unittests: Add tests for vim_str2nr

2 files changed, 301 insertions, 1 deletions

diff --git a/test/helpers.lua b/test/helpers.lua
index 20fe23821f..16b9818f12 100644
--- a/test/helpers.lua
+++ b/test/helpers.lua
@@ -310,6 +310,13 @@ local function mergedicts_copy(d1, d2)
   return ret
 end
 
+local function updated(d, d2)
+  for k, v in pairs(d2) do
+    d[k] = v
+  end
+  return d
+end
+
 local function concat_tables(...)
   local ret = {}
   for i = 1, select('#', ...) do
@@ -460,4 +467,5 @@ return {
   format_luav = format_luav,
   format_string = format_string,
   intchar2lua = intchar2lua,
+  updated = updated,
 }
diff --git a/test/unit/charset/vim_str2nr_spec.lua b/test/unit/charset/vim_str2nr_spec.lua
index cfbc77bc2a..9309dc380c 100644
--- a/test/unit/charset/vim_str2nr_spec.lua
+++ b/test/unit/charset/vim_str2nr_spec.lua
@@ -1 +1,293 @@
--- FIXME
+local helpers = require("test.unit.helpers")(after_each)
+local global_helpers = require('test.helpers')
+
+local itp = helpers.gen_itp(it)
+
+local cimport = helpers.cimport
+local ffi = helpers.ffi
+local eq = helpers.eq
+
+local shallowcopy = global_helpers.shallowcopy
+local updated = global_helpers.updated
+
+local lib = cimport('./src/nvim/charset.h')
+
+local ARGTYPES = {
+  num = ffi.typeof('varnumber_T[1]'),
+  unum = ffi.typeof('uvarnumber_T[1]'),
+  pre = ffi.typeof('int[1]'),
+  len = ffi.typeof('int[1]'),
+}
+
+local icnt = -42
+local ucnt = 4242
+
+local function arginit(arg)
+  if arg == 'unum' then
+    ucnt = ucnt + 1
+    return ARGTYPES[arg]({ucnt})
+  else
+    icnt = icnt - 1
+    return ARGTYPES[arg]({icnt})
+  end
+end
+
+local function test_vim_str2nr(s, what, exp, maxlen)
+  local comb = {[''] = {}}
+  for k, _ in pairs(exp) do
+    for ck, cv in pairs(comb) do
+      comb[ck .. ',' .. k] = updated(shallowcopy(cv), { [k] = arginit(k) })
+    end
+  end
+  maxlen = maxlen or #s
+  for _, cv in pairs(comb) do
+    lib.vim_str2nr(s, cv.pre, cv.len, what, cv.num, cv.unum, maxlen)
+    for cck, ccv in pairs(cv) do
+      if exp[cck] ~= tonumber(ccv[0]) then
+        error(('Failed check (%s = %d) in test (s=%s, w=%u, m=%d): %d'):format(
+          cck, exp[cck], s, tonumber(what), maxlen, tonumber(ccv[0])
+        ))
+      end
+    end
+  end
+end
+
+describe('vim_str2nr()', function()
+  itp('works fine when it has nothing to do', function()
+    test_vim_str2nr('', 0, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_ALL, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_BIN, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_OCT, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_HEX, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_FORCE + lib.STR2NR_DEC, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_FORCE + lib.STR2NR_BIN, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_FORCE + lib.STR2NR_OCT, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+    test_vim_str2nr('', lib.STR2NR_FORCE + lib.STR2NR_HEX, {len = 0, num = 0, unum = 0, pre = 0}, 0)
+  end)
+  itp('works with decimal numbers', function()
+    for _, flags in ipairs({
+      0,
+      lib.STR2NR_BIN,
+      lib.STR2NR_OCT,
+      lib.STR2NR_HEX,
+      lib.STR2NR_BIN + lib.STR2NR_OCT,
+      lib.STR2NR_BIN + lib.STR2NR_HEX,
+      lib.STR2NR_OCT + lib.STR2NR_HEX,
+      lib.STR2NR_ALL,
+      lib.STR2NR_FORCE + lib.STR2NR_DEC,
+    }) do
+      -- Check that all digits are recognized
+      test_vim_str2nr( '12345',  flags, {len = 5, num =  12345, unum = 12345, pre = 0}, 0)
+      test_vim_str2nr( '67890',  flags, {len = 5, num =  67890, unum = 67890, pre = 0}, 0)
+      test_vim_str2nr( '12345A',  flags, {len = 5, num =  12345, unum = 12345, pre = 0}, 0)
+      test_vim_str2nr( '67890A',  flags, {len = 5, num =  67890, unum = 67890, pre = 0}, 0)
+
+      test_vim_str2nr( '42',  flags, {len = 2, num =  42, unum = 42, pre = 0}, 0)
+      test_vim_str2nr( '42',  flags, {len = 1, num =   4, unum =  4, pre = 0}, 1)
+      test_vim_str2nr( '42',  flags, {len = 2, num =  42, unum = 42, pre = 0}, 2)
+      test_vim_str2nr( '42',  flags, {len = 2, num =  42, unum = 42, pre = 0}, 3)  -- includes NUL byte in maxlen
+
+      test_vim_str2nr( '42x', flags, {len = 2, num =  42, unum = 42, pre = 0}, 0)
+      test_vim_str2nr( '42x', flags, {len = 2, num =  42, unum = 42, pre = 0}, 3)
+
+      test_vim_str2nr('-42',  flags, {len = 3, num = -42, unum = 42, pre = 0}, 3)
+      test_vim_str2nr('-42',  flags, {len = 1, num =   0, unum =  0, pre = 0}, 1)
+
+      test_vim_str2nr('-42x', flags, {len = 3, num = -42, unum = 42, pre = 0}, 0)
+      test_vim_str2nr('-42x', flags, {len = 3, num = -42, unum = 42, pre = 0}, 4)
+    end
+  end)
+  itp('works with binary numbers', function()
+    for _, flags in ipairs({
+      lib.STR2NR_BIN,
+      lib.STR2NR_BIN + lib.STR2NR_OCT,
+      lib.STR2NR_BIN + lib.STR2NR_HEX,
+      lib.STR2NR_ALL,
+      lib.STR2NR_FORCE + lib.STR2NR_BIN,
+    }) do
+      local bin
+      local BIN
+      if flags > lib.STR2NR_FORCE then
+        bin = 0
+        BIN = 0
+      else
+        bin = ('b'):byte()
+        BIN = ('B'):byte()
+      end
+
+      test_vim_str2nr( '0b101',  flags, {len = 5, num =   5, unum =  5, pre = bin}, 0)
+      test_vim_str2nr( '0b101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr( '0b101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr( '0b101',  flags, {len = 3, num =   1, unum =  1, pre = bin}, 3)
+      test_vim_str2nr( '0b101',  flags, {len = 4, num =   2, unum =  2, pre = bin}, 4)
+      test_vim_str2nr( '0b101',  flags, {len = 5, num =   5, unum =  5, pre = bin}, 5)
+      test_vim_str2nr( '0b101',  flags, {len = 5, num =   5, unum =  5, pre = bin}, 6)
+
+      test_vim_str2nr( '0b1012', flags, {len = 5, num =   5, unum =  5, pre = bin}, 0)
+      test_vim_str2nr( '0b1012', flags, {len = 5, num =   5, unum =  5, pre = bin}, 6)
+
+      test_vim_str2nr('-0b101',  flags, {len = 6, num =  -5, unum =  5, pre = bin}, 0)
+      test_vim_str2nr('-0b101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr('-0b101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr('-0b101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 3)
+      test_vim_str2nr('-0b101',  flags, {len = 4, num =  -1, unum =  1, pre = bin}, 4)
+      test_vim_str2nr('-0b101',  flags, {len = 5, num =  -2, unum =  2, pre = bin}, 5)
+      test_vim_str2nr('-0b101',  flags, {len = 6, num =  -5, unum =  5, pre = bin}, 6)
+      test_vim_str2nr('-0b101',  flags, {len = 6, num =  -5, unum =  5, pre = bin}, 7)
+
+      test_vim_str2nr('-0b1012', flags, {len = 6, num =  -5, unum =  5, pre = bin}, 0)
+      test_vim_str2nr('-0b1012', flags, {len = 6, num =  -5, unum =  5, pre = bin}, 7)
+
+      test_vim_str2nr( '0B101',  flags, {len = 5, num =   5, unum =  5, pre = BIN}, 0)
+      test_vim_str2nr( '0B101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr( '0B101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr( '0B101',  flags, {len = 3, num =   1, unum =  1, pre = BIN}, 3)
+      test_vim_str2nr( '0B101',  flags, {len = 4, num =   2, unum =  2, pre = BIN}, 4)
+      test_vim_str2nr( '0B101',  flags, {len = 5, num =   5, unum =  5, pre = BIN}, 5)
+      test_vim_str2nr( '0B101',  flags, {len = 5, num =   5, unum =  5, pre = BIN}, 6)
+
+      test_vim_str2nr( '0B1012', flags, {len = 5, num =   5, unum =  5, pre = BIN}, 0)
+      test_vim_str2nr( '0B1012', flags, {len = 5, num =   5, unum =  5, pre = BIN}, 6)
+
+      test_vim_str2nr('-0B101',  flags, {len = 6, num =  -5, unum =  5, pre = BIN}, 0)
+      test_vim_str2nr('-0B101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr('-0B101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr('-0B101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 3)
+      test_vim_str2nr('-0B101',  flags, {len = 4, num =  -1, unum =  1, pre = BIN}, 4)
+      test_vim_str2nr('-0B101',  flags, {len = 5, num =  -2, unum =  2, pre = BIN}, 5)
+      test_vim_str2nr('-0B101',  flags, {len = 6, num =  -5, unum =  5, pre = BIN}, 6)
+      test_vim_str2nr('-0B101',  flags, {len = 6, num =  -5, unum =  5, pre = BIN}, 7)
+
+      test_vim_str2nr('-0B1012', flags, {len = 6, num =  -5, unum =  5, pre = BIN}, 0)
+      test_vim_str2nr('-0B1012', flags, {len = 6, num =  -5, unum =  5, pre = BIN}, 7)
+
+      if flags > lib.STR2NR_FORCE then
+        test_vim_str2nr('-101', flags, {len = 4, num = -5, unum = 5, pre = 0}, 0)
+      end
+    end
+  end)
+  itp('works with octal numbers', function()
+    for _, flags in ipairs({
+      lib.STR2NR_OCT,
+      lib.STR2NR_OCT + lib.STR2NR_BIN,
+      lib.STR2NR_OCT + lib.STR2NR_HEX,
+      lib.STR2NR_ALL,
+      lib.STR2NR_FORCE + lib.STR2NR_OCT,
+    }) do
+      local oct
+      if flags > lib.STR2NR_FORCE then
+        oct = 0
+      else
+        oct = ('0'):byte()
+      end
+
+      -- Check that all digits are recognized
+      test_vim_str2nr( '012345670', flags, {len = 9, num = 2739128, unum = 2739128, pre = oct}, 0)
+
+      test_vim_str2nr( '054',  flags, {len = 3, num =  44, unum = 44, pre = oct}, 0)
+      test_vim_str2nr( '054',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr( '054',  flags, {len = 2, num =   5, unum =  5, pre = oct}, 2)
+      test_vim_str2nr( '054',  flags, {len = 3, num =  44, unum = 44, pre = oct}, 3)
+      test_vim_str2nr( '0548', flags, {len = 3, num =  44, unum = 44, pre = oct}, 3)
+      test_vim_str2nr( '054',  flags, {len = 3, num =  44, unum = 44, pre = oct}, 4)
+
+      test_vim_str2nr( '054x', flags, {len = 3, num =  44, unum = 44, pre = oct}, 4)
+      test_vim_str2nr( '054x', flags, {len = 3, num =  44, unum = 44, pre = oct}, 0)
+
+      test_vim_str2nr('-054',  flags, {len = 4, num = -44, unum = 44, pre = oct}, 0)
+      test_vim_str2nr('-054',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr('-054',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr('-054',  flags, {len = 3, num =  -5, unum =  5, pre = oct}, 3)
+      test_vim_str2nr('-054',  flags, {len = 4, num = -44, unum = 44, pre = oct}, 4)
+      test_vim_str2nr('-0548', flags, {len = 4, num = -44, unum = 44, pre = oct}, 4)
+      test_vim_str2nr('-054',  flags, {len = 4, num = -44, unum = 44, pre = oct}, 5)
+
+      test_vim_str2nr('-054x', flags, {len = 4, num = -44, unum = 44, pre = oct}, 5)
+      test_vim_str2nr('-054x', flags, {len = 4, num = -44, unum = 44, pre = oct}, 0)
+
+      if flags > lib.STR2NR_FORCE then
+        test_vim_str2nr('-54', flags, {len = 3, num = -44, unum = 44, pre = 0}, 0)
+        test_vim_str2nr('-0548', flags, {len = 4, num = -44, unum = 44, pre = 0}, 5)
+        test_vim_str2nr('-0548', flags, {len = 4, num = -44, unum = 44, pre = 0}, 0)
+      else
+        test_vim_str2nr('-0548', flags, {len = 5, num = -548, unum = 548, pre = 0}, 5)
+        test_vim_str2nr('-0548', flags, {len = 5, num = -548, unum = 548, pre = 0}, 0)
+      end
+    end
+  end)
+  itp('works with hexadecimal numbers', function()
+    for _, flags in ipairs({
+      lib.STR2NR_HEX,
+      lib.STR2NR_HEX + lib.STR2NR_BIN,
+      lib.STR2NR_HEX + lib.STR2NR_OCT,
+      lib.STR2NR_ALL,
+      lib.STR2NR_FORCE + lib.STR2NR_HEX,
+    }) do
+      local hex
+      local HEX
+      if flags > lib.STR2NR_FORCE then
+        hex = 0
+        HEX = 0
+      else
+        hex = ('x'):byte()
+        HEX = ('X'):byte()
+      end
+
+      -- Check that all digits are recognized
+      test_vim_str2nr('0x12345', flags, {len = 7, num = 74565, unum = 74565, pre = hex}, 0)
+      test_vim_str2nr('0x67890', flags, {len = 7, num = 424080, unum = 424080, pre = hex}, 0)
+      test_vim_str2nr('0xABCDEF', flags, {len = 8, num = 11259375, unum = 11259375, pre = hex}, 0)
+      test_vim_str2nr('0xabcdef', flags, {len = 8, num = 11259375, unum = 11259375, pre = hex}, 0)
+
+      test_vim_str2nr( '0x101',  flags, {len = 5, num = 257, unum =257, pre = hex}, 0)
+      test_vim_str2nr( '0x101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr( '0x101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr( '0x101',  flags, {len = 3, num =   1, unum =  1, pre = hex}, 3)
+      test_vim_str2nr( '0x101',  flags, {len = 4, num =  16, unum = 16, pre = hex}, 4)
+      test_vim_str2nr( '0x101',  flags, {len = 5, num = 257, unum =257, pre = hex}, 5)
+      test_vim_str2nr( '0x101',  flags, {len = 5, num = 257, unum =257, pre = hex}, 6)
+
+      test_vim_str2nr( '0x101G', flags, {len = 5, num = 257, unum =257, pre = hex}, 0)
+      test_vim_str2nr( '0x101G', flags, {len = 5, num = 257, unum =257, pre = hex}, 6)
+
+      test_vim_str2nr('-0x101',  flags, {len = 6, num =-257, unum =257, pre = hex}, 0)
+      test_vim_str2nr('-0x101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr('-0x101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr('-0x101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 3)
+      test_vim_str2nr('-0x101',  flags, {len = 4, num =  -1, unum =  1, pre = hex}, 4)
+      test_vim_str2nr('-0x101',  flags, {len = 5, num = -16, unum = 16, pre = hex}, 5)
+      test_vim_str2nr('-0x101',  flags, {len = 6, num =-257, unum =257, pre = hex}, 6)
+      test_vim_str2nr('-0x101',  flags, {len = 6, num =-257, unum =257, pre = hex}, 7)
+
+      test_vim_str2nr('-0x101G', flags, {len = 6, num =-257, unum =257, pre = hex}, 0)
+      test_vim_str2nr('-0x101G', flags, {len = 6, num =-257, unum =257, pre = hex}, 7)
+
+      test_vim_str2nr( '0X101',  flags, {len = 5, num = 257, unum =257, pre = HEX}, 0)
+      test_vim_str2nr( '0X101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr( '0X101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr( '0X101',  flags, {len = 3, num =   1, unum =  1, pre = HEX}, 3)
+      test_vim_str2nr( '0X101',  flags, {len = 4, num =  16, unum = 16, pre = HEX}, 4)
+      test_vim_str2nr( '0X101',  flags, {len = 5, num = 257, unum =257, pre = HEX}, 5)
+      test_vim_str2nr( '0X101',  flags, {len = 5, num = 257, unum =257, pre = HEX}, 6)
+
+      test_vim_str2nr( '0X101G', flags, {len = 5, num = 257, unum =257, pre = HEX}, 0)
+      test_vim_str2nr( '0X101G', flags, {len = 5, num = 257, unum =257, pre = HEX}, 6)
+
+      test_vim_str2nr('-0X101',  flags, {len = 6, num =-257, unum =257, pre = HEX}, 0)
+      test_vim_str2nr('-0X101',  flags, {len = 1, num =   0, unum =  0, pre = 0  }, 1)
+      test_vim_str2nr('-0X101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 2)
+      test_vim_str2nr('-0X101',  flags, {len = 2, num =   0, unum =  0, pre = 0  }, 3)
+      test_vim_str2nr('-0X101',  flags, {len = 4, num =  -1, unum =  1, pre = HEX}, 4)
+      test_vim_str2nr('-0X101',  flags, {len = 5, num = -16, unum = 16, pre = HEX}, 5)
+      test_vim_str2nr('-0X101',  flags, {len = 6, num =-257, unum =257, pre = HEX}, 6)
+      test_vim_str2nr('-0X101',  flags, {len = 6, num =-257, unum =257, pre = HEX}, 7)
+
+      test_vim_str2nr('-0X101G', flags, {len = 6, num =-257, unum =257, pre = HEX}, 0)
+      test_vim_str2nr('-0X101G', flags, {len = 6, num =-257, unum =257, pre = HEX}, 7)
+
+      if flags > lib.STR2NR_FORCE then
+        test_vim_str2nr('-101', flags, {len = 4, num = -257, unum = 257, pre = 0}, 0)
+      end
+    end
+  end)
+end)