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 KeyStr = StringStorage.str().copy(StringAllocator);
337 return llvm::make_unique<ScalarHNode>(N, KeyStr);
338 } else if (BlockScalarNode *BSN = dyn_cast<BlockScalarNode>(N)) {
339 StringRef ValueCopy = BSN->getValue().copy(StringAllocator);
340 return llvm::make_unique<ScalarHNode>(N, ValueCopy);
341 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
342 auto SQHNode = llvm::make_unique<SequenceHNode>(N);
343 for (Node &SN : *SQ) {
344 auto Entry = this->createHNodes(&SN);
347 SQHNode->Entries.push_back(std::move(Entry));
349 return std::move(SQHNode);
350 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
351 auto mapHNode = llvm::make_unique<MapHNode>(N);
352 for (KeyValueNode &KVN : *Map) {
353 Node *KeyNode = KVN.getKey();
354 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(KeyNode);
356 setError(KeyNode, "Map key must be a scalar");
359 StringStorage.clear();
360 StringRef KeyStr = KeyScalar->getValue(StringStorage);
361 if (!StringStorage.empty()) {
362 // Copy string to permanent storage
363 KeyStr = StringStorage.str().copy(StringAllocator);
365 auto ValueHNode = this->createHNodes(KVN.getValue());
368 mapHNode->Mapping[KeyStr] = std::move(ValueHNode);
370 return std::move(mapHNode);
371 } else if (isa<NullNode>(N)) {
372 return llvm::make_unique<EmptyHNode>(N);
374 setError(N, "unknown node kind");
379 bool Input::MapHNode::isValidKey(StringRef Key) {
380 for (const char *K : ValidKeys) {
387 void Input::setError(const Twine &Message) {
388 this->setError(CurrentNode, Message);
391 bool Input::canElideEmptySequence() {
395 //===----------------------------------------------------------------------===//
397 //===----------------------------------------------------------------------===//
399 Output::Output(raw_ostream &yout, void *context, int WrapColumn)
402 WrapColumn(WrapColumn),
404 ColumnAtFlowStart(0),
405 ColumnAtMapFlowStart(0),
406 NeedBitValueComma(false),
407 NeedFlowSequenceComma(false),
408 EnumerationMatchFound(false),
409 NeedsNewLine(false) {
415 bool Output::outputting() {
419 void Output::beginMapping() {
420 StateStack.push_back(inMapFirstKey);
424 bool Output::mapTag(StringRef Tag, bool Use) {
426 // If this tag is being written inside a sequence we should write the start
427 // of the sequence before writing the tag, otherwise the tag won't be
428 // attached to the element in the sequence, but rather the sequence itself.
429 bool SequenceElement =
430 StateStack.size() > 1 && (StateStack[StateStack.size() - 2] == inSeq ||
431 StateStack[StateStack.size() - 2] == inFlowSeq);
432 if (SequenceElement && StateStack.back() == inMapFirstKey) {
433 this->newLineCheck();
438 if (SequenceElement) {
439 // If we're writing the tag during the first element of a map, the tag
440 // takes the place of the first element in the sequence.
441 if (StateStack.back() == inMapFirstKey) {
442 StateStack.pop_back();
443 StateStack.push_back(inMapOtherKey);
445 // Tags inside maps in sequences should act as keys in the map from a
446 // formatting perspective, so we always want a newline in a sequence.
453 void Output::endMapping() {
454 StateStack.pop_back();
457 bool Output::preflightKey(const char *Key, bool Required, bool SameAsDefault,
458 bool &UseDefault, void *&) {
460 if (Required || !SameAsDefault) {
461 auto State = StateStack.back();
462 if (State == inFlowMapFirstKey || State == inFlowMapOtherKey) {
465 this->newLineCheck();
466 this->paddedKey(Key);
473 void Output::postflightKey(void *) {
474 if (StateStack.back() == inMapFirstKey) {
475 StateStack.pop_back();
476 StateStack.push_back(inMapOtherKey);
477 } else if (StateStack.back() == inFlowMapFirstKey) {
478 StateStack.pop_back();
479 StateStack.push_back(inFlowMapOtherKey);
483 void Output::beginFlowMapping() {
484 StateStack.push_back(inFlowMapFirstKey);
485 this->newLineCheck();
486 ColumnAtMapFlowStart = Column;
490 void Output::endFlowMapping() {
491 StateStack.pop_back();
492 this->outputUpToEndOfLine(" }");
495 void Output::beginDocuments() {
496 this->outputUpToEndOfLine("---");
499 bool Output::preflightDocument(unsigned index) {
501 this->outputUpToEndOfLine("\n---");
505 void Output::postflightDocument() {
508 void Output::endDocuments() {
512 unsigned Output::beginSequence() {
513 StateStack.push_back(inSeq);
518 void Output::endSequence() {
519 StateStack.pop_back();
522 bool Output::preflightElement(unsigned, void *&) {
526 void Output::postflightElement(void *) {
529 unsigned Output::beginFlowSequence() {
530 StateStack.push_back(inFlowSeq);
531 this->newLineCheck();
532 ColumnAtFlowStart = Column;
534 NeedFlowSequenceComma = false;
538 void Output::endFlowSequence() {
539 StateStack.pop_back();
540 this->outputUpToEndOfLine(" ]");
543 bool Output::preflightFlowElement(unsigned, void *&) {
544 if (NeedFlowSequenceComma)
546 if (WrapColumn && Column > WrapColumn) {
548 for (int i = 0; i < ColumnAtFlowStart; ++i)
550 Column = ColumnAtFlowStart;
556 void Output::postflightFlowElement(void *) {
557 NeedFlowSequenceComma = true;
560 void Output::beginEnumScalar() {
561 EnumerationMatchFound = false;
564 bool Output::matchEnumScalar(const char *Str, bool Match) {
565 if (Match && !EnumerationMatchFound) {
566 this->newLineCheck();
567 this->outputUpToEndOfLine(Str);
568 EnumerationMatchFound = true;
573 bool Output::matchEnumFallback() {
574 if (EnumerationMatchFound)
576 EnumerationMatchFound = true;
580 void Output::endEnumScalar() {
581 if (!EnumerationMatchFound)
582 llvm_unreachable("bad runtime enum value");
585 bool Output::beginBitSetScalar(bool &DoClear) {
586 this->newLineCheck();
588 NeedBitValueComma = false;
593 bool Output::bitSetMatch(const char *Str, bool Matches) {
595 if (NeedBitValueComma)
598 NeedBitValueComma = true;
603 void Output::endBitSetScalar() {
604 this->outputUpToEndOfLine(" ]");
607 void Output::scalarString(StringRef &S, bool MustQuote) {
608 this->newLineCheck();
610 // Print '' for the empty string because leaving the field empty is not
612 this->outputUpToEndOfLine("''");
616 // Only quote if we must.
617 this->outputUpToEndOfLine(S);
622 unsigned End = S.size();
623 output("'"); // Starting single quote.
624 const char *Base = S.data();
626 // Escape a single quote by doubling it.
628 output(StringRef(&Base[i], j - i + 1));
634 output(StringRef(&Base[i], j - i));
635 this->outputUpToEndOfLine("'"); // Ending single quote.
638 void Output::blockScalarString(StringRef &S) {
639 if (!StateStack.empty())
644 unsigned Indent = StateStack.empty() ? 1 : StateStack.size();
646 auto Buffer = MemoryBuffer::getMemBuffer(S, "", false);
647 for (line_iterator Lines(*Buffer, false); !Lines.is_at_end(); ++Lines) {
648 for (unsigned I = 0; I < Indent; ++I) {
656 void Output::setError(const Twine &message) {
659 bool Output::canElideEmptySequence() {
660 // Normally, with an optional key/value where the value is an empty sequence,
661 // the whole key/value can be not written. But, that produces wrong yaml
662 // if the key/value is the only thing in the map and the map is used in
663 // a sequence. This detects if the this sequence is the first key/value
664 // in map that itself is embedded in a sequnce.
665 if (StateStack.size() < 2)
667 if (StateStack.back() != inMapFirstKey)
669 return (StateStack[StateStack.size()-2] != inSeq);
672 void Output::output(StringRef s) {
677 void Output::outputUpToEndOfLine(StringRef s) {
679 if (StateStack.empty() || (StateStack.back() != inFlowSeq &&
680 StateStack.back() != inFlowMapFirstKey &&
681 StateStack.back() != inFlowMapOtherKey))
685 void Output::outputNewLine() {
690 // if seq at top, indent as if map, then add "- "
691 // if seq in middle, use "- " if firstKey, else use " "
694 void Output::newLineCheck() {
697 NeedsNewLine = false;
699 this->outputNewLine();
701 assert(StateStack.size() > 0);
702 unsigned Indent = StateStack.size() - 1;
703 bool OutputDash = false;
705 if (StateStack.back() == inSeq) {
707 } else if ((StateStack.size() > 1) && ((StateStack.back() == inMapFirstKey) ||
708 (StateStack.back() == inFlowSeq) ||
709 (StateStack.back() == inFlowMapFirstKey)) &&
710 (StateStack[StateStack.size() - 2] == inSeq)) {
715 for (unsigned i = 0; i < Indent; ++i) {
724 void Output::paddedKey(StringRef key) {
727 const char *spaces = " ";
728 if (key.size() < strlen(spaces))
729 output(&spaces[key.size()]);
734 void Output::flowKey(StringRef Key) {
735 if (StateStack.back() == inFlowMapOtherKey)
737 if (WrapColumn && Column > WrapColumn) {
739 for (int I = 0; I < ColumnAtMapFlowStart; ++I)
741 Column = ColumnAtMapFlowStart;
748 //===----------------------------------------------------------------------===//
749 // traits for built-in types
750 //===----------------------------------------------------------------------===//
752 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
753 Out << (Val ? "true" : "false");
756 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
757 if (Scalar.equals("true")) {
760 } else if (Scalar.equals("false")) {
764 return "invalid boolean";
767 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
772 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
778 void ScalarTraits<std::string>::output(const std::string &Val, void *,
783 StringRef ScalarTraits<std::string>::input(StringRef Scalar, void *,
789 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
791 // use temp uin32_t because ostream thinks uint8_t is a character
796 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
797 unsigned long long n;
798 if (getAsUnsignedInteger(Scalar, 0, n))
799 return "invalid number";
801 return "out of range number";
806 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
811 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
813 unsigned long long n;
814 if (getAsUnsignedInteger(Scalar, 0, n))
815 return "invalid number";
817 return "out of range number";
822 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
827 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
829 unsigned long long n;
830 if (getAsUnsignedInteger(Scalar, 0, n))
831 return "invalid number";
832 if (n > 0xFFFFFFFFUL)
833 return "out of range number";
838 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
843 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
845 unsigned long long N;
846 if (getAsUnsignedInteger(Scalar, 0, N))
847 return "invalid number";
852 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
853 // use temp in32_t because ostream thinks int8_t is a character
858 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
860 if (getAsSignedInteger(Scalar, 0, N))
861 return "invalid number";
862 if ((N > 127) || (N < -128))
863 return "out of range number";
868 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
873 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
875 if (getAsSignedInteger(Scalar, 0, N))
876 return "invalid number";
877 if ((N > INT16_MAX) || (N < INT16_MIN))
878 return "out of range number";
883 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
888 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
890 if (getAsSignedInteger(Scalar, 0, N))
891 return "invalid number";
892 if ((N > INT32_MAX) || (N < INT32_MIN))
893 return "out of range number";
898 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
903 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
905 if (getAsSignedInteger(Scalar, 0, N))
906 return "invalid number";
911 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
912 Out << format("%g", Val);
915 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
916 SmallString<32> buff(Scalar.begin(), Scalar.end());
918 Val = strtod(buff.c_str(), &end);
920 return "invalid floating point number";
924 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
925 Out << format("%g", Val);
928 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
929 SmallString<32> buff(Scalar.begin(), Scalar.end());
931 Val = strtod(buff.c_str(), &end);
933 return "invalid floating point number";
937 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
939 Out << format("0x%02X", Num);
942 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
943 unsigned long long n;
944 if (getAsUnsignedInteger(Scalar, 0, n))
945 return "invalid hex8 number";
947 return "out of range hex8 number";
952 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
954 Out << format("0x%04X", Num);
957 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
958 unsigned long long n;
959 if (getAsUnsignedInteger(Scalar, 0, n))
960 return "invalid hex16 number";
962 return "out of range hex16 number";
967 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
969 Out << format("0x%08X", Num);
972 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
973 unsigned long long n;
974 if (getAsUnsignedInteger(Scalar, 0, n))
975 return "invalid hex32 number";
976 if (n > 0xFFFFFFFFUL)
977 return "out of range hex32 number";
982 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
984 Out << format("0x%016llX", Num);
987 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
988 unsigned long long Num;
989 if (getAsUnsignedInteger(Scalar, 0, Num))
990 return "invalid hex64 number";