|
| 1 | +//===----------------------------------------------------------------------===// |
| 2 | +// |
| 3 | +// This source file is part of the Swift open source project |
| 4 | +// |
| 5 | +// Copyright (c) 2025 Apple Inc. and the Swift project authors |
| 6 | +// Licensed under Apache License v2.0 with Runtime Library Exception |
| 7 | +// |
| 8 | +// See http://swift.org/LICENSE.txt for license information |
| 9 | +// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| 10 | +// |
| 11 | +//===----------------------------------------------------------------------===// |
| 12 | + |
| 13 | +public import SWBUtil |
| 14 | +import SWBMacro |
| 15 | + |
| 16 | +public struct ModuleDependency: Hashable, Sendable, SerializableCodable { |
| 17 | + public let name: String |
| 18 | + public let accessLevel: AccessLevel |
| 19 | + |
| 20 | + public enum AccessLevel: String, Hashable, Sendable, CaseIterable, Codable, Serializable { |
| 21 | + case Private = "private" |
| 22 | + case Package = "package" |
| 23 | + case Public = "public" |
| 24 | + } |
| 25 | + |
| 26 | + public init(name: String, accessLevel: AccessLevel) { |
| 27 | + self.name = name |
| 28 | + self.accessLevel = accessLevel |
| 29 | + } |
| 30 | + |
| 31 | + public init(entry: String) throws { |
| 32 | + let components = entry.split(separator: " ") |
| 33 | + guard (1...2).contains(components.count) else { |
| 34 | + throw StubError.error("expected 1 or 2 space-separated components in: \(entry)") |
| 35 | + } |
| 36 | + |
| 37 | + let accessLevel: AccessLevel |
| 38 | + if components.count > 1 { |
| 39 | + if let a = AccessLevel(rawValue: String(components[0])) { |
| 40 | + accessLevel = a |
| 41 | + } |
| 42 | + else { |
| 43 | + throw StubError.error("unexpected access modifier '\(components[0])', expected one of: \(AccessLevel.allCases.map { $0.rawValue }.joined(separator: ", "))") |
| 44 | + } |
| 45 | + } |
| 46 | + else { |
| 47 | + accessLevel = .Private |
| 48 | + } |
| 49 | + |
| 50 | + self.name = String(components.last!) |
| 51 | + self.accessLevel = accessLevel |
| 52 | + } |
| 53 | + |
| 54 | + public var asBuildSettingEntry: String { |
| 55 | + "\(accessLevel == .Private ? "" : "\(accessLevel.rawValue) ")\(name)" |
| 56 | + } |
| 57 | + |
| 58 | + public var asBuildSettingEntryQuotedIfNeeded: String { |
| 59 | + let e = asBuildSettingEntry |
| 60 | + return e.contains(" ") ? "\"\(e)\"" : e |
| 61 | + } |
| 62 | +} |
| 63 | + |
| 64 | +public struct ModuleDependenciesContext: Sendable, SerializableCodable { |
| 65 | + var validate: BooleanWarningLevel |
| 66 | + var moduleDependencies: [ModuleDependency] |
| 67 | + var fixItContext: FixItContext? |
| 68 | + |
| 69 | + init(validate: BooleanWarningLevel, moduleDependencies: [ModuleDependency], fixItContext: FixItContext? = nil) { |
| 70 | + self.validate = validate |
| 71 | + self.moduleDependencies = moduleDependencies |
| 72 | + self.fixItContext = fixItContext |
| 73 | + } |
| 74 | + |
| 75 | + public init?(settings: Settings) { |
| 76 | + let validate = settings.globalScope.evaluate(BuiltinMacros.VALIDATE_MODULE_DEPENDENCIES) |
| 77 | + guard validate != .no else { return nil } |
| 78 | + let fixItContext = ModuleDependenciesContext.FixItContext(settings: settings) |
| 79 | + self.init(validate: validate, moduleDependencies: settings.moduleDependencies, fixItContext: fixItContext) |
| 80 | + } |
| 81 | + |
| 82 | + /// Nil `imports` means the current toolchain doesn't have the features to gather imports. This is temporarily required to support running against older toolchains. |
| 83 | + public func makeDiagnostics(imports: [(ModuleDependency, importLocations: [Diagnostic.Location])]?) -> [Diagnostic] { |
| 84 | + guard validate != .no else { return [] } |
| 85 | + guard let imports else { |
| 86 | + return [Diagnostic( |
| 87 | + behavior: .error, |
| 88 | + location: .unknown, |
| 89 | + data: DiagnosticData("The current toolchain does not support \(BuiltinMacros.VALIDATE_MODULE_DEPENDENCIES.name)"))] |
| 90 | + } |
| 91 | + |
| 92 | + let missingDeps = imports.filter { |
| 93 | + // ignore module deps without source locations, these are inserted by swift / swift-build and we should treat them as implementation details which we can track without needing the user to declare them |
| 94 | + if $0.importLocations.isEmpty { return false } |
| 95 | + |
| 96 | + // TODO: if the difference is just the access modifier, we emit a new entry, but ultimately our fixit should update the existing entry or emit an error about a conflict |
| 97 | + if moduleDependencies.contains($0.0) { return false } |
| 98 | + return true |
| 99 | + } |
| 100 | + |
| 101 | + guard !missingDeps.isEmpty else { return [] } |
| 102 | + |
| 103 | + let behavior: Diagnostic.Behavior = validate == .yesError ? .error : .warning |
| 104 | + |
| 105 | + let fixIt = fixItContext?.makeFixIt(newModules: missingDeps.map { $0.0 }) |
| 106 | + let fixIts = fixIt.map { [$0] } ?? [] |
| 107 | + |
| 108 | + let importDiags: [Diagnostic] = missingDeps |
| 109 | + .flatMap { dep in |
| 110 | + dep.1.map { |
| 111 | + return Diagnostic( |
| 112 | + behavior: behavior, |
| 113 | + location: $0, |
| 114 | + data: DiagnosticData("Missing entry in \(BuiltinMacros.MODULE_DEPENDENCIES.name): \(dep.0.asBuildSettingEntryQuotedIfNeeded)"), |
| 115 | + fixIts: fixIts) |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | + let message = "Missing entries in \(BuiltinMacros.MODULE_DEPENDENCIES.name): \(missingDeps.map { $0.0.asBuildSettingEntryQuotedIfNeeded }.sorted().joined(separator: " "))" |
| 120 | + |
| 121 | + let location: Diagnostic.Location = fixIt.map { |
| 122 | + Diagnostic.Location.path($0.sourceRange.path, line: $0.sourceRange.endLine, column: $0.sourceRange.endColumn) |
| 123 | + } ?? Diagnostic.Location.buildSetting(BuiltinMacros.MODULE_DEPENDENCIES) |
| 124 | + |
| 125 | + return [Diagnostic( |
| 126 | + behavior: behavior, |
| 127 | + location: location, |
| 128 | + data: DiagnosticData(message), |
| 129 | + fixIts: fixIts, |
| 130 | + childDiagnostics: importDiags)] |
| 131 | + } |
| 132 | + |
| 133 | + struct FixItContext: Sendable, SerializableCodable { |
| 134 | + var sourceRange: Diagnostic.SourceRange |
| 135 | + var modificationStyle: ModificationStyle |
| 136 | + |
| 137 | + init(sourceRange: Diagnostic.SourceRange, modificationStyle: ModificationStyle) { |
| 138 | + self.sourceRange = sourceRange |
| 139 | + self.modificationStyle = modificationStyle |
| 140 | + } |
| 141 | + |
| 142 | + init?(settings: Settings) { |
| 143 | + guard let target = settings.target else { return nil } |
| 144 | + let thisTargetCondition = MacroCondition(parameter: BuiltinMacros.targetNameCondition, valuePattern: target.name) |
| 145 | + |
| 146 | + if let assignment = (settings.globalScope.table.lookupMacro(BuiltinMacros.MODULE_DEPENDENCIES)?.sequence.first { |
| 147 | + $0.location != nil && ($0.conditions?.conditions == [thisTargetCondition] || ($0.conditions?.conditions.isEmpty ?? true)) |
| 148 | + }), |
| 149 | + let location = assignment.location |
| 150 | + { |
| 151 | + self.init(sourceRange: .init(path: location.path, startLine: location.endLine, startColumn: location.endColumn, endLine: location.endLine, endColumn: location.endColumn), modificationStyle: .appendToExistingAssignment) |
| 152 | + } |
| 153 | + else if let path = settings.constructionComponents.targetXcconfigPath { |
| 154 | + self.init(sourceRange: .init(path: path, startLine: 0, startColumn: 0, endLine: 0, endColumn: 0), modificationStyle: .insertNewAssignment(targetNameCondition: nil)) |
| 155 | + } |
| 156 | + else if let path = settings.constructionComponents.projectXcconfigPath { |
| 157 | + self.init(sourceRange: .init(path: path, startLine: 0, startColumn: 0, endLine: 0, endColumn: 0), modificationStyle: .insertNewAssignment(targetNameCondition: target.name)) |
| 158 | + } |
| 159 | + else { |
| 160 | + return nil |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + enum ModificationStyle: Sendable, SerializableCodable, Hashable { |
| 165 | + case appendToExistingAssignment |
| 166 | + case insertNewAssignment(targetNameCondition: String?) |
| 167 | + } |
| 168 | + |
| 169 | + func makeFixIt(newModules: [ModuleDependency]) -> Diagnostic.FixIt { |
| 170 | + let stringValue = newModules.map { $0.asBuildSettingEntryQuotedIfNeeded }.sorted().joined(separator: " ") |
| 171 | + let newText: String |
| 172 | + switch modificationStyle { |
| 173 | + case .appendToExistingAssignment: |
| 174 | + newText = " \(stringValue)" |
| 175 | + case .insertNewAssignment(let targetNameCondition): |
| 176 | + let targetCondition = targetNameCondition.map { "[target=\($0)]" } ?? "" |
| 177 | + newText = "\n\(BuiltinMacros.MODULE_DEPENDENCIES.name)\(targetCondition) = $(inherited) \(stringValue)\n" |
| 178 | + } |
| 179 | + |
| 180 | + return Diagnostic.FixIt(sourceRange: sourceRange, newText: newText) |
| 181 | + } |
| 182 | + } |
| 183 | +} |
0 commit comments