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/SmallString.h"
12 #include "llvm/ADT/Twine.h"
13 #include "llvm/Support/Casting.h"
14 #include "llvm/Support/Errc.h"
15 #include "llvm/Support/ErrorHandling.h"
16 #include "llvm/Support/Format.h"
17 #include "llvm/Support/LineIterator.h"
18 #include "llvm/Support/YAMLParser.h"
19 #include "llvm/Support/raw_ostream.h"
25 //===----------------------------------------------------------------------===//
27 //===----------------------------------------------------------------------===//
29 IO::IO(void *Context) : Ctxt(Context) {
35 void *IO::getContext() {
39 void IO::setContext(void *Context) {
43 //===----------------------------------------------------------------------===//
45 //===----------------------------------------------------------------------===//
47 Input::Input(StringRef InputContent,
49 SourceMgr::DiagHandlerTy DiagHandler,
50 void *DiagHandlerCtxt)
52 Strm(new Stream(InputContent, SrcMgr)),
53 CurrentNode(nullptr) {
55 SrcMgr.setDiagHandler(DiagHandler, DiagHandlerCtxt);
56 DocIterator = Strm->begin();
62 std::error_code Input::error() { return EC; }
64 // Pin the vtables to this file.
65 void Input::HNode::anchor() {}
66 void Input::EmptyHNode::anchor() {}
67 void Input::ScalarHNode::anchor() {}
68 void Input::MapHNode::anchor() {}
69 void Input::SequenceHNode::anchor() {}
71 bool Input::outputting() {
75 bool Input::setCurrentDocument() {
76 if (DocIterator != Strm->end()) {
77 Node *N = DocIterator->getRoot();
79 assert(Strm->failed() && "Root is NULL iff parsing failed");
80 EC = make_error_code(errc::invalid_argument);
84 if (isa<NullNode>(N)) {
85 // Empty files are allowed and ignored
87 return setCurrentDocument();
89 TopNode = this->createHNodes(N);
90 CurrentNode = TopNode.get();
96 bool Input::nextDocument() {
97 return ++DocIterator != Strm->end();
100 const Node *Input::getCurrentNode() const {
101 return CurrentNode ? CurrentNode->_node : nullptr;
104 bool Input::mapTag(StringRef Tag, bool Default) {
105 std::string foundTag = CurrentNode->_node->getVerbatimTag();
106 if (foundTag.empty()) {
107 // If no tag found and 'Tag' is the default, say it was found.
110 // Return true iff found tag matches supplied tag.
111 return Tag.equals(foundTag);
114 void Input::beginMapping() {
117 // CurrentNode can be null if the document is empty.
118 MapHNode *MN = dyn_cast_or_null<MapHNode>(CurrentNode);
120 MN->ValidKeys.clear();
124 bool Input::preflightKey(const char *Key, bool Required, bool, bool &UseDefault,
130 // CurrentNode is null for empty documents, which is an error in case required
131 // nodes are present.
134 EC = make_error_code(errc::invalid_argument);
138 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
140 setError(CurrentNode, "not a mapping");
143 MN->ValidKeys.push_back(Key);
144 HNode *Value = MN->Mapping[Key].get();
147 setError(CurrentNode, Twine("missing required key '") + Key + "'");
152 SaveInfo = CurrentNode;
157 void Input::postflightKey(void *saveInfo) {
158 CurrentNode = reinterpret_cast<HNode *>(saveInfo);
161 void Input::endMapping() {
164 // CurrentNode can be null if the document is empty.
165 MapHNode *MN = dyn_cast_or_null<MapHNode>(CurrentNode);
168 for (const auto &NN : MN->Mapping) {
169 if (!MN->isValidKey(NN.first())) {
170 setError(NN.second.get(), Twine("unknown key '") + NN.first() + "'");
176 void Input::beginFlowMapping() { beginMapping(); }
178 void Input::endFlowMapping() { endMapping(); }
180 unsigned Input::beginSequence() {
181 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode))
182 return SQ->Entries.size();
183 if (isa<EmptyHNode>(CurrentNode))
185 // Treat case where there's a scalar "null" value as an empty sequence.
186 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
187 if (isNull(SN->value()))
190 // Any other type of HNode is an error.
191 setError(CurrentNode, "not a sequence");
195 void Input::endSequence() {
198 bool Input::preflightElement(unsigned Index, void *&SaveInfo) {
201 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
202 SaveInfo = CurrentNode;
203 CurrentNode = SQ->Entries[Index].get();
209 void Input::postflightElement(void *SaveInfo) {
210 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
213 unsigned Input::beginFlowSequence() { return beginSequence(); }
215 bool Input::preflightFlowElement(unsigned index, void *&SaveInfo) {
218 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
219 SaveInfo = CurrentNode;
220 CurrentNode = SQ->Entries[index].get();
226 void Input::postflightFlowElement(void *SaveInfo) {
227 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
230 void Input::endFlowSequence() {
233 void Input::beginEnumScalar() {
234 ScalarMatchFound = false;
237 bool Input::matchEnumScalar(const char *Str, bool) {
238 if (ScalarMatchFound)
240 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
241 if (SN->value().equals(Str)) {
242 ScalarMatchFound = true;
249 bool Input::matchEnumFallback() {
250 if (ScalarMatchFound)
252 ScalarMatchFound = true;
256 void Input::endEnumScalar() {
257 if (!ScalarMatchFound) {
258 setError(CurrentNode, "unknown enumerated scalar");
262 bool Input::beginBitSetScalar(bool &DoClear) {
263 BitValuesUsed.clear();
264 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
265 BitValuesUsed.insert(BitValuesUsed.begin(), SQ->Entries.size(), false);
267 setError(CurrentNode, "expected sequence of bit values");
273 bool Input::bitSetMatch(const char *Str, bool) {
276 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
278 for (auto &N : SQ->Entries) {
279 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(N.get())) {
280 if (SN->value().equals(Str)) {
281 BitValuesUsed[Index] = true;
285 setError(CurrentNode, "unexpected scalar in sequence of bit values");
290 setError(CurrentNode, "expected sequence of bit values");
295 void Input::endBitSetScalar() {
298 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
299 assert(BitValuesUsed.size() == SQ->Entries.size());
300 for (unsigned i = 0; i < SQ->Entries.size(); ++i) {
301 if (!BitValuesUsed[i]) {
302 setError(SQ->Entries[i].get(), "unknown bit value");
309 void Input::scalarString(StringRef &S, bool) {
310 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
313 setError(CurrentNode, "unexpected scalar");
317 void Input::blockScalarString(StringRef &S) { scalarString(S, false); }
319 void Input::setError(HNode *hnode, const Twine &message) {
320 assert(hnode && "HNode must not be NULL");
321 this->setError(hnode->_node, message);
324 void Input::setError(Node *node, const Twine &message) {
325 Strm->printError(node, message);
326 EC = make_error_code(errc::invalid_argument);
329 std::unique_ptr<Input::HNode> Input::createHNodes(Node *N) {
330 SmallString<128> StringStorage;
331 if (ScalarNode *SN = dyn_cast<ScalarNode>(N)) {
332 StringRef KeyStr = SN->getValue(StringStorage);
333 if (!StringStorage.empty()) {
334 // Copy string to permanent storage
335 unsigned Len = StringStorage.size();
336 char *Buf = StringAllocator.Allocate<char>(Len);
337 memcpy(Buf, &StringStorage[0], Len);
338 KeyStr = StringRef(Buf, Len);
340 return llvm::make_unique<ScalarHNode>(N, KeyStr);
341 } else if (BlockScalarNode *BSN = dyn_cast<BlockScalarNode>(N)) {
342 StringRef Value = BSN->getValue();
343 char *Buf = StringAllocator.Allocate<char>(Value.size());
344 memcpy(Buf, Value.data(), Value.size());
345 return llvm::make_unique<ScalarHNode>(N, StringRef(Buf, Value.size()));
346 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
347 auto SQHNode = llvm::make_unique<SequenceHNode>(N);
348 for (Node &SN : *SQ) {
349 auto Entry = this->createHNodes(&SN);
352 SQHNode->Entries.push_back(std::move(Entry));
354 return std::move(SQHNode);
355 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
356 auto mapHNode = llvm::make_unique<MapHNode>(N);
357 for (KeyValueNode &KVN : *Map) {
358 Node *KeyNode = KVN.getKey();
359 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(KeyNode);
361 setError(KeyNode, "Map key must be a scalar");
364 StringStorage.clear();
365 StringRef KeyStr = KeyScalar->getValue(StringStorage);
366 if (!StringStorage.empty()) {
367 // Copy string to permanent storage
368 unsigned Len = StringStorage.size();
369 char *Buf = StringAllocator.Allocate<char>(Len);
370 memcpy(Buf, &StringStorage[0], Len);
371 KeyStr = StringRef(Buf, Len);
373 auto ValueHNode = this->createHNodes(KVN.getValue());
376 mapHNode->Mapping[KeyStr] = std::move(ValueHNode);
378 return std::move(mapHNode);
379 } else if (isa<NullNode>(N)) {
380 return llvm::make_unique<EmptyHNode>(N);
382 setError(N, "unknown node kind");
387 bool Input::MapHNode::isValidKey(StringRef Key) {
388 for (const char *K : ValidKeys) {
395 void Input::setError(const Twine &Message) {
396 this->setError(CurrentNode, Message);
399 bool Input::canElideEmptySequence() {
403 //===----------------------------------------------------------------------===//
405 //===----------------------------------------------------------------------===//
407 Output::Output(raw_ostream &yout, void *context)
411 ColumnAtFlowStart(0),
412 ColumnAtMapFlowStart(0),
413 NeedBitValueComma(false),
414 NeedFlowSequenceComma(false),
415 EnumerationMatchFound(false),
416 NeedsNewLine(false) {
422 bool Output::outputting() {
426 void Output::beginMapping() {
427 StateStack.push_back(inMapFirstKey);
431 bool Output::mapTag(StringRef Tag, bool Use) {
439 void Output::endMapping() {
440 StateStack.pop_back();
443 bool Output::preflightKey(const char *Key, bool Required, bool SameAsDefault,
444 bool &UseDefault, void *&) {
446 if (Required || !SameAsDefault) {
447 auto State = StateStack.back();
448 if (State == inFlowMapFirstKey || State == inFlowMapOtherKey) {
451 this->newLineCheck();
452 this->paddedKey(Key);
459 void Output::postflightKey(void *) {
460 if (StateStack.back() == inMapFirstKey) {
461 StateStack.pop_back();
462 StateStack.push_back(inMapOtherKey);
463 } else if (StateStack.back() == inFlowMapFirstKey) {
464 StateStack.pop_back();
465 StateStack.push_back(inFlowMapOtherKey);
469 void Output::beginFlowMapping() {
470 StateStack.push_back(inFlowMapFirstKey);
471 this->newLineCheck();
472 ColumnAtMapFlowStart = Column;
476 void Output::endFlowMapping() {
477 StateStack.pop_back();
478 this->outputUpToEndOfLine(" }");
481 void Output::beginDocuments() {
482 this->outputUpToEndOfLine("---");
485 bool Output::preflightDocument(unsigned index) {
487 this->outputUpToEndOfLine("\n---");
491 void Output::postflightDocument() {
494 void Output::endDocuments() {
498 unsigned Output::beginSequence() {
499 StateStack.push_back(inSeq);
504 void Output::endSequence() {
505 StateStack.pop_back();
508 bool Output::preflightElement(unsigned, void *&) {
512 void Output::postflightElement(void *) {
515 unsigned Output::beginFlowSequence() {
516 StateStack.push_back(inFlowSeq);
517 this->newLineCheck();
518 ColumnAtFlowStart = Column;
520 NeedFlowSequenceComma = false;
524 void Output::endFlowSequence() {
525 StateStack.pop_back();
526 this->outputUpToEndOfLine(" ]");
529 bool Output::preflightFlowElement(unsigned, void *&) {
530 if (NeedFlowSequenceComma)
534 for (int i = 0; i < ColumnAtFlowStart; ++i)
536 Column = ColumnAtFlowStart;
542 void Output::postflightFlowElement(void *) {
543 NeedFlowSequenceComma = true;
546 void Output::beginEnumScalar() {
547 EnumerationMatchFound = false;
550 bool Output::matchEnumScalar(const char *Str, bool Match) {
551 if (Match && !EnumerationMatchFound) {
552 this->newLineCheck();
553 this->outputUpToEndOfLine(Str);
554 EnumerationMatchFound = true;
559 bool Output::matchEnumFallback() {
560 if (EnumerationMatchFound)
562 EnumerationMatchFound = true;
566 void Output::endEnumScalar() {
567 if (!EnumerationMatchFound)
568 llvm_unreachable("bad runtime enum value");
571 bool Output::beginBitSetScalar(bool &DoClear) {
572 this->newLineCheck();
574 NeedBitValueComma = false;
579 bool Output::bitSetMatch(const char *Str, bool Matches) {
581 if (NeedBitValueComma)
584 NeedBitValueComma = true;
589 void Output::endBitSetScalar() {
590 this->outputUpToEndOfLine(" ]");
593 void Output::scalarString(StringRef &S, bool MustQuote) {
594 this->newLineCheck();
596 // Print '' for the empty string because leaving the field empty is not
598 this->outputUpToEndOfLine("''");
602 // Only quote if we must.
603 this->outputUpToEndOfLine(S);
608 unsigned End = S.size();
609 output("'"); // Starting single quote.
610 const char *Base = S.data();
612 // Escape a single quote by doubling it.
614 output(StringRef(&Base[i], j - i + 1));
620 output(StringRef(&Base[i], j - i));
621 this->outputUpToEndOfLine("'"); // Ending single quote.
624 void Output::blockScalarString(StringRef &S) {
625 if (!StateStack.empty())
630 unsigned Indent = StateStack.empty() ? 1 : StateStack.size();
632 auto Buffer = MemoryBuffer::getMemBuffer(S, "", false);
633 for (line_iterator Lines(*Buffer, false); !Lines.is_at_end(); ++Lines) {
634 for (unsigned I = 0; I < Indent; ++I) {
642 void Output::setError(const Twine &message) {
645 bool Output::canElideEmptySequence() {
646 // Normally, with an optional key/value where the value is an empty sequence,
647 // the whole key/value can be not written. But, that produces wrong yaml
648 // if the key/value is the only thing in the map and the map is used in
649 // a sequence. This detects if the this sequence is the first key/value
650 // in map that itself is embedded in a sequnce.
651 if (StateStack.size() < 2)
653 if (StateStack.back() != inMapFirstKey)
655 return (StateStack[StateStack.size()-2] != inSeq);
658 void Output::output(StringRef s) {
663 void Output::outputUpToEndOfLine(StringRef s) {
665 if (StateStack.empty() || (StateStack.back() != inFlowSeq &&
666 StateStack.back() != inFlowMapFirstKey &&
667 StateStack.back() != inFlowMapOtherKey))
671 void Output::outputNewLine() {
676 // if seq at top, indent as if map, then add "- "
677 // if seq in middle, use "- " if firstKey, else use " "
680 void Output::newLineCheck() {
683 NeedsNewLine = false;
685 this->outputNewLine();
687 assert(StateStack.size() > 0);
688 unsigned Indent = StateStack.size() - 1;
689 bool OutputDash = false;
691 if (StateStack.back() == inSeq) {
693 } else if ((StateStack.size() > 1) && ((StateStack.back() == inMapFirstKey) ||
694 (StateStack.back() == inFlowSeq) ||
695 (StateStack.back() == inFlowMapFirstKey)) &&
696 (StateStack[StateStack.size() - 2] == inSeq)) {
701 for (unsigned i = 0; i < Indent; ++i) {
710 void Output::paddedKey(StringRef key) {
713 const char *spaces = " ";
714 if (key.size() < strlen(spaces))
715 output(&spaces[key.size()]);
720 void Output::flowKey(StringRef Key) {
721 if (StateStack.back() == inFlowMapOtherKey)
725 for (int I = 0; I < ColumnAtMapFlowStart; ++I)
727 Column = ColumnAtMapFlowStart;
734 //===----------------------------------------------------------------------===//
735 // traits for built-in types
736 //===----------------------------------------------------------------------===//
738 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
739 Out << (Val ? "true" : "false");
742 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
743 if (Scalar.equals("true")) {
746 } else if (Scalar.equals("false")) {
750 return "invalid boolean";
753 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
758 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
764 void ScalarTraits<std::string>::output(const std::string &Val, void *,
769 StringRef ScalarTraits<std::string>::input(StringRef Scalar, void *,
775 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
777 // use temp uin32_t because ostream thinks uint8_t is a character
782 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
783 unsigned long long n;
784 if (getAsUnsignedInteger(Scalar, 0, n))
785 return "invalid number";
787 return "out of range number";
792 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
797 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
799 unsigned long long n;
800 if (getAsUnsignedInteger(Scalar, 0, n))
801 return "invalid number";
803 return "out of range number";
808 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
813 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
815 unsigned long long n;
816 if (getAsUnsignedInteger(Scalar, 0, n))
817 return "invalid number";
818 if (n > 0xFFFFFFFFUL)
819 return "out of range number";
824 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
829 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
831 unsigned long long N;
832 if (getAsUnsignedInteger(Scalar, 0, N))
833 return "invalid number";
838 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
839 // use temp in32_t because ostream thinks int8_t is a character
844 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
846 if (getAsSignedInteger(Scalar, 0, N))
847 return "invalid number";
848 if ((N > 127) || (N < -128))
849 return "out of range number";
854 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
859 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
861 if (getAsSignedInteger(Scalar, 0, N))
862 return "invalid number";
863 if ((N > INT16_MAX) || (N < INT16_MIN))
864 return "out of range number";
869 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
874 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
876 if (getAsSignedInteger(Scalar, 0, N))
877 return "invalid number";
878 if ((N > INT32_MAX) || (N < INT32_MIN))
879 return "out of range number";
884 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
889 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
891 if (getAsSignedInteger(Scalar, 0, N))
892 return "invalid number";
897 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
898 Out << format("%g", Val);
901 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
902 SmallString<32> buff(Scalar.begin(), Scalar.end());
904 Val = strtod(buff.c_str(), &end);
906 return "invalid floating point number";
910 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
911 Out << format("%g", Val);
914 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
915 SmallString<32> buff(Scalar.begin(), Scalar.end());
917 Val = strtod(buff.c_str(), &end);
919 return "invalid floating point number";
923 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
925 Out << format("0x%02X", Num);
928 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
929 unsigned long long n;
930 if (getAsUnsignedInteger(Scalar, 0, n))
931 return "invalid hex8 number";
933 return "out of range hex8 number";
938 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
940 Out << format("0x%04X", Num);
943 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
944 unsigned long long n;
945 if (getAsUnsignedInteger(Scalar, 0, n))
946 return "invalid hex16 number";
948 return "out of range hex16 number";
953 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
955 Out << format("0x%08X", Num);
958 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
959 unsigned long long n;
960 if (getAsUnsignedInteger(Scalar, 0, n))
961 return "invalid hex32 number";
962 if (n > 0xFFFFFFFFUL)
963 return "out of range hex32 number";
968 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
970 Out << format("0x%016llX", Num);
973 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
974 unsigned long long Num;
975 if (getAsUnsignedInteger(Scalar, 0, Num))
976 return "invalid hex64 number";