[llvm] [llvm][Support] Add YAMLSchemeGen for producing YAML Schemes from YAM… (PR #133284)
via llvm-commits
llvm-commits at lists.llvm.org
Thu Mar 27 10:28:09 PDT 2025
https://github.com/tgs-sc created https://github.com/llvm/llvm-project/pull/133284
Introduced a way for generating scheme for validating input YAML. This can be useful to see the full structure of the input YAML file for different llvm based tools that use existing YAML parser, for example clang-format, clang-tidy e.t.c. This commit also can be useful for yaml-language-server.
>From 4b9e8a862d5e276ec53bf40a16db6491088a452a Mon Sep 17 00:00:00 2001
From: Timur Golubovich <timur.golubovich at syntacore.com>
Date: Thu, 27 Mar 2025 20:04:08 +0300
Subject: [PATCH] [llvm][Support] Add YAMLSchemeGen for producing YAML Schemes
from YAMLTraits
Introduced a way for generating scheme for validating input YAML. This can be
useful to see the full structure of the input YAML file for different llvm
based tools that use existing YAML parser, for example clang-format,
clang-tidy e.t.c. This commit also can be useful for yaml-language-server.
---
llvm/include/llvm/Support/YAMLSchemeGen.h | 497 ++++++++++++++++++
llvm/include/llvm/Support/YAMLTraits.h | 75 ++-
llvm/lib/Support/CMakeLists.txt | 1 +
llvm/lib/Support/YAMLSchemeGen.cpp | 163 ++++++
llvm/lib/Support/YAMLTraits.cpp | 4 +
llvm/unittests/ObjectYAML/CMakeLists.txt | 1 +
llvm/unittests/ObjectYAML/YAMLSchemeGen.cpp | 103 ++++
.../gn/secondary/llvm/lib/Support/BUILD.gn | 1 +
8 files changed, 818 insertions(+), 27 deletions(-)
create mode 100644 llvm/include/llvm/Support/YAMLSchemeGen.h
create mode 100644 llvm/lib/Support/YAMLSchemeGen.cpp
create mode 100644 llvm/unittests/ObjectYAML/YAMLSchemeGen.cpp
diff --git a/llvm/include/llvm/Support/YAMLSchemeGen.h b/llvm/include/llvm/Support/YAMLSchemeGen.h
new file mode 100644
index 0000000000000..8100e3f1d175f
--- /dev/null
+++ b/llvm/include/llvm/Support/YAMLSchemeGen.h
@@ -0,0 +1,497 @@
+//===- llvm/Support/YAMLSchemeGen.h -----------------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SUPPORT_YAMLSCHEMEGEN_H
+#define LLVM_SUPPORT_YAMLSCHEMEGEN_H
+
+#include "llvm/Support/YAMLTraits.h"
+
+namespace llvm {
+
+namespace yaml {
+
+class SchemeGen : public IO {
+public:
+ SchemeGen(raw_ostream &RO, void *Ctxt = nullptr, int WrapColumn = 70);
+ ~SchemeGen() override = default;
+
+ IOKind getKind() const override;
+ bool outputting() const override;
+ bool mapTag(StringRef, bool) override;
+ void beginMapping() override;
+ void endMapping() override;
+ bool preflightKey(const char *key, bool, bool, bool &, void *&) override;
+ void postflightKey(void *) override;
+ std::vector<StringRef> keys() override;
+ void beginFlowMapping() override;
+ void endFlowMapping() override;
+ unsigned beginSequence() override;
+ void endSequence() override;
+ bool preflightElement(unsigned, void *&) override;
+ void postflightElement(void *) override;
+ unsigned beginFlowSequence() override;
+ bool preflightFlowElement(unsigned, void *&) override;
+ void postflightFlowElement(void *) override;
+ void endFlowSequence() override;
+ void beginEnumScalar() override;
+ bool matchEnumScalar(const char *, bool) override;
+ bool matchEnumFallback() override;
+ void endEnumScalar() override;
+ bool beginBitSetScalar(bool &) override;
+ bool bitSetMatch(const char *, bool) override;
+ void endBitSetScalar() override;
+ void scalarString(StringRef &, QuotingType) override;
+ void blockScalarString(StringRef &) override;
+ void scalarTag(std::string &) override;
+ NodeKind getNodeKind() override;
+ void setError(const Twine &message) override;
+ bool canElideEmptySequence() override;
+
+ // These are only used by operator<<. They could be private
+ // if that templated operator could be made a friend.
+ void beginDocuments();
+ bool preflightDocument(unsigned);
+ void postflightDocument();
+ void endDocuments();
+
+ // These are needed to yamlize scheme.
+ struct YNode {
+ public:
+ YNode(NodeKind Kind) : Kind(Kind) {}
+
+ NodeKind getNodeKind() const { return Kind; }
+
+ private:
+ NodeKind Kind;
+ };
+
+ class ScalarYNode final : public YNode {
+ StringRef Str;
+ QuotingType QT;
+
+ public:
+ ScalarYNode(StringRef Str, QuotingType QT)
+ : YNode(NodeKind::Scalar), Str(Str), QT(QT) {}
+
+ StringRef getValue() const { return Str; }
+
+ QuotingType getQuotingType() const { return QT; }
+ };
+
+ class MapYNode final : public YNode,
+ SmallVector<std::pair<StringRef, YNode *>, 8> {
+ public:
+ using BaseVector = SmallVector<std::pair<StringRef, YNode *>, 8>;
+
+ MapYNode() : YNode(NodeKind::Map) {}
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+ };
+
+ class SequenceYNode final : public YNode, SmallVector<YNode *, 8> {
+ public:
+ using BaseVector = SmallVector<YNode *, 8>;
+
+ SequenceYNode() : YNode(NodeKind::Sequence) {}
+
+ using BaseVector::operator[];
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::resize;
+ using BaseVector::size;
+ };
+
+private:
+ template <typename YNodeType, typename... YNodeArgs>
+ YNodeType *createYNode(YNodeArgs &&...Args) {
+ auto UPtr = std::make_unique<YNodeType>(std::forward<YNodeArgs>(Args)...);
+ auto *Ptr = UPtr.get();
+ YNodes.emplace_back(std::move(UPtr));
+ return Ptr;
+ }
+
+public:
+ ScalarYNode *createScalarYNode(StringRef Str) {
+ return createYNode<ScalarYNode>(Str, QuotingType::None);
+ }
+
+ MapYNode *createMapYNode() { return createYNode<MapYNode>(); }
+
+ SequenceYNode *createSequenceYNode() { return createYNode<SequenceYNode>(); }
+
+ std::vector<std::unique_ptr<YNode>> YNodes;
+
+ using StringVector = SmallVector<StringRef, 8>;
+
+ class SchemeNode {
+ public:
+ virtual YNode *yamlize(SchemeGen &Gen) const = 0;
+
+ virtual ~SchemeNode() = default;
+ };
+
+ enum class PropertyKind : uint8_t {
+ Properties,
+ Required,
+ Type,
+ Enum,
+ Items,
+ };
+
+ class Scheme;
+
+ class SchemeProperty : public SchemeNode {
+ PropertyKind Kind;
+ StringRef Name;
+
+ public:
+ SchemeProperty(PropertyKind Kind, StringRef Name)
+ : Kind(Kind), Name(Name) {}
+
+ PropertyKind getKind() const { return Kind; }
+
+ StringRef getName() const { return Name; }
+ };
+
+ class PropertiesProperty final
+ : public SchemeProperty,
+ SmallVector<std::pair<StringRef, Scheme *>, 8> {
+ public:
+ using BaseVector = SmallVector<std::pair<StringRef, Scheme *>, 8>;
+
+ PropertiesProperty()
+ : SchemeProperty(PropertyKind::Properties, "properties") {}
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ auto *Map = Gen.createMapYNode();
+ for (auto &&[Key, Value] : *this) {
+ auto *Y = Value->yamlize(Gen);
+ Map->emplace_back(Key, Y);
+ }
+ return Map;
+ }
+ };
+
+ class RequiredProperty final : public SchemeProperty, StringVector {
+ public:
+ using BaseVector = StringVector;
+
+ RequiredProperty() : SchemeProperty(PropertyKind::Required, "required") {}
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ if (size() == 1) {
+ auto *Scalar = Gen.createScalarYNode(*begin());
+ return Scalar;
+ }
+ auto *Sequence = Gen.createSequenceYNode();
+ for (auto &&Value : *this) {
+ auto *Scalar = Gen.createScalarYNode(Value);
+ Sequence->emplace_back(Scalar);
+ }
+ return Sequence;
+ }
+ };
+
+ class TypeProperty final : public SchemeProperty {
+ StringRef Value = "any";
+
+ public:
+ TypeProperty() : SchemeProperty(PropertyKind::Type, "type") {}
+
+ StringRef getValue() const { return Value; }
+
+ void setValue(StringRef Val) { Value = Val; }
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ auto *Scalar = Gen.createScalarYNode(Value);
+ return Scalar;
+ }
+ };
+
+ class EnumProperty final : public SchemeProperty, StringVector {
+ public:
+ using BaseVector = StringVector;
+
+ EnumProperty() : SchemeProperty(PropertyKind::Enum, "enum") {}
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ auto *Sequence = Gen.createSequenceYNode();
+ for (auto &&Value : *this) {
+ auto *Scalar = Gen.createScalarYNode(Value);
+ Sequence->emplace_back(Scalar);
+ }
+ return Sequence;
+ }
+ };
+
+ class ItemsProperty final : public SchemeProperty, SmallVector<Scheme *, 8> {
+ public:
+ using BaseVector = SmallVector<Scheme *, 8>;
+
+ ItemsProperty() : SchemeProperty(PropertyKind::Items, "items") {}
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ auto *Sequence = Gen.createSequenceYNode();
+ for (auto &&Value : *this) {
+ auto *Y = Value->yamlize(Gen);
+ Sequence->emplace_back(Y);
+ }
+ return Sequence;
+ }
+ };
+
+ class Scheme final : public SchemeNode, SmallVector<SchemeProperty *, 8> {
+ public:
+ using BaseVector = SmallVector<SchemeProperty *, 8>;
+
+ Scheme() = default;
+
+ using BaseVector::begin;
+ using BaseVector::emplace_back;
+ using BaseVector::end;
+ using BaseVector::size;
+
+ template <typename PropertyType> PropertyType *findProperty() const {
+ auto P = PropertyType{};
+ auto Found = std::find_if(begin(), end(), [&](auto &&Prop) {
+ return Prop->getKind() == P.getKind();
+ });
+ return Found != end() ? static_cast<PropertyType *>(*Found) : nullptr;
+ }
+
+ template <typename PropertyType> bool hasProperty() const {
+ return findProperty<PropertyType>() != nullptr;
+ }
+
+ YNode *yamlize(SchemeGen &Gen) const override {
+ auto *Map = Gen.createMapYNode();
+ for (auto &&Value : *this) {
+ auto *Y = Value->yamlize(Gen);
+ auto Name = Value->getName();
+ Map->emplace_back(Name, Y);
+ }
+ return Map;
+ }
+ };
+
+private:
+ std::vector<std::unique_ptr<SchemeNode>> SchemeNodes;
+ SmallVector<Scheme *, 8> Schemes;
+
+ template <typename PropertyType> PropertyType *createProperty() {
+ auto UPtr = std::make_unique<PropertyType>();
+ auto *Ptr = UPtr.get();
+ SchemeNodes.emplace_back(std::move(UPtr));
+ return Ptr;
+ }
+
+public:
+ template <typename PropertyType>
+ PropertyType *getOrCreateProperty(Scheme &S) {
+ auto Found = S.findProperty<PropertyType>();
+ if (!Found) {
+ Found = createProperty<PropertyType>();
+ S.emplace_back(Found);
+ }
+ return Found;
+ }
+
+ Scheme *createScheme() {
+ auto UPtr = std::make_unique<Scheme>();
+ auto *Ptr = UPtr.get();
+ SchemeNodes.emplace_back(std::move(UPtr));
+ return Ptr;
+ }
+
+ Scheme *getTopScheme() const {
+ return Schemes.empty() ? nullptr : Schemes.back();
+ }
+
+private:
+ Output O;
+ SchemeNode *Root = nullptr;
+};
+
+template <> struct PolymorphicTraits<SchemeGen::YNode> {
+ static NodeKind getKind(const SchemeGen::YNode &N) { return N.getNodeKind(); }
+
+ static SchemeGen::ScalarYNode &getAsScalar(SchemeGen::YNode &N) {
+ return (SchemeGen::ScalarYNode &)N;
+ }
+
+ static SchemeGen::MapYNode &getAsMap(SchemeGen::YNode &N) {
+ return (SchemeGen::MapYNode &)N;
+ }
+
+ static SchemeGen::SequenceYNode &getAsSequence(SchemeGen::YNode &N) {
+ return (SchemeGen::SequenceYNode &)N;
+ }
+};
+
+template <> struct ScalarTraits<SchemeGen::ScalarYNode> {
+ static void output(const SchemeGen::ScalarYNode &N, void *Ctx,
+ llvm::raw_ostream &Out) {
+ Out << N.getValue();
+ }
+
+ static StringRef input(StringRef Scalar, void *Ctx,
+ SchemeGen::ScalarYNode &N) {
+ return {};
+ }
+
+ static QuotingType mustQuote(StringRef) { return QuotingType::None; }
+};
+
+template <> struct MappingTraits<SchemeGen::MapYNode> {
+ static void mapping(IO &io, SchemeGen::MapYNode &N) {
+ for (auto &&[Key, Value] : N) {
+ io.mapRequired(Key.data(), *Value);
+ }
+ }
+};
+
+template <> struct SequenceTraits<SchemeGen::SequenceYNode> {
+ static size_t size(IO &io, SchemeGen::SequenceYNode &N) { return N.size(); }
+
+ static SchemeGen::YNode &element(IO &, SchemeGen::SequenceYNode &N,
+ size_t Idx) {
+ if (Idx >= N.size())
+ N.resize(Idx + 1);
+ return *(N[Idx]);
+ }
+};
+
+// Define non-member operator<< so that Output can stream out document list.
+template <typename T>
+inline std::enable_if_t<has_DocumentListTraits<T>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &DocList) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ const size_t count = DocumentListTraits<T>::size(Gen, DocList);
+ for (size_t i = 0; i < count; ++i) {
+ if (Gen.preflightDocument(i)) {
+ yamlize(Gen, DocumentListTraits<T>::element(Gen, DocList, i), true, Ctx);
+ Gen.postflightDocument();
+ }
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Define non-member operator<< so that Output can stream out a map.
+template <typename T>
+inline std::enable_if_t<has_MappingTraits<T, EmptyContext>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &Map) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ if (Gen.preflightDocument(0)) {
+ yamlize(Gen, Map, true, Ctx);
+ Gen.postflightDocument();
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Define non-member operator<< so that Output can stream out a sequence.
+template <typename T>
+inline std::enable_if_t<has_SequenceTraits<T>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &Seq) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ if (Gen.preflightDocument(0)) {
+ yamlize(Gen, Seq, true, Ctx);
+ Gen.postflightDocument();
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Define non-member operator<< so that Output can stream out a block scalar.
+template <typename T>
+inline std::enable_if_t<has_BlockScalarTraits<T>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &Val) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ if (Gen.preflightDocument(0)) {
+ yamlize(Gen, Val, true, Ctx);
+ Gen.postflightDocument();
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Define non-member operator<< so that Output can stream out a string map.
+template <typename T>
+inline std::enable_if_t<has_CustomMappingTraits<T>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &Val) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ if (Gen.preflightDocument(0)) {
+ yamlize(Gen, Val, true, Ctx);
+ Gen.postflightDocument();
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Define non-member operator<< so that Output can stream out a polymorphic
+// type.
+template <typename T>
+inline std::enable_if_t<has_PolymorphicTraits<T>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &Val) {
+ EmptyContext Ctx;
+ Gen.beginDocuments();
+ if (Gen.preflightDocument(0)) {
+ // FIXME: The parser does not support explicit documents terminated with a
+ // plain scalar; the end-marker is included as part of the scalar token.
+ assert(PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar &&
+ "plain scalar documents are not supported");
+ yamlize(Gen, Val, true, Ctx);
+ Gen.postflightDocument();
+ }
+ Gen.endDocuments();
+ return Gen;
+}
+
+// Provide better error message about types missing a trait specialization
+template <typename T>
+inline std::enable_if_t<missingTraits<T, EmptyContext>::value, SchemeGen &>
+operator<<(SchemeGen &Gen, T &seq) {
+ char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
+ return Gen;
+}
+
+} // namespace yaml
+
+} // namespace llvm
+
+#endif // LLVM_SUPPORT_YAMLSCHEMEGEN_H
diff --git a/llvm/include/llvm/Support/YAMLTraits.h b/llvm/include/llvm/Support/YAMLTraits.h
index e707a445012b5..61f90fbdc5ac8 100644
--- a/llvm/include/llvm/Support/YAMLTraits.h
+++ b/llvm/include/llvm/Support/YAMLTraits.h
@@ -774,12 +774,19 @@ struct unvalidatedMappingTraits
bool, has_MappingTraits<T, Context>::value &&
!has_MappingValidateTraits<T, Context>::value> {};
+enum class IOKind : uint8_t {
+ Outputting,
+ Inputting,
+ SchemeGenering,
+};
+
// Base class for Input and Output.
class IO {
public:
IO(void *Ctxt = nullptr);
virtual ~IO();
+ virtual IOKind getKind() const = 0;
virtual bool outputting() const = 0;
virtual unsigned beginSequence() = 0;
@@ -824,15 +831,17 @@ class IO {
template <typename T>
void enumCase(T &Val, const char* Str, const T ConstVal) {
- if ( matchEnumScalar(Str, outputting() && Val == ConstVal) ) {
+ if (matchEnumScalar(Str,
+ getKind() == IOKind::Outputting && Val == ConstVal)) {
Val = ConstVal;
}
}
// allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
template <typename T>
- void enumCase(T &Val, const char* Str, const uint32_t ConstVal) {
- if ( matchEnumScalar(Str, outputting() && Val == static_cast<T>(ConstVal)) ) {
+ void enumCase(T &Val, const char *Str, const uint32_t ConstVal) {
+ if (matchEnumScalar(Str, getKind() == IOKind::Outputting &&
+ Val == static_cast<T>(ConstVal))) {
Val = ConstVal;
}
}
@@ -849,8 +858,9 @@ class IO {
}
template <typename T>
- void bitSetCase(T &Val, const char* Str, const T ConstVal) {
- if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
+ void bitSetCase(T &Val, const char *Str, const T ConstVal) {
+ if (bitSetMatch(Str, getKind() == IOKind::Outputting &&
+ (Val & ConstVal) == ConstVal)) {
Val = static_cast<T>(Val | ConstVal);
}
}
@@ -858,21 +868,24 @@ class IO {
// allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
template <typename T>
void bitSetCase(T &Val, const char* Str, const uint32_t ConstVal) {
- if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
+ if (bitSetMatch(Str, getKind() == IOKind::Outputting &&
+ (Val & ConstVal) == ConstVal)) {
Val = static_cast<T>(Val | ConstVal);
}
}
template <typename T>
void maskedBitSetCase(T &Val, const char *Str, T ConstVal, T Mask) {
- if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
+ if (bitSetMatch(Str, getKind() == IOKind::Outputting &&
+ (Val & Mask) == ConstVal))
Val = Val | ConstVal;
}
template <typename T>
void maskedBitSetCase(T &Val, const char *Str, uint32_t ConstVal,
uint32_t Mask) {
- if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
+ if (bitSetMatch(Str, getKind() == IOKind::Outputting &&
+ (Val & Mask) == ConstVal))
Val = Val | ConstVal;
}
@@ -942,7 +955,8 @@ class IO {
bool Required, Context &Ctx) {
void *SaveInfo;
bool UseDefault;
- const bool sameAsDefault = outputting() && Val == DefaultValue;
+ const bool sameAsDefault =
+ (getKind() == IOKind::Outputting) && Val == DefaultValue;
if ( this->preflightKey(Key, Required, sameAsDefault, UseDefault,
SaveInfo) ) {
yamlize(*this, Val, Required, Ctx);
@@ -1004,7 +1018,7 @@ yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
template <typename T>
std::enable_if_t<has_ScalarTraits<T>::value, void> yamlize(IO &io, T &Val, bool,
EmptyContext &Ctx) {
- if ( io.outputting() ) {
+ if (io.getKind() != IOKind::Inputting) {
SmallString<128> Storage;
raw_svector_ostream Buffer(Storage);
ScalarTraits<T>::output(Val, io.getContext(), Buffer);
@@ -1024,7 +1038,7 @@ std::enable_if_t<has_ScalarTraits<T>::value, void> yamlize(IO &io, T &Val, bool,
template <typename T>
std::enable_if_t<has_BlockScalarTraits<T>::value, void>
yamlize(IO &YamlIO, T &Val, bool, EmptyContext &Ctx) {
- if (YamlIO.outputting()) {
+ if (YamlIO.getKind() != IOKind::Inputting) {
std::string Storage;
raw_string_ostream Buffer(Storage);
BlockScalarTraits<T>::output(Val, YamlIO.getContext(), Buffer);
@@ -1043,7 +1057,7 @@ yamlize(IO &YamlIO, T &Val, bool, EmptyContext &Ctx) {
template <typename T>
std::enable_if_t<has_TaggedScalarTraits<T>::value, void>
yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
- if (io.outputting()) {
+ if (io.getKind() != IOKind::Inputting) {
std::string ScalarStorage, TagStorage;
raw_string_ostream ScalarBuffer(ScalarStorage), TagBuffer(TagStorage);
TaggedScalarTraits<T>::output(Val, io.getContext(), ScalarBuffer,
@@ -1085,7 +1099,7 @@ yamlize(IO &io, T &Val, bool, Context &Ctx) {
io.beginFlowMapping();
else
io.beginMapping();
- if (io.outputting()) {
+ if (io.getKind() == IOKind::Outputting) {
std::string Err = detail::doValidate(io, Val, Ctx);
if (!Err.empty()) {
errs() << Err << "\n";
@@ -1093,7 +1107,7 @@ yamlize(IO &io, T &Val, bool, Context &Ctx) {
}
}
detail::doMapping(io, Val, Ctx);
- if (!io.outputting()) {
+ if (io.getKind() == IOKind::Inputting) {
std::string Err = detail::doValidate(io, Val, Ctx);
if (!Err.empty())
io.setError(Err);
@@ -1113,7 +1127,7 @@ yamlizeMappingEnumInput(IO &io, T &Val) {
template <typename T, typename Context>
std::enable_if_t<has_MappingEnumInputTraits<T, Context>::value, bool>
yamlizeMappingEnumInput(IO &io, T &Val) {
- if (io.outputting())
+ if (io.getKind() != IOKind::Inputting)
return false;
io.beginEnumScalar();
@@ -1142,7 +1156,7 @@ yamlize(IO &io, T &Val, bool, Context &Ctx) {
template <typename T>
std::enable_if_t<has_CustomMappingTraits<T>::value, void>
yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
- if ( io.outputting() ) {
+ if (io.getKind() != IOKind::Inputting) {
io.beginMapping();
CustomMappingTraits<T>::output(io, Val);
io.endMapping();
@@ -1157,8 +1171,9 @@ yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
template <typename T>
std::enable_if_t<has_PolymorphicTraits<T>::value, void>
yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
- switch (io.outputting() ? PolymorphicTraits<T>::getKind(Val)
- : io.getNodeKind()) {
+ switch ((io.getKind() == IOKind::Inputting)
+ ? io.getNodeKind()
+ : PolymorphicTraits<T>::getKind(Val)) {
case NodeKind::Scalar:
return yamlize(io, PolymorphicTraits<T>::getAsScalar(Val), true, Ctx);
case NodeKind::Map:
@@ -1179,7 +1194,9 @@ std::enable_if_t<has_SequenceTraits<T>::value, void>
yamlize(IO &io, T &Seq, bool, Context &Ctx) {
if ( has_FlowTraits< SequenceTraits<T>>::value ) {
unsigned incnt = io.beginFlowSequence();
- unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
+ unsigned count = (io.getKind() == IOKind::Outputting)
+ ? SequenceTraits<T>::size(io, Seq)
+ : incnt;
for(unsigned i=0; i < count; ++i) {
void *SaveInfo;
if ( io.preflightFlowElement(i, SaveInfo) ) {
@@ -1191,7 +1208,9 @@ yamlize(IO &io, T &Seq, bool, Context &Ctx) {
}
else {
unsigned incnt = io.beginSequence();
- unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
+ unsigned count = (io.getKind() == IOKind::Outputting)
+ ? SequenceTraits<T>::size(io, Seq)
+ : incnt;
for(unsigned i=0; i < count; ++i) {
void *SaveInfo;
if ( io.preflightElement(i, SaveInfo) ) {
@@ -1358,7 +1377,7 @@ template <typename TNorm, typename TFinal>
struct MappingNormalization {
MappingNormalization(IO &i_o, TFinal &Obj)
: io(i_o), BufPtr(nullptr), Result(Obj) {
- if ( io.outputting() ) {
+ if (io.getKind() == IOKind::Outputting) {
BufPtr = new (&Buffer) TNorm(io, Obj);
}
else {
@@ -1367,7 +1386,7 @@ struct MappingNormalization {
}
~MappingNormalization() {
- if ( ! io.outputting() ) {
+ if (io.getKind() == IOKind::Inputting) {
Result = BufPtr->denormalize(io);
}
BufPtr->~TNorm();
@@ -1390,7 +1409,7 @@ template <typename TNorm, typename TFinal>
struct MappingNormalizationHeap {
MappingNormalizationHeap(IO &i_o, TFinal &Obj, BumpPtrAllocator *allocator)
: io(i_o), Result(Obj) {
- if ( io.outputting() ) {
+ if (io.getKind() == IOKind::Outputting) {
BufPtr = new (&Buffer) TNorm(io, Obj);
}
else if (allocator) {
@@ -1402,7 +1421,7 @@ struct MappingNormalizationHeap {
}
~MappingNormalizationHeap() {
- if ( io.outputting() ) {
+ if (io.getKind() == IOKind::Outputting) {
BufPtr->~TNorm();
}
else {
@@ -1452,6 +1471,7 @@ class Input : public IO {
std::error_code error() override;
private:
+ IOKind getKind() const override;
bool outputting() const override;
bool mapTag(StringRef, bool) override;
void beginMapping() override;
@@ -1603,6 +1623,7 @@ class Output : public IO {
/// anyway.
void setWriteDefaultValues(bool Write) { WriteDefaultValues = Write; }
+ IOKind getKind() const override;
bool outputting() const override;
bool mapTag(StringRef, bool) override;
void beginMapping() override;
@@ -1688,8 +1709,8 @@ void IO::processKeyWithDefault(const char *Key, std::optional<T> &Val,
assert(!DefaultValue && "std::optional<T> shouldn't have a value!");
void *SaveInfo;
bool UseDefault = true;
- const bool sameAsDefault = outputting() && !Val;
- if (!outputting() && !Val)
+ const bool sameAsDefault = (getKind() == IOKind::Outputting) && !Val;
+ if (!(getKind() == IOKind::Outputting) && !Val)
Val = T();
if (Val &&
this->preflightKey(Key, Required, sameAsDefault, UseDefault, SaveInfo)) {
@@ -1699,7 +1720,7 @@ void IO::processKeyWithDefault(const char *Key, std::optional<T> &Val,
// was requested, i.e. the DefaultValue will be assigned. The DefaultValue
// is usually None.
bool IsNone = false;
- if (!outputting())
+ if (getKind() == IOKind::Inputting)
if (const auto *Node =
dyn_cast<ScalarNode>(((Input *)this)->getCurrentNode()))
// We use rtrim to ignore possible white spaces that might exist when a
diff --git a/llvm/lib/Support/CMakeLists.txt b/llvm/lib/Support/CMakeLists.txt
index 2754c97fce6c1..6ebc8c426bc50 100644
--- a/llvm/lib/Support/CMakeLists.txt
+++ b/llvm/lib/Support/CMakeLists.txt
@@ -272,6 +272,7 @@ add_llvm_component_library(LLVMSupport
WithColor.cpp
YAMLParser.cpp
YAMLTraits.cpp
+ YAMLSchemeGen.cpp
raw_os_ostream.cpp
raw_ostream.cpp
raw_socket_stream.cpp
diff --git a/llvm/lib/Support/YAMLSchemeGen.cpp b/llvm/lib/Support/YAMLSchemeGen.cpp
new file mode 100644
index 0000000000000..16f7e81145308
--- /dev/null
+++ b/llvm/lib/Support/YAMLSchemeGen.cpp
@@ -0,0 +1,163 @@
+//===- lib/Support/YAMLSchemeGen.cpp --------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Support/YAMLSchemeGen.h"
+
+using namespace llvm;
+using namespace yaml;
+
+//===----------------------------------------------------------------------===//
+// SchemeGen
+//===----------------------------------------------------------------------===//
+
+SchemeGen::SchemeGen(raw_ostream &RO, void *Ctxt, int WrapColumn)
+ : O(RO, Ctxt, WrapColumn) {}
+
+IOKind SchemeGen::getKind() const { return IOKind::SchemeGenering; }
+
+bool SchemeGen::outputting() const { return false; }
+
+bool SchemeGen::mapTag(StringRef, bool) { return false; }
+
+void SchemeGen::beginMapping() {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *Type = getOrCreateProperty<TypeProperty>(*Top);
+ Type->setValue("object");
+}
+
+void SchemeGen::endMapping() {}
+
+bool SchemeGen::preflightKey(const char *Key, bool Required, bool SameAsDefault,
+ bool &UseDefault, void *&SaveInfo) {
+ auto *Top = getTopScheme();
+ assert(Top);
+ if (Required) {
+ auto *Req = getOrCreateProperty<RequiredProperty>(*Top);
+ Req->emplace_back(Key);
+ }
+ auto *S = createScheme();
+ auto *Properties = getOrCreateProperty<PropertiesProperty>(*Top);
+ Properties->emplace_back(Key, S);
+ Schemes.push_back(S);
+ return true;
+}
+
+void SchemeGen::postflightKey(void *) {
+ assert(!Schemes.empty());
+ Schemes.pop_back();
+}
+
+std::vector<StringRef> SchemeGen::keys() { return {}; }
+
+void SchemeGen::beginFlowMapping() { beginMapping(); }
+
+void SchemeGen::endFlowMapping() { endMapping(); }
+
+unsigned SchemeGen::beginSequence() {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *Type = getOrCreateProperty<TypeProperty>(*Top);
+ Type->setValue("array");
+ getOrCreateProperty<ItemsProperty>(*Top);
+ return 1;
+}
+
+void SchemeGen::endSequence() {}
+
+bool SchemeGen::preflightElement(unsigned, void *&) {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *S = createScheme();
+ auto *Items = getOrCreateProperty<ItemsProperty>(*Top);
+ Items->emplace_back(S);
+ Schemes.push_back(S);
+ return true;
+}
+
+void SchemeGen::postflightElement(void *) {
+ assert(!Schemes.empty());
+ Schemes.pop_back();
+}
+
+unsigned SchemeGen::beginFlowSequence() { return beginSequence(); }
+
+bool SchemeGen::preflightFlowElement(unsigned Arg1, void *&Arg2) {
+ return preflightElement(Arg1, Arg2);
+}
+
+void SchemeGen::postflightFlowElement(void *Arg1) { postflightElement(Arg1); }
+
+void SchemeGen::endFlowSequence() { endSequence(); }
+
+void SchemeGen::beginEnumScalar() {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *Type = getOrCreateProperty<TypeProperty>(*Top);
+ Type->setValue("string");
+ getOrCreateProperty<EnumProperty>(*Top);
+}
+
+bool SchemeGen::matchEnumScalar(const char *Val, bool) {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *Enum = getOrCreateProperty<EnumProperty>(*Top);
+ Enum->emplace_back(Val);
+ return false;
+}
+
+bool SchemeGen::matchEnumFallback() { return false; }
+
+void SchemeGen::endEnumScalar() {}
+
+bool SchemeGen::beginBitSetScalar(bool &) {
+ beginEnumScalar();
+ return true;
+}
+
+bool SchemeGen::bitSetMatch(const char *Val, bool Arg) {
+ return matchEnumScalar(Val, Arg);
+}
+
+void SchemeGen::endBitSetScalar() { endEnumScalar(); }
+
+void SchemeGen::scalarString(StringRef &Val, QuotingType) {
+ auto *Top = getTopScheme();
+ assert(Top);
+ auto *Type = getOrCreateProperty<TypeProperty>(*Top);
+ Type->setValue("string");
+}
+
+void SchemeGen::blockScalarString(StringRef &Val) {}
+
+void SchemeGen::scalarTag(std::string &val) {}
+
+NodeKind SchemeGen::getNodeKind() { report_fatal_error("invalid call"); }
+
+void SchemeGen::setError(const Twine &) {}
+
+bool SchemeGen::canElideEmptySequence() { return false; }
+
+// These are only used by operator<<. They could be private
+// if that templated operator could be made a friend.
+void SchemeGen::beginDocuments() {}
+
+bool SchemeGen::preflightDocument(unsigned) {
+ auto *S = createScheme();
+ Root = S;
+ Schemes.push_back(S);
+ return true;
+}
+
+void SchemeGen::postflightDocument() {
+ assert(!Schemes.empty());
+ Schemes.pop_back();
+ O << *Root->yamlize(*this);
+}
+
+void SchemeGen::endDocuments() {}
diff --git a/llvm/lib/Support/YAMLTraits.cpp b/llvm/lib/Support/YAMLTraits.cpp
index 035828b594e84..393b6ac0a2ee7 100644
--- a/llvm/lib/Support/YAMLTraits.cpp
+++ b/llvm/lib/Support/YAMLTraits.cpp
@@ -74,6 +74,8 @@ Input::~Input() = default;
std::error_code Input::error() { return EC; }
+IOKind Input::getKind() const { return IOKind::Inputting; }
+
bool Input::outputting() const {
return false;
}
@@ -485,6 +487,8 @@ Output::Output(raw_ostream &yout, void *context, int WrapColumn)
Output::~Output() = default;
+IOKind Output::getKind() const { return IOKind::Outputting; }
+
bool Output::outputting() const {
return true;
}
diff --git a/llvm/unittests/ObjectYAML/CMakeLists.txt b/llvm/unittests/ObjectYAML/CMakeLists.txt
index 17772ce494710..64149c80e0b5a 100644
--- a/llvm/unittests/ObjectYAML/CMakeLists.txt
+++ b/llvm/unittests/ObjectYAML/CMakeLists.txt
@@ -9,6 +9,7 @@ add_llvm_unittest(ObjectYAMLTests
ELFYAMLTest.cpp
MinidumpYAMLTest.cpp
YAML2ObjTest.cpp
+ YAMLSchemeGen.cpp
YAMLTest.cpp
)
diff --git a/llvm/unittests/ObjectYAML/YAMLSchemeGen.cpp b/llvm/unittests/ObjectYAML/YAMLSchemeGen.cpp
new file mode 100644
index 0000000000000..1b92b59b9d9f0
--- /dev/null
+++ b/llvm/unittests/ObjectYAML/YAMLSchemeGen.cpp
@@ -0,0 +1,103 @@
+//===- YAMLSchemeGenTest.cpp - Tests for Genering YAML Scheme -------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Support/YAMLSchemeGen.h"
+#include "llvm/Support/YAMLTraits.h"
+#include <string>
+#include <vector>
+
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+enum class ColorTy {
+ White,
+ Black,
+ Blue,
+};
+
+struct Baby {
+ std::string Name;
+ ColorTy Color;
+};
+
+LLVM_YAML_IS_SEQUENCE_VECTOR(Baby)
+
+struct Animal {
+ std::string Name;
+ std::optional<int> Age;
+ std::vector<Baby> Babies;
+};
+
+LLVM_YAML_IS_SEQUENCE_VECTOR(Animal)
+
+namespace llvm {
+namespace yaml {
+
+template <> struct ScalarEnumerationTraits<ColorTy> {
+ static void enumeration(IO &io, ColorTy &value) {
+ io.enumCase(value, "white", ColorTy::White);
+ io.enumCase(value, "black", ColorTy::Black);
+ io.enumCase(value, "blue", ColorTy::Blue);
+ }
+};
+
+template <> struct MappingTraits<Baby> {
+ static void mapping(IO &io, Baby &info) {
+ io.mapRequired("name", info.Name);
+ io.mapRequired("color", info.Color);
+ }
+};
+
+template <> struct MappingTraits<Animal> {
+ static void mapping(IO &io, Animal &info) {
+ io.mapRequired("name", info.Name);
+ io.mapOptional("age", info.Age);
+ io.mapOptional("babies", info.Babies);
+ }
+};
+
+} // namespace yaml
+} // namespace llvm
+
+TEST(ObjectYAMLSchemeGen, SimpleScheme) {
+ std::string String;
+ raw_string_ostream OS(String);
+ std::vector<Animal> Animals;
+ yaml::SchemeGen Gen(OS);
+ Gen << Animals;
+ StringRef YAMLScheme = R"(---
+type: array
+items:
+ - type: object
+ required: name
+ properties:
+ name:
+ type: string
+ age:
+ type: string
+ babies:
+ type: array
+ items:
+ - type: object
+ required:
+ - name
+ - color
+ properties:
+ name:
+ type: string
+ color:
+ type: string
+ enum:
+ - white
+ - black
+ - blue
+...
+)";
+ EXPECT_EQ(String.c_str(), YAMLScheme.str());
+}
diff --git a/llvm/utils/gn/secondary/llvm/lib/Support/BUILD.gn b/llvm/utils/gn/secondary/llvm/lib/Support/BUILD.gn
index fe7ff6ef68f99..3abc8e2055e39 100644
--- a/llvm/utils/gn/secondary/llvm/lib/Support/BUILD.gn
+++ b/llvm/utils/gn/secondary/llvm/lib/Support/BUILD.gn
@@ -166,6 +166,7 @@ static_library("Support") {
"WithColor.cpp",
"YAMLParser.cpp",
"YAMLTraits.cpp",
+ "YAMLSchemeGen.cpp",
"Z3Solver.cpp",
"circular_raw_ostream.cpp",
"raw_os_ostream.cpp",
More information about the llvm-commits
mailing list