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/YAMLTraits.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/raw_ostream.h"
21 using std::error_code;
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 error_code Input::error() {
64 // Pin the vtables to this file.
65 void Input::HNode::anchor() {}
66 void Input::EmptyHNode::anchor() {}
67 void Input::ScalarHNode::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 = std::make_error_code(std::errc::invalid_argument);
82 if (isa<NullNode>(N)) {
83 // Empty files are allowed and ignored
85 return setCurrentDocument();
87 TopNode.reset(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 = std::make_error_code(std::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];
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, 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];
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];
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 void Input::endEnumScalar() {
237 if (!ScalarMatchFound) {
238 setError(CurrentNode, "unknown enumerated scalar");
242 bool Input::beginBitSetScalar(bool &DoClear) {
243 BitValuesUsed.clear();
244 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
245 BitValuesUsed.insert(BitValuesUsed.begin(), SQ->Entries.size(), false);
247 setError(CurrentNode, "expected sequence of bit values");
253 bool Input::bitSetMatch(const char *Str, bool) {
256 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
258 for (HNode *N : SQ->Entries) {
259 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(N)) {
260 if (SN->value().equals(Str)) {
261 BitValuesUsed[Index] = true;
265 setError(CurrentNode, "unexpected scalar in sequence of bit values");
270 setError(CurrentNode, "expected sequence of bit values");
275 void Input::endBitSetScalar() {
278 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
279 assert(BitValuesUsed.size() == SQ->Entries.size());
280 for (unsigned i = 0; i < SQ->Entries.size(); ++i) {
281 if (!BitValuesUsed[i]) {
282 setError(SQ->Entries[i], "unknown bit value");
289 void Input::scalarString(StringRef &S, bool) {
290 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
293 setError(CurrentNode, "unexpected scalar");
297 void Input::setError(HNode *hnode, const Twine &message) {
298 assert(hnode && "HNode must not be NULL");
299 this->setError(hnode->_node, message);
302 void Input::setError(Node *node, const Twine &message) {
303 Strm->printError(node, message);
304 EC = std::make_error_code(std::errc::invalid_argument);
307 Input::HNode *Input::createHNodes(Node *N) {
308 SmallString<128> StringStorage;
309 if (ScalarNode *SN = dyn_cast<ScalarNode>(N)) {
310 StringRef KeyStr = SN->getValue(StringStorage);
311 if (!StringStorage.empty()) {
312 // Copy string to permanent storage
313 unsigned Len = StringStorage.size();
314 char *Buf = StringAllocator.Allocate<char>(Len);
315 memcpy(Buf, &StringStorage[0], Len);
316 KeyStr = StringRef(Buf, Len);
318 return new ScalarHNode(N, KeyStr);
319 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
320 SequenceHNode *SQHNode = new SequenceHNode(N);
321 for (Node &SN : *SQ) {
322 HNode *Entry = this->createHNodes(&SN);
325 SQHNode->Entries.push_back(Entry);
328 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
329 MapHNode *mapHNode = new MapHNode(N);
330 for (KeyValueNode &KVN : *Map) {
331 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(KVN.getKey());
332 StringStorage.clear();
333 StringRef KeyStr = KeyScalar->getValue(StringStorage);
334 if (!StringStorage.empty()) {
335 // Copy string to permanent storage
336 unsigned Len = StringStorage.size();
337 char *Buf = StringAllocator.Allocate<char>(Len);
338 memcpy(Buf, &StringStorage[0], Len);
339 KeyStr = StringRef(Buf, Len);
341 HNode *ValueHNode = this->createHNodes(KVN.getValue());
344 mapHNode->Mapping[KeyStr] = ValueHNode;
347 } else if (isa<NullNode>(N)) {
348 return new EmptyHNode(N);
350 setError(N, "unknown node kind");
355 bool Input::MapHNode::isValidKey(StringRef Key) {
356 for (const char *K : ValidKeys) {
363 void Input::setError(const Twine &Message) {
364 this->setError(CurrentNode, Message);
367 bool Input::canElideEmptySequence() {
371 Input::MapHNode::~MapHNode() {
372 for (auto &N : Mapping)
376 Input::SequenceHNode::~SequenceHNode() {
377 for (HNode *N : Entries)
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 void Output::endEnumScalar() {
519 if (!EnumerationMatchFound)
520 llvm_unreachable("bad runtime enum value");
523 bool Output::beginBitSetScalar(bool &DoClear) {
524 this->newLineCheck();
526 NeedBitValueComma = false;
531 bool Output::bitSetMatch(const char *Str, bool Matches) {
533 if (NeedBitValueComma)
536 NeedBitValueComma = true;
541 void Output::endBitSetScalar() {
542 this->outputUpToEndOfLine(" ]");
545 void Output::scalarString(StringRef &S, bool MustQuote) {
546 this->newLineCheck();
548 // Print '' for the empty string because leaving the field empty is not
550 this->outputUpToEndOfLine("''");
554 // Only quote if we must.
555 this->outputUpToEndOfLine(S);
560 unsigned End = S.size();
561 output("'"); // Starting single quote.
562 const char *Base = S.data();
564 // Escape a single quote by doubling it.
566 output(StringRef(&Base[i], j - i + 1));
572 output(StringRef(&Base[i], j - i));
573 this->outputUpToEndOfLine("'"); // Ending single quote.
576 void Output::setError(const Twine &message) {
579 bool Output::canElideEmptySequence() {
580 // Normally, with an optional key/value where the value is an empty sequence,
581 // the whole key/value can be not written. But, that produces wrong yaml
582 // if the key/value is the only thing in the map and the map is used in
583 // a sequence. This detects if the this sequence is the first key/value
584 // in map that itself is embedded in a sequnce.
585 if (StateStack.size() < 2)
587 if (StateStack.back() != inMapFirstKey)
589 return (StateStack[StateStack.size()-2] != inSeq);
592 void Output::output(StringRef s) {
597 void Output::outputUpToEndOfLine(StringRef s) {
599 if (StateStack.empty() || StateStack.back() != inFlowSeq)
603 void Output::outputNewLine() {
608 // if seq at top, indent as if map, then add "- "
609 // if seq in middle, use "- " if firstKey, else use " "
612 void Output::newLineCheck() {
615 NeedsNewLine = false;
617 this->outputNewLine();
619 assert(StateStack.size() > 0);
620 unsigned Indent = StateStack.size() - 1;
621 bool OutputDash = false;
623 if (StateStack.back() == inSeq) {
625 } else if ((StateStack.size() > 1) && (StateStack.back() == inMapFirstKey) &&
626 (StateStack[StateStack.size() - 2] == inSeq)) {
631 for (unsigned i = 0; i < Indent; ++i) {
640 void Output::paddedKey(StringRef key) {
643 const char *spaces = " ";
644 if (key.size() < strlen(spaces))
645 output(&spaces[key.size()]);
650 //===----------------------------------------------------------------------===//
651 // traits for built-in types
652 //===----------------------------------------------------------------------===//
654 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
655 Out << (Val ? "true" : "false");
658 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
659 if (Scalar.equals("true")) {
662 } else if (Scalar.equals("false")) {
666 return "invalid boolean";
669 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
674 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
680 void ScalarTraits<std::string>::output(const std::string &Val, void *,
685 StringRef ScalarTraits<std::string>::input(StringRef Scalar, void *,
691 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
693 // use temp uin32_t because ostream thinks uint8_t is a character
698 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
699 unsigned long long n;
700 if (getAsUnsignedInteger(Scalar, 0, n))
701 return "invalid number";
703 return "out of range number";
708 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
713 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
715 unsigned long long n;
716 if (getAsUnsignedInteger(Scalar, 0, n))
717 return "invalid number";
719 return "out of range number";
724 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
729 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
731 unsigned long long n;
732 if (getAsUnsignedInteger(Scalar, 0, n))
733 return "invalid number";
734 if (n > 0xFFFFFFFFUL)
735 return "out of range number";
740 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
745 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
747 unsigned long long N;
748 if (getAsUnsignedInteger(Scalar, 0, N))
749 return "invalid number";
754 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
755 // use temp in32_t because ostream thinks int8_t is a character
760 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
762 if (getAsSignedInteger(Scalar, 0, N))
763 return "invalid number";
764 if ((N > 127) || (N < -128))
765 return "out of range number";
770 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
775 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
777 if (getAsSignedInteger(Scalar, 0, N))
778 return "invalid number";
779 if ((N > INT16_MAX) || (N < INT16_MIN))
780 return "out of range number";
785 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
790 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
792 if (getAsSignedInteger(Scalar, 0, N))
793 return "invalid number";
794 if ((N > INT32_MAX) || (N < INT32_MIN))
795 return "out of range number";
800 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
805 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
807 if (getAsSignedInteger(Scalar, 0, N))
808 return "invalid number";
813 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
814 Out << format("%g", Val);
817 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
818 SmallString<32> buff(Scalar.begin(), Scalar.end());
820 Val = strtod(buff.c_str(), &end);
822 return "invalid floating point number";
826 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
827 Out << format("%g", Val);
830 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
831 SmallString<32> buff(Scalar.begin(), Scalar.end());
833 Val = strtod(buff.c_str(), &end);
835 return "invalid floating point number";
839 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
841 Out << format("0x%02X", Num);
844 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
845 unsigned long long n;
846 if (getAsUnsignedInteger(Scalar, 0, n))
847 return "invalid hex8 number";
849 return "out of range hex8 number";
854 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
856 Out << format("0x%04X", Num);
859 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
860 unsigned long long n;
861 if (getAsUnsignedInteger(Scalar, 0, n))
862 return "invalid hex16 number";
864 return "out of range hex16 number";
869 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
871 Out << format("0x%08X", Num);
874 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
875 unsigned long long n;
876 if (getAsUnsignedInteger(Scalar, 0, n))
877 return "invalid hex32 number";
878 if (n > 0xFFFFFFFFUL)
879 return "out of range hex32 number";
884 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
886 Out << format("0x%016llX", Num);
889 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
890 unsigned long long Num;
891 if (getAsUnsignedInteger(Scalar, 0, Num))
892 return "invalid hex64 number";