xref: /llvm-project/libcxx/test/std/ranges/range.access/size.pass.cpp (revision 12978b3e23a2766732595391c193e5631f40a3db)
1 //===----------------------------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 // UNSUPPORTED: c++03, c++11, c++14, c++17
10 
11 // std::ranges::size
12 
13 #include <ranges>
14 
15 #include <cassert>
16 #include "test_macros.h"
17 #include "test_iterators.h"
18 
19 using RangeSizeT = decltype(std::ranges::size);
20 
21 static_assert(!std::is_invocable_v<RangeSizeT, int[]>);
22 static_assert( std::is_invocable_v<RangeSizeT, int[1]>);
23 static_assert( std::is_invocable_v<RangeSizeT, int (&&)[1]>);
24 static_assert( std::is_invocable_v<RangeSizeT, int (&)[1]>);
25 
26 struct Incomplete;
27 static_assert(!std::is_invocable_v<RangeSizeT, Incomplete[]>);
28 static_assert(!std::is_invocable_v<RangeSizeT, Incomplete(&)[]>);
29 static_assert(!std::is_invocable_v<RangeSizeT, Incomplete(&&)[]>);
30 
31 extern Incomplete array_of_incomplete[42];
32 static_assert(std::ranges::size(array_of_incomplete) == 42);
33 static_assert(std::ranges::size(std::move(array_of_incomplete)) == 42);
34 static_assert(std::ranges::size(std::as_const(array_of_incomplete)) == 42);
35 static_assert(std::ranges::size(static_cast<const Incomplete(&&)[42]>(array_of_incomplete)) == 42);
36 
37 struct SizeMember {
sizeSizeMember38   constexpr std::size_t size() { return 42; }
39 };
40 
41 struct StaticSizeMember {
sizeStaticSizeMember42   constexpr static std::size_t size() { return 42; }
43 };
44 
45 static_assert(!std::is_invocable_v<RangeSizeT, const SizeMember>);
46 
47 struct SizeFunction {
size(SizeFunction)48   friend constexpr std::size_t size(SizeFunction) { return 42; }
49 };
50 
51 // Make sure the size member is preferred.
52 struct SizeMemberAndFunction {
sizeSizeMemberAndFunction53   constexpr std::size_t size() { return 42; }
size(SizeMemberAndFunction)54   friend constexpr std::size_t size(SizeMemberAndFunction) { return 0; }
55 };
56 
testArrayType()57 bool constexpr testArrayType() {
58   int a[4];
59   int b[1];
60   SizeMember c[4];
61   SizeFunction d[4];
62 
63   assert(std::ranges::size(a) == 4);
64   ASSERT_SAME_TYPE(decltype(std::ranges::size(a)), std::size_t);
65   assert(std::ranges::size(b) == 1);
66   ASSERT_SAME_TYPE(decltype(std::ranges::size(b)), std::size_t);
67   assert(std::ranges::size(c) == 4);
68   ASSERT_SAME_TYPE(decltype(std::ranges::size(c)), std::size_t);
69   assert(std::ranges::size(d) == 4);
70   ASSERT_SAME_TYPE(decltype(std::ranges::size(d)), std::size_t);
71 
72   return true;
73 }
74 
75 struct SizeMemberConst {
sizeSizeMemberConst76   constexpr std::size_t size() const { return 42; }
77 };
78 
79 struct SizeMemberSigned {
sizeSizeMemberSigned80   constexpr long size() { return 42; }
81 };
82 
testHasSizeMember()83 bool constexpr testHasSizeMember() {
84   assert(std::ranges::size(SizeMember()) == 42);
85   ASSERT_SAME_TYPE(decltype(std::ranges::size(SizeMember())), std::size_t);
86 
87   const SizeMemberConst sizeMemberConst;
88   assert(std::ranges::size(sizeMemberConst) == 42);
89 
90   assert(std::ranges::size(SizeMemberAndFunction()) == 42);
91 
92   assert(std::ranges::size(SizeMemberSigned()) == 42);
93   ASSERT_SAME_TYPE(decltype(std::ranges::size(SizeMemberSigned())), long);
94 
95   assert(std::ranges::size(StaticSizeMember()) == 42);
96   ASSERT_SAME_TYPE(decltype(std::ranges::size(StaticSizeMember())), std::size_t);
97 
98   return true;
99 }
100 
101 struct MoveOnlySizeFunction {
102   MoveOnlySizeFunction() = default;
103   MoveOnlySizeFunction(MoveOnlySizeFunction &&) = default;
104   MoveOnlySizeFunction(MoveOnlySizeFunction const&) = delete;
105 
size(MoveOnlySizeFunction)106   friend constexpr std::size_t size(MoveOnlySizeFunction) { return 42; }
107 };
108 
109 enum EnumSizeFunction {
110   a, b
111 };
112 
size(EnumSizeFunction)113 constexpr std::size_t size(EnumSizeFunction) { return 42; }
114 
115 struct SizeFunctionConst {
size(const SizeFunctionConst)116   friend constexpr std::size_t size(const SizeFunctionConst) { return 42; }
117 };
118 
119 struct SizeFunctionRef {
size(SizeFunctionRef &)120   friend constexpr std::size_t size(SizeFunctionRef&) { return 42; }
121 };
122 
123 struct SizeFunctionConstRef {
size(SizeFunctionConstRef const &)124   friend constexpr std::size_t size(SizeFunctionConstRef const&) { return 42; }
125 };
126 
127 struct SizeFunctionSigned {
size(SizeFunctionSigned)128   friend constexpr long size(SizeFunctionSigned) { return 42; }
129 };
130 
testHasSizeFunction()131 bool constexpr testHasSizeFunction() {
132   assert(std::ranges::size(SizeFunction()) == 42);
133   ASSERT_SAME_TYPE(decltype(std::ranges::size(SizeFunction())), std::size_t);
134   static_assert(!std::is_invocable_v<RangeSizeT, MoveOnlySizeFunction>);
135   assert(std::ranges::size(EnumSizeFunction()) == 42);
136   assert(std::ranges::size(SizeFunctionConst()) == 42);
137 
138   SizeFunctionRef a;
139   assert(std::ranges::size(a) == 42);
140 
141   const SizeFunctionConstRef b;
142   assert(std::ranges::size(b) == 42);
143 
144   assert(std::ranges::size(SizeFunctionSigned()) == 42);
145   ASSERT_SAME_TYPE(decltype(std::ranges::size(SizeFunctionSigned())), long);
146 
147   return true;
148 }
149 
150 struct Empty { };
151 static_assert(!std::is_invocable_v<RangeSizeT, Empty>);
152 
153 struct InvalidReturnTypeMember {
154   Empty size();
155 };
156 
157 struct InvalidReturnTypeFunction {
158   friend Empty size(InvalidReturnTypeFunction);
159 };
160 
161 struct Convertible {
162   operator std::size_t();
163 };
164 
165 struct ConvertibleReturnTypeMember {
166   Convertible size();
167 };
168 
169 struct ConvertibleReturnTypeFunction {
170   friend Convertible size(ConvertibleReturnTypeFunction);
171 };
172 
173 struct BoolReturnTypeMember {
174   bool size() const;
175 };
176 
177 struct BoolReturnTypeFunction {
178   friend bool size(BoolReturnTypeFunction const&);
179 };
180 
181 static_assert(!std::is_invocable_v<RangeSizeT, InvalidReturnTypeMember>);
182 static_assert(!std::is_invocable_v<RangeSizeT, InvalidReturnTypeFunction>);
183 static_assert( std::is_invocable_v<RangeSizeT, InvalidReturnTypeMember (&)[4]>);
184 static_assert( std::is_invocable_v<RangeSizeT, InvalidReturnTypeFunction (&)[4]>);
185 static_assert(!std::is_invocable_v<RangeSizeT, ConvertibleReturnTypeMember>);
186 static_assert(!std::is_invocable_v<RangeSizeT, ConvertibleReturnTypeFunction>);
187 static_assert(!std::is_invocable_v<RangeSizeT, BoolReturnTypeMember const&>);
188 static_assert(!std::is_invocable_v<RangeSizeT, BoolReturnTypeFunction const&>);
189 
190 struct SizeMemberDisabled {
sizeSizeMemberDisabled191   std::size_t size() { return 42; }
192 };
193 
194 template <>
195 inline constexpr bool std::ranges::disable_sized_range<SizeMemberDisabled> = true;
196 
197 struct ImproperlyDisabledMember {
sizeImproperlyDisabledMember198   std::size_t size() const { return 42; }
199 };
200 
201 // Intentionally disabling "const ConstSizeMemberDisabled". This doesn't disable anything
202 // because T is always uncvrefed before being checked.
203 template <>
204 inline constexpr bool std::ranges::disable_sized_range<const ImproperlyDisabledMember> = true;
205 
206 struct SizeFunctionDisabled {
size(SizeFunctionDisabled)207   friend std::size_t size(SizeFunctionDisabled) { return 42; }
208 };
209 
210 template <>
211 inline constexpr bool std::ranges::disable_sized_range<SizeFunctionDisabled> = true;
212 
213 struct ImproperlyDisabledFunction {
size(ImproperlyDisabledFunction const &)214   friend std::size_t size(ImproperlyDisabledFunction const&) { return 42; }
215 };
216 
217 template <>
218 inline constexpr bool std::ranges::disable_sized_range<const ImproperlyDisabledFunction> = true;
219 
220 static_assert( std::is_invocable_v<RangeSizeT, ImproperlyDisabledMember&>);
221 static_assert( std::is_invocable_v<RangeSizeT, const ImproperlyDisabledMember&>);
222 static_assert(std::is_invocable_v<RangeSizeT,
223                                   ImproperlyDisabledFunction&>); // Ill-formed before P2602R2 Poison Pills are Too Toxic
224 static_assert( std::is_invocable_v<RangeSizeT, const ImproperlyDisabledFunction&>);
225 
226 // No begin end.
227 struct HasMinusOperator {
operator -(HasMinusOperator,HasMinusOperator)228   friend constexpr std::size_t operator-(HasMinusOperator, HasMinusOperator) { return 2; }
229 };
230 static_assert(!std::is_invocable_v<RangeSizeT, HasMinusOperator>);
231 
232 struct HasMinusBeginEnd {
233   struct sentinel {
234     friend bool operator==(sentinel, forward_iterator<int*>);
operator -HasMinusBeginEnd235     friend constexpr std::ptrdiff_t operator-(const sentinel, const forward_iterator<int*>) { return 2; }
operator -HasMinusBeginEnd236     friend constexpr std::ptrdiff_t operator-(const forward_iterator<int*>, const sentinel) { return 2; }
237   };
238 
begin(HasMinusBeginEnd)239   friend constexpr forward_iterator<int*> begin(HasMinusBeginEnd) { return {}; }
end(HasMinusBeginEnd)240   friend constexpr sentinel end(HasMinusBeginEnd) { return {}; }
241 };
242 
243 struct other_forward_iterator : forward_iterator<int*> { };
244 
245 struct InvalidMinusBeginEnd {
246   struct sentinel {
247     friend bool operator==(sentinel, other_forward_iterator);
operator -InvalidMinusBeginEnd248     friend constexpr std::ptrdiff_t operator-(const sentinel, const other_forward_iterator) { return 2; }
operator -InvalidMinusBeginEnd249     friend constexpr std::ptrdiff_t operator-(const other_forward_iterator, const sentinel) { return 2; }
250   };
251 
begin(InvalidMinusBeginEnd)252   friend constexpr other_forward_iterator begin(InvalidMinusBeginEnd) { return {}; }
end(InvalidMinusBeginEnd)253   friend constexpr sentinel end(InvalidMinusBeginEnd) { return {}; }
254 };
255 
256 // short is integer-like, but it is not other_forward_iterator's difference_type.
257 static_assert(!std::same_as<other_forward_iterator::difference_type, short>);
258 static_assert(!std::is_invocable_v<RangeSizeT, InvalidMinusBeginEnd>);
259 
260 struct RandomAccessRange {
261   struct sentinel {
262     friend bool operator==(sentinel, random_access_iterator<int*>);
operator -RandomAccessRange263     friend constexpr std::ptrdiff_t operator-(const sentinel, const random_access_iterator<int*>) { return 2; }
operator -RandomAccessRange264     friend constexpr std::ptrdiff_t operator-(const random_access_iterator<int*>, const sentinel) { return 2; }
265   };
266 
beginRandomAccessRange267   constexpr random_access_iterator<int*> begin() { return {}; }
endRandomAccessRange268   constexpr sentinel end() { return {}; }
269 };
270 
271 struct IntPtrBeginAndEnd {
272   int buff[8];
beginIntPtrBeginAndEnd273   constexpr int* begin() { return buff; }
endIntPtrBeginAndEnd274   constexpr int* end() { return buff + 8; }
275 };
276 
277 struct DisabledSizeRangeWithBeginEnd {
278   int buff[8];
beginDisabledSizeRangeWithBeginEnd279   constexpr int* begin() { return buff; }
endDisabledSizeRangeWithBeginEnd280   constexpr int* end() { return buff + 8; }
sizeDisabledSizeRangeWithBeginEnd281   constexpr std::size_t size() { return 1; }
282 };
283 
284 template <>
285 inline constexpr bool std::ranges::disable_sized_range<DisabledSizeRangeWithBeginEnd> = true;
286 
287 struct SizeBeginAndEndMembers {
288   int buff[8];
beginSizeBeginAndEndMembers289   constexpr int* begin() { return buff; }
endSizeBeginAndEndMembers290   constexpr int* end() { return buff + 8; }
sizeSizeBeginAndEndMembers291   constexpr std::size_t size() { return 1; }
292 };
293 
testRanges()294 constexpr bool testRanges() {
295   HasMinusBeginEnd a;
296   assert(std::ranges::size(a) == 2);
297   // Ensure that this is converted to an *unsigned* type.
298   ASSERT_SAME_TYPE(decltype(std::ranges::size(a)), std::size_t);
299 
300   IntPtrBeginAndEnd b;
301   assert(std::ranges::size(b) == 8);
302 
303   DisabledSizeRangeWithBeginEnd c;
304   assert(std::ranges::size(c) == 8);
305 
306   RandomAccessRange d;
307   assert(std::ranges::size(d) == 2);
308   ASSERT_SAME_TYPE(decltype(std::ranges::size(d)), std::size_t);
309 
310   SizeBeginAndEndMembers e;
311   assert(std::ranges::size(e) == 1);
312 
313   return true;
314 }
315 
316 // Test ADL-proofing.
317 struct Incomplete;
318 template<class T> struct Holder { T t; };
319 static_assert(!std::is_invocable_v<RangeSizeT, Holder<Incomplete>*>);
320 static_assert(!std::is_invocable_v<RangeSizeT, Holder<Incomplete>*&>);
321 
main(int,char **)322 int main(int, char**) {
323   testArrayType();
324   static_assert(testArrayType());
325 
326   testHasSizeMember();
327   static_assert(testHasSizeMember());
328 
329   testHasSizeFunction();
330   static_assert(testHasSizeFunction());
331 
332   testRanges();
333   static_assert(testRanges());
334 
335   return 0;
336 }
337