Merge pull request #76790 from eeckstein/add-ast-module

SwiftCompilerSources: introduce the AST module

Author: eeckstein

SwiftCompilerSources/Sources/AST/CMakeLists.txt

@@ -0,0 +1,17 @@
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See http://swift.org/LICENSE.txt for license information
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+add_swift_compiler_module(AST
+  DEPENDS
+    Basic
+  SOURCES
+    Declarations.swift
+    Conformance.swift
+    Registration.swift
+    SubstitutionMap.swift
+    Type.swift)

SwiftCompilerSources/Sources/SIL/ProtocolConformance.swift renamed to SwiftCompilerSources/Sources/AST/Conformance.swift

@@ -1,4 +1,4 @@
-//===--- ProtocolConformance.swift ----------------------------------------===//
+//===--- Conformance.swift ------------------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -10,29 +10,41 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SILBridging
+import Basic
+import ASTBridging
 
-// TODO: move `ProtocolConformance` to an AST module, once we have it
+/// Describes how a particular type conforms to a given protocol, providing the mapping from the protocol
+/// members to the type (or extension) members that provide the functionality for the concrete type.
+///
+///  TODO: Ideally, `Conformance` should be an enum
+public struct Conformance: CustomStringConvertible, NoReflectionChildren {
+  public let bridged: BridgedConformance
 
-public struct ProtocolConformance {
-  public let bridged: BridgedProtocolConformance
-
-  init(bridged: BridgedProtocolConformance) {
+  public init(bridged: BridgedConformance) {
     self.bridged = bridged
   }
 
+  public var description: String {
+    return String(taking: bridged.getDebugDescription())
+  }
+
   public var isConcrete: Bool { bridged.isConcrete() }
 
   public var isValid: Bool { bridged.isValid() }
 
+  public var type: Type {
+    assert(isConcrete)
+    return Type(bridged: bridged.getType())
+  }
+
   public var isSpecialized: Bool {
     assert(isConcrete)
     return bridged.isSpecializedConformance()
   }
 
-  public var genericConformance: ProtocolConformance {
+  public var genericConformance: Conformance {
     assert(isSpecialized)
-    return bridged.getGenericConformance().protocolConformance
+    return bridged.getGenericConformance().conformance
   }
 
   public var specializedSubstitutions: SubstitutionMap {
@@ -41,18 +53,18 @@ public struct ProtocolConformance {
   }
 }
 
-public struct ProtocolConformanceArray : RandomAccessCollection, CustomReflectable {
-  public let bridged: BridgedProtocolConformanceArray
+public struct ConformanceArray : RandomAccessCollection, CustomReflectable {
+  public let bridged: BridgedConformanceArray
 
   public var startIndex: Int { return 0 }
   public var endIndex: Int { return bridged.getCount() }
 
-  public init(bridged: BridgedProtocolConformanceArray) {
+  public init(bridged: BridgedConformanceArray) {
     self.bridged = bridged
   }
 
-  public subscript(_ index: Int) -> ProtocolConformance {
-    bridged.getAt(index).protocolConformance
+  public subscript(_ index: Int) -> Conformance {
+    bridged.getAt(index).conformance
   }
 
   public var customMirror: Mirror {
@@ -61,6 +73,6 @@ public struct ProtocolConformanceArray : RandomAccessCollection, CustomReflectab
   }
 }
 
-extension BridgedProtocolConformance {
-  public var protocolConformance: ProtocolConformance { ProtocolConformance(bridged: self) }
+extension BridgedConformance {
+  public var conformance: Conformance { Conformance(bridged: self) }
 }

SwiftCompilerSources/Sources/AST/Declarations.swift

@@ -0,0 +1,135 @@
+//===--- Declarations.swift -----------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Basic
+import ASTBridging
+
+/// The base class for all declarations in Swift.
+@_semantics("arc.immortal")
+public class Decl: CustomStringConvertible, Hashable {
+  public var bridged: BridgedDeclObj { BridgedDeclObj(SwiftObject(self)) }
+
+  public var description: String { String(taking: bridged.getDebugDescription()) }
+
+  public static func ==(lhs: Decl, rhs: Decl) -> Bool { lhs === rhs }
+
+  public func hash(into hasher: inout Hasher) {
+    hasher.combine(ObjectIdentifier(self))
+  }
+}
+
+public class ValueDecl: Decl {
+  final public var nameLoc: SourceLoc? { SourceLoc(bridged: bridged.Value_getNameLoc()) }
+  final public var userFacingName: StringRef { StringRef(bridged: bridged.Value_getUserFacingName()) }
+}
+
+public class TypeDecl: ValueDecl {
+  final public var name: StringRef { StringRef(bridged: bridged.Type_getName()) }
+}
+
+public class GenericTypeDecl: TypeDecl {
+  final public var isGenericAtAnyLevel: Bool { bridged.GenericType_isGenericAtAnyLevel() }
+}
+
+public class NominalTypeDecl: GenericTypeDecl {
+  final public var isGlobalActor: Bool { bridged.NominalType_isGlobalActor() }
+
+  final public var valueTypeDestructor: DestructorDecl? {
+    bridged.NominalType_getValueTypeDestructor().getAs(DestructorDecl.self)
+  }
+}
+
+final public class EnumDecl: NominalTypeDecl {}
+
+final public class StructDecl: NominalTypeDecl {
+  public var hasUnreferenceableStorage: Bool { bridged.Struct_hasUnreferenceableStorage() }
+}
+
+final public class ClassDecl: NominalTypeDecl {
+  public var superClass: Type? { Type(bridgedOrNil: bridged.Class_getSuperclass()) }
+}
+
+final public class ProtocolDecl: NominalTypeDecl {}
+
+final public class BuiltinTupleDecl: NominalTypeDecl {}
+
+final public class OpaqueTypeDecl: GenericTypeDecl {}
+
+final public class TypeAliasDecl: GenericTypeDecl {}
+
+final public class GenericTypeParamDecl: TypeDecl {}
+
+final public class AssociatedTypeDecl: TypeDecl {}
+
+final public class ModuleDecl: TypeDecl {}
+
+public class AbstractStorageDecl: ValueDecl {}
+
+public class VarDecl: AbstractStorageDecl {}
+
+final public class ParamDecl: VarDecl {}
+
+final public class SubscriptDecl: AbstractStorageDecl {}
+
+public class AbstractFunctionDecl: ValueDecl {}
+
+final public class ConstructorDecl: AbstractFunctionDecl {}
+
+final public class DestructorDecl: AbstractFunctionDecl {}
+
+public class FuncDecl: AbstractFunctionDecl {}
+
+final public class AccessorDecl: FuncDecl {}
+
+final public class MacroDecl: ValueDecl {}
+
+final public class EnumElementDecl: ValueDecl {}
+
+final public class ExtensionDecl: Decl {}
+
+final public class TopLevelCodeDecl: Decl {}
+
+final public class ImportDecl: Decl {}
+
+final public class PoundDiagnosticDecl: Decl {}
+
+final public class PrecedenceGroupDecl: Decl {}
+
+final public class MissingDecl: Decl {}
+
+final public class MissingMemberDecl: Decl {}
+
+final public class PatternBindingDecl: Decl {}
+
+final public class EnumCaseDecl: Decl {}
+
+public class OperatorDecl: Decl {}
+
+final public class InfixOperatorDecl: OperatorDecl {}
+
+final public class PrefixOperatorDecl: OperatorDecl {}
+
+final public class PostfixOperatorDecl: OperatorDecl {}
+
+final public class MacroExpansionDecl: Decl {}
+
+// Bridging utilities
+
+extension BridgedDeclObj {
+  public var decl: Decl { obj.getAs(Decl.self) }
+  public func getAs<T: Decl>(_ declType: T.Type) -> T { obj.getAs(T.self) }
+}
+
+extension OptionalBridgedDeclObj {
+  public var decl: Decl? { obj.getAs(Decl.self) }
+  public func getAs<T: Decl>(_ declType: T.Type) -> T? { obj.getAs(T.self) }
+}

SwiftCompilerSources/Sources/AST/Registration.swift

@@ -0,0 +1,56 @@
+//===--- Registration.swift -----------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Basic
+import ASTBridging
+
+public func registerAST() {
+  registerDecl(EnumDecl.self)
+  registerDecl(StructDecl.self)
+  registerDecl(ClassDecl.self)
+  registerDecl(ProtocolDecl.self)
+  registerDecl(BuiltinTupleDecl.self)
+  registerDecl(OpaqueTypeDecl.self)
+  registerDecl(TypeAliasDecl.self)
+  registerDecl(GenericTypeParamDecl.self)
+  registerDecl(AssociatedTypeDecl.self)
+  registerDecl(ModuleDecl.self)
+  registerDecl(VarDecl.self)
+  registerDecl(ParamDecl.self)
+  registerDecl(SubscriptDecl.self)
+  registerDecl(ConstructorDecl.self)
+  registerDecl(DestructorDecl.self)
+  registerDecl(FuncDecl.self)
+  registerDecl(AccessorDecl.self)
+  registerDecl(MacroDecl.self)
+  registerDecl(EnumElementDecl.self)
+  registerDecl(ExtensionDecl.self)
+  registerDecl(TopLevelCodeDecl.self)
+  registerDecl(ImportDecl.self)
+  registerDecl(PoundDiagnosticDecl.self)
+  registerDecl(PrecedenceGroupDecl.self)
+  registerDecl(MissingDecl.self)
+  registerDecl(MissingMemberDecl.self)
+  registerDecl(PatternBindingDecl.self)
+  registerDecl(EnumCaseDecl.self)
+  registerDecl(InfixOperatorDecl.self)
+  registerDecl(PrefixOperatorDecl.self)
+  registerDecl(PostfixOperatorDecl.self)
+  registerDecl(MacroExpansionDecl.self)
+}
+
+private func registerDecl<T: AnyObject>(_ cl: T.Type) {
+  String(describing: cl)._withBridgedStringRef { nameStr in
+    let metatype = unsafeBitCast(cl, to: SwiftMetatype.self)
+    registerBridgedDecl(nameStr, metatype)
+  }
+}

SwiftCompilerSources/Sources/SIL/SubstitutionMap.swift renamed to SwiftCompilerSources/Sources/AST/SubstitutionMap.swift

@@ -2,16 +2,22 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
 
-import SILBridging
+import Basic
+import ASTBridging
 
+/// SubstitutionMap describes the mapping of abstract types to replacement types,
+/// together with associated conformances to use for deriving nested types and conformances.
+///
+/// Substitution maps are primarily used when performing substitutions into any entity that
+/// can reference type parameters and conformances.
 public struct SubstitutionMap {
   public let bridged: BridgedSubstitutionMap
 
@@ -29,15 +35,6 @@ public struct SubstitutionMap {
 
   public var conformances: ConformanceArray { ConformanceArray(substitutionMap: self) }
 
-  public var replacementTypes: OptionalTypeArray {
-    let types = BridgedTypeArray.fromReplacementTypes(bridged)
-    return OptionalTypeArray(bridged: types)
-  }
-
-  public func getMethodSubstitutions(for method: Function) -> SubstitutionMap {
-    return SubstitutionMap(bridged: bridged.getMethodSubstitutions(method.bridged))
-  }
-
   public struct ConformanceArray : BridgedRandomAccessCollection {
     fileprivate let bridgedSubs: BridgedSubstitutionMap
     public let count: Int
@@ -50,9 +47,9 @@ public struct SubstitutionMap {
     public var startIndex: Int { return 0 }
     public var endIndex: Int { return count }
 
-    public subscript(_ index: Int) -> ProtocolConformance {
+    public subscript(_ index: Int) -> Conformance {
       assert(index >= startIndex && index < endIndex)
-      return ProtocolConformance(bridged: bridgedSubs.getConformance(index))
+      return Conformance(bridged: bridgedSubs.getConformance(index))
     }
   }
 }