Add a new TypeBuilder helper class, which eases making LLVM IR types.

Patch by Jeffrey Yasskin!


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@70084 91177308-0d34-0410-b5e6-96231b3b80d8

1 files changed, 233 insertions, 0 deletions

diff --git a/unittests/Support/TypeBuilderTest.cpp b/unittests/Support/TypeBuilderTest.cpp
new file mode 100644
index 0000000000..425ee6bf54
--- /dev/null
+++ b/unittests/Support/TypeBuilderTest.cpp
@@ -0,0 +1,233 @@
+//===- llvm/unittest/Support/TypeBuilderTest.cpp - TypeBuilder tests -----===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Support/TypeBuilder.h"
+
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+namespace {
+
+TEST(TypeBuilderTest, Void) {
+  EXPECT_EQ(Type::VoidTy, (TypeBuilder<void, true>::get()));
+  EXPECT_EQ(Type::VoidTy, (TypeBuilder<void, false>::get()));
+  // Special case for C compatibility:
+  EXPECT_EQ(PointerType::getUnqual(Type::Int8Ty),
+            (TypeBuilder<void*, false>::get()));
+}
+
+TEST(TypeBuilderTest, HostIntegers) {
+  EXPECT_EQ(Type::Int8Ty, (TypeBuilder<int8_t, false>::get()));
+  EXPECT_EQ(Type::Int8Ty, (TypeBuilder<uint8_t, false>::get()));
+  EXPECT_EQ(Type::Int16Ty, (TypeBuilder<int16_t, false>::get()));
+  EXPECT_EQ(Type::Int16Ty, (TypeBuilder<uint16_t, false>::get()));
+  EXPECT_EQ(Type::Int32Ty, (TypeBuilder<int32_t, false>::get()));
+  EXPECT_EQ(Type::Int32Ty, (TypeBuilder<uint32_t, false>::get()));
+  EXPECT_EQ(Type::Int64Ty, (TypeBuilder<int64_t, false>::get()));
+  EXPECT_EQ(Type::Int64Ty, (TypeBuilder<uint64_t, false>::get()));
+
+  EXPECT_EQ(IntegerType::get(sizeof(size_t) * CHAR_BIT),
+            (TypeBuilder<size_t, false>::get()));
+  EXPECT_EQ(IntegerType::get(sizeof(ptrdiff_t) * CHAR_BIT),
+            (TypeBuilder<ptrdiff_t, false>::get()));
+}
+
+TEST(TypeBuilderTest, CrossCompilableIntegers) {
+  EXPECT_EQ(IntegerType::get(1), (TypeBuilder<types::i<1>, true>::get()));
+  EXPECT_EQ(IntegerType::get(1), (TypeBuilder<types::i<1>, false>::get()));
+  EXPECT_EQ(IntegerType::get(72), (TypeBuilder<types::i<72>, true>::get()));
+  EXPECT_EQ(IntegerType::get(72), (TypeBuilder<types::i<72>, false>::get()));
+}
+
+TEST(TypeBuilderTest, Float) {
+  EXPECT_EQ(Type::FloatTy, (TypeBuilder<float, false>::get()));
+  EXPECT_EQ(Type::DoubleTy, (TypeBuilder<double, false>::get()));
+  // long double isn't supported yet.
+  EXPECT_EQ(Type::FloatTy, (TypeBuilder<types::ieee_float, true>::get()));
+  EXPECT_EQ(Type::FloatTy, (TypeBuilder<types::ieee_float, false>::get()));
+  EXPECT_EQ(Type::DoubleTy, (TypeBuilder<types::ieee_double, true>::get()));
+  EXPECT_EQ(Type::DoubleTy, (TypeBuilder<types::ieee_double, false>::get()));
+  EXPECT_EQ(Type::X86_FP80Ty, (TypeBuilder<types::x86_fp80, true>::get()));
+  EXPECT_EQ(Type::X86_FP80Ty, (TypeBuilder<types::x86_fp80, false>::get()));
+  EXPECT_EQ(Type::FP128Ty, (TypeBuilder<types::fp128, true>::get()));
+  EXPECT_EQ(Type::FP128Ty, (TypeBuilder<types::fp128, false>::get()));
+  EXPECT_EQ(Type::PPC_FP128Ty, (TypeBuilder<types::ppc_fp128, true>::get()));
+  EXPECT_EQ(Type::PPC_FP128Ty, (TypeBuilder<types::ppc_fp128, false>::get()));
+}
+
+TEST(TypeBuilderTest, Derived) {
+  EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)),
+            (TypeBuilder<int8_t**, false>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7),
+            (TypeBuilder<int8_t[7], false>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0),
+            (TypeBuilder<int8_t[], false>::get()));
+
+  EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)),
+            (TypeBuilder<types::i<8>**, false>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7),
+            (TypeBuilder<types::i<8>[7], false>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0),
+            (TypeBuilder<types::i<8>[], false>::get()));
+
+  EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)),
+            (TypeBuilder<types::i<8>**, true>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7),
+            (TypeBuilder<types::i<8>[7], true>::get()));
+  EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0),
+            (TypeBuilder<types::i<8>[], true>::get()));
+
+
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const int8_t, false>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<volatile int8_t, false>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const volatile int8_t, false>::get()));
+
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const types::i<8>, false>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<volatile types::i<8>, false>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const volatile types::i<8>, false>::get()));
+
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const types::i<8>, true>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<volatile types::i<8>, true>::get()));
+  EXPECT_EQ(Type::Int8Ty,
+            (TypeBuilder<const volatile types::i<8>, true>::get()));
+
+  EXPECT_EQ(PointerType::getUnqual(Type::Int8Ty),
+            (TypeBuilder<const volatile int8_t*const volatile, false>::get()));
+}
+
+TEST(TypeBuilderTest, Functions) {
+  std::vector<const Type*> params;
+  EXPECT_EQ(FunctionType::get(Type::VoidTy, params, false),
+            (TypeBuilder<void(), true>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(...), false>::get()));
+  params.push_back(TypeBuilder<int32_t*, false>::get());
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false),
+            (TypeBuilder<int8_t(const int32_t*), false>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(const int32_t*, ...), false>::get()));
+  params.push_back(TypeBuilder<char*, false>::get());
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false),
+            (TypeBuilder<int8_t(int32_t*, void*), false>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(int32_t*, char*, ...), false>::get()));
+  params.push_back(TypeBuilder<char, false>::get());
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false),
+            (TypeBuilder<int8_t(int32_t*, void*, char), false>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(int32_t*, char*, char, ...), false>::get()));
+  params.push_back(TypeBuilder<char, false>::get());
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false),
+            (TypeBuilder<int8_t(int32_t*, void*, char, char), false>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(int32_t*, char*, char, char, ...),
+                         false>::get()));
+  params.push_back(TypeBuilder<char, false>::get());
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false),
+            (TypeBuilder<int8_t(int32_t*, void*, char, char, char),
+                         false>::get()));
+  EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true),
+            (TypeBuilder<int8_t(int32_t*, char*, char, char, char, ...),
+                         false>::get()));
+}
+
+class MyType {
+  int a;
+  int *b;
+  void *array[1];
+};
+
+class MyPortableType {
+  int32_t a;
+  int32_t *b;
+  void *array[1];
+};
+
+}  // anonymous namespace
+
+namespace llvm {
+template<bool cross> class TypeBuilder<MyType, cross> {
+public:
+  static const StructType *get() {
+    // Using the static result variable ensures that the type is
+    // only looked up once.
+    static const StructType *const result = StructType::get(
+      TypeBuilder<int, cross>::get(),
+      TypeBuilder<int*, cross>::get(),
+      TypeBuilder<void*[], cross>::get(),
+      NULL);
+    return result;
+  }
+
+  // You may find this a convenient place to put some constants
+  // to help with getelementptr.  They don't have any effect on
+  // the operation of TypeBuilder.
+  enum Fields {
+    FIELD_A,
+    FIELD_B,
+    FIELD_ARRAY
+  };
+};
+
+template<bool cross> class TypeBuilder<MyPortableType, cross> {
+public:
+  static const StructType *get() {
+    // Using the static result variable ensures that the type is
+    // only looked up once.
+    static const StructType *const result = StructType::get(
+      TypeBuilder<types::i<32>, cross>::get(),
+      TypeBuilder<types::i<32>*, cross>::get(),
+      TypeBuilder<types::i<8>*[], cross>::get(),
+      NULL);
+    return result;
+  }
+
+  // You may find this a convenient place to put some constants
+  // to help with getelementptr.  They don't have any effect on
+  // the operation of TypeBuilder.
+  enum Fields {
+    FIELD_A,
+    FIELD_B,
+    FIELD_ARRAY
+  };
+};
+}  // namespace llvm
+namespace {
+
+TEST(TypeBuilderTest, Extensions) {
+  EXPECT_EQ(PointerType::getUnqual(StructType::get(
+                                     TypeBuilder<int, false>::get(),
+                                     TypeBuilder<int*, false>::get(),
+                                     TypeBuilder<void*[], false>::get(),
+                                     NULL)),
+            (TypeBuilder<MyType*, false>::get()));
+  EXPECT_EQ(PointerType::getUnqual(StructType::get(
+                                     TypeBuilder<types::i<32>, false>::get(),
+                                     TypeBuilder<types::i<32>*, false>::get(),
+                                     TypeBuilder<types::i<8>*[], false>::get(),
+                                     NULL)),
+            (TypeBuilder<MyPortableType*, false>::get()));
+  EXPECT_EQ(PointerType::getUnqual(StructType::get(
+                                     TypeBuilder<types::i<32>, false>::get(),
+                                     TypeBuilder<types::i<32>*, false>::get(),
+                                     TypeBuilder<types::i<8>*[], false>::get(),
+                                     NULL)),
+            (TypeBuilder<MyPortableType*, true>::get()));
+}
+
+}  // anonymous namespace