Merge pull request #1555 from ahoppen/ahoppen/no-deprecations

Remove deprecated methods from SwiftSyntaxMacros

Author: ahoppen

Sources/SwiftCompilerPluginMessageHandling/PluginMacroExpansionContext.swift

@@ -211,7 +211,7 @@ class PluginMacroExpansionContext {
 
 extension PluginMacroExpansionContext: MacroExpansionContext {
   /// Generate a unique name for use in the macro.
-  public func createUniqueName(_ providedName: String) -> TokenSyntax {
+  public func makeUniqueName(_ providedName: String) -> TokenSyntax {
     // If provided with an empty name, substitute in something.
     let name = providedName.isEmpty ? "__local" : providedName
 
@@ -246,11 +246,10 @@ extension PluginMacroExpansionContext: MacroExpansionContext {
     of node: Node,
     at positionMode: PositionInSyntaxNode,
     filePathMode: SourceLocationFilePathMode
-  ) -> SourceLocation? {
-    return sourceManger.location(
-      of: Syntax(node),
-      at: positionMode,
-      filePathMode: filePathMode
-    )
+  ) -> AbstractSourceLocation? {
+    guard let location = sourceManger.location(of: Syntax(node), at: positionMode, filePathMode: filePathMode) else {
+      return nil
+    }
+    return AbstractSourceLocation(location)
   }
 }

Sources/SwiftSyntaxMacros/AbstractSourceLocation.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import SwiftSyntax
+import SwiftSyntaxBuilder
 
 /// Abstractly represents a source location in the macro.
 public struct AbstractSourceLocation {
@@ -22,4 +23,18 @@ public struct AbstractSourceLocation {
 
   /// A primary expression that represents the column and is `ExpressibleByIntegerLiteral`.
   public let column: ExprSyntax
+
+  public init(file: ExprSyntax, line: ExprSyntax, column: ExprSyntax) {
+    self.file = file
+    self.line = line
+    self.column = column
+  }
+
+  public init(_ sourceLocation: SourceLocation) {
+    self = AbstractSourceLocation(
+      file: "\(literal: sourceLocation.file)",
+      line: "\(literal: sourceLocation.line)",
+      column: "\(literal: sourceLocation.column)"
+    )
+  }
 }

Sources/SwiftSyntaxMacros/BasicMacroExpansionContext.swift

@@ -139,7 +139,7 @@ extension BasicMacroExpansionContext: MacroExpansionContext {
     of node: Node,
     at position: PositionInSyntaxNode,
     filePathMode: SourceLocationFilePathMode
-  ) -> SourceLocation? {
+  ) -> AbstractSourceLocation? {
     // Dig out the root source file and figure out how we need to adjust the
     // offset of the given syntax node to adjust for it.
     let rootSourceFile: SourceFileSyntax
@@ -188,6 +188,6 @@ extension BasicMacroExpansionContext: MacroExpansionContext {
 
     // Do the location lookup.
     let converter = SourceLocationConverter(file: fileName, tree: rootSourceFile)
-    return converter.location(for: rawPosition.advanced(by: offsetAdjustment))
+    return AbstractSourceLocation(converter.location(for: rawPosition.advanced(by: offsetAdjustment)))
   }
 }

Sources/SwiftSyntaxMacros/MacroExpansionContext.swift

@@ -17,17 +17,6 @@ import SwiftSyntaxBuilder
 /// Interface to extract information about the context in which a given
 /// macro is expanded.
 public protocol MacroExpansionContext: AnyObject {
-  /// Generate a unique name for use in the macro.
-  ///
-  /// - Parameters:
-  ///   - name: The name to use as a basis for the uniquely-generated name,
-  ///     which will appear in the unique name that's produced here.
-  ///
-  /// - Returns: an identifier token containing a unique name that will not
-  ///   conflict with any other name in a well-formed program.
-  @available(*, renamed: "makeUniqueName(_:)")
-  func createUniqueName(_ name: String) -> TokenSyntax
-
   /// Generate a unique name for use in the macro.
   ///
   /// - Parameters:
@@ -53,26 +42,6 @@ public protocol MacroExpansionContext: AnyObject {
   /// - Returns: the source location within the given node, or `nil` if the
   ///   given syntax node is not rooted in a source file that the macro
   ///   expansion context knows about.
-  @available(*, deprecated, message: "Please use AbstractSourceLocation version")
-  func location<Node: SyntaxProtocol>(
-    of node: Node,
-    at position: PositionInSyntaxNode,
-    filePathMode: SourceLocationFilePathMode
-  ) -> SourceLocation?
-
-  /// Retrieve a source location for the given syntax node.
-  ///
-  /// - Parameters:
-  ///   - node: The syntax node whose source location to produce.
-  ///   - position: The position within the syntax node for the resulting
-  ///     location.
-  ///   - filePathMode: How the file name contained in the source location is
-  ///     formed.
-  ///
-  /// - Returns: the source location within the given node, or `nil` if the
-  ///   given syntax node is not rooted in a source file that the macro
-  ///   expansion context knows about.
-  @_disfavoredOverload
   func location<Node: SyntaxProtocol>(
     of node: Node,
     at position: PositionInSyntaxNode,
@@ -90,87 +59,13 @@ extension MacroExpansionContext {
   /// - Returns: the source location within the given node, or `nil` if the
   ///   given syntax node is not rooted in a source file that the macro
   ///   expansion context knows about.
-  @available(*, deprecated, message: "Please use AbstractSourceLocation version")
-  public func location<Node: SyntaxProtocol>(
-    of node: Node
-  ) -> SourceLocation? {
-    return location(of: node, at: .afterLeadingTrivia, filePathMode: .fileID)
-  }
-
-  /// Retrieve a source location for the given syntax node's starting token
-  /// (after leading trivia) using file naming according to `#fileID`.
-  ///
-  /// - Parameters:
-  ///   - node: The syntax node whose source location to produce.
-  ///
-  /// - Returns: the source location within the given node, or `nil` if the
-  ///   given syntax node is not rooted in a source file that the macro
-  ///   expansion context knows about.
-  @_disfavoredOverload
   public func location<Node: SyntaxProtocol>(
     of node: Node
   ) -> AbstractSourceLocation? {
     return location(of: node, at: .afterLeadingTrivia, filePathMode: .fileID)
   }
 }
 
-extension MacroExpansionContext {
-  /// Retrieve a source location for the given syntax node.
-  ///
-  /// - Parameters:
-  ///   - node: The syntax node whose source location to produce.
-  ///   - position: The position within the syntax node for the resulting
-  ///     location.
-  ///   - filePathMode: How the file name contained in the source location is
-  ///     formed.
-  ///
-  /// - Returns: the source location within the given node, or `nil` if the
-  ///   given syntax node is not rooted in a source file that the macro
-  ///   expansion context knows about.
-  @_disfavoredOverload
-  @available(*, deprecated, message: "Please use AbstractSourceLocation version")
-  public func location<Node: SyntaxProtocol>(
-    of node: Node,
-    at position: PositionInSyntaxNode,
-    filePathMode: SourceLocationFilePathMode
-  ) -> AbstractSourceLocation? {
-    guard let sourceLoc: SourceLocation = location(of: node, at: position, filePathMode: filePathMode) else {
-      return nil
-    }
-
-    return AbstractSourceLocation(
-      file: "\(literal: sourceLoc.file)",
-      line: "\(literal: sourceLoc.line)",
-      column: "\(literal: sourceLoc.column)"
-    )
-  }
-
-  /// Generate a unique name for use in the macro.
-  ///
-  /// - Parameters:
-  ///   - name: The name to use as a basis for the uniquely-generated name,
-  ///     which will appear in the unique name that's produced here.
-  ///
-  /// - Returns: an identifier token containing a unique name that will not
-  ///   conflict with any other name in a well-formed program.
-  @available(*, renamed: "makeUniqueName(_:)")
-  public func createUniqueName(_ name: String) -> TokenSyntax {
-    makeUniqueName(name)
-  }
-
-  /// Generate a unique name for use in the macro.
-  ///
-  /// - Parameters:
-  ///   - name: The name to use as a basis for the uniquely-generated name,
-  ///     which will appear in the unique name that's produced here.
-  ///
-  /// - Returns: an identifier token containing a unique name that will not
-  ///   conflict with any other name in a well-formed program.
-  public func makeUniqueName(_ name: String) -> TokenSyntax {
-    createUniqueName(name)
-  }
-}
-
 /// Diagnostic message used for thrown errors.
 private struct ThrownErrorDiagnostic: DiagnosticMessage {
   let message: String

Sources/SwiftSyntaxMacros/MacroProtocols/AccessorMacro.swift

@@ -23,6 +23,3 @@ public protocol AccessorMacro: AttachedMacro {
     in context: Context
   ) throws -> [AccessorDeclSyntax]
 }
-
-@available(*, deprecated, renamed: "AccessorMacro")
-public typealias AccessorDeclarationMacro = AccessorMacro

Sources/SwiftSyntaxMacros/MacroProtocols/DeclarationMacro.swift

@@ -21,6 +21,3 @@ public protocol DeclarationMacro: FreestandingMacro {
     in context: Context
   ) throws -> [DeclSyntax]
 }
-
-@available(*, deprecated, renamed: "DeclarationMacro")
-public typealias FreestandingDeclarationMacro = DeclarationMacro

Sources/SwiftSyntaxMacros/MacroProtocols/MemberMacro.swift

@@ -32,6 +32,3 @@ public protocol MemberMacro: AttachedMacro {
     in context: Context
   ) throws -> [DeclSyntax]
 }
-
-@available(*, deprecated, renamed: "MemberMacro")
-public typealias MemberDeclarationMacro = MemberMacro

Sources/SwiftSyntaxMacros/MacroProtocols/PeerMacro.swift

@@ -25,6 +25,3 @@ public protocol PeerMacro: AttachedMacro {
     in context: Context
   ) throws -> [DeclSyntax]
 }
-
-@available(*, deprecated, renamed: "PeerMacro")
-public typealias PeerDeclarationMacro = PeerMacro