Dependencies: propagate actual xcconfig final line/column number to fixits instead of using .max (rdar://159783939)

Author: mirza-garibovic

Sources/SWBCore/CapturedBuildInfo.swift

@@ -97,16 +97,16 @@ public struct CapturedBuildInfo: PropertyListItemConvertible, Sendable {
             let settings = settingsPerTarget[configuredTarget]
             let targetConstructionComponents = settings?.constructionComponents
             let projectXcconfigSettings: CapturedBuildSettingsTableInfo = {
-                let settings = targetConstructionComponents?.projectXcconfigSettings?.capturedRepresentation ?? [:]
-                return CapturedBuildSettingsTableInfo(name: CapturedBuildSettingsTableInfo.Name.projectXcconfig, path: targetConstructionComponents?.projectXcconfigPath, settings: settings)
+                let settings = targetConstructionComponents?.projectXcconfig?.settings.capturedRepresentation ?? [:]
+                return CapturedBuildSettingsTableInfo(name: CapturedBuildSettingsTableInfo.Name.projectXcconfig, path: targetConstructionComponents?.projectXcconfig?.path, settings: settings)
             }()
             let projectSettings: CapturedBuildSettingsTableInfo = {
                 let settings = targetConstructionComponents?.projectSettings?.capturedRepresentation ?? [:]
                 return CapturedBuildSettingsTableInfo(name: CapturedBuildSettingsTableInfo.Name.project, path: nil, settings: settings)
             }()
             let targetXcconfigSettings: CapturedBuildSettingsTableInfo = {
-                let settings = targetConstructionComponents?.targetXcconfigSettings?.capturedRepresentation ?? [:]
-                return CapturedBuildSettingsTableInfo(name: CapturedBuildSettingsTableInfo.Name.targetXcconfig, path: targetConstructionComponents?.targetXcconfigPath, settings: settings)
+                let settings = targetConstructionComponents?.targetXcconfig?.settings.capturedRepresentation ?? [:]
+                return CapturedBuildSettingsTableInfo(name: CapturedBuildSettingsTableInfo.Name.targetXcconfig, path: targetConstructionComponents?.targetXcconfig?.path, settings: settings)
             }()
             let targetSettings: CapturedBuildSettingsTableInfo = {
                 let settings = targetConstructionComponents?.targetSettings?.capturedRepresentation ?? [:]

Sources/SWBCore/Dependencies.swift

@@ -196,11 +196,11 @@ public struct ModuleDependenciesContext: Sendable, SerializableCodable {
             {
                 self.init(sourceRange: .init(path: location.path, startLine: location.endLine, startColumn: location.endColumn, endLine: location.endLine, endColumn: location.endColumn), modificationStyle: .appendToExistingAssignment)
             }
-            else if let path = settings.constructionComponents.targetXcconfigPath {
-                self.init(sourceRange: .init(path: path, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max), modificationStyle: .insertNewAssignment(targetNameCondition: nil))
+            else if let xcconfig = settings.constructionComponents.targetXcconfig {
+                self.init(sourceRange: .init(path: xcconfig.path, startLine: xcconfig.finalLineNumber, startColumn: xcconfig.finalColumnNumber, endLine: xcconfig.finalLineNumber, endColumn: xcconfig.finalColumnNumber), modificationStyle: .insertNewAssignment(targetNameCondition: nil))
             }
-            else if let path = settings.constructionComponents.projectXcconfigPath {
-                self.init(sourceRange: .init(path: path, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max), modificationStyle: .insertNewAssignment(targetNameCondition: target.name))
+            else if let xcconfig = settings.constructionComponents.projectXcconfig {
+                self.init(sourceRange: .init(path: xcconfig.path, startLine: xcconfig.finalLineNumber, startColumn: xcconfig.finalColumnNumber, endLine: xcconfig.finalLineNumber, endColumn: xcconfig.finalColumnNumber), modificationStyle: .insertNewAssignment(targetNameCondition: target.name))
             }
             else {
                 return nil
@@ -357,11 +357,11 @@ public struct HeaderDependenciesContext: Sendable, SerializableCodable {
             {
                 self.init(sourceRange: .init(path: location.path, startLine: location.endLine, startColumn: location.endColumn, endLine: location.endLine, endColumn: location.endColumn), modificationStyle: .appendToExistingAssignment)
             }
-            else if let path = settings.constructionComponents.targetXcconfigPath {
-                self.init(sourceRange: .init(path: path, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max), modificationStyle: .insertNewAssignment(targetNameCondition: nil))
+            else if let xcconfig = settings.constructionComponents.targetXcconfig {
+                self.init(sourceRange: .init(path: xcconfig.path, startLine: xcconfig.finalLineNumber, startColumn: xcconfig.finalColumnNumber, endLine: xcconfig.finalLineNumber, endColumn: xcconfig.finalColumnNumber), modificationStyle: .insertNewAssignment(targetNameCondition: nil))
             }
-            else if let path = settings.constructionComponents.projectXcconfigPath {
-                self.init(sourceRange: .init(path: path, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max), modificationStyle: .insertNewAssignment(targetNameCondition: target.name))
+            else if let xcconfig = settings.constructionComponents.projectXcconfig {
+                self.init(sourceRange: .init(path: xcconfig.path, startLine: xcconfig.finalLineNumber, startColumn: xcconfig.finalColumnNumber, endLine: xcconfig.finalLineNumber, endColumn: xcconfig.finalColumnNumber), modificationStyle: .insertNewAssignment(targetNameCondition: target.name))
             }
             else {
                 return nil

Sources/SWBCore/Settings/Settings.swift

@@ -786,19 +786,16 @@ public final class Settings: PlatformBuildContext, Sendable {
     ///
     /// - remark: The overhead of this object should be very small, because the majority of the actual data are the linked lists of macro definitions, which are shared with the main table in the `Settings` object.
     public struct ConstructionComponents: Sendable {
-        // These properties are the individual tables (and info about them) of specific levels which contributed to the Settings.
+        struct XcconfigInfo: Sendable {
+            var path: Path
+            var settings: MacroValueAssignmentTable
+            var finalLineNumber: Int
+            var finalColumnNumber: Int
+        }
 
-        /// The path to the project-level xcconfig file.
-        let projectXcconfigPath: Path?
-        /// The project-level xcconfig settings table.
-        let projectXcconfigSettings: MacroValueAssignmentTable?
-        /// The project-level settings table.
+        let projectXcconfig: XcconfigInfo?
         let projectSettings: MacroValueAssignmentTable?
-        /// The path to the target-level xcconfig file.
-        let targetXcconfigPath: Path?
-        /// The target-level xcconfig settings table.
-        let targetXcconfigSettings: MacroValueAssignmentTable?
-        /// The target-level settings table.
+        let targetXcconfig: XcconfigInfo?
         let targetSettings: MacroValueAssignmentTable?
 
         // These properties are the actual tables of settings up to a certain point, which are used to compute the resolved values of settings at that level in the build settings editor (e.g., in the Levels view).
@@ -966,9 +963,9 @@ public final class Settings: PlatformBuildContext, Sendable {
         return BuildSettingsEditorInfoPayload(
             // Assigned values
             targetSettingAssignments: assignedValues(for: constructionComponents.targetSettings),
-            targetXcconfigSettingAssignments: assignedValues(for: constructionComponents.targetXcconfigSettings),
+            targetXcconfigSettingAssignments: assignedValues(for: constructionComponents.targetXcconfig?.settings),
             projectSettingAssignments: assignedValues(for: constructionComponents.projectSettings),
-            projectXcconfigSettingAssignments: assignedValues(for: constructionComponents.projectXcconfigSettings),
+            projectXcconfigSettingAssignments: assignedValues(for: constructionComponents.projectXcconfig?.settings),
 
             // Resolved values
             targetResolvedSettingsValues: resolvedValues(for: constructionComponents.upToTargetSettings),
@@ -1322,18 +1319,16 @@ private class SettingsBuilder {
         return core.coreSettings
     }
 
-    private var projectXcconfigPath: Path? = nil
-    private var projectXcconfigSettings: MacroValueAssignmentTable? = nil
+    private var projectXcconfig: Settings.ConstructionComponents.XcconfigInfo? = nil
     private var projectSettings: MacroValueAssignmentTable? = nil
-    private var targetXcconfigPath: Path? = nil
-    private var targetXcconfigSettings: MacroValueAssignmentTable? = nil
+    private var targetXcconfig: Settings.ConstructionComponents.XcconfigInfo? = nil
     private var targetSettings: MacroValueAssignmentTable? = nil
     /// Convenient array for iterating over all defined settings tables in the project for this target, from lowest to highest.
     private var allProjectSettingsLevels: [(table: MacroValueAssignmentTable?, path: Path?, level: String)] {
         return [
-            (projectXcconfigSettings, projectXcconfigPath, "project-xcconfig"),
+            (projectXcconfig?.settings, projectXcconfig?.path, "project-xcconfig"),
             (projectSettings, nil, "project"),
-            (targetXcconfigSettings, targetXcconfigPath, "target-xcconfig"),
+            (targetXcconfig?.settings, targetXcconfig?.path, "target-xcconfig"),
             (targetSettings, nil, "target"),
         ]
     }
@@ -1347,11 +1342,9 @@ private class SettingsBuilder {
     /// The project model components which were used to construct the settings made by this builder.
     var constructionComponents: Settings.ConstructionComponents {
         return Settings.ConstructionComponents(
-            projectXcconfigPath: self.projectXcconfigPath,
-        	projectXcconfigSettings: self.projectXcconfigSettings,
+            projectXcconfig: self.projectXcconfig,
             projectSettings: self.projectSettings,
-            targetXcconfigPath: self.targetXcconfigPath,
-            targetXcconfigSettings: self.targetXcconfigSettings,
+            targetXcconfig: self.targetXcconfig,
             targetSettings: self.targetSettings,
             upToDefaultsSettings: self.upToDefaultsSettings,
             upToProjectXcconfigSettings: upToProjectXcconfigSettings,
@@ -2807,8 +2800,7 @@ private class SettingsBuilder {
             }
 
             // Save the settings table as part of the construction components.
-            self.projectXcconfigPath = path
-            self.projectXcconfigSettings = info.table
+            self.projectXcconfig = .init(path: path, settings: info.table, finalLineNumber: info.finalLineNumber, finalColumnNumber: info.finalColumnNumber)
 
             // Also save the table we've constructed so far.
             self.upToProjectXcconfigSettings = MacroValueAssignmentTable(copying: _table)
@@ -3015,8 +3007,7 @@ private class SettingsBuilder {
             }
 
             // Save the settings table as part of the construction components.
-            self.targetXcconfigPath = path
-            self.targetXcconfigSettings = info.table
+            self.targetXcconfig = .init(path: path, settings: info.table, finalLineNumber: info.finalLineNumber, finalColumnNumber: info.finalColumnNumber)
 
             // Save the table we've constructed so far.
             self.upToTargetXcconfigSettings = MacroValueAssignmentTable(copying: _table)

Tests/SWBBuildSystemTests/DependencyValidationTests.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import Foundation
 import SWBCore
 import SWBTestSupport
 import SWBUtil
@@ -412,6 +413,11 @@ fileprivate struct DependencyValidationTests: CoreBasedTests {
             """
             }
 
+            let projectXCConfigContents = try #require(tester.fs.read(projectXCConfigPath).stringValue)
+            let projectXCConfigLines = projectXCConfigContents.components(separatedBy: .newlines)
+            let projectXCConfigFinalLineNumber = projectXCConfigLines.count
+            let projectXCConfigFinalColumnNumber = (projectXCConfigLines.last?.count ?? 0) + 1
+
             let expectedDiagsByTarget: [String: [Diagnostic]] = [
                 "TargetA": [
                     Diagnostic(
@@ -437,11 +443,11 @@ fileprivate struct DependencyValidationTests: CoreBasedTests {
                 "TargetB": [
                     Diagnostic(
                         behavior: .error,
-                        location: Diagnostic.Location.path(projectXCConfigPath, line: .max, column: .max),
+                        location: Diagnostic.Location.path(projectXCConfigPath, line: projectXCConfigFinalLineNumber, column: projectXCConfigFinalColumnNumber),
                         data: DiagnosticData("Missing entries in MODULE_DEPENDENCIES: Foundation"),
                         fixIts: [
                             Diagnostic.FixIt(
-                                sourceRange: Diagnostic.SourceRange(path: projectXCConfigPath, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max),
+                                sourceRange: Diagnostic.SourceRange(path: projectXCConfigPath, startLine: projectXCConfigFinalLineNumber, startColumn: projectXCConfigFinalColumnNumber, endLine: projectXCConfigFinalLineNumber, endColumn: projectXCConfigFinalColumnNumber),
                                 newText: "\nMODULE_DEPENDENCIES[target=TargetB] = $(inherited) \\\n    Foundation\n"),
                         ],
                         childDiagnostics: [
@@ -450,7 +456,7 @@ fileprivate struct DependencyValidationTests: CoreBasedTests {
                                 location: Diagnostic.Location.path(swiftSourcePath, line: 1, column: 8),
                                 data: DiagnosticData("Missing entry in MODULE_DEPENDENCIES: Foundation"),
                                 fixIts: [Diagnostic.FixIt(
-                                    sourceRange: Diagnostic.SourceRange(path: projectXCConfigPath, startLine: .max, startColumn: .max, endLine: .max, endColumn: .max),
+                                    sourceRange: Diagnostic.SourceRange(path: projectXCConfigPath, startLine: projectXCConfigFinalLineNumber, startColumn: projectXCConfigFinalColumnNumber, endLine: projectXCConfigFinalLineNumber, endColumn: projectXCConfigFinalColumnNumber),
                                     newText: "\nMODULE_DEPENDENCIES[target=TargetB] = $(inherited) \\\n    Foundation\n")],
                             ),
                         ]),