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 using Outer::Inner::FooEnumAttr;
32 
33 TEST(EnumsGenTest, GeneratedStrEnumDefinition) {
34   EXPECT_EQ(0u, static_cast<uint64_t>(FooEnum::CaseA));
35   EXPECT_EQ(1u, static_cast<uint64_t>(FooEnum::CaseB));
36 }
37 
38 TEST(EnumsGenTest, GeneratedI32EnumDefinition) {
39   EXPECT_EQ(5u, static_cast<uint64_t>(I32Enum::Case5));
40   EXPECT_EQ(10u, static_cast<uint64_t>(I32Enum::Case10));
41 }
42 
43 TEST(EnumsGenTest, GeneratedDenseMapInfo) {
44   llvm::DenseMap<FooEnum, std::string> myMap;
45 
46   myMap[FooEnum::CaseA] = "zero";
47   myMap[FooEnum::CaseB] = "one";
48 
49   EXPECT_EQ(myMap[FooEnum::CaseA], "zero");
50   EXPECT_EQ(myMap[FooEnum::CaseB], "one");
51 }
52 
53 TEST(EnumsGenTest, GeneratedSymbolToStringFn) {
54   EXPECT_EQ(ConvertToString(FooEnum::CaseA), "CaseA");
55   EXPECT_EQ(ConvertToString(FooEnum::CaseB), "CaseB");
56 }
57 
58 TEST(EnumsGenTest, GeneratedStringToSymbolFn) {
59   EXPECT_EQ(llvm::Optional<FooEnum>(FooEnum::CaseA), ConvertToEnum("CaseA"));
60   EXPECT_EQ(llvm::Optional<FooEnum>(FooEnum::CaseB), ConvertToEnum("CaseB"));
61   EXPECT_EQ(llvm::None, ConvertToEnum("X"));
62 }
63 
64 TEST(EnumsGenTest, GeneratedUnderlyingType) {
65   bool v = std::is_same<uint32_t, std::underlying_type<I32Enum>::type>::value;
66   EXPECT_TRUE(v);
67 }
68 
69 TEST(EnumsGenTest, GeneratedBitEnumDefinition) {
70   EXPECT_EQ(0u, static_cast<uint32_t>(BitEnumWithNone::None));
71   EXPECT_EQ(1u, static_cast<uint32_t>(BitEnumWithNone::Bit0));
72   EXPECT_EQ(8u, static_cast<uint32_t>(BitEnumWithNone::Bit3));
73 
74   EXPECT_EQ(2u, static_cast<uint64_t>(BitEnum64_Test::Bit1));
75   EXPECT_EQ(144115188075855872u, static_cast<uint64_t>(BitEnum64_Test::Bit57));
76 }
77 
78 TEST(EnumsGenTest, GeneratedSymbolToStringFnForBitEnum) {
79   EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::None), "None");
80   EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::Bit0), "Bit0");
81   EXPECT_EQ(stringifyBitEnumWithNone(BitEnumWithNone::Bit3), "Bit3");
82   EXPECT_EQ(
83       stringifyBitEnumWithNone(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3),
84       "Bit0|Bit3");
85 
86   EXPECT_EQ(stringifyBitEnum64_Test(BitEnum64_Test::Bit1), "Bit1");
87   EXPECT_EQ(
88       stringifyBitEnum64_Test(BitEnum64_Test::Bit1 | BitEnum64_Test::Bit57),
89       "Bit1|Bit57");
90 }
91 
92 TEST(EnumsGenTest, GeneratedStringToSymbolForBitEnum) {
93   EXPECT_EQ(symbolizeBitEnumWithNone("None"), BitEnumWithNone::None);
94   EXPECT_EQ(symbolizeBitEnumWithNone("Bit0"), BitEnumWithNone::Bit0);
95   EXPECT_EQ(symbolizeBitEnumWithNone("Bit3"), BitEnumWithNone::Bit3);
96   EXPECT_EQ(symbolizeBitEnumWithNone("Bit3|Bit0"),
97             BitEnumWithNone::Bit3 | BitEnumWithNone::Bit0);
98 
99   EXPECT_EQ(symbolizeBitEnumWithNone("Bit2"), llvm::None);
100   EXPECT_EQ(symbolizeBitEnumWithNone("Bit3|Bit4"), llvm::None);
101 
102   EXPECT_EQ(symbolizeBitEnumWithoutNone("None"), llvm::None);
103 }
104 
105 TEST(EnumsGenTest, GeneratedSymbolToStringFnForGroupedBitEnum) {
106   EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit0), "Bit0");
107   EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit3), "Bit3");
108   EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bits0To3),
109             "Bit0|Bit1|Bit2|Bit3|Bits0To3");
110   EXPECT_EQ(stringifyBitEnumWithGroup(BitEnumWithGroup::Bit4), "Bit4");
111   EXPECT_EQ(stringifyBitEnumWithGroup(
112                 BitEnumWithGroup::Bit0 | BitEnumWithGroup::Bit1 |
113                 BitEnumWithGroup::Bit2 | BitEnumWithGroup::Bit4),
114             "Bit0|Bit1|Bit2|Bit4");
115 }
116 
117 TEST(EnumsGenTest, GeneratedStringToSymbolForGroupedBitEnum) {
118   EXPECT_EQ(symbolizeBitEnumWithGroup("Bit0"), BitEnumWithGroup::Bit0);
119   EXPECT_EQ(symbolizeBitEnumWithGroup("Bit3"), BitEnumWithGroup::Bit3);
120   EXPECT_EQ(symbolizeBitEnumWithGroup("Bit5"), llvm::None);
121   EXPECT_EQ(symbolizeBitEnumWithGroup("Bit3|Bit0"),
122             BitEnumWithGroup::Bit3 | BitEnumWithGroup::Bit0);
123 }
124 
125 TEST(EnumsGenTest, GeneratedSymbolToStringFnForPrimaryGroupBitEnum) {
126   EXPECT_EQ(stringifyBitEnumPrimaryGroup(
127                 BitEnumPrimaryGroup::Bit0 | BitEnumPrimaryGroup::Bit1 |
128                 BitEnumPrimaryGroup::Bit2 | BitEnumPrimaryGroup::Bit3),
129             "Bits0To3");
130   EXPECT_EQ(stringifyBitEnumPrimaryGroup(BitEnumPrimaryGroup::Bit0 |
131                                          BitEnumPrimaryGroup::Bit2 |
132                                          BitEnumPrimaryGroup::Bit3),
133             "Bit0,Bit2,Bit3");
134   EXPECT_EQ(stringifyBitEnumPrimaryGroup(BitEnumPrimaryGroup::Bit0 |
135                                          BitEnumPrimaryGroup::Bit4 |
136                                          BitEnumPrimaryGroup::Bit5),
137             "Bits4And5,Bit0");
138   EXPECT_EQ(stringifyBitEnumPrimaryGroup(
139                 BitEnumPrimaryGroup::Bit0 | BitEnumPrimaryGroup::Bit1 |
140                 BitEnumPrimaryGroup::Bit2 | BitEnumPrimaryGroup::Bit3 |
141                 BitEnumPrimaryGroup::Bit4 | BitEnumPrimaryGroup::Bit5),
142             "Bits0To5");
143 }
144 
145 TEST(EnumsGenTest, GeneratedOperator) {
146   EXPECT_TRUE(bitEnumContains(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3,
147                               BitEnumWithNone::Bit0));
148   EXPECT_FALSE(bitEnumContains(BitEnumWithNone::Bit0 & BitEnumWithNone::Bit3,
149                                BitEnumWithNone::Bit0));
150 }
151 
152 TEST(EnumsGenTest, GeneratedSymbolToCustomStringFn) {
153   EXPECT_EQ(stringifyPrettyIntEnum(PrettyIntEnum::Case1), "case_one");
154   EXPECT_EQ(stringifyPrettyIntEnum(PrettyIntEnum::Case2), "case_two");
155 }
156 
157 TEST(EnumsGenTest, GeneratedCustomStringToSymbolFn) {
158   auto one = symbolizePrettyIntEnum("case_one");
159   EXPECT_TRUE(one);
160   EXPECT_EQ(*one, PrettyIntEnum::Case1);
161 
162   auto two = symbolizePrettyIntEnum("case_two");
163   EXPECT_TRUE(two);
164   EXPECT_EQ(*two, PrettyIntEnum::Case2);
165 
166   auto none = symbolizePrettyIntEnum("Case1");
167   EXPECT_FALSE(none);
168 }
169 
170 TEST(EnumsGenTest, GeneratedIntAttributeClass) {
171   mlir::MLIRContext ctx;
172   I32Enum rawVal = I32Enum::Case5;
173 
174   I32EnumAttr enumAttr = I32EnumAttr::get(&ctx, rawVal);
175   EXPECT_NE(enumAttr, nullptr);
176   EXPECT_EQ(enumAttr.getValue(), rawVal);
177 
178   mlir::Type intType = mlir::IntegerType::get(&ctx, 32);
179   mlir::Attribute intAttr = mlir::IntegerAttr::get(intType, 5);
180   EXPECT_TRUE(intAttr.isa<I32EnumAttr>());
181   EXPECT_EQ(intAttr, enumAttr);
182 }
183 
184 TEST(EnumsGenTest, GeneratedBitAttributeClass) {
185   mlir::MLIRContext ctx;
186 
187   mlir::Type intType = mlir::IntegerType::get(&ctx, 32);
188   mlir::Attribute intAttr = mlir::IntegerAttr::get(
189       intType,
190       static_cast<uint32_t>(BitEnumWithNone::Bit0 | BitEnumWithNone::Bit3));
191   EXPECT_TRUE(intAttr.isa<BitEnumWithNoneAttr>());
192   EXPECT_TRUE(intAttr.isa<BitEnumWithoutNoneAttr>());
193 
194   intAttr = mlir::IntegerAttr::get(
195       intType, static_cast<uint32_t>(BitEnumWithGroup::Bits0To3) | (1u << 6));
196   EXPECT_FALSE(intAttr.isa<BitEnumWithGroupAttr>());
197 }
198