Mercurial > vim
changeset 17756:a7afcea6f40a v8.1.1875
patch 8.1.1875: cannot get size and position of the popup menu
commit https://github.com/vim/vim/commit/e9bd57286a5cbb0e1ec18b5d194dc4af1bda9f3a
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Aug 17 19:36:06 2019 +0200
patch 8.1.1875: cannot get size and position of the popup menu
Problem: Cannot get size and position of the popup menu.
Solution: Add pum_getpos(). (Ben Jackson, closes https://github.com/vim/vim/issues/4827)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sat, 17 Aug 2019 19:45:03 +0200 |
| parents | 104c45824419 |
| children | 39fe82460b5d |
| files | runtime/doc/autocmd.txt runtime/doc/eval.txt src/evalfunc.c src/testdir/test_popup.vim src/version.c |
| diffstat | 5 files changed, 83 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -595,6 +595,10 @@ CompleteChanged *CompleteChanged* scrollbar TRUE if visible It is not allowed to change the text |textlock|. + + The size and position of the popup are also + available by calling |pum_getpos()|. + *CompleteDone* CompleteDone After Insert mode completion is done. Either when something was completed or abandoning
--- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -2613,6 +2613,7 @@ prop_type_delete({name} [, {props}]) prop_type_get([{name} [, {props}]) Dict get property type values prop_type_list([{props}]) List get list of property types +pum_getpos() Dict position and size of pum if visible pumvisible() Number whether popup menu is visible pyeval({expr}) any evaluate |Python| expression py3eval({expr}) any evaluate |python3| expression @@ -3477,6 +3478,10 @@ complete_info([{what}]) the items listed in {what} are returned. Unsupported items in {what} are silently ignored. + To get the position and size of the popup menu, see + |pum_getpos()|. It's also available in |v:event| during the + |CompleteChanged| event. + Examples: > " Get all items call complete_info() @@ -6977,6 +6982,20 @@ prompt_setprompt({buf}, {text}) *prom < prop_ functions are documented here: |text-prop-functions|. +pum_getpos() *pum_getpos()* + If the popup menu (see |ins-completion-menu|) is not visible, + returns an empty |Dictionary|, otherwise, returns a + |Dictionary| with the following keys: + height nr of items visible + width screen cells + row top screen row (0 first row) + col leftmost screen column (0 first col) + size total nr of items + scrollbar |TRUE| if visible + + The values are the same as in |v:event| during + |CompleteChanged|. + pumvisible() *pumvisible()* Returns non-zero when the popup menu is visible, zero otherwise. See |ins-completion-menu|.
--- a/src/evalfunc.c +++ b/src/evalfunc.c @@ -234,6 +234,7 @@ static void f_pow(typval_T *argvars, typ #endif static void f_prevnonblank(typval_T *argvars, typval_T *rettv); static void f_printf(typval_T *argvars, typval_T *rettv); +static void f_pum_getpos(typval_T *argvars, typval_T *rettv); static void f_pumvisible(typval_T *argvars, typval_T *rettv); #ifdef FEAT_PYTHON3 static void f_py3eval(typval_T *argvars, typval_T *rettv); @@ -741,6 +742,7 @@ static funcentry_T global_functions[] = {"prop_type_get", 1, 2, 0, f_prop_type_get}, {"prop_type_list", 0, 1, 0, f_prop_type_list}, #endif + {"pum_getpos", 0, 0, 0, f_pum_getpos}, {"pumvisible", 0, 0, 0, f_pumvisible}, #ifdef FEAT_PYTHON3 {"py3eval", 1, 1, 0, f_py3eval}, @@ -7961,6 +7963,19 @@ f_printf(typval_T *argvars, typval_T *re } /* + * "pum_getpos()" function + */ + static void +f_pum_getpos(typval_T *argvars UNUSED, typval_T *rettv UNUSED) +{ + if (rettv_dict_alloc(rettv) != OK) + return; +#ifdef FEAT_INS_EXPAND + pum_set_event_info(rettv->vval.v_dict); +#endif +} + +/* * "pumvisible()" function */ static void
--- a/src/testdir/test_popup.vim +++ b/src/testdir/test_popup.vim @@ -1033,6 +1033,20 @@ func Test_popup_complete_info_02() bwipe! endfunc +func Test_popup_complete_info_no_pum() + new + call assert_false( pumvisible() ) + let no_pum_info = complete_info() + let d = { + \ 'mode': '', + \ 'pum_visible': 0, + \ 'items': [], + \ 'selected': -1, + \ } + call assert_equal( d, complete_info() ) + bwipe! +endfunc + func Test_CompleteChanged() new call setline(1, ['foo', 'bar', 'foobar', '']) @@ -1063,8 +1077,36 @@ func Test_CompleteChanged() autocmd! AAAAA_Group set complete& completeopt& - delfunc! OnPumchange + delfunc! OnPumChange bw! endfunc +function! GetPumPosition() + call assert_true( pumvisible() ) + let g:pum_pos = pum_getpos() + return '' +endfunction + +func Test_pum_getpos() + new + inoremap <buffer><F5> <C-R>=GetPumPosition()<CR> + setlocal completefunc=UserDefinedComplete + + let d = { + \ 'height': 5, + \ 'width': 15, + \ 'row': 1, + \ 'col': 0, + \ 'size': 5, + \ 'scrollbar': v:false, + \ } + call feedkeys("i\<C-X>\<C-U>\<F5>", 'tx') + call assert_equal(d, g:pum_pos) + + call assert_false( pumvisible() ) + call assert_equal( {}, pum_getpos() ) + bw! + unlet g:pum_pos +endfunc + " vim: shiftwidth=2 sts=2 expandtab