[ASTGen] Move macros related code to a new dedicated module

Introduce 'swiftMacros' module.

Author: rintaro

lib/ASTGen/CMakeLists.txt

@@ -31,13 +31,10 @@ add_pure_swift_host_library(swiftASTGen STATIC
   Sources/ASTGen/Generics.swift
   Sources/ASTGen/LegacyParse.swift
   Sources/ASTGen/Literals.swift
-  Sources/ASTGen/Macros.swift
   Sources/ASTGen/ParameterClause.swift
   Sources/ASTGen/Patterns.swift
-  Sources/ASTGen/PluginHost.swift
   Sources/ASTGen/Regex.swift
   Sources/ASTGen/SourceFile.swift
-  Sources/ASTGen/SourceManager.swift
   Sources/ASTGen/Stmts.swift
   Sources/ASTGen/TypeAttrs.swift
   Sources/ASTGen/Types.swift
@@ -51,19 +48,34 @@ add_pure_swift_host_library(swiftASTGen STATIC
     _CompilerSwiftSyntaxBuilder
     _CompilerSwiftParser
     _CompilerSwiftParserDiagnostics
-    _CompilerSwiftCompilerPluginMessageHandling
-    _CompilerSwiftSyntaxMacroExpansion
     _CompilerSwiftDiagnostics
-    _CompilerSwiftIDEUtils
     ${ASTGen_Swift_dependencies}
 )
 
+add_pure_swift_host_library(swiftMacros STATIC
+  Sources/Macros/Macros.swift
+  Sources/Macros/PluginHost.swift
+  Sources/Macros/SourceManager.swift
+
+  DEPENDENCIES
+    swiftAST
+  SWIFT_DEPENDENCIES
+    _CompilerSwiftCompilerPluginMessageHandling
+    _CompilerSwiftDiagnostics
+    _CompilerSwiftOperators
+    _CompilerSwiftParser
+    _CompilerSwiftSyntax
+    _CompilerSwiftSyntaxMacroExpansion
+    swiftASTGen
+)
+
 add_pure_swift_host_library(swiftIDEUtilsBridging
   Sources/SwiftIDEUtilsBridging/NameMatcherBridging.swift
 
   DEPENDENCIES
     swiftAST
   SWIFT_DEPENDENCIES
+    _CompilerSwiftIDEUtils
     _CompilerSwiftSyntax
     swiftASTGen
 )
@@ -111,7 +123,7 @@ else()
 endif()
 
 if(SWIFT_BUILD_SWIFT_SYNTAX)
-  foreach(target swiftASTGen swiftIDEUtilsBridging)
+  foreach(target swiftASTGen swiftIDEUtilsBridging swiftMacros)
     target_compile_options(${target} PRIVATE ${compile_options})
   endforeach()
 endif()

lib/ASTGen/Package.swift

@@ -54,7 +54,6 @@ let package = Package(
     .target(
       name: "swiftASTGen",
       dependencies: [
-        .product(name: "_SwiftCompilerPluginMessageHandling", package: "swift-syntax"),
         .product(name: "SwiftDiagnostics", package: "swift-syntax"),
         .product(name: "SwiftIfConfig", package: "swift-syntax"),
         .product(name: "SwiftOperators", package: "swift-syntax"),
@@ -68,6 +67,20 @@ let package = Package(
       path: "Sources/ASTGen",
       swiftSettings: swiftSetttings
     ),
+    .target(
+      name: "swiftMacros",
+      dependencies: [
+        "swiftASTGen",
+        .product(name: "_SwiftCompilerPluginMessageHandling", package: "swift-syntax"),
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftDiagnostics", package: "swift-syntax"),
+        .product(name: "SwiftParser", package: "swift-syntax"),
+        .product(name: "SwiftOperators", package: "swift-syntax"),
+        .product(name: "SwiftSyntaxMacroExpansion", package: "swift-syntax"),
+      ],
+      path: "Sources/Macros",
+      swiftSettings: swiftSetttings
+    ),
     .target(
       name: "swiftIDEUtilsBridging",
       dependencies: [

lib/ASTGen/Sources/ASTGen/Bridge.swift

@@ -14,7 +14,7 @@ import ASTBridging
 import BasicBridging
 @_spi(RawSyntax) import SwiftSyntax
 
-protocol BridgedNullable: ExpressibleByNilLiteral {
+public protocol BridgedNullable: ExpressibleByNilLiteral {
   associatedtype RawPtr
   init(raw: RawPtr?)
 }
@@ -105,7 +105,7 @@ extension String {
     )
   }
 
-  mutating func withBridgedString<R>(_ body: (BridgedStringRef) throws -> R) rethrows -> R {
+  public mutating func withBridgedString<R>(_ body: (BridgedStringRef) throws -> R) rethrows -> R {
     try withUTF8 { buffer in
       try body(BridgedStringRef(data: buffer.baseAddress, count: buffer.count))
     }
@@ -119,7 +119,7 @@ extension SyntaxText {
 }
 
 /// Allocate a copy of the given string as a null-terminated UTF-8 string.
-func allocateBridgedString(
+public func allocateBridgedString(
   _ string: String
 ) -> BridgedStringRef {
   var string = string
@@ -143,12 +143,6 @@ public func freeBridgedString(bridged: BridgedStringRef) {
   bridged.data?.deallocate()
 }
 
-extension BridgedStringRef {
-  var isEmptyInitialized: Bool {
-    return self.data == nil && self.count == 0
-  }
-}
-
 extension BridgedStringRef: /*@retroactive*/ Swift.ExpressibleByStringLiteral {
   public init(stringLiteral str: StaticString) {
     self.init(data: str.utf8Start, count: str.utf8CodeUnitCount)

lib/ASTGen/Sources/ASTGen/DiagnosticsBridge.swift

@@ -100,7 +100,7 @@ fileprivate func emitDiagnosticParts(
 }
 
 /// Emit the given diagnostic via the diagnostic engine.
-func emitDiagnostic(
+public func emitDiagnostic(
   diagnosticEngine: BridgedDiagnosticEngine,
   sourceFileBuffer: UnsafeBufferPointer<UInt8>,
   sourceFileBufferOffset: Int = 0,
@@ -146,7 +146,7 @@ func emitDiagnostic(
 }
 
 extension DiagnosticSeverity {
-  var bridged: BridgedDiagnosticSeverity {
+  public var bridged: BridgedDiagnosticSeverity {
     switch self {
     case .error: return .error
     case .note: return .note
@@ -159,141 +159,6 @@ extension DiagnosticSeverity {
   }
 }
 
-extension SourceManager {
-  private func diagnoseSingle<Node: SyntaxProtocol>(
-    message: String,
-    severity: DiagnosticSeverity,
-    node: Node,
-    position: AbsolutePosition,
-    highlights: [Syntax] = [],
-    fixItChanges: [FixIt.Change] = []
-  ) {
-    // Map severity
-    let bridgedSeverity = severity.bridged
-
-    // Emit the diagnostic
-    var mutableMessage = message
-    let diag = mutableMessage.withBridgedString { bridgedMessage in
-      BridgedDiagnostic(
-        at: bridgedSourceLoc(for: node, at: position),
-        message: bridgedMessage,
-        severity: bridgedSeverity,
-        engine: bridgedDiagEngine
-      )
-    }
-
-    // Emit highlights
-    for highlight in highlights {
-      diag.highlight(
-        start: bridgedSourceLoc(for: highlight, at: highlight.positionAfterSkippingLeadingTrivia),
-        end: bridgedSourceLoc(for: highlight, at: highlight.endPositionBeforeTrailingTrivia)
-      )
-    }
-
-    // Emit changes for a Fix-It.
-    for change in fixItChanges {
-      let replaceStartLoc: BridgedSourceLoc
-      let replaceEndLoc: BridgedSourceLoc
-      var newText: String
-
-      switch change {
-      case .replace(let oldNode, let newNode):
-        replaceStartLoc = bridgedSourceLoc(
-          for: oldNode,
-          at: oldNode.positionAfterSkippingLeadingTrivia
-        )
-        replaceEndLoc = bridgedSourceLoc(
-          for: oldNode,
-          at: oldNode.endPositionBeforeTrailingTrivia
-        )
-        newText = newNode.description
-
-      case .replaceLeadingTrivia(let oldToken, let newTrivia):
-        replaceStartLoc = bridgedSourceLoc(for: oldToken)
-        replaceEndLoc = bridgedSourceLoc(
-          for: oldToken,
-          at: oldToken.positionAfterSkippingLeadingTrivia
-        )
-        newText = newTrivia.description
-
-      case .replaceTrailingTrivia(let oldToken, let newTrivia):
-        replaceStartLoc = bridgedSourceLoc(
-          for: oldToken,
-          at: oldToken.endPositionBeforeTrailingTrivia
-        )
-        replaceEndLoc = bridgedSourceLoc(
-          for: oldToken,
-          at: oldToken.endPosition
-        )
-        newText = newTrivia.description
-
-      case .replaceChild(let replacingChildData):
-        let replacementRange = replacingChildData.replacementRange
-        replaceStartLoc = bridgedSourceLoc(
-          for: replacingChildData.parent,
-          at: replacementRange.lowerBound
-        )
-        replaceEndLoc = bridgedSourceLoc(
-          for: replacingChildData.parent,
-          at: replacementRange.upperBound
-        )
-        newText = replacingChildData.newChild.description
-        
-#if RESILIENT_SWIFT_SYNTAX
-      @unknown default:
-        fatalError()
-#endif
-      }
-
-      newText.withBridgedString { bridgedMessage in
-        diag.fixItReplace(
-          start: replaceStartLoc,
-          end: replaceEndLoc,
-          replacement: bridgedMessage
-        )
-      }
-    }
-
-    diag.finish();
-  }
-
-  /// Emit a diagnostic via the C++ diagnostic engine.
-  func diagnose(
-    diagnostic: Diagnostic,
-    messageSuffix: String? = nil
-  ) {
-    // Emit the main diagnostic.
-    diagnoseSingle(
-      message: diagnostic.diagMessage.message + (messageSuffix ?? ""),
-      severity: diagnostic.diagMessage.severity,
-      node: diagnostic.node,
-      position: diagnostic.position,
-      highlights: diagnostic.highlights
-    )
-
-    // Emit Fix-Its.
-    for fixIt in diagnostic.fixIts {
-      diagnoseSingle(
-        message: fixIt.message.message,
-        severity: .note,
-        node: diagnostic.node,
-        position: diagnostic.position,
-        fixItChanges: fixIt.changes
-      )
-    }
-
-    // Emit any notes as follow-ons.
-    for note in diagnostic.notes {
-      diagnoseSingle(
-        message: note.message,
-        severity: .note,
-        node: note.node,
-        position: note.position
-      )
-    }
-  }
-}
-
 struct QueuedDiagnostics {
   var grouped: GroupedDiagnostics = GroupedDiagnostics()
 

lib/ASTGen/Sources/ASTGen/SourceFile.swift

@@ -25,18 +25,18 @@ public struct ExportedSourceFile {
   public let buffer: UnsafeBufferPointer<UInt8>
 
   /// The name of the enclosing module.
-  let moduleName: String
+  public let moduleName: String
 
   /// The name of the source file being parsed.
-  let fileName: String
+  public let fileName: String
 
   /// The syntax tree for the complete source file.
   public let syntax: SourceFileSyntax
 
   /// A source location converter to convert `AbsolutePosition`s in `syntax` to line/column locations.
   ///
   /// Cached so we don't need to re-build the line table every time we need to convert a position.
-  let sourceLocationConverter: SourceLocationConverter
+  public let sourceLocationConverter: SourceLocationConverter
 
   /// Configured regions for this source file.
   ///
@@ -200,3 +200,64 @@ public func emitParserDiagnostics(
     return anyDiags ? 1 : 0
   }
 }
+
+/// Retrieve a syntax node in the given source file, with the given type.
+public func findSyntaxNodeInSourceFile<Node: SyntaxProtocol>(
+  sourceFilePtr: UnsafeRawPointer,
+  sourceLocationPtr: UnsafePointer<UInt8>?,
+  type: Node.Type,
+  wantOutermost: Bool = false
+) -> Node? {
+  guard let sourceLocationPtr = sourceLocationPtr else {
+    return nil
+  }
+
+  let sourceFilePtr = sourceFilePtr.assumingMemoryBound(to: ExportedSourceFile.self)
+
+  // Find the offset.
+  let buffer = sourceFilePtr.pointee.buffer
+  let offset = sourceLocationPtr - buffer.baseAddress!
+  if offset < 0 || offset >= buffer.count {
+    print("source location isn't inside this buffer")
+    return nil
+  }
+
+  // Find the token at that offset.
+  let sf = sourceFilePtr.pointee.syntax
+  guard let token = sf.token(at: AbsolutePosition(utf8Offset: offset)) else {
+    print("couldn't find token at offset \(offset)")
+    return nil
+  }
+
+  var currentSyntax = Syntax(token)
+  var resultSyntax: Node? = nil
+  while let parentSyntax = currentSyntax.parent {
+    currentSyntax = parentSyntax
+    if let typedParent = currentSyntax.as(type) {
+      resultSyntax = typedParent
+      break
+    }
+  }
+
+  // If we didn't find anything, complain and fail.
+  guard var resultSyntax else {
+    print("unable to find node: \(token.debugDescription)")
+    return nil
+  }
+
+  // If we want the outermost node, keep looking.
+  // E.g. for 'foo.bar' we want the member ref expression instead of the
+  // identifier expression.
+  if wantOutermost {
+    while let parentSyntax = currentSyntax.parent,
+      parentSyntax.position == resultSyntax.position
+    {
+      currentSyntax = parentSyntax
+      if let typedParent = currentSyntax.as(type) {
+        resultSyntax = typedParent
+      }
+    }
+  }
+
+  return resultSyntax
+}