Merge pull request swiftlang#63640 from DougGregor/expand-macro-whitespace-adjust

Author: DougGregor

lib/Refactoring/Refactoring.cpp

@@ -8595,6 +8595,50 @@ bool RefactoringActionExpandMacro::isApplicable(const ResolvedCursorInfo &Info,
   return !getMacroExpansionBuffers(Diag.SourceMgr, Info).empty();
 }
 
+/// Given the expanded code for a particular macro, perform whitespace
+/// adjustments to make the refactoring more.
+static StringRef adjustMacroExpansionWhitespace(
+    GeneratedSourceInfo::Kind kind, StringRef expandedCode,
+    llvm::SmallString<64> &scratch
+) {
+  scratch.clear();
+
+  switch (kind) {
+  case GeneratedSourceInfo::ExpressionMacroExpansion:
+  case GeneratedSourceInfo::FreestandingDeclMacroExpansion:
+    return expandedCode;
+
+  case GeneratedSourceInfo::AccessorMacroExpansion:
+      // For accessor macros, wrap curly braces around the buffer contents.
+    scratch += "{\n";
+    scratch += expandedCode;
+    scratch += "\n}";
+    return scratch;
+
+  case GeneratedSourceInfo::MemberAttributeMacroExpansion:
+      // For member-attribute macros, add a space at the end.
+    scratch += expandedCode;
+    scratch += " ";
+    return scratch;
+
+  case GeneratedSourceInfo::PeerMacroExpansion:
+      // For peers, add a newline to create some separation.
+    scratch += "\n";
+    LLVM_FALLTHROUGH;
+
+  case GeneratedSourceInfo::MemberMacroExpansion:
+      // For members, add a newline.
+    scratch += "\n";
+    scratch += expandedCode;
+    scratch += "\n";
+    return scratch;
+
+  case GeneratedSourceInfo::ReplacedFunctionBody:
+  case GeneratedSourceInfo::PrettyPrinted:
+    return expandedCode;
+  }
+}
+
 bool RefactoringActionExpandMacro::performChange() {
   auto bufferIDs = getMacroExpansionBuffers(SM, CursorInfo);
   if (bufferIDs.empty())
@@ -8637,15 +8681,11 @@ bool RefactoringActionExpandMacro::performChange() {
 
       auto afterLeftBraceLoc = Lexer::getLocForEndOfToken(SM, leftBraceLoc);
       originalSourceRange = CharSourceRange(afterLeftBraceLoc, 0);
-    } else if (generatedInfo->kind ==
-                   GeneratedSourceInfo::AccessorMacroExpansion) {
-      // For accessor macros, wrap curly braces around the buffer contents.
-      scratchBuffer += "{\n";
-      scratchBuffer += rewrittenBuffer;
-      scratchBuffer += "\n}";
-      rewrittenBuffer = scratchBuffer;
     }
 
+    rewrittenBuffer = adjustMacroExpansionWhitespace(
+        generatedInfo->kind, rewrittenBuffer, scratchBuffer);
+
     EditConsumer.accept(SM, originalSourceRange, rewrittenBuffer);
 
     if (generatedInfo->attachedMacroCustomAttr && !attachedMacroAttr)

test/SourceKit/Macros/macro_basic.swift

@@ -106,11 +106,12 @@ struct S3 {
 //##-- Refactoring expanding the attached macro
 // RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=21:2 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=ATTACHED_EXPAND %s
 // ATTACHED_EXPAND: source.edit.kind.active:
-// ATTACHED_EXPAND:   23:3-23:3 "@accessViaStorage"
+// ATTACHED_EXPAND:   23:3-23:3 "@accessViaStorage "
 // ATTACHED_EXPAND: source.edit.kind.active:
-// ATTACHED_EXPAND:   24:3-24:3 "@accessViaStorage"
+// ATTACHED_EXPAND:   24:3-24:3 "@accessViaStorage "
 // ATTACHED_EXPAND: source.edit.kind.active:
-// ATTACHED_EXPAND:   22:11-22:11 "private var _storage = _Storage()"
+// ATTACHED_EXPAND:   22:11-22:11 "
+// ATTACHED_EXPAND: private var _storage = _Storage()
 // ATTACHED_EXPAND: source.edit.kind.active:
 // ATTACHED_EXPAND:   21:1-21:15 ""
 
@@ -137,10 +138,11 @@ struct S3 {
 //##-- Refactoring expanding the second accessor macro
 // RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=42:5 %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=PEER_EXPAND %s
 // PEER_EXPAND: source.edit.kind.active:
-// PEER_EXPAND:   45:4-45:4 "func f(a: Int, for b: String, _ value: Double, completionHandler: (String) -> Void) {
+// PEER_EXPAND:   45:4-45:4 "
+// PEER_EXPAND: func f(a: Int, for b: String, _ value: Double, completionHandler: (String) -> Void) {
 // PEER_EXPAND:  Task {
 // PEER_EXPAND:    completionHandler(await f(a: a, for: b, value))
 // PEER_EXPAND:  }
-// PEER_EXPAND: }"
+// PEER_EXPAND: }
 // PEER_EXPAND: source.edit.kind.active:
 // PEER_EXPAND:   42:3-42:24 ""