carbon-lang/common/enum_base_test.cpp

// 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>

#include "testing/base/test_raw_ostream.h"

namespace Carbon::Testing {
namespace {

// These are directly in the Carbon namespace because the defines require it.
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"
};

static_assert(sizeof(TestKind) == sizeof(uint8_t),
              "Class size doesn't match enum size!");

TEST(EnumBaseTest, NamesAndConstants) {
  EXPECT_EQ("Beep", TestKind::Beep.name());
  EXPECT_EQ("Boop", TestKind::Boop.name());
  EXPECT_EQ("Burr", TestKind::Burr.name());
}

TEST(EnumBaseTest, Printing) {
  TestRawOstream stream;

  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", stream.TakeStr()) << "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::Testing