Merge pull request swiftlang#63538 from hborla/peer-macros

hborla · web-flow · commit 5bfc7e6dacb8 · 2023-02-11T10:57:28.000-08:00
[Macros] Initial implementation of peer macros.
diff --git a/include/swift/AST/MacroDeclaration.h b/include/swift/AST/MacroDeclaration.h
@@ -49,6 +49,9 @@ enum class MacroRole: uint32_t {
   /// An attached macro that generates synthesized members
   /// inside the declaration.
   Member = 0x10,
+  /// An attached macro that generates declarations that are peers
+  /// of the declaration the macro is attached to.
+  Peer = 0x20,
 };
 
 /// The contexts in which a particular macro declaration can be used.
diff --git a/include/swift/AST/TypeCheckRequests.h b/include/swift/AST/TypeCheckRequests.h
@@ -3884,6 +3884,23 @@ class CompilerPluginLoadRequest
   bool isCached() const { return true; }
 };
 
+/// Expand peer macros attached to the given declaration.
+class ExpandPeerMacroRequest
+    : public SimpleRequest<ExpandPeerMacroRequest,
+                           bool(Decl *),
+                           RequestFlags::Cached> {
+public:
+  using SimpleRequest::SimpleRequest;
+
+private:
+  friend SimpleRequest;
+
+  bool evaluate(Evaluator &evaluator, Decl *decl) const;
+
+public:
+  bool isCached() const { return true; }
+};
+
 /// Resolve an external macro given its module and type name.
 class ExternalMacroDefinitionRequest
     : public SimpleRequest<ExternalMacroDefinitionRequest,
diff --git a/include/swift/AST/TypeCheckerTypeIDZone.def b/include/swift/AST/TypeCheckerTypeIDZone.def
@@ -437,6 +437,9 @@ SWIFT_REQUEST(TypeChecker, ExpandMemberAttributeMacros,
 SWIFT_REQUEST(TypeCHecker, ExpandSynthesizedMemberMacroRequest,
               bool(Decl *),
               Cached, NoLocationInfo)
+SWIFT_REQUEST(TypeChecker, ExpandPeerMacroRequest,
+              bool(Decl *),
+              Cached, NoLocationInfo)
 SWIFT_REQUEST(TypeChecker, SynthesizeRuntimeMetadataAttrGenerator,
               Expr *(CustomAttr *, ValueDecl *),
               Cached, NoLocationInfo)
diff --git a/include/swift/Basic/SourceManager.h b/include/swift/Basic/SourceManager.h
@@ -47,6 +47,9 @@ class GeneratedSourceInfo {
     /// The expansion of an attached member macro.
     MemberMacroExpansion,
 
+    /// The expansion of an attached peer macro.
+    PeerMacroExpansion,
+
     /// A new function body that is replacing an existing function body.
     ReplacedFunctionBody,
 
diff --git a/include/swift/Demangling/DemangleNodes.def b/include/swift/Demangling/DemangleNodes.def
@@ -182,6 +182,7 @@ CONTEXT_NODE(OwningAddressor)
 CONTEXT_NODE(OwningMutableAddressor)
 NODE(PartialApplyForwarder)
 NODE(PartialApplyObjCForwarder)
+NODE(PeerAttachedMacroExpansion)
 NODE(PostfixOperator)
 NODE(PrefixOperator)
 NODE(PrivateDeclName)
diff --git a/lib/AST/ASTMangler.cpp b/lib/AST/ASTMangler.cpp
@@ -3769,7 +3769,8 @@ void ASTMangler::appendMacroExpansionContext(
 
   case GeneratedSourceInfo::AccessorMacroExpansion:
   case GeneratedSourceInfo::MemberAttributeMacroExpansion:
-  case GeneratedSourceInfo::MemberMacroExpansion: {
+  case GeneratedSourceInfo::MemberMacroExpansion:
+  case GeneratedSourceInfo::PeerMacroExpansion: {
     auto decl = ASTNode::getFromOpaqueValue(generatedSourceInfo->astNode)
       .get<Decl *>();
     auto attr = generatedSourceInfo->attachedMacroCustomAttr;
@@ -3787,6 +3788,10 @@ void ASTMangler::appendMacroExpansionContext(
       role = MacroRole::Member;
       break;
 
+    case GeneratedSourceInfo::PeerMacroExpansion:
+      role = MacroRole::Peer;
+      break;
+
     default:
       llvm_unreachable("Unhandled macro role");
     }
@@ -3835,6 +3840,10 @@ void ASTMangler::appendMacroExpansionOperator(
   case MacroRole::Member:
     appendOperator("fMm", Index(discriminator));
     break;
+
+  case MacroRole::Peer:
+    appendOperator("fMp", Index(discriminator));
+    break;
   }
 }
 
diff --git a/lib/AST/ASTScopeCreation.cpp b/lib/AST/ASTScopeCreation.cpp
@@ -258,6 +258,7 @@ ASTSourceFileScope::ASTSourceFileScope(SourceFile *SF,
     case MacroRole::Declaration:
     case MacroRole::Accessor:
     case MacroRole::MemberAttribute:
+    case MacroRole::Peer:
       parentLoc = expansion.getStartLoc();
       break;
     case MacroRole::Member: {
diff --git a/lib/AST/Decl.cpp b/lib/AST/Decl.cpp
@@ -9758,6 +9758,9 @@ StringRef swift::getMacroRoleString(MacroRole role) {
 
   case MacroRole::Member:
     return "member";
+
+  case MacroRole::Peer:
+    return "peer";
   }
 }
 
@@ -9803,7 +9806,8 @@ static MacroRoles freestandingMacroRoles =
 static MacroRoles attachedMacroRoles = (MacroRoles() |
                                         MacroRole::Accessor |
                                         MacroRole::MemberAttribute |
-                                        MacroRole::Member);
+                                        MacroRole::Member |
+                                        MacroRole::Peer);
 
 bool swift::isFreestandingMacro(MacroRoles contexts) {
   return bool(contexts & freestandingMacroRoles);
@@ -9981,6 +9985,7 @@ MacroDiscriminatorContext MacroDiscriminatorContext::getParentOf(
   case GeneratedSourceInfo::AccessorMacroExpansion:
   case GeneratedSourceInfo::MemberAttributeMacroExpansion:
   case GeneratedSourceInfo::MemberMacroExpansion:
+  case GeneratedSourceInfo::PeerMacroExpansion:
   case GeneratedSourceInfo::PrettyPrinted:
   case GeneratedSourceInfo::ReplacedFunctionBody:
     return origDC;
diff --git a/lib/AST/DeclContext.cpp b/lib/AST/DeclContext.cpp
@@ -998,7 +998,8 @@ void IterableDeclContext::addMemberSilently(Decl *member, Decl *hint,
 
     // Synthesized member macros can add new members in a macro expansion buffer.
     auto *memberSourceFile = member->getInnermostDeclContext()->getParentSourceFile();
-    if (memberSourceFile->getFulfilledMacroRole() == MacroRole::Member)
+    if (memberSourceFile->getFulfilledMacroRole() == MacroRole::Member ||
+        memberSourceFile->getFulfilledMacroRole() == MacroRole::Peer)
       return;
 
     llvm::errs() << "Source ranges out of order in addMember():\n";
diff --git a/lib/AST/DiagnosticEngine.cpp b/lib/AST/DiagnosticEngine.cpp
@@ -1315,7 +1315,8 @@ std::vector<Diagnostic> DiagnosticEngine::getGeneratedSourceBufferNotes(
     case GeneratedSourceInfo::FreestandingDeclMacroExpansion:
     case GeneratedSourceInfo::AccessorMacroExpansion:
     case GeneratedSourceInfo::MemberAttributeMacroExpansion:
-    case GeneratedSourceInfo::MemberMacroExpansion: {
+    case GeneratedSourceInfo::MemberMacroExpansion:
+    case GeneratedSourceInfo::PeerMacroExpansion: {
       SourceRange origRange = expansionNode.getSourceRange();
       DeclName macroName;
       if (auto customAttr = generatedInfo->attachedMacroCustomAttr) {
diff --git a/lib/AST/Module.cpp b/lib/AST/Module.cpp
@@ -921,6 +921,9 @@ Optional<MacroRole> SourceFile::getFulfilledMacroRole() const {
   case GeneratedSourceInfo::MemberMacroExpansion:
     return MacroRole::Member;
 
+  case GeneratedSourceInfo::PeerMacroExpansion:
+    return MacroRole::Peer;
+
   case GeneratedSourceInfo::ReplacedFunctionBody:
   case GeneratedSourceInfo::PrettyPrinted:
     return None;
diff --git a/lib/ASTGen/Sources/ASTGen/Macros.swift b/lib/ASTGen/Sources/ASTGen/Macros.swift
@@ -38,6 +38,7 @@ enum MacroRole: UInt8 {
   case Accessor = 0x04
   case MemberAttribute = 0x08
   case Member = 0x10
+  case Peer = 0x20
 }
 
 /// Resolve a reference to type metadata into a macro, if posible.
@@ -430,6 +431,24 @@ func expandAttachedMacro(
         $0.trimmedDescription
       }.joined(separator: "\n\n")
 
+    case (let attachedMacro as PeerMacro.Type, .Peer):
+      let peers = try attachedMacro.expansion(
+        of: sourceManager.detach(
+          customAttrNode,
+          foldingWith: OperatorTable.standardOperators
+        ),
+        providingPeersOf: sourceManager.detach(
+          declarationNode,
+          foldingWith: OperatorTable.standardOperators
+        ),
+        in: context
+      )
+
+      // Form a buffer of peer declarations to return to the caller.
+      evaluatedSyntaxStr = peers.map {
+        $0.trimmedDescription
+      }.joined(separator: "\n\n")
+
     default:
       print("\(macroPtr) does not conform to any known attached macro protocol")
       return 1
diff --git a/lib/Basic/SourceLoc.cpp b/lib/Basic/SourceLoc.cpp
@@ -377,6 +377,7 @@ void SourceManager::setGeneratedSourceInfo(
   case GeneratedSourceInfo::AccessorMacroExpansion:
   case GeneratedSourceInfo::MemberAttributeMacroExpansion:
   case GeneratedSourceInfo::MemberMacroExpansion:
+  case GeneratedSourceInfo::PeerMacroExpansion:
   case GeneratedSourceInfo::PrettyPrinted:
     break;
 
diff --git a/lib/Demangling/Demangler.cpp b/lib/Demangling/Demangler.cpp
@@ -3899,7 +3899,8 @@ static bool isMacroExpansionNodeKind(Node::Kind kind) {
   return kind == Node::Kind::AccessorAttachedMacroExpansion ||
          kind == Node::Kind::MemberAttributeAttachedMacroExpansion ||
          kind == Node::Kind::FreestandingMacroExpansion ||
-         kind == Node::Kind::MemberAttachedMacroExpansion;
+         kind == Node::Kind::MemberAttachedMacroExpansion ||
+         kind == Node::Kind::PeerAttachedMacroExpansion;
 }
 
 NodePointer Demangler::demangleMacroExpansion() {
@@ -3921,6 +3922,10 @@ NodePointer Demangler::demangleMacroExpansion() {
     kind = Node::Kind::MemberAttachedMacroExpansion;
     break;
 
+  case 'p':
+    kind = Node::Kind::PeerAttachedMacroExpansion;
+    break;
+
   case 'u':
     kind = Node::Kind::MacroExpansionUniqueName;
     break;
diff --git a/lib/Demangling/NodePrinter.cpp b/lib/Demangling/NodePrinter.cpp
@@ -474,6 +474,7 @@ class NodePrinter {
     case Node::Kind::OwningMutableAddressor:
     case Node::Kind::PartialApplyForwarder:
     case Node::Kind::PartialApplyObjCForwarder:
+    case Node::Kind::PeerAttachedMacroExpansion:
     case Node::Kind::PostfixOperator:
     case Node::Kind::PredefinedObjCAsyncCompletionHandlerImpl:
     case Node::Kind::PrefixOperator:
@@ -1357,6 +1358,10 @@ NodePointer NodePrinter::print(NodePointer Node, unsigned depth,
     return printEntity(Node, depth, asPrefixContext, TypePrinting::NoType,
                        /*hasName*/true, "member macro expansion #",
                        (int)Node->getChild(2)->getIndex() + 1);
+  case Node::Kind::PeerAttachedMacroExpansion:
+    return printEntity(Node, depth, asPrefixContext, TypePrinting::NoType,
+                       /*hasName*/true, "peer macro expansion #",
+                       (int)Node->getChild(2)->getIndex() + 1);
   case Node::Kind::MacroExpansionUniqueName:
     return printEntity(Node, depth, asPrefixContext, TypePrinting::NoType,
                        /*hasName*/true, "unique name #",
diff --git a/lib/Demangling/OldRemangler.cpp b/lib/Demangling/OldRemangler.cpp
@@ -1091,6 +1091,13 @@ ManglingError Remangler::mangleMemberAttachedMacroExpansion(
   return mangleChildNodes(node, depth + 1);
 }
 
+ManglingError Remangler::manglePeerAttachedMacroExpansion(
+    Node *node, unsigned depth) {
+  Buffer << "fMp";
+  RETURN_IF_ERROR(mangleIndex(node, depth + 1));
+  return mangleChildNodes(node, depth + 1);
+}
+
 ManglingError Remangler::mangleMacroExpansionUniqueName(
     Node *node, unsigned depth) {
   Buffer << "fMu";
diff --git a/lib/Demangling/Remangler.cpp b/lib/Demangling/Remangler.cpp
@@ -2904,6 +2904,14 @@ ManglingError Remangler::mangleMemberAttachedMacroExpansion(
   return mangleChildNode(node, 2, depth + 1);
 }
 
+ManglingError Remangler::manglePeerAttachedMacroExpansion(
+    Node *node, unsigned depth) {
+  RETURN_IF_ERROR(mangleChildNode(node, 0, depth + 1));
+  RETURN_IF_ERROR(mangleChildNode(node, 1, depth + 1));
+  Buffer << "fMp";
+  return mangleChildNode(node, 2, depth + 1);
+}
+
 ManglingError Remangler::mangleMacroExpansionUniqueName(
     Node *node, unsigned depth) {
   RETURN_IF_ERROR(mangleChildNode(node, 0, depth + 1));
diff --git a/lib/Parse/ParseDecl.cpp b/lib/Parse/ParseDecl.cpp
@@ -2197,6 +2197,7 @@ static Optional<MacroRole> getMacroRole(
       .Case("accessor", MacroRole::Accessor)
       .Case("memberAttribute", MacroRole::MemberAttribute)
       .Case("member", MacroRole::Member)
+      .Case("peer", MacroRole::Peer)
       .Default(None);
 
   if (!role) {
diff --git a/lib/Parse/ParseRequests.cpp b/lib/Parse/ParseRequests.cpp
@@ -198,6 +198,12 @@ SourceFileParsingResult ParseSourceFileRequest::evaluate(Evaluator &evaluator,
       parser.parseExpandedAttributeList(items);
       break;
     }
+
+    case GeneratedSourceInfo::PeerMacroExpansion: {
+      // FIXME: this does not work for top-level or local peer expansions.
+      parser.parseExpandedMemberList(items);
+      break;
+    }
     }
   } else {
     parser.parseTopLevelItems(items);
diff --git a/lib/Sema/LookupVisibleDecls.cpp b/lib/Sema/LookupVisibleDecls.cpp
@@ -611,6 +611,14 @@ static void synthesizeMemberDeclsForLookup(NominalTypeDecl *NTD,
                     ExpandSynthesizedMemberMacroRequest{NTD},
                     false);
 
+  // Expand peer macros.
+  for (auto *member : NTD->getMembers()) {
+    (void)evaluateOrDefault(
+        ctx.evaluator,
+        ExpandPeerMacroRequest{member},
+        false);
+  }
+
   synthesizePropertyWrapperVariables(NTD);
 }
 
diff --git a/lib/Sema/TypeCheckDecl.cpp b/lib/Sema/TypeCheckDecl.cpp
@@ -2802,6 +2802,12 @@ static ArrayRef<Decl *> evaluateMembersRequest(
       nullptr);
 
   for (auto *member : idc->getMembers()) {
+    // Expand peer macros.
+    (void)evaluateOrDefault(
+        ctx.evaluator,
+        ExpandPeerMacroRequest{member},
+        false);
+
     if (auto *var = dyn_cast<VarDecl>(member)) {
       // The projected storage wrapper ($foo) might have
       // dynamically-dispatched accessors, so force them to be synthesized.
diff --git a/lib/Sema/TypeCheckMacros.cpp b/lib/Sema/TypeCheckMacros.cpp
diff --git a/lib/Sema/TypeCheckMacros.h b/lib/Sema/TypeCheckMacros.h
diff --git a/lib/Sema/TypeCheckStorage.cpp b/lib/Sema/TypeCheckStorage.cpp
diff --git a/lib/Serialization/Deserialization.cpp b/lib/Serialization/Deserialization.cpp
diff --git a/lib/Serialization/ModuleFormat.h b/lib/Serialization/ModuleFormat.h
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
diff --git a/test/Demangle/Inputs/manglings.txt b/test/Demangle/Inputs/manglings.txt
diff --git a/test/Macros/Inputs/syntax_macro_definitions.swift b/test/Macros/Inputs/syntax_macro_definitions.swift
diff --git a/test/Macros/macro_expand_peers.swift b/test/Macros/macro_expand_peers.swift
