%%
%% %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) ->
?line {} = list_to_tuple([]),
?line {a} = list_to_tuple([a]),
?line {a, b} = list_to_tuple([a, b]),
?line {a, b, c} = list_to_tuple([a, b, c]),
?line {a, b, c, d} = list_to_tuple([a, b, c, d]),
?line {a, b, c, d, e} = list_to_tuple([a, b, c, d, e]),
?line Size = 4096,
?line Tuple = list_to_tuple(lists:seq(1, Size)),
?line Size = size(Tuple),
?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id({a,b}))),
?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
?line {'EXIT', {badarg, _}} = (catch list_to_tuple(id([a|b]))),
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) ->
?line t_make_tuple1([]),
?line t_make_tuple1(42),
?line t_make_tuple1(a),
?line t_make_tuple1({}),
?line t_make_tuple1({a}),
?line t_make_tuple1(erlang:make_tuple(400, [])),
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) ->
?line {} = erlang:make_tuple(0, def, []),
?line {def} = erlang:make_tuple(1, def, []),
?line {a} = erlang:make_tuple(1, def, [{1,a}]),
?line {a,def,c,def,e} = erlang:make_tuple(5, def, [{5,e},{1,a},{3,c}]),
?line {a,def,c,def,e} = erlang:make_tuple(5, def,
[{1,blurf},{5,e},{3,blurf},
{1,a},{3,c}]),
%% Error cases.
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(0, def, [{1,a}])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{-1,a}])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{0,a}])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{6,z}])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(a, def, [{6,z}])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [{1,a}|b])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [42])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, [[a,b,c]])),
?line {'EXIT',{badarg,_}} = (catch erlang:make_tuple(5, def, non_list)),
ok.
%% Tests the append_element/2 BIF.
t_append_element(Config) when is_list(Config) ->
t_append_element({}, 2048, 2048).
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.
