neovim

Neovim text editor
git clone https://git.dasho.dev/neovim.git
Log | Files | Refs | README

termkey_spec.lua (40843B)


      1 local t = require('test.unit.testutil')
      2 local itp = t.gen_itp(it)
      3 local bit = require('bit')
      4 
      5 --- @alias TermKeyKey {utf8: string, type: integer, modifiers: integer, code: {codepoint: integer, sym: any, number: integer}}
      6 
      7 --- @class termkey
      8 --- @field TERMKEY_CANON_SPACESYMBOL integer
      9 --- @field TERMKEY_FLAG_SPACESYMBOL integer
     10 --- @field TERMKEY_FLAG_UTF8 integer
     11 --- @field TERMKEY_FORMAT_ALTISMETA integer
     12 --- @field TERMKEY_FORMAT_CARETCTRL integer
     13 --- @field TERMKEY_FORMAT_LONGMOD integer
     14 --- @field TERMKEY_FORMAT_LOWERMOD integer
     15 --- @field TERMKEY_FORMAT_LOWERSPACE integer
     16 --- @field TERMKEY_FORMAT_MOUSE_POS integer
     17 --- @field TERMKEY_FORMAT_SPACEMOD integer
     18 --- @field TERMKEY_FORMAT_WRAPBRACKET integer
     19 --- @field TERMKEY_KEYMOD_ALT integer
     20 --- @field TERMKEY_KEYMOD_CTRL integer
     21 --- @field TERMKEY_MOUSE_DRAG integer
     22 --- @field TERMKEY_MOUSE_PRESS integer
     23 --- @field TERMKEY_MOUSE_RELEASE integer
     24 --- @field TERMKEY_RES_AGAIN integer
     25 --- @field TERMKEY_RES_KEY integer
     26 --- @field TERMKEY_RES_NONE integer
     27 --- @field TERMKEY_SYM_DOWN integer
     28 --- @field TERMKEY_SYM_PAGEUP integer
     29 --- @field TERMKEY_SYM_SPACE integer
     30 --- @field TERMKEY_SYM_UNKNOWN integer
     31 --- @field TERMKEY_SYM_UP integer
     32 --- @field TERMKEY_TYPE_DCS integer
     33 --- @field TERMKEY_TYPE_FUNCTION integer
     34 --- @field TERMKEY_TYPE_KEYSYM integer
     35 --- @field TERMKEY_TYPE_MODEREPORT integer
     36 --- @field TERMKEY_TYPE_MOUSE integer
     37 --- @field TERMKEY_TYPE_OSC integer
     38 --- @field TERMKEY_TYPE_POSITION integer
     39 --- @field TERMKEY_TYPE_UNICODE integer
     40 --- @field TERMKEY_TYPE_UNKNOWN_CSI integer
     41 --- @field termkey_canonicalise fun(any, any):any
     42 --- @field termkey_destroy fun(any)
     43 --- @field termkey_get_buffer_remaining fun(any):integer
     44 --- @field termkey_get_buffer_size fun(any):integer
     45 --- @field termkey_get_canonflags fun(any):any
     46 --- @field termkey_get_keyname fun(any, any):any
     47 --- @field termkey_getkey fun(any, any):any
     48 --- @field termkey_getkey_force fun(any, any):any
     49 --- @field termkey_interpret_csi fun(any, any, any, any, any):any
     50 --- @field termkey_interpret_modereport fun(any, any, any, any, any):any
     51 --- @field termkey_interpret_mouse fun(any, any, TermKeyKey, integer, integer, integer):any
     52 --- @field termkey_interpret_position fun(any, any, any, any):any
     53 --- @field termkey_interpret_string fun(any, TermKeyKey, any):any
     54 --- @field termkey_lookup_keyname fun(any, any, any):any
     55 --- @field termkey_new_abstract fun(string, integer):any
     56 --- @field termkey_push_bytes fun(any, string, integer):integer
     57 --- @field termkey_set_buffer_size fun(any, integer):integer
     58 --- @field termkey_set_canonflags fun(any, any):any
     59 --- @field termkey_set_flags fun(any, integer)
     60 --- @field termkey_start fun(any):integer
     61 --- @field termkey_stop fun(any):integer
     62 --- @field termkey_strfkey fun(any, string, integer, any, any):integer
     63 local termkey = t.cimport(
     64  './src/nvim/tui/termkey/termkey.h',
     65  './src/nvim/tui/termkey/termkey-internal.h',
     66  './src/nvim/tui/termkey/termkey_defs.h',
     67  './src/nvim/tui/termkey/driver-csi.h'
     68 )
     69 
     70 describe('termkey', function()
     71  itp('01base', function()
     72    local tk = termkey.termkey_new_abstract(nil, 0)
     73    t.neq(tk, nil)
     74 
     75    t.eq(termkey.termkey_get_buffer_size(tk), 256)
     76    t.eq(tk.is_started, 1) -- tk->is_started true after construction
     77 
     78    termkey.termkey_stop(tk)
     79    t.neq(tk.is_started, 1) -- tk->is_started false after termkey_stop()
     80 
     81    termkey.termkey_start(tk)
     82    t.eq(tk.is_started, 1) -- tk->is_started true after termkey_start()
     83 
     84    termkey.termkey_destroy(tk)
     85  end)
     86 
     87  itp('02getkey', function()
     88    local tk = termkey.termkey_new_abstract(nil, 0)
     89    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
     90 
     91    t.eq(termkey.termkey_get_buffer_remaining(tk), 256) -- buffer free initially 256
     92 
     93    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_NONE) -- getkey yields RES_NONE when empty
     94 
     95    t.eq(termkey.termkey_push_bytes(tk, 'h', 1), 1) -- push_bytes returns 1
     96 
     97    t.eq(termkey.termkey_get_buffer_remaining(tk), 255) -- buffer free 255 after push_bytes
     98 
     99    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after h
    100 
    101    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type after h
    102    t.eq(key.code.codepoint, string.byte('h')) -- key.code.codepoint after h
    103    t.eq(key.modifiers, 0) -- key.modifiers after h
    104    t.eq(t.ffi.string(key.utf8), 'h') -- key.utf8 after h
    105 
    106    t.eq(termkey.termkey_get_buffer_remaining(tk), 256) -- buffer free 256 after getkey
    107 
    108    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_NONE) -- getkey yields RES_NONE a second time
    109 
    110    termkey.termkey_push_bytes(tk, '\x01', 1)
    111 
    112    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after C-a
    113 
    114    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type after C-a
    115    t.eq(key.code.codepoint, string.byte('a')) -- key.code.codepoint after C-a
    116    t.eq(key.modifiers, termkey.TERMKEY_KEYMOD_CTRL) -- key.modifiers after C-a
    117 
    118    termkey.termkey_push_bytes(tk, '\033OA', 3)
    119 
    120    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after Up
    121 
    122    -- is_int(key.type,        TERMKEY_TYPE_KEYSYM,  "key.type after Up");
    123    -- is_int(key.code.sym,    TERMKEY_SYM_UP,       "key.code.sym after Up");
    124    t.eq(key.modifiers, 0) -- key.modifiers after Up
    125 
    126    t.eq(termkey.termkey_push_bytes(tk, '\033O', 2), 2) -- push_bytes returns 2
    127 
    128    -- is_int(termkey_get_buffer_remaining(tk), 254, "buffer free 254 after partial write");
    129 
    130    -- is_int(termkey_getkey(tk, &key), TERMKEY_RES_AGAIN, "getkey yields RES_AGAIN after partial write");
    131 
    132    termkey.termkey_push_bytes(tk, 'C', 1)
    133 
    134    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after Right completion
    135 
    136    -- is_int(key.type,        TERMKEY_TYPE_KEYSYM,  "key.type after Right");
    137    -- is_int(key.code.sym,    TERMKEY_SYM_RIGHT,    "key.code.sym after Right");
    138    -- is_int(key.modifiers,   0,                    "key.modifiers after Right");
    139 
    140    -- is_int(termkey_get_buffer_remaining(tk), 256, "buffer free 256 after completion");
    141 
    142    termkey.termkey_push_bytes(tk, '\033[27;5u', 7)
    143 
    144    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after Ctrl-Escape
    145 
    146    -- is_int(key.type,        TERMKEY_TYPE_KEYSYM, "key.type after Ctrl-Escape");
    147    -- is_int(key.code.sym,    TERMKEY_SYM_ESCAPE,  "key.code.sym after Ctrl-Escape");
    148    -- is_int(key.modifiers,   TERMKEY_KEYMOD_CTRL, "key.modifiers after Ctrl-Escape");
    149 
    150    termkey.termkey_push_bytes(tk, '\0', 1)
    151 
    152    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after Ctrl-Space
    153 
    154    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type after Ctrl-Space
    155    -- t.eq(key.code.codepoint, string.byte(' ')) -- key.code.codepoint after Ctrl-Space
    156    -- is_int(key.modifiers,      TERMKEY_KEYMOD_CTRL,  "key.modifiers after Ctrl-Space");
    157 
    158    termkey.termkey_destroy(tk)
    159  end)
    160 
    161  itp('03utf8', function()
    162    local tk = termkey.termkey_new_abstract(nil, termkey.TERMKEY_FLAG_UTF8)
    163    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    164 
    165    termkey.termkey_push_bytes(tk, 'a', 1)
    166 
    167    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY low ASCII
    168    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type low ASCII
    169    t.eq(key.code.codepoint, string.byte('a')) -- key.code.codepoint low ASCII
    170 
    171    -- 2-byte UTF-8 range is U+0080 to U+07FF (0xDF 0xBF)
    172    -- However, we'd best avoid the C1 range, so we'll start at U+00A0 (0xC2 0xA0)
    173 
    174    termkey.termkey_push_bytes(tk, '\xC2\xA0', 2)
    175 
    176    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 2 low
    177    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 2 low
    178    t.eq(key.code.codepoint, 0x00A0) -- key.code.codepoint UTF-8 2 low
    179 
    180    termkey.termkey_push_bytes(tk, '\xDF\xBF', 2)
    181 
    182    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 2 high
    183    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 2 high
    184    t.eq(key.code.codepoint, 0x07FF) -- key.code.codepoint UTF-8 2 high
    185 
    186    -- 3-byte UTF-8 range is U+0800 (0xE0 0xA0 0x80) to U+FFFD (0xEF 0xBF 0xBD)
    187 
    188    termkey.termkey_push_bytes(tk, '\xE0\xA0\x80', 3)
    189 
    190    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 low
    191    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 3 low
    192    t.eq(key.code.codepoint, 0x0800) -- key.code.codepoint UTF-8 3 low
    193 
    194    termkey.termkey_push_bytes(tk, '\xEF\xBF\xBD', 3)
    195 
    196    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 high
    197    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 3 high
    198    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 3 high
    199 
    200    -- 4-byte UTF-8 range is U+10000 (0xF0 0x90 0x80 0x80) to U+10FFFF (0xF4 0x8F 0xBF 0xBF)
    201 
    202    termkey.termkey_push_bytes(tk, '\xF0\x90\x80\x80', 4)
    203 
    204    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 low
    205    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 4 low
    206    t.eq(key.code.codepoint, 0x10000) -- key.code.codepoint UTF-8 4 low
    207 
    208    termkey.termkey_push_bytes(tk, '\xF4\x8F\xBF\xBF', 4)
    209 
    210    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 high
    211    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type UTF-8 4 high
    212    t.eq(key.code.codepoint, 0x10FFFF) -- key.code.codepoint UTF-8 4 high
    213 
    214    -- Invalid continuations
    215 
    216    termkey.termkey_push_bytes(tk, '\xC2!', 2)
    217 
    218    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 2 invalid cont
    219    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 2 invalid cont
    220    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 2 invalid after
    221    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 2 invalid after
    222 
    223    termkey.termkey_push_bytes(tk, '\xE0!', 2)
    224 
    225    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 invalid cont
    226    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 3 invalid cont
    227    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 invalid after
    228    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 3 invalid after
    229 
    230    termkey.termkey_push_bytes(tk, '\xE0\xA0!', 3)
    231 
    232    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 invalid cont 2
    233    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 3 invalid cont 2
    234    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 invalid after
    235    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 3 invalid after
    236 
    237    termkey.termkey_push_bytes(tk, '\xF0!', 2)
    238 
    239    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid cont
    240    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 4 invalid cont
    241    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid after
    242    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 4 invalid after
    243 
    244    termkey.termkey_push_bytes(tk, '\xF0\x90!', 3)
    245 
    246    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid cont 2
    247    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 4 invalid cont 2
    248    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid after
    249    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 4 invalid after
    250 
    251    termkey.termkey_push_bytes(tk, '\xF0\x90\x80!', 4)
    252 
    253    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid cont 3
    254    t.eq(key.code.codepoint, 0xFFFD) -- key.code.codepoint UTF-8 4 invalid cont 3
    255    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 invalid after
    256    t.eq(key.code.codepoint, string.byte('!')) -- key.code.codepoint UTF-8 4 invalid after
    257 
    258    -- Partials
    259 
    260    termkey.termkey_push_bytes(tk, '\xC2', 1)
    261    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 2 partial
    262 
    263    termkey.termkey_push_bytes(tk, '\xA0', 1)
    264    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 2 partial
    265    t.eq(key.code.codepoint, 0x00A0) -- key.code.codepoint UTF-8 2 partial
    266 
    267    termkey.termkey_push_bytes(tk, '\xE0', 1)
    268    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 3 partial
    269 
    270    termkey.termkey_push_bytes(tk, '\xA0', 1)
    271    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 3 partial
    272 
    273    termkey.termkey_push_bytes(tk, '\x80', 1)
    274    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 3 partial
    275    t.eq(key.code.codepoint, 0x0800) -- key.code.codepoint UTF-8 3 partial
    276 
    277    termkey.termkey_push_bytes(tk, '\xF0', 1)
    278    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 4 partial
    279 
    280    termkey.termkey_push_bytes(tk, '\x90', 1)
    281    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 4 partial
    282 
    283    termkey.termkey_push_bytes(tk, '\x80', 1)
    284    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN UTF-8 4 partial
    285 
    286    termkey.termkey_push_bytes(tk, '\x80', 1)
    287    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY UTF-8 4 partial
    288    t.eq(key.code.codepoint, 0x10000) -- key.code.codepoint UTF-8 4 partial
    289 
    290    termkey.termkey_destroy(tk)
    291  end)
    292 
    293  itp('04flags', function()
    294    local tk = termkey.termkey_new_abstract(nil, 0)
    295    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    296 
    297    termkey.termkey_push_bytes(tk, ' ', 1)
    298 
    299    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after space
    300 
    301    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type after space
    302    t.eq(key.code.codepoint, string.byte(' ')) -- key.code.codepoint after space
    303    t.eq(key.modifiers, 0) -- key.modifiers after space
    304 
    305    termkey.termkey_set_flags(tk, termkey.TERMKEY_FLAG_SPACESYMBOL)
    306 
    307    termkey.termkey_push_bytes(tk, ' ', 1)
    308 
    309    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY after space
    310 
    311    t.eq(key.type, termkey.TERMKEY_TYPE_KEYSYM) -- key.type after space with FLAG_SPACESYMBOL
    312    t.eq(key.code.sym, termkey.TERMKEY_SYM_SPACE) -- key.code.sym after space with FLAG_SPACESYMBOL
    313    t.eq(key.modifiers, 0) -- key.modifiers after space with FLAG_SPACESYMBOL
    314 
    315    termkey.termkey_destroy(tk)
    316  end)
    317 
    318  itp('06buffer', function()
    319    local tk = termkey.termkey_new_abstract(nil, 0)
    320    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    321 
    322    t.eq(termkey.termkey_get_buffer_remaining(tk), 256) -- buffer free initially 256
    323    t.eq(termkey.termkey_get_buffer_size(tk), 256) -- buffer size initially 256
    324 
    325    t.eq(termkey.termkey_push_bytes(tk, 'h', 1), 1) -- push_bytes returns 1
    326 
    327    t.eq(termkey.termkey_get_buffer_remaining(tk), 255) -- buffer free 255 after push_bytes
    328    t.eq(termkey.termkey_get_buffer_size(tk), 256) -- buffer size 256 after push_bytes
    329 
    330    t.eq(not not termkey.termkey_set_buffer_size(tk, 512), true) -- buffer set size OK
    331 
    332    t.eq(termkey.termkey_get_buffer_remaining(tk), 511) -- buffer free 511 after push_bytes
    333    t.eq(termkey.termkey_get_buffer_size(tk), 512) -- buffer size 512 after push_bytes
    334 
    335    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- buffered key still usable after resize
    336 
    337    termkey.termkey_destroy(tk)
    338  end)
    339 
    340  local function termkey_keyname2sym(tk, keyname)
    341    local sym = t.ffi.new('TermKeySym[1]')
    342    local endp = termkey.termkey_lookup_keyname(tk, keyname, sym)
    343    if endp == nil then
    344      return termkey.TERMKEY_SYM_UNKNOWN
    345    end
    346    return sym
    347  end
    348 
    349  itp('10keyname', function()
    350    local tk = termkey.termkey_new_abstract(nil, 0)
    351 
    352    local sym = termkey_keyname2sym(tk, 'SomeUnknownKey')
    353    t.eq(sym, termkey.TERMKEY_SYM_UNKNOWN) -- keyname2sym SomeUnknownKey
    354 
    355    sym = termkey_keyname2sym(tk, 'Space')
    356    t.eq(sym[0], termkey.TERMKEY_SYM_SPACE) -- keyname2sym Space
    357 
    358    local _end = termkey.termkey_lookup_keyname(tk, 'Up', sym)
    359    t.neq(_end, nil) -- termkey_get_keyname Up returns non-NULL
    360    t.eq(t.ffi.string(_end), '') -- termkey_get_keyname Up return points at endofstring
    361    t.eq(sym[0], termkey.TERMKEY_SYM_UP) -- termkey_get_keyname Up yields Up symbol
    362 
    363    _end = termkey.termkey_lookup_keyname(tk, 'DownMore', sym)
    364    t.neq(_end, nil) -- termkey_get_keyname DownMore returns non-NULL
    365    t.eq(t.ffi.string(_end), 'More') -- termkey_get_keyname DownMore return points at More
    366    t.eq(sym[0], termkey.TERMKEY_SYM_DOWN) -- termkey_get_keyname DownMore yields Down symbol
    367 
    368    _end = termkey.termkey_lookup_keyname(tk, 'SomeUnknownKey', sym)
    369    t.eq(_end, nil) -- termkey_get_keyname SomeUnknownKey returns NULL
    370 
    371    t.eq(t.ffi.string(termkey.termkey_get_keyname(tk, termkey.TERMKEY_SYM_SPACE)), 'Space') -- "get_keyname SPACE");
    372 
    373    termkey.termkey_destroy(tk)
    374  end)
    375 
    376  itp('11strfkey', function()
    377    local tk = termkey.termkey_new_abstract(nil, 0)
    378    ---@type TermKeyKey
    379    local key = t.ffi.new(
    380      'TermKeyKey',
    381      { type = termkey.TERMKEY_TYPE_UNICODE, code = { codepoint = string.byte('A') } }
    382    )
    383    local buffer = t.ffi.new('char[16]')
    384 
    385    local len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    386    t.eq(len, 1) -- length for unicode/A/0
    387    t.eq(t.ffi.string(buffer), 'A') -- buffer for unicode/A/0
    388 
    389    len = termkey.termkey_strfkey(
    390      tk,
    391      buffer,
    392      t.ffi.sizeof(buffer),
    393      key,
    394      termkey.TERMKEY_FORMAT_WRAPBRACKET
    395    )
    396    t.eq(len, 1) -- length for unicode/A/0 wrapbracket
    397    t.eq(t.ffi.string(buffer), 'A') -- buffer for unicode/A/0 wrapbracket
    398 
    399    ---@type TermKeyKey
    400    key = t.ffi.new('TermKeyKey', {
    401      type = termkey.TERMKEY_TYPE_UNICODE,
    402      code = { codepoint = string.byte('b') },
    403      modifiers = termkey.TERMKEY_KEYMOD_CTRL,
    404    })
    405 
    406    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    407    t.eq(len, 3) -- length for unicode/b/CTRL
    408    t.eq(t.ffi.string(buffer), 'C-b') -- buffer for unicode/b/CTRL
    409 
    410    len =
    411      termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, termkey.TERMKEY_FORMAT_LONGMOD)
    412    t.eq(len, 6) -- length for unicode/b/CTRL longmod
    413    t.eq(t.ffi.string(buffer), 'Ctrl-b') -- buffer for unicode/b/CTRL longmod
    414 
    415    len = termkey.termkey_strfkey(
    416      tk,
    417      buffer,
    418      t.ffi.sizeof(buffer),
    419      key,
    420      bit.bor(termkey.TERMKEY_FORMAT_LONGMOD, termkey.TERMKEY_FORMAT_SPACEMOD)
    421    )
    422    t.eq(len, 6) -- length for unicode/b/CTRL longmod|spacemod
    423    t.eq(t.ffi.string(buffer), 'Ctrl b') -- buffer for unicode/b/CTRL longmod|spacemod
    424 
    425    len = termkey.termkey_strfkey(
    426      tk,
    427      buffer,
    428      t.ffi.sizeof(buffer),
    429      key,
    430      bit.bor(termkey.TERMKEY_FORMAT_LONGMOD, termkey.TERMKEY_FORMAT_LOWERMOD)
    431    )
    432    t.eq(len, 6) -- length for unicode/b/CTRL longmod|lowermod
    433    t.eq(t.ffi.string(buffer), 'ctrl-b') -- buffer for unicode/b/CTRL longmod|lowermod
    434 
    435    len = termkey.termkey_strfkey(
    436      tk,
    437      buffer,
    438      t.ffi.sizeof(buffer),
    439      key,
    440      bit.bor(
    441        termkey.TERMKEY_FORMAT_LONGMOD,
    442        termkey.TERMKEY_FORMAT_SPACEMOD,
    443        termkey.TERMKEY_FORMAT_LOWERMOD
    444      )
    445    )
    446    t.eq(len, 6) -- length for unicode/b/CTRL longmod|spacemod|lowermode
    447    t.eq(t.ffi.string(buffer), 'ctrl b') -- buffer for unicode/b/CTRL longmod|spacemod|lowermode
    448 
    449    len = termkey.termkey_strfkey(
    450      tk,
    451      buffer,
    452      t.ffi.sizeof(buffer),
    453      key,
    454      termkey.TERMKEY_FORMAT_CARETCTRL
    455    )
    456    t.eq(len, 2) -- length for unicode/b/CTRL caretctrl
    457    t.eq(t.ffi.string(buffer), '^B') -- buffer for unicode/b/CTRL caretctrl
    458 
    459    len = termkey.termkey_strfkey(
    460      tk,
    461      buffer,
    462      t.ffi.sizeof(buffer),
    463      key,
    464      termkey.TERMKEY_FORMAT_WRAPBRACKET
    465    )
    466    t.eq(len, 5) -- length for unicode/b/CTRL wrapbracket
    467    t.eq(t.ffi.string(buffer), '<C-b>') -- buffer for unicode/b/CTRL wrapbracket
    468 
    469    ---@type TermKeyKey
    470    key = t.ffi.new('TermKeyKey', {
    471      type = termkey.TERMKEY_TYPE_UNICODE,
    472      code = { codepoint = string.byte('c') },
    473      modifiers = termkey.TERMKEY_KEYMOD_ALT,
    474    })
    475 
    476    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    477    t.eq(len, 3) -- length for unicode/c/ALT
    478    t.eq(t.ffi.string(buffer), 'A-c') -- buffer for unicode/c/ALT
    479 
    480    len =
    481      termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, termkey.TERMKEY_FORMAT_LONGMOD)
    482    t.eq(len, 5) -- length for unicode/c/ALT longmod
    483    t.eq(t.ffi.string(buffer), 'Alt-c') -- buffer for unicode/c/ALT longmod
    484 
    485    len = termkey.termkey_strfkey(
    486      tk,
    487      buffer,
    488      t.ffi.sizeof(buffer),
    489      key,
    490      termkey.TERMKEY_FORMAT_ALTISMETA
    491    )
    492    t.eq(len, 3) -- length for unicode/c/ALT altismeta
    493    t.eq(t.ffi.string(buffer), 'M-c') -- buffer for unicode/c/ALT altismeta
    494 
    495    len = termkey.termkey_strfkey(
    496      tk,
    497      buffer,
    498      t.ffi.sizeof(buffer),
    499      key,
    500      bit.bor(termkey.TERMKEY_FORMAT_LONGMOD, termkey.TERMKEY_FORMAT_ALTISMETA)
    501    )
    502    t.eq(len, 6) -- length for unicode/c/ALT longmod|altismeta
    503    t.eq(t.ffi.string(buffer), 'Meta-c') -- buffer for unicode/c/ALT longmod|altismeta
    504 
    505    ---@type TermKeyKey
    506    key = t.ffi.new(
    507      'TermKeyKey',
    508      { type = termkey.TERMKEY_TYPE_KEYSYM, code = { sym = termkey.TERMKEY_SYM_UP } }
    509    )
    510 
    511    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    512    t.eq(len, 2) -- length for sym/Up/0
    513    t.eq(t.ffi.string(buffer), 'Up') -- buffer for sym/Up/0
    514 
    515    len = termkey.termkey_strfkey(
    516      tk,
    517      buffer,
    518      t.ffi.sizeof(buffer),
    519      key,
    520      termkey.TERMKEY_FORMAT_WRAPBRACKET
    521    )
    522    t.eq(len, 4) -- length for sym/Up/0 wrapbracket
    523    t.eq(t.ffi.string(buffer), '<Up>') -- buffer for sym/Up/0 wrapbracket
    524 
    525    ---@type TermKeyKey
    526    key = t.ffi.new(
    527      'TermKeyKey',
    528      { type = termkey.TERMKEY_TYPE_KEYSYM, code = { sym = termkey.TERMKEY_SYM_PAGEUP } }
    529    )
    530 
    531    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    532    t.eq(len, 6) -- length for sym/PageUp/0
    533    t.eq(t.ffi.string(buffer), 'PageUp') -- buffer for sym/PageUp/0
    534 
    535    len = termkey.termkey_strfkey(
    536      tk,
    537      buffer,
    538      t.ffi.sizeof(buffer),
    539      key,
    540      termkey.TERMKEY_FORMAT_LOWERSPACE
    541    )
    542    t.eq(len, 7) -- length for sym/PageUp/0 lowerspace
    543    t.eq(t.ffi.string(buffer), 'page up') -- buffer for sym/PageUp/0 lowerspace
    544 
    545    -- If size of buffer is too small, strfkey should return something consistent
    546    len = termkey.termkey_strfkey(tk, buffer, 4, key, 0)
    547    t.eq(len, 6) -- length for sym/PageUp/0
    548    t.eq(t.ffi.string(buffer), 'Pag') -- buffer of len 4 for sym/PageUp/0
    549 
    550    len = termkey.termkey_strfkey(tk, buffer, 4, key, termkey.TERMKEY_FORMAT_LOWERSPACE)
    551    t.eq(len, 7) -- length for sym/PageUp/0 lowerspace
    552    t.eq(t.ffi.string(buffer), 'pag') -- buffer of len 4 for sym/PageUp/0 lowerspace
    553 
    554    key = t.ffi.new('TermKeyKey', { type = termkey.TERMKEY_TYPE_FUNCTION, code = { number = 5 } }) ---@type TermKeyKey
    555 
    556    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    557    t.eq(len, 2) -- length for func/5/0
    558    t.eq(t.ffi.string(buffer), 'F5') -- buffer for func/5/0
    559 
    560    len = termkey.termkey_strfkey(
    561      tk,
    562      buffer,
    563      t.ffi.sizeof(buffer),
    564      key,
    565      termkey.TERMKEY_FORMAT_WRAPBRACKET
    566    )
    567    t.eq(len, 4) -- length for func/5/0 wrapbracket
    568    t.eq(t.ffi.string(buffer), '<F5>') -- buffer for func/5/0 wrapbracket
    569 
    570    len = termkey.termkey_strfkey(
    571      tk,
    572      buffer,
    573      t.ffi.sizeof(buffer),
    574      key,
    575      termkey.TERMKEY_FORMAT_LOWERSPACE
    576    )
    577    t.eq(len, 2) -- length for func/5/0 lowerspace
    578    t.eq(t.ffi.string(buffer), 'f5') -- buffer for func/5/0 lowerspace
    579 
    580    termkey.termkey_destroy(tk)
    581  end)
    582 
    583  itp('13cmpkey', function()
    584    local function termkey_keycmp(tk, key1, key2)
    585      termkey.termkey_canonicalise(tk, key1)
    586      termkey.termkey_canonicalise(tk, key2)
    587 
    588      if key1.type ~= key2.type then
    589        return key1.type - key2.type
    590      end
    591 
    592      if key1.type == termkey.TERMKEY_TYPE_UNICODE then
    593        if key1.code.codepoint ~= key2.code.codepoint then
    594          return key1.code.codepoint - key2.code.codepoint
    595        end
    596      end
    597 
    598      return key1.modifiers - key2.modifiers
    599    end
    600 
    601    local tk = termkey.termkey_new_abstract(nil, 0)
    602    ---@type TermKeyKey
    603    local key1 = t.ffi.new('TermKeyKey', {
    604      type = termkey.TERMKEY_TYPE_UNICODE,
    605      code = { codepoint = string.byte('A') },
    606      modifiers = 0,
    607    })
    608    ---@type TermKeyKey
    609    local key2 = t.ffi.new('TermKeyKey', {
    610      type = termkey.TERMKEY_TYPE_UNICODE,
    611      code = { codepoint = string.byte('A') },
    612      modifiers = 0,
    613    })
    614 
    615    t.eq(termkey_keycmp(tk, key1, key1), 0) -- cmpkey same structure
    616    t.eq(termkey_keycmp(tk, key1, key2), 0) -- cmpkey identical structure
    617 
    618    key2.modifiers = termkey.TERMKEY_KEYMOD_CTRL
    619 
    620    t.eq(termkey_keycmp(tk, key1, key2) < 0, true) -- cmpkey orders CTRL after nomod
    621    t.eq(termkey_keycmp(tk, key2, key1) > 0, true) -- cmpkey orders nomod before CTRL
    622 
    623    key2.code.codepoint = string.byte('B')
    624    key2.modifiers = 0
    625 
    626    t.eq(termkey_keycmp(tk, key1, key2) < 0, true) -- cmpkey orders 'B' after 'A'
    627    t.eq(termkey_keycmp(tk, key2, key1) > 0, true) -- cmpkey orders 'A' before 'B'
    628 
    629    key1.modifiers = termkey.TERMKEY_KEYMOD_CTRL
    630 
    631    t.eq(termkey_keycmp(tk, key1, key2) < 0, true) -- cmpkey orders nomod 'B' after CTRL 'A'
    632    t.eq(termkey_keycmp(tk, key2, key1) > 0, true) -- cmpkey orders CTRL 'A' before nomod 'B'
    633 
    634    key2.type = termkey.TERMKEY_TYPE_KEYSYM
    635    key2.code.sym = termkey.TERMKEY_SYM_UP
    636 
    637    t.eq(termkey_keycmp(tk, key1, key2) < 0, true) -- cmpkey orders KEYSYM after UNICODE
    638    t.eq(termkey_keycmp(tk, key2, key1) > 0, true) -- cmpkey orders UNICODE before KEYSYM
    639 
    640    key1.type = termkey.TERMKEY_TYPE_KEYSYM
    641    key1.code.sym = termkey.TERMKEY_SYM_SPACE
    642    key1.modifiers = 0
    643    key2.type = termkey.TERMKEY_TYPE_UNICODE
    644    key2.code.codepoint = string.byte(' ')
    645    key2.modifiers = 0
    646 
    647    t.eq(termkey_keycmp(tk, key1, key2), 0) -- cmpkey considers KEYSYM/SPACE and UNICODE/SP identical
    648 
    649    termkey.termkey_set_canonflags(
    650      tk,
    651      bit.bor(termkey.termkey_get_canonflags(tk), termkey.TERMKEY_CANON_SPACESYMBOL)
    652    )
    653    t.eq(termkey_keycmp(tk, key1, key2), 0) -- "cmpkey considers KEYSYM/SPACE and UNICODE/SP identical under SPACESYMBOL");
    654 
    655    termkey.termkey_destroy(tk)
    656  end)
    657 
    658  itp('30mouse', function()
    659    local tk = termkey.termkey_new_abstract(nil, 0)
    660    local key = t.ffi.new('TermKeyKey', { type = -1 }) ---@type TermKeyKey
    661    local ev = t.ffi.new('TermKeyMouseEvent[1]')
    662    local button = t.ffi.new('int[1]')
    663    local line = t.ffi.new('int[1]')
    664    local col = t.ffi.new('int[1]')
    665    local buffer = t.ffi.new('char[32]')
    666 
    667    termkey.termkey_push_bytes(tk, '\x1b[M !!', 6)
    668 
    669    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mouse press
    670 
    671    t.eq(key.type, termkey.TERMKEY_TYPE_MOUSE) -- key.type for mouse press
    672 
    673    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    674 
    675    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for press
    676    t.eq(button[0], 1) -- mouse button for press
    677    t.eq(line[0], 1) -- mouse line for press
    678    t.eq(col[0], 1) -- mouse column for press
    679    t.eq(key.modifiers, 0) -- modifiers for press
    680 
    681    local len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    682    t.eq(len, 13) -- string length for press
    683    t.eq(t.ffi.string(buffer), 'MousePress(1)') -- string buffer for press
    684 
    685    len = termkey.termkey_strfkey(
    686      tk,
    687      buffer,
    688      t.ffi.sizeof(buffer),
    689      key,
    690      termkey.TERMKEY_FORMAT_MOUSE_POS
    691    )
    692    t.eq(len, 21) -- string length for press
    693    t.eq(t.ffi.string(buffer), 'MousePress(1) @ (1,1)') -- string buffer for press
    694 
    695    termkey.termkey_push_bytes(tk, '\x1b[M@"!', 6)
    696 
    697    termkey.termkey_getkey(tk, key)
    698    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    699 
    700    t.eq(ev[0], termkey.TERMKEY_MOUSE_DRAG) -- mouse event for drag
    701    t.eq(button[0], 1) --  mouse button for drag
    702    t.eq(line[0], 1) --  mouse line for drag
    703    t.eq(col[0], 2) --  mouse column for drag
    704    t.eq(key.modifiers, 0) -- modifiers for press
    705 
    706    termkey.termkey_push_bytes(tk, '\x1b[M##!', 6)
    707 
    708    termkey.termkey_getkey(tk, key)
    709    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    710 
    711    t.eq(ev[0], termkey.TERMKEY_MOUSE_RELEASE) -- mouse event for release
    712    t.eq(line[0], 1) -- mouse line for release
    713    t.eq(col[0], 3) -- mouse column for release
    714    t.eq(key.modifiers, 0) -- modifiers for press
    715 
    716    termkey.termkey_push_bytes(tk, '\x1b[M0++', 6)
    717 
    718    termkey.termkey_getkey(tk, key)
    719    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    720 
    721    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for Ctrl-press
    722    t.eq(button[0], 1) -- mouse button for Ctrl-press
    723    t.eq(line[0], 11) -- mouse line for Ctrl-press
    724    t.eq(col[0], 11) -- mouse column for Ctrl-press
    725    t.eq(key.modifiers, termkey.TERMKEY_KEYMOD_CTRL) -- modifiers for Ctrl-press
    726 
    727    len = termkey.termkey_strfkey(tk, buffer, t.ffi.sizeof(buffer), key, 0)
    728    t.eq(len, 15) -- string length for Ctrl-press
    729    t.eq(t.ffi.string(buffer), 'C-MousePress(1)') -- string buffer for Ctrl-press
    730 
    731    termkey.termkey_push_bytes(tk, '\x1b[M`!!', 6)
    732 
    733    termkey.termkey_getkey(tk, key)
    734    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    735 
    736    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for wheel down
    737    t.eq(button[0], 4) -- mouse button for wheel down
    738 
    739    termkey.termkey_push_bytes(tk, '\x1b[Mb!!', 6)
    740 
    741    termkey.termkey_getkey(tk, key)
    742    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    743 
    744    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for wheel left
    745    t.eq(button[0], 6) -- mouse button for wheel left
    746 
    747    -- rxvt protocol
    748    termkey.termkey_push_bytes(tk, '\x1b[0;20;20M', 10)
    749 
    750    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mouse press rxvt protocol
    751 
    752    t.eq(key.type, termkey.TERMKEY_TYPE_MOUSE) -- key.type for mouse press rxvt protocol
    753 
    754    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    755 
    756    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for press rxvt protocol
    757    t.eq(button[0], 1) -- mouse button for press rxvt protocol
    758    t.eq(line[0], 20) -- mouse line for press rxvt protocol
    759    t.eq(col[0], 20) -- mouse column for press rxvt protocol
    760    t.eq(key.modifiers, 0) -- modifiers for press rxvt protocol
    761 
    762    termkey.termkey_push_bytes(tk, '\x1b[3;20;20M', 10)
    763 
    764    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mouse release rxvt protocol
    765 
    766    t.eq(key.type, termkey.TERMKEY_TYPE_MOUSE) -- key.type for mouse release rxvt protocol
    767 
    768    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    769 
    770    t.eq(ev[0], termkey.TERMKEY_MOUSE_RELEASE) -- mouse event for release rxvt protocol
    771    t.eq(line[0], 20) -- mouse line for release rxvt protocol
    772    t.eq(col[0], 20) -- mouse column for release rxvt protocol
    773    t.eq(key.modifiers, 0) -- modifiers for release rxvt protocol
    774 
    775    -- SGR protocol
    776    termkey.termkey_push_bytes(tk, '\x1b[<0;30;30M', 11)
    777 
    778    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mouse press SGR encoding
    779 
    780    t.eq(key.type, termkey.TERMKEY_TYPE_MOUSE) -- key.type for mouse press SGR encoding
    781 
    782    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    783 
    784    t.eq(ev[0], termkey.TERMKEY_MOUSE_PRESS) -- mouse event for press SGR
    785    t.eq(button[0], 1) -- mouse button for press SGR
    786    t.eq(line[0], 30) -- mouse line for press SGR
    787    t.eq(col[0], 30) -- mouse column for press SGR
    788    t.eq(key.modifiers, 0) -- modifiers for press SGR
    789 
    790    termkey.termkey_push_bytes(tk, '\x1b[<0;30;30m', 11)
    791 
    792    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mouse release SGR encoding
    793 
    794    t.eq(key.type, termkey.TERMKEY_TYPE_MOUSE) -- key.type for mouse release SGR encoding
    795 
    796    t.eq(termkey.termkey_interpret_mouse(tk, key, ev, button, line, col), termkey.TERMKEY_RES_KEY) -- interpret_mouse yields RES_KEY
    797 
    798    t.eq(ev[0], termkey.TERMKEY_MOUSE_RELEASE) -- mouse event for release SGR
    799 
    800    termkey.termkey_push_bytes(tk, '\x1b[<0;500;300M', 13)
    801 
    802    termkey.termkey_getkey(tk, key)
    803    termkey.termkey_interpret_mouse(tk, key, ev, button, line, col)
    804 
    805    t.eq(line[0], 300) -- mouse line for press SGR wide
    806    t.eq(col[0], 500) -- mouse column for press SGR wide
    807 
    808    termkey.termkey_destroy(tk)
    809  end)
    810 
    811  itp('31position', function()
    812    local tk = termkey.termkey_new_abstract(nil, 0)
    813    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    814    local line = t.ffi.new('int[1]')
    815    local col = t.ffi.new('int[1]')
    816 
    817    termkey.termkey_push_bytes(tk, '\x1b[?15;7R', 8)
    818 
    819    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for position report
    820 
    821    t.eq(key.type, termkey.TERMKEY_TYPE_POSITION) -- key.type for position report
    822 
    823    t.eq(termkey.termkey_interpret_position(tk, key, line, col), termkey.TERMKEY_RES_KEY) -- interpret_position yields RES_KEY
    824 
    825    t.eq(line[0], 15) -- line for position report
    826    t.eq(col[0], 7) -- column for position report
    827 
    828    -- A plain CSI R is likely to be <F3> though.
    829    -- This is tricky :/
    830 
    831    termkey.termkey_push_bytes(tk, '\x1b[R', 3)
    832 
    833    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for <F3>
    834 
    835    t.eq(key.type, termkey.TERMKEY_TYPE_FUNCTION) -- key.type for <F3>
    836    t.eq(key.code.number, 3) -- key.code.number for <F3>
    837 
    838    termkey.termkey_destroy(tk)
    839  end)
    840 
    841  itp('32modereport', function()
    842    local tk = termkey.termkey_new_abstract(nil, 0)
    843    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    844    local initial = t.ffi.new('int[1]')
    845    local mode = t.ffi.new('int[1]')
    846    local value = t.ffi.new('int[1]')
    847 
    848    termkey.termkey_push_bytes(tk, '\x1b[?1;2$y', 8)
    849 
    850    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mode report
    851 
    852    t.eq(key.type, termkey.TERMKEY_TYPE_MODEREPORT) -- key.type for mode report
    853 
    854    t.eq(
    855      termkey.termkey_interpret_modereport(tk, key, initial, mode, value),
    856      termkey.TERMKEY_RES_KEY
    857    ) -- interpret_modereoprt yields RES_KEY
    858 
    859    t.eq(initial[0], 63) -- initial indicator from mode report
    860    t.eq(mode[0], 1) -- mode number from mode report
    861    t.eq(value[0], 2) -- mode value from mode report
    862 
    863    termkey.termkey_push_bytes(tk, '\x1b[4;1$y', 7)
    864 
    865    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for mode report
    866 
    867    t.eq(key.type, termkey.TERMKEY_TYPE_MODEREPORT) -- key.type for mode report
    868 
    869    t.eq(
    870      termkey.termkey_interpret_modereport(tk, key, initial, mode, value),
    871      termkey.TERMKEY_RES_KEY
    872    ) -- interpret_modereoprt yields RES_KEY
    873 
    874    t.eq(initial[0], 0) -- initial indicator from mode report
    875    t.eq(mode[0], 4) -- mode number from mode report
    876    t.eq(value[0], 1) -- mode value from mode report
    877 
    878    termkey.termkey_destroy(tk)
    879  end)
    880 
    881  itp('38csi', function()
    882    local tk = termkey.termkey_new_abstract(nil, 0)
    883    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    884    local args = t.ffi.new('TermKeyCsiParam[16]')
    885    local nargs = t.ffi.new('size_t[1]')
    886    local command = t.ffi.new('unsigned[1]')
    887 
    888    termkey.termkey_push_bytes(tk, '\x1b[5;25v', 7)
    889 
    890    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for CSI v
    891 
    892    t.eq(key.type, termkey.TERMKEY_TYPE_UNKNOWN_CSI) -- key.type for unknown CSI
    893 
    894    t.eq(termkey.termkey_interpret_csi(tk, key, args, nargs, command), termkey.TERMKEY_RES_KEY) -- interpret_csi yields RES_KEY
    895 
    896    t.eq(nargs[0], 2) -- nargs for unknown CSI
    897    -- t.eq(args[0],   5) -- args[0] for unknown CSI
    898    -- t.eq(args[1],  25) -- args[1] for unknown CSI
    899    t.eq(command[0], 118) -- command for unknown CSI
    900 
    901    termkey.termkey_push_bytes(tk, '\x1b[?w', 4)
    902 
    903    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for CSI ? w
    904    t.eq(key.type, termkey.TERMKEY_TYPE_UNKNOWN_CSI) -- key.type for unknown CSI
    905    t.eq(termkey.termkey_interpret_csi(tk, key, args, nargs, command), termkey.TERMKEY_RES_KEY) -- interpret_csi yields RES_KEY
    906    t.eq(command[0], bit.bor(bit.lshift(63, 8), 119)) -- command for unknown CSI
    907 
    908    termkey.termkey_push_bytes(tk, '\x1b[?$x', 5)
    909 
    910    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for CSI ? $x
    911    t.eq(key.type, termkey.TERMKEY_TYPE_UNKNOWN_CSI) -- key.type for unknown CSI
    912    t.eq(termkey.termkey_interpret_csi(tk, key, args, nargs, command), termkey.TERMKEY_RES_KEY) -- interpret_csi yields RES_KEY
    913    t.eq(command[0], bit.bor(bit.lshift(36, 16), bit.lshift(63, 8), 120)) -- command for unknown CSI
    914 
    915    termkey.termkey_destroy(tk)
    916  end)
    917 
    918  itp('39dcs', function()
    919    local tk = termkey.termkey_new_abstract(nil, 0)
    920    local key = t.ffi.new('TermKeyKey') ---@type TermKeyKey
    921 
    922    -- 7bit DCS
    923    termkey.termkey_push_bytes(tk, '\x1bP1$r1 q\x1b\\', 10)
    924 
    925    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for DCS
    926 
    927    t.eq(key.type, termkey.TERMKEY_TYPE_DCS) -- key.type for DCS
    928    t.eq(key.modifiers, 0) -- key.modifiers for DCS
    929 
    930    local str = t.ffi.new('const char*[1]')
    931    t.eq(termkey.termkey_interpret_string(tk, key, str), termkey.TERMKEY_RES_KEY) -- termkey_interpret_string() gives string
    932    t.eq(t.ffi.string(str[0]), '1$r1 q') -- termkey_interpret_string() yields correct string
    933 
    934    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_NONE) -- getkey again yields RES_NONE
    935 
    936    -- 8bit DCS
    937    termkey.termkey_push_bytes(tk, '\x901$r2 q\x9c', 8)
    938 
    939    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for DCS
    940 
    941    t.eq(key.type, termkey.TERMKEY_TYPE_DCS) -- key.type for DCS
    942    t.eq(key.modifiers, 0) -- key.modifiers for DCS
    943 
    944    t.eq(termkey.termkey_interpret_string(tk, key, str), termkey.TERMKEY_RES_KEY) -- "termkey_interpret_string() gives string");
    945    t.eq(t.ffi.string(str[0]), '1$r2 q') -- "termkey_interpret_string() yields correct string");
    946 
    947    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_NONE) -- "getkey again yields RES_NONE");
    948 
    949    -- 7bit OSC
    950    termkey.termkey_push_bytes(tk, '\x1b]15;abc\x1b\\', 10)
    951 
    952    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_KEY) -- getkey yields RES_KEY for OSC
    953 
    954    t.eq(key.type, termkey.TERMKEY_TYPE_OSC) -- key.type for OSC
    955    t.eq(key.modifiers, 0) -- key.modifiers for OSC
    956 
    957    t.eq(termkey.termkey_interpret_string(tk, key, str), termkey.TERMKEY_RES_KEY) -- "termkey_interpret_string() gives string");
    958    t.eq(t.ffi.string(str[0]), '15;abc') -- "termkey_interpret_string() yields correct string");
    959 
    960    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_NONE) -- getkey again yields RES_NONE
    961 
    962    -- False alarm
    963    termkey.termkey_push_bytes(tk, '\x1bP', 2)
    964 
    965    t.eq(termkey.termkey_getkey(tk, key), termkey.TERMKEY_RES_AGAIN) -- getkey yields RES_AGAIN for false alarm
    966 
    967    t.eq(termkey.termkey_getkey_force(tk, key), termkey.TERMKEY_RES_KEY) -- getkey_force yields RES_KEY for false alarm
    968 
    969    t.eq(key.type, termkey.TERMKEY_TYPE_UNICODE) -- key.type for false alarm
    970    t.eq(key.code.codepoint, string.byte('P')) -- key.code.codepoint for false alarm
    971    t.eq(key.modifiers, termkey.TERMKEY_KEYMOD_ALT) -- key.modifiers for false alarm
    972 
    973    termkey.termkey_destroy(tk)
    974  end)
    975 end)