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 //===----------------------------------------------------------------------===//
23 //===----------------------------------------------------------------------===//
25 IO::IO(void *Context) : Ctxt(Context) {
31 void *IO::getContext() {
35 void IO::setContext(void *Context) {
39 //===----------------------------------------------------------------------===//
41 //===----------------------------------------------------------------------===//
43 Input::Input(StringRef InputContent, void *Ctxt) : IO(Ctxt), CurrentNode(NULL) {
44 Strm = new Stream(InputContent, SrcMgr);
45 DocIterator = Strm->begin();
48 error_code Input::error() {
52 void Input::setDiagHandler(SourceMgr::DiagHandlerTy Handler, void *Ctxt) {
53 SrcMgr.setDiagHandler(Handler, Ctxt);
56 bool Input::outputting() {
60 bool Input::setCurrentDocument() {
61 if (DocIterator != Strm->end()) {
62 Node *N = DocIterator->getRoot();
63 if (isa<NullNode>(N)) {
64 // Empty files are allowed and ignored
66 return setCurrentDocument();
68 CurrentNode = this->createHNodes(N);
74 void Input::nextDocument() {
78 void Input::beginMapping() {
81 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
83 MN->ValidKeys.clear();
87 bool Input::preflightKey(const char *Key, bool Required, bool, bool &UseDefault,
92 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
94 setError(CurrentNode, "not a mapping");
97 MN->ValidKeys.push_back(Key);
98 HNode *Value = MN->Mapping[Key];
101 setError(CurrentNode, Twine("missing required key '") + Key + "'");
106 SaveInfo = CurrentNode;
111 void Input::postflightKey(void *saveInfo) {
112 CurrentNode = reinterpret_cast<HNode *>(saveInfo);
115 void Input::endMapping() {
118 MapHNode *MN = dyn_cast<MapHNode>(CurrentNode);
121 for (MapHNode::NameToNode::iterator i = MN->Mapping.begin(),
122 End = MN->Mapping.end(); i != End; ++i) {
123 if (!MN->isValidKey(i->first)) {
124 setError(i->second, Twine("unknown key '") + i->first + "'");
130 unsigned Input::beginSequence() {
131 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
132 return SQ->Entries.size();
137 void Input::endSequence() {
140 bool Input::preflightElement(unsigned Index, void *&SaveInfo) {
143 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
144 SaveInfo = CurrentNode;
145 CurrentNode = SQ->Entries[Index];
151 void Input::postflightElement(void *SaveInfo) {
152 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
155 unsigned Input::beginFlowSequence() {
156 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
157 return SQ->Entries.size();
162 bool Input::preflightFlowElement(unsigned index, void *&SaveInfo) {
165 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
166 SaveInfo = CurrentNode;
167 CurrentNode = SQ->Entries[index];
173 void Input::postflightFlowElement(void *SaveInfo) {
174 CurrentNode = reinterpret_cast<HNode *>(SaveInfo);
177 void Input::endFlowSequence() {
180 void Input::beginEnumScalar() {
181 ScalarMatchFound = false;
184 bool Input::matchEnumScalar(const char *Str, bool) {
185 if (ScalarMatchFound)
187 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
188 if (SN->value().equals(Str)) {
189 ScalarMatchFound = true;
196 void Input::endEnumScalar() {
197 if (!ScalarMatchFound) {
198 setError(CurrentNode, "unknown enumerated scalar");
202 bool Input::beginBitSetScalar(bool &DoClear) {
203 BitValuesUsed.clear();
204 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
205 BitValuesUsed.insert(BitValuesUsed.begin(), SQ->Entries.size(), false);
207 setError(CurrentNode, "expected sequence of bit values");
213 bool Input::bitSetMatch(const char *Str, bool) {
216 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
218 for (std::vector<HNode *>::iterator i = SQ->Entries.begin(),
219 End = SQ->Entries.end(); i != End; ++i) {
220 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(*i)) {
221 if (SN->value().equals(Str)) {
222 BitValuesUsed[Index] = true;
226 setError(CurrentNode, "unexpected scalar in sequence of bit values");
231 setError(CurrentNode, "expected sequence of bit values");
236 void Input::endBitSetScalar() {
239 if (SequenceHNode *SQ = dyn_cast<SequenceHNode>(CurrentNode)) {
240 assert(BitValuesUsed.size() == SQ->Entries.size());
241 for (unsigned i = 0; i < SQ->Entries.size(); ++i) {
242 if (!BitValuesUsed[i]) {
243 setError(SQ->Entries[i], "unknown bit value");
250 void Input::scalarString(StringRef &S) {
251 if (ScalarHNode *SN = dyn_cast<ScalarHNode>(CurrentNode)) {
254 setError(CurrentNode, "unexpected scalar");
258 void Input::setError(HNode *hnode, const Twine &message) {
259 this->setError(hnode->_node, message);
262 void Input::setError(Node *node, const Twine &message) {
263 Strm->printError(node, message);
264 EC = make_error_code(errc::invalid_argument);
267 Input::HNode *Input::createHNodes(Node *N) {
268 SmallString<128> StringStorage;
269 if (ScalarNode *SN = dyn_cast<ScalarNode>(N)) {
270 StringRef KeyStr = SN->getValue(StringStorage);
271 if (!StringStorage.empty()) {
272 // Copy string to permanent storage
273 unsigned Len = StringStorage.size();
274 char *Buf = Allocator.Allocate<char>(Len);
275 memcpy(Buf, &StringStorage[0], Len);
276 KeyStr = StringRef(Buf, Len);
278 return new (Allocator) ScalarHNode(N, KeyStr);
279 } else if (SequenceNode *SQ = dyn_cast<SequenceNode>(N)) {
280 SequenceHNode *SQHNode = new (Allocator) SequenceHNode(N);
281 for (SequenceNode::iterator i = SQ->begin(), End = SQ->end(); i != End;
283 HNode *Entry = this->createHNodes(i);
286 SQHNode->Entries.push_back(Entry);
289 } else if (MappingNode *Map = dyn_cast<MappingNode>(N)) {
290 MapHNode *mapHNode = new (Allocator) MapHNode(N);
291 for (MappingNode::iterator i = Map->begin(), End = Map->end(); i != End;
293 ScalarNode *KeyScalar = dyn_cast<ScalarNode>(i->getKey());
294 StringStorage.clear();
295 StringRef KeyStr = KeyScalar->getValue(StringStorage);
296 if (!StringStorage.empty()) {
297 // Copy string to permanent storage
298 unsigned Len = StringStorage.size();
299 char *Buf = Allocator.Allocate<char>(Len);
300 memcpy(Buf, &StringStorage[0], Len);
301 KeyStr = StringRef(Buf, Len);
303 HNode *ValueHNode = this->createHNodes(i->getValue());
306 mapHNode->Mapping[KeyStr] = ValueHNode;
309 } else if (isa<NullNode>(N)) {
310 return new (Allocator) EmptyHNode(N);
312 setError(N, "unknown node kind");
317 bool Input::MapHNode::isValidKey(StringRef Key) {
318 for (SmallVector<const char *, 6>::iterator i = ValidKeys.begin(),
319 End = ValidKeys.end(); i != End; ++i) {
326 void Input::setError(const Twine &Message) {
327 this->setError(CurrentNode, Message);
330 //===----------------------------------------------------------------------===//
332 //===----------------------------------------------------------------------===//
334 Output::Output(raw_ostream &yout, void *context)
338 ColumnAtFlowStart(0),
339 NeedBitValueComma(false),
340 NeedFlowSequenceComma(false),
341 EnumerationMatchFound(false),
342 NeedsNewLine(false) {
348 bool Output::outputting() {
352 void Output::beginMapping() {
353 StateStack.push_back(inMapFirstKey);
357 void Output::endMapping() {
358 StateStack.pop_back();
361 bool Output::preflightKey(const char *Key, bool Required, bool SameAsDefault,
362 bool &UseDefault, void *&) {
364 if (Required || !SameAsDefault) {
365 this->newLineCheck();
366 this->paddedKey(Key);
372 void Output::postflightKey(void *) {
373 if (StateStack.back() == inMapFirstKey) {
374 StateStack.pop_back();
375 StateStack.push_back(inMapOtherKey);
379 void Output::beginDocuments() {
380 this->outputUpToEndOfLine("---");
383 bool Output::preflightDocument(unsigned index) {
385 this->outputUpToEndOfLine("\n---");
389 void Output::postflightDocument() {
392 void Output::endDocuments() {
396 unsigned Output::beginSequence() {
397 StateStack.push_back(inSeq);
402 void Output::endSequence() {
403 StateStack.pop_back();
406 bool Output::preflightElement(unsigned, void *&) {
410 void Output::postflightElement(void *) {
413 unsigned Output::beginFlowSequence() {
414 this->newLineCheck();
415 StateStack.push_back(inFlowSeq);
416 ColumnAtFlowStart = Column;
418 NeedFlowSequenceComma = false;
422 void Output::endFlowSequence() {
423 StateStack.pop_back();
424 this->outputUpToEndOfLine(" ]");
427 bool Output::preflightFlowElement(unsigned, void *&) {
428 if (NeedFlowSequenceComma)
432 for (int i = 0; i < ColumnAtFlowStart; ++i)
434 Column = ColumnAtFlowStart;
440 void Output::postflightFlowElement(void *) {
441 NeedFlowSequenceComma = true;
444 void Output::beginEnumScalar() {
445 EnumerationMatchFound = false;
448 bool Output::matchEnumScalar(const char *Str, bool Match) {
449 if (Match && !EnumerationMatchFound) {
450 this->newLineCheck();
451 this->outputUpToEndOfLine(Str);
452 EnumerationMatchFound = true;
457 void Output::endEnumScalar() {
458 if (!EnumerationMatchFound)
459 llvm_unreachable("bad runtime enum value");
462 bool Output::beginBitSetScalar(bool &DoClear) {
463 this->newLineCheck();
465 NeedBitValueComma = false;
470 bool Output::bitSetMatch(const char *Str, bool Matches) {
472 if (NeedBitValueComma)
475 NeedBitValueComma = true;
480 void Output::endBitSetScalar() {
481 this->outputUpToEndOfLine(" ]");
484 void Output::scalarString(StringRef &S) {
485 this->newLineCheck();
486 if (S.find('\n') == StringRef::npos) {
487 // No embedded new-line chars, just print string.
488 this->outputUpToEndOfLine(S);
493 unsigned End = S.size();
494 output("'"); // Starting single quote.
495 const char *Base = S.data();
497 // Escape a single quote by doubling it.
499 output(StringRef(&Base[i], j - i + 1));
505 output(StringRef(&Base[i], j - i));
506 this->outputUpToEndOfLine("'"); // Ending single quote.
509 void Output::setError(const Twine &message) {
512 void Output::output(StringRef s) {
517 void Output::outputUpToEndOfLine(StringRef s) {
519 if (StateStack.empty() || StateStack.back() != inFlowSeq)
523 void Output::outputNewLine() {
528 // if seq at top, indent as if map, then add "- "
529 // if seq in middle, use "- " if firstKey, else use " "
532 void Output::newLineCheck() {
535 NeedsNewLine = false;
537 this->outputNewLine();
539 assert(StateStack.size() > 0);
540 unsigned Indent = StateStack.size() - 1;
541 bool OutputDash = false;
543 if (StateStack.back() == inSeq) {
545 } else if ((StateStack.size() > 1) && (StateStack.back() == inMapFirstKey) &&
546 (StateStack[StateStack.size() - 2] == inSeq)) {
551 for (unsigned i = 0; i < Indent; ++i) {
560 void Output::paddedKey(StringRef key) {
563 const char *spaces = " ";
564 if (key.size() < strlen(spaces))
565 output(&spaces[key.size()]);
570 //===----------------------------------------------------------------------===//
571 // traits for built-in types
572 //===----------------------------------------------------------------------===//
574 void ScalarTraits<bool>::output(const bool &Val, void *, raw_ostream &Out) {
575 Out << (Val ? "true" : "false");
578 StringRef ScalarTraits<bool>::input(StringRef Scalar, void *, bool &Val) {
579 if (Scalar.equals("true")) {
582 } else if (Scalar.equals("false")) {
586 return "invalid boolean";
589 void ScalarTraits<StringRef>::output(const StringRef &Val, void *,
594 StringRef ScalarTraits<StringRef>::input(StringRef Scalar, void *,
600 void ScalarTraits<uint8_t>::output(const uint8_t &Val, void *,
602 // use temp uin32_t because ostream thinks uint8_t is a character
607 StringRef ScalarTraits<uint8_t>::input(StringRef Scalar, void *, uint8_t &Val) {
608 unsigned long long n;
609 if (getAsUnsignedInteger(Scalar, 0, n))
610 return "invalid number";
612 return "out of range number";
617 void ScalarTraits<uint16_t>::output(const uint16_t &Val, void *,
622 StringRef ScalarTraits<uint16_t>::input(StringRef Scalar, void *,
624 unsigned long long n;
625 if (getAsUnsignedInteger(Scalar, 0, n))
626 return "invalid number";
628 return "out of range number";
633 void ScalarTraits<uint32_t>::output(const uint32_t &Val, void *,
638 StringRef ScalarTraits<uint32_t>::input(StringRef Scalar, void *,
640 unsigned long long n;
641 if (getAsUnsignedInteger(Scalar, 0, n))
642 return "invalid number";
643 if (n > 0xFFFFFFFFUL)
644 return "out of range number";
649 void ScalarTraits<uint64_t>::output(const uint64_t &Val, void *,
654 StringRef ScalarTraits<uint64_t>::input(StringRef Scalar, void *,
656 unsigned long long N;
657 if (getAsUnsignedInteger(Scalar, 0, N))
658 return "invalid number";
663 void ScalarTraits<int8_t>::output(const int8_t &Val, void *, raw_ostream &Out) {
664 // use temp in32_t because ostream thinks int8_t is a character
669 StringRef ScalarTraits<int8_t>::input(StringRef Scalar, void *, int8_t &Val) {
671 if (getAsSignedInteger(Scalar, 0, N))
672 return "invalid number";
673 if ((N > 127) || (N < -128))
674 return "out of range number";
679 void ScalarTraits<int16_t>::output(const int16_t &Val, void *,
684 StringRef ScalarTraits<int16_t>::input(StringRef Scalar, void *, int16_t &Val) {
686 if (getAsSignedInteger(Scalar, 0, N))
687 return "invalid number";
688 if ((N > INT16_MAX) || (N < INT16_MIN))
689 return "out of range number";
694 void ScalarTraits<int32_t>::output(const int32_t &Val, void *,
699 StringRef ScalarTraits<int32_t>::input(StringRef Scalar, void *, int32_t &Val) {
701 if (getAsSignedInteger(Scalar, 0, N))
702 return "invalid number";
703 if ((N > INT32_MAX) || (N < INT32_MIN))
704 return "out of range number";
709 void ScalarTraits<int64_t>::output(const int64_t &Val, void *,
714 StringRef ScalarTraits<int64_t>::input(StringRef Scalar, void *, int64_t &Val) {
716 if (getAsSignedInteger(Scalar, 0, N))
717 return "invalid number";
722 void ScalarTraits<double>::output(const double &Val, void *, raw_ostream &Out) {
723 Out << format("%g", Val);
726 StringRef ScalarTraits<double>::input(StringRef Scalar, void *, double &Val) {
727 SmallString<32> buff(Scalar.begin(), Scalar.end());
729 Val = strtod(buff.c_str(), &end);
731 return "invalid floating point number";
735 void ScalarTraits<float>::output(const float &Val, void *, raw_ostream &Out) {
736 Out << format("%g", Val);
739 StringRef ScalarTraits<float>::input(StringRef Scalar, void *, float &Val) {
740 SmallString<32> buff(Scalar.begin(), Scalar.end());
742 Val = strtod(buff.c_str(), &end);
744 return "invalid floating point number";
748 void ScalarTraits<Hex8>::output(const Hex8 &Val, void *, raw_ostream &Out) {
750 Out << format("0x%02X", Num);
753 StringRef ScalarTraits<Hex8>::input(StringRef Scalar, void *, Hex8 &Val) {
754 unsigned long long n;
755 if (getAsUnsignedInteger(Scalar, 0, n))
756 return "invalid hex8 number";
758 return "out of range hex8 number";
763 void ScalarTraits<Hex16>::output(const Hex16 &Val, void *, raw_ostream &Out) {
765 Out << format("0x%04X", Num);
768 StringRef ScalarTraits<Hex16>::input(StringRef Scalar, void *, Hex16 &Val) {
769 unsigned long long n;
770 if (getAsUnsignedInteger(Scalar, 0, n))
771 return "invalid hex16 number";
773 return "out of range hex16 number";
778 void ScalarTraits<Hex32>::output(const Hex32 &Val, void *, raw_ostream &Out) {
780 Out << format("0x%08X", Num);
783 StringRef ScalarTraits<Hex32>::input(StringRef Scalar, void *, Hex32 &Val) {
784 unsigned long long n;
785 if (getAsUnsignedInteger(Scalar, 0, n))
786 return "invalid hex32 number";
787 if (n > 0xFFFFFFFFUL)
788 return "out of range hex32 number";
793 void ScalarTraits<Hex64>::output(const Hex64 &Val, void *, raw_ostream &Out) {
795 Out << format("0x%016llX", Num);
798 StringRef ScalarTraits<Hex64>::input(StringRef Scalar, void *, Hex64 &Val) {
799 unsigned long long Num;
800 if (getAsUnsignedInteger(Scalar, 0, Num))
801 return "invalid hex64 number";