mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
6a444433ec
Introduce localization support for diagnostics via file-per-language store in `YAML` format. Add `LocalizationFormat` interface and its implementation `YAMLLocalizationProducer`. Augment `DiagnosticEngine` to support localization when applicable.
130 lines
4.1 KiB
C++
130 lines
4.1 KiB
C++
//===--- LocalizationFormat.cpp - YAML format for Diagnostic Messages ---*-
|
|
// C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the format for localized diagnostic messages.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "swift/AST/LocalizationFormat.h"
|
|
#include "llvm/ADT/SmallString.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
#include "llvm/Support/YAMLParser.h"
|
|
#include "llvm/Support/YAMLTraits.h"
|
|
#include <string>
|
|
#include <type_traits>
|
|
|
|
namespace {
|
|
enum LocalDiagID : uint32_t {
|
|
#define DIAG(KIND, ID, Options, Text, Signature) ID,
|
|
#include "swift/AST/DiagnosticsAll.def"
|
|
NumDiags
|
|
};
|
|
|
|
struct DiagnosticNode {
|
|
uint32_t id;
|
|
std::string msg;
|
|
};
|
|
} // 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"
|
|
}
|
|
};
|
|
|
|
template <> struct MappingTraits<DiagnosticNode> {
|
|
static void mapping(IO &io, DiagnosticNode &node) {
|
|
LocalDiagID diagID;
|
|
io.mapRequired("id", diagID);
|
|
io.mapRequired("msg", node.msg);
|
|
node.id = static_cast<uint32_t>(diagID);
|
|
}
|
|
};
|
|
|
|
} // namespace yaml
|
|
} // namespace llvm
|
|
|
|
namespace swift {
|
|
namespace diag {
|
|
|
|
YAMLLocalizationProducer::YAMLLocalizationProducer(std::string locale,
|
|
std::string path) {
|
|
llvm::SmallString<128> DiagnosticsFilePath(path);
|
|
llvm::sys::path::append(DiagnosticsFilePath, locale);
|
|
llvm::sys::path::replace_extension(DiagnosticsFilePath, ".yaml");
|
|
auto FileBufOrErr = llvm::MemoryBuffer::getFileOrSTDIN(DiagnosticsFilePath);
|
|
// Absence of localizations shouldn't crash the compiler.
|
|
if (!FileBufOrErr)
|
|
return;
|
|
llvm::MemoryBuffer *document = FileBufOrErr->get();
|
|
diag::LocalizationInput yin(document->getBuffer());
|
|
yin >> diagnostics;
|
|
}
|
|
|
|
llvm::StringRef
|
|
YAMLLocalizationProducer::getMessageOr(swift::DiagID id,
|
|
llvm::StringRef defaultMessage) const {
|
|
if (diagnostics.empty())
|
|
return defaultMessage;
|
|
const std::string &diagnosticMessage = diagnostics[(unsigned)id];
|
|
if (diagnosticMessage.empty())
|
|
return defaultMessage;
|
|
return diagnosticMessage;
|
|
}
|
|
|
|
template <typename T, typename Context>
|
|
typename std::enable_if<llvm::yaml::has_SequenceTraits<T>::value, void>::type
|
|
readYAML(llvm::yaml::IO &io, T &Seq, 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)) {
|
|
DiagnosticNode current;
|
|
yamlize(io, current, true, Ctx);
|
|
io.postflightElement(SaveInfo);
|
|
// 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 `DiagnosticNode::id`
|
|
// indicates their position.
|
|
Seq[static_cast<unsigned>(current.id)] = std::move(current.msg);
|
|
}
|
|
}
|
|
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, true, Ctx);
|
|
}
|
|
return yin;
|
|
}
|
|
|
|
} // namespace diag
|
|
} // namespace swift
|