implement a way to pass custom defines from SSGC.CompileCommand down to SSGC.Linker.Tables

Author: tayloraswift

Sources/SymbolGraphBuilder/Builds/SSGC.Workspace.swift

@@ -57,8 +57,8 @@ extension SSGC.Workspace
         validation:SSGC.ValidationBehavior = .ignoreErrors,
         clean:Bool = true) throws -> SymbolGraphObject<Void>
     {
-        try self.build(some: build, toolchain: swift, 
-            status: nil, 
+        try self.build(some: build,
+            toolchain: swift,
             logger: .init(validation: validation, file: nil),
             clean: clean)
     }
@@ -69,8 +69,8 @@ extension SSGC.Workspace
         validation:SSGC.ValidationBehavior = .ignoreErrors,
         clean:Bool = true) throws -> SymbolGraphObject<Void>
     {
-        try self.build(some: build, toolchain: swift, 
-            status: nil, 
+        try self.build(some: build,
+            toolchain: swift,
             logger: .init(validation: validation, file: nil),
             clean: clean)
     }
@@ -79,11 +79,15 @@ extension SSGC.Workspace
 {
     func build<Build>(some build:consuming Build,
         toolchain swift:SSGC.Toolchain,
-        status:SSGC.StatusStream?,
+        define defines:[String] = [],
+        status:SSGC.StatusStream? = nil,
         logger:SSGC.Logger = .default(),
         clean:Bool) throws -> SymbolGraphObject<Void>
         where Build:SSGC.DocumentationBuild
     {
+        /// TODO: support values?
+        let definitions:[String: Void] = defines.reduce(into: [:]) { $0[$1] = () }
+
         let metadata:SymbolGraphMetadata
         let package:any SSGC.DocumentationSources
 
@@ -96,6 +100,7 @@ extension SSGC.Workspace
             clean: clean)
 
         let documentation:SymbolGraph = try package.link(
+            definitions: definitions,
             logger: logger,
             with: swift)
 

Sources/SymbolGraphBuilder/SSGC.CompileCommand.swift

@@ -65,6 +65,12 @@ extension SSGC
         var appleSDK:AppleSDK? = nil
 
 
+        @Option(
+            name: [.customLong("define"), .customShort("D")],
+            parsing: .unconditionalSingleValue,
+            help: "Define a trait for the Documentation compiler")
+        var defines:[String] = []
+
         @Option(
             name: [.customLong("Xswiftc")],
             parsing: .unconditionalSingleValue,
@@ -304,6 +310,7 @@ extension SSGC.CompileCommand
 
             object = try workspace.build(some: build,
                 toolchain: toolchain,
+                define: self.defines,
                 status: status,
                 logger: logger,
                 clean: self.cleanArtifacts)
@@ -312,6 +319,7 @@ extension SSGC.CompileCommand
         {
             object = try workspace.build(some: SSGC.StandardLibraryBuild.swift,
                 toolchain: toolchain,
+                define: self.defines,
                 status: status,
                 logger: logger,
                 clean: self.cleanArtifacts)
@@ -355,6 +363,7 @@ extension SSGC.CompileCommand
 
             object = try workspace.build(some: build,
                 toolchain: toolchain,
+                define: self.defines,
                 status: status,
                 logger: logger,
                 clean: self.cleanArtifacts)

Sources/SymbolGraphBuilder/Sources/SSGC.DocumentationSources.swift

@@ -31,7 +31,9 @@ extension SSGC
 }
 extension SSGC.DocumentationSources
 {
-    func link(logger:SSGC.Logger, with swift:SSGC.Toolchain) throws -> SymbolGraph
+    func link(definitions:[String: Void],
+        logger:SSGC.Logger,
+        with swift:SSGC.Toolchain) throws -> SymbolGraph
     {
         let moduleLayouts:[SSGC.ModuleLayout] = self.cultures
         let snippets:[SSGC.LazyFile] = self.snippets
@@ -143,6 +145,7 @@ extension SSGC.DocumentationSources
             let graph:SymbolGraph = try profiler.measure(\.linking)
             {
                 try .link(projectRoot: prefix,
+                    definitions: definitions,
                     plugins: [.swift(index: index)],
                     modules: moduleLayouts.map(\.module),
                     indexes: moduleIndexes,

Sources/SymbolGraphLinker/SSGC.Linker.Tables.swift

@@ -11,6 +11,7 @@ extension SSGC.Linker
     @_spi(testable) public
     struct Tables//:~Copyable
     {
+        let definitions:[String: Void]
         var diagnostics:Diagnostics<SSGC.Symbolicator>
 
         @_spi(testable) public
@@ -34,12 +35,15 @@ extension SSGC.Linker
         var graph:SymbolGraph
 
         @_spi(testable) public
-        init(diagnostics:Diagnostics<SSGC.Symbolicator> = .init(),
+        init(
+            definitions:[String: Void] = [:],
+            diagnostics:Diagnostics<SSGC.Symbolicator> = .init(),
             packageLinks:UCF.ResolutionTable<UCF.PackageOverload> = .init(),
             articleLinks:UCF.ArticleTable = .init(),
             anchors:SSGC.AnchorResolver = .init(),
             modules:[SymbolGraph.Module] = [])
         {
+            self.definitions = definitions
             self.diagnostics = diagnostics
             self.packageLinks = packageLinks
             self.articleLinks = articleLinks
@@ -57,7 +61,6 @@ extension SSGC.Linker
             self.files = [:]
 
             self.graph = .init(modules: modules)
-
         }
     }
 }
@@ -400,6 +403,7 @@ extension SSGC.Linker.Tables
     {
         var outliner:SSGC.Outliner = .init(
             resolver: .init(scopes: environment, tables: consume self))
+
         do
         {
             let success:Success = try body(&outliner)

Sources/SymbolGraphLinker/SSGC.Linker.swift

@@ -65,12 +65,14 @@ extension SSGC
 }
 extension SSGC.Linker
 {
-    init(plugins:[any Markdown.CodeLanguageType] = [], modules:[SymbolGraph.Module])
+    init(definitions:[String: Void],
+        plugins:[any Markdown.CodeLanguageType],
+        modules:[SymbolGraph.Module])
     {
         //  If we were given a plugin that says it can highlight swift,
         //  make it the default plugin for the doccomment parser.
         let swift:(any Markdown.CodeLanguageType)? = plugins.first { $0.name == "swift" }
-        let tables:Tables = .init(modules: modules)
+        let tables:Tables = .init(definitions: definitions, modules: modules)
 
         self = .init(
             doccommentParser: .init(plugins: plugins, default: swift),

Sources/SymbolGraphLinker/SymbolGraph (ext).swift

@@ -9,14 +9,19 @@ import Symbols
 extension SymbolGraph
 {
     public
-    static func link(projectRoot:Symbol.FileBase? = nil,
+    static func link(
+        projectRoot:Symbol.FileBase? = nil,
+        definitions:[String: Void],
         plugins:consuming [any Markdown.CodeLanguageType] = [],
         modules:consuming [SymbolGraph.Module],
         indexes:consuming [SSGC.ModuleIndex],
         snippets:[any SSGC.ResourceFile],
         logger:any DiagnosticLogger) throws -> Self
     {
-        var linker:SSGC.Linker = .init(plugins: plugins, modules: modules)
+        var linker:SSGC.Linker = .init(definitions: definitions,
+            plugins: plugins,
+            modules: modules)
+
         try linker.attach(snippets: snippets, indexes: indexes, projectRoot: projectRoot)
         try linker.collate()