patch 8.2.1081: Lua: cannot use table.insert() and table.remove()

Problem:    Lua: cannot use table.insert() and table.remove().
Solution:   Add the list functions. (Prabir Shrestha, closes #6353)

diff --git a/runtime/doc/if_lua.txt b/runtime/doc/if_lua.txt
index f32be7c37959ae66c08fbb5f1ae25f4fb0451836..214179641d75bcdc7316964492c4f56bbcdf5ec9 100644 (file)
--- a/runtime/doc/if_lua.txt
+++ b/runtime/doc/if_lua.txt
@@ -227,8 +227,17 @@ Properties
            in Vim.
        o "l[k]" returns the k-th item in "l"; "l" is one-indexed, as in Lua.
            To modify the k-th item, simply do "l[k] = newitem"; in
-           particular, "l[k] = nil" removes the k-th item from "l".
+           particular, "l[k] = nil" removes the k-th item from "l". Item can
+           be added to the end of the list by "l[#l + 1] = newitem"
        o "l()" returns an iterator for "l".
+       o "table.insert(l, newitem)" inserts an item at the end of the list.
+           (only Lua 5.3 and later)
+       o "table.insert(l, position, newitem)" inserts an item at the
+           specified position. "position" is one-indexed.  (only Lua 5.3 and
+           later)
+       o "table.remove(l, position)" removes an item at the specified
+           position. "position" is one-indexed.
+
 
 Methods
 -------
@@ -246,8 +255,11 @@ Examples:
        :lua l[1] = nil -- remove first item
        :lua l:insert(true, 1)
        :lua print(l, #l, l[1], l[2])
+       :lua l[#l + 1] = 'value'
+       :lua table.insert(l, 100)
+       :lua table.insert(l, 2, 200)
+       :lua table.remove(l, 1)
        :lua for item in l() do print(item) end
-<
 
 ==============================================================================
 4. Dict userdata                                       *lua-dict*

diff --git a/src/if_lua.c b/src/if_lua.c
index 2d02f7c58d493066fda4946c2409b0cb074288e5..c5fc683212666819c3669801dd4901f6b7636944 100644 (file)
--- a/src/if_lua.c
+++ b/src/if_lua.c
@@ -913,19 +913,32 @@ luaV_list_newindex(lua_State *L)
     if (l->lv_lock)
        luaL_error(L, "list is locked");
     li = list_find(l, n);
-    if (li == NULL) return 0;
-    if (lua_isnil(L, 3)) // remove?
+    if (li == NULL)
     {
-       vimlist_remove(l, li, li);
-       listitem_free(l, li);
+        if (!lua_isnil(L, 3))
+        {
+          typval_T v;
+          luaV_checktypval(L, 3, &v, "inserting list item");
+          if (list_insert_tv(l, &v, li) == FAIL)
+               luaL_error(L, "failed to add item to list");
+          clear_tv(&v);
+        }
     }
     else
     {
-       typval_T v;
-       luaV_checktypval(L, 3, &v, "setting list item");
-       clear_tv(&li->li_tv);
-       copy_tv(&v, &li->li_tv);
-       clear_tv(&v);
+        if (lua_isnil(L, 3)) // remove?
+        {
+           vimlist_remove(l, li, li);
+           listitem_free(l, li);
+        }
+        else
+        {
+           typval_T v;
+           luaV_checktypval(L, 3, &v, "setting list item");
+           clear_tv(&li->li_tv);
+           copy_tv(&v, &li->li_tv);
+           clear_tv(&v);
+        }
     }
     return 0;
 }

diff --git a/src/testdir/test_lua.vim b/src/testdir/test_lua.vim
index 9d5ad6864ea6af21dfbe81415e03754913084011..e1ad5004bed5ab78c7f12bd987e07e8e248f4d8b 100644 (file)
--- a/src/testdir/test_lua.vim
+++ b/src/testdir/test_lua.vim
@@ -353,6 +353,32 @@ func Test_lua_list_table()
   call assert_fails('lua vim.list(true)', '[string "vim chunk"]:1: table expected, got boolean')
 endfunc
 
+func Test_lua_list_table_insert_remove()
+  let luaver = split(split(luaeval('_VERSION'), ' ')[1], '\.')
+  let major = str2nr(luaver[0])
+  let minor = str2nr(luaver[1])
+
+  if major < 5 || (major == 5 && minor < 3)
+    throw 'Skipped: Lua version < 5.3'
+  endif
+
+  let l = [1, 2] 
+  lua t = vim.eval('l')
+  lua table.insert(t, 10)
+  lua t[#t + 1] = 20
+  lua table.insert(t, 2, 30)
+  call assert_equal(l, [1, 30, 2, 10, 20])
+  lua table.remove(t, 2)
+  call assert_equal(l, [1, 2, 10, 20])
+  lua t[3] = nil
+  call assert_equal(l, [1, 2, 20])
+  lua removed_value = table.remove(t, 3)
+  call assert_equal(luaeval('removed_value'), 20)
+  lua t = nil
+  lua removed_value = nil
+  unlet l
+endfunc
+
 " Test l() i.e. iterator on list
 func Test_lua_list_iter()
   lua l = vim.list():add('foo'):add('bar')

diff --git a/src/version.c b/src/version.c
index 0c24515bc802e172ca9ef79ed28ac1fb5afb3bf9..69c89ff443033b73629ef6138284ebf28139a045 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -754,6 +754,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1081,
 /**/
     1080,
 /**/