path: root/test/functional/api/tabpage_spec.lua

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local Screen = require('test.functional.ui.screen')

local describe, it, before_each = t.describe, t.it, t.before_each
local clear, eq, ok = n.clear, t.eq, t.ok
local matches = t.matches
local exec = n.exec
local api = n.api
local fn = n.fn
local request = n.request
local NIL = vim.NIL
local pcall_err = t.pcall_err
local command = n.command

describe('api/tabpage', function()
  before_each(clear)

  describe('list_wins and get_win', function()
    it('works', function()
      command('tabnew')
      command('vsplit')
      local tab1, tab2 = unpack(api.nvim_list_tabpages())
      local win1, win2, win3 = unpack(api.nvim_list_wins())
      eq({ win1 }, api.nvim_tabpage_list_wins(tab1))
      eq(win1, api.nvim_tabpage_get_win(tab1))
      eq({ win2, win3 }, api.nvim_tabpage_list_wins(tab2))
      eq(win2, api.nvim_tabpage_get_win(tab2))
      api.nvim_set_current_win(win3)
      eq(win3, api.nvim_tabpage_get_win(tab2))
      command('tabprev')
      eq(win1, api.nvim_tabpage_get_win(tab1))
      eq(win3, api.nvim_tabpage_get_win(tab2))
    end)

    it('validates args', function()
      eq('Invalid tabpage id: 23', pcall_err(api.nvim_tabpage_list_wins, 23))
    end)
  end)

  describe('set_win', function()
    it('works', function()
      command('tabnew')
      command('vsplit')
      local tab1, tab2 = unpack(api.nvim_list_tabpages())
      local win1, win2, win3 = unpack(api.nvim_list_wins())
      eq({ win1 }, api.nvim_tabpage_list_wins(tab1))
      eq({ win2, win3 }, api.nvim_tabpage_list_wins(tab2))
      eq(win2, api.nvim_tabpage_get_win(tab2))
      api.nvim_tabpage_set_win(tab2, win3)
      eq(win3, api.nvim_tabpage_get_win(tab2))
    end)

    it('works in non-current tabpages', function()
      command('tabnew')
      command('vsplit')
      local tab1, tab2 = unpack(api.nvim_list_tabpages())
      local win1, win2, win3 = unpack(api.nvim_list_wins())
      eq({ win1 }, api.nvim_tabpage_list_wins(tab1))
      eq({ win2, win3 }, api.nvim_tabpage_list_wins(tab2))
      eq(win2, api.nvim_tabpage_get_win(tab2))
      eq(win2, api.nvim_get_current_win())

      command('tabprev')

      eq(tab1, api.nvim_get_current_tabpage())

      eq(win2, api.nvim_tabpage_get_win(tab2))
      api.nvim_tabpage_set_win(tab2, win3)
      eq(win3, api.nvim_tabpage_get_win(tab2))

      command('tabnext')
      eq(win3, api.nvim_get_current_win())
    end)

    it('throws an error when the window does not belong to the tabpage', function()
      command('tabnew')
      command('vsplit')
      local tab1, tab2 = unpack(api.nvim_list_tabpages())
      local win1, win2, win3 = unpack(api.nvim_list_wins())
      eq({ win1 }, api.nvim_tabpage_list_wins(tab1))
      eq({ win2, win3 }, api.nvim_tabpage_list_wins(tab2))
      eq(win2, api.nvim_get_current_win())

      eq(
        string.format('Window does not belong to tabpage %d', tab2),
        pcall_err(api.nvim_tabpage_set_win, tab2, win1)
      )

      eq(
        string.format('Window does not belong to tabpage %d', tab1),
        pcall_err(api.nvim_tabpage_set_win, tab1, win3)
      )
    end)

    it('checks textlock restrictions', function()
      command('autocmd TextYankPost * ++once call nvim_open_tabpage(0, 0, {})')
      matches('E565:', pcall_err(command, 'yank'))
      eq(1, fn.tabpagenr('$'))

      exec([[
        new
        call setline(1, 'foo')
        setlocal debug=throw indentexpr=nvim_tabpage_set_win(0,win_getid())
      ]])
      local cur_win = api.nvim_get_current_win()
      matches('E565: Not allowed to change text or change window', pcall_err(command, 'normal! =='))
      eq(cur_win, api.nvim_get_current_win())
    end)
  end)

  describe('{get,set,del}_var', function()
    it('works', function()
      api.nvim_tabpage_set_var(0, 'lua', { 1, 2, { ['3'] = 1 } })
      eq({ 1, 2, { ['3'] = 1 } }, api.nvim_tabpage_get_var(0, 'lua'))
      eq({ 1, 2, { ['3'] = 1 } }, api.nvim_eval('t:lua'))
      eq(1, fn.exists('t:lua'))
      api.nvim_tabpage_del_var(0, 'lua')
      eq(0, fn.exists('t:lua'))
      eq('Key not found: lua', pcall_err(api.nvim_tabpage_del_var, 0, 'lua'))
      api.nvim_tabpage_set_var(0, 'lua', 1)
      command('lockvar t:lua')
      eq('Key is locked: lua', pcall_err(api.nvim_tabpage_del_var, 0, 'lua'))
      eq('Key is locked: lua', pcall_err(api.nvim_tabpage_set_var, 0, 'lua', 1))
    end)

    it('tabpage_set_var returns the old value', function()
      local val1 = { 1, 2, { ['3'] = 1 } }
      local val2 = { 4, 7 }
      eq(NIL, request('tabpage_set_var', 0, 'lua', val1))
      eq(val1, request('tabpage_set_var', 0, 'lua', val2))
    end)

    it('tabpage_del_var returns the old value', function()
      local val1 = { 1, 2, { ['3'] = 1 } }
      local val2 = { 4, 7 }
      eq(NIL, request('tabpage_set_var', 0, 'lua', val1))
      eq(val1, request('tabpage_set_var', 0, 'lua', val2))
      eq(val2, request('tabpage_del_var', 0, 'lua'))
    end)
  end)

  describe('get_number', function()
    it('works', function()
      local tabs = api.nvim_list_tabpages()
      eq(1, api.nvim_tabpage_get_number(tabs[1]))

      command('tabnew')
      local tab1, tab2 = unpack(api.nvim_list_tabpages())
      eq(1, api.nvim_tabpage_get_number(tab1))
      eq(2, api.nvim_tabpage_get_number(tab2))

      command('-tabmove')
      eq(2, api.nvim_tabpage_get_number(tab1))
      eq(1, api.nvim_tabpage_get_number(tab2))
    end)
  end)

  describe('is_valid', function()
    it('works', function()
      command('tabnew')
      local tab = api.nvim_list_tabpages()[2]
      api.nvim_set_current_tabpage(tab)
      ok(api.nvim_tabpage_is_valid(tab))
      command('tabclose')
      ok(not api.nvim_tabpage_is_valid(tab))
    end)
  end)

  describe('open_tabpage', function()
    it('works', function()
      local tabs = api.nvim_list_tabpages()
      eq(1, #tabs)
      local curtab = api.nvim_get_current_tabpage()
      local tab = api.nvim_open_tabpage(0, false, {})
      local newtabs = api.nvim_list_tabpages()
      eq(2, #newtabs)
      eq(tab, newtabs[2])
      eq(curtab, api.nvim_get_current_tabpage())

      local tab2 = api.nvim_open_tabpage(0, true, {})
      local newtabs2 = api.nvim_list_tabpages()
      eq(3, #newtabs2)
      eq({
        tabs[1],
        tab2, -- new tabs open after the current tab
        tab,
      }, newtabs2)
      eq(tab2, newtabs2[2])
      eq(tab, newtabs2[3])
      eq(tab2, api.nvim_get_current_tabpage())
    end)

    it('respects the `after` option', function()
      local tab1 = api.nvim_get_current_tabpage()
      command('tabnew')
      local tab2 = api.nvim_get_current_tabpage()
      command('tabnew')
      local tab3 = api.nvim_get_current_tabpage()

      local newtabs = api.nvim_list_tabpages()
      eq(3, #newtabs)
      eq({
        tab1,
        tab2,
        -- new_tab,
        tab3,
      }, newtabs)

      local new_tab = api.nvim_open_tabpage(0, false, { after = api.nvim_tabpage_get_number(tab2) })
      local newtabs2 = api.nvim_list_tabpages()
      eq(4, #newtabs2)
      eq({
        tab1,
        tab2,
        new_tab,
        tab3,
      }, newtabs2)
      eq(tab3, api.nvim_get_current_tabpage())
    end)

    it('respects the `enter` argument', function()
      local screen = Screen.new(50, 8)
      eq(1, #api.nvim_list_tabpages())
      local tab1 = api.nvim_get_current_tabpage()

      local new_tab = api.nvim_open_tabpage(0, false, {})
      local newtabs = api.nvim_list_tabpages()
      eq(2, #newtabs)
      eq({ tab1, new_tab }, newtabs)
      eq(tab1, api.nvim_get_current_tabpage())
      -- Tabline redrawn when not entering.
      screen:expect([[
        {5: [No Name] }{24: [No Name] }{2:                           }{24:X}|
        ^                                                  |
        {1:~                                                 }|*5
                                                          |
      ]])

      local new_tab2 = api.nvim_open_tabpage(0, true, {})
      local newtabs2 = api.nvim_list_tabpages()
      eq(3, #newtabs2)
      eq({ tab1, new_tab2, new_tab }, newtabs2)
      eq(new_tab2, api.nvim_get_current_tabpage())
      -- Tabline redrawn. (when entering)
      screen:expect([[
        {24: [No Name] }{5: [No Name] }{24: [No Name] }{2:                }{24:X}|
        ^                                                  |
        {1:~                                                 }|*5
                                                          |
      ]])

      api.nvim_open_tabpage(0, false, {})
      -- Tabline redrawn when not entering, and when there's already one.
      screen:expect([[
        {24: [No Name] }{5: [No Name] }{24: [No Name]  [No Name] }{2:     }{24:X}|
        ^                                                  |
        {1:~                                                 }|*5
                                                          |
      ]])
    end)

    it('applies autocmds in the context of the new tabpage', function()
      exec([=[
        let g:events = []
        autocmd WinNew * let g:events += [['WinNew', nvim_get_current_tabpage(), win_getid()]]
        autocmd WinEnter * let g:events += [['WinEnter', nvim_get_current_tabpage(), win_getid()]]
        autocmd TabNew * let g:events += [['TabNew', nvim_get_current_tabpage(), win_getid()]]
        autocmd TabEnter * let g:events += [['TabEnter', nvim_get_current_tabpage(), win_getid()]]
        autocmd BufEnter * let g:events += [['BufEnter', nvim_get_current_tabpage(), win_getid()]]
        autocmd BufLeave * let g:events += [['BufLeave', nvim_get_current_tabpage(), win_getid()]]
        autocmd BufWinEnter * let g:events += [['BufWinEnter', nvim_get_current_tabpage(), win_getid()]]
      ]=])

      local new_tab = api.nvim_open_tabpage(0, true, {})
      local new_win