Reuse EnumBase for interpreter's Builtin enum (#2688)

This was bugging me after I saw all the strings; it feels like this is why we have EnumBase on the toolchain side. I've included the move of EnumBase to //common because I figured it's reasonable to evaluate together; if we don't want EnumBase in this case, it doesn't make sense to move.
2026-10-04 17:51:05 +01:00 · 2023-03-17 08:40:43 -07:00
parent e25d8b0875
commit 9e1a5cfaee
21 changed files with 197 additions and 228 deletions
@@ -0,0 +1,108 @@
+// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
+// Exceptions. See /LICENSE for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include "common/enum_base.h"
+
+#include <gtest/gtest.h>
+
+namespace Carbon {
+
+CARBON_DEFINE_RAW_ENUM_CLASS(TestKind, uint8_t) {
+#define CARBON_ENUM_BASE_TEST_KIND(Name) CARBON_RAW_ENUM_ENUMERATOR(Name)
+#include "common/enum_base_test.def"
+};
+
+class TestKind : public CARBON_ENUM_BASE(TestKind) {
+ public:
+#define CARBON_ENUM_BASE_TEST_KIND(Name) CARBON_ENUM_CONSTANT_DECLARATION(Name)
+#include "common/enum_base_test.def"
+
+  using EnumBase::AsInt;
+  using EnumBase::FromInt;
+};
+
+#define CARBON_ENUM_BASE_TEST_KIND(Name) \
+  CARBON_ENUM_CONSTANT_DEFINITION(TestKind, Name)
+#include "common/enum_base_test.def"
+
+CARBON_DEFINE_ENUM_CLASS_NAMES(TestKind) = {
+#define CARBON_ENUM_BASE_TEST_KIND(Name) CARBON_ENUM_CLASS_NAME_STRING(Name)
+#include "common/enum_base_test.def"
+};
+
+namespace {
+
+TEST(EnumBaseTest, NamesAndConstants) {
+  EXPECT_EQ("Beep", TestKind::Beep.name());
+  EXPECT_EQ("Boop", TestKind::Boop.name());
+  EXPECT_EQ("Burr", TestKind::Burr.name());
+}
+
+TEST(EnumBaseTest, Printing) {
+  std::string s;
+  llvm::raw_string_ostream stream(s);
+
+  TestKind kind = TestKind::Beep;
+  stream << kind << " " << TestKind::Beep;
+  kind = TestKind::Boop;
+  stream << " " << kind;
+
+  // Check the streamed results and also make sure we can stream into GoogleTest
+  // assertions.
+  EXPECT_EQ("Beep Beep Boop", s) << "Final kind: " << kind;
+}
+
+TEST(EnumBaseTest, Switch) {
+  TestKind kind = TestKind::Boop;
+
+  switch (kind) {
+    case TestKind::Beep: {
+      FAIL() << "Beep case selected!";
+      break;
+    }
+    case TestKind::Boop: {
+      EXPECT_EQ("Boop", kind.name());
+      break;
+    }
+    case TestKind::Burr: {
+      FAIL() << "Burr case selected!";
+      break;
+    }
+  }
+}
+
+TEST(EnumBaseTest, Comparison) {
+  TestKind kind = TestKind::Beep;
+
+  // Make sure all the different comparisons work, and also to work with
+  // GoogleTest expectations.
+  EXPECT_EQ(TestKind::Beep, kind);
+  EXPECT_NE(TestKind::Boop, kind);
+  EXPECT_LT(kind, TestKind::Boop);
+  EXPECT_GT(TestKind::Burr, kind);
+  EXPECT_LE(kind, TestKind::Beep);
+  EXPECT_GE(TestKind::Beep, kind);
+
+  // These should also all be constexpr.
+  constexpr TestKind Kind2 = TestKind::Beep;
+  static_assert(Kind2 == TestKind::Beep);
+  static_assert(Kind2 != TestKind::Boop);
+  static_assert(Kind2 < TestKind::Boop);
+  static_assert(!(Kind2 > TestKind::Burr));
+  static_assert(Kind2 <= TestKind::Beep);
+  static_assert(!(Kind2 >= TestKind::Burr));
+}
+
+TEST(EnumBaseTest, IntConversion) {
+  EXPECT_EQ(0, TestKind::Beep.AsInt());
+  EXPECT_EQ(1, TestKind::Boop.AsInt());
+  EXPECT_EQ(2, TestKind::Burr.AsInt());
+
+  EXPECT_EQ(TestKind::Beep, TestKind::FromInt(0));
+  EXPECT_EQ(TestKind::Boop, TestKind::FromInt(1));
+  EXPECT_EQ(TestKind::Burr, TestKind::FromInt(2));
+}
+
+}  // namespace
+}  // namespace Carbon