1 //===- llvm/unittest/ADT/ArrayRefTest.cpp - ArrayRef unit tests -----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/ADT/ArrayRef.h"
11 #include "llvm/Support/Allocator.h"
12 #include "llvm/Support/raw_ostream.h"
13 #include "gtest/gtest.h"
14 #include <vector>
15 using namespace llvm;
16 
17 // Check that the ArrayRef-of-pointer converting constructor only allows adding
18 // cv qualifiers (not removing them, or otherwise changing the type)
19 static_assert(
20     std::is_convertible<ArrayRef<int *>, ArrayRef<const int *>>::value,
21     "Adding const");
22 static_assert(
23     std::is_convertible<ArrayRef<int *>, ArrayRef<volatile int *>>::value,
24     "Adding volatile");
25 static_assert(!std::is_convertible<ArrayRef<int *>, ArrayRef<float *>>::value,
26               "Changing pointer of one type to a pointer of another");
27 static_assert(
28     !std::is_convertible<ArrayRef<const int *>, ArrayRef<int *>>::value,
29     "Removing const");
30 static_assert(
31     !std::is_convertible<ArrayRef<volatile int *>, ArrayRef<int *>>::value,
32     "Removing volatile");
33 
34 // Check that we can't accidentally assign a temporary location to an ArrayRef.
35 // (Unfortunately we can't make use of the same thing with constructors.)
36 static_assert(
37     !std::is_assignable<ArrayRef<int *>, int *>::value,
38     "Assigning from single prvalue element");
39 static_assert(
40     !std::is_assignable<ArrayRef<int *>, int * &&>::value,
41     "Assigning from single xvalue element");
42 static_assert(
43     std::is_assignable<ArrayRef<int *>, int * &>::value,
44     "Assigning from single lvalue element");
45 static_assert(
46     !std::is_assignable<ArrayRef<int *>, std::initializer_list<int *>>::value,
47     "Assigning from an initializer list");
48 
49 namespace {
50 
51 TEST(ArrayRefTest, AllocatorCopy) {
52   BumpPtrAllocator Alloc;
53   static const uint16_t Words1[] = { 1, 4, 200, 37 };
54   ArrayRef<uint16_t> Array1 = makeArrayRef(Words1, 4);
55   static const uint16_t Words2[] = { 11, 4003, 67, 64000, 13 };
56   ArrayRef<uint16_t> Array2 = makeArrayRef(Words2, 5);
57   ArrayRef<uint16_t> Array1c = Array1.copy(Alloc);
58   ArrayRef<uint16_t> Array2c = Array2.copy(Alloc);
59   EXPECT_TRUE(Array1.equals(Array1c));
60   EXPECT_NE(Array1.data(), Array1c.data());
61   EXPECT_TRUE(Array2.equals(Array2c));
62   EXPECT_NE(Array2.data(), Array2c.data());
63 
64   // Check that copy can cope with uninitialized memory.
65   struct NonAssignable {
66     const char *Ptr;
67 
68     NonAssignable(const char *Ptr) : Ptr(Ptr) {}
69     NonAssignable(const NonAssignable &RHS) = default;
70     void operator=(const NonAssignable &RHS) { assert(RHS.Ptr != nullptr); }
71     bool operator==(const NonAssignable &RHS) const { return Ptr == RHS.Ptr; }
72   } Array3Src[] = {"hello", "world"};
73   ArrayRef<NonAssignable> Array3Copy = makeArrayRef(Array3Src).copy(Alloc);
74   EXPECT_EQ(makeArrayRef(Array3Src), Array3Copy);
75   EXPECT_NE(makeArrayRef(Array3Src).data(), Array3Copy.data());
76 }
77 
78 TEST(ArrayRefTest, DropBack) {
79   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
80   ArrayRef<int> AR1(TheNumbers);
81   ArrayRef<int> AR2(TheNumbers, AR1.size() - 1);
82   EXPECT_TRUE(AR1.drop_back().equals(AR2));
83 
84   // Check that drop_back accepts size_t-sized numbers.
85   ArrayRef<char> AR3((const char *)0x10000, SIZE_MAX - 0x10000);
86   EXPECT_EQ(1U, AR3.drop_back(AR3.size() - 1).size());
87 }
88 
89 TEST(ArrayRefTest, DropFront) {
90   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
91   ArrayRef<int> AR1(TheNumbers);
92   ArrayRef<int> AR2(&TheNumbers[2], AR1.size() - 2);
93   EXPECT_TRUE(AR1.drop_front(2).equals(AR2));
94 
95   // Check that drop_front accepts size_t-sized numbers.
96   ArrayRef<char> AR3((const char *)0x10000, SIZE_MAX - 0x10000);
97   EXPECT_EQ(1U, AR3.drop_front(AR3.size() - 1).size());
98 }
99 
100 TEST(ArrayRefTest, TakeBack) {
101   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
102   ArrayRef<int> AR1(TheNumbers);
103   ArrayRef<int> AR2(AR1.end() - 1, 1);
104   EXPECT_TRUE(AR1.take_back().equals(AR2));
105 }
106 
107 TEST(ArrayRefTest, TakeFront) {
108   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
109   ArrayRef<int> AR1(TheNumbers);
110   ArrayRef<int> AR2(AR1.data(), 2);
111   EXPECT_TRUE(AR1.take_front(2).equals(AR2));
112 }
113 
114 TEST(ArrayRefTest, Equals) {
115   static const int A1[] = {1, 2, 3, 4, 5, 6, 7, 8};
116   ArrayRef<int> AR1(A1);
117   EXPECT_TRUE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 8}));
118   EXPECT_FALSE(AR1.equals({8, 1, 2, 4, 5, 6, 6, 7}));
119   EXPECT_FALSE(AR1.equals({2, 4, 5, 6, 6, 7, 8, 1}));
120   EXPECT_FALSE(AR1.equals({0, 1, 2, 4, 5, 6, 6, 7}));
121   EXPECT_FALSE(AR1.equals({1, 2, 42, 4, 5, 6, 7, 8}));
122   EXPECT_FALSE(AR1.equals({42, 2, 3, 4, 5, 6, 7, 8}));
123   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 42}));
124   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7}));
125   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 8, 9}));
126 
127   ArrayRef<int> AR1a = AR1.drop_back();
128   EXPECT_TRUE(AR1a.equals({1, 2, 3, 4, 5, 6, 7}));
129   EXPECT_FALSE(AR1a.equals({1, 2, 3, 4, 5, 6, 7, 8}));
130 
131   ArrayRef<int> AR1b = AR1a.slice(2, 4);
132   EXPECT_TRUE(AR1b.equals({3, 4, 5, 6}));
133   EXPECT_FALSE(AR1b.equals({2, 3, 4, 5, 6}));
134   EXPECT_FALSE(AR1b.equals({3, 4, 5, 6, 7}));
135 }
136 
137 TEST(ArrayRefTest, EmptyEquals) {
138   EXPECT_TRUE(ArrayRef<unsigned>() == ArrayRef<unsigned>());
139 }
140 
141 TEST(ArrayRefTest, Slice) {
142   // Check that slice accepts size_t-sized numbers.
143   ArrayRef<char> AR((const char *)0x10000, SIZE_MAX - 0x10000);
144   EXPECT_EQ(1U, AR.slice(AR.size() - 1).size());
145   EXPECT_EQ(AR.size() - 1, AR.slice(1, AR.size() - 1).size());
146 }
147 
148 TEST(ArrayRefTest, ConstConvert) {
149   int buf[4];
150   for (int i = 0; i < 4; ++i)
151     buf[i] = i;
152 
153   static int *A[] = {&buf[0], &buf[1], &buf[2], &buf[3]};
154   ArrayRef<const int *> a((ArrayRef<int *>(A)));
155   a = ArrayRef<int *>(A);
156 }
157 
158 static std::vector<int> ReturnTest12() { return {1, 2}; }
159 static void ArgTest12(ArrayRef<int> A) {
160   EXPECT_EQ(2U, A.size());
161   EXPECT_EQ(1, A[0]);
162   EXPECT_EQ(2, A[1]);
163 }
164 
165 TEST(ArrayRefTest, InitializerList) {
166   std::initializer_list<int> init_list = { 0, 1, 2, 3, 4 };
167   ArrayRef<int> A = init_list;
168   for (int i = 0; i < 5; ++i)
169     EXPECT_EQ(i, A[i]);
170 
171   std::vector<int> B = ReturnTest12();
172   A = B;
173   EXPECT_EQ(1, A[0]);
174   EXPECT_EQ(2, A[1]);
175 
176   ArgTest12({1, 2});
177 }
178 
179 TEST(ArrayRefTest, EmptyInitializerList) {
180   ArrayRef<int> A = {};
181   EXPECT_TRUE(A.empty());
182 
183   A = {};
184   EXPECT_TRUE(A.empty());
185 }
186 
187 // Test that makeArrayRef works on ArrayRef (no-op)
188 TEST(ArrayRefTest, makeArrayRef) {
189   static const int A1[] = {1, 2, 3, 4, 5, 6, 7, 8};
190 
191   // No copy expected for non-const ArrayRef (true no-op)
192   ArrayRef<int> AR1(A1);
193   ArrayRef<int> &AR1Ref = makeArrayRef(AR1);
194   EXPECT_EQ(&AR1, &AR1Ref);
195 
196   // A copy is expected for non-const ArrayRef (thin copy)
197   const ArrayRef<int> AR2(A1);
198   const ArrayRef<int> &AR2Ref = makeArrayRef(AR2);
199   EXPECT_NE(&AR2Ref, &AR2);
200   EXPECT_TRUE(AR2.equals(AR2Ref));
201 }
202 
203 } // end anonymous namespace
204