[ASTGen] Generate MacroDecl

rintaro · rintaro · commit bc64ff29618b · 2024-11-06T00:37:04.000-08:00
diff --git a/include/swift/AST/ASTBridging.h b/include/swift/AST/ASTBridging.h
@@ -38,13 +38,17 @@ class ASTContext;
 struct ASTNode;
 class DeclAttributes;
 class DeclBaseName;
+class DeclName;
 class DeclNameLoc;
 class DeclNameRef;
 class DiagnosticArgument;
 class DiagnosticEngine;
 class Identifier;
 class IfConfigClauseRangeInfo;
 struct LabeledStmtInfo;
+enum class MacroRole : uint32_t;
+class MacroIntroducedDeclName;
+enum class MacroIntroducedDeclNameKind;
 class ProtocolConformanceRef;
 class RegexLiteralPatternFeature;
 class RegexLiteralPatternFeatureKind;
@@ -59,6 +63,7 @@ struct BridgedASTType;
 class BridgedCanType;
 class BridgedASTContext;
 struct BridgedSubstitutionMap;
+class BridgedParameterList;
 
 //===----------------------------------------------------------------------===//
 // MARK: Identifier
@@ -114,6 +119,20 @@ SWIFT_NAME("BridgedDeclBaseName.createIdentifier(_:)")
 BridgedDeclBaseName
 BridgedDeclBaseName_createIdentifier(BridgedIdentifier identifier);
 
+class BridgedDeclName {
+  void *_Nonnull opaque;
+
+public:
+  BRIDGED_INLINE BridgedDeclName(swift::DeclName name);
+
+  BRIDGED_INLINE swift::DeclName unbridged() const;
+};
+
+SWIFT_NAME("BridgedDeclName.createParsed(_:baseName:paramList:)")
+BridgedDeclName BridgedDeclName_createParsed(BridgedASTContext cContext,
+                                             BridgedDeclBaseName cBaseName,
+                                             BridgedParameterList cParamList);
+
 class BridgedDeclNameRef {
   void *_Nonnull opaque;
 
@@ -681,6 +700,51 @@ BridgedMainTypeAttr BridgedMainTypeAttr_createParsed(BridgedASTContext cContext,
                                                      BridgedSourceLoc cAtLoc,
                                                      BridgedSourceLoc cNameLoc);
 
+enum ENUM_EXTENSIBILITY_ATTR(closed) BridgedMacroSyntax {
+  BridgedMacroSyntaxFreestanding,
+  BridgedMacroSyntaxAttached,
+};
+
+enum ENUM_EXTENSIBILITY_ATTR(closed) BridgedMacroIntroducedDeclNameKind {
+  BridgedMacroIntroducedDeclNameKindNamed,
+  BridgedMacroIntroducedDeclNameKindOverloaded,
+  BridgedMacroIntroducedDeclNameKindPrefixed,
+  BridgedMacroIntroducedDeclNameKindSuffixed,
+  BridgedMacroIntroducedDeclNameKindArbitrary,
+};
+
+BRIDGED_INLINE swift::MacroIntroducedDeclNameKind
+unbridge(BridgedMacroIntroducedDeclNameKind kind);
+
+struct BridgedMacroIntroducedDeclName {
+  BridgedMacroIntroducedDeclNameKind kind;
+  BridgedDeclName name;
+
+  BRIDGED_INLINE swift::MacroIntroducedDeclName unbridged() const;
+};
+
+enum ENUM_EXTENSIBILITY_ATTR(closed) BridgedMacroRole {
+#define MACRO_ROLE(Name, Description) BridgedMacroRole##Name,
+#include "swift/Basic/MacroRoles.def"
+  BridgedMacroRoleNone,
+};
+
+BRIDGED_INLINE swift::MacroRole unbridge(BridgedMacroRole cRole);
+
+SWIFT_NAME("BridgedMacroRole.init(from:)")
+BridgedMacroRole BridgedMacroRole_fromString(BridgedStringRef str);
+
+SWIFT_NAME("getter:BridgedMacroRole.isAttached(self:)")
+BRIDGED_INLINE bool BridgedMacroRole_isAttached(BridgedMacroRole role);
+
+SWIFT_NAME("BridgedMacroRoleAttr.createParsed(_:atLoc:range:syntax:lParenLoc:"
+           "role:names:conformances:rParenLoc:)")
+BridgedMacroRoleAttr BridgedMacroRoleAttr_createParsed(
+    BridgedASTContext cContext, BridgedSourceLoc cAtLoc,
+    BridgedSourceRange cRange, BridgedMacroSyntax cSyntax,
+    BridgedSourceLoc cLParenLoc, BridgedMacroRole cRole, BridgedArrayRef cNames,
+    BridgedArrayRef cConformances, BridgedSourceLoc cRParenLoc);
+
 SWIFT_NAME(
     "BridgedSwiftNativeObjCRuntimeBaseAttr.createParsed(_:atLoc:range:name:)")
 BridgedSwiftNativeObjCRuntimeBaseAttr
@@ -980,6 +1044,16 @@ BridgedAssociatedTypeDecl BridgedAssociatedTypeDecl_createParsed(
     BridgedNullableTypeRepr opaqueDefaultType,
     BridgedNullableTrailingWhereClause genericWhereClause);
 
+SWIFT_NAME(
+    "BridgedMacroDecl.createParsed(_:declContext:macroKeywordLoc:name:nameLoc:"
+    "genericParamList:paramList:arrowLoc:resultType:definition:)")
+BridgedMacroDecl BridgedMacroDecl_createParsed(
+    BridgedASTContext cContext, BridgedDeclContext cDeclContext,
+    BridgedSourceLoc cMacroLoc, BridgedIdentifier cName,
+    BridgedSourceLoc cNameLoc, BridgedNullableGenericParamList cGenericParams,
+    BridgedParameterList cParams, BridgedSourceLoc cArrowLoc,
+    BridgedNullableTypeRepr cResultType, BridgedNullableExpr cDefinition);
+
 SWIFT_NAME("BridgedMacroExpansionDecl.createParsed(_:poundLoc:macroNameRef:"
            "macroNameLoc:leftAngleLoc:genericArgs:rightAngleLoc:args:)")
 BridgedMacroExpansionDecl BridgedMacroExpansionDecl_createParsed(
diff --git a/include/swift/AST/ASTBridgingImpl.h b/include/swift/AST/ASTBridgingImpl.h
@@ -18,6 +18,7 @@
 #include "swift/AST/Decl.h"
 #include "swift/AST/Expr.h"
 #include "swift/AST/IfConfigClauseRangeInfo.h"
+#include "swift/AST/MacroDeclaration.h"
 #include "swift/AST/ProtocolConformance.h"
 #include "swift/AST/ProtocolConformanceRef.h"
 #include "swift/AST/SourceFile.h"
@@ -48,6 +49,17 @@ swift::DeclBaseName BridgedDeclBaseName::unbridged() const {
   return swift::DeclBaseName(Ident.unbridged());
 }
 
+//===----------------------------------------------------------------------===//
+// MARK: BridgedDeclName
+//===----------------------------------------------------------------------===//
+
+BridgedDeclName::BridgedDeclName(swift::DeclName name)
+    : opaque(name.getOpaqueValue()) {}
+
+swift::DeclName BridgedDeclName::unbridged() const {
+  return swift::DeclName::getFromOpaqueValue(opaque);
+}
+
 //===----------------------------------------------------------------------===//
 // MARK: BridgedDeclNameRef
 //===----------------------------------------------------------------------===//
@@ -355,6 +367,45 @@ BridgedConformance BridgedConformanceArray::getAt(SwiftInt index) const {
   return pcArray.unbridged<swift::ProtocolConformanceRef>()[index];
 }
 
+//===----------------------------------------------------------------------===//
+// MARK: Macros
+//===----------------------------------------------------------------------===//
+
+swift::MacroRole unbridge(BridgedMacroRole cRole) {
+  switch (cRole) {
+#define MACRO_ROLE(Name, Description)                                          \
+  case BridgedMacroRole##Name:                                                 \
+    return swift::MacroRole::Name;
+#include "swift/Basic/MacroRoles.def"
+  case BridgedMacroRoleNone:
+    break;
+  }
+  assert(false && "invalid macro role");
+}
+
+swift::MacroIntroducedDeclNameKind
+unbridge(BridgedMacroIntroducedDeclNameKind kind) {
+  switch (kind) {
+#define CASE(ID)                                                               \
+  case BridgedMacroIntroducedDeclNameKind##ID:                                 \
+    return swift::MacroIntroducedDeclNameKind::ID;
+    CASE(Named)
+    CASE(Overloaded)
+    CASE(Prefixed)
+    CASE(Suffixed)
+    CASE(Arbitrary)
+  }
+}
+
+bool BridgedMacroRole_isAttached(BridgedMacroRole role) {
+  return isAttachedMacro(unbridge(role));
+}
+
+swift::MacroIntroducedDeclName
+BridgedMacroIntroducedDeclName::unbridged() const {
+  return swift::MacroIntroducedDeclName(unbridge(kind), name.unbridged());
+}
+
 //===----------------------------------------------------------------------===//
 // MARK: BridgedSubstitutionMap
 //===----------------------------------------------------------------------===//
diff --git a/lib/AST/Bridging/DeclAttributeBridging.cpp b/lib/AST/Bridging/DeclAttributeBridging.cpp
@@ -266,6 +266,44 @@ BridgedInlineAttr BridgedInlineAttr_createParsed(BridgedASTContext cContext,
       InlineAttr(cAtLoc.unbridged(), cRange.unbridged(), unbridged(cKind));
 }
 
+BridgedMacroRole BridgedMacroRole_fromString(BridgedStringRef str) {
+  // Match the role string to the known set of roles.
+  auto role =
+      llvm::StringSwitch<std::optional<BridgedMacroRole>>(str.unbridged())
+#define MACRO_ROLE(Name, Description) .Case(Description, BridgedMacroRole##Name)
+#include "swift/Basic/MacroRoles.def"
+          .Default(std::nullopt);
+  return role.has_value() ? *role : BridgedMacroRoleNone;
+}
+
+MacroSyntax unbridge(BridgedMacroSyntax cSyntax) {
+  switch (cSyntax) {
+  case BridgedMacroSyntaxAttached:
+    return MacroSyntax::Attached;
+  case BridgedMacroSyntaxFreestanding:
+    return MacroSyntax::Freestanding;
+  }
+}
+
+BridgedMacroRoleAttr BridgedMacroRoleAttr_createParsed(
+    BridgedASTContext cContext, BridgedSourceLoc cAtLoc,
+    BridgedSourceRange cRange, BridgedMacroSyntax cSyntax,
+    BridgedSourceLoc cLParenLoc, BridgedMacroRole cRole, BridgedArrayRef cNames,
+    BridgedArrayRef cConformances, BridgedSourceLoc cRParenLoc) {
+  SmallVector<MacroIntroducedDeclName, 2> names;
+  for (auto &n : cNames.unbridged<BridgedMacroIntroducedDeclName>())
+    names.push_back(n.unbridged());
+
+  SmallVector<TypeExpr *, 2> conformances;
+  for (auto &t : cConformances.unbridged<BridgedTypeExpr>())
+    conformances.push_back(t.unbridged());
+
+  return MacroRoleAttr::create(
+      cContext.unbridged(), cAtLoc.unbridged(), cRange.unbridged(),
+      unbridge(cSyntax), cLParenLoc.unbridged(), unbridge(cRole), names,
+      conformances, cRParenLoc.unbridged(), /*implicit=*/false);
+}
+
 BridgedMainTypeAttr
 BridgedMainTypeAttr_createParsed(BridgedASTContext cContext,
                                  BridgedSourceLoc cAtLoc,
diff --git a/lib/AST/Bridging/DeclBridging.cpp b/lib/AST/Bridging/DeclBridging.cpp
@@ -304,6 +304,22 @@ BridgedDestructorDecl_createParsed(BridgedASTContext cContext,
   return decl;
 }
 
+BridgedMacroDecl BridgedMacroDecl_createParsed(
+    BridgedASTContext cContext, BridgedDeclContext cDeclContext,
+    BridgedSourceLoc cMacroLoc, BridgedIdentifier cName,
+    BridgedSourceLoc cNameLoc, BridgedNullableGenericParamList cGenericParams,
+    BridgedParameterList cParams, BridgedSourceLoc cArrowLoc,
+    BridgedNullableTypeRepr cResultType, BridgedNullableExpr cDefinition) {
+  ASTContext &context = cContext.unbridged();
+  auto *params = cParams.unbridged();
+  DeclName fullName = DeclName(context, cName.unbridged(), params);
+  return new (context)
+      MacroDecl(cMacroLoc.unbridged(), fullName, cNameLoc.unbridged(),
+                cGenericParams.unbridged(), params, cArrowLoc.unbridged(),
+                cResultType.unbridged(), cDefinition.unbridged(),
+                cDeclContext.unbridged());
+}
+
 BridgedTypeAliasDecl BridgedTypeAliasDecl_createParsed(
     BridgedASTContext cContext, BridgedDeclContext cDeclContext,
     BridgedSourceLoc cAliasKeywordLoc, BridgedIdentifier cName,
diff --git a/lib/ASTGen/Sources/ASTGen/DeclAttrs.swift b/lib/ASTGen/Sources/ASTGen/DeclAttrs.swift
@@ -135,7 +135,7 @@ extension ASTGenVisitor {
       case .mainType:
         return self.generateMainTypeAttr(attribute: node)?.asDeclAttribute
       case .macroRole:
-        fatalError("unimplemented")
+        return self.generateMacroRoleAttr(attribute: node, attrName: attrName)?.asDeclAttribute
       case .noExistentials:
         fatalError("unimplemented")
       case .noObjCBridging:
@@ -674,6 +674,116 @@ extension ASTGenVisitor {
     )
   }
 
+  func generateMacroIntroducedDeclName(expr: ExprSyntax) -> BridgedMacroIntroducedDeclName? {
+    fatalError("unimplemented")
+  }
+
+  func generateMacroIntroducedConformance(expr: ExprSyntax) -> BridgedTypeExpr? {
+    fatalError("unimplemented")
+  }
+
+  func generateMacroRoleAttr(attribute node: AttributeSyntax, attrName: SyntaxText) -> BridgedMacroRoleAttr? {
+    // '@freestanding' or '@attached'.
+    assert(attrName == "freestanding" || attrName == "attached")
+    let syntax: BridgedMacroSyntax =
+      attrName == "freestanding" ? .freestanding : .attached;
+    let isAttached = syntax == .attached
+
+    // Start consuming arguments.
+    guard
+      var args = node.arguments?.as(LabeledExprListSyntax.self)?[...]
+    else {
+      // TODO: Diagnose.
+      return nil
+    }
+
+    // Macro role.
+    let role = self.generateConsumingPlainIdentifierAttrOption(args: &args) {
+      BridgedMacroRole(from: $0.rawText.bridged)
+    }
+    guard let role = role else {
+      return nil
+    }
+    guard role != .none else {
+      // TODO: Diagnose.
+      return nil
+    }
+    if role.isAttached != isAttached {
+      // TODO: Diagnose.
+      return nil
+    }
+
+    var names: [BridgedMacroIntroducedDeclName] = []
+    var conformances: [BridgedTypeExpr] = []
+
+    enum ArgState {
+    case inNames
+    case inConformances
+    case inInvalid
+    }
+    // We assume we're in 'names:' arguments.
+    var argState: ArgState = .inNames
+    // Seen at 'names:' argument label.
+    var seenNames = false
+    // Seen at 'conformances:' argument label.
+    var seenConformances = false
+
+    LOOP: while let arg = args.popFirst() {
+      // Argument state.
+      if let label = arg.label {
+        switch label {
+        case .identifier("names"):
+          argState = .inNames
+          if seenNames {
+            // TODO: Diagnose duplicated 'names:'.
+          }
+          seenNames = true
+        case .identifier("conformances"):
+          argState = .inConformances
+          if seenConformances {
+            // TODO: Diagnose duplicated 'conformances:'.
+          }
+          seenConformances = true
+        default:
+          // Invalid label.
+          // TODO: Diagnose `no argument with label '\(label)'`.
+          argState = .inInvalid
+        }
+      } else if argState == .inNames && !seenNames {
+        // E.g. `@attached(member, named(foo))` this is missing 'names:'
+        // TODO: Diagnose to insert 'names:'
+        seenNames = true
+      }
+
+      // Argument values.
+      switch argState {
+      case .inNames:
+        if let name = self.generateMacroIntroducedDeclName(expr: arg.expression) {
+          names.append(name)
+        }
+      case .inConformances:
+        if let conformance = self.generateMacroIntroducedConformance(expr: arg.expression) {
+          conformances.append(conformance)
+        }
+      case .inInvalid:
+        // Ignore the value.
+        break
+      }
+    }
+
+    return .createParsed(
+      self.ctx,
+      atLoc: self.generateSourceLoc(node.atSign),
+      range: self.generateSourceRange(node),
+      syntax: syntax,
+      lParenLoc: self.generateSourceLoc(node.leftParen),
+      role: role,
+      names: names.lazy.bridgedArray(in: self),
+      conformances: conformances.lazy.bridgedArray(in: self),
+      rParenLoc: self.generateSourceLoc(node.rightParen)
+    )
+  }
+
   func generateNonSendableAttr(attribute node: AttributeSyntax) -> BridgedNonSendableAttr? {
     let kind: BridgedNonSendableKind? = self.generateSingleAttrOption(
       attribute: node,
diff --git a/lib/ASTGen/Sources/ASTGen/Decls.swift b/lib/ASTGen/Sources/ASTGen/Decls.swift
