1 //===- lib/Support/YAMLTraits.cpp -----------------------------------------===//
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/Errc.h"
11 #include "llvm/ADT/Twine.h"
12 #include "llvm/Support/Casting.h"
13 #include "llvm/Support/ErrorHandling.h"
14 #include "llvm/Support/Format.h"
15 #include "llvm/Support/YAMLParser.h"
16 #include "llvm/Support/YAMLTraits.h"
17 #include "llvm/Support/raw_ostream.h"
23 //===----------------------------------------------------------------------===//
25 //===----------------------------------------------------------------------===//
27 IO::IO(void *Context) : Ctxt(Context) {
33 void *IO::getContext() {
37 void IO::setContext(void *Context) {
41 //===----------------------------------------------------------------------===//
43 //===----------------------------------------------------------------------===//
45 Input::Input(StringRef InputContent,
47 SourceMgr::DiagHandlerTy DiagHandler,
48 void *DiagHandlerCtxt)
50 Strm(new Stream(InputContent, SrcMgr)),
51 CurrentNode(nullptr) {
53 SrcMgr.setDiagHandler(DiagHandler, DiagHandlerCtxt);
54 DocIterator = Strm->begin();
60 std::error_code Input::error() { return EC; }
62 // Pin the vtables to this file.
63 void Input::HNode::anchor() {}
64 void Input::EmptyHNode::anchor() {}
65 void Input::ScalarHNode::anchor() {}
66 void Input::MapHNode::anchor() {}
67 void Input::SequenceHNode::anchor() {}
69 bool Input::outputting() {
73 bool Input::setCurrentDocument() {
74 if (DocIterator != Strm->end()) {
75 Node *N = DocIterator->getRoot();
77 assert(Strm->failed() && "Root is NULL iff parsing failed");
78 EC = make_error_code(errc::invalid_argument);
82 if (isa<NullNode>(N)) {
83 // Empty files are allowed and ignored
85 return setCurrentDocument();
87 TopNode = this->createHNodes(N);
88 CurrentNode = TopNode.get();
94 bool Input::nextDocument() {
95 return ++DocIterator != Strm->end();
98 bool Input::mapTag(StringRef Tag, bool Default) {
99 std::string foundTag = CurrentNode->_node->getVerbatimTag();
100 if (foundTag.empty()) {
101 // If no tag found and 'Tag' is the default, say it was found.
104 // Return true iff found tag matches supplied tag.
105 return Tag.equals(foundTag);
108 void Input::beginMapping() {
111 // CurrentNode can be null if the document is empty.
112 MapHNode *MN = dyn_cast_or_null<MapHNode>(CurrentNode);
114 MN->ValidKeys.clear();
118 bool Input::preflightKey(const char *Key, bool Required, bool, bool &UseDefault,
124 // CurrentNode is null for empty documents, which is an error in case required
125 // nodes are present.
128 EC = make_error_code(errc::invalid_argument);
132 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
134 setError(CurrentNode, "not a mapping");
137 MN->ValidKeys.push_back(Key);
138 HNode *Value = MN->Mapping[Key].get();
141 setError(CurrentNode, Twine("missing required key '") + Key + "'");
146 SaveInfo = CurrentNode;
151 void Input::postflightKey(void *saveInfo) {
152 CurrentNode = reinterpret_cast<HNode *>(saveInfo);
155 void Input::endMapping() {
158 // CurrentNode can be null if the document is empty.
159 MapHNode *MN = dyn_cast_or_null<MapHNode>(CurrentNode);
162 for (const auto &NN : MN->Mapping) {
163 if (!MN->isValidKey(NN.first())) {
164 setError(NN.second.get(), Twine("unknown key '") + NN.first() + "'");
170 unsigned Input::beginSequence() {
171 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
172 return SQ->Entries.size();
177 void Input::endSequence() {
180 bool Input::preflightElement(unsigned Index, void *&SaveInfo) {
183 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
184 SaveInfo = CurrentNode;
185 CurrentNode = SQ->Entries[Index].get();
191 void Input::postflightElement(void *SaveInfo) {
192 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
195 unsigned Input::beginFlowSequence() {
196 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
197 return SQ->Entries.size();
202 bool Input::preflightFlowElement(unsigned index, void *&SaveInfo) {
205 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
206 SaveInfo = CurrentNode;
207 CurrentNode = SQ->Entries[index].get();
213 void Input::postflightFlowElement(void *SaveInfo) {
214 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
217 void Input::endFlowSequence() {
220 void Input::beginEnumScalar() {
221 ScalarMatchFound = false;
224 bool Input::matchEnumScalar(const char *Str, bool) {
225 if (ScalarMatchFound)
227 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
228 if (SN->value().equals(Str)) {
229 ScalarMatchFound = true;
236 bool Input::matchEnumFallback() {
237 if (ScalarMatchFound)
239 ScalarMatchFound = true;
243 void Input::endEnumScalar() {
244 if (!ScalarMatchFound) {
245 setError(CurrentNode, "unknown enumerated scalar");
249 bool Input::beginBitSetScalar(bool &DoClear) {
250 BitValuesUsed.clear();
251 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
252 BitValuesUsed.insert(BitValuesUsed.begin(), SQ->Entries.size(), false);
254 setError(CurrentNode, "expected sequence of bit values");
260 bool Input::bitSetMatch(const char *Str, bool) {
263 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
265 for (auto &N : SQ->Entries) {
266 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(N.get())) {
267 if (SN->value().equals(Str)) {
268 BitValuesUsed[Index] = true;
272 setError(CurrentNode, "unexpected scalar in sequence of bit values");
277 setError(CurrentNode, "expected sequence of bit values");
282 void Input::endBitSetScalar() {
285 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
286 assert(BitValuesUsed.size() == SQ->Entries.size());
287 for (unsigned i = 0; i < SQ->Entries.size(); ++i) {
288 if (!BitValuesUsed[i]) {
289 setError(SQ->Entries[i].get(), "unknown bit value");
296 void Input::scalarString(StringRef &S, bool) {
297 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
300 setError(CurrentNode, "unexpected scalar");
304 void Input::setError(HNode *hnode, const Twine &message) {
305 assert(hnode && "HNode must not be NULL");
306 this->setError(hnode->_node, message);
309 void Input::setError(Node *node, const Twine &message) {
310 Strm->printError(node, message);
311 EC = make_error_code(errc::invalid_argument);
314 std::unique_ptr<Input::HNode> Input::createHNodes(Node *N) {
315 SmallString<128> StringStorage;
316 if (ScalarNode *SN = dyn_cast<ScalarNode>(N)) {
317 StringRef KeyStr = SN->getValue(StringStorage);
318 if (!StringStorage.empty()) {
319 // Copy string to permanent storage
320 unsigned Len = StringStorage.size();
321 char *Buf = StringAllocator.Allocate<char>(Len);
322 memcpy(Buf, &StringStorage[0], Len);
323 KeyStr = StringRef(Buf, Len);
325 return llvm::make_unique<ScalarHNode>(N, KeyStr);
326 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
327 auto SQHNode = llvm::make_unique<SequenceHNode>(N);
328 for (Node &SN : *SQ) {
329 auto Entry = this->createHNodes(&SN);
332 SQHNode->Entries.push_back(std::move(Entry));
334 return std::move(SQHNode);
335 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
336 auto mapHNode = llvm::make_unique<MapHNode>(N);
337 for (KeyValueNode &KVN : *Map) {
338 Node *KeyNode = KVN.getKey();
339 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(KeyNode);
341 setError(KeyNode, "Map key must be a scalar");
344 StringStorage.clear();
345 StringRef KeyStr = KeyScalar->getValue(StringStorage);
346 if (!StringStorage.empty()) {
347 // Copy string to permanent storage
348 unsigned Len = StringStorage.size();
349 char *Buf = StringAllocator.Allocate<char>(Len);
350 memcpy(Buf, &StringStorage[0], Len);
351 KeyStr = StringRef(Buf, Len);
353 auto ValueHNode = this->createHNodes(KVN.getValue());
356 mapHNode->Mapping[KeyStr] = std::move(ValueHNode);
358 return std::move(mapHNode);
359 } else if (isa<NullNode>(N)) {
360 return llvm::make_unique<EmptyHNode>(N);
362 setError(N, "unknown node kind");
367 bool Input::MapHNode::isValidKey(StringRef Key) {
368 for (const char *K : ValidKeys) {
375 void Input::setError(const Twine &Message) {
376 this->setError(CurrentNode, Message);
379 bool Input::canElideEmptySequence() {
383 //===----------------------------------------------------------------------===//
385 //===----------------------------------------------------------------------===//
387 Output::Output(raw_ostream &yout, void *context)
391 ColumnAtFlowStart(0),
392 NeedBitValueComma(false),
393 NeedFlowSequenceComma(false),
394 EnumerationMatchFound(false),
395 NeedsNewLine(false) {
401 bool Output::outputting() {
405 void Output::beginMapping() {
406 StateStack.push_back(inMapFirstKey);
410 bool Output::mapTag(StringRef Tag, bool Use) {
418 void Output::endMapping() {
419 StateStack.pop_back();
422 bool Output::preflightKey(const char *Key, bool Required, bool SameAsDefault,
423 bool &UseDefault, void *&) {
425 if (Required || !SameAsDefault) {
426 this->newLineCheck();
427 this->paddedKey(Key);
433 void Output::postflightKey(void *) {
434 if (StateStack.back() == inMapFirstKey) {
435 StateStack.pop_back();
436 StateStack.push_back(inMapOtherKey);
440 void Output::beginDocuments() {
441 this->outputUpToEndOfLine("---");
444 bool Output::preflightDocument(unsigned index) {
446 this->outputUpToEndOfLine("\n---");
450 void Output::postflightDocument() {
453 void Output::endDocuments() {
457 unsigned Output::beginSequence() {
458 StateStack.push_back(inSeq);
463 void Output::endSequence() {
464 StateStack.pop_back();
467 bool Output::preflightElement(unsigned, void *&) {
471 void Output::postflightElement(void *) {
474 unsigned Output::beginFlowSequence() {
475 StateStack.push_back(inFlowSeq);
476 this->newLineCheck();
477 ColumnAtFlowStart = Column;
479 NeedFlowSequenceComma = false;
483 void Output::endFlowSequence() {
484 StateStack.pop_back();
485 this->outputUpToEndOfLine(" ]");
488 bool Output::preflightFlowElement(unsigned, void *&) {
489 if (NeedFlowSequenceComma)
493 for (int i = 0; i < ColumnAtFlowStart; ++i)
495 Column = ColumnAtFlowStart;
501 void Output::postflightFlowElement(void *) {
502 NeedFlowSequenceComma = true;
505 void Output::beginEnumScalar() {
506 EnumerationMatchFound = false;
509 bool Output::matchEnumScalar(const char *Str, bool Match) {
510 if (Match && !EnumerationMatchFound) {
511 this->newLineCheck();
512 this->outputUpToEndOfLine(Str);
513 EnumerationMatchFound = true;
518 bool Output::matchEnumFallback() {
519 if (EnumerationMatchFound)
521 EnumerationMatchFound = true;
525 void Output::endEnumScalar() {
526 if (!EnumerationMatchFound)
527 llvm_unreachable("bad runtime enum value");
530 bool Output::beginBitSetScalar(bool &DoClear) {
531 this->newLineCheck();
533 NeedBitValueComma = false;
538 bool Output::bitSetMatch(const char *Str, bool Matches) {
540 if (NeedBitValueComma)
543 NeedBitValueComma = true;
548 void Output::endBitSetScalar() {
549 this->outputUpToEndOfLine(" ]");
552 void Output::scalarString(StringRef &S, bool MustQuote) {
553 this->newLineCheck();
555 // Print '' for the empty string because leaving the field empty is not
557 this->outputUpToEndOfLine("''");
561 // Only quote if we must.
562 this->outputUpToEndOfLine(S);
567 unsigned End = S.size();
568 output("'"); // Starting single quote.
569 const char *Base = S.data();
571 // Escape a single quote by doubling it.
573 output(StringRef(&Base[i], j - i + 1));
579 output(StringRef(&Base[i], j - i));
580 this->outputUpToEndOfLine("'"); // Ending single quote.
583 void Output::setError(const Twine &message) {
586 bool Output::canElideEmptySequence() {
587 // Normally, with an optional key/value where the value is an empty sequence,
588 // the whole key/value can be not written. But, that produces wrong yaml
589 // if the key/value is the only thing in the map and the map is used in
590 // a sequence. This detects if the this sequence is the first key/value
591 // in map that itself is embedded in a sequnce.
592 if (StateStack.size() < 2)
594 if (StateStack.back() != inMapFirstKey)
596 return (StateStack[StateStack.size()-2] != inSeq);
599 void Output::output(StringRef s) {
604 void Output::outputUpToEndOfLine(StringRef s) {
606 if (StateStack.empty() || StateStack.back() != inFlowSeq)
610 void Output::outputNewLine() {
615 // if seq at top, indent as if map, then add "- "
616 // if seq in middle, use "- " if firstKey, else use " "
619 void Output::newLineCheck() {
622 NeedsNewLine = false;
624 this->outputNewLine();
626 assert(StateStack.size() > 0);
627 unsigned Indent = StateStack.size() - 1;
628 bool OutputDash = false;
630 if (StateStack.back() == inSeq) {
632 } else if ((StateStack.size() > 1) && (StateStack.back() == inMapFirstKey) &&
633 (StateStack[StateStack.size() - 2] == inSeq)) {
638 for (unsigned i = 0; i < Indent; ++i) {
647 void Output::paddedKey(StringRef key) {
650 const char *spaces = " ";
651 if (key.size() < strlen(spaces))
652 output(&spaces[key.size()]);
657 //===----------------------------------------------------------------------===//
658 // traits for built-in types
659 //===----------------------------------------------------------------------===//
661 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
662 Out << (Val ? "true" : "false");
665 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
666 if (Scalar.equals("true")) {
669 } else if (Scalar.equals("false")) {
673 return "invalid boolean";
676 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
681 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
687 void ScalarTraits<std::string>::output(const std::string &Val, void *,
692 StringRef ScalarTraits<std::string>::input(StringRef Scalar, void *,
698 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
700 // use temp uin32_t because ostream thinks uint8_t is a character
705 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
706 unsigned long long n;
707 if (getAsUnsignedInteger(Scalar, 0, n))
708 return "invalid number";
710 return "out of range number";
715 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
720 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
722 unsigned long long n;
723 if (getAsUnsignedInteger(Scalar, 0, n))
724 return "invalid number";
726 return "out of range number";
731 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
736 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
738 unsigned long long n;
739 if (getAsUnsignedInteger(Scalar, 0, n))
740 return "invalid number";
741 if (n > 0xFFFFFFFFUL)
742 return "out of range number";
747 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
752 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
754 unsigned long long N;
755 if (getAsUnsignedInteger(Scalar, 0, N))
756 return "invalid number";
761 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
762 // use temp in32_t because ostream thinks int8_t is a character
767 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
769 if (getAsSignedInteger(Scalar, 0, N))
770 return "invalid number";
771 if ((N > 127) || (N < -128))
772 return "out of range number";
777 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
782 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
784 if (getAsSignedInteger(Scalar, 0, N))
785 return "invalid number";
786 if ((N > INT16_MAX) || (N < INT16_MIN))
787 return "out of range number";
792 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
797 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
799 if (getAsSignedInteger(Scalar, 0, N))
800 return "invalid number";
801 if ((N > INT32_MAX) || (N < INT32_MIN))
802 return "out of range number";
807 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
812 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
814 if (getAsSignedInteger(Scalar, 0, N))
815 return "invalid number";
820 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
821 Out << format("%g", Val);
824 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
825 SmallString<32> buff(Scalar.begin(), Scalar.end());
827 Val = strtod(buff.c_str(), &end);
829 return "invalid floating point number";
833 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
834 Out << format("%g", Val);
837 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
838 SmallString<32> buff(Scalar.begin(), Scalar.end());
840 Val = strtod(buff.c_str(), &end);
842 return "invalid floating point number";
846 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
848 Out << format("0x%02X", Num);
851 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
852 unsigned long long n;
853 if (getAsUnsignedInteger(Scalar, 0, n))
854 return "invalid hex8 number";
856 return "out of range hex8 number";
861 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
863 Out << format("0x%04X", Num);
866 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
867 unsigned long long n;
868 if (getAsUnsignedInteger(Scalar, 0, n))
869 return "invalid hex16 number";
871 return "out of range hex16 number";
876 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
878 Out << format("0x%08X", Num);
881 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
882 unsigned long long n;
883 if (getAsUnsignedInteger(Scalar, 0, n))
884 return "invalid hex32 number";
885 if (n > 0xFFFFFFFFUL)
886 return "out of range hex32 number";
891 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
893 Out << format("0x%016llX", Num);
896 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
897 unsigned long long Num;
898 if (getAsUnsignedInteger(Scalar, 0, Num))
899 return "invalid hex64 number";