patch 8.1.1561: popup_setoptions() is not implemented yet
Problem: Popup_setoptions() is not implemented yet.
Solution: Implement popup_setoptions(). Also add more fields to
popup_getoptions().
diff --git a/src/dict.c b/src/dict.c
index c67eb42..ffcb100 100644
--- a/src/dict.c
+++ b/src/dict.c
@@ -448,6 +448,27 @@
}
/*
+ * Add a callback to dictionary "d".
+ * Returns FAIL when out of memory and when key already exists.
+ */
+ int
+dict_add_callback(dict_T *d, char *key, callback_T *cb)
+{
+ dictitem_T *item;
+
+ item = dictitem_alloc((char_u *)key);
+ if (item == NULL)
+ return FAIL;
+ put_callback(cb, &item->di_tv);
+ if (dict_add(d, item) == FAIL)
+ {
+ dictitem_free(item);
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
* Initializes "iter" for iterating over dictionary items with
* dict_iterate_next().
* If "var" is not a Dict or an empty Dict then there will be nothing to
diff --git a/src/evalfunc.c b/src/evalfunc.c
index b98c7e7..66612e8 100644
--- a/src/evalfunc.c
+++ b/src/evalfunc.c
@@ -824,6 +824,7 @@
{"popup_menu", 2, 2, f_popup_menu},
{"popup_move", 2, 2, f_popup_move},
{"popup_notification", 2, 2, f_popup_notification},
+ {"popup_setoptions", 2, 2, f_popup_setoptions},
{"popup_settext", 2, 2, f_popup_settext},
{"popup_show", 1, 1, f_popup_show},
#endif
diff --git a/src/popupwin.c b/src/popupwin.c
index c042fe8..d777ae5 100644
--- a/src/popupwin.c
+++ b/src/popupwin.c
@@ -106,7 +106,7 @@
}
static void
-get_padding_border(dict_T *dict, int *array, char *name, int max_val)
+set_padding_border(dict_T *dict, int *array, char *name, int max_val)
{
dictitem_T *di;
@@ -251,48 +251,41 @@
#endif
/*
- * Go through the options in "dict" and apply them to buffer "buf" displayed in
- * popup window "wp".
+ * Shared between popup_create() and f_popup_move().
*/
static void
-apply_options(win_T *wp, buf_T *buf UNUSED, dict_T *dict)
+apply_move_options(win_T *wp, dict_T *d)
{
+ int nr;
+
+ if ((nr = dict_get_number(d, (char_u *)"minwidth")) > 0)
+ wp->w_minwidth = nr;
+ if ((nr = dict_get_number(d, (char_u *)"minheight")) > 0)
+ wp->w_minheight = nr;
+ if ((nr = dict_get_number(d, (char_u *)"maxwidth")) > 0)
+ wp->w_maxwidth = nr;
+ if ((nr = dict_get_number(d, (char_u *)"maxheight")) > 0)
+ wp->w_maxheight = nr;
+ get_pos_options(wp, d);
+}
+
+/*
+ * Shared between popup_create() and f_popup_setoptions().
+ */
+ static void
+apply_general_options(win_T *wp, dict_T *dict)
+{
+ dictitem_T *di;
int nr;
char_u *str;
- dictitem_T *di;
- int i;
- di = dict_find(dict, (char_u *)"minwidth", -1);
+ // TODO: flip
+
+ di = dict_find(dict, (char_u *)"firstline", -1);
if (di != NULL)
- wp->w_minwidth = dict_get_number(dict, (char_u *)"minwidth");
- wp->w_minheight = dict_get_number(dict, (char_u *)"minheight");
- wp->w_maxwidth = dict_get_number(dict, (char_u *)"maxwidth");
- wp->w_maxheight = dict_get_number(dict, (char_u *)"maxheight");
-
- get_pos_options(wp, dict);
-
- di = dict_find(dict, (char_u *)"zindex", -1);
- if (di != NULL)
- {
- wp->w_zindex = dict_get_number(dict, (char_u *)"zindex");
- if (wp->w_zindex < 1)
- wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
- if (wp->w_zindex > 32000)
- wp->w_zindex = 32000;
- }
-
-#if defined(FEAT_TIMERS)
- // Add timer to close the popup after some time.
- nr = dict_get_number(dict, (char_u *)"time");
- if (nr > 0)
- popup_add_timeout(wp, nr);
-#endif
-
- // Option values resulting in setting an option.
- str = dict_get_string(dict, (char_u *)"highlight", FALSE);
- if (str != NULL)
- set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
- str, OPT_FREE|OPT_LOCAL, 0);
+ wp->w_firstline = dict_get_number(dict, (char_u *)"firstline");
+ if (wp->w_firstline < 1)
+ wp->w_firstline = 1;
str = dict_get_string(dict, (char_u *)"title", FALSE);
if (str != NULL)
@@ -301,10 +294,6 @@
wp->w_popup_title = vim_strsave(str);
}
- wp->w_firstline = dict_get_number(dict, (char_u *)"firstline");
- if (wp->w_firstline < 1)
- wp->w_firstline = 1;
-
di = dict_find(dict, (char_u *)"wrap", -1);
if (di != NULL)
{
@@ -316,29 +305,14 @@
if (di != NULL)
wp->w_popup_drag = dict_get_number(dict, (char_u *)"drag");
- di = dict_find(dict, (char_u *)"callback", -1);
- if (di != NULL)
- {
- callback_T callback = get_callback(&di->di_tv);
+ str = dict_get_string(dict, (char_u *)"highlight", FALSE);
+ if (str != NULL)
+ set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
+ str, OPT_FREE|OPT_LOCAL, 0);
- if (callback.cb_name != NULL)
- set_callback(&wp->w_close_cb, &callback);
- }
+ set_padding_border(dict, wp->w_popup_padding, "padding", 999);
+ set_padding_border(dict, wp->w_popup_border, "border", 1);
- di = dict_find(dict, (char_u *)"filter", -1);
- if (di != NULL)
- {
- callback_T callback = get_callback(&di->di_tv);
-
- if (callback.cb_name != NULL)
- set_callback(&wp->w_filter_cb, &callback);
- }
-
- get_padding_border(dict, wp->w_popup_padding, "padding", 999);
- get_padding_border(dict, wp->w_popup_border, "border", 1);
-
- for (i = 0; i < 4; ++i)
- VIM_CLEAR(wp->w_border_highlight[i]);
di = dict_find(dict, (char_u *)"borderhighlight", -1);
if (di != NULL)
{
@@ -348,6 +322,7 @@
{
list_T *list = di->di_tv.vval.v_list;
listitem_T *li;
+ int i;
if (list != NULL)
for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
@@ -364,8 +339,6 @@
}
}
- for (i = 0; i < 8; ++i)
- wp->w_border_char[i] = 0;
di = dict_find(dict, (char_u *)"borderchars", -1);
if (di != NULL)
{
@@ -375,6 +348,7 @@
{
list_T *list = di->di_tv.vval.v_list;
listitem_T *li;
+ int i;
if (list != NULL)
for (i = 0, li = list->lv_first; i < 8 && i < list->lv_len;
@@ -397,6 +371,23 @@
}
}
+ di = dict_find(dict, (char_u *)"zindex", -1);
+ if (di != NULL)
+ {
+ wp->w_zindex = dict_get_number(dict, (char_u *)"zindex");
+ if (wp->w_zindex < 1)
+ wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
+ if (wp->w_zindex > 32000)
+ wp->w_zindex = 32000;
+ }
+
+#if defined(FEAT_TIMERS)
+ // Add timer to close the popup after some time.
+ nr = dict_get_number(dict, (char_u *)"time");
+ if (nr > 0)
+ popup_add_timeout(wp, nr);
+#endif
+
di = dict_find(dict, (char_u *)"moved", -1);
if (di != NULL)
{
@@ -428,6 +419,42 @@
semsg(_(e_invarg2), tv_get_string(&di->di_tv));
}
+ di = dict_find(dict, (char_u *)"filter", -1);
+ if (di != NULL)
+ {
+ callback_T callback = get_callback(&di->di_tv);
+
+ if (callback.cb_name != NULL)
+ {
+ free_callback(&wp->w_filter_cb);
+ set_callback(&wp->w_filter_cb, &callback);
+ }
+ }
+
+ di = dict_find(dict, (char_u *)"callback", -1);
+ if (di != NULL)
+ {
+ callback_T callback = get_callback(&di->di_tv);
+
+ if (callback.cb_name != NULL)
+ {
+ free_callback(&wp->w_close_cb);
+ set_callback(&wp->w_close_cb, &callback);
+ }
+ }
+}
+
+/*
+ * Go through the options in "dict" and apply them to popup window "wp".
+ */
+ static void
+apply_options(win_T *wp, dict_T *dict)
+{
+ int nr;
+
+ apply_move_options(wp, dict);
+ apply_general_options(wp, dict);
+
nr = dict_get_number(dict, (char_u *)"hidden");
if (nr > 0)
{
@@ -804,6 +831,7 @@
buf_T *buf;
dict_T *d;
int nr;
+ int i;
// Check arguments look OK.
if (!(argvars[0].v_type == VAR_STRING && argvars[0].vval.v_string != NULL)
@@ -903,7 +931,6 @@
{
win_T *twp, *nextwin;
int height = buf->b_ml.ml_line_count + 3;
- int i;
// Try to not overlap with another global popup. Guess we need 3
// more screen lines than buffer lines.
@@ -946,8 +973,6 @@
if (type == TYPE_DIALOG || type == TYPE_MENU)
{
- int i;
-
wp->w_popup_pos = POPPOS_CENTER;
wp->w_zindex = POPUPWIN_DIALOG_ZINDEX;
wp->w_popup_drag = 1;
@@ -972,8 +997,13 @@
wp->w_p_wrap = 0;
}
+ for (i = 0; i < 4; ++i)
+ VIM_CLEAR(wp->w_border_highlight[i]);
+ for (i = 0; i < 8; ++i)
+ wp->w_border_char[i] = 0;
+
// Deal with options.
- apply_options(wp, buf, argvars[1].vval.v_dict);
+ apply_options(wp, argvars[1].vval.v_dict);
if (type == TYPE_NOTIFICATION && wp->w_popup_timer == NULL)
popup_add_timeout(wp, 3000);
@@ -1375,8 +1405,7 @@
void
f_popup_move(typval_T *argvars, typval_T *rettv UNUSED)
{
- dict_T *d;
- int nr;
+ dict_T *dict;
int id = (int)tv_get_number(argvars);
win_T *wp = find_popup_win(id);
@@ -1388,17 +1417,9 @@
emsg(_(e_dictreq));
return;
}
- d = argvars[1].vval.v_dict;
+ dict = argvars[1].vval.v_dict;
- if ((nr = dict_get_number(d, (char_u *)"minwidth")) > 0)
- wp->w_minwidth = nr;
- if ((nr = dict_get_number(d, (char_u *)"minheight")) > 0)
- wp->w_minheight = nr;
- if ((nr = dict_get_number(d, (char_u *)"maxwidth")) > 0)
- wp->w_maxwidth = nr;
- if ((nr = dict_get_number(d, (char_u *)"maxheight")) > 0)
- wp->w_maxheight = nr;
- get_pos_options(wp, d);
+ apply_move_options(wp, dict);
if (wp->w_winrow + wp->w_height >= cmdline_row)
clear_cmdline = TRUE;
@@ -1406,6 +1427,32 @@
}
/*
+ * popup_setoptions({id}, {options})
+ */
+ void
+f_popup_setoptions(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ dict_T *dict;
+ int id = (int)tv_get_number(argvars);
+ win_T *wp = find_popup_win(id);
+
+ if (wp == NULL)
+ return; // invalid {id}
+
+ if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
+ {
+ emsg(_(e_dictreq));
+ return;
+ }
+ dict = argvars[1].vval.v_dict;
+
+ apply_move_options(wp, dict);
+ apply_general_options(wp, dict);
+
+ popup_adjust_position(wp);
+}
+
+/*
* popup_getpos({id})
*/
void
@@ -1444,6 +1491,98 @@
}
/*
+ * For popup_getoptions(): add a "border" or "padding" entry to "dict".
+ */
+ static void
+get_padding_border(dict_T *dict, int *array, char *name)
+{
+ list_T *list;
+ int i;
+
+ if (array[0] == 0 && array[1] == 0 && array[2] == 0 && array[3] == 0)
+ return;
+
+ list = list_alloc();
+ if (list != NULL)
+ {
+ dict_add_list(dict, name, list);
+ if (array[0] != 1 || array[1] != 1 || array[2] != 1 || array[3] != 1)
+ for (i = 0; i < 4; ++i)
+ list_append_number(list, array[i]);
+ }
+}
+
+/*
+ * For popup_getoptions(): add a "borderhighlight" entry to "dict".
+ */
+ static void
+get_borderhighlight(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+ int i;
+
+ for (i = 0; i < 4; ++i)
+ if (wp->w_border_highlight[i] != NULL)
+ break;
+ if (i == 4)
+ return;
+
+ list = list_alloc();
+ if (list != NULL)
+ {
+ dict_add_list(dict, "borderhighlight", list);
+ for (i = 0; i < 4; ++i)
+ list_append_string(list, wp->w_border_highlight[i], -1);
+ }
+}
+
+/*
+ * For popup_getoptions(): add a "borderchars" entry to "dict".
+ */
+ static void
+get_borderchars(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+ int i;
+ char_u buf[NUMBUFLEN];
+ int len;
+
+ for (i = 0; i < 8; ++i)
+ if (wp->w_border_char[i] != 0)
+ break;
+ if (i == 8)
+ return;
+
+ list = list_alloc();
+ if (list != NULL)
+ {
+ dict_add_list(dict, "borderchars", list);
+ for (i = 0; i < 8; ++i)
+ {
+ len = mb_char2bytes(wp->w_border_char[i], buf);
+ list_append_string(list, buf, len);
+ }
+ }
+}
+
+/*
+ * For popup_getoptions(): add a "moved" entry to "dict".
+ */
+ static void
+get_moved_list(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+
+ list = list_alloc();
+ if (list != NULL)
+ {
+ dict_add_list(dict, "moved", list);
+ list_append_number(list, wp->w_popup_mincol);
+ list_append_number(list, wp->w_popup_maxcol);
+ }
+}
+
+/*
* popup_getoptions({id})
*/
void
@@ -1469,6 +1608,21 @@
dict_add_number(dict, "firstline", wp->w_firstline);
dict_add_number(dict, "zindex", wp->w_zindex);
dict_add_number(dict, "fixed", wp->w_popup_fixed);
+ dict_add_string(dict, "title", wp->w_popup_title);
+ dict_add_number(dict, "wrap", wp->w_p_wrap);
+ dict_add_number(dict, "drag", wp->w_popup_drag);
+ dict_add_string(dict, "highlight", wp->w_p_wcr);
+
+ get_padding_border(dict, wp->w_popup_padding, "padding");
+ get_padding_border(dict, wp->w_popup_border, "border");
+ get_borderhighlight(dict, wp);
+ get_borderchars(dict, wp);
+ get_moved_list(dict, wp);
+
+ if (wp->w_filter_cb.cb_name != NULL)
+ dict_add_callback(dict, "filter", &wp->w_filter_cb);
+ if (wp->w_close_cb.cb_name != NULL)
+ dict_add_callback(dict, "callback", &wp->w_close_cb);
for (i = 0; i < (int)(sizeof(poppos_entries) / sizeof(poppos_entry_T));
++i)
diff --git a/src/proto/dict.pro b/src/proto/dict.pro
index d482025..3d31347 100644
--- a/src/proto/dict.pro
+++ b/src/proto/dict.pro
@@ -18,6 +18,7 @@
int dict_add_string(dict_T *d, char *key, char_u *str);
int dict_add_string_len(dict_T *d, char *key, char_u *str, int len);
int dict_add_list(dict_T *d, char *key, list_T *list);
+int dict_add_callback(dict_T *d, char *key, callback_T *cb);
void dict_iterate_start(typval_T *var, dict_iterator_T *iter);
char_u *dict_iterate_next(dict_iterator_T *iter, typval_T **tv_result);
int dict_add_dict(dict_T *d, char *key, dict_T *dict);
diff --git a/src/proto/popupwin.pro b/src/proto/popupwin.pro
index fefb031..6c5ea46 100644
--- a/src/proto/popupwin.pro
+++ b/src/proto/popupwin.pro
@@ -21,6 +21,7 @@
void popup_close_tabpage(tabpage_T *tp, int id);
void close_all_popups(void);
void f_popup_move(typval_T *argvars, typval_T *rettv);
+void f_popup_setoptions(typval_T *argvars, typval_T *rettv);
void f_popup_getpos(typval_T *argvars, typval_T *rettv);
void f_popup_getoptions(typval_T *argvars, typval_T *rettv);
int error_if_popup_window(void);
diff --git a/src/testdir/runtest.vim b/src/testdir/runtest.vim
index 45d3b1d..e120e7f 100644
--- a/src/testdir/runtest.vim
+++ b/src/testdir/runtest.vim
@@ -170,6 +170,11 @@
au!
au SwapExists * call HandleSwapExists()
+ " Close any stray popup windows
+ if has('textprop')
+ call popup_clear()
+ endif
+
" Close any extra tab pages and windows and make the current one not modified.
while tabpagenr('$') > 1
quit!
diff --git a/src/testdir/test_popupwin.vim b/src/testdir/test_popupwin.vim
index 7496608..f16a46f 100644
--- a/src/testdir/test_popupwin.vim
+++ b/src/testdir/test_popupwin.vim
@@ -129,9 +129,29 @@
\ 'visible': 1}
let winid = popup_create('hello border', {'line': 2, 'col': 3, 'border': []})",
call assert_equal(with_border_or_padding, popup_getpos(winid))
+ let options = popup_getoptions(winid)
+ call assert_equal([], options.border)
+ call assert_false(has_key(options, "padding"))
- let winid = popup_create('hello paddng', {'line': 2, 'col': 3, 'padding': []})
+ let winid = popup_create('hello padding', {'line': 2, 'col': 3, 'padding': []})
+ let with_border_or_padding.width = 15
+ let with_border_or_padding.core_width = 13
call assert_equal(with_border_or_padding, popup_getpos(winid))
+ let options = popup_getoptions(winid)
+ call assert_false(has_key(options, "border"))
+ call assert_equal([], options.padding)
+
+ call popup_setoptions(winid, {
+ \ 'padding': [1, 2, 3, 4],
+ \ 'border': [4, 0, 7, 8],
+ \ 'borderhighlight': ['Top', 'Right', 'Bottom', 'Left'],
+ \ 'borderchars': ['1', '^', '2', '>', '3', 'v', '4', '<'],
+ \ })
+ let options = popup_getoptions(winid)
+ call assert_equal([1, 0, 1, 1], options.border)
+ call assert_equal([1, 2, 3, 4], options.padding)
+ call assert_equal(['Top', 'Right', 'Bottom', 'Left'], options.borderhighlight)
+ call assert_equal(['1', '^', '2', '>', '3', 'v', '4', '<'], options.borderchars)
let winid = popup_create('hello both', {'line': 3, 'col': 8, 'border': [], 'padding': []})
call assert_equal({
@@ -144,6 +164,8 @@
\ 'height': 5,
\ 'core_height': 1,
\ 'visible': 1}, popup_getpos(winid))
+
+ call popup_clear()
endfunc
func Test_popup_with_syntax_win_execute()
@@ -288,6 +310,16 @@
" clean up
call StopVimInTerminal(buf)
call delete('XtestPopupFirstline')
+
+ let winid = popup_create(['1111', '222222', '33333', '44444'], {
+ \ 'maxheight': 2,
+ \ 'firstline': 3,
+ \ })
+ call assert_equal(3, popup_getoptions(winid).firstline)
+ call popup_setoptions(winid, {'firstline': 1})
+ call assert_equal(1, popup_getoptions(winid).firstline)
+
+ call popup_close(winid)
endfunc
func Test_popup_drag()
@@ -978,6 +1010,13 @@
" clean up
call StopVimInTerminal(buf)
call delete('XtestPopupTitle')
+
+ let winid = popup_create('something', {'title': 'Some Title'})
+ call assert_equal('Some Title', popup_getoptions(winid).title)
+ call popup_setoptions(winid, {'title': 'Another Title'})
+ call assert_equal('Another Title', popup_getoptions(winid).title)
+
+ call popup_clear()
endfunc
func Test_popup_close_callback()
@@ -1230,6 +1269,7 @@
let winid = popup_atcursor('text', {'moved': 'any'})
redraw
call assert_equal(1, popup_getpos(winid).visible)
+ call assert_equal([4, 4], popup_getoptions(winid).moved)
" trigger the check for last_cursormoved by going into insert mode
call feedkeys("li\<Esc>", 'xt')
call assert_equal({}, popup_getpos(winid))
@@ -1239,6 +1279,7 @@
let winid = popup_atcursor('text', {'moved': 'word'})
redraw
call assert_equal(1, popup_getpos(winid).visible)
+ call assert_equal([4, 7], popup_getoptions(winid).moved)
call feedkeys("hi\<Esc>", 'xt')
call assert_equal({}, popup_getpos(winid))
call popup_clear()
@@ -1247,6 +1288,7 @@
let winid = popup_atcursor('text', {'moved': 'word'})
redraw
call assert_equal(1, popup_getpos(winid).visible)
+ call assert_equal([4, 7], popup_getoptions(winid).moved)
call feedkeys("li\<Esc>", 'xt')
call assert_equal(1, popup_getpos(winid).visible)
call feedkeys("ei\<Esc>", 'xt')
@@ -1260,6 +1302,7 @@
let winid = popup_atcursor('text', {})
redraw
call assert_equal(1, popup_getpos(winid).visible)
+ call assert_equal([2, 15], popup_getoptions(winid).moved)
call feedkeys("eli\<Esc>", 'xt')
call assert_equal(1, popup_getpos(winid).visible)
call feedkeys("wi\<Esc>", 'xt')
@@ -1377,6 +1420,8 @@
\ })
redraw
call assert_equal(0, popup_getpos(winid).visible)
+ call assert_equal(function('popup_filter_yesno'), popup_getoptions(winid).filter)
+ call assert_equal(function('QuitCallback'), popup_getoptions(winid).callback)
exe "normal anot used by filter\<Esc>"
call assert_equal('not used by filter', getline(1))
@@ -1387,3 +1432,20 @@
bwipe!
delfunc QuitCallback
endfunc
+
+" Test options not checked elsewhere
+func Test_set_get_options()
+ let winid = popup_create('some text', {'highlight': 'Beautiful'})
+ let options = popup_getoptions(winid)
+ call assert_equal(1, options.wrap)
+ call assert_equal(0, options.drag)
+ call assert_equal('Beautiful', options.highlight)
+
+ call popup_setoptions(winid, {'wrap': 0, 'drag': 1, 'highlight': 'Another'})
+ let options = popup_getoptions(winid)
+ call assert_equal(0, options.wrap)
+ call assert_equal(1, options.drag)
+ call assert_equal('Another', options.highlight)
+
+ call popup_close(winid)
+endfunc
diff --git a/src/version.c b/src/version.c
index ea203f6..feac085 100644
--- a/src/version.c
+++ b/src/version.c
@@ -778,6 +778,8 @@
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
+ 1561,
+/**/
1560,
/**/
1559,