Add variants APIs for multi-language symbols

Adds APIs for specifying different variants for fields of the Symbol
API in support of documenting symbols that are available in multiple
languages, for example Swift and Objective-C.

rdar://83665056

Author: franklinsch

Sources/SwiftDocC/Infrastructure/External Data/OutOfProcessReferenceResolver.swift

@@ -752,25 +752,25 @@ extension OutOfProcessReferenceResolver {
         }
 
         return Symbol(
-            kind: symbolKind(forNodeKind: kind),
-            title: title,
-            subHeading: declarationFragments?.declarationFragments,
-            navigator: nil,
-            roleHeading: "", // This information isn't used anywhere since this node doesn't have its own page, it's just referenced from other pages.
-            platformName: nil,
-            moduleName: "", // This information isn't used anywhere since the `urlForResolvedReference(reference:)` specifies the URL for this node.
-            externalID: nil,
-            accessLevel: nil,
-            availability: availability,
-            deprecatedSummary: nil,
-            mixins: nil,
-            abstractSection: nil,
-            discussion: nil,
-            topics: nil,
-            seeAlso: nil,
-            returnsSection: nil,
-            parametersSection: nil,
-            redirects: nil
+            kindVariants: .init(swiftVariant: symbolKind(forNodeKind: kind)),
+            titleVariants: .init(swiftVariant: title),
+            subHeadingVariants: .init(swiftVariant: declarationFragments?.declarationFragments),
+            navigatorVariants: .init(swiftVariant: nil),
+            roleHeadingVariants: .init(swiftVariant: ""), // This information isn't used anywhere since this node doesn't have its own page, it's just referenced from other pages.
+            platformNameVariants: .init(swiftVariant: nil),
+            moduleNameVariants: .init(swiftVariant: ""), // This information isn't used anywhere since the `urlForResolvedReference(reference:)` specifies the URL for this node.
+            externalIDVariants: .init(swiftVariant: nil),
+            accessLevelVariants: .init(swiftVariant: nil),
+            availabilityVariants: .init(swiftVariant: availability),
+            deprecatedSummaryVariants: .init(swiftVariant: nil),
+            mixinsVariants: .init(swiftVariant: nil),
+            abstractSectionVariants: .init(swiftVariant: nil),
+            discussionVariants: .init(swiftVariant: nil),
+            topicsVariants: .init(swiftVariant: nil),
+            seeAlsoVariants: .init(swiftVariant: nil),
+            returnsSectionVariants: .init(swiftVariant: nil),
+            parametersSectionVariants: .init(swiftVariant: nil),
+            redirectsVariants: .init(swiftVariant: nil)
         )
     }
 }

Sources/SwiftDocC/Model/DocumentationNode.swift

@@ -181,28 +181,28 @@ public struct DocumentationNode {
         let extendedModule = (symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] as? SymbolGraph.Symbol.Swift.Extension)?.extendedModule
 
         self.semantic = Symbol(
-            kind: symbol.kind,
-            title: symbol.names.title,
-            subHeading: symbol.names.subHeading,
-            navigator: symbol.names.navigator,
-            roleHeading: symbol.kind.displayName,
-            platformName: platformName.map(PlatformName.init(operatingSystemName:)),
-            moduleName: moduleName,
-            extendedModule: extendedModule,
-            externalID: symbol.identifier.precise,
-            accessLevel: symbol.accessLevel.rawValue,
-            availability: symbolAvailability,
-            deprecatedSummary: nil,
-            mixins: symbol.mixins,
-            relationships: RelationshipsSection(),
-            abstractSection: AbstractSection(paragraph: .init([Text("Placeholder Abstract")])),
-            discussion: nil,
-            topics: nil,
-            seeAlso: nil,
-            returnsSection: nil,
-            parametersSection: nil,
-            redirects: nil,
-            bystanderModuleNames: bystanderModules
+            kindVariants: .init(swiftVariant: symbol.kind),
+            titleVariants: .init(swiftVariant: symbol.names.title),
+            subHeadingVariants: .init(swiftVariant: symbol.names.subHeading),
+            navigatorVariants: .init(swiftVariant: symbol.names.navigator),
+            roleHeadingVariants: .init(swiftVariant: symbol.kind.displayName),
+            platformNameVariants: .init(swiftVariant: platformName.map(PlatformName.init(operatingSystemName:))),
+            moduleNameVariants: .init(swiftVariant: moduleName),
+            extendedModuleVariants: .init(swiftVariant: extendedModule),
+            externalIDVariants: .init(swiftVariant: symbol.identifier.precise),
+            accessLevelVariants: .init(swiftVariant: symbol.accessLevel.rawValue),
+            availabilityVariants: .init(swiftVariant: symbolAvailability),
+            deprecatedSummaryVariants: .init(swiftVariant: nil),
+            mixinsVariants: .init(swiftVariant: symbol.mixins),
+            relationshipsVariants: .init(swiftVariant: RelationshipsSection()),
+            abstractSectionVariants: .init(swiftVariant: AbstractSection(paragraph: .init([Text("Placeholder Abstract")]))),
+            discussionVariants: .init(swiftVariant: nil),
+            topicsVariants: .init(swiftVariant: nil),
+            seeAlsoVariants: .init(swiftVariant: nil),
+            returnsSectionVariants: .init(swiftVariant: nil),
+            parametersSectionVariants: .init(swiftVariant: nil),
+            redirectsVariants: .init(swiftVariant: nil),
+            bystanderModuleNamesVariants: .init(swiftVariant: bystanderModules)
         )
     }
 
@@ -413,27 +413,27 @@ public struct DocumentationNode {
         let markupModel = DocumentationMarkup(markup: markup)
 
         self.semantic = Symbol(
-            kind: symbol.kind,
-            title: symbol.names.title,
-            subHeading: symbol.names.subHeading,
-            navigator: symbol.names.navigator,
-            roleHeading: symbol.kind.displayName,
-            platformName: platformName.map(PlatformName.init(operatingSystemName:)),
-            moduleName: moduleName,
-            externalID: symbol.identifier.precise,
-            accessLevel: symbol.accessLevel.rawValue,
-            availability: symbolAvailability,
-            deprecatedSummary: deprecated,
-            mixins: symbol.mixins,
-            relationships: RelationshipsSection(),
-            abstractSection: markupModel.abstractSection,
-            discussion: markupModel.discussionSection,
-            topics: markupModel.topicsSection,
-            seeAlso: markupModel.seeAlsoSection,
-            returnsSection: markupModel.discussionTags.flatMap({ $0.returns.isEmpty ? nil : ReturnsSection(content: $0.returns[0].contents) }),
-            parametersSection: markupModel.discussionTags.flatMap({ $0.parameters.isEmpty ? nil : ParametersSection(parameters: $0.parameters) }),
-            redirects: article?.redirects,
-            bystanderModuleNames: bystanderModules
+            kindVariants: .init(swiftVariant: symbol.kind),
+            titleVariants: .init(swiftVariant: symbol.names.title),
+            subHeadingVariants: .init(swiftVariant: symbol.names.subHeading),
+            navigatorVariants: .init(swiftVariant: symbol.names.navigator),
+            roleHeadingVariants: .init(swiftVariant: symbol.kind.displayName),
+            platformNameVariants: .init(swiftVariant: platformName.map(PlatformName.init(operatingSystemName:))),
+            moduleNameVariants: .init(swiftVariant: moduleName),
+            externalIDVariants: .init(swiftVariant: symbol.identifier.precise),
+            accessLevelVariants: .init(swiftVariant: symbol.accessLevel.rawValue),
+            availabilityVariants: .init(swiftVariant: symbolAvailability),
+            deprecatedSummaryVariants: .init(swiftVariant: deprecated),
+            mixinsVariants: .init(swiftVariant: symbol.mixins),
+            relationshipsVariants: .init(swiftVariant: RelationshipsSection()),
+            abstractSectionVariants: .init(swiftVariant: markupModel.abstractSection),
+            discussionVariants: .init(swiftVariant: markupModel.discussionSection),
+            topicsVariants: .init(swiftVariant: markupModel.topicsSection),
+            seeAlsoVariants: .init(swiftVariant: markupModel.seeAlsoSection),
+            returnsSectionVariants: .init(swiftVariant: markupModel.discussionTags.flatMap({ $0.returns.isEmpty ? nil : ReturnsSection(content: $0.returns[0].contents) })),
+            parametersSectionVariants: .init(swiftVariant: markupModel.discussionTags.flatMap({ $0.parameters.isEmpty ? nil : ParametersSection(parameters: $0.parameters) })),
+            redirectsVariants: .init(swiftVariant: article?.redirects),
+            bystanderModuleNamesVariants: .init(swiftVariant: bystanderModules)
         )
 
         updateAnchorSections()

Sources/SwiftDocC/Semantics/ReferenceResolver.swift

@@ -399,33 +399,33 @@ struct ReferenceResolver: SemanticVisitor {
         // or the merged default implementations to the new `Symbol` instance.
 
         return Symbol(
-            kind: symbol.kind,
-            title: symbol.title,
-            subHeading: symbol.subHeading,
-            navigator: symbol.navigator,
-            roleHeading: symbol.roleHeading,
-            platformName: symbol.platformName,
-            moduleName: symbol.moduleName,
-            extendedModule: symbol.extendedModule,
-            required: symbol.isRequired,
-            externalID: symbol.externalID,
-            accessLevel: symbol.accessLevel,
-            availability: symbol.availability,
-            deprecatedSummary: symbol.deprecatedSummary,
-            mixins: symbol.mixins,
-            declaration: symbol.declaration,
-            defaultImplementations: symbol.defaultImplementations,
-            relationships: symbol.relationships,
-            abstractSection: newAbstract,
-            discussion: newDiscussion,
-            topics: newTopics,
-            seeAlso: newSeeAlso,
-            returnsSection: newReturns,
-            parametersSection: newParameters,
-            redirects: symbol.redirects,
-            bystanderModuleNames: symbol.bystanderModuleNames,
-            origin: symbol.origin,
-            automaticTaskGroups: symbol.automaticTaskGroups
+            kindVariants: .init(swiftVariant: symbol.kind),
+            titleVariants: .init(swiftVariant: symbol.title),
+            subHeadingVariants: .init(swiftVariant: symbol.subHeading),
+            navigatorVariants: .init(swiftVariant: symbol.navigator),
+            roleHeadingVariants: .init(swiftVariant: symbol.roleHeading),
+            platformNameVariants: .init(swiftVariant: symbol.platformName),
+            moduleNameVariants: .init(swiftVariant: symbol.moduleName),
+            extendedModuleVariants: .init(swiftVariant: symbol.extendedModule),
+            requiredVariants: .init(swiftVariant: symbol.isRequired),
+            externalIDVariants: .init(swiftVariant: symbol.externalID),
+            accessLevelVariants: .init(swiftVariant: symbol.accessLevel),
+            availabilityVariants: .init(swiftVariant: symbol.availability),
+            deprecatedSummaryVariants: .init(swiftVariant: symbol.deprecatedSummary),
+            mixinsVariants: .init(swiftVariant: symbol.mixins),
+            declarationVariants: .init(swiftVariant: symbol.declaration),
+            defaultImplementationsVariants: .init(swiftVariant: symbol.defaultImplementations),
+            relationshipsVariants: .init(swiftVariant: symbol.relationships),
+            abstractSectionVariants: .init(swiftVariant: newAbstract),
+            discussionVariants: .init(swiftVariant: newDiscussion),
+            topicsVariants: .init(swiftVariant: newTopics),
+            seeAlsoVariants: .init(swiftVariant: newSeeAlso),
+            returnsSectionVariants: .init(swiftVariant: newReturns),
+            parametersSectionVariants: .init(swiftVariant: newParameters),
+            redirectsVariants: .init(swiftVariant: symbol.redirects),
+            bystanderModuleNamesVariants: .init(swiftVariant: symbol.bystanderModuleNames),
+            originVariants: .init(swiftVariant: symbol.origin),
+            automaticTaskGroupsVariants: .init(swiftVariant: symbol.automaticTaskGroups)
         )
     }