Merge pull request #64253 from bnbarham/add-freestanding-decl-expansion

[Refactoring] Allow expanding freestanding decl expansions

Author: bnbarham

lib/IDE/SourceEntityWalker.cpp

@@ -212,6 +212,14 @@ ASTWalker::PreWalkAction SemaAnnotator::walkToDeclPreProper(Decl *D) {
       }
       return Action::SkipChildren();
     }
+  } else if (auto *MD = dyn_cast<MacroExpansionDecl>(D)) {
+    if (auto *macro =
+            dyn_cast_or_null<MacroDecl>(MD->getMacroRef().getDecl())) {
+      auto macroRefType = macro->getDeclaredInterfaceType();
+      if (!passReference(macro, macroRefType, MD->getMacroNameLoc(),
+                         ReferenceMetaData(SemaReferenceKind::DeclRef, None)))
+        return Action::Stop();
+    }
   }
 
   CharSourceRange Range = (Loc.isValid()) ? CharSourceRange(Loc, NameLen)

lib/Refactoring/Refactoring.cpp

@@ -59,19 +59,28 @@ class ContextFinder : public SourceEntityWalker {
     }
     return Result;
   }
+
 public:
   ContextFinder(SourceFile &SF, ASTNode TargetNode,
                 std::function<bool(ASTNode)> IsContext =
                   [](ASTNode N) { return true; }) :
                   SF(SF), Ctx(SF.getASTContext()), SM(Ctx.SourceMgr),
                   Target(TargetNode.getSourceRange()), IsContext(IsContext) {}
+
   ContextFinder(SourceFile &SF, SourceLoc TargetLoc,
                 std::function<bool(ASTNode)> IsContext =
                   [](ASTNode N) { return true; }) :
                   SF(SF), Ctx(SF.getASTContext()), SM(Ctx.SourceMgr),
                   Target(TargetLoc), IsContext(IsContext) {
                     assert(TargetLoc.isValid() && "Invalid loc to find");
-                  }
+  }
+
+  // Only need expansions for the expands refactoring, but we
+  // skip nodes that don't contain the passed location anyway.
+  virtual MacroWalking getMacroWalkingBehavior() const override {
+    return MacroWalking::ArgumentsAndExpansion;
+  }
+
   bool walkToDeclPre(Decl *D, CharSourceRange Range) override { return contains(D); }
   bool walkToStmtPre(Stmt *S) override { return contains(S); }
   bool walkToExprPre(Expr *E) override { return contains(E); }
@@ -8497,6 +8506,15 @@ static Optional<unsigned> getMacroExpansionBuffer(
   return None;
 }
 
+/// Retrieve the macro expansion buffer for the given macro expansion
+/// declaration.
+static Optional<unsigned>
+getMacroExpansionBuffer(SourceManager &sourceMgr,
+                        MacroExpansionDecl *expansion) {
+  return evaluateOrDefault(expansion->getASTContext().evaluator,
+                           ExpandMacroExpansionDeclRequest{expansion}, {});
+}
+
 /// Retrieve the macro expansion buffers for the given attached macro reference.
 static llvm::SmallVector<unsigned, 2>
 getMacroExpansionBuffers(MacroDecl *macro, const CustomAttr *attr, Decl *decl) {
@@ -8584,13 +8602,14 @@ getMacroExpansionBuffers(SourceManager &sourceMgr, ResolvedCursorInfoPtr Info) {
   // FIXME: A resolved cursor should contain a slice up to its reference.
   // We shouldn't need to find it again.
   ContextFinder Finder(*Info->getSourceFile(), Info->getLoc(), [&](ASTNode N) {
-    if (N.getStartLoc() == Info->getLoc())
-      return true;
-
-    // TODO: Handle MacroExpansionDecl
     if (auto *expr =
             dyn_cast_or_null<MacroExpansionExpr>(N.dyn_cast<Expr *>())) {
-      return expr->getMacroNameLoc().getBaseNameLoc() == Info->getLoc();
+      return expr->getStartLoc() == Info->getLoc() ||
+             expr->getMacroNameLoc().getBaseNameLoc() == Info->getLoc();
+    } else if (auto *decl =
+                   dyn_cast_or_null<MacroExpansionDecl>(N.dyn_cast<Decl *>())) {
+      return decl->getStartLoc() == Info->getLoc() ||
+             decl->getMacroNameLoc().getBaseNameLoc() == Info->getLoc();
     }
 
     return false;
@@ -8599,8 +8618,11 @@ getMacroExpansionBuffers(SourceManager &sourceMgr, ResolvedCursorInfoPtr Info) {
 
   if (!Finder.getContexts().empty()) {
     Optional<unsigned> bufferID;
-    if (auto *target = dyn_cast<MacroExpansionExpr>(
-            Finder.getContexts()[0].get<Expr *>())) {
+    if (auto *target = dyn_cast_or_null<MacroExpansionExpr>(
+            Finder.getContexts()[0].dyn_cast<Expr *>())) {
+      bufferID = getMacroExpansionBuffer(sourceMgr, target);
+    } else if (auto *target = dyn_cast_or_null<MacroExpansionDecl>(
+                   Finder.getContexts()[0].dyn_cast<Decl *>())) {
       bufferID = getMacroExpansionBuffer(sourceMgr, target);
     }
 

test/SourceKit/Macros/macro_basic.swift

@@ -51,6 +51,11 @@ macro Hashable() = #externalMacro(module: "MacroDefinition", type: "HashableMacr
 @Hashable
 struct S4 { }
 
+@freestanding(declaration)
+macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition", type: "DefineAnonymousTypesMacro")
+
+#anonymousTypes { "hello" }
+
 // FIXME: Swift parser is not enabled on Linux CI yet.
 // REQUIRES: OS=macosx
 
@@ -105,6 +110,43 @@ struct S4 { }
 // EXPAND: source.edit.kind.active:
 // EXPAND-NEXT: 4:7-4:24 (@__swiftmacro_9MacroUser13testStringify1a1bySi_SitF9stringifyfMf_.swift) "(a + b, "a + b")"
 
+//##-- cursor-info on macro declaration
+// RUN: %sourcekitd-test -req=cursor -pos=57:1 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=CURSOR_MACRO_DECL %s
+// RUN: %sourcekitd-test -req=cursor -pos=57:2 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=CURSOR_MACRO_DECL %s
+// CURSOR_MACRO_DECL: source.lang.swift.ref.macro (55:7-55:21)
+// CURSOR_MACRO_DECL-LABEL: SYMBOL GRAPH BEGIN
+// CURSOR_MACRO_DECL: "identifier": {
+// CURSOR_MACRO_DECL-NEXT:   "interfaceLanguage": "swift",
+// CURSOR_MACRO_DECL-NEXT:   "precise": "s:9MacroUser14anonymousTypesyySSyXEcfm"
+// CURSOR_MACRO_DECL-NEXT: },
+// CURSOR_MACRO_DECL-NEXT: "kind": {
+// CURSOR_MACRO_DECL-NEXT:   "displayName": "Macro",
+// CURSOR_MACRO_DECL-NEXT:   "identifier": "swift.macro"
+// CURSOR_MACRO_DECL-NEXT: },
+// CURSOR_MACRO_DECL: SYMBOL GRAPH END
+// CURSOR_MACRO_DECL-LABEL: ACTIONS BEGIN
+// CURSOR_MACRO_DECL: source.refactoring.kind.expand.macro
+// CURSOR_MACRO_DECL-NEXT: Expand Macro
+// CURSOR_MACRO_DECL: ACTIONS END
+
+//##-- Refactoring on macro declaration
+// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=57:1 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=EXPAND_MACRO_DECL %s
+// RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=57:2 %s -- ${COMPILER_ARGS[@]} -parse-as-library -enable-experimental-feature FreestandingMacros | %FileCheck -check-prefix=EXPAND_MACRO_DECL %s
+// EXPAND_MACRO_DECL: source.edit.kind.active:
+// EXPAND_MACRO_DECL-NEXT: 57:1-57:28 (@__swiftmacro_9MacroUser14anonymousTypesfMf0_.swift) "class $s9MacroUser14anonymousTypesfMf0_4namefMu_ {
+// EXPAND_MACRO_DECL-NEXT:   func hello() -> String {
+// EXPAND_MACRO_DECL-NEXT:     "hello"
+// EXPAND_MACRO_DECL-NEXT:   }
+// EXPAND_MACRO_DECL-NEXT: }
+// EXPAND_MACRO_DECL-NEXT: enum $s9MacroUser14anonymousTypesfMf0_4namefMu0_ {
+// EXPAND_MACRO_DECL-NEXT:   case apple
+// EXPAND_MACRO_DECL-NEXT:   case banana
+// EXPAND_MACRO_DECL-EMPTY:
+// EXPAND_MACRO_DECL-NEXT:   func hello() -> String {
+// EXPAND_MACRO_DECL-NEXT:     "hello"
+// EXPAND_MACRO_DECL-NEXT:   }
+// EXPAND_MACRO_DECL-NEXT: }"
+
 //##-- cursor-info on attached macro
 // RUN: %sourcekitd-test -req=cursor -pos=21:1 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_ATTACHED %s
 // RUN: %sourcekitd-test -req=cursor -pos=21:2 -cursor-action -req-opts=retrieve_symbol_graph=1 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=CURSOR_ATTACHED %s