1 //===- EnumsGenTest.cpp - TableGen EnumsGen Tests -------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "mlir/IR/BuiltinAttributes.h"
10 #include "mlir/IR/BuiltinTypes.h"
11 #include "mlir/IR/MLIRContext.h"
12 #include "mlir/Support/LLVM.h"
13
14 #include "llvm/ADT/DenseMap.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/ADT/StringSwitch.h"
17
18 #include "gmock/gmock.h"
19
20 #include <type_traits>
21
22 /// Pull in generated enum utility declarations and definitions.
23 #include "EnumsGenTest.h.inc"
24
25 #include "EnumsGenTest.cpp.inc"
26
27 /// Test namespaces and enum class/utility names.
28 using Outer::Inner::ConvertToEnum;
29 using Outer::Inner::ConvertToString;
30 using Outer::Inner::FooEnum;
31
TEST(EnumsGenTest,GeneratedStrEnumDefinition)32 TEST(EnumsGenTest, GeneratedStrEnumDefinition) {
33 EXPECT_EQ(0u, static_cast<uint64_t>(FooEnum::CaseA));
34 EXPECT_EQ(1u, static_cast<uint64_t>(FooEnum::CaseB));
35 }
36
TEST(EnumsGenTest,GeneratedI32EnumDefinition)37 TEST(EnumsGenTest, GeneratedI32EnumDefinition) {
38 EXPECT_EQ(5u, static_cast<uint64_t>(I32Enum::Case5));
39 EXPECT_EQ(10u, static_cast<uint64_t>(I32Enum::Case10));
40 }
41
TEST(EnumsGenTest,GeneratedDenseMapInfo)42 TEST(EnumsGenTest, GeneratedDenseMapInfo) {
43 llvm::DenseMap<FooEnum, std::string> myMap;
44
45 myMap[FooEnum::CaseA] = "zero";
46 myMap[FooEnum::CaseB] = "one";
47
48 EXPECT_EQ(myMap[FooEnum::CaseA], "zero");
49 EXPECT_EQ(myMap[FooEnum::CaseB], "one");
50 }
51
TEST(EnumsGenTest,GeneratedSymbolToStringFn)52 TEST(EnumsGenTest, GeneratedSymbolToStringFn) {
53 EXPECT_EQ(ConvertToString(FooEnum::CaseA), "CaseA");
54 EXPECT_EQ(ConvertToString(FooEnum::CaseB), "CaseB");
55 }
56
TEST(EnumsGenTest,GeneratedStringToSymbolFn)57 TEST(EnumsGenTest, GeneratedStringToSymbolFn) {
58 EXPECT_EQ(llvm::Optional<FooEnum>(FooEnum::CaseA), ConvertToEnum("CaseA"));
59 EXPECT_EQ(llvm::Optional<FooEnum>(FooEnum::CaseB), ConvertToEnum("CaseB"));
60 EXPECT_EQ(llvm::None, ConvertToEnum("X"));
61 }
62
TEST(EnumsGenTest,GeneratedUnderlyingType)63 TEST(EnumsGenTest, GeneratedUnderlyingType) {
64 bool v = std::is_same<uint32_t, std::underlying_type<I32Enum>::type>::value;
65 EXPECT_TRUE(v);
66 }
67
TEST(EnumsGenTest,GeneratedBitEnumDefinition)68 TEST(EnumsGenTest, GeneratedBitEnumDefinition) {
69 EXPECT_EQ(0u, static_cast<uint32_t>(BitEnumWithNone::None));
70 EXPECT_EQ(1u, static_cast<uint32_t>(BitEnumWithNone::Bit0));
71 EXPECT_EQ(8u, static_cast<uint32_t>(BitEnumWithNone::Bit3));
72
73 EXPECT_EQ(2u, static_cast<uint64_t>(BitEnum64_Test::Bit1));
74 EXPECT_EQ(144115188075855872u, static_cast<uint64_t>(BitEnum64_Test::Bit57));
75 }
76
TEST(EnumsGenTest,GeneratedSymbolToStringFnForBitEnum)77 TEST(EnumsGenTest, GeneratedSymbolToStringFnForBitEnum) {
78 EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::None), "None");
79 EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::Bit0), "Bit0");
80 EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::Bit3), "Bit3");
81 EXPECT_EQ(
82 stringifyBitEnumWithNone(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3),
83 "Bit0 | Bit3");
84
85 EXPECT_EQ(stringifyBitEnum64_Test(BitEnum64_Test::Bit1), "Bit1");
86 EXPECT_EQ(
87 stringifyBitEnum64_Test(BitEnum64_Test::Bit1 | BitEnum64_Test::Bit57),
88 "Bit1|Bit57");
89 }
90
TEST(EnumsGenTest,GeneratedStringToSymbolForBitEnum)91 TEST(EnumsGenTest, GeneratedStringToSymbolForBitEnum) {
92 EXPECT_EQ(symbolizeBitEnumWithNone("None"), BitEnumWithNone::None);
93 EXPECT_EQ(symbolizeBitEnumWithNone("Bit0"), BitEnumWithNone::Bit0);
94 EXPECT_EQ(symbolizeBitEnumWithNone("Bit3"), BitEnumWithNone::Bit3);
95 EXPECT_EQ(symbolizeBitEnumWithNone("Bit3|Bit0"),
96 BitEnumWithNone::Bit3 | BitEnumWithNone::Bit0);
97
98 EXPECT_EQ(symbolizeBitEnumWithNone("Bit2"), llvm::None);
99 EXPECT_EQ(symbolizeBitEnumWithNone("Bit3 | Bit4"), llvm::None);
100
101 EXPECT_EQ(symbolizeBitEnumWithoutNone("None"), llvm::None);
102 }
103
TEST(EnumsGenTest,GeneratedSymbolToStringFnForGroupedBitEnum)104 TEST(EnumsGenTest, GeneratedSymbolToStringFnForGroupedBitEnum) {
105 EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit0), "Bit0");
106 EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit3), "Bit3");
107 EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bits0To3),
108 "Bit0|Bit1|Bit2|Bit3|Bits0To3");
109 EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit4), "Bit4");
110 EXPECT_EQ(stringifyBitEnumWithGroup(
111 BitEnumWithGroup::Bit0 | BitEnumWithGroup::Bit1 |
112 BitEnumWithGroup::Bit2 | BitEnumWithGroup::Bit4),
113 "Bit0|Bit1|Bit2|Bit4");
114 }
115
TEST(EnumsGenTest,GeneratedStringToSymbolForGroupedBitEnum)116 TEST(EnumsGenTest, GeneratedStringToSymbolForGroupedBitEnum) {
117 EXPECT_EQ(symbolizeBitEnumWithGroup("Bit0"), BitEnumWithGroup::Bit0);
118 EXPECT_EQ(symbolizeBitEnumWithGroup("Bit3"), BitEnumWithGroup::Bit3);
119 EXPECT_EQ(symbolizeBitEnumWithGroup("Bit5"), llvm::None);
120 EXPECT_EQ(symbolizeBitEnumWithGroup("Bit3|Bit0"),
121 BitEnumWithGroup::Bit3 | BitEnumWithGroup::Bit0);
122 }
123
TEST(EnumsGenTest,GeneratedSymbolToStringFnForPrimaryGroupBitEnum)124 TEST(EnumsGenTest, GeneratedSymbolToStringFnForPrimaryGroupBitEnum) {
125 EXPECT_EQ(stringifyBitEnumPrimaryGroup(
126 BitEnumPrimaryGroup::Bit0 | BitEnumPrimaryGroup::Bit1 |
127 BitEnumPrimaryGroup::Bit2 | BitEnumPrimaryGroup::Bit3),
128 "Bits0To3");
129 EXPECT_EQ(stringifyBitEnumPrimaryGroup(BitEnumPrimaryGroup::Bit0 |
130 BitEnumPrimaryGroup::Bit2 |
131 BitEnumPrimaryGroup::Bit3),
132 "Bit0, Bit2, Bit3");
133 EXPECT_EQ(stringifyBitEnumPrimaryGroup(BitEnumPrimaryGroup::Bit0 |
134 BitEnumPrimaryGroup::Bit4 |
135 BitEnumPrimaryGroup::Bit5),
136 "Bits4And5, Bit0");
137 EXPECT_EQ(stringifyBitEnumPrimaryGroup(
138 BitEnumPrimaryGroup::Bit0 | BitEnumPrimaryGroup::Bit1 |
139 BitEnumPrimaryGroup::Bit2 | BitEnumPrimaryGroup::Bit3 |
140 BitEnumPrimaryGroup::Bit4 | BitEnumPrimaryGroup::Bit5),
141 "Bits0To5");
142 }
143
TEST(EnumsGenTest,GeneratedOperator)144 TEST(EnumsGenTest, GeneratedOperator) {
145 EXPECT_TRUE(bitEnumContains(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3,
146 BitEnumWithNone::Bit0));
147 EXPECT_FALSE(bitEnumContains(BitEnumWithNone::Bit0 & BitEnumWithNone::Bit3,
148 BitEnumWithNone::Bit0));
149 }
150
TEST(EnumsGenTest,GeneratedSymbolToCustomStringFn)151 TEST(EnumsGenTest, GeneratedSymbolToCustomStringFn) {
152 EXPECT_EQ(stringifyPrettyIntEnum(PrettyIntEnum::Case1), "case_one");
153 EXPECT_EQ(stringifyPrettyIntEnum(PrettyIntEnum::Case2), "case_two");
154 }
155
TEST(EnumsGenTest,GeneratedCustomStringToSymbolFn)156 TEST(EnumsGenTest, GeneratedCustomStringToSymbolFn) {
157 auto one = symbolizePrettyIntEnum("case_one");
158 EXPECT_TRUE(one);
159 EXPECT_EQ(*one, PrettyIntEnum::Case1);
160
161 auto two = symbolizePrettyIntEnum("case_two");
162 EXPECT_TRUE(two);
163 EXPECT_EQ(*two, PrettyIntEnum::Case2);
164
165 auto none = symbolizePrettyIntEnum("Case1");
166 EXPECT_FALSE(none);
167 }
168
TEST(EnumsGenTest,GeneratedIntAttributeClass)169 TEST(EnumsGenTest, GeneratedIntAttributeClass) {
170 mlir::MLIRContext ctx;
171 I32Enum rawVal = I32Enum::Case5;
172
173 I32EnumAttr enumAttr = I32EnumAttr::get(&ctx, rawVal);
174 EXPECT_NE(enumAttr, nullptr);
175 EXPECT_EQ(enumAttr.getValue(), rawVal);
176
177 mlir::Type intType = mlir::IntegerType::get(&ctx, 32);
178 mlir::Attribute intAttr = mlir::IntegerAttr::get(intType, 5);
179 EXPECT_TRUE(intAttr.isa<I32EnumAttr>());
180 EXPECT_EQ(intAttr, enumAttr);
181 }
182
TEST(EnumsGenTest,GeneratedBitAttributeClass)183 TEST(EnumsGenTest, GeneratedBitAttributeClass) {
184 mlir::MLIRContext ctx;
185
186 mlir::Type intType = mlir::IntegerType::get(&ctx, 32);
187 mlir::Attribute intAttr = mlir::IntegerAttr::get(
188 intType,
189 static_cast<uint32_t>(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3));
190 EXPECT_TRUE(intAttr.isa<BitEnumWithNoneAttr>());
191 EXPECT_TRUE(intAttr.isa<BitEnumWithoutNoneAttr>());
192
193 intAttr = mlir::IntegerAttr::get(
194 intType, static_cast<uint32_t>(BitEnumWithGroup::Bits0To3) | (1u << 6));
195 EXPECT_FALSE(intAttr.isa<BitEnumWithGroupAttr>());
196 }
197