Merge pull request #66082 from hamishknight/if-it-is-broke-but-not-directly-fixable-dont-fix-it-5.9

Author: hamishknight

lib/AST/DiagnosticEngine.cpp

@@ -1264,11 +1264,36 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic) {
   else if (isNoUsageDiagnostic(diagnostic.getID()))
     Category = "no-usage";
 
+  auto fixIts = diagnostic.getFixIts();
+  if (loc.isValid()) {
+    // If the diagnostic is being emitted in a generated buffer, drop the
+    // fix-its, as the user will have no way of applying them.
+    auto bufferID = SourceMgr.findBufferContainingLoc(loc);
+    if (auto generatedInfo = SourceMgr.getGeneratedSourceInfo(bufferID)) {
+      switch (generatedInfo->kind) {
+      case GeneratedSourceInfo::ExpressionMacroExpansion:
+      case GeneratedSourceInfo::FreestandingDeclMacroExpansion:
+      case GeneratedSourceInfo::AccessorMacroExpansion:
+      case GeneratedSourceInfo::MemberAttributeMacroExpansion:
+      case GeneratedSourceInfo::MemberMacroExpansion:
+      case GeneratedSourceInfo::PeerMacroExpansion:
+      case GeneratedSourceInfo::ConformanceMacroExpansion:
+      case GeneratedSourceInfo::PrettyPrinted:
+        fixIts = {};
+        break;
+      case GeneratedSourceInfo::ReplacedFunctionBody:
+        // A replaced function body is for user-written code, so fix-its are
+        // still valid.
+        break;
+      }
+    }
+  }
+
   return DiagnosticInfo(
       diagnostic.getID(), loc, toDiagnosticKind(behavior),
       diagnosticStringFor(diagnostic.getID(), getPrintDiagnosticNames()),
       diagnostic.getArgs(), Category, getDefaultDiagnosticLoc(),
-      /*child note info*/ {}, diagnostic.getRanges(), diagnostic.getFixIts(),
+      /*child note info*/ {}, diagnostic.getRanges(), fixIts,
       diagnostic.isChildNote());
 }
 

lib/Parse/ParseDecl.cpp

@@ -344,8 +344,6 @@ Parser::parseSourceFileViaASTGen(SmallVectorImpl<ASTNode> &items,
                                  Optional<DiagnosticTransaction> &transaction,
                                  bool suppressDiagnostics) {
 #if SWIFT_SWIFT_PARSER
-  using ParsingFlags = SourceFile::ParsingFlags;
-  const auto parsingOpts = SF.getParsingOptions();
   const auto &langOpts = Context.LangOpts;
 
   // We only need to do parsing if we either have ASTGen enabled, or want the

test/Macros/Inputs/syntax_macro_definitions.swift

@@ -1293,6 +1293,25 @@ public struct DefineStructWithUnqualifiedLookupMacro: DeclarationMacro {
   }
 }
 
+public struct AddMemberWithFixIt: MemberMacro {
+  public static func expansion<
+    Declaration: DeclGroupSyntax, Context: MacroExpansionContext
+  >(
+    of node: AttributeSyntax,
+    providingMembersOf declaration: Declaration,
+    in context: Context
+  ) throws -> [DeclSyntax] {
+    [
+      """
+      func foo() {
+        var x = 0
+        _ = x
+      }
+      """
+    ]
+  }
+}
+
 extension TupleExprElementListSyntax {
   /// Retrieve the first element with the given label.
   func first(labeled name: String) -> Element? {

test/Macros/macro_fixits.swift

@@ -0,0 +1,26 @@
+// REQUIRES: swift_swift_parser
+
+// This test ensures we don't emit fix-its in generated code, such as macro
+// expansion buffers.
+
+// RUN: %empty-directory(%t)
+
+// RUN: %host-build-swift -emit-library %S/Inputs/syntax_macro_definitions.swift -o %t/%target-library-name(MacroDefinition) -module-name MacroDefinition -swift-version 5 -g -no-toolchain-stdlib-rpath
+
+// RUN: %target-swift-frontend -typecheck %s -load-plugin-library %t/%target-library-name(MacroDefinition) -swift-version 5 -serialize-diagnostics-path %t/diags.dia -fixit-all -emit-fixits-path %t/fixits.json
+
+// RUN: %FileCheck %s --check-prefix FIXITS-JSON < %t/fixits.json
+
+// FIXITS-JSON:      [
+// FIXITS-JSON-NEXT: ]
+
+// RUN: c-index-test -read-diagnostics %t/diags.dia 2>&1 | %FileCheck -check-prefix DIAGS %s
+
+// DIAGS: warning: variable 'x' was never mutated; consider changing to 'let' constant
+// DIAGS-NEXT: Number FIXITs = 0
+
+@attached(member, names: arbitrary)
+public macro addMemberWithFixIt() = #externalMacro(module: "MacroDefinition", type: "AddMemberWithFixIt")
+
+@addMemberWithFixIt
+struct S {}

test/SourceKit/Macros/diags.swift

@@ -16,6 +16,13 @@ func foo() {
 @Invalid
 struct Bad {}
 
+@attached(member, names: arbitrary)
+public macro addMemberWithFixIt() = #externalMacro(module: "MacroDefinition", type: "AddMemberWithFixIt")
+
+// Make sure we don't emit the fix-it for the member added by this macro.
+@addMemberWithFixIt
+struct S {}
+
 // REQUIRES: swift_swift_parser
 
 // RUN: %empty-directory(%t)

test/SourceKit/Macros/diags.swift.response

@@ -44,6 +44,15 @@
         key.buffer_name: diags.swift
       },
       key.buffer_name: "@__swiftmacro_9MacroUser3Bad7InvalidfMp_.swift"
+    },
+    {
+      key.buffer_text: "func foo() {\n  var x = 0\n  _ = x\n}",
+      key.original_location: {
+        key.offset: 748,
+        key.length: 0,
+        key.buffer_name: diags.swift
+      },
+      key.buffer_name: "@__swiftmacro_9MacroUser1S18addMemberWithFixItfMm_.swift"
     }
   ],
   key.diagnostics: [
@@ -175,6 +184,30 @@
         }
       ]
     },
+    {
+      key.line: 2,
+      key.column: 7,
+      key.filepath: "@__swiftmacro_9MacroUser1S18addMemberWithFixItfMm_.swift",
+      key.severity: source.diagnostic.severity.warning,
+      key.id: "variable_never_mutated",
+      key.description: "variable 'x' was never mutated; consider changing to 'let' constant",
+      key.diagnostics: [
+        {
+          key.line: 24,
+          key.column: 1,
+          key.filepath: diags.swift,
+          key.severity: source.diagnostic.severity.note,
+          key.id: "in_macro_expansion",
+          key.description: "in expansion of macro 'addMemberWithFixIt' here",
+          key.ranges: [
+            {
+              key.offset: 738,
+              key.length: 11
+            }
+          ]
+        }
+      ]
+    },
     {
       key.line: 3,
       key.column: 17,