1 //===- unittest/Support/YAMLIOTest.cpp ------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/ADT/SmallString.h"
11 #include "llvm/ADT/Twine.h"
12 #include "llvm/Support/Casting.h"
13 #include "llvm/Support/Format.h"
14 #include "llvm/Support/YAMLTraits.h"
15 #include "gtest/gtest.h"
18 using llvm::yaml::Input;
19 using llvm::yaml::Output;
21 using llvm::yaml::MappingTraits;
22 using llvm::yaml::MappingNormalization;
23 using llvm::yaml::ScalarTraits;
24 using llvm::yaml::Hex8;
25 using llvm::yaml::Hex16;
26 using llvm::yaml::Hex32;
27 using llvm::yaml::Hex64;
32 static void suppressErrorMessages(const llvm::SMDiagnostic &, void *) {
37 //===----------------------------------------------------------------------===//
39 //===----------------------------------------------------------------------===//
45 typedef std::vector<FooBar> FooBarSequence;
47 LLVM_YAML_IS_SEQUENCE_VECTOR(FooBar)
49 struct FooBarContainer {
56 struct MappingTraits<FooBar> {
57 static void mapping(IO &io, FooBar& fb) {
58 io.mapRequired("foo", fb.foo);
59 io.mapRequired("bar", fb.bar);
63 template <> struct MappingTraits<FooBarContainer> {
64 static void mapping(IO &io, FooBarContainer &fb) {
65 io.mapRequired("fbs", fb.fbs);
73 // Test the reading of a yaml mapping
75 TEST(YAMLIO, TestMapRead) {
78 Input yin("---\nfoo: 3\nbar: 5\n...\n");
81 EXPECT_FALSE(yin.error());
82 EXPECT_EQ(doc.foo, 3);
83 EXPECT_EQ(doc.bar, 5);
87 Input yin("{foo: 3, bar: 5}");
90 EXPECT_FALSE(yin.error());
91 EXPECT_EQ(doc.foo, 3);
92 EXPECT_EQ(doc.bar, 5);
96 TEST(YAMLIO, TestMalformedMapRead) {
98 Input yin("{foo: 3; bar: 5}", nullptr, suppressErrorMessages);
100 EXPECT_TRUE(!!yin.error());
104 // Test the reading of a yaml sequence of mappings
106 TEST(YAMLIO, TestSequenceMapRead) {
108 Input yin("---\n - foo: 3\n bar: 5\n - foo: 7\n bar: 9\n...\n");
111 EXPECT_FALSE(yin.error());
112 EXPECT_EQ(seq.size(), 2UL);
113 FooBar& map1 = seq[0];
114 FooBar& map2 = seq[1];
115 EXPECT_EQ(map1.foo, 3);
116 EXPECT_EQ(map1.bar, 5);
117 EXPECT_EQ(map2.foo, 7);
118 EXPECT_EQ(map2.bar, 9);
122 // Test the reading of a map containing a yaml sequence of mappings
124 TEST(YAMLIO, TestContainerSequenceMapRead) {
126 FooBarContainer cont;
127 Input yin2("---\nfbs:\n - foo: 3\n bar: 5\n - foo: 7\n bar: 9\n...\n");
130 EXPECT_FALSE(yin2.error());
131 EXPECT_EQ(cont.fbs.size(), 2UL);
132 EXPECT_EQ(cont.fbs[0].foo, 3);
133 EXPECT_EQ(cont.fbs[0].bar, 5);
134 EXPECT_EQ(cont.fbs[1].foo, 7);
135 EXPECT_EQ(cont.fbs[1].bar, 9);
139 FooBarContainer cont;
140 Input yin("---\nfbs:\n...\n");
142 // Okay: Empty node represents an empty array.
143 EXPECT_FALSE(yin.error());
144 EXPECT_EQ(cont.fbs.size(), 0UL);
148 FooBarContainer cont;
149 Input yin("---\nfbs: !!null null\n...\n");
151 // Okay: null represents an empty array.
152 EXPECT_FALSE(yin.error());
153 EXPECT_EQ(cont.fbs.size(), 0UL);
157 FooBarContainer cont;
158 Input yin("---\nfbs: ~\n...\n");
160 // Okay: null represents an empty array.
161 EXPECT_FALSE(yin.error());
162 EXPECT_EQ(cont.fbs.size(), 0UL);
166 FooBarContainer cont;
167 Input yin("---\nfbs: null\n...\n");
169 // Okay: null represents an empty array.
170 EXPECT_FALSE(yin.error());
171 EXPECT_EQ(cont.fbs.size(), 0UL);
176 // Test the reading of a map containing a malformed yaml sequence
178 TEST(YAMLIO, TestMalformedContainerSequenceMapRead) {
180 FooBarContainer cont;
181 Input yin("---\nfbs:\n foo: 3\n bar: 5\n...\n", nullptr,
182 suppressErrorMessages);
184 // Error: fbs is not a sequence.
185 EXPECT_TRUE(!!yin.error());
186 EXPECT_EQ(cont.fbs.size(), 0UL);
190 FooBarContainer cont;
191 Input yin("---\nfbs: 'scalar'\n...\n", nullptr, suppressErrorMessages);
193 // This should be an error.
194 EXPECT_TRUE(!!yin.error());
195 EXPECT_EQ(cont.fbs.size(), 0UL);
200 // Test writing then reading back a sequence of mappings
202 TEST(YAMLIO, TestSequenceMapWriteAndRead) {
203 std::string intermediate;
212 seq.push_back(entry1);
213 seq.push_back(entry2);
215 llvm::raw_string_ostream ostr(intermediate);
221 Input yin(intermediate);
225 EXPECT_FALSE(yin.error());
226 EXPECT_EQ(seq2.size(), 2UL);
227 FooBar& map1 = seq2[0];
228 FooBar& map2 = seq2[1];
229 EXPECT_EQ(map1.foo, 10);
230 EXPECT_EQ(map1.bar, -3);
231 EXPECT_EQ(map2.foo, 257);
232 EXPECT_EQ(map2.bar, 0);
237 //===----------------------------------------------------------------------===//
238 // Test built-in types
239 //===----------------------------------------------------------------------===//
241 struct BuiltInTypes {
264 struct MappingTraits<BuiltInTypes> {
265 static void mapping(IO &io, BuiltInTypes& bt) {
266 io.mapRequired("str", bt.str);
267 io.mapRequired("stdstr", bt.stdstr);
268 io.mapRequired("u64", bt.u64);
269 io.mapRequired("u32", bt.u32);
270 io.mapRequired("u16", bt.u16);
271 io.mapRequired("u8", bt.u8);
272 io.mapRequired("b", bt.b);
273 io.mapRequired("s64", bt.s64);
274 io.mapRequired("s32", bt.s32);
275 io.mapRequired("s16", bt.s16);
276 io.mapRequired("s8", bt.s8);
277 io.mapRequired("f", bt.f);
278 io.mapRequired("d", bt.d);
279 io.mapRequired("h8", bt.h8);
280 io.mapRequired("h16", bt.h16);
281 io.mapRequired("h32", bt.h32);
282 io.mapRequired("h64", bt.h64);
290 // Test the reading of all built-in scalar conversions
292 TEST(YAMLIO, TestReadBuiltInTypes) {
296 "stdstr: hello where?\n"
311 "h64: 0xFEDCBA9876543210\n"
315 EXPECT_FALSE(yin.error());
316 EXPECT_TRUE(map.str.equals("hello there"));
317 EXPECT_TRUE(map.stdstr == "hello where?");
318 EXPECT_EQ(map.u64, 5000000000ULL);
319 EXPECT_EQ(map.u32, 4000000000U);
320 EXPECT_EQ(map.u16, 65000);
321 EXPECT_EQ(map.u8, 255);
322 EXPECT_EQ(map.b, false);
323 EXPECT_EQ(map.s64, -5000000000LL);
324 EXPECT_EQ(map.s32, -2000000000L);
325 EXPECT_EQ(map.s16, -32000);
326 EXPECT_EQ(map.s8, -127);
327 EXPECT_EQ(map.f, 137.125);
328 EXPECT_EQ(map.d, -2.8625);
329 EXPECT_EQ(map.h8, Hex8(255));
330 EXPECT_EQ(map.h16, Hex16(0x8765));
331 EXPECT_EQ(map.h32, Hex32(0xFEDCBA98));
332 EXPECT_EQ(map.h64, Hex64(0xFEDCBA9876543210LL));
337 // Test writing then reading back all built-in scalar types
339 TEST(YAMLIO, TestReadWriteBuiltInTypes) {
340 std::string intermediate;
344 map.stdstr = "three four";
345 map.u64 = 6000000000ULL;
346 map.u32 = 3000000000U;
350 map.s64 = -6000000000LL;
351 map.s32 = -2000000000;
358 map.h32 = 3000000000U;
359 map.h64 = 6000000000LL;
361 llvm::raw_string_ostream ostr(intermediate);
367 Input yin(intermediate);
371 EXPECT_FALSE(yin.error());
372 EXPECT_TRUE(map.str.equals("one two"));
373 EXPECT_TRUE(map.stdstr == "three four");
374 EXPECT_EQ(map.u64, 6000000000ULL);
375 EXPECT_EQ(map.u32, 3000000000U);
376 EXPECT_EQ(map.u16, 50000);
377 EXPECT_EQ(map.u8, 254);
378 EXPECT_EQ(map.b, true);
379 EXPECT_EQ(map.s64, -6000000000LL);
380 EXPECT_EQ(map.s32, -2000000000L);
381 EXPECT_EQ(map.s16, -32000);
382 EXPECT_EQ(map.s8, -128);
383 EXPECT_EQ(map.f, 3.25);
384 EXPECT_EQ(map.d, -2.8625);
385 EXPECT_EQ(map.h8, Hex8(254));
386 EXPECT_EQ(map.h16, Hex16(50000));
387 EXPECT_EQ(map.h32, Hex32(3000000000U));
388 EXPECT_EQ(map.h64, Hex64(6000000000LL));
393 llvm::StringRef str1;
394 llvm::StringRef str2;
395 llvm::StringRef str3;
396 llvm::StringRef str4;
397 llvm::StringRef str5;
398 llvm::StringRef str6;
399 llvm::StringRef str7;
400 llvm::StringRef str8;
401 llvm::StringRef str9;
402 llvm::StringRef str10;
403 llvm::StringRef str11;
413 std::string stdstr10;
414 std::string stdstr11;
420 struct MappingTraits<StringTypes> {
421 static void mapping(IO &io, StringTypes& st) {
422 io.mapRequired("str1", st.str1);
423 io.mapRequired("str2", st.str2);
424 io.mapRequired("str3", st.str3);
425 io.mapRequired("str4", st.str4);
426 io.mapRequired("str5", st.str5);
427 io.mapRequired("str6", st.str6);
428 io.mapRequired("str7", st.str7);
429 io.mapRequired("str8", st.str8);
430 io.mapRequired("str9", st.str9);
431 io.mapRequired("str10", st.str10);
432 io.mapRequired("str11", st.str11);
433 io.mapRequired("stdstr1", st.stdstr1);
434 io.mapRequired("stdstr2", st.stdstr2);
435 io.mapRequired("stdstr3", st.stdstr3);
436 io.mapRequired("stdstr4", st.stdstr4);
437 io.mapRequired("stdstr5", st.stdstr5);
438 io.mapRequired("stdstr6", st.stdstr6);
439 io.mapRequired("stdstr7", st.stdstr7);
440 io.mapRequired("stdstr8", st.stdstr8);
441 io.mapRequired("stdstr9", st.stdstr9);
442 io.mapRequired("stdstr10", st.stdstr10);
443 io.mapRequired("stdstr11", st.stdstr11);
449 TEST(YAMLIO, TestReadWriteStringTypes) {
450 std::string intermediate;
458 map.str6 = "0000000004000000";
462 map.str10 = "0.2e20";
464 map.stdstr1 = "'eee";
465 map.stdstr2 = "\"fff";
466 map.stdstr3 = "`ggg";
467 map.stdstr4 = "@hhh";
469 map.stdstr6 = "0000000004000000";
470 map.stdstr7 = "true";
471 map.stdstr8 = "FALSE";
473 map.stdstr10 = "0.2e20";
474 map.stdstr11 = "0x30";
476 llvm::raw_string_ostream ostr(intermediate);
481 llvm::StringRef flowOut(intermediate);
482 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'''aaa"));
483 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'\"bbb'"));
484 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'`ccc'"));
485 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'@ddd'"));
486 EXPECT_NE(llvm::StringRef::npos, flowOut.find("''\n"));
487 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'0000000004000000'\n"));
488 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'true'\n"));
489 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'FALSE'\n"));
490 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'~'\n"));
491 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'0.2e20'\n"));
492 EXPECT_NE(llvm::StringRef::npos, flowOut.find("'0x30'\n"));
493 EXPECT_NE(std::string::npos, flowOut.find("'''eee"));
494 EXPECT_NE(std::string::npos, flowOut.find("'\"fff'"));
495 EXPECT_NE(std::string::npos, flowOut.find("'`ggg'"));
496 EXPECT_NE(std::string::npos, flowOut.find("'@hhh'"));
497 EXPECT_NE(std::string::npos, flowOut.find("''\n"));
498 EXPECT_NE(std::string::npos, flowOut.find("'0000000004000000'\n"));
501 Input yin(intermediate);
505 EXPECT_FALSE(yin.error());
506 EXPECT_TRUE(map.str1.equals("'aaa"));
507 EXPECT_TRUE(map.str2.equals("\"bbb"));
508 EXPECT_TRUE(map.str3.equals("`ccc"));
509 EXPECT_TRUE(map.str4.equals("@ddd"));
510 EXPECT_TRUE(map.str5.equals(""));
511 EXPECT_TRUE(map.str6.equals("0000000004000000"));
512 EXPECT_TRUE(map.stdstr1 == "'eee");
513 EXPECT_TRUE(map.stdstr2 == "\"fff");
514 EXPECT_TRUE(map.stdstr3 == "`ggg");
515 EXPECT_TRUE(map.stdstr4 == "@hhh");
516 EXPECT_TRUE(map.stdstr5 == "");
517 EXPECT_TRUE(map.stdstr6 == "0000000004000000");
521 //===----------------------------------------------------------------------===//
522 // Test ScalarEnumerationTraits
523 //===----------------------------------------------------------------------===//
544 struct ScalarEnumerationTraits<Colors> {
545 static void enumeration(IO &io, Colors &value) {
546 io.enumCase(value, "red", cRed);
547 io.enumCase(value, "blue", cBlue);
548 io.enumCase(value, "green", cGreen);
549 io.enumCase(value, "yellow",cYellow);
553 struct MappingTraits<ColorMap> {
554 static void mapping(IO &io, ColorMap& c) {
555 io.mapRequired("c1", c.c1);
556 io.mapRequired("c2", c.c2);
557 io.mapRequired("c3", c.c3);
558 io.mapOptional("c4", c.c4, cBlue); // supplies default
559 io.mapOptional("c5", c.c5, cYellow); // supplies default
560 io.mapOptional("c6", c.c6, cRed); // supplies default
568 // Test reading enumerated scalars
570 TEST(YAMLIO, TestEnumRead) {
580 EXPECT_FALSE(yin.error());
581 EXPECT_EQ(cBlue, map.c1);
582 EXPECT_EQ(cRed, map.c2);
583 EXPECT_EQ(cGreen, map.c3);
584 EXPECT_EQ(cBlue, map.c4); // tests default
585 EXPECT_EQ(cYellow,map.c5); // tests overridden
586 EXPECT_EQ(cRed, map.c6); // tests default
591 //===----------------------------------------------------------------------===//
592 // Test ScalarBitSetTraits
593 //===----------------------------------------------------------------------===//
602 inline MyFlags operator|(MyFlags a, MyFlags b) {
603 return static_cast<MyFlags>(
604 static_cast<uint32_t>(a) | static_cast<uint32_t>(b));
618 struct ScalarBitSetTraits<MyFlags> {
619 static void bitset(IO &io, MyFlags &value) {
620 io.bitSetCase(value, "big", flagBig);
621 io.bitSetCase(value, "flat", flagFlat);
622 io.bitSetCase(value, "round", flagRound);
623 io.bitSetCase(value, "pointy",flagPointy);
627 struct MappingTraits<FlagsMap> {
628 static void mapping(IO &io, FlagsMap& c) {
629 io.mapRequired("f1", c.f1);
630 io.mapRequired("f2", c.f2);
631 io.mapRequired("f3", c.f3);
632 io.mapOptional("f4", c.f4, MyFlags(flagRound));
640 // Test reading flow sequence representing bit-mask values
642 TEST(YAMLIO, TestFlagsRead) {
646 "f2: [ round, flat ]\n"
651 EXPECT_FALSE(yin.error());
652 EXPECT_EQ(flagBig, map.f1);
653 EXPECT_EQ(flagRound|flagFlat, map.f2);
654 EXPECT_EQ(flagNone, map.f3); // check empty set
655 EXPECT_EQ(flagRound, map.f4); // check optional key
660 // Test writing then reading back bit-mask values
662 TEST(YAMLIO, TestReadWriteFlags) {
663 std::string intermediate;
667 map.f2 = flagRound | flagFlat;
671 llvm::raw_string_ostream ostr(intermediate);
677 Input yin(intermediate);
681 EXPECT_FALSE(yin.error());
682 EXPECT_EQ(flagBig, map2.f1);
683 EXPECT_EQ(flagRound|flagFlat, map2.f2);
684 EXPECT_EQ(flagNone, map2.f3);
685 //EXPECT_EQ(flagRound, map2.f4); // check optional key
691 //===----------------------------------------------------------------------===//
693 //===----------------------------------------------------------------------===//
695 struct MyCustomType {
700 struct MyCustomTypeMap {
710 struct MappingTraits<MyCustomTypeMap> {
711 static void mapping(IO &io, MyCustomTypeMap& s) {
712 io.mapRequired("f1", s.f1);
713 io.mapRequired("f2", s.f2);
714 io.mapRequired("f3", s.f3);
717 // MyCustomType is formatted as a yaml scalar. A value of
718 // {length=3, width=4} would be represented in yaml as "3 by 4".
720 struct ScalarTraits<MyCustomType> {
721 static void output(const MyCustomType &value, void* ctxt, llvm::raw_ostream &out) {
722 out << llvm::format("%d by %d", value.length, value.width);
724 static StringRef input(StringRef scalar, void* ctxt, MyCustomType &value) {
725 size_t byStart = scalar.find("by");
726 if ( byStart != StringRef::npos ) {
727 StringRef lenStr = scalar.slice(0, byStart);
728 lenStr = lenStr.rtrim();
729 if ( lenStr.getAsInteger(0, value.length) ) {
730 return "malformed length";
732 StringRef widthStr = scalar.drop_front(byStart+2);
733 widthStr = widthStr.ltrim();
734 if ( widthStr.getAsInteger(0, value.width) ) {
735 return "malformed width";
740 return "malformed by";
743 static bool mustQuote(StringRef) { return true; }
750 // Test writing then reading back custom values
752 TEST(YAMLIO, TestReadWriteMyCustomType) {
753 std::string intermediate;
762 llvm::raw_string_ostream ostr(intermediate);
768 Input yin(intermediate);
769 MyCustomTypeMap map2;
772 EXPECT_FALSE(yin.error());
773 EXPECT_EQ(1, map2.f1.length);
774 EXPECT_EQ(4, map2.f1.width);
775 EXPECT_EQ(100, map2.f2.length);
776 EXPECT_EQ(400, map2.f2.width);
777 EXPECT_EQ(10, map2.f3);
782 //===----------------------------------------------------------------------===//
783 // Test flow sequences
784 //===----------------------------------------------------------------------===//
786 LLVM_YAML_STRONG_TYPEDEF(int, MyNumber)
787 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(MyNumber)
788 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::StringRef)
793 struct ScalarTraits<MyNumber> {
794 static void output(const MyNumber &value, void *, llvm::raw_ostream &out) {
798 static StringRef input(StringRef scalar, void *, MyNumber &value) {
800 if ( getAsSignedInteger(scalar, 0, n) )
801 return "invalid number";
806 static bool mustQuote(StringRef) { return false; }
811 struct NameAndNumbers {
812 llvm::StringRef name;
813 std::vector<llvm::StringRef> strings;
814 std::vector<MyNumber> single;
815 std::vector<MyNumber> numbers;
821 struct MappingTraits<NameAndNumbers> {
822 static void mapping(IO &io, NameAndNumbers& nn) {
823 io.mapRequired("name", nn.name);
824 io.mapRequired("strings", nn.strings);
825 io.mapRequired("single", nn.single);
826 io.mapRequired("numbers", nn.numbers);
832 typedef std::vector<MyNumber> MyNumberFlowSequence;
834 LLVM_YAML_IS_SEQUENCE_VECTOR(MyNumberFlowSequence)
836 struct NameAndNumbersFlow {
837 llvm::StringRef name;
838 std::vector<MyNumberFlowSequence> sequenceOfNumbers;
844 struct MappingTraits<NameAndNumbersFlow> {
845 static void mapping(IO &io, NameAndNumbersFlow& nn) {
846 io.mapRequired("name", nn.name);
847 io.mapRequired("sequenceOfNumbers", nn.sequenceOfNumbers);
854 // Test writing then reading back custom values
856 TEST(YAMLIO, TestReadWriteMyFlowSequence) {
857 std::string intermediate;
861 map.strings.push_back(llvm::StringRef("one"));
862 map.strings.push_back(llvm::StringRef("two"));
863 map.single.push_back(1);
864 map.numbers.push_back(10);
865 map.numbers.push_back(-30);
866 map.numbers.push_back(1024);
868 llvm::raw_string_ostream ostr(intermediate);
872 // Verify sequences were written in flow style
874 llvm::StringRef flowOut(intermediate);
875 EXPECT_NE(llvm::StringRef::npos, flowOut.find("one, two"));
876 EXPECT_NE(llvm::StringRef::npos, flowOut.find("10, -30, 1024"));
880 Input yin(intermediate);
884 EXPECT_FALSE(yin.error());
885 EXPECT_TRUE(map2.name.equals("hello"));
886 EXPECT_EQ(map2.strings.size(), 2UL);
887 EXPECT_TRUE(map2.strings[0].equals("one"));
888 EXPECT_TRUE(map2.strings[1].equals("two"));
889 EXPECT_EQ(map2.single.size(), 1UL);
890 EXPECT_EQ(1, map2.single[0]);
891 EXPECT_EQ(map2.numbers.size(), 3UL);
892 EXPECT_EQ(10, map2.numbers[0]);
893 EXPECT_EQ(-30, map2.numbers[1]);
894 EXPECT_EQ(1024, map2.numbers[2]);
900 // Test writing then reading back a sequence of flow sequences.
902 TEST(YAMLIO, TestReadWriteSequenceOfMyFlowSequence) {
903 std::string intermediate;
905 NameAndNumbersFlow map;
907 MyNumberFlowSequence single = { 0 };
908 MyNumberFlowSequence numbers = { 12, 1, -512 };
909 map.sequenceOfNumbers.push_back(single);
910 map.sequenceOfNumbers.push_back(numbers);
911 map.sequenceOfNumbers.push_back(MyNumberFlowSequence());
913 llvm::raw_string_ostream ostr(intermediate);
917 // Verify sequences were written in flow style
918 // and that the parent sequence used '-'.
920 llvm::StringRef flowOut(intermediate);
921 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- [ 0 ]"));
922 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- [ 12, 1, -512 ]"));
923 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- [ ]"));
927 Input yin(intermediate);
928 NameAndNumbersFlow map2;
931 EXPECT_FALSE(yin.error());
932 EXPECT_TRUE(map2.name.equals("hello"));
933 EXPECT_EQ(map2.sequenceOfNumbers.size(), 3UL);
934 EXPECT_EQ(map2.sequenceOfNumbers[0].size(), 1UL);
935 EXPECT_EQ(0, map2.sequenceOfNumbers[0][0]);
936 EXPECT_EQ(map2.sequenceOfNumbers[1].size(), 3UL);
937 EXPECT_EQ(12, map2.sequenceOfNumbers[1][0]);
938 EXPECT_EQ(1, map2.sequenceOfNumbers[1][1]);
939 EXPECT_EQ(-512, map2.sequenceOfNumbers[1][2]);
940 EXPECT_TRUE(map2.sequenceOfNumbers[2].empty());
944 //===----------------------------------------------------------------------===//
945 // Test normalizing/denormalizing
946 //===----------------------------------------------------------------------===//
948 LLVM_YAML_STRONG_TYPEDEF(uint32_t, TotalSeconds)
950 typedef std::vector<TotalSeconds> SecondsSequence;
952 LLVM_YAML_IS_SEQUENCE_VECTOR(TotalSeconds)
958 struct MappingTraits<TotalSeconds> {
960 class NormalizedSeconds {
962 NormalizedSeconds(IO &io)
963 : hours(0), minutes(0), seconds(0) {
965 NormalizedSeconds(IO &, TotalSeconds &secs)
967 minutes((secs - (hours*3600))/60),
970 TotalSeconds denormalize(IO &) {
971 return TotalSeconds(hours*3600 + minutes*60 + seconds);
979 static void mapping(IO &io, TotalSeconds &secs) {
980 MappingNormalization<NormalizedSeconds, TotalSeconds> keys(io, secs);
982 io.mapOptional("hours", keys->hours, (uint32_t)0);
983 io.mapOptional("minutes", keys->minutes, (uint8_t)0);
984 io.mapRequired("seconds", keys->seconds);
992 // Test the reading of a yaml sequence of mappings
994 TEST(YAMLIO, TestReadMySecondsSequence) {
996 Input yin("---\n - hours: 1\n seconds: 5\n - seconds: 59\n...\n");
999 EXPECT_FALSE(yin.error());
1000 EXPECT_EQ(seq.size(), 2UL);
1001 EXPECT_EQ(seq[0], 3605U);
1002 EXPECT_EQ(seq[1], 59U);
1007 // Test writing then reading back custom values
1009 TEST(YAMLIO, TestReadWriteMySecondsSequence) {
1010 std::string intermediate;
1012 SecondsSequence seq;
1013 seq.push_back(4000);
1017 llvm::raw_string_ostream ostr(intermediate);
1022 Input yin(intermediate);
1023 SecondsSequence seq2;
1026 EXPECT_FALSE(yin.error());
1027 EXPECT_EQ(seq2.size(), 3UL);
1028 EXPECT_EQ(seq2[0], 4000U);
1029 EXPECT_EQ(seq2[1], 500U);
1030 EXPECT_EQ(seq2[2], 59U);
1035 //===----------------------------------------------------------------------===//
1036 // Test dynamic typing
1037 //===----------------------------------------------------------------------===//
1056 struct KindAndFlags {
1057 KindAndFlags() : kind(kindA), flags(0) { }
1058 KindAndFlags(Kind k, uint32_t f) : kind(k), flags(f) { }
1063 typedef std::vector<KindAndFlags> KindAndFlagsSequence;
1065 LLVM_YAML_IS_SEQUENCE_VECTOR(KindAndFlags)
1070 struct ScalarEnumerationTraits<AFlags> {
1071 static void enumeration(IO &io, AFlags &value) {
1072 io.enumCase(value, "a1", a1);
1073 io.enumCase(value, "a2", a2);
1074 io.enumCase(value, "a3", a3);
1078 struct ScalarEnumerationTraits<BFlags> {
1079 static void enumeration(IO &io, BFlags &value) {
1080 io.enumCase(value, "b1", b1);
1081 io.enumCase(value, "b2", b2);
1082 io.enumCase(value, "b3", b3);
1086 struct ScalarEnumerationTraits<Kind> {
1087 static void enumeration(IO &io, Kind &value) {
1088 io.enumCase(value, "A", kindA);
1089 io.enumCase(value, "B", kindB);
1093 struct MappingTraits<KindAndFlags> {
1094 static void mapping(IO &io, KindAndFlags& kf) {
1095 io.mapRequired("kind", kf.kind);
1096 // Type of "flags" field varies depending on "kind" field.
1097 // Use memcpy here to avoid breaking strict aliasing rules.
1098 if (kf.kind == kindA) {
1099 AFlags aflags = static_cast<AFlags>(kf.flags);
1100 io.mapRequired("flags", aflags);
1103 BFlags bflags = static_cast<BFlags>(kf.flags);
1104 io.mapRequired("flags", bflags);
1114 // Test the reading of a yaml sequence dynamic types
1116 TEST(YAMLIO, TestReadKindAndFlagsSequence) {
1117 KindAndFlagsSequence seq;
1118 Input yin("---\n - kind: A\n flags: a2\n - kind: B\n flags: b1\n...\n");
1121 EXPECT_FALSE(yin.error());
1122 EXPECT_EQ(seq.size(), 2UL);
1123 EXPECT_EQ(seq[0].kind, kindA);
1124 EXPECT_EQ(seq[0].flags, (uint32_t)a2);
1125 EXPECT_EQ(seq[1].kind, kindB);
1126 EXPECT_EQ(seq[1].flags, (uint32_t)b1);
1130 // Test writing then reading back dynamic types
1132 TEST(YAMLIO, TestReadWriteKindAndFlagsSequence) {
1133 std::string intermediate;
1135 KindAndFlagsSequence seq;
1136 seq.push_back(KindAndFlags(kindA,a1));
1137 seq.push_back(KindAndFlags(kindB,b1));
1138 seq.push_back(KindAndFlags(kindA,a2));
1139 seq.push_back(KindAndFlags(kindB,b2));
1140 seq.push_back(KindAndFlags(kindA,a3));
1142 llvm::raw_string_ostream ostr(intermediate);
1147 Input yin(intermediate);
1148 KindAndFlagsSequence seq2;
1151 EXPECT_FALSE(yin.error());
1152 EXPECT_EQ(seq2.size(), 5UL);
1153 EXPECT_EQ(seq2[0].kind, kindA);
1154 EXPECT_EQ(seq2[0].flags, (uint32_t)a1);
1155 EXPECT_EQ(seq2[1].kind, kindB);
1156 EXPECT_EQ(seq2[1].flags, (uint32_t)b1);
1157 EXPECT_EQ(seq2[2].kind, kindA);
1158 EXPECT_EQ(seq2[2].flags, (uint32_t)a2);
1159 EXPECT_EQ(seq2[3].kind, kindB);
1160 EXPECT_EQ(seq2[3].flags, (uint32_t)b2);
1161 EXPECT_EQ(seq2[4].kind, kindA);
1162 EXPECT_EQ(seq2[4].flags, (uint32_t)a3);
1167 //===----------------------------------------------------------------------===//
1168 // Test document list
1169 //===----------------------------------------------------------------------===//
1175 typedef std::vector<FooBarMap> FooBarMapDocumentList;
1177 LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(FooBarMap)
1183 struct MappingTraits<FooBarMap> {
1184 static void mapping(IO &io, FooBarMap& fb) {
1185 io.mapRequired("foo", fb.foo);
1186 io.mapRequired("bar", fb.bar);
1194 // Test the reading of a yaml mapping
1196 TEST(YAMLIO, TestDocRead) {
1198 Input yin("---\nfoo: 3\nbar: 5\n...\n");
1201 EXPECT_FALSE(yin.error());
1202 EXPECT_EQ(doc.foo, 3);
1203 EXPECT_EQ(doc.bar,5);
1209 // Test writing then reading back a sequence of mappings
1211 TEST(YAMLIO, TestSequenceDocListWriteAndRead) {
1212 std::string intermediate;
1220 std::vector<FooBarMap> docList;
1221 docList.push_back(doc1);
1222 docList.push_back(doc2);
1224 llvm::raw_string_ostream ostr(intermediate);
1231 Input yin(intermediate);
1232 std::vector<FooBarMap> docList2;
1235 EXPECT_FALSE(yin.error());
1236 EXPECT_EQ(docList2.size(), 2UL);
1237 FooBarMap& map1 = docList2[0];
1238 FooBarMap& map2 = docList2[1];
1239 EXPECT_EQ(map1.foo, 10);
1240 EXPECT_EQ(map1.bar, -3);
1241 EXPECT_EQ(map2.foo, 257);
1242 EXPECT_EQ(map2.bar, 0);
1246 //===----------------------------------------------------------------------===//
1247 // Test document tags
1248 //===----------------------------------------------------------------------===//
1251 MyDouble() : value(0.0) { }
1252 MyDouble(double x) : value(x) { }
1256 LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(MyDouble)
1262 struct MappingTraits<MyDouble> {
1263 static void mapping(IO &io, MyDouble &d) {
1264 if (io.mapTag("!decimal", true)) {
1265 mappingDecimal(io, d);
1266 } else if (io.mapTag("!fraction")) {
1267 mappingFraction(io, d);
1270 static void mappingDecimal(IO &io, MyDouble &d) {
1271 io.mapRequired("value", d.value);
1273 static void mappingFraction(IO &io, MyDouble &d) {
1275 io.mapRequired("numerator", num);
1276 io.mapRequired("denominator", denom);
1277 // convert fraction to double
1278 d.value = num/denom;
1286 // Test the reading of two different tagged yaml documents.
1288 TEST(YAMLIO, TestTaggedDocuments) {
1289 std::vector<MyDouble> docList;
1290 Input yin("--- !decimal\nvalue: 3.0\n"
1291 "--- !fraction\nnumerator: 9.0\ndenominator: 2\n...\n");
1293 EXPECT_FALSE(yin.error());
1294 EXPECT_EQ(docList.size(), 2UL);
1295 EXPECT_EQ(docList[0].value, 3.0);
1296 EXPECT_EQ(docList[1].value, 4.5);
1302 // Test writing then reading back tagged documents
1304 TEST(YAMLIO, TestTaggedDocumentsWriteAndRead) {
1305 std::string intermediate;
1309 std::vector<MyDouble> docList;
1310 docList.push_back(a);
1311 docList.push_back(b);
1313 llvm::raw_string_ostream ostr(intermediate);
1319 Input yin(intermediate);
1320 std::vector<MyDouble> docList2;
1323 EXPECT_FALSE(yin.error());
1324 EXPECT_EQ(docList2.size(), 2UL);
1325 EXPECT_EQ(docList2[0].value, 10.25);
1326 EXPECT_EQ(docList2[1].value, -3.75);
1331 //===----------------------------------------------------------------------===//
1332 // Test mapping validation
1333 //===----------------------------------------------------------------------===//
1335 struct MyValidation {
1339 LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(MyValidation)
1344 struct MappingTraits<MyValidation> {
1345 static void mapping(IO &io, MyValidation &d) {
1346 io.mapRequired("value", d.value);
1348 static StringRef validate(IO &io, MyValidation &d) {
1350 return "negative value";
1359 // Test that validate() is called and complains about the negative value.
1361 TEST(YAMLIO, TestValidatingInput) {
1362 std::vector<MyValidation> docList;
1363 Input yin("--- \nvalue: 3.0\n"
1364 "--- \nvalue: -1.0\n...\n",
1365 nullptr, suppressErrorMessages);
1367 EXPECT_TRUE(!!yin.error());
1370 //===----------------------------------------------------------------------===//
1371 // Test flow mapping
1372 //===----------------------------------------------------------------------===//
1378 FlowFooBar() : foo(0), bar(0) {}
1379 FlowFooBar(int foo, int bar) : foo(foo), bar(bar) {}
1382 typedef std::vector<FlowFooBar> FlowFooBarSequence;
1384 LLVM_YAML_IS_SEQUENCE_VECTOR(FlowFooBar)
1386 struct FlowFooBarDoc {
1387 FlowFooBar attribute;
1388 FlowFooBarSequence seq;
1394 struct MappingTraits<FlowFooBar> {
1395 static void mapping(IO &io, FlowFooBar &fb) {
1396 io.mapRequired("foo", fb.foo);
1397 io.mapRequired("bar", fb.bar);
1400 static const bool flow = true;
1404 struct MappingTraits<FlowFooBarDoc> {
1405 static void mapping(IO &io, FlowFooBarDoc &fb) {
1406 io.mapRequired("attribute", fb.attribute);
1407 io.mapRequired("seq", fb.seq);
1414 // Test writing then reading back custom mappings
1416 TEST(YAMLIO, TestReadWriteMyFlowMapping) {
1417 std::string intermediate;
1420 doc.attribute = FlowFooBar(42, 907);
1421 doc.seq.push_back(FlowFooBar(1, 2));
1422 doc.seq.push_back(FlowFooBar(0, 0));
1423 doc.seq.push_back(FlowFooBar(-1, 1024));
1425 llvm::raw_string_ostream ostr(intermediate);
1429 // Verify that mappings were written in flow style
1431 llvm::StringRef flowOut(intermediate);
1432 EXPECT_NE(llvm::StringRef::npos, flowOut.find("{ foo: 42, bar: 907 }"));
1433 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- { foo: 1, bar: 2 }"));
1434 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- { foo: 0, bar: 0 }"));
1435 EXPECT_NE(llvm::StringRef::npos, flowOut.find("- { foo: -1, bar: 1024 }"));
1439 Input yin(intermediate);
1443 EXPECT_FALSE(yin.error());
1444 EXPECT_EQ(doc2.attribute.foo, 42);
1445 EXPECT_EQ(doc2.attribute.bar, 907);
1446 EXPECT_EQ(doc2.seq.size(), 3UL);
1447 EXPECT_EQ(doc2.seq[0].foo, 1);
1448 EXPECT_EQ(doc2.seq[0].bar, 2);
1449 EXPECT_EQ(doc2.seq[1].foo, 0);
1450 EXPECT_EQ(doc2.seq[1].bar, 0);
1451 EXPECT_EQ(doc2.seq[2].foo, -1);
1452 EXPECT_EQ(doc2.seq[2].bar, 1024);
1456 //===----------------------------------------------------------------------===//
1457 // Test error handling
1458 //===----------------------------------------------------------------------===//
1461 // Test error handling of unknown enumerated scalar
1463 TEST(YAMLIO, TestColorsReadError) {
1471 suppressErrorMessages);
1473 EXPECT_TRUE(!!yin.error());
1478 // Test error handling of flow sequence with unknown value
1480 TEST(YAMLIO, TestFlagsReadError) {
1484 "f2: [ round, hollow ]\n"
1488 suppressErrorMessages);
1491 EXPECT_TRUE(!!yin.error());
1496 // Test error handling reading built-in uint8_t type
1498 LLVM_YAML_IS_SEQUENCE_VECTOR(uint8_t)
1499 TEST(YAMLIO, TestReadBuiltInTypesUint8Error) {
1500 std::vector<uint8_t> seq;
1507 suppressErrorMessages);
1510 EXPECT_TRUE(!!yin.error());
1515 // Test error handling reading built-in uint16_t type
1517 LLVM_YAML_IS_SEQUENCE_VECTOR(uint16_t)
1518 TEST(YAMLIO, TestReadBuiltInTypesUint16Error) {
1519 std::vector<uint16_t> seq;
1526 suppressErrorMessages);
1529 EXPECT_TRUE(!!yin.error());
1534 // Test error handling reading built-in uint32_t type
1536 LLVM_YAML_IS_SEQUENCE_VECTOR(uint32_t)
1537 TEST(YAMLIO, TestReadBuiltInTypesUint32Error) {
1538 std::vector<uint32_t> seq;
1545 suppressErrorMessages);
1548 EXPECT_TRUE(!!yin.error());
1553 // Test error handling reading built-in uint64_t type
1555 LLVM_YAML_IS_SEQUENCE_VECTOR(uint64_t)
1556 TEST(YAMLIO, TestReadBuiltInTypesUint64Error) {
1557 std::vector<uint64_t> seq;
1559 "- 18446744073709551615\n"
1561 "- 19446744073709551615\n"
1564 suppressErrorMessages);
1567 EXPECT_TRUE(!!yin.error());
1572 // Test error handling reading built-in int8_t type
1574 LLVM_YAML_IS_SEQUENCE_VECTOR(int8_t)
1575 TEST(YAMLIO, TestReadBuiltInTypesint8OverError) {
1576 std::vector<int8_t> seq;
1584 suppressErrorMessages);
1587 EXPECT_TRUE(!!yin.error());
1591 // Test error handling reading built-in int8_t type
1593 TEST(YAMLIO, TestReadBuiltInTypesint8UnderError) {
1594 std::vector<int8_t> seq;
1602 suppressErrorMessages);
1605 EXPECT_TRUE(!!yin.error());
1610 // Test error handling reading built-in int16_t type
1612 LLVM_YAML_IS_SEQUENCE_VECTOR(int16_t)
1613 TEST(YAMLIO, TestReadBuiltInTypesint16UnderError) {
1614 std::vector<int16_t> seq;
1622 suppressErrorMessages);
1625 EXPECT_TRUE(!!yin.error());
1630 // Test error handling reading built-in int16_t type
1632 TEST(YAMLIO, TestReadBuiltInTypesint16OverError) {
1633 std::vector<int16_t> seq;
1641 suppressErrorMessages);
1644 EXPECT_TRUE(!!yin.error());
1649 // Test error handling reading built-in int32_t type
1651 LLVM_YAML_IS_SEQUENCE_VECTOR(int32_t)
1652 TEST(YAMLIO, TestReadBuiltInTypesint32UnderError) {
1653 std::vector<int32_t> seq;
1661 suppressErrorMessages);
1664 EXPECT_TRUE(!!yin.error());
1668 // Test error handling reading built-in int32_t type
1670 TEST(YAMLIO, TestReadBuiltInTypesint32OverError) {
1671 std::vector<int32_t> seq;
1679 suppressErrorMessages);
1682 EXPECT_TRUE(!!yin.error());
1687 // Test error handling reading built-in int64_t type
1689 LLVM_YAML_IS_SEQUENCE_VECTOR(int64_t)
1690 TEST(YAMLIO, TestReadBuiltInTypesint64UnderError) {
1691 std::vector<int64_t> seq;
1693 "- -9223372036854775808\n"
1695 "- 9223372036854775807\n"
1696 "- -9223372036854775809\n"
1699 suppressErrorMessages);
1702 EXPECT_TRUE(!!yin.error());
1706 // Test error handling reading built-in int64_t type
1708 TEST(YAMLIO, TestReadBuiltInTypesint64OverError) {
1709 std::vector<int64_t> seq;
1711 "- -9223372036854775808\n"
1713 "- 9223372036854775807\n"
1714 "- 9223372036854775809\n"
1717 suppressErrorMessages);
1720 EXPECT_TRUE(!!yin.error());
1724 // Test error handling reading built-in float type
1726 LLVM_YAML_IS_SEQUENCE_VECTOR(float)
1727 TEST(YAMLIO, TestReadBuiltInTypesFloatError) {
1728 std::vector<float> seq;
1736 suppressErrorMessages);
1739 EXPECT_TRUE(!!yin.error());
1743 // Test error handling reading built-in float type
1745 LLVM_YAML_IS_SEQUENCE_VECTOR(double)
1746 TEST(YAMLIO, TestReadBuiltInTypesDoubleError) {
1747 std::vector<double> seq;
1755 suppressErrorMessages);
1758 EXPECT_TRUE(!!yin.error());
1762 // Test error handling reading built-in Hex8 type
1764 LLVM_YAML_IS_SEQUENCE_VECTOR(Hex8)
1765 TEST(YAMLIO, TestReadBuiltInTypesHex8Error) {
1766 std::vector<Hex8> seq;
1773 suppressErrorMessages);
1776 EXPECT_TRUE(!!yin.error());
1781 // Test error handling reading built-in Hex16 type
1783 LLVM_YAML_IS_SEQUENCE_VECTOR(Hex16)
1784 TEST(YAMLIO, TestReadBuiltInTypesHex16Error) {
1785 std::vector<Hex16> seq;
1792 suppressErrorMessages);
1795 EXPECT_TRUE(!!yin.error());
1799 // Test error handling reading built-in Hex32 type
1801 LLVM_YAML_IS_SEQUENCE_VECTOR(Hex32)
1802 TEST(YAMLIO, TestReadBuiltInTypesHex32Error) {
1803 std::vector<Hex32> seq;
1810 suppressErrorMessages);
1813 EXPECT_TRUE(!!yin.error());
1817 // Test error handling reading built-in Hex64 type
1819 LLVM_YAML_IS_SEQUENCE_VECTOR(Hex64)
1820 TEST(YAMLIO, TestReadBuiltInTypesHex64Error) {
1821 std::vector<Hex64> seq;
1824 "- 0xFFEEDDCCBBAA9988\n"
1825 "- 0x12345567890ABCDEF0\n"
1828 suppressErrorMessages);
1831 EXPECT_TRUE(!!yin.error());
1834 TEST(YAMLIO, TestMalformedMapFailsGracefully) {
1837 // We pass the suppressErrorMessages handler to handle the error
1838 // message generated in the constructor of Input.
1839 Input yin("{foo:3, bar: 5}", /*Ctxt=*/nullptr, suppressErrorMessages);
1841 EXPECT_TRUE(!!yin.error());
1845 Input yin("---\nfoo:3\nbar: 5\n...\n", /*Ctxt=*/nullptr, suppressErrorMessages);
1847 EXPECT_TRUE(!!yin.error());
1851 struct OptionalTest {
1852 std::vector<int> Numbers;
1855 struct OptionalTestSeq {
1856 std::vector<OptionalTest> Tests;
1859 LLVM_YAML_IS_SEQUENCE_VECTOR(OptionalTest)
1863 struct MappingTraits<OptionalTest> {
1864 static void mapping(IO& IO, OptionalTest &OT) {
1865 IO.mapOptional("Numbers", OT.Numbers);
1870 struct MappingTraits<OptionalTestSeq> {
1871 static void mapping(IO &IO, OptionalTestSeq &OTS) {
1872 IO.mapOptional("Tests", OTS.Tests);
1878 TEST(YAMLIO, SequenceElideTest) {
1879 // Test that writing out a purely optional structure with its fields set to
1880 // default followed by other data is properly read back in.
1881 OptionalTestSeq Seq;
1882 OptionalTest One, Two, Three, Four;
1883 int N[] = {1, 2, 3};
1884 Three.Numbers.assign(N, N + 3);
1885 Seq.Tests.push_back(One);
1886 Seq.Tests.push_back(Two);
1887 Seq.Tests.push_back(Three);
1888 Seq.Tests.push_back(Four);
1890 std::string intermediate;
1892 llvm::raw_string_ostream ostr(intermediate);
1897 Input yin(intermediate);
1898 OptionalTestSeq Seq2;
1901 EXPECT_FALSE(yin.error());
1903 EXPECT_EQ(4UL, Seq2.Tests.size());
1905 EXPECT_TRUE(Seq2.Tests[0].Numbers.empty());
1906 EXPECT_TRUE(Seq2.Tests[1].Numbers.empty());
1908 EXPECT_EQ(1, Seq2.Tests[2].Numbers[0]);
1909 EXPECT_EQ(2, Seq2.Tests[2].Numbers[1]);
1910 EXPECT_EQ(3, Seq2.Tests[2].Numbers[2]);
1912 EXPECT_TRUE(Seq2.Tests[3].Numbers.empty());
1915 TEST(YAMLIO, TestEmptyStringFailsForMapWithRequiredFields) {
1919 EXPECT_TRUE(!!yin.error());
1922 TEST(YAMLIO, TestEmptyStringSucceedsForMapWithOptionalFields) {
1926 EXPECT_FALSE(yin.error());
1929 TEST(YAMLIO, TestEmptyStringSucceedsForSequence) {
1930 std::vector<uint8_t> seq;
1931 Input yin("", /*Ctxt=*/nullptr, suppressErrorMessages);
1934 EXPECT_FALSE(yin.error());
1935 EXPECT_TRUE(seq.empty());