Merge branch 'egil/r16/insert_delete_element/OTP-10643'

* egil/r16/insert_delete_element/OTP-10643:
  Update preloaded erlang.beam
  erts: Document insert_element and delete_element
  tests: Update tuple_SUITE for insert and delete
  Add insert_element/3 and delete_element/2

6 files changed, 172 insertions, 0 deletions

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 1a97a84b42..2faa46d760 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -626,6 +626,22 @@ false</pre>
 {more,6}</pre>
       </desc>
     </func>
+
+    <func>
+      <name name="delete_element" arity="2"/>
+      <fsummary>Delete element at index in a tuple</fsummary>
+      <type_desc variable="Index">1..tuple_size(<anno>Tuple1</anno>)</type_desc>
+      <desc>
+		  <p>
+			  Returns a new tuple with element at <c><anno>Index</anno></c> removed from
+			  tuple <c><anno>Tuple1</anno></c>.
+		  </p>
+        <pre>
+> <input>erlang:delete_element(2, {one, two, three}).</input>
+{one,three}</pre>
+      </desc>
+    </func>
+
     <func>
       <name name="delete_module" arity="1"/>
       <fsummary>Make the current code for a module old</fsummary>
@@ -1361,6 +1377,24 @@ os_prompt% </pre>
           when the process wakes up.</p>
       </desc>
     </func>
+
+    <func>
+      <name name="insert_element" arity="3"/>
+      <fsummary>Insert an element at index in a tuple</fsummary>
+      <type_desc variable="Index">1..tuple_size(<anno>Tuple1</anno>) + 1</type_desc>
+      <desc>
+		  <p>
+			  Returns a new tuple with element <c><anno>Term</anno></c> insert at position
+			  <c><anno>Index</anno></c> in tuple <c><anno>Tuple1</anno></c>.
+			  All elements from position <c><anno>Index</anno></c> and upwards are subsequently
+			  pushed one step higher in the new tuple <c><anno>Tuple2</anno></c>.
+		  </p>
+        <pre>
+> <input>erlang:insert_element(2, {one, two, three}, new).</input>
+{one,new,two,three}</pre>
+      </desc>
+    </func>
+
     <func>
       <name name="integer_to_list" arity="1"/>
       <fsummary>Text representation of an integer</fsummary>
diff --git a/erts/emulator/beam/bif.c b/erts/emulator/beam/bif.c
index c4ff4fe982..97c8114437 100644
--- a/erts/emulator/beam/bif.c
+++ b/erts/emulator/beam/bif.c
@@ -2526,6 +2526,78 @@ BIF_RETTYPE append_element_2(BIF_ALIST_2)
     BIF_RET(res);
 }
 
+BIF_RETTYPE insert_element_3(BIF_ALIST_3)
+{
+    Eterm* ptr;
+    Eterm* hp;
+    Uint arity;
+    Eterm res;
+    Sint ix;
+
+    if (is_not_tuple(BIF_ARG_2) || is_not_small(BIF_ARG_1)) {
+	BIF_ERROR(BIF_P, BADARG);
+    }
+
+    ptr   = tuple_val(BIF_ARG_2);
+    arity = arityval(*ptr);
+    ix    = signed_val(BIF_ARG_1);
+
+    if ((ix < 1) || (ix > (arity + 1))) {
+	BIF_ERROR(BIF_P, BADARG);
+    }
+
+    hp  = HAlloc(BIF_P, arity + 1 + 1);
+    res = make_tuple(hp);
+    *hp = make_arityval(arity + 1);
+
+    ix--;
+    arity -= ix;
+
+    while (ix--) { *++hp = *++ptr; }
+
+    *++hp = BIF_ARG_3;
+
+    while(arity--) { *++hp = *++ptr; }
+
+    BIF_RET(res);
+}
+
+BIF_RETTYPE delete_element_2(BIF_ALIST_3)
+{
+    Eterm* ptr;
+    Eterm* hp;
+    Uint arity;
+    Eterm res;
+    Sint ix;
+
+    if (is_not_tuple(BIF_ARG_2) || is_not_small(BIF_ARG_1)) {
+	BIF_ERROR(BIF_P, BADARG);
+    }
+
+    ptr   = tuple_val(BIF_ARG_2);
+    arity = arityval(*ptr);
+    ix    = signed_val(BIF_ARG_1);
+
+    if ((ix < 1) || (ix > arity) || (arity == 0)) {
+	BIF_ERROR(BIF_P, BADARG);
+    }
+
+    hp  = HAlloc(BIF_P, arity + 1 - 1);
+    res = make_tuple(hp);
+    *hp = make_arityval(arity - 1);
+
+    ix--;
+    arity -= ix;
+
+    while (ix--) { *++hp = *++ptr; }
+
+    ++ptr;
+
+    while(arity--) { *++hp = *++ptr; }
+
+    BIF_RET(res);
+}
+
 /**********************************************************************/
 
 /* convert an atom to a list of ascii integer */
diff --git a/erts/emulator/beam/bif.tab b/erts/emulator/beam/bif.tab
index 9a1a25031c..1799f15504 100644
--- a/erts/emulator/beam/bif.tab
+++ b/erts/emulator/beam/bif.tab
@@ -821,6 +821,8 @@ bif erlang:dt_append_vm_tag_data/1
 #
 bif erlang:prepare_loading/2
 bif erlang:finish_loading/1
+bif erlang:insert_element/3
+bif erlang:delete_element/2
 
 #
 # Obsolete
diff --git a/erts/emulator/test/tuple_SUITE.erl b/erts/emulator/test/tuple_SUITE.erl
index 978d96a110..a3b2764a5d 100644
--- a/erts/emulator/test/tuple_SUITE.erl
+++ b/erts/emulator/test/tuple_SUITE.erl
@@ -20,6 +20,7 @@
 -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_insert_element/1, t_delete_element/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]).
@@ -41,6 +42,7 @@ 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,
+     t_insert_element, t_delete_element,
      tuple_with_case, tuple_in_guard].
 
 groups() -> 
@@ -262,6 +264,49 @@ t_make_tuple_3(Config) when is_list(Config) ->
 
     ok.
 
+%% Tests the erlang:insert_element/3 BIF.
+t_insert_element(Config) when is_list(Config) ->
+    {a}       = erlang:insert_element(1, {}, a),
+    {{b,b},a} = erlang:insert_element(1, {a}, {b,b}),
+    {a,b}     = erlang:insert_element(2, {a}, b),
+    [b,def|_] = tuple_to_list(erlang:insert_element(1, erlang:make_tuple(1 bsl 20, def), b)),
+    [def,b|_] = tuple_to_list(erlang:insert_element(2, erlang:make_tuple(1 bsl 20, def), b)),
+    [def,b|_] = lists:reverse(tuple_to_list(erlang:insert_element(1 bsl 20, erlang:make_tuple(1 bsl 20, def), b))),
+    [b,def|_] = lists:reverse(tuple_to_list(erlang:insert_element((1 bsl 20) + 1, erlang:make_tuple(1 bsl 20, def), b))),
+
+    %% Error cases.
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(1, [], a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(1, a, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(0, {}, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(0, {b,b,b,b,b}, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(-1, {}, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(2, {}, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(6, {b,b,b,b}, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:insert_element(1 bsl 20, {b,b,b,b}, a)),
+    ok.
+
+%% Tests the erlang:delete_element/3 BIF.
+t_delete_element(Config) when is_list(Config) ->
+    {}        = erlang:delete_element(1, {a}),
+    {{b,b},c} = erlang:delete_element(1, {a,{b,b},c}),
+    {a,b}     = erlang:delete_element(2, {a,c,b}),
+    [2,3|_]   = tuple_to_list(erlang:delete_element(1, list_to_tuple(lists:seq(1, 1 bsl 20)))),
+    [1,3|_]   = tuple_to_list(erlang:delete_element(2, list_to_tuple(lists:seq(1, 1 bsl 20)))),
+    [(1 bsl 20) - 1, (1 bsl 20) - 2 |_] = lists:reverse(tuple_to_list(erlang:delete_element(1 bsl 20, list_to_tuple(lists:seq(1, 1 bsl 20))))),
+    [(1 bsl 20), (1 bsl 20) - 2 |_] = lists:reverse(tuple_to_list(erlang:delete_element((1 bsl 20) - 1, list_to_tuple(lists:seq(1, 1 bsl 20))))),
+
+    %% Error cases.
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(1, [])),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(1, a)),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(0, {})),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(-1, {})),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(1, {})),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(0, {b,b,b,b,b})),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(5, {b,b,b,b})),
+    {'EXIT',{badarg,_}} = (catch erlang:delete_element(1 bsl 20, {b,c,b,b,b})),
+    ok.
+
+
 %% Tests the append_element/2 BIF.
 t_append_element(Config) when is_list(Config) ->
     ok = t_append_element({}, 2048, 2048),
diff --git a/erts/preloaded/ebin/erlang.beam b/erts/preloaded/ebin/erlang.beam
index 074e31fb13..b59c22eb02 100644
--- a/erts/preloaded/ebin/erlang.beam
+++ b/erts/preloaded/ebin/erlang.beam
diff --git a/erts/preloaded/src/erlang.erl b/erts/preloaded/src/erlang.erl
index 51a190b095..739fdde10a 100644
--- a/erts/preloaded/src/erlang.erl
+++ b/erts/preloaded/src/erlang.erl
@@ -79,6 +79,7 @@
 -export([bump_reductions/1, byte_size/1, call_on_load_function/1]).
 -export([cancel_timer/1, check_old_code/1, check_process_code/2, crc32/1]).
 -export([crc32/2, crc32_combine/3, date/0, decode_packet/3]).
+-export([delete_element/2]).
 -export([delete_module/1, demonitor/1, demonitor/2, display/1]).
 -export([display_nl/0, display_string/1, dist_exit/3, erase/0, erase/1]).
 -export([error/1, error/2, exit/1, exit/2, external_size/1]).
@@ -88,6 +89,7 @@
 -export([garbage_collect_message_area/0, get/0, get/1, get_keys/1]).
 -export([get_module_info/1, get_stacktrace/0, group_leader/0]).
 -export([group_leader/2, halt/0, halt/1, halt/2, hash/2, hibernate/3]).
+-export([insert_element/3]).
 -export([integer_to_list/1, iolist_size/1, iolist_to_binary/1]).
 -export([is_alive/0, is_builtin/3, is_process_alive/1, length/1, link/1]).
 -export([list_to_atom/1, list_to_binary/1, list_to_bitstr/1]).
@@ -529,6 +531,14 @@ date() ->
 decode_packet(_Type, _Bin, _Options) ->
     erlang:nif_error(undefined).
 
+%% delete_element/2
+-spec erlang:delete_element(Index, Tuple1) -> Tuple2 when
+      Index  :: pos_integer(),
+      Tuple1 :: tuple(),
+      Tuple2 :: tuple().
+delete_element(_Index, _Tuple1) ->
+    erlang:nif_error(undefined).
+
 %% delete_module/1
 -spec delete_module(Module) -> true | undefined when
       Module :: module().
@@ -820,6 +830,15 @@ hash(_Term, _Range) ->
 hibernate(_Module, _Function, _Args) ->
     erlang:nif_error(undefined).
 
+%% insert_element/3
+-spec erlang:insert_element(Index, Tuple1, Term) -> Tuple2 when
+      Index  :: pos_integer(),
+      Tuple1 :: tuple(),
+      Tuple2 :: tuple(),
+      Term   :: term().
+insert_element(_Index, _Tuple1, _Term) ->
+    erlang:nif_error(undefined).
+
 %% integer_to_list/1
 -spec integer_to_list(Integer) -> string() when
       Integer :: integer().