Macros: track xcconfig file end line/column numbers during parsing/loading

Author: mirza-garibovic

Sources/SWBCore/MacroConfigFileLoader.swift

@@ -30,6 +30,12 @@ import Foundation
 
     /// Whether we failed to read the file at all. If this is `true`, the macro table is guaranteed to be empty.
     @_spi(Testing) public let isFileReadFailure: Bool
+
+    /// The final line number after parsing completes.
+    let finalLineNumber: Int
+
+    /// The final column number after parsing completes.
+    let finalColumnNumber: Int
 }
 
 @_spi(Testing) public enum MacroConfigLoadContext: Sendable {
@@ -54,7 +60,7 @@ final class MacroConfigFileLoader: Sendable {
         guard let data = try? fs.read(path) else {
             let table = MacroValueAssignmentTable(namespace: namespace)
             let dependencyPaths = [path]
-            return MacroConfigInfo(table: table, diagnostics: [], dependencyPaths: dependencyPaths, signature: filesSignature(dependencyPaths), isFileReadFailure: true)
+            return MacroConfigInfo(table: table, diagnostics: [], dependencyPaths: dependencyPaths, signature: filesSignature(dependencyPaths), isFileReadFailure: true, finalLineNumber: 1, finalColumnNumber: 1)
         }
 
         return loadSettingsFromConfig(data: data, path: path, namespace: namespace, searchPaths: searchPaths, filesSignature: filesSignature)
@@ -287,7 +293,7 @@ final class MacroConfigFileLoader: Sendable {
         let delegate = SettingsConfigFileParserDelegate(fs: fs, basePath: path?.dirname, searchPaths: searchPaths, table: tableRef, diagnostics: diagnostics, nestedConfigurations: nestedConfigs, ancestorIncludes: ancestorIncludes, developerPath: core.developerPath)
         let parser = MacroConfigFileParser(byteString: data, path: path ?? Path("no path to xcconfig file provided"), delegate: delegate)
         parser.parse()
-        return MacroConfigInfo(table: tableRef.table, diagnostics: diagnostics.diagnostics, dependencyPaths: nestedConfigs.paths, signature: filesSignature(nestedConfigs.paths), isFileReadFailure: false)
+        return MacroConfigInfo(table: tableRef.table, diagnostics: diagnostics.diagnostics, dependencyPaths: nestedConfigs.paths, signature: filesSignature(nestedConfigs.paths), isFileReadFailure: false, finalLineNumber: parser.finalLineNumber, finalColumnNumber: parser.finalColumnNumber)
     }
 }
 

Sources/SWBMacro/MacroConfigFileParser.swift

@@ -42,6 +42,15 @@ public final class MacroConfigFileParser {
     /// Current line number.  Starts at one.
     var currLine: Int
 
+    /// The final line number after parsing completes.
+    public private(set) var finalLineNumber: Int = 1
+
+    /// The final column number after parsing completes.
+    public private(set) var finalColumnNumber: Int = 1
+
+    /// Index of the start of the current line in the byte array.
+    private var currentLineStartIdx: Int = 0
+
 
     /// Initializes the macro expression parser with the given string and delegate.  How the string is parsed depends on the particular parse method that’s invoked, such as `parseAsString()` or `parseAsStringList()`, and not on the configuration of the parser.
     public init(byteString: ByteString, path: Path, delegate: (any MacroConfigFileParserDelegate)?) {
@@ -55,6 +64,9 @@ public final class MacroConfigFileParser {
     /// Returns the current line number of the parser.  This is commonly used from the custom implementations of the parser delegate function callbacks.  Line numbers are one-based, and refer only to the source text of the parser itself (not taking into account any source text included using #include directives).
     public var lineNumber: Int { return currLine }
 
+    /// Returns the current column number of the parser. Column numbers are one-based.
+    public var columnNumber: Int { return currIdx - currentLineStartIdx + 1 }
+
     /*
 
     Grammar:
@@ -131,6 +143,7 @@ public final class MacroConfigFileParser {
         }
         advance(advancement)
         currLine += 1
+        currentLineStartIdx = currIdx
     }
 
 
@@ -461,6 +474,10 @@ public final class MacroConfigFileParser {
 
         // At this point, we expect to have seen all of the input string.
         assert(isAtEndOfStream)
+
+        // Set the final line and column numbers
+        finalLineNumber = currLine
+        finalColumnNumber = columnNumber
     }
 
 

Tests/SWBMacroTests/MacroParsingTests.swift

@@ -824,6 +824,45 @@ fileprivate let testFileData = [
                                   expectedIncludeDirectivesCount: 1
         )
     }
+    
+    @Test
+    func finalLineAndColumnTracking() {
+        // Test empty string
+        TestMacroConfigFileParser("",
+                                  expectedAssignments: [],
+                                  expectedDiagnostics: [],
+                                  expectedIncludeDirectivesCount: 0,
+                                  expectedEndLine: 1,
+                                  expectedEndColumn: 1
+        )
+        
+        // Test single line assignment
+        TestMacroConfigFileParser("A = B",
+                                  expectedAssignments: [(macro: "A", conditions: [], value: "B")],
+                                  expectedDiagnostics: [],
+                                  expectedIncludeDirectivesCount: 0,
+                                  expectedEndLine: 1,
+                                  expectedEndColumn: 6
+        )
+        
+        // Test multiple lines with empty line at end
+        TestMacroConfigFileParser("A = B\n\n",
+                                  expectedAssignments: [(macro: "A", conditions: [], value: "B")],
+                                  expectedDiagnostics: [],
+                                  expectedIncludeDirectivesCount: 0,
+                                  expectedEndLine: 3,
+                                  expectedEndColumn: 1
+        )
+        
+        // Test with comment-only line at end
+        TestMacroConfigFileParser("A = B\n// This is a comment",
+                                  expectedAssignments: [(macro: "A", conditions: [], value: "B")],
+                                  expectedDiagnostics: [],
+                                  expectedIncludeDirectivesCount: 0,
+                                  expectedEndLine: 2,
+                                  expectedEndColumn: 21
+        )
+    }
 }
 
 // We used typealiased tuples for simplicity and readability.
@@ -832,7 +871,7 @@ typealias AssignmentInfo = (macro: String, conditions: [ConditionInfo], value: S
 typealias DiagnosticInfo = (level: MacroConfigFileDiagnostic.Level, kind: MacroConfigFileDiagnostic.Kind, line: Int)
 typealias LocationInfo = (macro: String, path: Path, startLine: Int, endLine: Int, startColumn: Int, endColumn: Int)
 
-private func TestMacroConfigFileParser(_ string: String, expectedAssignments: [AssignmentInfo], expectedDiagnostics: [DiagnosticInfo], expectedLocations: [LocationInfo]? = nil, expectedIncludeDirectivesCount: Int, sourceLocation: SourceLocation = #_sourceLocation) {
+private func TestMacroConfigFileParser(_ string: String, expectedAssignments: [AssignmentInfo], expectedDiagnostics: [DiagnosticInfo], expectedLocations: [LocationInfo]? = nil, expectedIncludeDirectivesCount: Int, expectedEndLine: Int? = nil, expectedEndColumn: Int? = nil, sourceLocation: SourceLocation = #_sourceLocation) {
 
     /// We use a custom delegate to test that we’re getting the expected results, which for the sake of convenience are just kept in (name, conds:[(cond-param, cond-value)], value) tuples, i.e. conditions is an array of two-element tuples.
     class ConfigFileParserTestDelegate : MacroConfigFileParserDelegate {
@@ -873,6 +912,14 @@ private func TestMacroConfigFileParser(_ string: String, expectedAssignments: [A
     // Create a parser, and do the parse.
     let parser = MacroConfigFileParser(byteString: ByteString(encodingAsUTF8: string), path: Path("TestMacroConfigFileParser().xcconfig"), delegate: delegate)
     parser.parse()
+    
+    // Check the final line and column numbers if expected values are provided.
+    if let expectedEndLine {
+        #expect(parser.finalLineNumber == expectedEndLine, "expected final line number \(expectedEndLine), but instead got \(parser.finalLineNumber)", sourceLocation: sourceLocation)
+    }
+    if let expectedEndColumn {
+        #expect(parser.finalColumnNumber == expectedEndColumn, "expected final column number \(expectedEndColumn), but instead got \(parser.finalColumnNumber)", sourceLocation: sourceLocation)
+    }
 
     // Check the assignments that the delegate saw against the expected ones.
     #expect(delegate.assignments == expectedAssignments, "expected assignments \(expectedAssignments), but instead got \(delegate.assignments)", sourceLocation: sourceLocation)