---

yaml
---
r: 349347
b: refs/heads/master-next
c: 6bca134
h: refs/heads/master
i:
  349345: 21414e6
  349343: f3ff42a

Author: swift-ci

[refs]

@@ -1,6 +1,6 @@
 ---
 refs/heads/master: 3574c513bbc5578dd9346b4ea9ab5995c5927bb5
-refs/heads/master-next: 2f37dd154c6385a0824e39577a2a3ff20f59cc12
+refs/heads/master-next: 6bca134a930a7dd2e77da52aa8264b0b49a7ec81
 refs/tags/osx-passed: b6b74147ef8a386f532cf9357a1bde006e552c54
 refs/tags/swift-2.2-SNAPSHOT-2015-12-01-a: 6bb18e013c2284f2b45f5f84f2df2887dc0f7dea
 refs/tags/swift-2.2-SNAPSHOT-2015-12-01-b: 66d897bfcf64a82cb9a87f5e663d889189d06d07

branches/master-next/docs/DebuggingTheCompiler.rst

@@ -86,6 +86,14 @@ diagnostic engine to assert on the first error/warning:
 These allow one to dump a stack trace of where the diagnostic is being emitted
 (if run without a debugger) or drop into the debugger if a debugger is attached.
 
+Finding Diagnostic Names
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some diagnostics rely heavily on format string arguments, so it can be difficult
+to find their implementation by searching for parts of the emitted message in
+the codebase. To print the corresponding diagnostic name at the end of each
+emitted message, use the ``-Xfrontend -debug-diagnostic-names`` argument.
+
 Debugging the Type Checker
 --------------------------
 

branches/master-next/include/swift/AST/DiagnosticEngine.h

@@ -583,6 +583,9 @@ namespace swift {
     /// input being compiled.
     /// May be invalid.
     SourceLoc bufferIndirectlyCausingDiagnostic;
+    
+    /// Print diagnostic names after their messages
+    bool printDiagnosticNames = false;
 
     friend class InFlightDiagnostic;
     friend class DiagnosticTransaction;
@@ -618,6 +621,14 @@ namespace swift {
       return state.getWarningsAsErrors();
     }
 
+    /// Whether to print diagnostic names after their messages
+    void setPrintDiagnosticNames(bool val) {
+      printDiagnosticNames = val;
+    }
+    bool getPrintDiagnosticNames() const {
+      return printDiagnosticNames;
+    }
+
     void ignoreDiagnostic(DiagID id) {
       state.setDiagnosticBehavior(id, DiagnosticState::Behavior::Ignore);
     }
@@ -826,7 +837,8 @@ namespace swift {
     void emitTentativeDiagnostics();
 
   public:
-    static const char *diagnosticStringFor(const DiagID id);
+    static const char *diagnosticStringFor(const DiagID id,
+                                           bool printDiagnosticName);
 
     /// If there is no clear .dia file for a diagnostic, put it in the one
     /// corresponding to the SourceLoc given here.

branches/master-next/include/swift/Basic/DiagnosticOptions.h

@@ -52,6 +52,9 @@ class DiagnosticOptions {
   /// Treat all warnings as errors
   bool WarningsAsErrors = false;
 
+  // When printing diagnostics, include the diagnostic name at the end
+  bool PrintDiagnosticNames = false;
+
   /// Return a hash code of any components from these options that should
   /// contribute to a Swift Bridging PCH hash.
   llvm::hash_code getPCHHashComponents() const {

branches/master-next/include/swift/Option/Options.td

@@ -306,6 +306,9 @@ def color_diagnostics : Flag<["-"], "color-diagnostics">,
 def no_color_diagnostics : Flag<["-"], "no-color-diagnostics">,
   Flags<[FrontendOption, DoesNotAffectIncrementalBuild]>,
   HelpText<"Do not print diagnostics in color">;
+def debug_diagnostic_names : Flag<["-"], "debug-diagnostic-names">,
+  Flags<[FrontendOption, DoesNotAffectIncrementalBuild, HelpHidden]>,
+  HelpText<"Include diagnostic names when printing">;
 
 def module_cache_path : Separate<["-"], "module-cache-path">,
   Flags<[FrontendOption, DoesNotAffectIncrementalBuild, ArgumentIsPath]>,

branches/master-next/lib/AST/DiagnosticEngine.cpp

@@ -99,6 +99,15 @@ static constexpr const char * const diagnosticStrings[] = {
     "<not a diagnostic>",
 };
 
+static constexpr const char *const debugDiagnosticStrings[] = {
+#define ERROR(ID, Options, Text, Signature) Text " [" #ID "]",
+#define WARNING(ID, Options, Text, Signature) Text " [" #ID "]",
+#define NOTE(ID, Options, Text, Signature) Text " [" #ID "]",
+#define REMARK(ID, Options, Text, Signature) Text " [" #ID "]",
+#include "swift/AST/DiagnosticsAll.def"
+    "<not a diagnostic>",
+};
+
 DiagnosticState::DiagnosticState() {
   // Initialize our per-diagnostic state to default
   perDiagnosticBehavior.resize(LocalDiagID::NumDiags, Behavior::Unspecified);
@@ -893,14 +902,18 @@ void DiagnosticEngine::emitDiagnostic(const Diagnostic &diagnostic) {
   Info.Ranges = diagnostic.getRanges();
   Info.FixIts = diagnostic.getFixIts();
   for (auto &Consumer : Consumers) {
-    Consumer->handleDiagnostic(SourceMgr, loc, toDiagnosticKind(behavior),
-                               diagnosticStringFor(Info.ID),
-                               diagnostic.getArgs(), Info,
-                               getDefaultDiagnosticLoc());
+    Consumer->handleDiagnostic(
+        SourceMgr, loc, toDiagnosticKind(behavior),
+        diagnosticStringFor(Info.ID, getPrintDiagnosticNames()),
+        diagnostic.getArgs(), Info, getDefaultDiagnosticLoc());
   }
 }
 
-const char *DiagnosticEngine::diagnosticStringFor(const DiagID id) {
+const char *DiagnosticEngine::diagnosticStringFor(const DiagID id,
+                                                  bool printDiagnosticName) {
+  if (printDiagnosticName) {
+    return debugDiagnosticStrings[(unsigned)id];
+  }
   return diagnosticStrings[(unsigned)id];
 }
 

branches/master-next/lib/Driver/ToolChains.cpp

@@ -233,6 +233,7 @@ static void addCommonFrontendArgs(const ToolChain &TC, const OutputInfo &OI,
                        options::OPT_experimental_dependency_include_intrafile);
   inputArgs.AddLastArg(arguments, options::OPT_package_description_version);
   inputArgs.AddLastArg(arguments, options::OPT_serialize_diagnostics_path);
+  inputArgs.AddLastArg(arguments, options::OPT_debug_diagnostic_names);
   inputArgs.AddLastArg(arguments, options::OPT_enable_astscope_lookup);
   inputArgs.AddLastArg(arguments, options::OPT_disable_astscope_lookup);
   inputArgs.AddLastArg(arguments, options::OPT_disable_parser_lookup);

branches/master-next/lib/Frontend/CompilerInvocation.cpp

@@ -670,6 +670,7 @@ static bool ParseDiagnosticArgs(DiagnosticOptions &Opts, ArgList &Args,
   Opts.FixitCodeForAllDiagnostics |= Args.hasArg(OPT_fixit_all);
   Opts.SuppressWarnings |= Args.hasArg(OPT_suppress_warnings);
   Opts.WarningsAsErrors |= Args.hasArg(OPT_warnings_as_errors);
+  Opts.PrintDiagnosticNames |= Args.hasArg(OPT_debug_diagnostic_names);
 
   assert(!(Opts.WarningsAsErrors && Opts.SuppressWarnings) &&
          "conflicting arguments; should have been caught by driver");

branches/master-next/lib/Frontend/Frontend.cpp

@@ -308,6 +308,9 @@ void CompilerInstance::setUpDiagnosticOptions() {
   if (Invocation.getDiagnosticOptions().WarningsAsErrors) {
     Diagnostics.setWarningsAsErrors(true);
   }
+  if (Invocation.getDiagnosticOptions().PrintDiagnosticNames) {
+    Diagnostics.setPrintDiagnosticNames(true);
+  }
 }
 
 bool CompilerInstance::setUpModuleLoaders() {

branches/master-next/test/Frontend/debug-diagnostic-names.swift

@@ -0,0 +1,23 @@
+// RUN: not %target-swift-frontend -debug-diagnostic-names -typecheck %s 2>&1 | %FileCheck %s --check-prefix=CHECK_NAMES
+// RUN: not %target-swift-frontend -typecheck %s 2>&1 | %FileCheck %s --check-prefix=CHECK_NONAMES
+
+let x =
+// CHECK_NAMES: error: expected initial value after '=' [expected_init_value]{{$}}
+// CHECK_NONAMES: error: expected initial value after '='{{$}}
+
+guard let y = 0 else {}
+// CHECK_NAMES: error: initializer for conditional binding must have Optional type, not 'Int' [condition_optional_element_pattern_not_valid_type]{{$}}
+// CHECK_NONAMES: error: initializer for conditional binding must have Optional type, not 'Int'{{$}}
+
+let z: Double = ""
+// CHECK_NAMES: error: cannot convert value of type 'String' to specified type 'Double' [cannot_convert_initializer_value]{{$}}
+// CHECK_NONAMES: error: cannot convert value of type 'String' to specified type 'Double'{{$}}
+
+func foo() -> Int {
+  return
+  42
+}
+// CHECK_NAMES: warning: expression following 'return' is treated as an argument of the 'return' [unindented_code_after_return]{{$}}
+// CHECK_NAMES: note: indent the expression to silence this warning [indent_expression_to_silence]{{$}}
+// CHECK_NONAMES: warning: expression following 'return' is treated as an argument of the 'return'{{$}}
+// CHECK_NONAMES: note: indent the expression to silence this warning{{$}}