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 namespace {
35 
36 TEST(ArrayRefTest, AllocatorCopy) {
37   BumpPtrAllocator Alloc;
38   static const uint16_t Words1[] = { 1, 4, 200, 37 };
39   ArrayRef<uint16_t> Array1 = makeArrayRef(Words1, 4);
40   static const uint16_t Words2[] = { 11, 4003, 67, 64000, 13 };
41   ArrayRef<uint16_t> Array2 = makeArrayRef(Words2, 5);
42   ArrayRef<uint16_t> Array1c = Array1.copy(Alloc);
43   ArrayRef<uint16_t> Array2c = Array2.copy(Alloc);
44   EXPECT_TRUE(Array1.equals(Array1c));
45   EXPECT_NE(Array1.data(), Array1c.data());
46   EXPECT_TRUE(Array2.equals(Array2c));
47   EXPECT_NE(Array2.data(), Array2c.data());
48 
49   // Check that copy can cope with uninitialized memory.
50   struct NonAssignable {
51     const char *Ptr;
52 
53     NonAssignable(const char *Ptr) : Ptr(Ptr) {}
54     NonAssignable(const NonAssignable &RHS) = default;
55     void operator=(const NonAssignable &RHS) { assert(RHS.Ptr != nullptr); }
56     bool operator==(const NonAssignable &RHS) const { return Ptr == RHS.Ptr; }
57   } Array3Src[] = {"hello", "world"};
58   ArrayRef<NonAssignable> Array3Copy = makeArrayRef(Array3Src).copy(Alloc);
59   EXPECT_EQ(makeArrayRef(Array3Src), Array3Copy);
60   EXPECT_NE(makeArrayRef(Array3Src).data(), Array3Copy.data());
61 }
62 
63 TEST(ArrayRefTest, DropBack) {
64   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
65   ArrayRef<int> AR1(TheNumbers);
66   ArrayRef<int> AR2(TheNumbers, AR1.size() - 1);
67   EXPECT_TRUE(AR1.drop_back().equals(AR2));
68 
69   // Check that drop_back accepts size_t-sized numbers.
70   ArrayRef<char> AR3((const char *)0x10000, SIZE_MAX - 0x10000);
71   EXPECT_EQ(1U, AR3.drop_back(AR3.size() - 1).size());
72 }
73 
74 TEST(ArrayRefTest, DropFront) {
75   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
76   ArrayRef<int> AR1(TheNumbers);
77   ArrayRef<int> AR2(&TheNumbers[2], AR1.size() - 2);
78   EXPECT_TRUE(AR1.drop_front(2).equals(AR2));
79 
80   // Check that drop_front accepts size_t-sized numbers.
81   ArrayRef<char> AR3((const char *)0x10000, SIZE_MAX - 0x10000);
82   EXPECT_EQ(1U, AR3.drop_front(AR3.size() - 1).size());
83 }
84 
85 TEST(ArrayRefTest, KeepBack) {
86   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
87   ArrayRef<int> AR1(TheNumbers);
88   ArrayRef<int> AR2(AR1.end() - 1, 1);
89   EXPECT_TRUE(AR1.keep_back().equals(AR2));
90 }
91 
92 TEST(ArrayRefTest, KeepFront) {
93   static const int TheNumbers[] = {4, 8, 15, 16, 23, 42};
94   ArrayRef<int> AR1(TheNumbers);
95   ArrayRef<int> AR2(AR1.data(), 2);
96   EXPECT_TRUE(AR1.keep_front(2).equals(AR2));
97 }
98 
99 TEST(ArrayRefTest, Equals) {
100   static const int A1[] = {1, 2, 3, 4, 5, 6, 7, 8};
101   ArrayRef<int> AR1(A1);
102   EXPECT_TRUE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 8}));
103   EXPECT_FALSE(AR1.equals({8, 1, 2, 4, 5, 6, 6, 7}));
104   EXPECT_FALSE(AR1.equals({2, 4, 5, 6, 6, 7, 8, 1}));
105   EXPECT_FALSE(AR1.equals({0, 1, 2, 4, 5, 6, 6, 7}));
106   EXPECT_FALSE(AR1.equals({1, 2, 42, 4, 5, 6, 7, 8}));
107   EXPECT_FALSE(AR1.equals({42, 2, 3, 4, 5, 6, 7, 8}));
108   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 42}));
109   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7}));
110   EXPECT_FALSE(AR1.equals({1, 2, 3, 4, 5, 6, 7, 8, 9}));
111 
112   ArrayRef<int> AR1a = AR1.drop_back();
113   EXPECT_TRUE(AR1a.equals({1, 2, 3, 4, 5, 6, 7}));
114   EXPECT_FALSE(AR1a.equals({1, 2, 3, 4, 5, 6, 7, 8}));
115 
116   ArrayRef<int> AR1b = AR1a.slice(2, 4);
117   EXPECT_TRUE(AR1b.equals({3, 4, 5, 6}));
118   EXPECT_FALSE(AR1b.equals({2, 3, 4, 5, 6}));
119   EXPECT_FALSE(AR1b.equals({3, 4, 5, 6, 7}));
120 }
121 
122 TEST(ArrayRefTest, EmptyEquals) {
123   EXPECT_TRUE(ArrayRef<unsigned>() == ArrayRef<unsigned>());
124 }
125 
126 TEST(ArrayRefTest, Slice) {
127   // Check that slice accepts size_t-sized numbers.
128   ArrayRef<char> AR((const char *)0x10000, SIZE_MAX - 0x10000);
129   EXPECT_EQ(1U, AR.slice(AR.size() - 1).size());
130   EXPECT_EQ(AR.size() - 1, AR.slice(1, AR.size() - 1).size());
131 }
132 
133 TEST(ArrayRefTest, ConstConvert) {
134   int buf[4];
135   for (int i = 0; i < 4; ++i)
136     buf[i] = i;
137 
138   static int *A[] = {&buf[0], &buf[1], &buf[2], &buf[3]};
139   ArrayRef<const int *> a((ArrayRef<int *>(A)));
140   a = ArrayRef<int *>(A);
141 }
142 
143 static std::vector<int> ReturnTest12() { return {1, 2}; }
144 static void ArgTest12(ArrayRef<int> A) {
145   EXPECT_EQ(2U, A.size());
146   EXPECT_EQ(1, A[0]);
147   EXPECT_EQ(2, A[1]);
148 }
149 
150 TEST(ArrayRefTest, InitializerList) {
151   std::initializer_list<int> init_list = { 0, 1, 2, 3, 4 };
152   ArrayRef<int> A = init_list;
153   for (int i = 0; i < 5; ++i)
154     EXPECT_EQ(i, A[i]);
155 
156   std::vector<int> B = ReturnTest12();
157   A = B;
158   EXPECT_EQ(1, A[0]);
159   EXPECT_EQ(2, A[1]);
160 
161   ArgTest12({1, 2});
162 }
163 
164 // Test that makeArrayRef works on ArrayRef (no-op)
165 TEST(ArrayRefTest, makeArrayRef) {
166   static const int A1[] = {1, 2, 3, 4, 5, 6, 7, 8};
167 
168   // No copy expected for non-const ArrayRef (true no-op)
169   ArrayRef<int> AR1(A1);
170   ArrayRef<int> &AR1Ref = makeArrayRef(AR1);
171   EXPECT_EQ(&AR1, &AR1Ref);
172 
173   // A copy is expected for non-const ArrayRef (thin copy)
174   const ArrayRef<int> AR2(A1);
175   const ArrayRef<int> &AR2Ref = makeArrayRef(AR2);
176   EXPECT_NE(&AR2Ref, &AR2);
177   EXPECT_TRUE(AR2.equals(AR2Ref));
178 }
179 
180 } // end anonymous namespace
181