Merge pull request #34319 from HassanElDesouky/localization-debug-diagnostics

[Diag] Print the diagnostic ID name from localization

Author: xedin

include/swift/AST/DiagnosticEngine.h

@@ -814,15 +814,15 @@ namespace swift {
       if (llvm::sys::fs::exists(filePath)) {
         if (auto file = llvm::MemoryBuffer::getFile(filePath)) {
           localization = std::make_unique<diag::SerializedLocalizationProducer>(
-              std::move(file.get()));
+              std::move(file.get()), getPrintDiagnosticNames());
         }
       } else {
         llvm::sys::path::replace_extension(filePath, ".yaml");
         // In case of missing localization files, we should fallback to messages
         // from `.def` files.
         if (llvm::sys::fs::exists(filePath)) {
-          localization =
-              std::make_unique<diag::YAMLLocalizationProducer>(filePath.str());
+          localization = std::make_unique<diag::YAMLLocalizationProducer>(
+              filePath.str(), getPrintDiagnosticNames());
         }
       }
     }
@@ -1049,7 +1049,7 @@ namespace swift {
 
   public:
     llvm::StringRef diagnosticStringFor(const DiagID id,
-                                        bool printDiagnosticName);
+                                        bool printDiagnosticNames);
 
     /// If there is no clear .dia file for a diagnostic, put it in the one
     /// corresponding to the SourceLoc given here.

include/swift/Localization/LocalizationFormat.h

@@ -26,6 +26,7 @@
 #include "llvm/Support/EndianStream.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/OnDiskHashTable.h"
+#include "llvm/Support/StringSaver.h"
 #include "llvm/Support/YAMLParser.h"
 #include "llvm/Support/YAMLTraits.h"
 #include "llvm/Support/raw_ostream.h"
@@ -154,14 +155,23 @@ class SerializedLocalizationWriter {
 };
 
 class LocalizationProducer {
+  /// This allocator will retain localized diagnostic strings containing the
+  /// diagnostic's message and identifier as `message [id]` for the duration of
+  /// compiler invocation. This will be used when the frontend flag
+  /// `-debug-diagnostic-names` is used.
+  llvm::BumpPtrAllocator localizationAllocator;
+  llvm::StringSaver localizationSaver;
+  bool printDiagnosticNames;
+
 public:
+  LocalizationProducer(bool printDiagnosticNames = false)
+      : localizationSaver(localizationAllocator),
+        printDiagnosticNames(printDiagnosticNames) {}
+
   /// If the  message isn't available/localized in current context
   /// return the fallback default message.
   virtual llvm::StringRef getMessageOr(swift::DiagID id,
-                                       llvm::StringRef defaultMessage) const {
-    auto message = getMessage(id);
-    return message.empty() ? defaultMessage : message;
-  }
+                                       llvm::StringRef defaultMessage);
 
   virtual ~LocalizationProducer() {}
 
@@ -177,7 +187,8 @@ class YAMLLocalizationProducer final : public LocalizationProducer {
 public:
   /// The diagnostics IDs that are no longer available in `.def`
   std::vector<std::string> unknownIDs;
-  explicit YAMLLocalizationProducer(llvm::StringRef filePath);
+  explicit YAMLLocalizationProducer(llvm::StringRef filePath,
+                                    bool printDiagnosticNames = false);
 
   /// Iterate over all of the available (non-empty) translations
   /// maintained by this producer, callback gets each translation
@@ -198,7 +209,8 @@ class SerializedLocalizationProducer final : public LocalizationProducer {
 
 public:
   explicit SerializedLocalizationProducer(
-      std::unique_ptr<llvm::MemoryBuffer> buffer);
+      std::unique_ptr<llvm::MemoryBuffer> buffer,
+      bool printDiagnosticNames = false);
 
 protected:
   llvm::StringRef getMessage(swift::DiagID id) const override;

lib/AST/DiagnosticEngine.cpp

@@ -1115,12 +1115,10 @@ void DiagnosticEngine::emitDiagnostic(const Diagnostic &diagnostic) {
 
 llvm::StringRef
 DiagnosticEngine::diagnosticStringFor(const DiagID id,
-                                      bool printDiagnosticName) {
-  // TODO: Print diagnostic names from `localization`.
-  if (printDiagnosticName) {
-    return debugDiagnosticStrings[(unsigned)id];
-  }
-  auto defaultMessage = diagnosticStrings[(unsigned)id];
+                                      bool printDiagnosticNames) {
+  auto defaultMessage = printDiagnosticNames
+                            ? debugDiagnosticStrings[(unsigned)id]
+                            : diagnosticStrings[(unsigned)id];
   if (localization) {
     auto localizedMessage =
         localization.get()->getMessageOr(id, defaultMessage);

lib/Localization/LocalizationFormat.cpp

@@ -37,6 +37,12 @@ enum LocalDiagID : uint32_t {
   NumDiags
 };
 
+static constexpr const char *const diagnosticNameStrings[] = {
+#define DIAG(KIND, ID, Options, Text, Signature) " [" #ID "]",
+#include "swift/AST/DiagnosticsAll.def"
+    "<not a diagnostic>",
+};
+
 } // namespace
 
 namespace llvm {
@@ -85,9 +91,24 @@ bool SerializedLocalizationWriter::emit(llvm::StringRef filePath) {
   return OS.has_error();
 }
 
+llvm::StringRef
+LocalizationProducer::getMessageOr(swift::DiagID id,
+                                   llvm::StringRef defaultMessage) {
+  auto localizedMessage = getMessage(id);
+  if (localizedMessage.empty())
+    return defaultMessage;
+  if (printDiagnosticNames) {
+    llvm::StringRef diagnosticName(diagnosticNameStrings[(unsigned)id]);
+    auto localizedDebugDiagnosticMessage =
+        localizationSaver.save(localizedMessage.str() + diagnosticName.str());
+    return localizedDebugDiagnosticMessage;
+  }
+  return localizedMessage;
+}
+
 SerializedLocalizationProducer::SerializedLocalizationProducer(
-    std::unique_ptr<llvm::MemoryBuffer> buffer)
-    : Buffer(std::move(buffer)) {
+    std::unique_ptr<llvm::MemoryBuffer> buffer, bool printDiagnosticNames)
+    : LocalizationProducer(printDiagnosticNames), Buffer(std::move(buffer)) {
   auto base =
       reinterpret_cast<const unsigned char *>(Buffer.get()->getBufferStart());
   auto tableOffset = endian::read<offset_type>(base, little);
@@ -103,7 +124,9 @@ SerializedLocalizationProducer::getMessage(swift::DiagID id) const {
   return {(const char *)value.getDataPtr(), value.getDataLen()};
 }
 
-YAMLLocalizationProducer::YAMLLocalizationProducer(llvm::StringRef filePath) {
+YAMLLocalizationProducer::YAMLLocalizationProducer(llvm::StringRef filePath,
+                                                   bool printDiagnosticNames)
+    : LocalizationProducer(printDiagnosticNames) {
   auto FileBufOrErr = llvm::MemoryBuffer::getFileOrSTDIN(filePath);
   llvm::MemoryBuffer *document = FileBufOrErr->get();
   diag::LocalizationInput yin(document->getBuffer());

test/diagnostics/Localization/en_debug_diagnostic_name.swift

@@ -0,0 +1,13 @@
+// RUN: not %target-swift-frontend -debug-diagnostic-names -localization-path %S/Inputs -locale en -typecheck %s 2>&1 | %FileCheck %s --check-prefix=CHECK_NAMES
+
+_ = "HI!
+// CHECK_NAMES: error: unterminated string literal [lex_unterminated_string]{{$}}
+
+var self1 = self1
+// CHECK_NAMES: error: circular reference [circular_reference]{{$}}
+// CHECK_NAMES: note: through reference here [circular_reference_through]{{$}}
+
+struct Broken {
+  var b : Bool = True 
+}
+// CHECK_NAMES: error: cannot find 'True' in scope [cannot_find_in_scope]{{$}}

test/diagnostics/Localization/fr_debug_diagnostic_name.swift

@@ -0,0 +1,19 @@
+// RUN: %empty-directory(%t)
+// RUN: swift-serialize-diagnostics --input-file-path=%S/Inputs/fr.yaml --output-directory=%t/
+// RUN: swift-serialize-diagnostics --input-file-path=%S/Inputs/en.yaml --output-directory=%t/ 2>&1 | %FileCheck %s
+// RUN: not %target-swift-frontend -debug-diagnostic-names -localization-path %S/Inputs -locale fr -typecheck %s 2>&1 | %FileCheck %s --check-prefix=CHECK_NAMES
+
+// CHECK: These diagnostic IDs are no longer availiable: 'not_available_in_def, not_available_in_def_2, not_available_in_def_3, not_available_in_def_4, not_available_in_def_5'
+_ = "HI!
+// CHECK_NAMES: error: chaîne non terminée littérale [lex_unterminated_string]{{$}}
+
+// FIXME: This used to produce a localized diagnostic.
+
+var self1 = self1
+// CHECK_NAMES: error: circular reference [circular_reference]{{$}}
+// CHECK_NAMES: note: through reference here [circular_reference_through]{{$}}
+
+struct Broken {
+  var b : Bool = True
+}
+// CHECK_NAMES: error: impossible de trouver 'True' portée [cannot_find_in_scope]{{$}}