[Localization] Remove YAML format and tool

Author: xedin

include/swift/Localization/LocalizationFormat.h

@@ -27,8 +27,6 @@
 #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"
 #include <cstdint>
 #include <memory>
@@ -50,20 +48,6 @@ enum LocalizationProducerState : uint8_t {
   FailedInitialization
 };
 
-class DefToYAMLConverter {
-  llvm::ArrayRef<const char *> IDs;
-  llvm::ArrayRef<const char *> Messages;
-
-public:
-  DefToYAMLConverter(llvm::ArrayRef<const char *> ids,
-                     llvm::ArrayRef<const char *> messages)
-      : IDs(ids), Messages(messages) {
-    assert(IDs.size() == Messages.size());
-  }
-
-  void convert(llvm::raw_ostream &out);
-};
-
 class DefToStringsConverter {
   llvm::ArrayRef<const char *> IDs;
   llvm::ArrayRef<const char *> Messages;
@@ -195,9 +179,9 @@ class LocalizationProducer {
                                        llvm::StringRef defaultMessage);
 
   /// \returns a `SerializedLocalizationProducer` pointer if the serialized
-  /// diagnostics file available, otherwise returns a `YAMLLocalizationProducer`
-  /// if the `YAML` file is available. If both files aren't available returns a
-  /// `nullptr`.
+  /// diagnostics file available, otherwise returns a
+  /// `StringsLocalizationProducer` if the `.strings` file is available. If both
+  /// files aren't available returns a `nullptr`.
   static std::unique_ptr<LocalizationProducer>
   producerFor(llvm::StringRef locale, llvm::StringRef path,
               bool printDiagnosticNames);
@@ -218,27 +202,6 @@ class LocalizationProducer {
   virtual llvm::StringRef getMessage(swift::DiagID id) const = 0;
 };
 
-class YAMLLocalizationProducer final : public LocalizationProducer {
-  std::vector<std::string> diagnostics;
-  std::string filePath;
-
-public:
-  /// The diagnostics IDs that are no longer available in `.def`
-  std::vector<std::string> unknownIDs;
-  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
-  /// with its unique identifier.
-  void forEachAvailable(
-      llvm::function_ref<void(swift::DiagID, llvm::StringRef)> callback);
-
-protected:
-  bool initializeImpl() override;
-  llvm::StringRef getMessage(swift::DiagID id) const override;
-};
-
 class StringsLocalizationProducer final : public LocalizationProducer {
   std::string filePath;
 
@@ -281,32 +244,6 @@ class SerializedLocalizationProducer final : public LocalizationProducer {
   llvm::StringRef getMessage(swift::DiagID id) const override;
 };
 
-class LocalizationInput : public llvm::yaml::Input {
-  using Input::Input;
-
-  /// Read diagnostics in the YAML file iteratively
-  template <typename T, typename Context>
-  friend typename std::enable_if<llvm::yaml::has_SequenceTraits<T>::value,
-                                 void>::type
-  readYAML(llvm::yaml::IO &io, T &Seq, T &unknownIDs, bool, Context &Ctx);
-
-  template <typename T>
-  friend typename std::enable_if<llvm::yaml::has_SequenceTraits<T>::value,
-                                 LocalizationInput &>::type
-  operator>>(LocalizationInput &yin, T &diagnostics);
-
-public:
-  /// A vector that keeps track of the diagnostics IDs that are available in
-  /// YAML and not available in `.def` files.
-  std::vector<std::string> unknownIDs;
-  
-  /// A diagnostic ID might be present in YAML and not in `.def` file, if that's
-  /// the case the `id` won't have a `DiagID` value.
-  /// If the `id` is available in `.def` file this method will return the `id`'s
-  /// value, otherwise this method won't return a value.
-  static llvm::Optional<uint32_t> readID(llvm::yaml::IO &io);
-};
-
 } // namespace diag
 } // namespace swift
 

lib/ConstExtract/ConstExtract.cpp

@@ -21,6 +21,8 @@
 #include "swift/AST/TypeCheckRequests.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/JSON.h"
+#include "llvm/Support/YAMLParser.h"
+#include "llvm/Support/YAMLTraits.h"
 
 #include <set>
 #include <sstream>

lib/Localization/LocalizationFormat.cpp

@@ -24,9 +24,8 @@
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
-#include "llvm/Support/YAMLParser.h"
-#include "llvm/Support/YAMLTraits.h"
 #include <cstdint>
+#include <map>
 #include <string>
 #include <system_error>
 #include <type_traits>
@@ -47,24 +46,6 @@ static constexpr const char *const diagnosticNameStrings[] = {
 
 } // namespace
 
-namespace llvm {
-namespace yaml {
-
-template <> struct ScalarEnumerationTraits<LocalDiagID> {
-  static void enumeration(IO &io, LocalDiagID &value) {
-#define DIAG(KIND, ID, Options, Text, Signature)                               \
-  io.enumCase(value, #ID, LocalDiagID::ID);
-#include "swift/AST/DiagnosticsAll.def"
-    // Ignore diagnostic IDs that are available in the YAML file and not
-    // available in the `.def` file.
-    if (io.matchEnumFallback())
-      value = LocalDiagID::NumDiags;
-  }
-};
-
-} // namespace yaml
-} // namespace llvm
-
 namespace swift {
 namespace diag {
 
@@ -149,38 +130,6 @@ SerializedLocalizationProducer::getMessage(swift::DiagID id) const {
   return {(const char *)value.getDataPtr(), value.getDataLen()};
 }
 
-YAMLLocalizationProducer::YAMLLocalizationProducer(llvm::StringRef filePath,
-                                                   bool printDiagnosticNames)
-    : LocalizationProducer(printDiagnosticNames), filePath(filePath) {
-}
-
-bool YAMLLocalizationProducer::initializeImpl() {
-  auto FileBufOrErr = llvm::MemoryBuffer::getFileOrSTDIN(filePath);
-  llvm::MemoryBuffer *document = FileBufOrErr->get();
-  diag::LocalizationInput yin(document->getBuffer());
-  yin >> diagnostics;
-  unknownIDs = std::move(yin.unknownIDs);
-  return true;
-}
-
-llvm::StringRef YAMLLocalizationProducer::getMessage(swift::DiagID id) const {
-  return diagnostics[(unsigned)id];
-}
-
-void YAMLLocalizationProducer::forEachAvailable(
-    llvm::function_ref<void(swift::DiagID, llvm::StringRef)> callback) {
-  initializeIfNeeded();
-  if (getState() == FailedInitialization) {
-    return;
-  }
-
-  for (uint32_t i = 0, n = diagnostics.size(); i != n; ++i) {
-    auto translation = diagnostics[i];
-    if (!translation.empty())
-      callback(static_cast<swift::DiagID>(i), translation);
-  }
-}
-
 std::unique_ptr<LocalizationProducer>
 LocalizationProducer::producerFor(llvm::StringRef locale, llvm::StringRef path,
                                   bool printDiagnosticNames) {
@@ -189,21 +138,13 @@ LocalizationProducer::producerFor(llvm::StringRef locale, llvm::StringRef path,
   llvm::sys::path::replace_extension(filePath, ".db");
 
   // If the serialized diagnostics file not available,
-  // fallback to the `YAML` file.
+  // fallback to the `.strings` file.
   if (llvm::sys::fs::exists(filePath)) {
     if (auto file = llvm::MemoryBuffer::getFile(filePath)) {
       return std::make_unique<diag::SerializedLocalizationProducer>(
           std::move(file.get()), printDiagnosticNames);
     }
   } 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)) {
-      return std::make_unique<diag::YAMLLocalizationProducer>(
-          filePath.str(), printDiagnosticNames);
-    }
-
     llvm::sys::path::replace_extension(filePath, ".strings");
     if (llvm::sys::fs::exists(filePath)) {
       return std::make_unique<diag::StringsLocalizationProducer>(
@@ -214,86 +155,6 @@ LocalizationProducer::producerFor(llvm::StringRef locale, llvm::StringRef path,
   return std::unique_ptr<LocalizationProducer>();
 }
 
-llvm::Optional<uint32_t> LocalizationInput::readID(llvm::yaml::IO &io) {
-  LocalDiagID diagID;
-  io.mapRequired("id", diagID);
-  if (diagID == LocalDiagID::NumDiags)
-    return llvm::None;
-  return static_cast<uint32_t>(diagID);
-}
-
-template <typename T, typename Context>
-typename std::enable_if<llvm::yaml::has_SequenceTraits<T>::value, void>::type
-readYAML(llvm::yaml::IO &io, T &Seq, T &unknownIDs, bool, Context &Ctx) {
-  unsigned count = io.beginSequence();
-  if (count) {
-    Seq.resize(LocalDiagID::NumDiags);
-  }
-
-  for (unsigned i = 0; i < count; ++i) {
-    void *SaveInfo;
-    if (io.preflightElement(i, SaveInfo)) {
-      io.beginMapping();
-
-      // If the current diagnostic ID is available in YAML and in `.def`, add it
-      // to the diagnostics array. Otherwise, re-parse the current diagnostic
-      // id as a string and store it in `unknownIDs` array.
-      if (auto id = LocalizationInput::readID(io)) {
-        // YAML file isn't guaranteed to have diagnostics in order of their
-        // declaration in `.def` files, to accommodate that we need to leave
-        // holes in diagnostic array for diagnostics which haven't yet been
-        // localized and for the ones that have `id` indicates their position.
-        io.mapRequired("msg", Seq[*id]);
-      } else {
-        std::string unknownID, message;
-        // Read "raw" id since it doesn't exist in `.def` file.
-        io.mapRequired("id", unknownID);
-        io.mapRequired("msg", message);
-        unknownIDs.push_back(unknownID);
-      }
-      io.endMapping();
-      io.postflightElement(SaveInfo);
-    }
-  }
-  io.endSequence();
-}
-
-template <typename T>
-typename std::enable_if<llvm::yaml::has_SequenceTraits<T>::value,
-                        LocalizationInput &>::type
-operator>>(LocalizationInput &yin, T &diagnostics) {
-  llvm::yaml::EmptyContext Ctx;
-  if (yin.setCurrentDocument()) {
-    // If YAML file's format doesn't match the current format in
-    // DiagnosticMessageFormat, will throw an error.
-    readYAML(yin, diagnostics, yin.unknownIDs, true, Ctx);
-  }
-  return yin;
-}
-
-void DefToYAMLConverter::convert(llvm::raw_ostream &out) {
-  for (auto i : swift::indices(IDs)) {
-    out << "- id: " << IDs[i] << "\n";
-
-    const std::string &msg = Messages[i];
-
-    out << "  msg: \"";
-    // Add an escape character before a double quote `"` or a backslash `\`.
-    for (unsigned j = 0; j < msg.length(); ++j) {
-      if (msg[j] == '"') {
-        out << '\\';
-        out << '"';
-      } else if (msg[j] == '\\') {
-        out << '\\';
-        out << '\\';
-      } else {
-        out << msg[j];
-      }
-    }
-    out << "\"\r\n";
-  }
-}
-
 void DefToStringsConverter::convert(llvm::raw_ostream &out) {
   // "<id>" = "<msg>";
   for (auto i : swift::indices(IDs)) {

tools/CMakeLists.txt

@@ -22,7 +22,6 @@ add_swift_tool_subdirectory(sil-opt)
 add_swift_tool_subdirectory(swift-dependency-tool)
 add_swift_tool_subdirectory(swift-demangle)
 add_swift_tool_subdirectory(swift-demangle-yamldump)
-add_swift_tool_subdirectory(swift-def-to-yaml-converter)
 add_swift_tool_subdirectory(swift-def-to-strings-converter)
 add_swift_tool_subdirectory(swift-serialize-diagnostics)
 add_swift_tool_subdirectory(sil-func-extractor)