-*builtin.txt* For Vim version 9.2. Last change: 2026 Apr 27
+*builtin.txt* For Vim version 9.2. Last change: 2026 Apr 28
VIM REFERENCE MANUAL by Bram Moolenaar
tabpagenr([{arg}]) Number number of current or last tab page
tabpagewinnr({tabarg} [, {arg}])
Number number of current window in tab page
+tabpanel_getinfo() Dict get current state of the tabpanel
+tabpanel_scroll({n} [, {opts}]) Bool scroll the tabpanel
tagfiles() List tags files used
taglist({expr} [, {filename}]) List list of tags matching {expr}
tan({expr}) Float tangent of {expr}
Return type: |Number|
+tabpanel_getinfo() *tabpanel_getinfo()*
+ Return a |Dictionary| describing the current state of the
+ tabpanel (see |tabpanel|). The dictionary has these keys:
+ align "left" or "right"
+ columns width in screen columns
+ scrollbar |TRUE| if a scrollbar is shown
+ offset current scroll offset in rows
+ total total number of rows rendered
+ max_offset largest valid value for "offset"
+
+ The "total" and "max_offset" values are only accurate after
+ the tabpanel has been drawn at least once.
+
+ Return type: dict<any>
+
+
+tabpanel_scroll({n} [, {opts}]) *tabpanel_scroll()*
+ Scroll the tabpanel by {n} rows. Positive values scroll down
+ (later tabs become visible), negative values scroll up. The
+ new offset is clamped to the valid range.
+
+ When {opts} is a |Dictionary| and its "absolute" entry is
+ |TRUE|, {n} is used as the new absolute scroll offset
+ instead of a delta.
+
+ Returns |TRUE| if the scroll offset changed, |FALSE|
+ otherwise (for example when the tabpanel is not shown, or
+ the offset is already at the requested value).
+
+ Return type: |vim9-boolean|
+
+
tagfiles() *tagfiles()*
Returns a |List| with the file names used to search for tags
for the current buffer. This is the 'tags' option expanded.
tabpanel tabpage.txt /*tabpanel*
tabpanel-mouse tabpage.txt /*tabpanel-mouse*
tabpanel-scroll tabpage.txt /*tabpanel-scroll*
+tabpanel_getinfo() builtin.txt /*tabpanel_getinfo()*
+tabpanel_scroll() builtin.txt /*tabpanel_scroll()*
tag tagsrch.txt /*tag*
tag-! tagsrch.txt /*tag-!*
tag-binary-search tagsrch.txt /*tag-binary-search*
-*usr_41.txt* For Vim version 9.2. Last change: 2026 Feb 16
+*usr_41.txt* For Vim version 9.2. Last change: 2026 Apr 28
VIM USER MANUAL by Bram Moolenaar
tabpagebuflist() return List of buffers in a tab page
tabpagenr() get the number of a tab page
tabpagewinnr() like winnr() for a specified tab page
+ tabpanel_getinfo() get current state of the tabpanel
+ tabpanel_scroll() scroll the tabpanel
winnr() get the window number for the current window
bufwinid() get the window ID of a specific buffer
bufwinnr() get the window number of a specific buffer
Functions: ~
|ch_listen()| listen on {address}
+|tabpanel_getinfo()| get current state of the |tabpanel|
+|tabpanel_scroll()| scroll the |tabpanel|
Autocommands: ~
" Language: Vim script
" Maintainer: Hirohito Higashi <h.east.727 ATMARK gmail.com>
" Doug Kearns <dougkearns@gmail.com>
-" Last Change: 2026 Apr 20
+" Last Change: 2026 Apr 28
" Former Maintainer: Charles E. Campbell
" DO NOT CHANGE DIRECTLY.
syn keyword vimFuncName contained histget histnr hlID hlexists hlget hlset hostname iconv id indent index indexof input inputdialog inputlist inputrestore inputsave inputsecret insert instanceof interrupt invert isabsolutepath isdirectory isinf islocked isnan items job_getchannel job_info job_setoptions job_start job_status job_stop join js_decode js_encode json_decode json_encode keys keytrans len libcall libcallnr line line2byte lispindent list2blob list2str list2tuple listener_add listener_flush listener_remove localtime log log10 luaeval map maparg mapcheck maplist mapnew mapset match matchadd matchaddpos matcharg matchbufline matchdelete matchend matchfuzzy matchfuzzypos matchlist matchstr matchstrlist matchstrpos max menu_info min mkdir mode mzeval nextnonblank
syn keyword vimFuncName contained ngettext nr2char or pathshorten perleval popup_atcursor popup_beval popup_clear popup_close popup_create popup_dialog popup_filter_menu popup_filter_yesno popup_findecho popup_findinfo popup_findpreview popup_getoptions popup_getpos popup_hide popup_list popup_locate popup_menu popup_move popup_notification popup_setbuf popup_setoptions popup_settext popup_show pow preinserted prevnonblank printf prompt_getprompt prompt_setcallback prompt_setinterrupt prompt_setprompt prop_add prop_add_list prop_clear prop_find prop_list prop_remove prop_type_add prop_type_change prop_type_delete prop_type_get prop_type_list pum_getpos pumvisible py3eval pyeval pyxeval rand range readblob readdir readdirex readfile redraw_listener_add redraw_listener_remove
syn keyword vimFuncName contained reduce reg_executing reg_recording reltime reltimefloat reltimestr remote_expr remote_foreground remote_peek remote_read remote_send remote_startserver remove rename repeat resolve reverse round rubyeval screenattr screenchar screenchars screencol screenpos screenrow screenstring search searchcount searchdecl searchpair searchpairpos searchpos server2client serverlist setbufline setbufvar setcellwidths setcharpos setcharsearch setcmdline setcmdpos setcursorcharpos setenv setfperm setline setloclist setmatches setpos setqflist setreg settabvar settabwinvar settagstack setwinvar sha256 shellescape shiftwidth sign_define sign_getdefined sign_getplaced sign_jump sign_place sign_placelist sign_undefine sign_unplace sign_unplacelist
-syn keyword vimFuncName contained simplify sin sinh slice sort sound_clear sound_playevent sound_playfile sound_stop soundfold spellbadword spellsuggest split sqrt srand state str2blob str2float str2list str2nr strcharlen strcharpart strchars strdisplaywidth strftime strgetchar stridx string strlen strpart strptime strridx strtrans strutf16len strwidth submatch substitute swapfilelist swapinfo swapname synID synIDattr synIDtrans synconcealed synstack system systemlist tabpagebuflist tabpagenr tabpagewinnr tagfiles taglist tan tanh tempname term_dumpdiff term_dumpload term_dumpwrite term_getaltscreen term_getansicolors term_getattr term_getcursor term_getjob term_getline term_getscrolled term_getsize term_getstatus term_gettitle term_gettty term_list term_scrape
-syn keyword vimFuncName contained term_sendkeys term_setansicolors term_setapi term_setkill term_setrestore term_setsize term_start term_wait terminalprops test_alloc_fail test_autochdir test_feedinput test_garbagecollect_now test_garbagecollect_soon test_getvalue test_gui_event test_ignore_error test_mswin_event test_null_blob test_null_channel test_null_dict test_null_function test_null_job test_null_list test_null_partial test_null_string test_null_tuple test_option_not_set test_override test_refcount test_setmouse test_settime test_srand_seed test_unknown test_void timer_info timer_pause timer_start timer_stop timer_stopall tolower toupper tr trim trunc tuple2list type typename undofile undotree uniq uri_decode uri_encode utf16idx values virtcol virtcol2col
-syn keyword vimFuncName contained visualmode wildmenumode wildtrigger win_execute win_findbuf win_getid win_gettype win_gotoid win_id2tabwin win_id2win win_move_separator win_move_statusline win_screenpos win_splitmove winbufnr wincol windowsversion winheight winlayout winline winnr winrestcmd winrestview winsaveview winwidth wordcount writefile xor
+syn keyword vimFuncName contained simplify sin sinh slice sort sound_clear sound_playevent sound_playfile sound_stop soundfold spellbadword spellsuggest split sqrt srand state str2blob str2float str2list str2nr strcharlen strcharpart strchars strdisplaywidth strftime strgetchar stridx string strlen strpart strptime strridx strtrans strutf16len strwidth submatch substitute swapfilelist swapinfo swapname synID synIDattr synIDtrans synconcealed synstack system systemlist tabpagebuflist tabpagenr tabpagewinnr tabpanel_getinfo tabpanel_scroll tagfiles taglist tan tanh tempname term_dumpdiff term_dumpload term_dumpwrite term_getaltscreen term_getansicolors term_getattr term_getcursor term_getjob term_getline term_getscrolled term_getsize term_getstatus term_gettitle
+syn keyword vimFuncName contained term_gettty term_list term_scrape term_sendkeys term_setansicolors term_setapi term_setkill term_setrestore term_setsize term_start term_wait terminalprops test_alloc_fail test_autochdir test_feedinput test_garbagecollect_now test_garbagecollect_soon test_getvalue test_gui_event test_ignore_error test_mswin_event test_null_blob test_null_channel test_null_dict test_null_function test_null_job test_null_list test_null_partial test_null_string test_null_tuple test_option_not_set test_override test_refcount test_setmouse test_settime test_srand_seed test_unknown test_void timer_info timer_pause timer_start timer_stop timer_stopall tolower toupper tr trim trunc tuple2list type typename undofile undotree uniq uri_decode uri_encode
+syn keyword vimFuncName contained utf16idx values virtcol virtcol2col visualmode wildmenumode wildtrigger win_execute win_findbuf win_getid win_gettype win_gotoid win_id2tabwin win_id2win win_move_separator win_move_statusline win_screenpos win_splitmove winbufnr wincol windowsversion winheight winlayout winline winnr winrestcmd winrestview winsaveview winwidth wordcount writefile xor
" Predefined variable names {{{2
" GEN_SYN_VIM: vimVarName, START_STR='syn keyword vimVimVarName contained', END_STR=''
#else
# define TERM_FUNC(name) NULL
#endif
+#ifdef FEAT_TABPANEL
+# define TABPANEL_FUNC(name) name
+#else
+# define TABPANEL_FUNC(name) NULL
+#endif
static const funcentry_T global_functions[] =
{
ret_number, f_tabpagenr},
{"tabpagewinnr", 1, 2, FEARG_1, arg2_number_string,
ret_number, f_tabpagewinnr},
+ {"tabpanel_getinfo", 0, 0, 0, NULL,
+ ret_dict_any, TABPANEL_FUNC(f_tabpanel_getinfo)},
+ {"tabpanel_scroll", 1, 2, FEARG_1, arg2_number_dict_any,
+ ret_bool, TABPANEL_FUNC(f_tabpanel_scroll)},
{"tagfiles", 0, 0, 0, NULL,
ret_list_string, f_tagfiles},
{"taglist", 1, 2, FEARG_1, arg2_string,
bool mouse_on_tabpanel_scrollbar(void);
bool tabpanel_drag_scrollbar(int screen_row);
bool tabpanel_scroll(int dir, int count);
+bool tabpanel_set_offset(int offset);
+void f_tabpanel_getinfo(typval_T *argvars, typval_T *rettv);
+void f_tabpanel_scroll(typval_T *argvars, typval_T *rettv);
/* vim: set ft=c : */
return true;
}
+/*
+ * Set the tabpanel scroll offset to "offset" (clamped to the valid range).
+ * Returns true if the offset changed and a redraw was scheduled.
+ */
+ bool
+tabpanel_set_offset(int offset)
+{
+ int max_offset;
+
+ if (tabpanel_width() == 0)
+ return false;
+
+ max_offset = tpl_total_rows - Rows;
+ if (max_offset < 0)
+ max_offset = 0;
+
+ if (offset < 0)
+ offset = 0;
+ if (offset > max_offset)
+ offset = max_offset;
+ if (offset == tpl_scroll_offset)
+ return false;
+
+ tpl_scroll_offset = offset;
+ redraw_tabpanel = TRUE;
+ return true;
+}
+
+/*
+ * "tabpanel_getinfo()" function
+ */
+ void
+f_tabpanel_getinfo(typval_T *argvars UNUSED, typval_T *rettv)
+{
+ dict_T *d;
+ int max_offset;
+
+ if (rettv_dict_alloc(rettv) == FAIL)
+ return;
+ d = rettv->vval.v_dict;
+
+ max_offset = tpl_total_rows - Rows;
+ if (max_offset < 0)
+ max_offset = 0;
+
+ dict_add_string(d, "align",
+ (char_u *)(tpl_align == ALIGN_RIGHT ? "right" : "left"));
+ dict_add_number(d, "columns", tabpanel_width());
+ dict_add_bool(d, "scrollbar", tpl_scrollbar);
+ dict_add_number(d, "offset", tpl_scroll_offset);
+ dict_add_number(d, "total", tpl_total_rows);
+ dict_add_number(d, "max_offset", max_offset);
+}
+
+/*
+ * "tabpanel_scroll()" function
+ */
+ void
+f_tabpanel_scroll(typval_T *argvars, typval_T *rettv)
+{
+ varnumber_T n;
+ int absolute = 0;
+ bool changed;
+
+ rettv->v_type = VAR_BOOL;
+ rettv->vval.v_number = VVAL_FALSE;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_opt_dict_arg(argvars, 1) == FAIL))
+ return;
+
+ n = tv_get_number_chk(&argvars[0], NULL);
+ if (argvars[1].v_type != VAR_UNKNOWN)
+ {
+ if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
+ {
+ emsg(_(e_dictionary_required));
+ return;
+ }
+ absolute = dict_get_bool(argvars[1].vval.v_dict, "absolute", FALSE);
+ }
+
+ // Clamp to int range to avoid signed overflow when casting and negating.
+ if (n > INT_MAX)
+ n = INT_MAX;
+ else if (n < -INT_MAX)
+ n = -INT_MAX;
+
+ if (absolute)
+ changed = tabpanel_set_offset((int)n);
+ else
+ changed = tabpanel_scroll(n >= 0 ? 1 : -1,
+ (int)(n >= 0 ? n : -n));
+
+ rettv->vval.v_number = changed ? VVAL_TRUE : VVAL_FALSE;
+}
+
#endif // FEAT_TABPANEL
set tabpanel&
endfunc
+func Test_tabpanel_getinfo_and_scroll()
+ CheckScreendump
+
+ let lines =<< trim END
+ set showtabpanel=2 tabpanelopt=columns:20
+ set showtabline=0
+ for i in range(40)
+ tabnew
+ endfor
+ tabfirst
+ redraw
+ func WriteResult(label)
+ call writefile([a:label, string(tabpanel_getinfo())], 'Xresult', 'a')
+ endfunc
+ call delete('Xresult')
+ call WriteResult('initial')
+ let g:r1 = tabpanel_scroll(1)
+ redraw
+ call WriteResult('after_scroll_1')
+ call tabpanel_scroll(-10)
+ redraw
+ call WriteResult('after_scroll_minus10')
+ let g:max = tabpanel_getinfo().max_offset
+ call tabpanel_scroll(g:max, #{absolute: 1})
+ redraw
+ call WriteResult('after_abs_max')
+ call tabpanel_scroll(99999, #{absolute: 1})
+ redraw
+ call WriteResult('after_abs_overflow')
+ call tabpanel_scroll(-5, #{absolute: 1})
+ redraw
+ call WriteResult('after_abs_negative')
+ let g:r_zero = tabpanel_scroll(0, #{absolute: 1})
+ let g:r_neg_at_zero = tabpanel_scroll(-1)
+ call writefile([
+ \ 'r1=' .. g:r1,
+ \ 'max=' .. g:max,
+ \ 'r_zero=' .. g:r_zero,
+ \ 'r_neg_at_zero=' .. g:r_neg_at_zero,
+ \ ], 'Xflags')
+ END
+ call writefile(lines, 'XTest_tabpanel_getinfo', 'D')
+
+ let buf = RunVimInTerminal('-S XTest_tabpanel_getinfo', {'rows': 10, 'cols': 45})
+ call WaitForAssert({-> assert_true(filereadable('Xflags'))})
+ call StopVimInTerminal(buf)
+
+ let results = readfile('Xresult')
+ let flags = readfile('Xflags')
+ call delete('Xresult')
+ call delete('Xflags')
+
+ " Parse [label, dict] pairs.
+ let info = {}
+ for i in range(0, len(results) - 1, 2)
+ let info[results[i]] = eval(results[i + 1])
+ endfor
+
+ call assert_equal('left', info.initial.align)
+ call assert_equal(20, info.initial.columns)
+ call assert_false(has_key(info.initial, 'scroll'))
+ call assert_equal(0, info.initial.offset)
+ call assert_true(info.initial.total > 0)
+ call assert_true(info.initial.max_offset > 0)
+
+ call assert_equal(1, info.after_scroll_1.offset)
+ call assert_equal(0, info.after_scroll_minus10.offset)
+
+ let max = info.initial.max_offset
+ call assert_equal(max, info.after_abs_max.offset)
+ call assert_equal(max, info.after_abs_overflow.offset)
+ call assert_equal(0, info.after_abs_negative.offset)
+
+ call assert_equal(['r1=v:true', 'max=' .. max,
+ \ 'r_zero=v:false', 'r_neg_at_zero=v:false'], flags)
+endfunc
+
" vim: shiftwidth=2 sts=2 expandtab
static int included_patches[] =
{ /* Add new patch number below this line */
+/**/
+ 411,
/**/
410,
/**/
projects / thirdparty / vim.git / commitdiff
