runtime: Add autoload/shada.vim helper file

Contains most of the logic

1 files changed, 2082 insertions, 0 deletions

diff --git a/test/functional/plugin/shada_spec.lua b/test/functional/plugin/shada_spec.lua
new file mode 100644
index 0000000000..7595517d25
--- /dev/null
+++ b/test/functional/plugin/shada_spec.lua
@@ -0,0 +1,2082 @@
+local helpers = require('test.functional.helpers')
+local eq, nvim_eval, nvim_command, nvim, exc_exec, funcs =
+  helpers.eq, helpers.eval, helpers.command, helpers.nvim, helpers.exc_exec,
+  helpers.funcs
+
+local msgpack = require('MessagePack')
+
+local plugin_helpers = require('test.functional.plugin.helpers')
+local reset = plugin_helpers.reset
+
+describe('In autoload/shada.vim', function()
+  local epoch = os.date('%Y-%m-%dT%H:%M:%S', 0)
+  before_each(function()
+    reset()
+    nvim_command([[
+    function ModifyVal(val)
+      if type(a:val) == type([])
+        if len(a:val) == 2 && type(a:val[0]) == type('') && a:val[0][0] is# '!' && has_key(v:msgpack_types, a:val[0][1:])
+          return {'_TYPE': v:msgpack_types[ a:val[0][1:] ], '_VAL': a:val[1]}
+        else
+          return map(copy(a:val), 'ModifyVal(v:val)')
+        endif
+      elseif type(a:val) == type({})
+        let keys = sort(keys(a:val))
+        let ret = {'_TYPE': v:msgpack_types.map, '_VAL': []}
+        for key in keys
+          let k = {'_TYPE': v:msgpack_types.string, '_VAL': split(key, "\n", 1)}
+          let v = ModifyVal(a:val[key])
+          call add(ret._VAL, [k, v])
+          unlet v
+        endfor
+        return ret
+      elseif type(a:val) == type('')
+        return {'_TYPE': v:msgpack_types.binary, '_VAL': split(a:val, "\n", 1)}
+      else
+        return a:val
+      endif
+    endfunction
+    ]])
+  end)
+
+  local sp = function(typ, val)
+    return ('{"_TYPE": v:msgpack_types.%s, "_VAL": %s}'):format(typ, val)
+  end
+
+  local st_meta = {
+    __pairs=function(table)
+      local ret = {}
+      local next_key = nil
+      local num_keys = 0
+      while true do
+        next_key = next(table, next_key)
+        if next_key == nil then
+          break
+        end
+        num_keys = num_keys + 1
+        ret[num_keys] = {next_key, table[next_key]}
+      end
+      table.sort(ret, function(a, b)
+        return a[1] < b[1]
+      end)
+      local state = {i=0}
+      return (function(state, var)
+        state.i = state.i + 1
+        if ret[state.i] then
+          return table.unpack(ret[state.i])
+        end
+      end), state
+    end
+  }
+
+  local st = function(table)
+    return setmetatable(table, st_meta)
+  end
+
+  describe('function shada#mpack_to_sd', function()
+    local mpack2sd = function(arg)
+      return ('shada#mpack_to_sd(%s)'):format(arg)
+    end
+
+    it('works', function()
+      eq({}, nvim_eval(mpack2sd('[]')))
+      eq({{type=1, timestamp=5, length=1, data=7}},
+         nvim_eval(mpack2sd('[1, 5, 1, 7]')))
+      eq({{type=1, timestamp=5, length=1, data=7},
+          {type=1, timestamp=10, length=1, data=5}},
+         nvim_eval(mpack2sd('[1, 5, 1, 7, 1, 10, 1, 5]')))
+      eq('zero-uint:Entry 1 has type element which is zero',
+         exc_exec('call ' .. mpack2sd('[0, 5, 1, 7]')))
+      eq('zero-uint:Entry 1 has type element which is zero',
+         exc_exec('call ' .. mpack2sd(('[%s, 5, 1, 7]'):format(
+            sp('integer', '[1, 0, 0, 0]')))))
+      eq('not-uint:Entry 1 has timestamp element which is not an unsigned integer',
+         exc_exec('call ' .. mpack2sd('[1, -1, 1, 7]')))
+      eq('not-uint:Entry 1 has length element which is not an unsigned integer',
+         exc_exec('call ' .. mpack2sd('[1, 1, -1, 7]')))
+      eq('not-uint:Entry 1 has type element which is not an unsigned integer',
+         exc_exec('call ' .. mpack2sd('["", 1, -1, 7]')))
+    end)
+  end)
+
+  describe('function shada#sd_to_strings', function()
+    local sd2strings_eq = function(expected, arg)
+      if type(arg) == 'table' then
+        eq(expected, funcs['shada#sd_to_strings'](arg))
+      else
+        eq(expected, nvim_eval(('shada#sd_to_strings(%s)'):format(arg)))
+      end
+    end
+
+    it('works with empty input', function()
+      sd2strings_eq({}, '[]')
+    end)
+
+    it('works with unknown items', function()
+      sd2strings_eq({
+        'Unknown (0x64) with timestamp ' .. epoch .. ':',
+        '  = 100'
+      }, {{type=100, timestamp=0, length=1, data=100}})
+
+      sd2strings_eq({
+        'Unknown (0x4000001180000006) with timestamp ' .. epoch .. ':',
+        '  = 100'
+      }, ('[{"type": %s, "timestamp": 0, "length": 1, "data": 100}]'):format(
+        sp('integer', '[1, 1, 35, 6]')
+      ))
+    end)
+
+    it('works with multiple unknown items', function()
+      sd2strings_eq({
+        'Unknown (0x64) with timestamp ' .. epoch .. ':',
+        '  = 100',
+        'Unknown (0x65) with timestamp ' .. epoch .. ':',
+        '  = 500',
+      }, {{type=100, timestamp=0, length=1, data=100},
+          {type=101, timestamp=0, length=1, data=500}})
+    end)
+
+    it('works with header items', function()
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key______  Value',
+        '  + generator  "test"',
+      }, {{type=1, timestamp=0, data={generator='test'}}})
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + a                 1',
+        '  + b                 2',
+        '  + c    column       3',
+        '  + d                 4',
+      }, {{type=1, timestamp=0, data=st({a=1, b=2, c=3, d=4})}})
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Value',
+        '  + t    "test"',
+      }, {{type=1, timestamp=0, data={t='test'}}})
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: array instead of map',
+        '  = [1, 2, 3]',
+      }, {{type=1, timestamp=0, data={1, 2, 3}}})
+    end)
+
+    it('processes standard keys correctly, even in header', function()
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  + c    column               0',
+        '  + f    file name            "/tmp/foo"',
+        '  + l    line number          10',
+        '  + n    name                 \'@\'',
+        '  + rc   contents             ["abc", "def"]',
+        '  + rt   type                 CHARACTERWISE',
+        '  + rw   block width          10',
+        '  + sc   smartcase value      FALSE',
+        '  + se   place cursor at end  TRUE',
+        '  + sh   v:hlsearch value     TRUE',
+        '  + sl   has line offset      FALSE',
+        '  + sm   magic value          TRUE',
+        '  + so   offset value         10',
+        '  + sp   pattern              "100"',
+        '  + ss   is :s pattern        TRUE',
+        '  + su   is last used         FALSE',
+      }, ([[ [{'type': 1, 'timestamp': 0, 'data': {
+        'sm': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sc': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'sl': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'se': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'so': 10,
+        'su': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'ss': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sh': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sp': '100',
+        'rt': 0,
+        'rw': 10,
+        'rc': ['abc', 'def'],
+        'n': 0x40,
+        'l': 10,
+        'c': 0,
+        'f': '/tmp/foo',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Description____  Value',
+        '  # Expected integer',
+        '  + c    column           "abc"',
+        '  # Expected no NUL bytes',
+        '  + f    file name        "abc\\0def"',
+        '  # Value is negative',
+        '  + l    line number      -10',
+        '  # Value is negative',
+        '  + n    name             -64',
+        '  # Expected array value',
+        '  + rc   contents         "10"',
+        '  # Unexpected enum value: expected one of '
+         .. '0 (CHARACTERWISE), 1 (LINEWISE), 2 (BLOCKWISE)',
+        '  + rt   type             10',
+        '  # Expected boolean',
+        '  + sc   smartcase value  NIL',
+        '  # Expected boolean',
+        '  + sm   magic value      "TRUE"',
+        '  # Expected integer',
+        '  + so   offset value     "TRUE"',
+        '  # Expected binary string',
+        '  + sp   pattern          ="abc"',
+      }, ([[ [{'type': 1, 'timestamp': 0, 'data': {
+        'sm': 'TRUE',
+        'sc': {'_TYPE': v:msgpack_types.nil, '_VAL': 0},
+        'so': 'TRUE',
+        'sp': {'_TYPE': v:msgpack_types.string, '_VAL': ["abc"]},
+        'rt': 10,
+        'rc': '10',
+        'n': -0x40,
+        'l': -10,
+        'c': 'abc',
+        'f': {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc\ndef"]},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Expected no NUL bytes',
+        '  + f    file name    "abc\\0def"',
+        '  # Expected array of binary strings',
+        '  + rc   contents     ["abc", ="abc"]',
+        '  # Expected integer',
+        '  + rt   type         "ABC"',
+      }, ([[ [{'type': 1, 'timestamp': 0, 'data': {
+        'rt': 'ABC',
+        'rc': ["abc", {'_TYPE': v:msgpack_types.string, '_VAL': ["abc"]}],
+        'f': {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc\ndef"]},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Header with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Expected no NUL bytes',
+        '  + rc   contents     ["abc", "a\\nd\\0"]',
+      }, ([[ [{'type': 1, 'timestamp': 0, 'data': {
+        'rc': ["abc", {'_TYPE': v:msgpack_types.binary, '_VAL': ["a", "d\n"]}],
+      }}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with search pattern items', function()
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: array instead of map',
+        '  = [1, 2, 3]',
+      }, {{type=2, timestamp=0, data={1, 2, 3}}})
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  + sp   pattern              "abc"',
+        '  + sh   v:hlsearch value     FALSE',
+        '  + ss   is :s pattern        FALSE',
+        '  + sm   magic value          TRUE',
+        '  + sc   smartcase value      FALSE',
+        '  + sl   has line offset      FALSE',
+        '  + se   place cursor at end  FALSE',
+        '  + so   offset value         0',
+        '  + su   is last used         TRUE',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+        'sp': 'abc',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  + sp   pattern              "abc"',
+        '  + sh   v:hlsearch value     FALSE',
+        '  + ss   is :s pattern        FALSE',
+        '  + sm   magic value          TRUE',
+        '  + sc   smartcase value      FALSE',
+        '  + sl   has line offset      FALSE',
+        '  + se   place cursor at end  FALSE',
+        '  + so   offset value         0',
+        '  + su   is last used         TRUE',
+        '  + sX                        NIL',
+        '  + sY                        NIL',
+        '  + sZ                        NIL',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+        'sp': 'abc',
+        'sZ': {'_TYPE': v:msgpack_types.nil, '_VAL': 0},
+        'sY': {'_TYPE': v:msgpack_types.nil, '_VAL': 0},
+        'sX': {'_TYPE': v:msgpack_types.nil, '_VAL': 0},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  + sp   pattern              "abc"',
+        '  + sh   v:hlsearch value     FALSE',
+        '  + ss   is :s pattern        FALSE',
+        '  + sm   magic value          TRUE',
+        '  + sc   smartcase value      FALSE',
+        '  + sl   has line offset      FALSE',
+        '  + se   place cursor at end  FALSE',
+        '  + so   offset value         0',
+        '  + su   is last used         TRUE',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+        'sp': 'abc',
+        'sh': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'ss': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'sm': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sc': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'sl': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'se': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'so': 0,
+        'su': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  # Required key missing: sp',
+        '  + sh   v:hlsearch value     FALSE',
+        '  + ss   is :s pattern        FALSE',
+        '  + sm   magic value          TRUE',
+        '  + sc   smartcase value      FALSE',
+        '  + sl   has line offset      FALSE',
+        '  + se   place cursor at end  FALSE',
+        '  + so   offset value         0',
+        '  + su   is last used         TRUE',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  + sp   pattern              ""',
+        '  + sh   v:hlsearch value     TRUE',
+        '  + ss   is :s pattern        TRUE',
+        '  + sm   magic value          FALSE',
+        '  + sc   smartcase value      TRUE',
+        '  + sl   has line offset      TRUE',
+        '  + se   place cursor at end  TRUE',
+        '  + so   offset value         -10',
+        '  + su   is last used         FALSE',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+        'sp': '',
+        'sh': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'ss': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sm': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+        'sc': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'sl': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'se': {'_TYPE': v:msgpack_types.boolean, '_VAL': 1},
+        'so': -10,
+        'su': {'_TYPE': v:msgpack_types.boolean, '_VAL': 0},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Search pattern with timestamp ' .. epoch .. ':',
+        '  % Key  Description________  Value',
+        '  # Expected binary string',
+        '  + sp   pattern              0',
+        '  # Expected boolean',
+        '  + sh   v:hlsearch value     0',
+        '  # Expected boolean',
+        '  + ss   is :s pattern        0',
+        '  # Expected boolean',
+        '  + sm   magic value          0',
+        '  # Expected boolean',
+        '  + sc   smartcase value      0',
+        '  # Expected boolean',
+        '  + sl   has line offset      0',
+        '  # Expected boolean',
+        '  + se   place cursor at end  0',
+        '  # Expected integer',
+        '  + so   offset value         ""',
+        '  # Expected boolean',
+        '  + su   is last used         0',
+      }, ([[ [{'type': 2, 'timestamp': 0, 'data': {
+        'sp': 0,
+        'sh': 0,
+        'ss': 0,
+        'sm': 0,
+        'sc': 0,
+        'sl': 0,
+        'se': 0,
+        'so': '',
+        'su': 0,
+      }}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with replacement string items', function()
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: map instead of array',
+        '  = {="a": [10]}',
+      }, {{type=3, timestamp=0, data={a={10}}}})
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  @ Description__________  Value',
+        '  # Expected more elements in list'
+      }, ([[ [{'type': 3, 'timestamp': 0, 'data': [
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  @ Description__________  Value',
+        '  # Expected binary string',
+        '  - :s replacement string  0',
+      }, ([[ [{'type': 3, 'timestamp': 0, 'data': [
+        0,
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  @ Description__________  Value',
+        '  # Expected no NUL bytes',
+        '  - :s replacement string  "abc\\0def"',
+      }, ([[ [{'type': 3, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc\ndef"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  @ Description__________  Value',
+        '  - :s replacement string  "abc\\ndef"',
+      }, ([[ [{'type': 3, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc", "def"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Replacement string with timestamp ' .. epoch .. ':',
+        '  @ Description__________  Value',
+        '  - :s replacement string  "abc\\ndef"',
+        '  -                        0',
+      }, ([[ [{'type': 3, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc", "def"]},
+        0,
+      ]}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with history entry items', function()
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: map instead of array',
+        '  = {="a": [10]}',
+      }, {{type=4, timestamp=0, data={a={10}}}})
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  # Expected more elements in list'
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  # Expected integer',
+        '  - history type  ""',
+        '  # Expected more elements in list'
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  # Unexpected enum value: expected one of 0 (CMD), 1 (SEARCH), '
+            .. '2 (EXPR), 3 (INPUT), 4 (DEBUG)',
+        '  - history type  5',
+        '  - contents      ""',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        5,
+        ''
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  # Unexpected enum value: expected one of 0 (CMD), 1 (SEARCH), '
+            .. '2 (EXPR), 3 (INPUT), 4 (DEBUG)',
+        '  - history type  5',
+        '  - contents      ""',
+        '  -               32',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        5,
+        '',
+        0x20
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  CMD',
+        '  - contents      ""',
+        '  -               32',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        0,
+        '',
+        0x20
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  SEARCH',
+        '  - contents      ""',
+        '  - separator     \' \'',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        1,
+        '',
+        0x20
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  SEARCH',
+        '  - contents      ""',
+        '  # Expected more elements in list',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        1,
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  EXPR',
+        '  - contents      ""',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        2,
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  INPUT',
+        '  - contents      ""',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        3,
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  DEBUG',
+        '  - contents      ""',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        4,
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  DEBUG',
+        '  # Expected binary string',
+        '  - contents      10',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        4,
+        10,
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  DEBUG',
+        '  # Expected no NUL bytes',
+        '  - contents      "abc\\0def"',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        4,
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["abc\ndef"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  SEARCH',
+        '  - contents      "abc"',
+        '  # Expected integer',
+        '  - separator     ""',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        1,
+        'abc',
+        '',
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'History entry with timestamp ' .. epoch .. ':',
+        '  @ Description_  Value',
+        '  - history type  SEARCH',
+        '  - contents      "abc"',
+        '  # Value is negative',
+        '  - separator     -1',
+      }, ([[ [{'type': 4, 'timestamp': 0, 'data': [
+        1,
+        'abc',
+        -1,
+      ]}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with register items', function()
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: array instead of map',
+        '  = [1, 2, 3]',
+      }, {{type=5, timestamp=0, data={1, 2, 3}}})
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Required key missing: n',
+        '  # Required key missing: rc',
+        '  + rw   block width  0',
+        '  + rt   type         CHARACTERWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  # Required key missing: rc',
+        '  + rw   block width  0',
+        '  + rt   type         CHARACTERWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  + rc   contents     ["abc", "def"]',
+        '  + rw   block width  0',
+        '  + rt   type         CHARACTERWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': ["abc", "def"],
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  + rc   contents     @',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  + rw   block width  0',
+        '  + rt   type         CHARACTERWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': ['abcdefghijklmnopqrstuvwxyz', 'abcdefghijklmnopqrstuvwxyz'],
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  + rc   contents     @',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  + rw   block width  0',
+        '  + rt   type         CHARACTERWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': ['abcdefghijklmnopqrstuvwxyz', 'abcdefghijklmnopqrstuvwxyz'],
+        'rw': 0,
+        'rt': 0,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  + rc   contents     @',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  + rw   block width  5',
+        '  + rt   type         LINEWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': ['abcdefghijklmnopqrstuvwxyz', 'abcdefghijklmnopqrstuvwxyz'],
+        'rw': 5,
+        'rt': 1,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  + rc   contents     @',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  | - "abcdefghijklmnopqrstuvwxyz"',
+        '  # Expected integer',
+        '  + rw   block width  ""',
+        '  + rt   type         BLOCKWISE',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': ['abcdefghijklmnopqrstuvwxyz', 'abcdefghijklmnopqrstuvwxyz'],
+        'rw': "",
+        'rt': 2,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Register with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         \' \'',
+        '  # Expected array value',
+        '  + rc   contents     0',
+        '  # Value is negative',
+        '  + rw   block width  -1',
+        '  # Unexpected enum value: expected one of 0 (CHARACTERWISE), '
+        .. '1 (LINEWISE), 2 (BLOCKWISE)',
+        '  + rt   type         10',
+      }, ([[ [{'type': 5, 'timestamp': 0, 'data': {
+        'n': 0x20,
+        'rc': 0,
+        'rw': -1,
+        'rt': 10,
+      }}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with variable items', function()
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: map instead of array',
+        '  = {="a": [10]}',
+      }, {{type=6, timestamp=0, data={a={10}}}})
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  # Expected more elements in list'
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  # Expected binary string',
+        '  - name         1',
+        '  # Expected more elements in list',
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+        1
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  # Expected no NUL bytes',
+        '  - name         "\\0"',
+        '  # Expected more elements in list',
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["\n"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  - name         "foo"',
+        '  # Expected more elements in list',
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["foo"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  - name         "foo"',
+        '  - value        NIL',
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["foo"]},
+        {'_TYPE': v:msgpack_types.nil, '_VAL': ["foo"]},
+      ]}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Variable with timestamp ' .. epoch .. ':',
+        '  @ Description  Value',
+        '  - name         "foo"',
+        '  - value        NIL',
+        '  -              NIL',
+      }, ([[ [{'type': 6, 'timestamp': 0, 'data': [
+        {'_TYPE': v:msgpack_types.binary, '_VAL': ["foo"]},
+        {'_TYPE': v:msgpack_types.nil, '_VAL': ["foo"]},
+        {'_TYPE': v:msgpack_types.nil, '_VAL': ["foo"]},
+      ]}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with global mark items', function()
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: array instead of map',
+        '  = [1, 2, 3]',
+      }, {{type=7, timestamp=0, data={1, 2, 3}}})
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Required key missing: n',
+        '  # Required key missing: f',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Expected integer',
+        '  + n    name         "foo"',
+        '  # Required key missing: f',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'n': 'foo',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Required key missing: n',
+        '  + f    file name    "foo"',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'f': 'foo',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Value is negative',
+        '  + n    name         -10',
+        '  # Expected no NUL bytes',
+        '  + f    file name    "\\0"',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'n': -10,
+        'f': {'_TYPE': v:msgpack_types.binary, '_VAL': ["\n"]},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         20',
+        '  + f    file name    "foo"',
+        '  # Value is negative',
+        '  + l    line number  -10',
+        '  # Value is negative',
+        '  + c    column       -10',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'n': 20,
+        'f': 'foo',
+        'l': -10,
+        'c': -10,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + n    name         20',
+        '  + f    file name    "foo"',
+        '  # Expected integer',
+        '  + l    line number  "FOO"',
+        '  # Expected integer',
+        '  + c    column       "foo"',
+        '  + mX                10',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'n': 20,
+        'f': 'foo',
+        'l': 'FOO',
+        'c': 'foo',
+        'mX': 10,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Global mark with timestamp ' .. epoch .. ':',
+        '  % Key________  Description  Value',
+        '  + n            name         \'A\'',
+        '  + f            file name    "foo"',
+        '  + l            line number  2',
+        '  + c            column       200',
+        '  + mX                        10',
+        '  + mYYYYYYYYYY               10',
+      }, ([[ [{'type': 7, 'timestamp': 0, 'data': {
+        'n': char2nr('A'),
+        'f': 'foo',
+        'l': 2,
+        'c': 200,
+        'mX': 10,
+        'mYYYYYYYYYY': 10,
+      }}] ]]):gsub('\n', ''))
+    end)
+
+    it('works with jump items', function()
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  # Unexpected type: array instead of map',
+        '  = [1, 2, 3]',
+      }, {{type=8, timestamp=0, data={1, 2, 3}}})
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Required key missing: f',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Required key missing: f',
+        '  + l    line number  1',
+        '  + c    column       0',
+        '  # Expected integer',
+        '  + n    name         "foo"',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+        'n': 'foo',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + f    file name    "foo"',
+        '  + l    line number  1',
+        '  + c    column       0',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+        'f': 'foo',
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  # Expected no NUL bytes',
+        '  + f    file name    "\\0"',
+        '  + l    line number  1',
+        '  + c    column       0',
+        '  # Value is negative',
+        '  + n    name         -10',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+        'n': -10,
+        'f': {'_TYPE': v:msgpack_types.binary, '_VAL': ["\n"]},
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + f    file name    "foo"',
+        '  # Value is negative',
+        '  + l    line number  -10',
+        '  # Value is negative',
+        '  + c    column       -10',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+        'f': 'foo',
+        'l': -10,
+        'c': -10,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key  Description  Value',
+        '  + f    file name    "foo"',
+        '  # Expected integer',
+        '  + l    line number  "FOO"',
+        '  # Expected integer',
+        '  + c    column       "foo"',
+        '  + mX                10',
+      }, ([[ [{'type': 8, 'timestamp': 0, 'data': {
+        'f': 'foo',
+        'l': 'FOO',
+        'c': 'foo',
+        'mX': 10,
+      }}] ]]):gsub('\n', ''))
+      sd2strings_eq({
+        'Jump with timestamp ' .. epoch .. ':',
+        '  % Key________  Description  Value',