path: root/test/unit/extreg_spec.lua

local t = require('test.unit.testutil')

local describe, it = t.describe, t.it
local itp = t.gen_itp(it)
local cimport = t.cimport
local child_call_once = t.child_call_once
local eq = t.eq
local ffi = t.ffi

local lib = cimport('./src/nvim/extreg.h')

-- Helper function to convert a single character to its codepoint
local function char2codepoint(ch)
  assert(ch:len() == 1, 'Expected single character: ' .. ch)
  return ch:byte(1)
end

-- Single initialization for all tests
child_call_once(function()
  lib.extreg_init()
end)

describe('extreg provider registration', function()
  itp('provider can be registered successfully', function()
    local result = lib.extreg_register('test-provider', -1, -1)
    eq(1, result) -- extreg_register returns int (1 = success)

    local prov = lib.extreg_get_provider('test-provider')
    eq(true, prov ~= nil)

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('duplicate provider registration fails', function()
    lib.extreg_register('test-provider', -1, -1)
    local result = lib.extreg_register('test-provider', -1, -1)
    eq(0, result) -- Duplicate should fail (0 = failure)

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('provider name too long fails', function()
    local long_name = ('a'):rep(257)
    local result = lib.extreg_register(long_name, -1, -1)
    eq(0, result) -- Name too long should fail
  end)

  itp('provider can be retrieved by name', function()
    lib.extreg_register('named-provider', -1, -1)

    local prov = lib.extreg_get_provider('named-provider')
    eq(true, prov ~= nil)

    -- Cleanup
    lib.extreg_unregister('named-provider')
  end)

  itp('nonexistent provider returns nil', function()
    local prov = lib.extreg_get_provider('nonexistent-provider')
    eq(nil, prov)
  end)
end)

describe('extreg provider unregistering', function()
  itp('provider can be unregistered successfully', function()
    lib.extreg_register('to-unregister', -1, -1)

    local result = lib.extreg_unregister('to-unregister')
    eq(1, result) -- 1 = success

    -- Provider should be gone
    local prov = lib.extreg_get_provider('to-unregister')
    eq(nil, prov)
  end)

  itp('unregistering nonexistent provider fails', function()
    local result = lib.extreg_unregister('nonexistent-provider')
    eq(0, result) -- 0 = failure
  end)

  itp('unregistering already unregistered provider fails', function()
    lib.extreg_register('once-only', -1, -1)
    lib.extreg_unregister('once-only')

    local result = lib.extreg_unregister('once-only')
    eq(0, result) -- 0 = failure
  end)
end)

describe('extreg alias binding', function()
  itp('alias can be bound to provider', function()
    lib.extreg_register('alias-target', -1, -1)

    local result = lib.extreg_bind(char2codepoint('@'), 'alias-target')
    eq(1, result) -- 1 = success

    eq(true, lib.extreg_is_alias(char2codepoint('@')))

    -- Cleanup
    lib.extreg_unbind(char2codepoint('@'))
    lib.extreg_unregister('alias-target')
  end)

  itp('lowercase letters cannot be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    eq(0, lib.extreg_bind(char2codepoint('a'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('b'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('z'), 'test-provider'))

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('uppercase letters cannot be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    eq(0, lib.extreg_bind(char2codepoint('A'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('B'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('Z'), 'test-provider'))

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('special characters cannot be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    eq(0, lib.extreg_bind(char2codepoint('='), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('#'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('%'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('.'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('/'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint(':'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint(';'), 'test-provider'))
    eq(0, lib.extreg_bind(char2codepoint('+'), 'test-provider'))

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('digits cannot be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    for i = 0, 9 do
      eq(0, lib.extreg_bind(char2codepoint(tostring(i)), 'test-provider'))
    end

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('control characters cannot be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    eq(0, lib.extreg_bind(char2codepoint(string.char(32)), 'test-provider'))  -- space
    eq(0, lib.extreg_bind(char2codepoint(string.char(9)), 'test-provider'))   -- tab
    eq(0, lib.extreg_bind(char2codepoint(string.char(10)), 'test-provider'))  -- newline
    eq(0, lib.extreg_bind(char2codepoint(string.char(13)), 'test-provider'))  -- carriage return
    eq(0, lib.extreg_bind(char2codepoint(string.char(0)), 'test-provider'))   -- NUL
    eq(0, lib.extreg_bind(char2codepoint(string.char(127)), 'test-provider')) -- DEL

    -- Cleanup
    lib.extreg_unregister('test-provider')
  end)

  itp('valid special characters can be used as aliases', function()
    lib.extreg_register('test-provider', -1, -1)

    eq(1, lib.extreg_bind(char2codepoint('@'), 'test-provider'))
    eq(1, lib.extreg_bind(char2codepoint('$'), 'test-provider'))
    eq(1, lib.extreg_bind(char2codepoint('!'), 'test-provider'))
    eq(1, lib.extreg_bind(char2codepoint('`'), 'test-provider'))

    -- Cleanup
    lib.extreg_unbind(char2codepoint('@'))
    lib.extreg_unbind(char2codepoint('$'))
    lib.extreg_unbind(char2codepoint('!'))
    lib.extreg_unbind(char2codepoint('`'))
    lib.extreg_unregister('test-provider')
  end)

  itp('alias can be rebound to different provider', function()
    lib.extreg_register('provider-1', -1, -1)
    lib.extreg_register('provider-2', -1, -1)

    eq(1, lib.extreg_bind(char2codepoint('@'), 'provider-1'))
    eq(true, lib.extreg_is_alias(char2codepoint('@')))

    eq(1, lib.extreg_unbind(char2codepoint('@')))
    eq(1, lib.extreg_bind(char2codepoint('@'), 'provider-2'))
    eq(true, lib.extreg_is_alias(char2codepoint('@'))) -- Alias still exists

    -- Cleanup
    lib.extreg_unbind(char2codepoint('@'))
    lib.extreg_unregister('provider-1')
    lib.extreg_unregister('provider-2')
  end)
end)

describe('extreg alias unbinding', function()
  itp('alias can be unbound successfully', function()
    lib.extreg_register('unbind-target', -1, -1)
    eq(1, lib.extreg_bind(char2codepoint('`'), 'unbind-target'))

    eq(true, lib.extreg_is_alias(char2codepoint('`')))

    local result = lib.extreg_unbind(char2codepoint('`'))
    eq(1, result) -- 1 = success

    eq(false, lib.extreg_is_alias(char2codepoint('`')))

    -- Cleanup
    lib.extreg_unregister('unbind-target')
  end)

  itp('unbinding non-bound alias fails', function()
    local result = lib.extreg_unbind(char2codepoint('@'))
    eq(0, result) -- 0 = failure

    eq(false, lib.extreg_is_alias(char2codepoint('@')))
  end)
end)

describe('extreg alias checking', function()
  itp('is_alias returns true for bound alias', function()
    lib.extreg_register('alias-test', -1, -1)
    eq(1, lib.extreg_bind(char2codepoint('$'), 'alias-test'))

    eq(true, lib.extreg_is_alias(char2codepoint('$')))

    -- Cleanup
    lib.extreg_unbind(char2codepoint('$'))
    lib.extreg_unregister('alias-test')
  end)

  itp('is_alias returns false for unbound alias', function()
    eq(false, lib.extreg_is_alias(char2codepoint('`')))
  end)
end)

describe('extreg clear all', function()
  itp('clear_all removes all providers', function()
    lib.extreg_register('clear-1', -1, -1)
    lib.extreg_register('clear-2', -1, -1)

    eq(true, lib.extreg_get_provider('clear-1') ~= nil)