1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1997-2011. All Rights Reserved.
%%
%% The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved online at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%%
%% %CopyrightEnd%
%%
-module(tuple_SUITE).
-export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1,
init_per_group/2,end_per_group/2,
t_size/1, t_tuple_size/1, t_element/1, t_setelement/1,
t_list_to_tuple/1, t_tuple_to_list/1,
t_make_tuple_2/1, t_make_tuple_3/1, t_append_element/1,
build_and_match/1, tuple_with_case/1, tuple_in_guard/1]).
-include_lib("test_server/include/test_server.hrl").
%% Tests tuples and the BIFs:
%%
%% size(Tuple)
%% element/2
%% setelement/3
%% tuple_to_list/1
%% list_to_tuple/1
%% make_tuple/2
%%
suite() -> [{ct_hooks,[ts_install_cth]}].
all() ->
[build_and_match, t_size, t_tuple_size, t_list_to_tuple,
t_tuple_to_list, t_element, t_setelement,
t_make_tuple_2, t_make_tuple_3, t_append_element,
tuple_with_case, tuple_in_guard].
groups() ->
[].
init_per_suite(Config) ->
Config.
end_per_suite(_Config) ->
ok.
init_per_group(_GroupName, Config) ->
Config.
end_per_group(_GroupName, Config) ->
Config.
build_and_match(Config) when is_list(Config) ->
?line {} = id({}),
?line {1} = id({1}),
?line {1, 2} = id({1, 2}),
?line {1, 2, 3} = id({1, 2, 3}),
?line {1, 2, 3, 4} = id({1, 2, 3, 4}),
?line {1, 2, 3, 4, 5} = id({1, 2, 3, 4, 5}),
?line {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
?line {1, 2, 3, 4, 5, 6} = id({1, 2, 3, 4, 5, 6}),
?line {1, 2, 3, 4, 5, 6, 7} = id({1, 2, 3, 4, 5, 6, 7}),
?line {1, 2, 3, 4, 5, 6, 7, 8} = id({1, 2, 3, 4, 5, 6, 7, 8}),
ok.
%% Tests size(Tuple).
t_size(Config) when is_list(Config) ->
?line 0 = size({}),
?line 1 = size({a}),
?line 1 = size({{a}}),
?line 2 = size({{a}, {b}}),
?line 3 = size({1, 2, 3}),
ok.
t_tuple_size(Config) when is_list(Config) ->
?line 0 = tuple_size(id({})),
?line 1 = tuple_size(id({a})),
?line 1 = tuple_size(id({{a}})),
?line 2 = tuple_size(id({{a},{b}})),
?line 3 = tuple_size(id({1,2,3})),
%% Error cases.
?line {'EXIT',{badarg,_}} = (catch tuple_size([])),
?line {'EXIT',{badarg,_}} = (catch tuple_size(<<1,2,3>>)),
?line error = ludicrous_tuple_size({a,b,c}),
?line error = ludicrous_tuple_size([a,b,c]),
ok.
ludicrous_tuple_size(T)
when tuple_size(T) =:= 16#7777777777777777777777777777777777 -> ok;
ludicrous_tuple_size(_) -> error.
%% Tests element/2.
t_element(Config) when is_list(Config) ->
?line a = element(1, {a}),
?line a = element(1, {a, b}),
?line List = lists:seq(1, 4096),
?line Tuple = list_to_tuple(lists:seq(1, 4096)),
?line get_elements(List, Tuple, 1),
?line {'EXIT', {badarg, _}} = (catch element(0, id({a,b}))),
?line {'EXIT', {badarg, _}} = (catch element(3, id({a,b}))),
?line {'EXIT', {badarg, _}} = (catch element(1, id({}))),
?line {'EXIT', {badarg, _}} = (catch element(1, id([a,b]))),
?line {'EXIT', {badarg, _}} = (catch element(1, id(42))),
?line {'EXIT', {badarg, _}} = (catch element(id(1.5), id({a,b}))),
ok.
get_elements([Element|Rest], Tuple, Pos) ->
?line Element = element(Pos, Tuple),
?line get_elements(Rest, Tuple, Pos+1);
get_elements([], _Tuple, _Pos) ->
ok.
%% Tests set_element/3.
t_setelement(Config) when is_list(Config) ->
?line {x} = setelement(1, id({1}), x),
?line {x,2} = setelement(1, id({1,2}), x),
?line {1,x} = setelement(2, id({1,2}), x),
?line Tuple = list_to_tuple(lists:duplicate(2048, x)),
?line NewTuple = set_all_elements(Tuple, 1),
?line NewTuple = list_to_tuple(lists:seq(1+7, 2048+7)),
?line {'EXIT', {badarg, _}} = (catch setelement(0, {a, b}, x)),
?line {'EXIT', {badarg, _}} = (catch setelement(3, {a, b}, x)),
?line {'EXIT', {badarg, _}} = (catch setelement(1, {}, x)),
?line {'EXIT', {badarg, _}} = (catch setelement(1, [a, b], x)),
?line {'EXIT', {badarg, _}} = (catch setelement(1.5, {a, b}, x)),
%% Nested setelement with literals.
AnotherTuple = id({0,0,a,b,c}),
{93748793749387837476555412,3.0,gurka,b,c} =
setelement(1, setelement(2, setelement(3, AnotherTuple, gurka),
3.0), 93748793749387837476555412),
ok.
set_all_elements(Tuple, Pos) when Pos =< size(Tuple) ->
set_all_elements(setelement(Pos, Tuple, Pos+7), Pos+1);
set_all_elements(Tuple, Pos) when Pos > size(Tuple) ->
Tuple.
%% Tests list_to_tuple/1.
t_list_to_tuple(Config) when is_list(Config) ->
{} = list_to_tuple([]),
{a} = list_to_tuple([a]),
{a, b} = list_to_tuple([a, b]),
{a, b, c} = list_to_tuple([a, b, c]),
{a, b, c, d} = list_to_tuple([a, b, c, d]),
{a, b, c, d, e} = list_to_tuple([a, b, c, d, e]),
Size = 4096,
Tuple = list_to_tuple(lists:seq(1, Size)),
Size = size(Tuple),
{'EXIT', {badarg, _}} = (catch list_to_tuple(id({a,b}))),
{'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
{'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
% test upper boundry, 16777215 elements
MaxSize = 1 bsl 24 - 1,
MaxTuple = list_to_tuple(lists:seq(1, MaxSize)),
MaxSize = size(MaxTuple),
{'EXIT', {badarg,_}} = (catch list_to_tuple(lists:seq(1, 1 bsl 24))),
ok.
%% Tests tuple_to_list/1.
t_tuple_to_list(Config) when is_list(Config) ->
?line [] = tuple_to_list({}),
?line [a] = tuple_to_list({a}),
?line [a, b] = tuple_to_list({a, b}),
?line [a, b, c] = tuple_to_list({a, b, c}),
?line [a, b, c, d] = tuple_to_list({a, b, c, d}),
?line [a, b, c, d] = tuple_to_list({a, b, c, d}),
?line Size = 4096,
?line List = lists:seq(1, Size),
?line Tuple = list_to_tuple(List),
?line Size = size(Tuple),
?line List = tuple_to_list(Tuple),
?line {'EXIT', {badarg,_}} = (catch tuple_to_list(id(a))),
?line {'EXIT', {badarg,_}} = (catch tuple_to_list(id(42))),
ok.
%% Tests the make_tuple/2 BIF.
t_make_tuple_2(Config) when is_list(Config) ->
t_make_tuple1([]),
t_make_tuple1(42),
t_make_tuple1(a),
t_make_tuple1({}),
t_make_tuple1({a}),
t_make_tuple1(erlang:make_tuple(400, [])),
% test upper boundry, 16777215 elements
t_make_tuple(1 bsl 24 - 1, a),
{'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 24, a)),
{'EXIT', {badarg,_}} = (catch erlang:make_tuple(-1, a)),
% 26 bits is the total header arity room (for now)
{'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 26 + 3, a)),
% bignum
{'EXIT', {badarg,_}} = (catch erlang:make_tuple(1 bsl 65 + 3, a)),
ok.
t_make_tuple1(Element) ->
lists:foreach(fun(Size) -> t_make_tuple(Size, Element) end,
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 255, 256, 511, 512, 999,
1000, 1023, 1024, 4095, 4096]).
t_make_tuple(Size, Element) ->
Tuple = erlang:make_tuple(Size, Element),
lists:foreach(fun(El) when El =:= Element ->
ok;
(Other) ->
test_server:fail({got, Other, expected, Element})
end, tuple_to_list(Tuple)).
%% Tests the erlang:make_tuple/3 BIF.
t_make_tuple_3(Config) when is_list(Config) ->
{} = erlang:make_tuple(0, def, []),
{def} = erlang:make_tuple(1, def, []),
{a} = erlang:make_tuple(1, def, [{1,a}]),
{a,def,c,def,e} = erlang:make_tuple(5, def, [{5,e},{1,a},{3,c}]),
{a,def,c,def,e} = erlang:make_tuple(5, def, [{1,blurf},{5,e},{3,blurf},{1,a},{3,c}]),
MaxSize = 1 bsl 16 - 1,
MaxTuple = erlang:make_tuple(MaxSize, def, [{1,blurf},{5,e},{3,blurf},{1,a},{3,c}]),
MaxSize = size(MaxTuple),
%% Error cases.
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(0, def, [{1,a}])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{-1,a}])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{0,a}])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{6,z}])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(a, def, [{6,z}])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{1,a}|b])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [42])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [[a,b,c]])),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, non_list)),
{'EXIT',{badarg,_}} = (catch erlang:make_tuple(1 bsl 24, def, [{5,e},{1,a},{3,c}])),
ok.
%% Tests the append_element/2 BIF.
t_append_element(Config) when is_list(Config) ->
ok = t_append_element({}, 2048, 2048),
% test upper boundry, 16777215 elements
MaxSize = 1 bsl 24 - 1,
MaxTuple = list_to_tuple(lists:seq(1, MaxSize)),
{'EXIT',{badarg,_}} = (catch erlang:append_element(MaxTuple, a)),
ok.
t_append_element(_Tuple, 0, _High) -> ok;
t_append_element(Tuple, N, High) ->
NewTuple = erlang:append_element(Tuple, N),
verify_seq(tuple_to_list(Tuple), High, N),
t_append_element(NewTuple, N-1, High).
verify_seq([], High, High) -> ok;
verify_seq([High], High, High) -> ok;
verify_seq([High|T], High, Lower) ->
verify_seq(T, High-1, Lower).
%% Tests that a case nested inside a tuple is ok.
%% (This is known to crash earlier versions of BEAM.)
tuple_with_case(Config) when is_list(Config) ->
?line {reply, true} = tuple_with_case(),
ok.
tuple_with_case() ->
%% The following comments apply to the BEAM compiler.
foo(), % Reset var count.
{reply, % Compiler will choose {x,1} for tuple.
case foo() of % Call will reset var count.
{'EXIT', Reason} -> % Case will return in {x,1} (first free).
{error, Reason}; % but the tuple will be build in {x,1},
_ -> % so case value is lost and a circular
true % data element is built.
end}.
foo() -> ignored.
%% Test to build a tuple in a guard.
tuple_in_guard(Config) when is_list(Config) ->
?line Tuple1 = id({a,b}),
?line Tuple2 = id({a,b,c}),
?line if
Tuple1 == {element(1, Tuple2),element(2, Tuple2)} ->
ok;
true ->
?line test_server:fail()
end,
?line if
Tuple2 == {element(1, Tuple2),element(2, Tuple2),
element(3, Tuple2)} ->
ok;
true ->
?line test_server:fail()
end,
ok.
%% Use this function to avoid compile-time evaluation of an expression.
id(I) -> I.
|