1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SWBCore
import SWBUtil
import SWBTaskConstruction
import SWBMacro
final class AppIntentsMetadataTaskProducer: PhasedTaskProducer, TaskProducer {
init(_ context: TargetTaskProducerContext, phaseStartNodes: [any PlannedNode], phaseEndNode: any PlannedNode) {
super.init(context, phaseStartNodes: phaseStartNodes, phaseEndNode: phaseEndNode)
}
override var defaultTaskOrderingOptions: TaskOrderingOptions {
return .unsignedProductRequirement
}
private func filterBuildFiles(_ buildFiles: [BuildFile]?, identifiers: [String], buildFilesProcessingContext: BuildFilesProcessingContext) -> [FileToBuild] {
guard let buildFiles else {
return []
}
let fileTypes = identifiers.compactMap { identifier in
context.lookupFileType(identifier: identifier)
}
return fileTypes.flatMap { fileType in
buildFiles.compactMap { buildFile in
guard let resolvedBuildFileInfo = try? self.context.resolveBuildFileReference(buildFile),
!buildFilesProcessingContext.isExcluded(resolvedBuildFileInfo.absolutePath, filters: buildFile.platformFilters),
resolvedBuildFileInfo.fileType.conformsTo(fileType) else {
return nil
}
return FileToBuild(absolutePath: resolvedBuildFileInfo.absolutePath, fileType: fileType)
}
}
}
func generateTasks() async -> [any PlannedTask] {
let tasks: [any PlannedTask] = []
guard !context.settings.globalScope.evaluate(BuiltinMacros.LM_SKIP_METADATA_EXTRACTION) else {
return []
}
guard let configuredTarget = self.targetContext.configuredTarget, let buildPhaseTarget = configuredTarget.target as? BuildPhaseTarget else {
return []
}
context.addDeferredProducer {
let scope = self.context.settings.globalScope
var deferredTasks: [any PlannedTask] = []
let buildFilesProcessingContext = BuildFilesProcessingContext(self.context.settings.globalScope)
let swiftSources: [FileToBuild] = self.filterBuildFiles(buildPhaseTarget.sourcesBuildPhase?.buildFiles, identifiers: ["sourcecode.swift"], buildFilesProcessingContext: buildFilesProcessingContext)
let perArchConstMetadataFiles = self.context.generatedSwiftConstMetadataFiles()
var metadataDependencyList: Set<Path> = []
var staticLibraryDependencyList: Set<Path> = []
if let configuredTarget = self.targetContext.configuredTarget {
let dependencies = transitiveClosure([configuredTarget], successors: self.targetContext.globalProductPlan.dependencies(of:))
for dependency in dependencies.0 {
if let standardTarget = dependency.target as? StandardTarget,
let bundleProductType = self.context.getSpec(standardTarget.productTypeIdentifier),
bundleProductType.conformsTo(identifier: "com.apple.product-type.bundle") {
let targetScope = self.targetContext.globalProductPlan.getTargetSettings(dependency).globalScope
let dependencyMetadataPath = targetScope.evaluate(BuiltinMacros.TARGET_BUILD_DIR)
.join(targetScope.evaluate(BuiltinMacros.UNLOCALIZED_RESOURCES_FOLDER_PATH))
.join("Metadata.appintents/extract.actionsdata")
metadataDependencyList.insert(dependencyMetadataPath)
}
let targetScope = self.targetContext.globalProductPlan.getTargetSettings(dependency).globalScope
let machOType = targetScope.evaluate(BuiltinMacros.MACH_O_TYPE)
if machOType == "staticlib" || machOType == "mh_object" {
let dependencyMetadataPath = targetScope.evaluate(BuiltinMacros.TARGET_BUILD_DIR)
.join(targetScope.evaluate(BuiltinMacros.PRODUCT_MODULE_NAME) + ".appintents")
.join("Metadata.appintents/extract.actionsdata")
staticLibraryDependencyList.insert(dependencyMetadataPath)
}
}
}
// In expectation, these files will not differ between architectures and AppIntentsMetadataProcessor only runs once, on the final binary
// To attempt to make this deterministic, let's pick the list corresponding to the first arch alphabetically.
let constMetadataFiles: [Path]
if let firstArch = perArchConstMetadataFiles.keys.sorted().first {
constMetadataFiles = perArchConstMetadataFiles[firstArch]!
} else {
constMetadataFiles = []
}
let constMetadataFilesToBuild = constMetadataFiles.map { absolutePath -> FileToBuild in
let fileType = self.context.workspaceContext.core.specRegistry.getSpec("file") as! FileTypeSpec
return FileToBuild(absolutePath: absolutePath, fileType: fileType)
}
await self.appendGeneratedTasks(&deferredTasks) { delegate in
let metadataDependencyPath = scope.evaluate(BuiltinMacros.LM_AUX_INTENTS_METADATA_FILES_LIST_PATH)
if !metadataDependencyPath.isEmpty {
let fileListContents = OutputByteStream()
for metadataPath in metadataDependencyList.sorted() {
fileListContents <<< metadataPath.str <<< "\n"
}
let path = metadataDependencyPath
self.context.writeFileSpec.constructFileTasks(CommandBuildContext(producer: self.context, scope: scope, inputs: [], output: path), delegate, contents: fileListContents.bytes, permissions: nil, preparesForIndexing: true, additionalTaskOrderingOptions: [.immediate, .ignorePhaseOrdering])
}
}
await self.appendGeneratedTasks(&deferredTasks) { delegate in
let metadataDependencyPath = scope.evaluate(BuiltinMacros.LM_AUX_INTENTS_STATIC_METADATA_FILES_LIST_PATH)
if !metadataDependencyPath.isEmpty {
let fileListContents = OutputByteStream()
for metadataPath in staticLibraryDependencyList.sorted() {
fileListContents <<< metadataPath.str <<< "\n"
}
self.context.writeFileSpec
.constructFileTasks(
CommandBuildContext(producer: self.context, scope: scope, inputs: [], output: metadataDependencyPath),
delegate,
contents: fileListContents.bytes,
permissions: nil,
preparesForIndexing: true,
additionalTaskOrderingOptions: [.immediate, .ignorePhaseOrdering]
)
}
}
let appShortcutStringsSources: [FileToBuild] = self.filterBuildFiles(buildPhaseTarget.resourcesBuildPhase?.buildFiles, identifiers: ["text.plist.strings", "text.json.xcstrings"], buildFilesProcessingContext: buildFilesProcessingContext).filter { ["AppShortcuts.strings", "AppShortcuts.xcstrings"].contains($0.absolutePath.basename) }
let cbc = CommandBuildContext(producer: self.context, scope: scope, inputs: swiftSources + constMetadataFilesToBuild + appShortcutStringsSources, resourcesDir: buildFilesProcessingContext.resourcesDir)
let assistantIntentsStringsSources: [FileToBuild] = self.filterBuildFiles(buildPhaseTarget.resourcesBuildPhase?.buildFiles, identifiers: ["text.plist.strings", "text.json.xcstrings"], buildFilesProcessingContext: buildFilesProcessingContext).filter { ["AssistantIntents.strings", "AssistantIntents.xcstrings"].contains($0.absolutePath.basename) }
await self.appendGeneratedTasks(&deferredTasks) { delegate in
let shouldConstructAppIntentsMetadataTask = self.context.appIntentsMetadataCompilerSpec.shouldConstructAppIntentsMetadataTask(cbc)
let isInstallLoc = scope.evaluate(BuiltinMacros.BUILD_COMPONENTS).contains("installLoc")
await self.context.appIntentsMetadataCompilerSpec.constructTasks(cbc, delegate)
let inputs = appShortcutStringsSources + assistantIntentsStringsSources
if inputs.count > 0, appShortcutStringsSources.count < 2, assistantIntentsStringsSources.count < 2 {
let appShortcutsMetadataCbc = CommandBuildContext(producer: self.context, scope: scope, inputs: inputs, resourcesDir: buildFilesProcessingContext.resourcesDir)
await self.context.appShortcutStringsMetadataCompilerSpec.constructTasks(appShortcutsMetadataCbc, delegate)
}
// Only construct SSU task by default for public SDK clients. Internal default behavior should skip SSU task construction.
let isSSUEnabled = scope.evaluate(BuiltinMacros.APP_SHORTCUTS_ENABLE_FLEXIBLE_MATCHING)
if isSSUEnabled &&
self.context.settings.platform?.familyName == "iOS" &&
self.context.productType?.hasInfoPlist == true &&
((!scope.effectiveInputInfoPlistPath().isEmpty && shouldConstructAppIntentsMetadataTask) || isInstallLoc) {
var infoPlistSources: [FileToBuild]
if isInstallLoc {
infoPlistSources = self.filterBuildFiles(buildPhaseTarget.resourcesBuildPhase?.buildFiles, identifiers: ["text.plist.strings", "text.json.xcstrings"], buildFilesProcessingContext: buildFilesProcessingContext).filter { $0.absolutePath.basename.hasSuffix("InfoPlist.strings") || $0.absolutePath.basename.hasSuffix("InfoPlist.xcstrings") }
// The installLoc builds should include an AppShortcuts strings/xcstrings file to run SSU tasks
guard appShortcutStringsSources.count == 1 else {
return
}
} else {
infoPlistSources = [FileToBuild(absolutePath: scope.evaluate(BuiltinMacros.TARGET_BUILD_DIR).join(scope.evaluate(BuiltinMacros.INFOPLIST_PATH)), inferringTypeUsing: self.context)]
}
let yamlGenerationInputs: [FileToBuild] = infoPlistSources + appShortcutStringsSources
let appIntentsSsuTrainingCbc = CommandBuildContext(producer: self.context, scope: scope, inputs: yamlGenerationInputs, resourcesDir: buildFilesProcessingContext.resourcesDir)
await self.context.appIntentsSsuTrainingCompilerSpec.constructTasks(appIntentsSsuTrainingCbc, delegate)
}
}
return deferredTasks
}
return tasks
}
}
extension TaskProducerContext {
var appIntentsMetadataCompilerSpec: AppIntentsMetadataCompilerSpec {
return workspaceContext.core.specRegistry.getSpec("com.apple.compilers.appintentsmetadata", domain: domain) as! AppIntentsMetadataCompilerSpec
}
var appIntentsSsuTrainingCompilerSpec: AppIntentsSSUTrainingCompilerSpec {
return workspaceContext.core.specRegistry.getSpec("com.apple.compilers.appintents-ssu-training", domain: domain) as! AppIntentsSSUTrainingCompilerSpec
}
}
|
