[llvm][Support] Add YAMLGenerateSchema for producing YAML Schemes from YAMLTraits #133284
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@llvm/pr-subscribers-llvm-support Author: None (tgs-sc) ChangesIntroduced 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. Patch is 34.07 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/133284.diff 8 Files Affected:
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...
[truncated]
|
4b9e8a8 to
2096a43
Compare
|
@jh7370, I apologize in advance, but I saw that you recently looked at a patch to add new functionality (new virtual error method) to this part of llvm for working with the yaml format. Could you please look at this patch, because it also adds some new functionality without breaking backward compatibility. |
Hi @tgs-sc, I've added this to my backlog. Please note it may take me a while to review - I've just come back from 2 weeks off work and have a lot to catch up on, plus some upcoming deadlines. |
2096a43 to
efe6840
Compare
|
Hi @jh7370! Sorry to bother you, but may be you are now less busier and can take a look at this patch? |
jh7370
reviewed
Apr 8, 2025
There was a problem hiding this comment.
The term you're looking for is "Schema" not "Scheme".
Realistically, this change appears to be adding too much in one go, so I'm not going to be able to meaningfully review it. Could it be broken up into smaller pieces?
I'm also likely to still be overwhelmed for the next month, with very limited review time during this time.
Have you solicited any feedback for who would want this functionality with an RFC on the LLVM Discourse or similar?
| enum class IOKind : uint8_t { | ||
| Outputting, | ||
| Inputting, | ||
| SchemeGenering, |
There was a problem hiding this comment.
Suggested change
| SchemeGenering, | |
| GeneratingSchema, |
| @@ -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)) { | |||
There was a problem hiding this comment.
Why does this and similar code need to change rather than continue to use outputting()?
There was a problem hiding this comment.
That is because generate schema should behave like Outputting in some cases and like Inputting in others. And in such a case I had to explicitly specify these places, implying that !IOKind::Inputting == (IOKind::Outputting || IOKind::GeneratingSchema). I also decided to leave virtual method outputting() not to break backward compatibility as it is potentially can be called in IO class.
efe6840 to
92222dc
Compare
|
Hi @jh7370!
I think that I can split this patch into 2 commits: added new Derived class GenerateSchema (as this is something monolite) and unit tests for it, but it seems to me that this way you can see better how you can use the new functionality.
Currently there is no such topic, but I can make it. |
|
Hi @jh7370! I have created a suggestion for adding this functionality https://discourse.llvm.org/t/rfc-support-yamlgenerateschema-for-producing-yaml-schemas/85806/2, but unfortunately no one has responded yet. Probably you know someone who has worked on this part of llvm and who can give some comments? |
I suspect your problem is that you've posted it in the wrong category. "Project Infrastructure" is for stuff that supports how the LLVM project works, like build bots, GitHub usage and so on. You probably want to post your RFC in the "LLVM Project" category, where it'll attract more attention. You should also look at the people who work in the areas that you envisage this functionality benefiting and try CC'ing them in the thread, as it is these people you should try to get interested in. |
You can test this locally with the following command:git-clang-format --diff HEAD~1 HEAD --extensions h,cpp -- llvm/include/llvm/Support/YAMLGenerateSchema.h llvm/lib/Support/YAMLGenerateSchema.cpp llvm/unittests/Support/YAMLGenerateSchemaTest.cpp llvm/include/llvm/Support/YAMLTraits.h llvm/lib/Support/YAMLTraits.cppView the diff from clang-format here.diff --git a/llvm/include/llvm/Support/YAMLTraits.h b/llvm/include/llvm/Support/YAMLTraits.h
index dbf13d402..029484705 100644
--- a/llvm/include/llvm/Support/YAMLTraits.h
+++ b/llvm/include/llvm/Support/YAMLTraits.h
@@ -1024,8 +1024,7 @@ std::enable_if_t<has_ScalarTraits<T>::value, void> yamlize(IO &io, T &Val, bool,
ScalarTraits<T>::output(Val, io.getContext(), Buffer);
StringRef Str = Buffer.str();
io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
- }
- else {
+ } else {
StringRef Str;
io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
StringRef Result = ScalarTraits<T>::input(Str, io.getContext(), Val);
@@ -1379,8 +1378,7 @@ struct MappingNormalization {
: io(i_o), BufPtr(nullptr), Result(Obj) {
if (io.getKind() == IOKind::Outputting) {
BufPtr = new (&Buffer) TNorm(io, Obj);
- }
- else {
+ } else {
BufPtr = new (&Buffer) TNorm(io);
}
}
@@ -1411,8 +1409,7 @@ struct MappingNormalizationHeap {
: io(i_o), Result(Obj) {
if (io.getKind() == IOKind::Outputting) {
BufPtr = new (&Buffer) TNorm(io, Obj);
- }
- else if (allocator) {
+ } else if (allocator) {
BufPtr = allocator->Allocate<TNorm>();
new (BufPtr) TNorm(io);
} else {
@@ -1423,8 +1420,7 @@ struct MappingNormalizationHeap {
~MappingNormalizationHeap() {
if (io.getKind() == IOKind::Outputting) {
BufPtr->~TNorm();
- }
- else {
+ } else {
Result = BufPtr->denormalize(io);
}
}
|
Introduced a way for generating schema 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.
92222dc to
4d11015
Compare
|
@jholewinski, @silvasean, I apologize for disturbing, but I have seen that you had already participated in reviewing this part of llvm. May be this patch will be interesting for you so take a look please! |
|
@hyp, sorry to bother you but maybe you can take a look at this patch? |
|
Hi @tgs-sc, as you wrote an RFC to accompany this PR, I think it's more important you seek some input on that RFC there rather than here on the PR. In particular, I'd reach out (on the RFC on Discord) to the maintainers and contributors to the tools this PR is aimed to help with, rather than the people who occasionally submit patches to areas of yaml2obj/ObjectYAML. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.