Add some table functions

- Add table.pack
- Add table.insert
- Add table.remove
- Add table.sort
- Change ipairs to make it return 3 values, iter, i and v.
- Add Lua and pico8 tests for table.pack, table.insert, table.remove, table.sort and return values for ipairs.
- Add comments to let the user know about getmetatable and rawget dependencies.
- generate_pico8.py now exports missing.lua in 1-space indentation.
- generate_package.py now exports the "table" table.

Author: adamscott

generate_package.py

@@ -7,10 +7,14 @@
     matches = []
     with open('missing.lua', 'r') as r:
         for line in r:
-            match = re.match(r'function (\w+) \(', line)
-            if match is not None:
+            function_match = re.match(r'function (\w+) \(', line)
+            table_match = re.match(r'(table) = \{\}', line)
+            if function_match is not None:
                 line = re.sub(r'(function \w+ \()', r'local \1', line)
-                matches.append(match.group(1))
+                matches.append(function_match.group(1))
+            elif table_match is not None:
+                line = re.sub(r'(table = \{\})', r'local \1', line)
+                matches.append(table_match.group(1))
             w.write(line)
         r.close()
     w.write("\n")

generate_pico8.py

@@ -7,7 +7,21 @@
     lua_content = None
     missing_content = None
     with open('missing.lua', 'r') as r:
-        lua_content = r.read()
+        lua_content = ""
+        for line in r:
+            if re.match(r'^ {12}[\w.]+', line) is not None:
+                line = re.sub(r'^ {12}([\w.]+)', r'   \1', line)
+            elif re.match(r'^ {10}[\w.]+', line) is not None:
+                line = re.sub(r'^ {10}([\w.]+)', r'   \1', line)
+            elif re.match(r'^ {8}[\w.]+', line) is not None:
+                line = re.sub(r'^ {8}([\w.]+)', r'   \1', line)
+            elif re.match(r'^ {6}[\w.]+', line) is not None:
+                line = re.sub(r'^ {6}([\w.]+)', r'   \1', line)
+            elif re.match(r'^ {4}[\w.]+', line) is not None:
+                line = re.sub(r'^ {4}([\w.]+)', r'  \1', line)
+            elif re.match(r'^ {2}[\w.]+', line) is not None:
+                line = re.sub(r'^ {2}([\w.]+)', r' \1', line)
+            lua_content += line
         r.close()
     with open('template_missing.p8', 'r') as r:
         missing_content = r.read()

missing.lua

@@ -1,15 +1,17 @@
--- pico8-missing-builtins v0.1.3
+-- pico8-missing-builtins v0.2.0
 -- https://github.com/adamscott/pico8-missing-builtins
 __setmetatable = setmetatable
 __metatables = {}
 function setmetatable (object, mt)
   __metatables[object] = mt
   return __setmetatable(object, mt)
 end
+-- getmetatable depends on this setmetatable implementation
 function getmetatable (object)
   return __metatables[object]
 end
 
+-- rawget depends on getmetatable
 function rawget (tbl, index)
   assert(type(tbl) == 'table', "bad argument #1 to 'rawget' "
     .."(table expected, got "..type(tbl)..")")
@@ -44,11 +46,78 @@ function unpack (arr, i, j)
   return create_arg(l)
 end
 
-function ipairs (arr)
-  local i, n = 0, #arr
-  return function ()
+function ipairs (a)
+  local function iter(a, i)
     i = i + 1
-    if i <= n then return i, arr[i] end
+    local v = a[i]
+    if v then
+      return i, v
+    end
+  end
+  return iter, a, 0
+end
+
+table = {}
+table.pack = function (...) return {...} end
+table.unpack = unpack
+
+function table.insert (list, pos, value)
+  assert(type(list) == 'table', "bad argument #1 to 'insert' "
+    .."(table expected, got "..type(list)..")")
+  if pos and not value then
+    value = pos
+    pos = #list + 1
+  else
+    assert(type(pos) == 'number', "bad argument #2 to 'insert' "
+      .."(number expected, got "..type(pos)..")")
+  end
+  if pos <= #list then
+    for i = #list, pos, -1 do
+      list[i + 1] = list[i]
+    end
+  end
+  list[pos] = value
+end
+
+function table.remove(list, pos)
+  assert(type(list) == 'table', "bad argument #1 to 'remove' "
+    .."(table expected, got "..type(list)..")")
+  if not pos then
+    pos = #list
+  else
+    assert(type(pos) == 'number', "bad argument #2 to 'remove' "
+      .."(number expected, got "..type(tbl)..")")
+  end
+  for i = pos, #list do
+    list[i] = list[i + 1]
+  end
+end
+
+function table.sort (arr, comp)
+  if not comp then
+    comp = function (a, b)
+      return a < b
+    end
+  end
+  local function partition (a, lo, hi)
+      pivot = a[hi]
+      i = lo - 1
+      for j = lo, hi - 1 do
+        if comp(a[j], pivot) then
+          i = i + 1
+          a[i], a[j] = a[j], a[i]
+        end
+      end
+      a[i + 1], a[hi] = a[hi], a[i + 1]
+      return i + 1
+    end
+  local function quicksort (a, lo, hi)
+    if lo < hi then
+      p = partition(a, lo, hi)
+      quicksort(a, lo, p - 1)
+      return quicksort(a, p + 1, hi)
+    end
   end
+  return quicksort(arr, 1, #arr)
 end
 -- END pico8-missing-builtins v0.1.3

template_missing.p8

@@ -15,6 +15,10 @@ function _init()
   test_rawget()
   test_unpack()
   test_ipairs()
+  test_table_pack()
+  test_table_insert()
+  test_table_remove()
+  test_table_sort()
   print("every test passed.")
 end
 
@@ -211,6 +215,99 @@ function test_ipairs()
   for i,v in ipairs(test_table) do
     assert(2^i == v, "fail")
   end
+  printh("----> return an iter function")
+  test_table = {2,4,8,16,32,64,128,256,512,1024}
+  iter, i, v = ipairs(test_table)
+  assert(type(iter) == "function", "fail")
+  printh("pass")
+end
+
+function test_table_pack()
+  printh("==> 'table.pack'")
+  printh("----> pack values")
+  local values = table.pack(1,2,3,4,5)
+  assert(values[1] == 1, "fail")
+  assert(values[2] == 2, "fail")
+  assert(values[3] == 3, "fail")
+  assert(values[4] == 4, "fail")
+  assert(values[5] == 5, "fail")
+  printh("pass")
+end
+
+function test_table_insert()
+  printh("==> 'table.insert'")
+  printh("----> insert value")
+  local test_table = {22,-20,67,1009,-500}
+  table.insert(test_table, 10)
+  assert(test_table[1] == 22, "fail")
+  assert(test_table[2] == -20, "fail")
+  assert(test_table[3] == 67, "fail")
+  assert(test_table[4] == 1009, "fail")
+  assert(test_table[5] == -500, "fail")
+  assert(test_table[6] == 10, "fail")
+  printh("----> insert value at specified pos")
+  test_table = {-3,-2,-1,0,2,3}
+  table.insert(test_table, 5, 1)
+  assert(test_table[1] == -3, "fail")
+  assert(test_table[2] == -2, "fail")
+  assert(test_table[3] == -1, "fail")
+  assert(test_table[4] == 0, "fail")
+  assert(test_table[5] == 1, "fail")
+  assert(test_table[6] == 2, "fail")
+  assert(test_table[7] == 3, "fail")
+  printh("pass")
+end
+
+function test_table_remove()
+  printh("==> 'table.remove'")
+  printh("----> remove value")
+  local test_table = {-3,-2,-1,0,1,2,3}
+  table.remove(test_table)
+  assert(test_table[1] == -3, "fail")
+  assert(test_table[2] == -2, "fail")
+  assert(test_table[3] == -1, "fail")
+  assert(test_table[4] == 0, "fail")
+  assert(test_table[5] == 1, "fail")
+  assert(test_table[6] == 2, "fail")
+  assert(test_table[7] == nil, "fail")
+  printh("----> remove value at specified pos")
+  test_table = {-3,-2,-1,0,1,2,3}
+  table.remove(test_table, 1)
+  assert(test_table[1] == -2, "fail")
+  assert(test_table[2] == -1, "fail")
+  assert(test_table[3] == 0, "fail")
+  assert(test_table[4] == 1, "fail")
+  assert(test_table[5] == 2, "fail")
+  assert(test_table[6] == 3, "fail")
+  assert(test_table[7] == nil, "fail")
+  printh("pass")
+end
+
+function test_table_sort()
+  printh("==> 'table.sort'")
+  printh("----> sort simple table")
+  local test_table = {33,3,333,87,13,252,-29}
+  table.sort(test_table)
+  assert(test_table[1] == -29, "fail")
+  assert(test_table[2] == 3, "fail")
+  assert(test_table[3] == 13, "fail")
+  assert(test_table[4] == 33, "fail")
+  assert(test_table[5] == 87, "fail")
+  assert(test_table[6] == 252, "fail")
+  assert(test_table[7] == 333, "fail")
+  printh("----> sort simple table with given comp function")
+  local function desc(a,b)
+    return a > b
+  end
+  test_table = {33,3,333,87,13,252,-29}
+  table.sort(test_table, desc)
+  assert(test_table[1] == 333, "fail")
+  assert(test_table[2] == 252, "fail")
+  assert(test_table[3] == 87, "fail")
+  assert(test_table[4] == 33, "fail")
+  assert(test_table[5] == 13, "fail")
+  assert(test_table[6] == 3, "fail")
+  assert(test_table[7] == -29, "fail")
   printh("pass")
 end
 

test.lua

@@ -221,4 +221,107 @@ describe("missing -ipairs-", function()
       assert.are.equals(2^i, v)
     end
   end)
+
+  it("should return a iter function", function()
+    local test_table = {2,4,8,16,32,64,128,256,512,1024}
+    iter, i, v = missing.ipairs(test_table)
+    assert.are.equals(type(iter), 'function')
+  end)
+end)
+
+describe("missing -table.pack-", function()
+  it("should pack", function()
+    local test_table_native = table.pack(-1,0,1,2,3,4,5)
+    local test_table_missing = missing.table.pack(-1,0,1,2,3,4,5)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+end)
+
+describe("missing -table.insert-", function()
+  it("should insert a value in a simple table", function()
+    local function generate_table()
+      return {22,-20,67,1009,-500}
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.insert(test_table_native, 10)
+    missing.table.insert(test_table_missing, 10)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+
+  it("should insert a value at specified pos in a table", function()
+    local function generate_table()
+      return {-3,-2,-1,0,2,3}
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.insert(test_table_native, 5, 1)
+    missing.table.insert(test_table_missing, 5, 1)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+end)
+
+describe("missing -table.remove-", function()
+  it("should remove an element from a given table", function()
+    local function generate_table()
+      return {-3,-2,-1,0,1,2,3}
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.remove(test_table_native)
+    missing.table.remove(test_table_missing)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+
+  it("should remove an specified element from a given table", function()
+    local function generate_table()
+      return {-3,-2,-1,0,1,2,3}
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.remove(test_table_native, 1)
+    missing.table.remove(test_table_missing, 1)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+end)
+
+describe("missing -table.sort-", function()
+  it("should sort a simple table", function()
+    local function generate_table()
+      return {33,3,333,87,13,252,-29}
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.sort(test_table_native)
+    missing.table.sort(test_table_missing)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
+
+  it("should sort a simple table with a given comp function", function()
+    local function generate_table()
+      return {33,3,333,87,13,252,-29}
+    end
+    local function desc(a, b)
+      return a > b
+    end
+    local test_table_native = generate_table()
+    local test_table_missing = generate_table()
+    table.sort(test_table_native, desc)
+    missing.table.sort(test_table_missing, desc)
+    for i,v in ipairs(test_table_native) do
+      assert.are.equals(test_table_native[i], test_table_missing[i])
+    end
+  end)
 end)