Merge pull request #75793 from ahoppen/no-editor-mode

Remove `DiagnosticsEditorMode`

Author: ahoppen

docs/Diagnostics.md

@@ -84,13 +84,6 @@ The correct spelling of this feature is "fix-it" rather than "fixit". In [camelc
 
   [camelcased]: https://en.wikipedia.org/wiki/Camel_case
 
-
-### "Editor Mode" ###
-
-The Swift compiler has a setting (under LangOptions) called `DiagnosticsEditorMode`. When set, diagnostics should be customized for an interactive editor that can display and apply complex fix-its, and worry less about the appearance in build logs and command-line environments.
-
-Most diagnostics have no reason to change behavior under editor mode. An example of an exception is the "protocol requirements not satisfied diagnostic"; on the command line, it may be better to show all unsatisfied requirements, while in an IDE a single multi-line fix-it would be preferred.
-
 ### Educational Notes ###
 
 Educational notes are short-form documentation attached to a diagnostic which explain relevant language concepts. They are intended to further Swift's goal of progressive disclosure by providing a learning resource at the point of use when encountering an error message for the first time. In very limited circumstances, they also allow the main diagnostic message to use precise terminology (e.g. nominal types) which would otherwise be too unfriendly for beginners.

include/swift/AST/DiagnosticsSema.def

@@ -2814,11 +2814,10 @@ ERROR(conditional_conformances_cannot_imply_conformances,none,
 NOTE(note_explicitly_state_conditional_conformance_different,none,
      "did you mean to explicitly state the conformance with different bounds?", ())
 NOTE(note_explicitly_state_conditional_conformance_relaxed,none,
-     "did you mean to explicitly state the conformance with relaxed bounds?", ())
+     "did you mean to explicitly state the conformance with relaxed bounds using '%0'?",
+     (StringRef))
 NOTE(note_explicitly_state_conditional_conformance_same,none,
-     "did you mean to explicitly state the conformance with the same bounds?", ())
-NOTE(note_explicitly_state_conditional_conformance_noneditor,none,
-     "did you mean to explicitly state the conformance like '%0where ...'?",
+     "did you mean to explicitly state the conformance with the same bounds using '%0'?",
      (StringRef))
 ERROR(protocol_has_missing_requirements,none,
       "type %0 cannot conform to protocol %1 because it has requirements that "

include/swift/Basic/LangOptions.h

@@ -458,10 +458,6 @@ namespace swift {
     /// [TODO: Clang-type-plumbing] Turn on for feature rollout.
     bool UseClangFunctionTypes = false;
 
-    /// If set to true, the diagnosis engine can assume the emitted diagnostics
-    /// will be used in editor. This usually leads to more aggressive fixit.
-    bool DiagnosticsEditorMode = false;
-
     /// Access or distribution level of the whole module being parsed.
     LibraryLevel LibraryLevel = LibraryLevel::Other;
 

lib/Frontend/CompilerInvocation.cpp

@@ -779,9 +779,6 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
 
   Opts.UseMalloc |= Args.hasArg(OPT_use_malloc);
 
-  Opts.DiagnosticsEditorMode |= Args.hasArg(OPT_diagnostics_editor_mode,
-                                            OPT_serialize_diagnostics_path);
-
   Opts.EnableExperimentalConcurrency |=
     Args.hasArg(OPT_enable_experimental_concurrency);
 

lib/IDETool/CompilerInvocation.cpp

@@ -223,7 +223,6 @@ bool ide::initCompilerInvocation(
 
   auto &LangOpts = Invocation.getLangOptions();
   LangOpts.AttachCommentsToDecls = true;
-  LangOpts.DiagnosticsEditorMode = true;
   LangOpts.CollectParsedToken = true;
   #if defined(_WIN32)
   // Source files that might be open in an editor should not be memory mapped on Windows,

lib/Sema/TypeCheckProtocol.cpp

@@ -2173,21 +2173,11 @@ static void diagnoseConformanceImpliedByConditionalConformance(
                  << indent;
   }
 
-  if (!ctxt.LangOpts.DiagnosticsEditorMode) {
-    // The fixits below are too complicated for the command line: the suggested
-    // code ends up not being displayed, and the text by itself doesn't help. So
-    // instead we skip all that and just have some text.
-    Diags.diagnose(loc,
-                   diag::note_explicitly_state_conditional_conformance_noneditor,
-                   prefix.str());
-    return;
-  }
-
   // First, we do the fixit for "matching" requirements (i.e. X: P where T: P).
   bool matchingIsValid = true;
-  llvm::SmallString<128> matchingFixit = prefix;
+  llvm::SmallString<128> matchingWhereClause;
   {
-    llvm::raw_svector_ostream matchingStream(matchingFixit);
+    llvm::raw_svector_ostream matchingStream(matchingWhereClause);
     matchingStream << "where ";
     bool first = true;
     for (const auto &req : implyingConf->getConditionalRequirements()) {
@@ -2207,35 +2197,30 @@ static void diagnoseConformanceImpliedByConditionalConformance(
   }
 
   if (matchingIsValid) {
-    matchingFixit += suffix;
     Diags
         .diagnose(loc,
-                  diag::note_explicitly_state_conditional_conformance_relaxed)
-        .fixItInsert(loc, matchingFixit);
+                  diag::note_explicitly_state_conditional_conformance_relaxed, matchingWhereClause)
+        .fixItInsert(loc, (prefix + matchingWhereClause + suffix).str());
   }
 
   // Next, do the fixit for using the same requirements, but be resilient to a
   // missing `where` clause: this is one of a few fixits that get emitted here,
   // and so is a very low priority diagnostic, and so shouldn't crash.
   if (auto TWC = ext->getTrailingWhereClause()) {
-    llvm::SmallString<128> sameFixit = prefix;
+    llvm::SmallString<128> sameWhereClause;
     auto CSR =
         Lexer::getCharSourceRangeFromSourceRange(SM, TWC->getSourceRange());
-    sameFixit += SM.extractText(CSR);
-    sameFixit += suffix;
+    sameWhereClause += SM.extractText(CSR);
     Diags
-        .diagnose(loc, diag::note_explicitly_state_conditional_conformance_same)
-        .fixItInsert(loc, sameFixit);
+        .diagnose(loc, diag::note_explicitly_state_conditional_conformance_same, sameWhereClause)
+        .fixItInsert(loc, (prefix + sameWhereClause + suffix).str());
   }
 
   // And finally, just the generic new-requirements one:
-  llvm::SmallString<128> differentFixit = prefix;
-  differentFixit += "where <#requirements#>";
-  differentFixit += suffix;
   Diags
       .diagnose(loc,
                 diag::note_explicitly_state_conditional_conformance_different)
-      .fixItInsert(loc, differentFixit);
+      .fixItInsert(loc, (prefix + "where <#requirements#>" + suffix).str());
 }
 
 /// Determine whether there are additional semantic checks for conformance

test/AssociatedTypeInference/associated_type_inference_proto_ext.swift

@@ -11,7 +11,8 @@ extension Pair: Codable where A: Codable, B: Codable {}
 
 extension Pair: Collection where A == B {
 // expected-error@-1 {{conditional conformance of type 'Pair<A, B>' to protocol 'Collection' does not imply conformance to inherited protocol 'Sequence'}}
-// expected-note@-2 {{did you mean to explicitly state the conformance like 'extension Pair: Sequence where ...'?}}
+// expected-note@-2 {{did you mean to explicitly state the conformance with the same bounds using 'where A == B'?}}
+// expected-note@-3 {{did you mean to explicitly state the conformance with different bounds?}}
     typealias Element = A
 
     var startIndex: Int { return 0 }

test/AssociatedTypeInference/missing_conformance.swift

@@ -148,8 +148,9 @@ struct CountSteps1<T> : Collection {
 extension CountSteps1 // expected-error {{type 'CountSteps1<T>' does not conform to protocol 'RandomAccessCollection'}}
   // expected-note@-1 {{add stubs for conformance}}
   // expected-error@-2 {{conditional conformance of type 'CountSteps1<T>' to protocol 'RandomAccessCollection' does not imply conformance to inherited protocol 'BidirectionalCollection'}}
-  // expected-note@-3 {{did you mean to explicitly state the conformance like 'extension CountSteps1: BidirectionalCollection where ...'?}}
-  // expected-error@-4 {{type 'CountSteps1<T>' does not conform to protocol 'BidirectionalCollection'}}
+  // expected-note@-3 {{did you mean to explicitly state the conformance with the same bounds using 'where T : Equatable'?}}
+  // expected-note@-4 {{did you mean to explicitly state the conformance with different bounds?}}
+  // expected-error@-5 {{type 'CountSteps1<T>' does not conform to protocol 'BidirectionalCollection'}}
   : RandomAccessCollection
      where T : Equatable
 {

test/Concurrency/implied_sendable_conformance_swift6.swift

@@ -9,15 +9,19 @@ struct One<T> {  // expected-note {{consider making generic parameter 'T' confor
 
 extension One: P where T: P {}
 // expected-error@-1 {{conditional conformance of type 'One<T>' to protocol 'P' does not imply conformance to inherited protocol 'Sendable'}}
-// expected-note@-2 {{did you mean to explicitly state the conformance like 'extension One: Sendable where ...'}}
+// expected-note@-2 {{did you mean to explicitly state the conformance with relaxed bounds using 'where T: Sendable'?}}
+// expected-note@-3 {{did you mean to explicitly state the conformance with the same bounds using 'where T: P'?}}
+// expected-note@-4 {{did you mean to explicitly state the conformance with different bounds?}}
 
 struct Both<T> { // expected-note {{consider making generic parameter 'T' conform to the 'Sendable' protocol}}
   var t: T  // expected-error {{stored property 't' of 'Sendable'-conforming generic struct 'Both' has non-sendable type 'T'}}
 }
 
 extension Both: P where T: P {}
 // expected-error@-1 {{conditional conformance of type 'Both<T>' to protocol 'P' does not imply conformance to inherited protocol 'Sendable'}}
-// expected-note@-2 {{did you mean to explicitly state the conformance like 'extension Both: Sendable where ...'}}
+// expected-note@-2 {{did you mean to explicitly state the conformance with relaxed bounds using 'where T: Sendable'?}}
+// expected-note@-3 {{did you mean to explicitly state the conformance with the same bounds using 'where T: P'?}}
+// expected-note@-4 {{did you mean to explicitly state the conformance with different bounds?}}
 
 extension Both: Q where T: Q {}
 

test/FixCode/batch-mode.swift

@@ -1,4 +1,4 @@
-// RUN: not %swift -typecheck -target %target-triple -primary-file %s  -emit-fixits-path %t.main.remap -primary-file %S/Inputs/batch-mode-helper.swift -emit-fixits-path %t.helper.remap -diagnostics-editor-mode
+// RUN: not %swift -typecheck -target %target-triple -primary-file %s  -emit-fixits-path %t.main.remap -primary-file %S/Inputs/batch-mode-helper.swift -emit-fixits-path %t.helper.remap
 // RUN: %FileCheck -check-prefix=CHECK-MAIN %s < %t.main.remap
 // RUN: %FileCheck -check-prefix=NEGATIVE-MAIN %s < %t.main.remap
 // RUN: %FileCheck -check-prefix=CHECK-HELPER %s < %t.helper.remap