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"
22 //===----------------------------------------------------------------------===//
24 //===----------------------------------------------------------------------===//
26 IO::IO(void *Context) : Ctxt(Context) {
32 void *IO::getContext() {
36 void IO::setContext(void *Context) {
40 //===----------------------------------------------------------------------===//
42 //===----------------------------------------------------------------------===//
44 Input::Input(StringRef InputContent, void *Ctxt)
46 Strm(new Stream(InputContent, SrcMgr)),
48 DocIterator = Strm->begin();
54 error_code Input::error() {
58 void Input::setDiagHandler(SourceMgr::DiagHandlerTy Handler, void *Ctxt) {
59 SrcMgr.setDiagHandler(Handler, Ctxt);
62 bool Input::outputting() {
66 bool Input::setCurrentDocument() {
67 if (DocIterator != Strm->end()) {
68 Node *N = DocIterator->getRoot();
69 if (isa<NullNode>(N)) {
70 // Empty files are allowed and ignored
72 return setCurrentDocument();
74 TopNode.reset(this->createHNodes(N));
75 CurrentNode = TopNode.get();
81 void Input::nextDocument() {
85 bool Input::mapTag(StringRef Tag, bool Default) {
86 StringRef foundTag = CurrentNode->_node->getVerbatimTag();
87 if (foundTag.empty()) {
88 // If no tag found and 'Tag' is the default, say it was found.
91 // Return true iff found tag matches supplied tag.
92 return Tag.equals(foundTag);
95 void Input::beginMapping() {
98 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
100 MN->ValidKeys.clear();
104 bool Input::preflightKey(const char *Key, bool Required, bool, bool &UseDefault,
109 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
111 setError(CurrentNode, "not a mapping");
114 MN->ValidKeys.push_back(Key);
115 HNode *Value = MN->Mapping[Key];
118 setError(CurrentNode, Twine("missing required key '") + Key + "'");
123 SaveInfo = CurrentNode;
128 void Input::postflightKey(void *saveInfo) {
129 CurrentNode = reinterpret_cast<HNode *>(saveInfo);
132 void Input::endMapping() {
135 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
138 for (MapHNode::NameToNode::iterator i = MN->Mapping.begin(),
139 End = MN->Mapping.end(); i != End; ++i) {
140 if (!MN->isValidKey(i->first())) {
141 setError(i->second, Twine("unknown key '") + i->first() + "'");
147 unsigned Input::beginSequence() {
148 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
149 return SQ->Entries.size();
154 void Input::endSequence() {
157 bool Input::preflightElement(unsigned Index, void *&SaveInfo) {
160 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
161 SaveInfo = CurrentNode;
162 CurrentNode = SQ->Entries[Index];
168 void Input::postflightElement(void *SaveInfo) {
169 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
172 unsigned Input::beginFlowSequence() {
173 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
174 return SQ->Entries.size();
179 bool Input::preflightFlowElement(unsigned index, void *&SaveInfo) {
182 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
183 SaveInfo = CurrentNode;
184 CurrentNode = SQ->Entries[index];
190 void Input::postflightFlowElement(void *SaveInfo) {
191 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
194 void Input::endFlowSequence() {
197 void Input::beginEnumScalar() {
198 ScalarMatchFound = false;
201 bool Input::matchEnumScalar(const char *Str, bool) {
202 if (ScalarMatchFound)
204 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
205 if (SN->value().equals(Str)) {
206 ScalarMatchFound = true;
213 void Input::endEnumScalar() {
214 if (!ScalarMatchFound) {
215 setError(CurrentNode, "unknown enumerated scalar");
219 bool Input::beginBitSetScalar(bool &DoClear) {
220 BitValuesUsed.clear();
221 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
222 BitValuesUsed.insert(BitValuesUsed.begin(), SQ->Entries.size(), false);
224 setError(CurrentNode, "expected sequence of bit values");
230 bool Input::bitSetMatch(const char *Str, bool) {
233 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
235 for (std::vector<HNode *>::iterator i = SQ->Entries.begin(),
236 End = SQ->Entries.end(); i != End; ++i) {
237 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(*i)) {
238 if (SN->value().equals(Str)) {
239 BitValuesUsed[Index] = true;
243 setError(CurrentNode, "unexpected scalar in sequence of bit values");
248 setError(CurrentNode, "expected sequence of bit values");
253 void Input::endBitSetScalar() {
256 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
257 assert(BitValuesUsed.size() == SQ->Entries.size());
258 for (unsigned i = 0; i < SQ->Entries.size(); ++i) {
259 if (!BitValuesUsed[i]) {
260 setError(SQ->Entries[i], "unknown bit value");
267 void Input::scalarString(StringRef &S) {
268 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
271 setError(CurrentNode, "unexpected scalar");
275 void Input::setError(HNode *hnode, const Twine &message) {
276 this->setError(hnode->_node, message);
279 void Input::setError(Node *node, const Twine &message) {
280 Strm->printError(node, message);
281 EC = make_error_code(errc::invalid_argument);
284 Input::HNode *Input::createHNodes(Node *N) {
285 SmallString<128> StringStorage;
286 if (ScalarNode *SN = dyn_cast<ScalarNode>(N)) {
287 StringRef KeyStr = SN->getValue(StringStorage);
288 if (!StringStorage.empty()) {
289 // Copy string to permanent storage
290 unsigned Len = StringStorage.size();
291 char *Buf = StringAllocator.Allocate<char>(Len);
292 memcpy(Buf, &StringStorage[0], Len);
293 KeyStr = StringRef(Buf, Len);
295 return new ScalarHNode(N, KeyStr);
296 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
297 SequenceHNode *SQHNode = new SequenceHNode(N);
298 for (SequenceNode::iterator i = SQ->begin(), End = SQ->end(); i != End;
300 HNode *Entry = this->createHNodes(i);
303 SQHNode->Entries.push_back(Entry);
306 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
307 MapHNode *mapHNode = new MapHNode(N);
308 for (MappingNode::iterator i = Map->begin(), End = Map->end(); i != End;
310 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(i->getKey());
311 StringStorage.clear();
312 StringRef KeyStr = KeyScalar->getValue(StringStorage);
313 if (!StringStorage.empty()) {
314 // Copy string to permanent storage
315 unsigned Len = StringStorage.size();
316 char *Buf = StringAllocator.Allocate<char>(Len);
317 memcpy(Buf, &StringStorage[0], Len);
318 KeyStr = StringRef(Buf, Len);
320 HNode *ValueHNode = this->createHNodes(i->getValue());
323 mapHNode->Mapping[KeyStr] = ValueHNode;
326 } else if (isa<NullNode>(N)) {
327 return new EmptyHNode(N);
329 setError(N, "unknown node kind");
334 bool Input::MapHNode::isValidKey(StringRef Key) {
335 for (SmallVectorImpl<const char *>::iterator i = ValidKeys.begin(),
336 End = ValidKeys.end(); i != End; ++i) {
343 void Input::setError(const Twine &Message) {
344 this->setError(CurrentNode, Message);
347 bool Input::canElideEmptySequence() {
351 Input::MapHNode::~MapHNode() {
352 for (MapHNode::NameToNode::iterator i = Mapping.begin(), End = Mapping.end();
358 Input::SequenceHNode::~SequenceHNode() {
359 for (std::vector<HNode*>::iterator i = Entries.begin(), End = Entries.end();
367 //===----------------------------------------------------------------------===//
369 //===----------------------------------------------------------------------===//
371 Output::Output(raw_ostream &yout, void *context)
375 ColumnAtFlowStart(0),
376 NeedBitValueComma(false),
377 NeedFlowSequenceComma(false),
378 EnumerationMatchFound(false),
379 NeedsNewLine(false) {
385 bool Output::outputting() {
389 void Output::beginMapping() {
390 StateStack.push_back(inMapFirstKey);
394 bool Output::mapTag(StringRef Tag, bool Use) {
402 void Output::endMapping() {
403 StateStack.pop_back();
406 bool Output::preflightKey(const char *Key, bool Required, bool SameAsDefault,
407 bool &UseDefault, void *&) {
409 if (Required || !SameAsDefault) {
410 this->newLineCheck();
411 this->paddedKey(Key);
417 void Output::postflightKey(void *) {
418 if (StateStack.back() == inMapFirstKey) {
419 StateStack.pop_back();
420 StateStack.push_back(inMapOtherKey);
424 void Output::beginDocuments() {
425 this->outputUpToEndOfLine("---");
428 bool Output::preflightDocument(unsigned index) {
430 this->outputUpToEndOfLine("\n---");
434 void Output::postflightDocument() {
437 void Output::endDocuments() {
441 unsigned Output::beginSequence() {
442 StateStack.push_back(inSeq);
447 void Output::endSequence() {
448 StateStack.pop_back();
451 bool Output::preflightElement(unsigned, void *&) {
455 void Output::postflightElement(void *) {
458 unsigned Output::beginFlowSequence() {
459 StateStack.push_back(inFlowSeq);
460 this->newLineCheck();
461 ColumnAtFlowStart = Column;
463 NeedFlowSequenceComma = false;
467 void Output::endFlowSequence() {
468 StateStack.pop_back();
469 this->outputUpToEndOfLine(" ]");
472 bool Output::preflightFlowElement(unsigned, void *&) {
473 if (NeedFlowSequenceComma)
477 for (int i = 0; i < ColumnAtFlowStart; ++i)
479 Column = ColumnAtFlowStart;
485 void Output::postflightFlowElement(void *) {
486 NeedFlowSequenceComma = true;
489 void Output::beginEnumScalar() {
490 EnumerationMatchFound = false;
493 bool Output::matchEnumScalar(const char *Str, bool Match) {
494 if (Match && !EnumerationMatchFound) {
495 this->newLineCheck();
496 this->outputUpToEndOfLine(Str);
497 EnumerationMatchFound = true;
502 void Output::endEnumScalar() {
503 if (!EnumerationMatchFound)
504 llvm_unreachable("bad runtime enum value");
507 bool Output::beginBitSetScalar(bool &DoClear) {
508 this->newLineCheck();
510 NeedBitValueComma = false;
515 bool Output::bitSetMatch(const char *Str, bool Matches) {
517 if (NeedBitValueComma)
520 NeedBitValueComma = true;
525 void Output::endBitSetScalar() {
526 this->outputUpToEndOfLine(" ]");
529 void Output::scalarString(StringRef &S) {
530 const char ScalarSafeChars[] = "abcdefghijklmnopqrstuvwxyz"
531 "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-/^., \t";
533 this->newLineCheck();
535 // Print '' for the empty string because leaving the field empty is not
537 this->outputUpToEndOfLine("''");
540 if (S.find_first_not_of(ScalarSafeChars) == StringRef::npos &&
541 !isspace(S.front()) && !isspace(S.back())) {
542 // If the string consists only of safe characters, print it out without
544 this->outputUpToEndOfLine(S);
549 unsigned End = S.size();
550 output("'"); // Starting single quote.
551 const char *Base = S.data();
553 // Escape a single quote by doubling it.
555 output(StringRef(&Base[i], j - i + 1));
561 output(StringRef(&Base[i], j - i));
562 this->outputUpToEndOfLine("'"); // Ending single quote.
565 void Output::setError(const Twine &message) {
568 bool Output::canElideEmptySequence() {
569 // Normally, with an optional key/value where the value is an empty sequence,
570 // the whole key/value can be not written. But, that produces wrong yaml
571 // if the key/value is the only thing in the map and the map is used in
572 // a sequence. This detects if the this sequence is the first key/value
573 // in map that itself is embedded in a sequnce.
574 if (StateStack.size() < 2)
576 if (StateStack.back() != inMapFirstKey)
578 return (StateStack[StateStack.size()-2] != inSeq);
581 void Output::output(StringRef s) {
586 void Output::outputUpToEndOfLine(StringRef s) {
588 if (StateStack.empty() || StateStack.back() != inFlowSeq)
592 void Output::outputNewLine() {
597 // if seq at top, indent as if map, then add "- "
598 // if seq in middle, use "- " if firstKey, else use " "
601 void Output::newLineCheck() {
604 NeedsNewLine = false;
606 this->outputNewLine();
608 assert(StateStack.size() > 0);
609 unsigned Indent = StateStack.size() - 1;
610 bool OutputDash = false;
612 if (StateStack.back() == inSeq) {
614 } else if ((StateStack.size() > 1) && (StateStack.back() == inMapFirstKey) &&
615 (StateStack[StateStack.size() - 2] == inSeq)) {
620 for (unsigned i = 0; i < Indent; ++i) {
629 void Output::paddedKey(StringRef key) {
632 const char *spaces = " ";
633 if (key.size() < strlen(spaces))
634 output(&spaces[key.size()]);
639 //===----------------------------------------------------------------------===//
640 // traits for built-in types
641 //===----------------------------------------------------------------------===//
643 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
644 Out << (Val ? "true" : "false");
647 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
648 if (Scalar.equals("true")) {
651 } else if (Scalar.equals("false")) {
655 return "invalid boolean";
658 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
663 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
669 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
671 // use temp uin32_t because ostream thinks uint8_t is a character
676 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
677 unsigned long long n;
678 if (getAsUnsignedInteger(Scalar, 0, n))
679 return "invalid number";
681 return "out of range number";
686 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
691 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
693 unsigned long long n;
694 if (getAsUnsignedInteger(Scalar, 0, n))
695 return "invalid number";
697 return "out of range number";
702 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
707 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
709 unsigned long long n;
710 if (getAsUnsignedInteger(Scalar, 0, n))
711 return "invalid number";
712 if (n > 0xFFFFFFFFUL)
713 return "out of range number";
718 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
723 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
725 unsigned long long N;
726 if (getAsUnsignedInteger(Scalar, 0, N))
727 return "invalid number";
732 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
733 // use temp in32_t because ostream thinks int8_t is a character
738 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
740 if (getAsSignedInteger(Scalar, 0, N))
741 return "invalid number";
742 if ((N > 127) || (N < -128))
743 return "out of range number";
748 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
753 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
755 if (getAsSignedInteger(Scalar, 0, N))
756 return "invalid number";
757 if ((N > INT16_MAX) || (N < INT16_MIN))
758 return "out of range number";
763 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
768 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
770 if (getAsSignedInteger(Scalar, 0, N))
771 return "invalid number";
772 if ((N > INT32_MAX) || (N < INT32_MIN))
773 return "out of range number";
778 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
783 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
785 if (getAsSignedInteger(Scalar, 0, N))
786 return "invalid number";
791 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
792 Out << format("%g", Val);
795 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
796 SmallString<32> buff(Scalar.begin(), Scalar.end());
798 Val = strtod(buff.c_str(), &end);
800 return "invalid floating point number";
804 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
805 Out << format("%g", Val);
808 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
809 SmallString<32> buff(Scalar.begin(), Scalar.end());
811 Val = strtod(buff.c_str(), &end);
813 return "invalid floating point number";
817 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
819 Out << format("0x%02X", Num);
822 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
823 unsigned long long n;
824 if (getAsUnsignedInteger(Scalar, 0, n))
825 return "invalid hex8 number";
827 return "out of range hex8 number";
832 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
834 Out << format("0x%04X", Num);
837 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
838 unsigned long long n;
839 if (getAsUnsignedInteger(Scalar, 0, n))
840 return "invalid hex16 number";
842 return "out of range hex16 number";
847 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
849 Out << format("0x%08X", Num);
852 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
853 unsigned long long n;
854 if (getAsUnsignedInteger(Scalar, 0, n))
855 return "invalid hex32 number";
856 if (n > 0xFFFFFFFFUL)
857 return "out of range hex32 number";
862 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
864 Out << format("0x%016llX", Num);
867 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
868 unsigned long long Num;
869 if (getAsUnsignedInteger(Scalar, 0, Num))
870 return "invalid hex64 number";