blob: a244c32368f6996eceac6ae12ea1d8de7dfaedc5 [file] [log] [blame]
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read a list of people who contributed.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * Implementation of popup windows. See ":help popup".
12 */
13
14#include "vim.h"
15
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +010016#if defined(FEAT_PROP_POPUP) || defined(PROTO)
Bram Moolenaar4d784b22019-05-25 19:51:39 +020017
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +020018typedef struct {
19 char *pp_name;
20 poppos_T pp_val;
21} poppos_entry_T;
22
23static poppos_entry_T poppos_entries[] = {
24 {"botleft", POPPOS_BOTLEFT},
25 {"topleft", POPPOS_TOPLEFT},
26 {"botright", POPPOS_BOTRIGHT},
27 {"topright", POPPOS_TOPRIGHT},
28 {"center", POPPOS_CENTER}
29};
30
Bram Moolenaar5843f5f2019-08-20 20:13:45 +020031static void popup_adjust_position(win_T *wp);
32
Bram Moolenaar4d784b22019-05-25 19:51:39 +020033/*
Bram Moolenaarb0ebbda2019-06-02 16:51:21 +020034 * Get option value for "key", which is "line" or "col".
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020035 * Handles "cursor+N" and "cursor-N".
Bram Moolenaar1fb08312019-08-29 20:02:11 +020036 * Returns MAXCOL if the entry is not present.
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020037 */
38 static int
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +020039popup_options_one(dict_T *dict, char_u *key)
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020040{
41 dictitem_T *di;
42 char_u *val;
43 char_u *s;
44 char_u *endp;
45 int n = 0;
46
47 di = dict_find(dict, key, -1);
48 if (di == NULL)
Bram Moolenaar1fb08312019-08-29 20:02:11 +020049 return MAXCOL;
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020050
51 val = tv_get_string(&di->di_tv);
52 if (STRNCMP(val, "cursor", 6) != 0)
Bram Moolenaarb0ebbda2019-06-02 16:51:21 +020053 return dict_get_number_check(dict, key);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020054
55 setcursor_mayforce(TRUE);
56 s = val + 6;
57 if (*s != NUL)
58 {
Bram Moolenaarb0ebbda2019-06-02 16:51:21 +020059 endp = s;
60 if (*skipwhite(s) == '+' || *skipwhite(s) == '-')
61 n = strtol((char *)s, (char **)&endp, 10);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020062 if (endp != NULL && *skipwhite(endp) != NUL)
63 {
64 semsg(_(e_invexpr2), val);
65 return 0;
66 }
67 }
68
69 if (STRCMP(key, "line") == 0)
70 n = screen_screenrow() + 1 + n;
71 else // "col"
72 n = screen_screencol() + 1 + n;
73
Bram Moolenaarb754b5b2019-10-24 19:25:00 +020074 // Zero means "not set", use -1 instead.
75 if (n == 0)
76 n = -1;
Bram Moolenaarcc31ad92019-05-30 19:25:06 +020077 return n;
78}
79
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +020080 static void
Bram Moolenaarae943152019-06-16 22:54:14 +020081set_padding_border(dict_T *dict, int *array, char *name, int max_val)
Bram Moolenaar2fd8e352019-06-01 20:16:48 +020082{
83 dictitem_T *di;
84
Bram Moolenaar2fd8e352019-06-01 20:16:48 +020085 di = dict_find(dict, (char_u *)name, -1);
86 if (di != NULL)
87 {
88 if (di->di_tv.v_type != VAR_LIST)
89 emsg(_(e_listreq));
90 else
91 {
92 list_T *list = di->di_tv.vval.v_list;
93 listitem_T *li;
94 int i;
95 int nr;
96
97 for (i = 0; i < 4; ++i)
98 array[i] = 1;
99 if (list != NULL)
Bram Moolenaarb0992022020-01-30 14:55:42 +0100100 {
101 range_list_materialize(list);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +0200102 for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
103 ++i, li = li->li_next)
104 {
105 nr = (int)tv_get_number(&li->li_tv);
106 if (nr >= 0)
107 array[i] = nr > max_val ? max_val : nr;
108 }
Bram Moolenaarb0992022020-01-30 14:55:42 +0100109 }
Bram Moolenaar2fd8e352019-06-01 20:16:48 +0200110 }
111 }
112}
113
Bram Moolenaarcc31ad92019-05-30 19:25:06 +0200114/*
Bram Moolenaar17627312019-06-02 19:53:44 +0200115 * Used when popup options contain "moved": set default moved values.
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200116 */
117 static void
Bram Moolenaar17627312019-06-02 19:53:44 +0200118set_moved_values(win_T *wp)
119{
120 wp->w_popup_curwin = curwin;
121 wp->w_popup_lnum = curwin->w_cursor.lnum;
122 wp->w_popup_mincol = curwin->w_cursor.col;
123 wp->w_popup_maxcol = curwin->w_cursor.col;
124}
125
126/*
127 * Used when popup options contain "moved" with "word" or "WORD".
128 */
129 static void
130set_moved_columns(win_T *wp, int flags)
131{
132 char_u *ptr;
133 int len = find_ident_under_cursor(&ptr, flags | FIND_NOERROR);
134
135 if (len > 0)
136 {
137 wp->w_popup_mincol = (int)(ptr - ml_get_curline());
138 wp->w_popup_maxcol = wp->w_popup_mincol + len - 1;
139 }
140}
141
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200142/*
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200143 * Used when popup options contain "mousemoved": set default moved values.
144 */
145 static void
146set_mousemoved_values(win_T *wp)
147{
148 wp->w_popup_mouse_row = mouse_row;
149 wp->w_popup_mouse_mincol = mouse_col;
150 wp->w_popup_mouse_maxcol = mouse_col;
151}
152
153/*
154 * Used when popup options contain "moved" with "word" or "WORD".
155 */
156 static void
157set_mousemoved_columns(win_T *wp, int flags)
158{
Bram Moolenaarb05caa72019-07-10 21:55:54 +0200159 win_T *textwp;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200160 char_u *text;
161 int col;
Bram Moolenaarb05caa72019-07-10 21:55:54 +0200162 pos_T pos;
163 colnr_T mcol;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200164
165 if (find_word_under_cursor(mouse_row, mouse_col, TRUE, flags,
Bram Moolenaarb05caa72019-07-10 21:55:54 +0200166 &textwp, &pos.lnum, &text, NULL, &col) == OK)
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200167 {
Bram Moolenaarb05caa72019-07-10 21:55:54 +0200168 // convert text column to mouse column
169 pos.col = col;
170 pos.coladd = 0;
171 getvcol(textwp, &pos, &mcol, NULL, NULL);
172 wp->w_popup_mouse_mincol = mcol;
173
Bram Moolenaar10727682019-07-12 13:59:20 +0200174 pos.col = col + (colnr_T)STRLEN(text) - 1;
Bram Moolenaarb05caa72019-07-10 21:55:54 +0200175 getvcol(textwp, &pos, NULL, NULL, &mcol);
176 wp->w_popup_mouse_maxcol = mcol;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200177 vim_free(text);
178 }
179}
180
181/*
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200182 * Return TRUE if "row"/"col" is on the border of the popup.
183 * The values are relative to the top-left corner.
184 */
185 int
186popup_on_border(win_T *wp, int row, int col)
187{
188 return (row == 0 && wp->w_popup_border[0] > 0)
189 || (row == popup_height(wp) - 1 && wp->w_popup_border[2] > 0)
190 || (col == 0 && wp->w_popup_border[3] > 0)
191 || (col == popup_width(wp) - 1 && wp->w_popup_border[1] > 0);
192}
193
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200194/*
Bram Moolenaarf6396232019-08-24 19:36:00 +0200195 * Return TRUE and close the popup if "row"/"col" is on the "X" button of the
196 * popup and w_popup_close is POPCLOSE_BUTTON.
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200197 * The values are relative to the top-left corner.
Bram Moolenaarf6396232019-08-24 19:36:00 +0200198 * Caller should check the left mouse button was clicked.
199 * Return TRUE if the popup was closed.
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200200 */
201 int
Bram Moolenaarf6396232019-08-24 19:36:00 +0200202popup_close_if_on_X(win_T *wp, int row, int col)
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200203{
Bram Moolenaarf6396232019-08-24 19:36:00 +0200204 if (wp->w_popup_close == POPCLOSE_BUTTON
205 && row == 0 && col == popup_width(wp) - 1)
206 {
207 popup_close_for_mouse_click(wp);
208 return TRUE;
209 }
210 return FALSE;
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200211}
212
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200213// Values set when dragging a popup window starts.
214static int drag_start_row;
215static int drag_start_col;
216static int drag_start_wantline;
217static int drag_start_wantcol;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200218static int drag_on_resize_handle;
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200219
220/*
221 * Mouse down on border of popup window: start dragging it.
222 * Uses mouse_col and mouse_row.
223 */
224 void
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200225popup_start_drag(win_T *wp, int row, int col)
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200226{
227 drag_start_row = mouse_row;
228 drag_start_col = mouse_col;
Bram Moolenaarb754b5b2019-10-24 19:25:00 +0200229 if (wp->w_wantline <= 0)
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200230 drag_start_wantline = wp->w_winrow + 1;
231 else
232 drag_start_wantline = wp->w_wantline;
233 if (wp->w_wantcol == 0)
234 drag_start_wantcol = wp->w_wincol + 1;
235 else
236 drag_start_wantcol = wp->w_wantcol;
Bram Moolenaara42d9452019-06-15 21:46:30 +0200237
238 // Stop centering the popup
239 if (wp->w_popup_pos == POPPOS_CENTER)
240 wp->w_popup_pos = POPPOS_TOPLEFT;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200241
242 drag_on_resize_handle = wp->w_popup_border[1] > 0
243 && wp->w_popup_border[2] > 0
244 && row == popup_height(wp) - 1
245 && col == popup_width(wp) - 1;
246
247 if (wp->w_popup_pos != POPPOS_TOPLEFT && drag_on_resize_handle)
248 {
249 if (wp->w_popup_pos == POPPOS_TOPRIGHT
250 || wp->w_popup_pos == POPPOS_BOTRIGHT)
251 wp->w_wantcol = wp->w_wincol + 1;
252 if (wp->w_popup_pos == POPPOS_BOTLEFT)
253 wp->w_wantline = wp->w_winrow + 1;
254 wp->w_popup_pos = POPPOS_TOPLEFT;
255 }
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200256}
257
258/*
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200259 * Mouse moved while dragging a popup window: adjust the window popup position
260 * or resize.
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200261 */
262 void
263popup_drag(win_T *wp)
264{
265 // The popup may be closed before dragging stops.
266 if (!win_valid_popup(wp))
267 return;
268
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200269 if ((wp->w_popup_flags & POPF_RESIZE) && drag_on_resize_handle)
270 {
271 int width_inc = mouse_col - drag_start_col;
272 int height_inc = mouse_row - drag_start_row;
273
274 if (width_inc != 0)
275 {
276 int width = wp->w_width + width_inc;
277
278 if (width < 1)
279 width = 1;
280 wp->w_minwidth = width;
281 wp->w_maxwidth = width;
282 drag_start_col = mouse_col;
283 }
284
285 if (height_inc != 0)
286 {
287 int height = wp->w_height + height_inc;
288
289 if (height < 1)
290 height = 1;
291 wp->w_minheight = height;
292 wp->w_maxheight = height;
293 drag_start_row = mouse_row;
294 }
295
296 popup_adjust_position(wp);
297 return;
298 }
299
300 if (!(wp->w_popup_flags & POPF_DRAG))
301 return;
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200302 wp->w_wantline = drag_start_wantline + (mouse_row - drag_start_row);
303 if (wp->w_wantline < 1)
304 wp->w_wantline = 1;
305 if (wp->w_wantline > Rows)
306 wp->w_wantline = Rows;
307 wp->w_wantcol = drag_start_wantcol + (mouse_col - drag_start_col);
308 if (wp->w_wantcol < 1)
309 wp->w_wantcol = 1;
310 if (wp->w_wantcol > Columns)
311 wp->w_wantcol = Columns;
312
313 popup_adjust_position(wp);
314}
Bram Moolenaar68d48f42019-06-12 22:42:41 +0200315
Bram Moolenaarf9c85f52019-06-29 07:41:35 +0200316/*
317 * Set w_firstline to match the current "wp->w_topline".
318 */
319 void
320popup_set_firstline(win_T *wp)
321{
322 int height = wp->w_height;
323
324 wp->w_firstline = wp->w_topline;
325 popup_adjust_position(wp);
326
327 // we don't want the popup to get smaller, decrement the first line
328 // until it doesn't
329 while (wp->w_firstline > 1 && wp->w_height < height)
330 {
331 --wp->w_firstline;
332 popup_adjust_position(wp);
333 }
334}
335
336/*
Bram Moolenaar13b11ed2019-08-01 15:52:45 +0200337 * Return TRUE if the position is in the popup window scrollbar.
338 */
339 int
340popup_is_in_scrollbar(win_T *wp, int row, int col)
341{
342 return wp->w_has_scrollbar
343 && row >= wp->w_popup_border[0]
344 && row < popup_height(wp) - wp->w_popup_border[2]
345 && col == popup_width(wp) - wp->w_popup_border[1] - 1;
346}
347
348
349/*
Bram Moolenaarf9c85f52019-06-29 07:41:35 +0200350 * Handle a click in a popup window, if it is in the scrollbar.
351 */
352 void
353popup_handle_scrollbar_click(win_T *wp, int row, int col)
354{
355 int height = popup_height(wp);
356 int old_topline = wp->w_topline;
357
Bram Moolenaar13b11ed2019-08-01 15:52:45 +0200358 if (popup_is_in_scrollbar(wp, row, col))
Bram Moolenaarf9c85f52019-06-29 07:41:35 +0200359 {
360 if (row >= height / 2)
361 {
362 // Click in lower half, scroll down.
363 if (wp->w_topline < wp->w_buffer->b_ml.ml_line_count)
364 ++wp->w_topline;
365 }
366 else if (wp->w_topline > 1)
367 // click on upper half, scroll up.
368 --wp->w_topline;
369 if (wp->w_topline != old_topline)
370 {
371 popup_set_firstline(wp);
372 redraw_win_later(wp, NOT_VALID);
373 }
374 }
375}
376
Bram Moolenaar68d48f42019-06-12 22:42:41 +0200377#if defined(FEAT_TIMERS)
378 static void
379popup_add_timeout(win_T *wp, int time)
380{
381 char_u cbbuf[50];
382 char_u *ptr = cbbuf;
383 typval_T tv;
384
385 vim_snprintf((char *)cbbuf, sizeof(cbbuf),
386 "{_ -> popup_close(%d)}", wp->w_id);
387 if (get_lambda_tv(&ptr, &tv, TRUE) == OK)
388 {
389 wp->w_popup_timer = create_timer(time, 0);
390 wp->w_popup_timer->tr_callback = get_callback(&tv);
391 clear_tv(&tv);
392 }
393}
394#endif
395
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +0100396 static poppos_T
397get_pos_entry(dict_T *d, int give_error)
398{
399 char_u *str = dict_get_string(d, (char_u *)"pos", FALSE);
400 int nr;
401
402 if (str == NULL)
403 return POPPOS_NONE;
404
405 for (nr = 0; nr < (int)(sizeof(poppos_entries) / sizeof(poppos_entry_T));
406 ++nr)
407 if (STRCMP(str, poppos_entries[nr].pp_name) == 0)
408 return poppos_entries[nr].pp_val;
409
410 if (give_error)
411 semsg(_(e_invarg2), str);
412 return POPPOS_NONE;
413}
414
Bram Moolenaar17627312019-06-02 19:53:44 +0200415/*
Bram Moolenaarae943152019-06-16 22:54:14 +0200416 * Shared between popup_create() and f_popup_move().
Bram Moolenaar17627312019-06-02 19:53:44 +0200417 */
418 static void
Bram Moolenaarae943152019-06-16 22:54:14 +0200419apply_move_options(win_T *wp, dict_T *d)
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200420{
Bram Moolenaar12034e22019-08-25 22:25:02 +0200421 int nr;
422 char_u *str;
423 dictitem_T *di;
Bram Moolenaarae943152019-06-16 22:54:14 +0200424
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200425 if ((nr = dict_get_number_def(d, (char_u *)"minwidth", -1)) >= 0)
Bram Moolenaarae943152019-06-16 22:54:14 +0200426 wp->w_minwidth = nr;
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200427 if ((nr = dict_get_number_def(d, (char_u *)"minheight", -1)) >= 0)
Bram Moolenaarae943152019-06-16 22:54:14 +0200428 wp->w_minheight = nr;
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200429 if ((nr = dict_get_number_def(d, (char_u *)"maxwidth", -1)) >= 0)
Bram Moolenaarae943152019-06-16 22:54:14 +0200430 wp->w_maxwidth = nr;
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200431 if ((nr = dict_get_number_def(d, (char_u *)"maxheight", -1)) >= 0)
Bram Moolenaarae943152019-06-16 22:54:14 +0200432 wp->w_maxheight = nr;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200433
434 nr = popup_options_one(d, (char_u *)"line");
Bram Moolenaar1fb08312019-08-29 20:02:11 +0200435 if (nr != MAXCOL)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200436 wp->w_wantline = nr;
437 nr = popup_options_one(d, (char_u *)"col");
Bram Moolenaar1fb08312019-08-29 20:02:11 +0200438 if (nr != MAXCOL)
Bram Moolenaar12034e22019-08-25 22:25:02 +0200439 wp->w_wantcol = nr;
440
441 di = dict_find(d, (char_u *)"fixed", -1);
442 if (di != NULL)
443 wp->w_popup_fixed = dict_get_number(d, (char_u *)"fixed") != 0;
444
Bram Moolenaar12034e22019-08-25 22:25:02 +0200445 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +0100446 poppos_T ppt = get_pos_entry(d, TRUE);
447
448 if (ppt != POPPOS_NONE)
449 wp->w_popup_pos = ppt;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200450 }
451
452 str = dict_get_string(d, (char_u *)"textprop", FALSE);
453 if (str != NULL)
454 {
455 wp->w_popup_prop_type = 0;
456 if (*str != NUL)
457 {
Bram Moolenaara37cb552019-11-16 20:03:31 +0100458 wp->w_popup_prop_win = curwin;
459 di = dict_find(d, (char_u *)"textpropwin", -1);
460 if (di != NULL)
461 {
462 wp->w_popup_prop_win = find_win_by_nr_or_id(&di->di_tv);
463 if (!win_valid(wp->w_popup_prop_win))
464 wp->w_popup_prop_win = curwin;
465 }
466
467 nr = find_prop_type_id(str, wp->w_popup_prop_win->w_buffer);
Bram Moolenaar12034e22019-08-25 22:25:02 +0200468 if (nr <= 0)
469 nr = find_prop_type_id(str, NULL);
470 if (nr <= 0)
471 semsg(_(e_invarg2), str);
472 else
Bram Moolenaar12034e22019-08-25 22:25:02 +0200473 wp->w_popup_prop_type = nr;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200474 }
475 }
476
477 di = dict_find(d, (char_u *)"textpropid", -1);
478 if (di != NULL)
479 wp->w_popup_prop_id = dict_get_number(d, (char_u *)"textpropid");
Bram Moolenaarae943152019-06-16 22:54:14 +0200480}
481
Bram Moolenaarb0992022020-01-30 14:55:42 +0100482/*
483 * Handle "moved" and "mousemoved" arguments.
484 */
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200485 static void
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200486handle_moved_argument(win_T *wp, dictitem_T *di, int mousemoved)
487{
488 if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
489 {
490 char_u *s = di->di_tv.vval.v_string;
491 int flags = 0;
492
493 if (STRCMP(s, "word") == 0)
494 flags = FIND_IDENT | FIND_STRING;
495 else if (STRCMP(s, "WORD") == 0)
496 flags = FIND_STRING;
497 else if (STRCMP(s, "expr") == 0)
498 flags = FIND_IDENT | FIND_STRING | FIND_EVAL;
499 else if (STRCMP(s, "any") != 0)
500 semsg(_(e_invarg2), s);
501 if (flags != 0)
502 {
503 if (mousemoved)
504 set_mousemoved_columns(wp, flags);
505 else
506 set_moved_columns(wp, flags);
507 }
508 }
509 else if (di->di_tv.v_type == VAR_LIST
510 && di->di_tv.vval.v_list != NULL
Bram Moolenaara1396152019-10-20 18:46:05 +0200511 && (di->di_tv.vval.v_list->lv_len == 2
512 || di->di_tv.vval.v_list->lv_len == 3))
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200513 {
Bram Moolenaara1396152019-10-20 18:46:05 +0200514 list_T *l = di->di_tv.vval.v_list;
Bram Moolenaarb0992022020-01-30 14:55:42 +0100515 listitem_T *li;
Bram Moolenaara1396152019-10-20 18:46:05 +0200516 int mincol;
517 int maxcol;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200518
Bram Moolenaarb0992022020-01-30 14:55:42 +0100519 range_list_materialize(l);
520 li = l->lv_first;
521 if (l->lv_len == 3)
Bram Moolenaara1396152019-10-20 18:46:05 +0200522 {
523 varnumber_T nr = tv_get_number(&l->lv_first->li_tv);
524
525 // Three numbers, might be from popup_getoptions().
526 if (mousemoved)
527 wp->w_popup_mouse_row = nr;
528 else
529 wp->w_popup_lnum = nr;
530 li = li->li_next;
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +0100531 if (nr == 0)
532 wp->w_popup_curwin = NULL;
Bram Moolenaara1396152019-10-20 18:46:05 +0200533 }
534
535 mincol = tv_get_number(&li->li_tv);
536 maxcol = tv_get_number(&li->li_next->li_tv);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200537 if (mousemoved)
538 {
539 wp->w_popup_mouse_mincol = mincol;
540 wp->w_popup_mouse_maxcol = maxcol;
541 }
542 else
543 {
544 wp->w_popup_mincol = mincol;
545 wp->w_popup_maxcol = maxcol;
546 }
547 }
548 else
549 semsg(_(e_invarg2), tv_get_string(&di->di_tv));
550}
551
552 static void
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200553check_highlight(dict_T *dict, char *name, char_u **pval)
554{
555 dictitem_T *di;
556 char_u *str;
557
558 di = dict_find(dict, (char_u *)name, -1);
559 if (di != NULL)
560 {
561 if (di->di_tv.v_type != VAR_STRING)
562 semsg(_(e_invargval), name);
563 else
564 {
565 str = tv_get_string(&di->di_tv);
566 if (*str != NUL)
567 *pval = vim_strsave(str);
568 }
569 }
570}
571
Bram Moolenaarae943152019-06-16 22:54:14 +0200572/*
Bram Moolenaar7b3d9392019-10-16 22:17:07 +0200573 * Scroll to show the line with the cursor.
Bram Moolenaar79648732019-07-18 21:43:07 +0200574 */
575 static void
576popup_show_curline(win_T *wp)
577{
578 if (wp->w_cursor.lnum < wp->w_topline)
579 wp->w_topline = wp->w_cursor.lnum;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200580 else if (wp->w_cursor.lnum >= wp->w_botline
581 && (curwin->w_valid & VALID_BOTLINE))
582 {
Bram Moolenaar79648732019-07-18 21:43:07 +0200583 wp->w_topline = wp->w_cursor.lnum - wp->w_height + 1;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200584 if (wp->w_topline < 1)
585 wp->w_topline = 1;
586 else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
587 wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +0200588 while (wp->w_topline < wp->w_cursor.lnum
589 && wp->w_topline < wp->w_buffer->b_ml.ml_line_count
590 && plines_m_win(wp, wp->w_topline, wp->w_cursor.lnum)
591 > wp->w_height)
592 ++wp->w_topline;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200593 }
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200594
595 // Don't use "firstline" now.
596 wp->w_firstline = 0;
597}
598
599/*
600 * Get the sign group name for window "wp".
601 * Returns a pointer to a static buffer, overwritten on the next call.
602 */
603 static char_u *
604popup_get_sign_name(win_T *wp)
605{
606 static char buf[30];
607
608 vim_snprintf(buf, sizeof(buf), "popup-%d", wp->w_id);
609 return (char_u *)buf;
Bram Moolenaar79648732019-07-18 21:43:07 +0200610}
611
612/*
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200613 * Highlight the line with the cursor.
614 * Also scrolls the text to put the cursor line in view.
615 */
616 static void
617popup_highlight_curline(win_T *wp)
618{
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200619 int sign_id = 0;
620 char_u *sign_name = popup_get_sign_name(wp);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200621
Bram Moolenaar72570732019-11-30 14:21:53 +0100622 buf_delete_signs(wp->w_buffer, (char_u *)"PopUpMenu");
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200623
624 if ((wp->w_popup_flags & POPF_CURSORLINE) != 0)
625 {
Bram Moolenaar79648732019-07-18 21:43:07 +0200626 popup_show_curline(wp);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200627
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200628 if (!sign_exists_by_name(sign_name))
629 {
630 char *linehl = "PopupSelected";
631
632 if (syn_name2id((char_u *)linehl) == 0)
633 linehl = "PmenuSel";
Bram Moolenaar62a0cb42019-08-18 16:35:23 +0200634 sign_define_by_name(sign_name, NULL, (char_u *)linehl, NULL, NULL);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200635 }
636
Bram Moolenaar72570732019-11-30 14:21:53 +0100637 sign_place(&sign_id, (char_u *)"PopUpMenu", sign_name,
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200638 wp->w_buffer, wp->w_cursor.lnum, SIGN_DEF_PRIO);
639 redraw_win_later(wp, NOT_VALID);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200640 }
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200641 else
642 sign_undefine_by_name(sign_name, FALSE);
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200643 wp->w_popup_last_curline = wp->w_cursor.lnum;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200644}
645
646/*
Bram Moolenaarae943152019-06-16 22:54:14 +0200647 * Shared between popup_create() and f_popup_setoptions().
648 */
649 static void
650apply_general_options(win_T *wp, dict_T *dict)
651{
652 dictitem_T *di;
Bram Moolenaar402502d2019-05-30 22:07:36 +0200653 int nr;
654 char_u *str;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +0200655
Bram Moolenaarae943152019-06-16 22:54:14 +0200656 // TODO: flip
657
658 di = dict_find(dict, (char_u *)"firstline", -1);
Bram Moolenaardfa97f22019-06-15 14:31:55 +0200659 if (di != NULL)
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200660 {
Bram Moolenaarae943152019-06-16 22:54:14 +0200661 wp->w_firstline = dict_get_number(dict, (char_u *)"firstline");
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200662 if (wp->w_firstline < 0)
663 wp->w_firstline = -1;
664 }
Bram Moolenaarbf0eff02019-06-01 17:13:36 +0200665
Bram Moolenaar75fb0852019-06-25 05:15:58 +0200666 di = dict_find(dict, (char_u *)"scrollbar", -1);
667 if (di != NULL)
668 wp->w_want_scrollbar = dict_get_number(dict, (char_u *)"scrollbar");
669
Bram Moolenaareb2310d2019-06-16 20:09:10 +0200670 str = dict_get_string(dict, (char_u *)"title", FALSE);
671 if (str != NULL)
672 {
673 vim_free(wp->w_popup_title);
674 wp->w_popup_title = vim_strsave(str);
675 }
676
Bram Moolenaar402502d2019-05-30 22:07:36 +0200677 di = dict_find(dict, (char_u *)"wrap", -1);
678 if (di != NULL)
679 {
680 nr = dict_get_number(dict, (char_u *)"wrap");
681 wp->w_p_wrap = nr != 0;
682 }
Bram Moolenaarbf0eff02019-06-01 17:13:36 +0200683
Bram Moolenaara42d9452019-06-15 21:46:30 +0200684 di = dict_find(dict, (char_u *)"drag", -1);
685 if (di != NULL)
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200686 {
687 nr = dict_get_number(dict, (char_u *)"drag");
688 if (nr)
689 wp->w_popup_flags |= POPF_DRAG;
690 else
691 wp->w_popup_flags &= ~POPF_DRAG;
692 }
693
Bram Moolenaar638a4a72019-11-06 19:25:22 +0100694 di = dict_find(dict, (char_u *)"posinvert", -1);
695 if (di != NULL)
696 {
697 nr = dict_get_number(dict, (char_u *)"posinvert");
698 if (nr)
699 wp->w_popup_flags |= POPF_POSINVERT;
700 else
701 wp->w_popup_flags &= ~POPF_POSINVERT;
702 }
703
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200704 di = dict_find(dict, (char_u *)"resize", -1);
705 if (di != NULL)
706 {
707 nr = dict_get_number(dict, (char_u *)"resize");
708 if (nr)
709 wp->w_popup_flags |= POPF_RESIZE;
710 else
711 wp->w_popup_flags &= ~POPF_RESIZE;
712 }
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200713
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200714 di = dict_find(dict, (char_u *)"close", -1);
715 if (di != NULL)
716 {
717 int ok = TRUE;
718
719 if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
720 {
721 char_u *s = di->di_tv.vval.v_string;
722
723 if (STRCMP(s, "none") == 0)
724 wp->w_popup_close = POPCLOSE_NONE;
725 else if (STRCMP(s, "button") == 0)
726 wp->w_popup_close = POPCLOSE_BUTTON;
727 else if (STRCMP(s, "click") == 0)
728 wp->w_popup_close = POPCLOSE_CLICK;
729 else
730 ok = FALSE;
731 }
732 else
733 ok = FALSE;
734 if (!ok)
735 semsg(_(e_invargNval), "close", tv_get_string(&di->di_tv));
736 }
737
Bram Moolenaarae943152019-06-16 22:54:14 +0200738 str = dict_get_string(dict, (char_u *)"highlight", FALSE);
739 if (str != NULL)
740 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
741 str, OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar9eaac892019-06-01 22:49:29 +0200742
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200743 set_string_option_direct_in_win(wp, (char_u *)"signcolumn", -1,
744 (char_u *)"no", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaarae943152019-06-16 22:54:14 +0200745 set_padding_border(dict, wp->w_popup_padding, "padding", 999);
746 set_padding_border(dict, wp->w_popup_border, "border", 1);
Bram Moolenaar9eaac892019-06-01 22:49:29 +0200747
Bram Moolenaar790498b2019-06-01 22:15:29 +0200748 di = dict_find(dict, (char_u *)"borderhighlight", -1);
749 if (di != NULL)
750 {
Bram Moolenaar403d0902019-07-17 21:37:32 +0200751 if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
Bram Moolenaar790498b2019-06-01 22:15:29 +0200752 emsg(_(e_listreq));
753 else
754 {
755 list_T *list = di->di_tv.vval.v_list;
756 listitem_T *li;
Bram Moolenaarae943152019-06-16 22:54:14 +0200757 int i;
Bram Moolenaar790498b2019-06-01 22:15:29 +0200758
Bram Moolenaarb0992022020-01-30 14:55:42 +0100759 range_list_materialize(list);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200760 for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
761 ++i, li = li->li_next)
762 {
763 str = tv_get_string(&li->li_tv);
764 if (*str != NUL)
Bram Moolenaar622b6462019-11-10 15:16:54 +0100765 {
766 vim_free(wp->w_border_highlight[i]);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200767 wp->w_border_highlight[i] = vim_strsave(str);
Bram Moolenaar622b6462019-11-10 15:16:54 +0100768 }
Bram Moolenaar403d0902019-07-17 21:37:32 +0200769 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200770 if (list->lv_len == 1 && wp->w_border_highlight[0] != NULL)
771 for (i = 1; i < 4; ++i)
Bram Moolenaar622b6462019-11-10 15:16:54 +0100772 {
773 vim_free(wp->w_border_highlight[i]);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200774 wp->w_border_highlight[i] =
Bram Moolenaar790498b2019-06-01 22:15:29 +0200775 vim_strsave(wp->w_border_highlight[0]);
Bram Moolenaar622b6462019-11-10 15:16:54 +0100776 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200777 }
778 }
779
Bram Moolenaar790498b2019-06-01 22:15:29 +0200780 di = dict_find(dict, (char_u *)"borderchars", -1);
781 if (di != NULL)
782 {
783 if (di->di_tv.v_type != VAR_LIST)
784 emsg(_(e_listreq));
785 else
786 {
787 list_T *list = di->di_tv.vval.v_list;
788 listitem_T *li;
Bram Moolenaarae943152019-06-16 22:54:14 +0200789 int i;
Bram Moolenaar790498b2019-06-01 22:15:29 +0200790
791 if (list != NULL)
Bram Moolenaarb0992022020-01-30 14:55:42 +0100792 {
793 range_list_materialize(list);
Bram Moolenaar790498b2019-06-01 22:15:29 +0200794 for (i = 0, li = list->lv_first; i < 8 && i < list->lv_len;
795 ++i, li = li->li_next)
796 {
797 str = tv_get_string(&li->li_tv);
798 if (*str != NUL)
799 wp->w_border_char[i] = mb_ptr2char(str);
800 }
Bram Moolenaar8d4ed112020-04-04 14:50:32 +0200801 if (list->lv_len == 1)
802 for (i = 1; i < 8; ++i)
803 wp->w_border_char[i] = wp->w_border_char[0];
804 if (list->lv_len == 2)
805 {
806 for (i = 4; i < 8; ++i)
807 wp->w_border_char[i] = wp->w_border_char[1];
808 for (i = 1; i < 4; ++i)
809 wp->w_border_char[i] = wp->w_border_char[0];
810 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200811 }
812 }
813 }
Bram Moolenaar3397f742019-06-02 18:40:06 +0200814
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200815 check_highlight(dict, "scrollbarhighlight", &wp->w_scrollbar_highlight);
816 check_highlight(dict, "thumbhighlight", &wp->w_thumb_highlight);
817
Bram Moolenaarae943152019-06-16 22:54:14 +0200818 di = dict_find(dict, (char_u *)"zindex", -1);
819 if (di != NULL)
820 {
821 wp->w_zindex = dict_get_number(dict, (char_u *)"zindex");
822 if (wp->w_zindex < 1)
823 wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
824 if (wp->w_zindex > 32000)
825 wp->w_zindex = 32000;
826 }
827
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200828 di = dict_find(dict, (char_u *)"mask", -1);
829 if (di != NULL)
830 {
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200831 int ok = FALSE;
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200832
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200833 if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200834 {
835 listitem_T *li;
836
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200837 ok = TRUE;
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200838 FOR_ALL_LIST_ITEMS(di->di_tv.vval.v_list, li)
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200839 {
840 if (li->li_tv.v_type != VAR_LIST
841 || li->li_tv.vval.v_list == NULL
842 || li->li_tv.vval.v_list->lv_len != 4)
843 {
844 ok = FALSE;
845 break;
846 }
Bram Moolenaarb0992022020-01-30 14:55:42 +0100847 else
848 range_list_materialize(li->li_tv.vval.v_list);
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200849 }
850 }
851 if (ok)
852 {
853 wp->w_popup_mask = di->di_tv.vval.v_list;
854 ++wp->w_popup_mask->lv_refcount;
Bram Moolenaare865dcb2019-07-26 22:15:50 +0200855 VIM_CLEAR(wp->w_popup_mask_cells);
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200856 }
857 else
858 semsg(_(e_invargval), "mask");
859 }
860
Bram Moolenaarae943152019-06-16 22:54:14 +0200861#if defined(FEAT_TIMERS)
862 // Add timer to close the popup after some time.
863 nr = dict_get_number(dict, (char_u *)"time");
864 if (nr > 0)
865 popup_add_timeout(wp, nr);
866#endif
867
Bram Moolenaar3397f742019-06-02 18:40:06 +0200868 di = dict_find(dict, (char_u *)"moved", -1);
869 if (di != NULL)
870 {
Bram Moolenaar17627312019-06-02 19:53:44 +0200871 set_moved_values(wp);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200872 handle_moved_argument(wp, di, FALSE);
873 }
Bram Moolenaar3397f742019-06-02 18:40:06 +0200874
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200875 di = dict_find(dict, (char_u *)"mousemoved", -1);
876 if (di != NULL)
877 {
878 set_mousemoved_values(wp);
879 handle_moved_argument(wp, di, TRUE);
Bram Moolenaar3397f742019-06-02 18:40:06 +0200880 }
Bram Moolenaar33796b32019-06-08 16:01:13 +0200881
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200882 di = dict_find(dict, (char_u *)"cursorline", -1);
883 if (di != NULL)
884 {
885 if (di->di_tv.v_type == VAR_NUMBER)
886 {
887 if (di->di_tv.vval.v_number != 0)
888 wp->w_popup_flags |= POPF_CURSORLINE;
889 else
890 wp->w_popup_flags &= ~POPF_CURSORLINE;
891 }
892 else
893 semsg(_(e_invargval), "cursorline");
894 }
895
Bram Moolenaarae943152019-06-16 22:54:14 +0200896 di = dict_find(dict, (char_u *)"filter", -1);
897 if (di != NULL)
898 {
899 callback_T callback = get_callback(&di->di_tv);
900
901 if (callback.cb_name != NULL)
902 {
903 free_callback(&wp->w_filter_cb);
904 set_callback(&wp->w_filter_cb, &callback);
905 }
906 }
Bram Moolenaar749fa0a2019-08-03 16:18:07 +0200907 di = dict_find(dict, (char_u *)"mapping", -1);
908 if (di != NULL)
909 {
910 nr = dict_get_number(dict, (char_u *)"mapping");
911 if (nr)
912 wp->w_popup_flags |= POPF_MAPPING;
913 else
914 wp->w_popup_flags &= ~POPF_MAPPING;
915 }
Bram Moolenaarae943152019-06-16 22:54:14 +0200916
Bram Moolenaar581ba392019-09-03 22:08:33 +0200917 str = dict_get_string(dict, (char_u *)"filtermode", FALSE);
918 if (str != NULL)
919 {
920 if (STRCMP(str, "a") == 0)
921 wp->w_filter_mode = MODE_ALL;
922 else
923 wp->w_filter_mode = mode_str2flags(str);
924 }
925
Bram Moolenaarae943152019-06-16 22:54:14 +0200926 di = dict_find(dict, (char_u *)"callback", -1);
927 if (di != NULL)
928 {
929 callback_T callback = get_callback(&di->di_tv);
930
931 if (callback.cb_name != NULL)
932 {
933 free_callback(&wp->w_close_cb);
934 set_callback(&wp->w_close_cb, &callback);
935 }
936 }
937}
938
939/*
940 * Go through the options in "dict" and apply them to popup window "wp".
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200941 * Only used when creating a new popup window.
Bram Moolenaarae943152019-06-16 22:54:14 +0200942 */
943 static void
944apply_options(win_T *wp, dict_T *dict)
945{
946 int nr;
947
948 apply_move_options(wp, dict);
949 apply_general_options(wp, dict);
950
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200951 nr = dict_get_number(dict, (char_u *)"hidden");
952 if (nr > 0)
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200953 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200954
Bram Moolenaar33796b32019-06-08 16:01:13 +0200955 popup_mask_refresh = TRUE;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200956 popup_highlight_curline(wp);
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200957}
958
959/*
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200960 * Add lines to the popup from a list of strings.
961 */
962 static void
963add_popup_strings(buf_T *buf, list_T *l)
964{
965 listitem_T *li;
966 linenr_T lnum = 0;
967 char_u *p;
968
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200969 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200970 if (li->li_tv.v_type == VAR_STRING)
971 {
972 p = li->li_tv.vval.v_string;
973 ml_append_buf(buf, lnum++,
974 p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
975 }
976}
977
978/*
979 * Add lines to the popup from a list of dictionaries.
980 */
981 static void
982add_popup_dicts(buf_T *buf, list_T *l)
983{
984 listitem_T *li;
985 listitem_T *pli;
986 linenr_T lnum = 0;
987 char_u *p;
988 dict_T *dict;
989
990 // first add the text lines
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200991 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200992 {
993 if (li->li_tv.v_type != VAR_DICT)
994 {
995 emsg(_(e_dictreq));
996 return;
997 }
998 dict = li->li_tv.vval.v_dict;
999 p = dict == NULL ? NULL
1000 : dict_get_string(dict, (char_u *)"text", FALSE);
1001 ml_append_buf(buf, lnum++,
1002 p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
1003 }
1004
1005 // add the text properties
1006 lnum = 1;
1007 for (li = l->lv_first; li != NULL; li = li->li_next, ++lnum)
1008 {
1009 dictitem_T *di;
1010 list_T *plist;
1011
1012 dict = li->li_tv.vval.v_dict;
1013 di = dict_find(dict, (char_u *)"props", -1);
1014 if (di != NULL)
1015 {
1016 if (di->di_tv.v_type != VAR_LIST)
1017 {
1018 emsg(_(e_listreq));
1019 return;
1020 }
1021 plist = di->di_tv.vval.v_list;
1022 if (plist != NULL)
1023 {
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001024 FOR_ALL_LIST_ITEMS(plist, pli)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +02001025 {
1026 if (pli->li_tv.v_type != VAR_DICT)
1027 {
1028 emsg(_(e_dictreq));
1029 return;
1030 }
1031 dict = pli->li_tv.vval.v_dict;
1032 if (dict != NULL)
1033 {
1034 int col = dict_get_number(dict, (char_u *)"col");
1035
1036 prop_add_common( lnum, col, dict, buf, NULL);
1037 }
1038 }
1039 }
1040 }
1041 }
1042}
1043
1044/*
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001045 * Get the padding plus border at the top, adjusted to 1 if there is a title.
1046 */
Bram Moolenaarbd483b32019-08-21 15:13:41 +02001047 int
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001048popup_top_extra(win_T *wp)
1049{
1050 int extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
1051
1052 if (extra == 0 && wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
1053 return 1;
1054 return extra;
1055}
1056
1057/*
Bram Moolenaardb3a2052019-11-16 18:22:41 +01001058 * Get the padding plus border at the left.
1059 */
1060 int
1061popup_left_extra(win_T *wp)
1062{
1063 return wp->w_popup_border[3] + wp->w_popup_padding[3];
1064}
1065
1066/*
Bram Moolenaard529ba52019-07-02 23:13:53 +02001067 * Return the height of popup window "wp", including border and padding.
1068 */
1069 int
1070popup_height(win_T *wp)
1071{
1072 return wp->w_height
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001073 + popup_top_extra(wp)
1074 + wp->w_popup_padding[2] + wp->w_popup_border[2];
Bram Moolenaard529ba52019-07-02 23:13:53 +02001075}
1076
1077/*
1078 * Return the width of popup window "wp", including border, padding and
1079 * scrollbar.
1080 */
1081 int
1082popup_width(win_T *wp)
1083{
Bram Moolenaar017c2692019-07-13 14:17:51 +02001084 // w_leftcol is how many columns of the core are left of the screen
1085 // w_popup_rightoff is how many columns of the core are right of the screen
Bram Moolenaard529ba52019-07-02 23:13:53 +02001086 return wp->w_width + wp->w_leftcol
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001087 + popup_extra_width(wp)
1088 + wp->w_popup_rightoff;
1089}
1090
1091/*
1092 * Return the extra width of popup window "wp": border, padding and scrollbar.
1093 */
1094 int
1095popup_extra_width(win_T *wp)
1096{
1097 return wp->w_popup_padding[3] + wp->w_popup_border[3]
1098 + wp->w_popup_padding[1] + wp->w_popup_border[1]
1099 + wp->w_has_scrollbar;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001100}
1101
1102/*
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001103 * Adjust the position and size of the popup to fit on the screen.
1104 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001105 static void
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001106popup_adjust_position(win_T *wp)
1107{
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001108 linenr_T lnum;
1109 int wrapped = 0;
1110 int maxwidth;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +02001111 int used_maxwidth = FALSE;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001112 int maxspace;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001113 int center_vert = FALSE;
1114 int center_hor = FALSE;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001115 int allow_adjust_left = !wp->w_popup_fixed;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001116 int top_extra = popup_top_extra(wp);
Bram Moolenaar399d8982019-06-02 15:34:29 +02001117 int right_extra = wp->w_popup_border[1] + wp->w_popup_padding[1];
1118 int bot_extra = wp->w_popup_border[2] + wp->w_popup_padding[2];
1119 int left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
1120 int extra_height = top_extra + bot_extra;
1121 int extra_width = left_extra + right_extra;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001122 int w_height_before_limit;
Bram Moolenaar33796b32019-06-08 16:01:13 +02001123 int org_winrow = wp->w_winrow;
1124 int org_wincol = wp->w_wincol;
1125 int org_width = wp->w_width;
1126 int org_height = wp->w_height;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001127 int org_leftcol = wp->w_leftcol;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001128 int org_leftoff = wp->w_popup_leftoff;
Bram Moolenaar19398262020-03-14 15:28:08 +01001129 int minwidth, minheight;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001130 int wantline = wp->w_wantline; // adjusted for textprop
1131 int wantcol = wp->w_wantcol; // adjusted for textprop
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001132 int use_wantcol = wantcol != 0;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001133
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001134 wp->w_winrow = 0;
1135 wp->w_wincol = 0;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001136 wp->w_leftcol = 0;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001137 wp->w_popup_leftoff = 0;
1138 wp->w_popup_rightoff = 0;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001139
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02001140 // May need to update the "cursorline" highlighting, which may also change
1141 // "topline"
1142 if (wp->w_popup_last_curline != wp->w_cursor.lnum)
1143 popup_highlight_curline(wp);
1144
Bram Moolenaar12034e22019-08-25 22:25:02 +02001145 if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
1146 {
1147 win_T *prop_win = wp->w_popup_prop_win;
1148 textprop_T prop;
1149 linenr_T prop_lnum;
1150 pos_T pos;
1151 int screen_row;
1152 int screen_scol;
1153 int screen_ccol;
1154 int screen_ecol;
1155
1156 // Popup window is positioned relative to a text property.
1157 if (find_visible_prop(prop_win,
1158 wp->w_popup_prop_type, wp->w_popup_prop_id,
1159 &prop, &prop_lnum) == FAIL)
1160 {
1161 // Text property is no longer visible, hide the popup.
1162 // Unhiding the popup is done in check_popup_unhidden().
1163 if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
1164 {
1165 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001166 if (win_valid(wp->w_popup_prop_win))
1167 redraw_win_later(wp->w_popup_prop_win, SOME_VALID);
1168 }
1169 return;
1170 }
1171
1172 // Compute the desired position from the position of the text
1173 // property. Use "wantline" and "wantcol" as offsets.
1174 pos.lnum = prop_lnum;
1175 pos.col = prop.tp_col;
1176 if (wp->w_popup_pos == POPPOS_TOPLEFT
1177 || wp->w_popup_pos == POPPOS_BOTLEFT)
1178 pos.col += prop.tp_len - 1;
1179 textpos2screenpos(prop_win, &pos, &screen_row,
1180 &screen_scol, &screen_ccol, &screen_ecol);
1181
1182 if (wp->w_popup_pos == POPPOS_TOPLEFT
1183 || wp->w_popup_pos == POPPOS_TOPRIGHT)
1184 // below the text
1185 wantline = screen_row + wantline + 1;
1186 else
1187 // above the text
1188 wantline = screen_row + wantline - 1;
1189 center_vert = FALSE;
1190 if (wp->w_popup_pos == POPPOS_TOPLEFT
1191 || wp->w_popup_pos == POPPOS_BOTLEFT)
1192 // right of the text
1193 wantcol = screen_ecol + wantcol;
1194 else
1195 // left of the text
Bram Moolenaarbc2d4c12019-08-28 22:18:30 +02001196 wantcol = screen_scol + wantcol - 2;
Bram Moolenaaraa1f04d2019-10-24 22:12:54 +02001197 use_wantcol = TRUE;
1198 }
1199 else
1200 {
1201 // If no line was specified default to vertical centering.
1202 if (wantline == 0)
1203 center_vert = TRUE;
1204 else if (wantline < 0)
1205 // If "wantline" is negative it actually means zero.
1206 wantline = 0;
1207 if (wantcol < 0)
1208 // If "wantcol" is negative it actually means zero.
1209 wantcol = 0;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001210 }
1211
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001212 if (wp->w_popup_pos == POPPOS_CENTER)
1213 {
1214 // center after computing the size
1215 center_vert = TRUE;
1216 center_hor = TRUE;
1217 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001218 else
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001219 {
Bram Moolenaaraa1f04d2019-10-24 22:12:54 +02001220 if (wantline > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
1221 || wp->w_popup_pos == POPPOS_TOPRIGHT))
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001222 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001223 wp->w_winrow = wantline - 1;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001224 if (wp->w_winrow >= Rows)
1225 wp->w_winrow = Rows - 1;
1226 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001227
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001228 if (!use_wantcol)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001229 center_hor = TRUE;
Bram Moolenaar1fb08312019-08-29 20:02:11 +02001230 else if (wantcol > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
1231 || wp->w_popup_pos == POPPOS_BOTLEFT))
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001232 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001233 wp->w_wincol = wantcol - 1;
Bram Moolenaarba2920f2020-03-06 21:43:17 +01001234 // Need to see at least one character after the decoration.
1235 if (wp->w_wincol > Columns - left_extra - 1)
1236 wp->w_wincol = Columns - left_extra - 1;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001237 }
1238 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001239
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001240 // When centering or right aligned, use maximum width.
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001241 // When left aligned use the space available, but shift to the left when we
1242 // hit the right of the screen.
Bram Moolenaard529ba52019-07-02 23:13:53 +02001243 maxspace = Columns - wp->w_wincol - left_extra;
1244 maxwidth = maxspace;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001245 if (wp->w_maxwidth > 0 && maxwidth > wp->w_maxwidth)
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001246 {
1247 allow_adjust_left = FALSE;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001248 maxwidth = wp->w_maxwidth;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001249 }
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001250 minwidth = wp->w_minwidth;
Bram Moolenaar19398262020-03-14 15:28:08 +01001251 minheight = wp->w_minheight;
1252#ifdef FEAT_TERMINAL
1253 // A terminal popup initially does not have content, use a default minimal
1254 // width of 20 characters and height of 5 lines.
1255 if (wp->w_buffer->b_term != NULL)
1256 {
1257 if (minwidth == 0)
1258 minwidth = 20;
1259 if (minheight == 0)
1260 minheight = 5;
1261 }
1262#endif
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001263
Bram Moolenaar8d241042019-06-12 23:40:01 +02001264 // start at the desired first line
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001265 if (wp->w_firstline > 0)
Bram Moolenaar79648732019-07-18 21:43:07 +02001266 wp->w_topline = wp->w_firstline;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02001267 if (wp->w_topline < 1)
1268 wp->w_topline = 1;
1269 else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
Bram Moolenaar8d241042019-06-12 23:40:01 +02001270 wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
1271
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001272 // Compute width based on longest text line and the 'wrap' option.
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001273 // Use a minimum width of one, so that something shows when there is no
1274 // text.
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001275 // When "firstline" is -1 then start with the last buffer line and go
1276 // backwards.
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001277 // TODO: more accurate wrapping
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001278 wp->w_width = 1;
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001279 if (wp->w_firstline < 0)
1280 lnum = wp->w_buffer->b_ml.ml_line_count;
1281 else
1282 lnum = wp->w_topline;
1283 while (lnum >= 1 && lnum <= wp->w_buffer->b_ml.ml_line_count)
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001284 {
Bram Moolenaar331bafd2019-07-20 17:46:05 +02001285 int len;
1286 int w_width = wp->w_width;
1287
1288 // Count Tabs for what they are worth and compute the length based on
1289 // the maximum width (matters when 'showbreak' is set).
1290 if (wp->w_width < maxwidth)
1291 wp->w_width = maxwidth;
1292 len = win_linetabsize(wp, ml_get_buf(wp->w_buffer, lnum, FALSE),
Bram Moolenaare089c3f2019-07-09 20:25:25 +02001293 (colnr_T)MAXCOL);
Bram Moolenaar331bafd2019-07-20 17:46:05 +02001294 wp->w_width = w_width;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001295
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001296 if (wp->w_p_wrap)
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001297 {
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001298 while (len > maxwidth)
1299 {
1300 ++wrapped;
1301 len -= maxwidth;
1302 wp->w_width = maxwidth;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +02001303 used_maxwidth = TRUE;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001304 }
1305 }
1306 else if (len > maxwidth
1307 && allow_adjust_left
1308 && (wp->w_popup_pos == POPPOS_TOPLEFT
1309 || wp->w_popup_pos == POPPOS_BOTLEFT))
1310 {
1311 // adjust leftwise to fit text on screen
Bram Moolenaar51c31312019-06-15 22:27:23 +02001312 int shift_by = len - maxwidth;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001313
Bram Moolenaar51c31312019-06-15 22:27:23 +02001314 if (shift_by > wp->w_wincol)
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001315 {
1316 int truncate_shift = shift_by - wp->w_wincol;
Bram Moolenaar51c31312019-06-15 22:27:23 +02001317
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001318 len -= truncate_shift;
1319 shift_by -= truncate_shift;
1320 }
1321
1322 wp->w_wincol -= shift_by;
1323 maxwidth += shift_by;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001324 wp->w_width = maxwidth;
1325 }
1326 if (wp->w_width < len)
Bram Moolenaar017c2692019-07-13 14:17:51 +02001327 {
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001328 wp->w_width = len;
Bram Moolenaar017c2692019-07-13 14:17:51 +02001329 if (wp->w_maxwidth > 0 && wp->w_width > wp->w_maxwidth)
1330 wp->w_width = wp->w_maxwidth;
1331 }
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001332
1333 if (wp->w_firstline < 0)
1334 --lnum;
1335 else
1336 ++lnum;
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001337
1338 // do not use the width of lines we're not going to show
1339 if (wp->w_maxheight > 0
1340 && (wp->w_firstline >= 0
1341 ? lnum - wp->w_topline
1342 : wp->w_buffer->b_ml.ml_line_count - lnum)
1343 + wrapped >= wp->w_maxheight)
1344 break;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001345 }
1346
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001347 if (wp->w_firstline < 0)
1348 wp->w_topline = lnum > 0 ? lnum + 1 : lnum;
1349
Bram Moolenaar75fb0852019-06-25 05:15:58 +02001350 wp->w_has_scrollbar = wp->w_want_scrollbar
1351 && (wp->w_topline > 1 || lnum <= wp->w_buffer->b_ml.ml_line_count);
Bram Moolenaar219c7d02020-02-01 21:57:29 +01001352#ifdef FEAT_TERMINAL
1353 if (wp->w_buffer->b_term != NULL)
1354 // Terminal window never has a scrollbar, adjusts to window height.
1355 wp->w_has_scrollbar = FALSE;
1356#endif
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001357 if (wp->w_has_scrollbar)
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001358 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001359 ++right_extra;
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001360 ++extra_width;
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001361 // make space for the scrollbar if needed, when lines wrap and when
1362 // applying minwidth
1363 if (maxwidth + right_extra >= maxspace
1364 && (used_maxwidth || (minwidth > 0 && wp->w_width < minwidth)))
1365 maxwidth -= wp->w_popup_padding[1] + 1;
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001366 }
Bram Moolenaar75fb0852019-06-25 05:15:58 +02001367
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001368 if (wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
1369 {
1370 int title_len = vim_strsize(wp->w_popup_title) + 2 - extra_width;
1371
1372 if (minwidth < title_len)
1373 minwidth = title_len;
1374 }
1375
1376 if (minwidth > 0 && wp->w_width < minwidth)
1377 wp->w_width = minwidth;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001378 if (wp->w_width > maxwidth)
Bram Moolenaard529ba52019-07-02 23:13:53 +02001379 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001380 if (wp->w_width > maxspace && !wp->w_p_wrap)
Bram Moolenaard529ba52019-07-02 23:13:53 +02001381 // some columns cut off on the right
1382 wp->w_popup_rightoff = wp->w_width - maxspace;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001383 wp->w_width = maxwidth;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001384 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001385 if (center_hor)
Bram Moolenaara730e552019-06-16 19:05:31 +02001386 {
1387 wp->w_wincol = (Columns - wp->w_width - extra_width) / 2;
1388 if (wp->w_wincol < 0)
1389 wp->w_wincol = 0;
1390 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001391 else if (wp->w_popup_pos == POPPOS_BOTRIGHT
1392 || wp->w_popup_pos == POPPOS_TOPRIGHT)
1393 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001394 int leftoff = wantcol - (wp->w_width + extra_width);
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001395
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001396 // Right aligned: move to the right if needed.
1397 // No truncation, because that would change the height.
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001398 if (leftoff >= 0)
1399 wp->w_wincol = leftoff;
1400 else if (wp->w_popup_fixed)
1401 {
1402 // "col" specifies the right edge, but popup doesn't fit, skip some
Bram Moolenaard529ba52019-07-02 23:13:53 +02001403 // columns when displaying the window, minus left border and
1404 // padding.
1405 if (-leftoff > left_extra)
1406 wp->w_leftcol = -leftoff - left_extra;
1407 wp->w_width -= wp->w_leftcol;
1408 wp->w_popup_leftoff = -leftoff;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001409 if (wp->w_width < 0)
1410 wp->w_width = 0;
1411 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001412 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001413
Bram Moolenaar8edf0e32019-07-30 21:19:26 +02001414 if (wp->w_p_wrap || (!wp->w_popup_fixed
1415 && (wp->w_popup_pos == POPPOS_TOPLEFT
1416 || wp->w_popup_pos == POPPOS_BOTLEFT)))
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001417 {
1418 int want_col = 0;
1419
Bram Moolenaar8c8b88d2019-07-30 20:32:41 +02001420 // try to show the right border and any scrollbar
1421 want_col = left_extra + wp->w_width + right_extra;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001422 if (want_col > 0 && wp->w_wincol > 0
1423 && wp->w_wincol + want_col >= Columns)
1424 {
1425 wp->w_wincol = Columns - want_col;
1426 if (wp->w_wincol < 0)
1427 wp->w_wincol = 0;
1428 }
1429 }
1430
Bram Moolenaar8d241042019-06-12 23:40:01 +02001431 wp->w_height = wp->w_buffer->b_ml.ml_line_count - wp->w_topline
1432 + 1 + wrapped;
Bram Moolenaar19398262020-03-14 15:28:08 +01001433 if (minheight > 0 && wp->w_height < minheight)
1434 wp->w_height = minheight;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001435 if (wp->w_maxheight > 0 && wp->w_height > wp->w_maxheight)
1436 wp->w_height = wp->w_maxheight;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001437 w_height_before_limit = wp->w_height;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001438 if (wp->w_height > Rows - wp->w_winrow)
1439 wp->w_height = Rows - wp->w_winrow;
Bram Moolenaar30efcf32019-11-03 22:29:38 +01001440 if (wp->w_height != org_height)
1441 win_comp_scroll(wp);
Bram Moolenaar17146962019-05-30 00:12:11 +02001442
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001443 if (center_vert)
Bram Moolenaara730e552019-06-16 19:05:31 +02001444 {
1445 wp->w_winrow = (Rows - wp->w_height - extra_height) / 2;
1446 if (wp->w_winrow < 0)
1447 wp->w_winrow = 0;
1448 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001449 else if (wp->w_popup_pos == POPPOS_BOTRIGHT
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001450 || wp->w_popup_pos == POPPOS_BOTLEFT)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001451 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001452 if ((wp->w_height + extra_height) <= wantline)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001453 // bottom aligned: may move down
Bram Moolenaar12034e22019-08-25 22:25:02 +02001454 wp->w_winrow = wantline - (wp->w_height + extra_height);
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001455 else if (wantline * 2 >= Rows || !(wp->w_popup_flags & POPF_POSINVERT))
1456 {
1457 // Bottom aligned but does not fit, and less space on the other
1458 // side or "posinvert" is off: reduce height.
1459 wp->w_winrow = 0;
1460 wp->w_height = wantline - extra_height;
1461 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001462 else
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001463 // Not enough space and more space on the other side: make top
1464 // aligned.
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001465 wp->w_winrow = (wantline < 0 ? 0 : wantline) + 1;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001466 }
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001467 else if (wp->w_popup_pos == POPPOS_TOPRIGHT
1468 || wp->w_popup_pos == POPPOS_TOPLEFT)
1469 {
1470 if (wantline + (wp->w_height + extra_height) - 1 > Rows
1471 && wantline * 2 > Rows
1472 && (wp->w_popup_flags & POPF_POSINVERT))
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001473 {
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001474 // top aligned and not enough space below but there is space above:
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001475 // make bottom aligned and recompute the height
1476 wp->w_height = w_height_before_limit;
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001477 wp->w_winrow = wantline - 2 - wp->w_height - extra_height;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001478 if (wp->w_winrow < 0)
1479 {
1480 wp->w_height += wp->w_winrow;
1481 wp->w_winrow = 0;
1482 }
1483 }
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001484 else
1485 wp->w_winrow = wantline - 1;
1486 }
Bram Moolenaar12034e22019-08-25 22:25:02 +02001487 if (wp->w_winrow >= Rows)
1488 wp->w_winrow = Rows - 1;
1489 else if (wp->w_winrow < 0)
1490 wp->w_winrow = 0;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001491
Bram Moolenaar17146962019-05-30 00:12:11 +02001492 wp->w_popup_last_changedtick = CHANGEDTICK(wp->w_buffer);
Bram Moolenaar12034e22019-08-25 22:25:02 +02001493 if (win_valid(wp->w_popup_prop_win))
1494 {
1495 wp->w_popup_prop_changedtick =
1496 CHANGEDTICK(wp->w_popup_prop_win->w_buffer);
1497 wp->w_popup_prop_topline = wp->w_popup_prop_win->w_topline;
1498 }
Bram Moolenaar33796b32019-06-08 16:01:13 +02001499
1500 // Need to update popup_mask if the position or size changed.
Bram Moolenaar356375f2019-08-24 14:46:29 +02001501 // And redraw windows and statuslines that were behind the popup.
Bram Moolenaar33796b32019-06-08 16:01:13 +02001502 if (org_winrow != wp->w_winrow
1503 || org_wincol != wp->w_wincol
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001504 || org_leftcol != wp->w_leftcol
Bram Moolenaard529ba52019-07-02 23:13:53 +02001505 || org_leftoff != wp->w_popup_leftoff
Bram Moolenaar33796b32019-06-08 16:01:13 +02001506 || org_width != wp->w_width
1507 || org_height != wp->w_height)
1508 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001509 redraw_win_later(wp, NOT_VALID);
1510 if (wp->w_popup_flags & POPF_ON_CMDLINE)
1511 clear_cmdline = TRUE;
Bram Moolenaar33796b32019-06-08 16:01:13 +02001512 popup_mask_refresh = TRUE;
1513 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001514}
1515
Bram Moolenaar17627312019-06-02 19:53:44 +02001516typedef enum
1517{
1518 TYPE_NORMAL,
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001519 TYPE_ATCURSOR,
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02001520 TYPE_BEVAL,
Bram Moolenaara42d9452019-06-15 21:46:30 +02001521 TYPE_NOTIFICATION,
Bram Moolenaara730e552019-06-16 19:05:31 +02001522 TYPE_DIALOG,
Bram Moolenaar79648732019-07-18 21:43:07 +02001523 TYPE_MENU,
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001524 TYPE_PREVIEW, // preview window
1525 TYPE_INFO // popup menu info
Bram Moolenaar17627312019-06-02 19:53:44 +02001526} create_type_T;
1527
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001528/*
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001529 * Make "buf" empty and set the contents to "text".
1530 * Used by popup_create() and popup_settext().
1531 */
1532 static void
1533popup_set_buffer_text(buf_T *buf, typval_T text)
1534{
1535 int lnum;
1536
1537 // Clear the buffer, then replace the lines.
1538 curbuf = buf;
1539 for (lnum = buf->b_ml.ml_line_count; lnum > 0; --lnum)
1540 ml_delete(lnum, FALSE);
1541 curbuf = curwin->w_buffer;
1542
1543 // Add text to the buffer.
1544 if (text.v_type == VAR_STRING)
1545 {
1546 // just a string
1547 ml_append_buf(buf, 0, text.vval.v_string, (colnr_T)0, TRUE);
1548 }
1549 else
1550 {
1551 list_T *l = text.vval.v_list;
1552
1553 if (l->lv_len > 0)
1554 {
1555 if (l->lv_first->li_tv.v_type == VAR_STRING)
1556 // list of strings
1557 add_popup_strings(buf, l);
1558 else
1559 // list of dictionaries
1560 add_popup_dicts(buf, l);
1561 }
1562 }
1563
1564 // delete the line that was in the empty buffer
1565 curbuf = buf;
1566 ml_delete(buf->b_ml.ml_line_count, FALSE);
1567 curbuf = curwin->w_buffer;
1568}
1569
1570/*
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001571 * Parse the 'previewpopup' or 'completepopup' option and apply the values to
1572 * window "wp" if it is not NULL.
Bram Moolenaar79648732019-07-18 21:43:07 +02001573 * Return FAIL if the parsing fails.
1574 */
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001575 static int
1576parse_popup_option(win_T *wp, int is_preview)
Bram Moolenaar79648732019-07-18 21:43:07 +02001577{
Bram Moolenaar36e4d982019-08-20 21:12:16 +02001578 char_u *p =
1579#ifdef FEAT_QUICKFIX
1580 !is_preview ? p_cpp :
1581#endif
1582 p_pvp;
Bram Moolenaar79648732019-07-18 21:43:07 +02001583
Bram Moolenaar258cef52019-08-21 17:29:29 +02001584 if (wp != NULL)
1585 wp->w_popup_flags &= ~POPF_INFO_MENU;
1586
Bram Moolenaar36e4d982019-08-20 21:12:16 +02001587 for ( ; *p != NUL; p += (*p == ',' ? 1 : 0))
Bram Moolenaar79648732019-07-18 21:43:07 +02001588 {
1589 char_u *e, *dig;
1590 char_u *s = p;
1591 int x;
1592
1593 e = vim_strchr(p, ':');
1594 if (e == NULL || e[1] == NUL)
1595 return FAIL;
1596
1597 p = vim_strchr(e, ',');
1598 if (p == NULL)
1599 p = e + STRLEN(e);
1600 dig = e + 1;
1601 x = getdigits(&dig);
Bram Moolenaar79648732019-07-18 21:43:07 +02001602
1603 if (STRNCMP(s, "height:", 7) == 0)
1604 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001605 if (dig != p)
1606 return FAIL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001607 if (wp != NULL)
1608 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001609 if (is_preview)
1610 wp->w_minheight = x;
Bram Moolenaar79648732019-07-18 21:43:07 +02001611 wp->w_maxheight = x;
1612 }
1613 }
1614 else if (STRNCMP(s, "width:", 6) == 0)
1615 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001616 if (dig != p)
1617 return FAIL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001618 if (wp != NULL)
1619 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001620 if (is_preview)
1621 wp->w_minwidth = x;
Bram Moolenaar79648732019-07-18 21:43:07 +02001622 wp->w_maxwidth = x;
1623 }
1624 }
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001625 else if (STRNCMP(s, "highlight:", 10) == 0)
1626 {
1627 if (wp != NULL)
1628 {
1629 int c = *p;
1630
1631 *p = NUL;
1632 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
1633 s + 10, OPT_FREE|OPT_LOCAL, 0);
1634 *p = c;
1635 }
1636 }
Bram Moolenaarbd483b32019-08-21 15:13:41 +02001637 else if (STRNCMP(s, "border:", 7) == 0)
1638 {
1639 char_u *arg = s + 7;
1640 int on = STRNCMP(arg, "on", 2) == 0 && arg + 2 == p;
1641 int off = STRNCMP(arg, "off", 3) == 0 && arg + 3 == p;
1642 int i;
1643
1644 if (!on && !off)
1645 return FAIL;
1646 if (wp != NULL)
1647 {
1648 for (i = 0; i < 4; ++i)
1649 wp->w_popup_border[i] = on ? 1 : 0;
1650 if (off)
1651 // only show the X for close when there is a border
1652 wp->w_popup_close = POPCLOSE_NONE;
1653 }
1654 }
Bram Moolenaar258cef52019-08-21 17:29:29 +02001655 else if (STRNCMP(s, "align:", 6) == 0)
1656 {
1657 char_u *arg = s + 6;
1658 int item = STRNCMP(arg, "item", 4) == 0 && arg + 4 == p;
1659 int menu = STRNCMP(arg, "menu", 4) == 0 && arg + 4 == p;
1660
1661 if (!menu && !item)
1662 return FAIL;
1663 if (wp != NULL && menu)
1664 wp->w_popup_flags |= POPF_INFO_MENU;
1665 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001666 else
1667 return FAIL;
1668 }
1669 return OK;
1670}
1671
1672/*
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001673 * Parse the 'previewpopup' option and apply the values to window "wp" if it
1674 * is not NULL.
1675 * Return FAIL if the parsing fails.
1676 */
1677 int
1678parse_previewpopup(win_T *wp)
1679{
1680 return parse_popup_option(wp, TRUE);
1681}
1682
1683/*
1684 * Parse the 'completepopup' option and apply the values to window "wp" if it
1685 * is not NULL.
1686 * Return FAIL if the parsing fails.
1687 */
1688 int
1689parse_completepopup(win_T *wp)
1690{
1691 return parse_popup_option(wp, FALSE);
1692}
1693
1694/*
Bram Moolenaar79648732019-07-18 21:43:07 +02001695 * Set w_wantline and w_wantcol for the cursor position in the current window.
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001696 * Keep at least "width" columns from the right of the screen.
Bram Moolenaar79648732019-07-18 21:43:07 +02001697 */
1698 void
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001699popup_set_wantpos_cursor(win_T *wp, int width, dict_T *d)
Bram Moolenaar79648732019-07-18 21:43:07 +02001700{
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001701 poppos_T ppt = POPPOS_NONE;
1702
1703 if (d != NULL)
1704 ppt = get_pos_entry(d, FALSE);
1705
Bram Moolenaar79648732019-07-18 21:43:07 +02001706 setcursor_mayforce(TRUE);
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001707 if (ppt == POPPOS_TOPRIGHT || ppt == POPPOS_TOPLEFT)
Bram Moolenaar79648732019-07-18 21:43:07 +02001708 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001709 wp->w_wantline = curwin->w_winrow + curwin->w_wrow + 2;
1710 }
1711 else
1712 {
1713 wp->w_wantline = curwin->w_winrow + curwin->w_wrow;
1714 if (wp->w_wantline == 0) // cursor in first line
1715 {
1716 wp->w_wantline = 2;
1717 wp->w_popup_pos = ppt == POPPOS_BOTRIGHT
1718 ? POPPOS_TOPRIGHT : POPPOS_TOPLEFT;
1719 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001720 }
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001721
Bram Moolenaar79648732019-07-18 21:43:07 +02001722 wp->w_wantcol = curwin->w_wincol + curwin->w_wcol + 1;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001723 if (wp->w_wantcol > Columns - width)
1724 {
1725 wp->w_wantcol = Columns - width;
1726 if (wp->w_wantcol < 1)
1727 wp->w_wantcol = 1;
1728 }
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001729
Bram Moolenaar79648732019-07-18 21:43:07 +02001730 popup_adjust_position(wp);
1731}
1732
1733/*
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001734 * Set w_wantline and w_wantcol for the a given screen position.
1735 * Caller must take care of running into the window border.
1736 */
1737 void
1738popup_set_wantpos_rowcol(win_T *wp, int row, int col)
1739{
1740 wp->w_wantline = row;
1741 wp->w_wantcol = col;
1742 popup_adjust_position(wp);
1743}
1744
1745/*
1746 * Add a border and lef&right padding.
1747 */
1748 static void
1749add_border_left_right_padding(win_T *wp)
1750{
1751 int i;
1752
1753 for (i = 0; i < 4; ++i)
1754 {
1755 wp->w_popup_border[i] = 1;
1756 wp->w_popup_padding[i] = (i & 1) ? 1 : 0;
1757 }
1758}
1759
1760/*
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001761 * popup_create({text}, {options})
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02001762 * popup_atcursor({text}, {options})
Bram Moolenaar79648732019-07-18 21:43:07 +02001763 * etc.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001764 * When creating a preview or info popup "argvars" and "rettv" are NULL.
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001765 */
Bram Moolenaara730e552019-06-16 19:05:31 +02001766 static win_T *
Bram Moolenaar17627312019-06-02 19:53:44 +02001767popup_create(typval_T *argvars, typval_T *rettv, create_type_T type)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001768{
Bram Moolenaara3fce622019-06-20 02:31:49 +02001769 win_T *wp;
1770 tabpage_T *tp = NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001771 int tabnr = 0;
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001772 int new_buffer;
1773 buf_T *buf = NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001774 dict_T *d = NULL;
Bram Moolenaara3fce622019-06-20 02:31:49 +02001775 int nr;
1776 int i;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001777
Bram Moolenaar79648732019-07-18 21:43:07 +02001778 if (argvars != NULL)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001779 {
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02001780 // Check that arguments look OK.
Bram Moolenaar79648732019-07-18 21:43:07 +02001781 if (argvars[0].v_type == VAR_NUMBER)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001782 {
Bram Moolenaar49540192019-12-11 19:34:54 +01001783 buf = buflist_findnr(argvars[0].vval.v_number);
Bram Moolenaar79648732019-07-18 21:43:07 +02001784 if (buf == NULL)
1785 {
1786 semsg(_(e_nobufnr), argvars[0].vval.v_number);
1787 return NULL;
1788 }
1789 }
1790 else if (!(argvars[0].v_type == VAR_STRING
1791 && argvars[0].vval.v_string != NULL)
1792 && !(argvars[0].v_type == VAR_LIST
1793 && argvars[0].vval.v_list != NULL))
1794 {
Bram Moolenaar219c7d02020-02-01 21:57:29 +01001795 emsg(_("E450: buffer number, text or a list required"));
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001796 return NULL;
1797 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001798 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
Bram Moolenaara3fce622019-06-20 02:31:49 +02001799 {
Bram Moolenaar79648732019-07-18 21:43:07 +02001800 emsg(_(e_dictreq));
Bram Moolenaara3fce622019-06-20 02:31:49 +02001801 return NULL;
1802 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001803 d = argvars[1].vval.v_dict;
1804 }
1805
1806 if (d != NULL)
1807 {
1808 if (dict_find(d, (char_u *)"tabpage", -1) != NULL)
1809 tabnr = (int)dict_get_number(d, (char_u *)"tabpage");
1810 else if (type == TYPE_NOTIFICATION)
1811 tabnr = -1; // notifications are global by default
1812 else
1813 tabnr = 0;
1814 if (tabnr > 0)
1815 {
1816 tp = find_tabpage(tabnr);
1817 if (tp == NULL)
1818 {
1819 semsg(_("E997: Tabpage not found: %d"), tabnr);
1820 return NULL;
1821 }
1822 }
Bram Moolenaara3fce622019-06-20 02:31:49 +02001823 }
1824
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001825 // Create the window and buffer.
1826 wp = win_alloc_popup_win();
1827 if (wp == NULL)
Bram Moolenaara730e552019-06-16 19:05:31 +02001828 return NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001829 if (rettv != NULL)
1830 rettv->vval.v_number = wp->w_id;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001831 wp->w_popup_pos = POPPOS_TOPLEFT;
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001832 wp->w_popup_flags = POPF_IS_POPUP | POPF_MAPPING | POPF_POSINVERT;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001833
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001834 if (buf != NULL)
1835 {
1836 // use existing buffer
1837 new_buffer = FALSE;
Bram Moolenaar7866b872019-07-01 22:21:01 +02001838 win_init_popup_win(wp, buf);
Bram Moolenaar46451042019-08-24 15:50:46 +02001839 set_local_options_default(wp, FALSE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001840 buffer_ensure_loaded(buf);
1841 }
1842 else
1843 {
1844 // create a new buffer associated with the popup
1845 new_buffer = TRUE;
Bram Moolenaar00b0d6d2019-08-21 22:25:30 +02001846 buf = buflist_new(NULL, NULL, (linenr_T)0, BLN_NEW|BLN_DUMMY|BLN_REUSE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001847 if (buf == NULL)
1848 return NULL;
1849 ml_open(buf);
Bram Moolenaarcacc6a52019-05-30 15:22:43 +02001850
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001851 win_init_popup_win(wp, buf);
Bram Moolenaarcacc6a52019-05-30 15:22:43 +02001852
Bram Moolenaar46451042019-08-24 15:50:46 +02001853 set_local_options_default(wp, TRUE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001854 set_string_option_direct_in_buf(buf, (char_u *)"buftype", -1,
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001855 (char_u *)"popup", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001856 set_string_option_direct_in_buf(buf, (char_u *)"bufhidden", -1,
Bram Moolenaar79648732019-07-18 21:43:07 +02001857 (char_u *)"wipe", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001858 buf->b_p_ul = -1; // no undo
1859 buf->b_p_swf = FALSE; // no swap file
1860 buf->b_p_bl = FALSE; // unlisted buffer
1861 buf->b_locked = TRUE;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001862
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001863 // Avoid that 'buftype' is reset when this buffer is entered.
1864 buf->b_p_initialized = TRUE;
1865 }
Bram Moolenaara112f2d2019-09-01 17:38:09 +02001866 wp->w_p_wrap = TRUE; // 'wrap' is default on
1867 wp->w_p_so = 0; // 'scrolloff' zero
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001868
Bram Moolenaara3fce622019-06-20 02:31:49 +02001869 if (tp != NULL)
1870 {
1871 // popup on specified tab page
1872 wp->w_next = tp->tp_first_popupwin;
1873 tp->tp_first_popupwin = wp;
1874 }
1875 else if (tabnr == 0)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001876 {
Bram Moolenaarfc06cbb2019-06-15 14:14:31 +02001877 // popup on current tab page
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02001878 wp->w_next = curtab->tp_first_popupwin;
1879 curtab->tp_first_popupwin = wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001880 }
Bram Moolenaara3fce622019-06-20 02:31:49 +02001881 else // (tabnr < 0)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001882 {
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001883 win_T *prev = first_popupwin;
1884
1885 // Global popup: add at the end, so that it gets displayed on top of
1886 // older ones with the same zindex. Matters for notifications.
1887 if (first_popupwin == NULL)
1888 first_popupwin = wp;
1889 else
1890 {
1891 while (prev->w_next != NULL)
1892 prev = prev->w_next;
1893 prev->w_next = wp;
1894 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001895 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001896
Bram Moolenaar79648732019-07-18 21:43:07 +02001897 if (new_buffer && argvars != NULL)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001898 popup_set_buffer_text(buf, argvars[0]);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001899
Bram Moolenaar79648732019-07-18 21:43:07 +02001900 if (type == TYPE_ATCURSOR || type == TYPE_PREVIEW)
Bram Moolenaar17627312019-06-02 19:53:44 +02001901 {
1902 wp->w_popup_pos = POPPOS_BOTLEFT;
Bram Moolenaar79648732019-07-18 21:43:07 +02001903 }
1904 if (type == TYPE_ATCURSOR)
1905 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001906 popup_set_wantpos_cursor(wp, 0, d);
Bram Moolenaar17627312019-06-02 19:53:44 +02001907 set_moved_values(wp);
1908 set_moved_columns(wp, FIND_STRING);
1909 }
1910
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02001911 if (type == TYPE_BEVAL)
1912 {
1913 wp->w_popup_pos = POPPOS_BOTLEFT;
1914
1915 // by default use the mouse position
1916 wp->w_wantline = mouse_row;
1917 if (wp->w_wantline <= 0) // mouse on first line
1918 {
1919 wp->w_wantline = 2;
1920 wp->w_popup_pos = POPPOS_TOPLEFT;
1921 }
1922 wp->w_wantcol = mouse_col + 1;
1923 set_mousemoved_values(wp);
1924 set_mousemoved_columns(wp, FIND_IDENT + FIND_STRING + FIND_EVAL);
1925 }
1926
Bram Moolenaar33796b32019-06-08 16:01:13 +02001927 // set default values
1928 wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
Bram Moolenaar2e62b562019-06-30 18:07:00 +02001929 wp->w_popup_close = POPCLOSE_NONE;
Bram Moolenaar33796b32019-06-08 16:01:13 +02001930
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001931 if (type == TYPE_NOTIFICATION)
1932 {
1933 win_T *twp, *nextwin;
1934 int height = buf->b_ml.ml_line_count + 3;
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001935
1936 // Try to not overlap with another global popup. Guess we need 3
1937 // more screen lines than buffer lines.
1938 wp->w_wantline = 1;
1939 for (twp = first_popupwin; twp != NULL; twp = nextwin)
1940 {
1941 nextwin = twp->w_next;
1942 if (twp != wp
1943 && twp->w_zindex == POPUPWIN_NOTIFICATION_ZINDEX
1944 && twp->w_winrow <= wp->w_wantline - 1 + height
1945 && twp->w_winrow + popup_height(twp) > wp->w_wantline - 1)
1946 {
1947 // move to below this popup and restart the loop to check for
1948 // overlap with other popups
1949 wp->w_wantline = twp->w_winrow + popup_height(twp) + 1;
1950 nextwin = first_popupwin;
1951 }
1952 }
1953 if (wp->w_wantline + height > Rows)
1954 {
1955 // can't avoid overlap, put on top in the hope that message goes
1956 // away soon.
1957 wp->w_wantline = 1;
1958 }
1959
1960 wp->w_wantcol = 10;
1961 wp->w_zindex = POPUPWIN_NOTIFICATION_ZINDEX;
Bram Moolenaardfa97f22019-06-15 14:31:55 +02001962 wp->w_minwidth = 20;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02001963 wp->w_popup_flags |= POPF_DRAG;
Bram Moolenaar2e62b562019-06-30 18:07:00 +02001964 wp->w_popup_close = POPCLOSE_CLICK;
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001965 for (i = 0; i < 4; ++i)
1966 wp->w_popup_border[i] = 1;
1967 wp->w_popup_padding[1] = 1;
1968 wp->w_popup_padding[3] = 1;
Bram Moolenaardfa97f22019-06-15 14:31:55 +02001969
1970 nr = syn_name2id((char_u *)"PopupNotification");
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001971 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
Bram Moolenaardfa97f22019-06-15 14:31:55 +02001972 (char_u *)(nr == 0 ? "WarningMsg" : "PopupNotification"),
1973 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001974 }
1975
Bram Moolenaara730e552019-06-16 19:05:31 +02001976 if (type == TYPE_DIALOG || type == TYPE_MENU)
Bram Moolenaara42d9452019-06-15 21:46:30 +02001977 {
Bram Moolenaara42d9452019-06-15 21:46:30 +02001978 wp->w_popup_pos = POPPOS_CENTER;
1979 wp->w_zindex = POPUPWIN_DIALOG_ZINDEX;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02001980 wp->w_popup_flags |= POPF_DRAG;
Bram Moolenaar749fa0a2019-08-03 16:18:07 +02001981 wp->w_popup_flags &= ~POPF_MAPPING;
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001982 add_border_left_right_padding(wp);
Bram Moolenaara42d9452019-06-15 21:46:30 +02001983 }
1984
Bram Moolenaara730e552019-06-16 19:05:31 +02001985 if (type == TYPE_MENU)
1986 {
1987 typval_T tv;
1988 callback_T callback;
1989
1990 tv.v_type = VAR_STRING;
1991 tv.vval.v_string = (char_u *)"popup_filter_menu";
1992 callback = get_callback(&tv);
1993 if (callback.cb_name != NULL)
1994 set_callback(&wp->w_filter_cb, &callback);
1995
1996 wp->w_p_wrap = 0;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02001997 wp->w_popup_flags |= POPF_CURSORLINE;
Bram Moolenaara730e552019-06-16 19:05:31 +02001998 }
1999
Bram Moolenaar79648732019-07-18 21:43:07 +02002000 if (type == TYPE_PREVIEW)
2001 {
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002002 wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
Bram Moolenaar79648732019-07-18 21:43:07 +02002003 wp->w_popup_close = POPCLOSE_BUTTON;
2004 for (i = 0; i < 4; ++i)
2005 wp->w_popup_border[i] = 1;
2006 parse_previewpopup(wp);
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01002007 popup_set_wantpos_cursor(wp, wp->w_minwidth, d);
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002008 }
Bram Moolenaar36e4d982019-08-20 21:12:16 +02002009# ifdef FEAT_QUICKFIX
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002010 if (type == TYPE_INFO)
2011 {
2012 wp->w_popup_pos = POPPOS_TOPLEFT;
2013 wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
2014 wp->w_popup_close = POPCLOSE_BUTTON;
2015 add_border_left_right_padding(wp);
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002016 parse_completepopup(wp);
Bram Moolenaar79648732019-07-18 21:43:07 +02002017 }
Bram Moolenaar36e4d982019-08-20 21:12:16 +02002018# endif
Bram Moolenaar79648732019-07-18 21:43:07 +02002019
Bram Moolenaarae943152019-06-16 22:54:14 +02002020 for (i = 0; i < 4; ++i)
2021 VIM_CLEAR(wp->w_border_highlight[i]);
2022 for (i = 0; i < 8; ++i)
2023 wp->w_border_char[i] = 0;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002024 wp->w_want_scrollbar = 1;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02002025 wp->w_popup_fixed = 0;
Bram Moolenaar581ba392019-09-03 22:08:33 +02002026 wp->w_filter_mode = MODE_ALL;
Bram Moolenaarae943152019-06-16 22:54:14 +02002027
Bram Moolenaar79648732019-07-18 21:43:07 +02002028 if (d != NULL)
2029 // Deal with options.
2030 apply_options(wp, d);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002031
Bram Moolenaar0fcf26b2019-06-23 01:03:51 +02002032#ifdef FEAT_TIMERS
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002033 if (type == TYPE_NOTIFICATION && wp->w_popup_timer == NULL)
2034 popup_add_timeout(wp, 3000);
Bram Moolenaar0fcf26b2019-06-23 01:03:51 +02002035#endif
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002036
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002037 popup_adjust_position(wp);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002038
2039 wp->w_vsep_width = 0;
2040
2041 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002042 popup_mask_refresh = TRUE;
Bram Moolenaara730e552019-06-16 19:05:31 +02002043
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002044#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002045 // When running a terminal in the popup it becomes the current window.
2046 if (buf->b_term != NULL)
2047 win_enter(wp, FALSE);
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002048#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002049
Bram Moolenaara730e552019-06-16 19:05:31 +02002050 return wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002051}
2052
2053/*
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002054 * popup_clear()
2055 */
2056 void
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002057f_popup_clear(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002058{
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002059 int force = FALSE;
2060
2061 if (argvars[0].v_type != VAR_UNKNOWN)
2062 force = (int)tv_get_number(&argvars[0]);
2063 close_all_popups(force);
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002064}
2065
2066/*
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002067 * popup_create({text}, {options})
2068 */
2069 void
2070f_popup_create(typval_T *argvars, typval_T *rettv)
2071{
Bram Moolenaar17627312019-06-02 19:53:44 +02002072 popup_create(argvars, rettv, TYPE_NORMAL);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002073}
2074
2075/*
2076 * popup_atcursor({text}, {options})
2077 */
2078 void
2079f_popup_atcursor(typval_T *argvars, typval_T *rettv)
2080{
Bram Moolenaar17627312019-06-02 19:53:44 +02002081 popup_create(argvars, rettv, TYPE_ATCURSOR);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002082}
2083
2084/*
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002085 * popup_beval({text}, {options})
2086 */
2087 void
2088f_popup_beval(typval_T *argvars, typval_T *rettv)
2089{
2090 popup_create(argvars, rettv, TYPE_BEVAL);
2091}
2092
2093/*
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002094 * Invoke the close callback for window "wp" with value "result".
2095 * Careful: The callback may make "wp" invalid!
2096 */
2097 static void
2098invoke_popup_callback(win_T *wp, typval_T *result)
2099{
2100 typval_T rettv;
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002101 typval_T argv[3];
2102
2103 argv[0].v_type = VAR_NUMBER;
2104 argv[0].vval.v_number = (varnumber_T)wp->w_id;
2105
2106 if (result != NULL && result->v_type != VAR_UNKNOWN)
2107 copy_tv(result, &argv[1]);
2108 else
2109 {
2110 argv[1].v_type = VAR_NUMBER;
2111 argv[1].vval.v_number = 0;
2112 }
2113
2114 argv[2].v_type = VAR_UNKNOWN;
2115
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002116 call_callback(&wp->w_close_cb, -1, &rettv, 2, argv);
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002117 if (result != NULL)
2118 clear_tv(&argv[1]);
2119 clear_tv(&rettv);
2120}
2121
2122/*
Bram Moolenaar3397f742019-06-02 18:40:06 +02002123 * Close popup "wp" and invoke any close callback for it.
2124 */
2125 static void
2126popup_close_and_callback(win_T *wp, typval_T *arg)
2127{
2128 int id = wp->w_id;
2129
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002130#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002131 if (wp == curwin && curbuf->b_term != NULL)
2132 {
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002133 win_T *owp;
2134
2135 // Closing popup window with a terminal: put focus back on the first
2136 // that works:
2137 // - another popup window with a terminal
2138 // - the previous window
2139 // - the first one.
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002140 FOR_ALL_POPUPWINS(owp)
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002141 if (owp != curwin && owp->w_buffer->b_term != NULL)
2142 break;
2143 if (owp != NULL)
2144 win_enter(owp, FALSE);
2145 else
2146 {
2147 for (owp = curtab->tp_first_popupwin; owp != NULL;
2148 owp = owp->w_next)
2149 if (owp != curwin && owp->w_buffer->b_term != NULL)
2150 break;
2151 if (owp != NULL)
2152 win_enter(owp, FALSE);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002153 else if (win_valid(prevwin) && wp != prevwin)
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002154 win_enter(prevwin, FALSE);
2155 else
2156 win_enter(firstwin, FALSE);
2157 }
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002158 }
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002159#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002160
Bram Moolenaar49540192019-12-11 19:34:54 +01002161 // Just in case a check higher up is missing.
2162 if (wp == curwin && ERROR_IF_POPUP_WINDOW)
2163 return;
2164
Bram Moolenaarcee52202020-03-11 14:19:58 +01002165 CHECK_CURBUF;
Bram Moolenaar3397f742019-06-02 18:40:06 +02002166 if (wp->w_close_cb.cb_name != NULL)
2167 // Careful: This may make "wp" invalid.
2168 invoke_popup_callback(wp, arg);
2169
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002170 popup_close(id, FALSE);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002171 CHECK_CURBUF;
Bram Moolenaar3397f742019-06-02 18:40:06 +02002172}
2173
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002174 void
Bram Moolenaar12034e22019-08-25 22:25:02 +02002175popup_close_with_retval(win_T *wp, int retval)
2176{
2177 typval_T res;
2178
2179 res.v_type = VAR_NUMBER;
2180 res.vval.v_number = retval;
2181 popup_close_and_callback(wp, &res);
2182}
2183
Bram Moolenaar3397f742019-06-02 18:40:06 +02002184/*
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002185 * Close popup "wp" because of a mouse click.
2186 */
2187 void
2188popup_close_for_mouse_click(win_T *wp)
2189{
Bram Moolenaar12034e22019-08-25 22:25:02 +02002190 popup_close_with_retval(wp, -2);
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002191}
2192
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002193 static void
2194check_mouse_moved(win_T *wp, win_T *mouse_wp)
2195{
2196 // Close the popup when all if these are true:
2197 // - the mouse is not on this popup
2198 // - "mousemoved" was used
2199 // - the mouse is no longer on the same screen row or the mouse column is
2200 // outside of the relevant text
2201 if (wp != mouse_wp
2202 && wp->w_popup_mouse_row != 0
2203 && (wp->w_popup_mouse_row != mouse_row
2204 || mouse_col < wp->w_popup_mouse_mincol
2205 || mouse_col > wp->w_popup_mouse_maxcol))
2206 {
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002207 // Careful: this makes "wp" invalid.
Bram Moolenaar12034e22019-08-25 22:25:02 +02002208 popup_close_with_retval(wp, -2);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002209 }
2210}
2211
2212/*
2213 * Called when the mouse moved: may close a popup with "mousemoved".
2214 */
2215 void
2216popup_handle_mouse_moved(void)
2217{
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002218 win_T *wp, *nextwp;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002219 win_T *mouse_wp;
2220 int row = mouse_row;
2221 int col = mouse_col;
2222
2223 // find the window where the mouse is in
2224 mouse_wp = mouse_find_win(&row, &col, FIND_POPUP);
2225
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002226 for (wp = first_popupwin; wp != NULL; wp = nextwp)
2227 {
2228 nextwp = wp->w_next;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002229 check_mouse_moved(wp, mouse_wp);
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002230 }
2231 for (wp = curtab->tp_first_popupwin; wp != NULL; wp = nextwp)
2232 {
2233 nextwp = wp->w_next;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002234 check_mouse_moved(wp, mouse_wp);
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002235 }
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002236}
2237
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002238/*
Bram Moolenaara730e552019-06-16 19:05:31 +02002239 * In a filter: check if the typed key is a mouse event that is used for
2240 * dragging the popup.
2241 */
2242 static void
2243filter_handle_drag(win_T *wp, int c, typval_T *rettv)
2244{
2245 int row = mouse_row;
2246 int col = mouse_col;
2247
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002248 if ((wp->w_popup_flags & POPF_DRAG)
Bram Moolenaara730e552019-06-16 19:05:31 +02002249 && is_mouse_key(c)
2250 && (wp == popup_dragwin
2251 || wp == mouse_find_win(&row, &col, FIND_POPUP)))
2252 // do not consume the key, allow for dragging the popup
2253 rettv->vval.v_number = 0;
2254}
2255
Bram Moolenaara730e552019-06-16 19:05:31 +02002256/*
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002257 * popup_filter_menu({id}, {key})
Bram Moolenaara730e552019-06-16 19:05:31 +02002258 */
2259 void
2260f_popup_filter_menu(typval_T *argvars, typval_T *rettv)
2261{
2262 int id = tv_get_number(&argvars[0]);
2263 win_T *wp = win_id2wp(id);
2264 char_u *key = tv_get_string(&argvars[1]);
2265 typval_T res;
2266 int c;
2267 linenr_T old_lnum;
2268
2269 // If the popup has been closed do not consume the key.
2270 if (wp == NULL)
2271 return;
2272
2273 c = *key;
2274 if (c == K_SPECIAL && key[1] != NUL)
2275 c = TO_SPECIAL(key[1], key[2]);
2276
2277 // consume all keys until done
2278 rettv->vval.v_number = 1;
2279 res.v_type = VAR_NUMBER;
2280
2281 old_lnum = wp->w_cursor.lnum;
2282 if ((c == 'k' || c == 'K' || c == K_UP) && wp->w_cursor.lnum > 1)
2283 --wp->w_cursor.lnum;
2284 if ((c == 'j' || c == 'J' || c == K_DOWN)
2285 && wp->w_cursor.lnum < wp->w_buffer->b_ml.ml_line_count)
2286 ++wp->w_cursor.lnum;
2287 if (old_lnum != wp->w_cursor.lnum)
2288 {
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002289 // caller will call popup_highlight_curline()
Bram Moolenaara730e552019-06-16 19:05:31 +02002290 return;
2291 }
2292
2293 if (c == 'x' || c == 'X' || c == ESC || c == Ctrl_C)
2294 {
2295 // Cancelled, invoke callback with -1
2296 res.vval.v_number = -1;
2297 popup_close_and_callback(wp, &res);
2298 return;
2299 }
2300 if (c == ' ' || c == K_KENTER || c == CAR || c == NL)
2301 {
2302 // Invoke callback with current index.
2303 res.vval.v_number = wp->w_cursor.lnum;
2304 popup_close_and_callback(wp, &res);
2305 return;
2306 }
2307
2308 filter_handle_drag(wp, c, rettv);
2309}
2310
2311/*
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002312 * popup_filter_yesno({id}, {key})
Bram Moolenaara42d9452019-06-15 21:46:30 +02002313 */
2314 void
2315f_popup_filter_yesno(typval_T *argvars, typval_T *rettv)
2316{
2317 int id = tv_get_number(&argvars[0]);
2318 win_T *wp = win_id2wp(id);
2319 char_u *key = tv_get_string(&argvars[1]);
2320 typval_T res;
Bram Moolenaara730e552019-06-16 19:05:31 +02002321 int c;
Bram Moolenaara42d9452019-06-15 21:46:30 +02002322
2323 // If the popup has been closed don't consume the key.
2324 if (wp == NULL)
2325 return;
2326
Bram Moolenaara730e552019-06-16 19:05:31 +02002327 c = *key;
2328 if (c == K_SPECIAL && key[1] != NUL)
2329 c = TO_SPECIAL(key[1], key[2]);
2330
Bram Moolenaara42d9452019-06-15 21:46:30 +02002331 // consume all keys until done
2332 rettv->vval.v_number = 1;
2333
Bram Moolenaara730e552019-06-16 19:05:31 +02002334 if (c == 'y' || c == 'Y')
Bram Moolenaara42d9452019-06-15 21:46:30 +02002335 res.vval.v_number = 1;
Bram Moolenaara730e552019-06-16 19:05:31 +02002336 else if (c == 'n' || c == 'N' || c == 'x' || c == 'X' || c == ESC)
Bram Moolenaara42d9452019-06-15 21:46:30 +02002337 res.vval.v_number = 0;
2338 else
2339 {
Bram Moolenaara730e552019-06-16 19:05:31 +02002340 filter_handle_drag(wp, c, rettv);
Bram Moolenaara42d9452019-06-15 21:46:30 +02002341 return;
2342 }
2343
2344 // Invoke callback
2345 res.v_type = VAR_NUMBER;
2346 popup_close_and_callback(wp, &res);
2347}
2348
2349/*
2350 * popup_dialog({text}, {options})
2351 */
2352 void
2353f_popup_dialog(typval_T *argvars, typval_T *rettv)
2354{
2355 popup_create(argvars, rettv, TYPE_DIALOG);
2356}
2357
2358/*
Bram Moolenaara730e552019-06-16 19:05:31 +02002359 * popup_menu({text}, {options})
2360 */
2361 void
2362f_popup_menu(typval_T *argvars, typval_T *rettv)
2363{
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02002364 popup_create(argvars, rettv, TYPE_MENU);
Bram Moolenaara730e552019-06-16 19:05:31 +02002365}
2366
2367/*
Bram Moolenaara42d9452019-06-15 21:46:30 +02002368 * popup_notification({text}, {options})
2369 */
2370 void
2371f_popup_notification(typval_T *argvars, typval_T *rettv)
2372{
2373 popup_create(argvars, rettv, TYPE_NOTIFICATION);
2374}
2375
2376/*
2377 * Find the popup window with window-ID "id".
2378 * If the popup window does not exist NULL is returned.
2379 * If the window is not a popup window, and error message is given.
2380 */
2381 static win_T *
2382find_popup_win(int id)
2383{
2384 win_T *wp = win_id2wp(id);
2385
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002386 if (wp != NULL && !WIN_IS_POPUP(wp))
Bram Moolenaara42d9452019-06-15 21:46:30 +02002387 {
2388 semsg(_("E993: window %d is not a popup window"), id);
2389 return NULL;
2390 }
2391 return wp;
2392}
2393
2394/*
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002395 * popup_close({id})
2396 */
2397 void
2398f_popup_close(typval_T *argvars, typval_T *rettv UNUSED)
2399{
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002400 int id = (int)tv_get_number(argvars);
Bram Moolenaar49540192019-12-11 19:34:54 +01002401 win_T *wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002402
Bram Moolenaar11ec8072020-02-20 20:12:29 +01002403 if (
2404# ifdef FEAT_TERMINAL
2405 // if the popup contains a terminal it will become hidden
2406 curbuf->b_term == NULL &&
2407# endif
2408 ERROR_IF_ANY_POPUP_WINDOW)
Bram Moolenaar49540192019-12-11 19:34:54 +01002409 return;
2410
2411 wp = find_popup_win(id);
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002412 if (wp != NULL)
Bram Moolenaar3397f742019-06-02 18:40:06 +02002413 popup_close_and_callback(wp, &argvars[1]);
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002414}
2415
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002416 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002417popup_hide(win_T *wp)
2418{
Bram Moolenaar2e6638d2020-02-05 21:07:18 +01002419#ifdef FEAT_TERMINAL
2420 if (error_if_term_popup_window())
2421 return;
2422#endif
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002423 if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
2424 {
2425 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaarca7c0782020-01-14 20:42:48 +01002426 // Do not decrement b_nwindows, we still reference the buffer.
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002427 redraw_all_later(NOT_VALID);
2428 popup_mask_refresh = TRUE;
2429 }
2430}
2431
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002432/*
2433 * popup_hide({id})
2434 */
2435 void
2436f_popup_hide(typval_T *argvars, typval_T *rettv UNUSED)
2437{
2438 int id = (int)tv_get_number(argvars);
2439 win_T *wp = find_popup_win(id);
2440
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002441 if (wp != NULL)
2442 popup_hide(wp);
2443}
2444
2445 void
2446popup_show(win_T *wp)
2447{
2448 if ((wp->w_popup_flags & POPF_HIDDEN) != 0)
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002449 {
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002450 wp->w_popup_flags &= ~POPF_HIDDEN;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002451 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002452 popup_mask_refresh = TRUE;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002453 }
2454}
2455
2456/*
2457 * popup_show({id})
2458 */
2459 void
2460f_popup_show(typval_T *argvars, typval_T *rettv UNUSED)
2461{
2462 int id = (int)tv_get_number(argvars);
2463 win_T *wp = find_popup_win(id);
2464
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002465 if (wp != NULL)
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002466 {
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002467 popup_show(wp);
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01002468#ifdef FEAT_QUICKFIX
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002469 if (wp->w_popup_flags & POPF_INFO)
2470 pum_position_info_popup(wp);
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01002471#endif
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002472 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002473}
2474
Bram Moolenaardc2ce582019-06-16 15:32:14 +02002475/*
2476 * popup_settext({id}, {text})
2477 */
2478 void
2479f_popup_settext(typval_T *argvars, typval_T *rettv UNUSED)
2480{
2481 int id = (int)tv_get_number(&argvars[0]);
2482 win_T *wp = find_popup_win(id);
2483
2484 if (wp != NULL)
2485 {
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002486 if (argvars[1].v_type != VAR_STRING && argvars[1].v_type != VAR_LIST)
2487 semsg(_(e_invarg2), tv_get_string(&argvars[1]));
2488 else
2489 {
2490 popup_set_buffer_text(wp->w_buffer, argvars[1]);
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02002491 redraw_win_later(wp, NOT_VALID);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002492 popup_adjust_position(wp);
2493 }
Bram Moolenaardc2ce582019-06-16 15:32:14 +02002494 }
2495}
2496
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002497 static void
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002498popup_free(win_T *wp)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002499{
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002500 sign_undefine_by_name(popup_get_sign_name(wp), FALSE);
Bram Moolenaar868b7b62019-05-29 21:44:40 +02002501 wp->w_buffer->b_locked = FALSE;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02002502 if (wp->w_winrow + popup_height(wp) >= cmdline_row)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002503 clear_cmdline = TRUE;
2504 win_free_popup(wp);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002505
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002506 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002507 popup_mask_refresh = TRUE;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002508}
2509
Bram Moolenaar82106932020-03-13 14:34:38 +01002510 static void
2511error_for_popup_window(void)
2512{
2513 emsg(_("E994: Not allowed in a popup window"));
2514}
2515
2516 int
2517error_if_popup_window(int also_with_term UNUSED)
2518{
2519 // win_execute() may set "curwin" to a popup window temporarily, but many
2520 // commands are disallowed then. When a terminal runs in the popup most
2521 // things are allowed. When a terminal is finished it can be closed.
2522 if (WIN_IS_POPUP(curwin)
2523# ifdef FEAT_TERMINAL
2524 && (also_with_term || curbuf->b_term == NULL)
2525 && !term_is_finished(curbuf)
2526# endif
2527 )
2528 {
2529 error_for_popup_window();
2530 return TRUE;
2531 }
2532 return FALSE;
2533}
2534
Bram Moolenaarec583842019-05-26 14:11:23 +02002535/*
2536 * Close a popup window by Window-id.
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002537 * Does not invoke the callback.
Bram Moolenaard502aa42020-05-13 01:04:32 +02002538 * Return OK if the popup was closed, FAIL otherwise.
Bram Moolenaarec583842019-05-26 14:11:23 +02002539 */
Bram Moolenaard502aa42020-05-13 01:04:32 +02002540 int
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002541popup_close(int id, int force)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002542{
2543 win_T *wp;
Bram Moolenaarec583842019-05-26 14:11:23 +02002544 tabpage_T *tp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002545 win_T *prev = NULL;
2546
Bram Moolenaarec583842019-05-26 14:11:23 +02002547 // go through global popups
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002548 for (wp = first_popupwin; wp != NULL; prev = wp, wp = wp->w_next)
Bram Moolenaarec583842019-05-26 14:11:23 +02002549 if (wp->w_id == id)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002550 {
Bram Moolenaarcee52202020-03-11 14:19:58 +01002551 if (wp == curwin)
2552 {
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002553 if (!force)
2554 {
2555 error_for_popup_window();
2556 return FAIL;
2557 }
2558 win_enter(firstwin, FALSE);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002559 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002560 if (prev == NULL)
2561 first_popupwin = wp->w_next;
2562 else
2563 prev->w_next = wp->w_next;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002564 popup_free(wp);
Bram Moolenaard502aa42020-05-13 01:04:32 +02002565 return OK;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002566 }
2567
Bram Moolenaarec583842019-05-26 14:11:23 +02002568 // go through tab-local popups
2569 FOR_ALL_TABPAGES(tp)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002570 if (popup_close_tabpage(tp, id, force) == OK)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002571 return OK;
2572 return FAIL;
Bram Moolenaarec583842019-05-26 14:11:23 +02002573}
2574
2575/*
2576 * Close a popup window with Window-id "id" in tabpage "tp".
2577 */
Bram Moolenaard502aa42020-05-13 01:04:32 +02002578 int
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002579popup_close_tabpage(tabpage_T *tp, int id, int force)
Bram Moolenaarec583842019-05-26 14:11:23 +02002580{
2581 win_T *wp;
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02002582 win_T **root = &tp->tp_first_popupwin;
Bram Moolenaarec583842019-05-26 14:11:23 +02002583 win_T *prev = NULL;
2584
Bram Moolenaarec583842019-05-26 14:11:23 +02002585 for (wp = *root; wp != NULL; prev = wp, wp = wp->w_next)
2586 if (wp->w_id == id)
2587 {
Bram Moolenaarcee52202020-03-11 14:19:58 +01002588 if (wp == curwin)
2589 {
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002590 if (!force)
2591 {
2592 error_for_popup_window();
2593 return FAIL;
2594 }
2595 win_enter(firstwin, FALSE);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002596 }
Bram Moolenaarec583842019-05-26 14:11:23 +02002597 if (prev == NULL)
2598 *root = wp->w_next;
2599 else
2600 prev->w_next = wp->w_next;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002601 popup_free(wp);
Bram Moolenaard502aa42020-05-13 01:04:32 +02002602 return OK;
Bram Moolenaarec583842019-05-26 14:11:23 +02002603 }
Bram Moolenaard502aa42020-05-13 01:04:32 +02002604 return FAIL;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002605}
2606
2607 void
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002608close_all_popups(int force)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002609{
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002610 if (!force && ERROR_IF_ANY_POPUP_WINDOW)
Bram Moolenaar8bf716c2020-01-23 15:33:54 +01002611 return;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002612 while (first_popupwin != NULL)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002613 if (popup_close(first_popupwin->w_id, force) == FAIL)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002614 return;
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02002615 while (curtab->tp_first_popupwin != NULL)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002616 if (popup_close(curtab->tp_first_popupwin->w_id, force) == FAIL)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002617 return;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002618}
2619
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002620/*
2621 * popup_move({id}, {options})
2622 */
2623 void
2624f_popup_move(typval_T *argvars, typval_T *rettv UNUSED)
2625{
Bram Moolenaarae943152019-06-16 22:54:14 +02002626 dict_T *dict;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002627 int id = (int)tv_get_number(argvars);
2628 win_T *wp = find_popup_win(id);
2629
2630 if (wp == NULL)
2631 return; // invalid {id}
2632
2633 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
2634 {
2635 emsg(_(e_dictreq));
2636 return;
2637 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002638 dict = argvars[1].vval.v_dict;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002639
Bram Moolenaarae943152019-06-16 22:54:14 +02002640 apply_move_options(wp, dict);
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002641
2642 if (wp->w_winrow + wp->w_height >= cmdline_row)
2643 clear_cmdline = TRUE;
2644 popup_adjust_position(wp);
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002645}
2646
Bram Moolenaarbc133542019-05-29 20:26:46 +02002647/*
Bram Moolenaarae943152019-06-16 22:54:14 +02002648 * popup_setoptions({id}, {options})
2649 */
2650 void
2651f_popup_setoptions(typval_T *argvars, typval_T *rettv UNUSED)
2652{
2653 dict_T *dict;
2654 int id = (int)tv_get_number(argvars);
2655 win_T *wp = find_popup_win(id);
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002656 linenr_T old_firstline;
Bram Moolenaarae943152019-06-16 22:54:14 +02002657
2658 if (wp == NULL)
2659 return; // invalid {id}
2660
2661 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
2662 {
2663 emsg(_(e_dictreq));
2664 return;
2665 }
2666 dict = argvars[1].vval.v_dict;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002667 old_firstline = wp->w_firstline;
Bram Moolenaarae943152019-06-16 22:54:14 +02002668
2669 apply_move_options(wp, dict);
2670 apply_general_options(wp, dict);
2671
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002672 if (old_firstline != wp->w_firstline)
2673 redraw_win_later(wp, NOT_VALID);
Bram Moolenaarad24a712019-06-17 20:05:45 +02002674 popup_mask_refresh = TRUE;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02002675 popup_highlight_curline(wp);
Bram Moolenaarae943152019-06-16 22:54:14 +02002676 popup_adjust_position(wp);
2677}
2678
2679/*
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002680 * popup_getpos({id})
Bram Moolenaarbc133542019-05-29 20:26:46 +02002681 */
2682 void
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002683f_popup_getpos(typval_T *argvars, typval_T *rettv)
Bram Moolenaarbc133542019-05-29 20:26:46 +02002684{
2685 dict_T *dict;
2686 int id = (int)tv_get_number(argvars);
2687 win_T *wp = find_popup_win(id);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002688 int top_extra;
2689 int left_extra;
Bram Moolenaarbc133542019-05-29 20:26:46 +02002690
2691 if (rettv_dict_alloc(rettv) == OK)
2692 {
2693 if (wp == NULL)
2694 return; // invalid {id}
Bram Moolenaareb2310d2019-06-16 20:09:10 +02002695 top_extra = popup_top_extra(wp);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002696 left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
2697
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002698 // we know how much space we need, avoid resizing halfway
Bram Moolenaarbc133542019-05-29 20:26:46 +02002699 dict = rettv->vval.v_dict;
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002700 hash_lock_size(&dict->dv_hashtab, 11);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002701
Bram Moolenaarbc133542019-05-29 20:26:46 +02002702 dict_add_number(dict, "line", wp->w_winrow + 1);
2703 dict_add_number(dict, "col", wp->w_wincol + 1);
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002704 dict_add_number(dict, "width", wp->w_width + left_extra
2705 + wp->w_popup_border[1] + wp->w_popup_padding[1]);
2706 dict_add_number(dict, "height", wp->w_height + top_extra
2707 + wp->w_popup_border[2] + wp->w_popup_padding[2]);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002708
2709 dict_add_number(dict, "core_line", wp->w_winrow + 1 + top_extra);
2710 dict_add_number(dict, "core_col", wp->w_wincol + 1 + left_extra);
2711 dict_add_number(dict, "core_width", wp->w_width);
2712 dict_add_number(dict, "core_height", wp->w_height);
2713
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002714 dict_add_number(dict, "scrollbar", wp->w_has_scrollbar);
Bram Moolenaar68acb412019-06-26 03:40:36 +02002715 dict_add_number(dict, "firstline", wp->w_topline);
Bram Moolenaar30efcf32019-11-03 22:29:38 +01002716 dict_add_number(dict, "lastline", wp->w_botline - 1);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002717 dict_add_number(dict, "visible",
Bram Moolenaarb0ebbda2019-06-02 16:51:21 +02002718 win_valid(wp) && (wp->w_popup_flags & POPF_HIDDEN) == 0);
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002719
2720 hash_unlock(&dict->dv_hashtab);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002721 }
2722}
Bram Moolenaaref6b9792020-05-13 16:34:15 +02002723
2724/*
2725 * popup_list()
2726 */
2727 void
2728f_popup_list(typval_T *argvars UNUSED, typval_T *rettv)
2729{
2730 win_T *wp;
2731 tabpage_T *tp;
2732
2733 if (rettv_list_alloc(rettv) != OK)
2734 return;
2735 FOR_ALL_POPUPWINS(wp)
2736 list_append_number(rettv->vval.v_list, wp->w_id);
2737 FOR_ALL_TABPAGES(tp)
2738 FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
2739 list_append_number(rettv->vval.v_list, wp->w_id);
2740}
2741
Bram Moolenaarb4f06282019-07-12 21:07:54 +02002742/*
2743 * popup_locate({row}, {col})
2744 */
2745 void
2746f_popup_locate(typval_T *argvars, typval_T *rettv)
2747{
2748 int row = tv_get_number(&argvars[0]) - 1;
2749 int col = tv_get_number(&argvars[1]) - 1;
2750 win_T *wp;
2751
2752 wp = mouse_find_win(&row, &col, FIND_POPUP);
Bram Moolenaarfd318112019-11-22 19:22:08 +01002753 if (wp != NULL && WIN_IS_POPUP(wp))
Bram Moolenaarb4f06282019-07-12 21:07:54 +02002754 rettv->vval.v_number = wp->w_id;
2755}
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002756
2757/*
Bram Moolenaarae943152019-06-16 22:54:14 +02002758 * For popup_getoptions(): add a "border" or "padding" entry to "dict".
2759 */
2760 static void
2761get_padding_border(dict_T *dict, int *array, char *name)
2762{
2763 list_T *list;
2764 int i;
2765
2766 if (array[0] == 0 && array[1] == 0 && array[2] == 0 && array[3] == 0)
2767 return;
2768
2769 list = list_alloc();
2770 if (list != NULL)
2771 {
2772 dict_add_list(dict, name, list);
2773 if (array[0] != 1 || array[1] != 1 || array[2] != 1 || array[3] != 1)
2774 for (i = 0; i < 4; ++i)
2775 list_append_number(list, array[i]);
2776 }
2777}
2778
2779/*
2780 * For popup_getoptions(): add a "borderhighlight" entry to "dict".
2781 */
2782 static void
2783get_borderhighlight(dict_T *dict, win_T *wp)
2784{
2785 list_T *list;
2786 int i;
2787
2788 for (i = 0; i < 4; ++i)
2789 if (wp->w_border_highlight[i] != NULL)
2790 break;
2791 if (i == 4)
2792 return;
2793
2794 list = list_alloc();
2795 if (list != NULL)
2796 {
2797 dict_add_list(dict, "borderhighlight", list);
2798 for (i = 0; i < 4; ++i)
2799 list_append_string(list, wp->w_border_highlight[i], -1);
2800 }
2801}
2802
2803/*
2804 * For popup_getoptions(): add a "borderchars" entry to "dict".
2805 */
2806 static void
2807get_borderchars(dict_T *dict, win_T *wp)
2808{
2809 list_T *list;
2810 int i;
2811 char_u buf[NUMBUFLEN];
2812 int len;
2813
2814 for (i = 0; i < 8; ++i)
2815 if (wp->w_border_char[i] != 0)
2816 break;
2817 if (i == 8)
2818 return;
2819
2820 list = list_alloc();
2821 if (list != NULL)
2822 {
2823 dict_add_list(dict, "borderchars", list);
2824 for (i = 0; i < 8; ++i)
2825 {
2826 len = mb_char2bytes(wp->w_border_char[i], buf);
2827 list_append_string(list, buf, len);
2828 }
2829 }
2830}
2831
2832/*
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002833 * For popup_getoptions(): add a "moved" and "mousemoved" entry to "dict".
Bram Moolenaarae943152019-06-16 22:54:14 +02002834 */
2835 static void
2836get_moved_list(dict_T *dict, win_T *wp)
2837{
2838 list_T *list;
2839
2840 list = list_alloc();
2841 if (list != NULL)
2842 {
2843 dict_add_list(dict, "moved", list);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002844 list_append_number(list, wp->w_popup_lnum);
Bram Moolenaarae943152019-06-16 22:54:14 +02002845 list_append_number(list, wp->w_popup_mincol);
2846 list_append_number(list, wp->w_popup_maxcol);
2847 }
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002848 list = list_alloc();
2849 if (list != NULL)
2850 {
2851 dict_add_list(dict, "mousemoved", list);
2852 list_append_number(list, wp->w_popup_mouse_row);
2853 list_append_number(list, wp->w_popup_mouse_mincol);
2854 list_append_number(list, wp->w_popup_mouse_maxcol);
2855 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002856}
2857
2858/*
Bram Moolenaar33796b32019-06-08 16:01:13 +02002859 * popup_getoptions({id})
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002860 */
2861 void
2862f_popup_getoptions(typval_T *argvars, typval_T *rettv)
2863{
2864 dict_T *dict;
2865 int id = (int)tv_get_number(argvars);
2866 win_T *wp = find_popup_win(id);
Bram Moolenaara3fce622019-06-20 02:31:49 +02002867 tabpage_T *tp;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002868 int i;
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002869
2870 if (rettv_dict_alloc(rettv) == OK)
2871 {
2872 if (wp == NULL)
2873 return;
2874
2875 dict = rettv->vval.v_dict;
2876 dict_add_number(dict, "line", wp->w_wantline);
2877 dict_add_number(dict, "col", wp->w_wantcol);
2878 dict_add_number(dict, "minwidth", wp->w_minwidth);
2879 dict_add_number(dict, "minheight", wp->w_minheight);
2880 dict_add_number(dict, "maxheight", wp->w_maxheight);
2881 dict_add_number(dict, "maxwidth", wp->w_maxwidth);
Bram Moolenaar8d241042019-06-12 23:40:01 +02002882 dict_add_number(dict, "firstline", wp->w_firstline);
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002883 dict_add_number(dict, "scrollbar", wp->w_want_scrollbar);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002884 dict_add_number(dict, "zindex", wp->w_zindex);
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02002885 dict_add_number(dict, "fixed", wp->w_popup_fixed);
Bram Moolenaar12034e22019-08-25 22:25:02 +02002886 if (wp->w_popup_prop_type && win_valid(wp->w_popup_prop_win))
2887 {
2888 proptype_T *pt = text_prop_type_by_id(
2889 wp->w_popup_prop_win->w_buffer,
2890 wp->w_popup_prop_type);
2891
2892 if (pt != NULL)
2893 dict_add_string(dict, "textprop", pt->pt_name);
2894 dict_add_number(dict, "textpropwin", wp->w_popup_prop_win->w_id);
2895 dict_add_number(dict, "textpropid", wp->w_popup_prop_id);
2896 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002897 dict_add_string(dict, "title", wp->w_popup_title);
2898 dict_add_number(dict, "wrap", wp->w_p_wrap);
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002899 dict_add_number(dict, "drag", (wp->w_popup_flags & POPF_DRAG) != 0);
Bram Moolenaar12034e22019-08-25 22:25:02 +02002900 dict_add_number(dict, "mapping",
2901 (wp->w_popup_flags & POPF_MAPPING) != 0);
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002902 dict_add_number(dict, "resize", (wp->w_popup_flags & POPF_RESIZE) != 0);
Bram Moolenaar638a4a72019-11-06 19:25:22 +01002903 dict_add_number(dict, "posinvert",
2904 (wp->w_popup_flags & POPF_POSINVERT) != 0);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002905 dict_add_number(dict, "cursorline",
2906 (wp->w_popup_flags & POPF_CURSORLINE) != 0);
Bram Moolenaarae943152019-06-16 22:54:14 +02002907 dict_add_string(dict, "highlight", wp->w_p_wcr);
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02002908 if (wp->w_scrollbar_highlight != NULL)
2909 dict_add_string(dict, "scrollbarhighlight",
2910 wp->w_scrollbar_highlight);
2911 if (wp->w_thumb_highlight != NULL)
2912 dict_add_string(dict, "thumbhighlight", wp->w_thumb_highlight);
Bram Moolenaarae943152019-06-16 22:54:14 +02002913
Bram Moolenaara3fce622019-06-20 02:31:49 +02002914 // find the tabpage that holds this popup
2915 i = 1;
2916 FOR_ALL_TABPAGES(tp)
2917 {
Bram Moolenaar1824f452019-10-02 23:06:46 +02002918 win_T *twp;
Bram Moolenaara3fce622019-06-20 02:31:49 +02002919
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002920 FOR_ALL_POPUPWINS_IN_TAB(tp, twp)
2921 if (twp->w_id == id)
2922 break;
2923 if (twp != NULL)
2924 break;
2925 ++i;
Bram Moolenaara3fce622019-06-20 02:31:49 +02002926 }
2927 if (tp == NULL)
2928 i = -1; // must be global
2929 else if (tp == curtab)
2930 i = 0;
2931 dict_add_number(dict, "tabpage", i);
2932
Bram Moolenaarae943152019-06-16 22:54:14 +02002933 get_padding_border(dict, wp->w_popup_padding, "padding");
2934 get_padding_border(dict, wp->w_popup_border, "border");
2935 get_borderhighlight(dict, wp);
2936 get_borderchars(dict, wp);
2937 get_moved_list(dict, wp);
2938
2939 if (wp->w_filter_cb.cb_name != NULL)
2940 dict_add_callback(dict, "filter", &wp->w_filter_cb);
2941 if (wp->w_close_cb.cb_name != NULL)
2942 dict_add_callback(dict, "callback", &wp->w_close_cb);
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002943
2944 for (i = 0; i < (int)(sizeof(poppos_entries) / sizeof(poppos_entry_T));
2945 ++i)
2946 if (wp->w_popup_pos == poppos_entries[i].pp_val)
2947 {
2948 dict_add_string(dict, "pos",
2949 (char_u *)poppos_entries[i].pp_name);
2950 break;
2951 }
2952
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002953 dict_add_string(dict, "close", (char_u *)(
2954 wp->w_popup_close == POPCLOSE_BUTTON ? "button"
2955 : wp->w_popup_close == POPCLOSE_CLICK ? "click" : "none"));
2956
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002957# if defined(FEAT_TIMERS)
2958 dict_add_number(dict, "time", wp->w_popup_timer != NULL
2959 ? (long)wp->w_popup_timer->tr_interval : 0L);
2960# endif
Bram Moolenaarbc133542019-05-29 20:26:46 +02002961 }
2962}
Bram Moolenaar815b76b2019-06-01 14:15:52 +02002963
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002964# if defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaard98c0b62020-02-02 15:25:16 +01002965/*
2966 * Return TRUE if the current window is running a terminal in a popup window.
2967 * Return FALSE when the job has ended.
2968 */
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002969 int
2970error_if_term_popup_window()
2971{
Bram Moolenaard98c0b62020-02-02 15:25:16 +01002972 if (WIN_IS_POPUP(curwin) && curbuf->b_term != NULL
2973 && term_job_running(curbuf->b_term))
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002974 {
Bram Moolenaara5edb672020-02-03 22:58:48 +01002975 emsg(_("E863: Not allowed for a terminal in a popup window"));
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002976 return TRUE;
2977 }
2978 return FALSE;
2979}
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002980# endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002981
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02002982/*
Bram Moolenaarafe45b62019-11-13 22:35:19 +01002983 * Reset all the "handled_flag" flags in global popup windows and popup windows
Bram Moolenaarfc06cbb2019-06-15 14:14:31 +02002984 * in the current tab page.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01002985 * Each calling function should use a different flag, see the list at
2986 * POPUP_HANDLED_1. This won't work with recursive calls though.
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02002987 */
2988 void
Bram Moolenaarafe45b62019-11-13 22:35:19 +01002989popup_reset_handled(int handled_flag)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02002990{
2991 win_T *wp;
2992
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002993 FOR_ALL_POPUPWINS(wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01002994 wp->w_popup_handled &= ~handled_flag;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002995 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01002996 wp->w_popup_handled &= ~handled_flag;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02002997}
2998
2999/*
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003000 * Find the next visible popup where "handled_flag" is not set.
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003001 * Must have called popup_reset_handled() first.
3002 * When "lowest" is TRUE find the popup with the lowest zindex, otherwise the
3003 * popup with the highest zindex.
3004 */
3005 win_T *
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003006find_next_popup(int lowest, int handled_flag)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003007{
3008 win_T *wp;
3009 win_T *found_wp;
3010 int found_zindex;
3011
3012 found_zindex = lowest ? INT_MAX : 0;
3013 found_wp = NULL;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003014 FOR_ALL_POPUPWINS(wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003015 if ((wp->w_popup_handled & handled_flag) == 0
3016 && (wp->w_popup_flags & POPF_HIDDEN) == 0
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003017 && (lowest ? wp->w_zindex < found_zindex
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003018 : wp->w_zindex > found_zindex))
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003019 {
3020 found_zindex = wp->w_zindex;
3021 found_wp = wp;
3022 }
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003023 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003024 if ((wp->w_popup_handled & handled_flag) == 0
3025 && (wp->w_popup_flags & POPF_HIDDEN) == 0
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003026 && (lowest ? wp->w_zindex < found_zindex
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003027 : wp->w_zindex > found_zindex))
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003028 {
3029 found_zindex = wp->w_zindex;
3030 found_wp = wp;
3031 }
3032
3033 if (found_wp != NULL)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003034 found_wp->w_popup_handled |= handled_flag;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003035 return found_wp;
3036}
3037
3038/*
3039 * Invoke the filter callback for window "wp" with typed character "c".
3040 * Uses the global "mod_mask" for modifiers.
3041 * Returns the return value of the filter.
3042 * Careful: The filter may make "wp" invalid!
3043 */
3044 static int
3045invoke_popup_filter(win_T *wp, int c)
3046{
3047 int res;
3048 typval_T rettv;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003049 typval_T argv[3];
3050 char_u buf[NUMBUFLEN];
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02003051 linenr_T old_lnum = wp->w_cursor.lnum;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003052
Bram Moolenaara42d9452019-06-15 21:46:30 +02003053 // Emergency exit: CTRL-C closes the popup.
3054 if (c == Ctrl_C)
3055 {
Bram Moolenaarfd00c042019-10-05 11:56:54 +02003056 int save_got_int = got_int;
3057
3058 // Reset got_int to avoid the callback isn't called.
3059 got_int = FALSE;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003060 popup_close_with_retval(wp, -1);
Bram Moolenaarfd00c042019-10-05 11:56:54 +02003061 got_int |= save_got_int;
Bram Moolenaara42d9452019-06-15 21:46:30 +02003062 return 1;
3063 }
3064
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003065 argv[0].v_type = VAR_NUMBER;
3066 argv[0].vval.v_number = (varnumber_T)wp->w_id;
3067
3068 // Convert the number to a string, so that the function can use:
3069 // if a:c == "\<F2>"
Bram Moolenaarec084d32020-02-28 22:44:47 +01003070 buf[special_to_buf(c, mod_mask, FALSE, buf)] = NUL;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003071 argv[1].v_type = VAR_STRING;
3072 argv[1].vval.v_string = vim_strsave(buf);
3073
3074 argv[2].v_type = VAR_UNKNOWN;
3075
Bram Moolenaar638a4a72019-11-06 19:25:22 +01003076 // NOTE: The callback might close the popup and make "wp" invalid.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003077 call_callback(&wp->w_filter_cb, -1, &rettv, 2, argv);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02003078 if (win_valid_popup(wp) && old_lnum != wp->w_cursor.lnum)
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02003079 popup_highlight_curline(wp);
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003080 res = tv_get_number(&rettv);
Bram Moolenaarf8b036b2019-11-06 21:09:17 +01003081
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003082 vim_free(argv[1].vval.v_string);
3083 clear_tv(&rettv);
3084 return res;
3085}
3086
3087/*
3088 * Called when "c" was typed: invoke popup filter callbacks.
3089 * Returns TRUE when the character was consumed,
3090 */
3091 int
3092popup_do_filter(int c)
3093{
Bram Moolenaar934470e2019-09-01 23:27:05 +02003094 static int recursive = FALSE;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003095 int res = FALSE;
Bram Moolenaara42d9452019-06-15 21:46:30 +02003096 win_T *wp;
Bram Moolenaar934470e2019-09-01 23:27:05 +02003097 int save_KeyTyped = KeyTyped;
Bram Moolenaar581ba392019-09-03 22:08:33 +02003098 int state;
Bram Moolenaarfbb3bc82019-09-07 14:33:36 +02003099 int was_must_redraw = must_redraw;
Bram Moolenaar934470e2019-09-01 23:27:05 +02003100
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003101#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003102 // Popup window with terminal always gets focus.
3103 if (popup_is_popup(curwin) && curbuf->b_term != NULL)
3104 return FALSE;
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003105#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003106
Bram Moolenaar934470e2019-09-01 23:27:05 +02003107 if (recursive)
3108 return FALSE;
3109 recursive = TRUE;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003110
Bram Moolenaarf6396232019-08-24 19:36:00 +02003111 if (c == K_LEFTMOUSE)
3112 {
3113 int row = mouse_row;
3114 int col = mouse_col;
3115
3116 wp = mouse_find_win(&row, &col, FIND_POPUP);
3117 if (wp != NULL && popup_close_if_on_X(wp, row, col))
Bram Moolenaar934470e2019-09-01 23:27:05 +02003118 res = TRUE;
Bram Moolenaarf6396232019-08-24 19:36:00 +02003119 }
3120
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003121 popup_reset_handled(POPUP_HANDLED_2);
Bram Moolenaar581ba392019-09-03 22:08:33 +02003122 state = get_real_state();
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003123 while (!res && (wp = find_next_popup(FALSE, POPUP_HANDLED_2)) != NULL)
Bram Moolenaar581ba392019-09-03 22:08:33 +02003124 if (wp->w_filter_cb.cb_name != NULL
3125 && (wp->w_filter_mode & state) != 0)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003126 res = invoke_popup_filter(wp, c);
3127
Bram Moolenaarfbb3bc82019-09-07 14:33:36 +02003128 if (must_redraw > was_must_redraw)
Bram Moolenaarbcb4c8f2019-09-07 14:06:52 +02003129 redraw_after_callback(FALSE);
Bram Moolenaar934470e2019-09-01 23:27:05 +02003130 recursive = FALSE;
3131 KeyTyped = save_KeyTyped;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003132 return res;
3133}
3134
Bram Moolenaar3397f742019-06-02 18:40:06 +02003135/*
Bram Moolenaar749fa0a2019-08-03 16:18:07 +02003136 * Return TRUE if there is a popup visible with a filter callback and the
3137 * "mapping" property off.
3138 */
3139 int
3140popup_no_mapping(void)
3141{
3142 int round;
3143 win_T *wp;
3144
3145 for (round = 1; round <= 2; ++round)
3146 for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
3147 wp != NULL; wp = wp->w_next)
3148 if (wp->w_filter_cb.cb_name != NULL
3149 && (wp->w_popup_flags & (POPF_HIDDEN | POPF_MAPPING)) == 0)
3150 return TRUE;
3151 return FALSE;
3152}
3153
3154/*
Bram Moolenaar3397f742019-06-02 18:40:06 +02003155 * Called when the cursor moved: check if any popup needs to be closed if the
3156 * cursor moved far enough.
3157 */
3158 void
3159popup_check_cursor_pos()
3160{
3161 win_T *wp;
Bram Moolenaar3397f742019-06-02 18:40:06 +02003162
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003163 popup_reset_handled(POPUP_HANDLED_3);
3164 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_3)) != NULL)
Bram Moolenaar3397f742019-06-02 18:40:06 +02003165 if (wp->w_popup_curwin != NULL
3166 && (curwin != wp->w_popup_curwin
3167 || curwin->w_cursor.lnum != wp->w_popup_lnum
3168 || curwin->w_cursor.col < wp->w_popup_mincol
3169 || curwin->w_cursor.col > wp->w_popup_maxcol))
Bram Moolenaar12034e22019-08-25 22:25:02 +02003170 popup_close_with_retval(wp, -1);
Bram Moolenaar3397f742019-06-02 18:40:06 +02003171}
3172
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003173/*
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003174 * Update "w_popup_mask_cells".
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003175 */
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003176 static void
3177popup_update_mask(win_T *wp, int width, int height)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003178{
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003179 listitem_T *lio, *li;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003180 char_u *cells;
3181 int row, col;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003182
3183 if (wp->w_popup_mask == NULL)
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003184 return;
3185 if (wp->w_popup_mask_cells != NULL
3186 && wp->w_popup_mask_height == height
3187 && wp->w_popup_mask_width == width)
3188 return; // cache is still valid
3189
3190 vim_free(wp->w_popup_mask_cells);
3191 wp->w_popup_mask_cells = alloc_clear(width * height);
3192 if (wp->w_popup_mask_cells == NULL)
3193 return;
3194 cells = wp->w_popup_mask_cells;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003195
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003196 FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003197 {
3198 int cols, cole;
3199 int lines, linee;
3200
3201 li = lio->li_tv.vval.v_list->lv_first;
3202 cols = tv_get_number(&li->li_tv);
3203 if (cols < 0)
3204 cols = width + cols + 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003205 li = li->li_next;
3206 cole = tv_get_number(&li->li_tv);
3207 if (cole < 0)
3208 cole = width + cole + 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003209 li = li->li_next;
3210 lines = tv_get_number(&li->li_tv);
3211 if (lines < 0)
3212 lines = height + lines + 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003213 li = li->li_next;
3214 linee = tv_get_number(&li->li_tv);
3215 if (linee < 0)
3216 linee = height + linee + 1;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003217
3218 for (row = lines - 1; row < linee && row < height; ++row)
3219 for (col = cols - 1; col < cole && col < width; ++col)
3220 cells[row * width + col] = 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003221 }
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003222}
3223
3224/*
3225 * Return TRUE if "col" / "line" matches with an entry in w_popup_mask.
3226 * "col" and "line" are screen coordinates.
3227 */
3228 static int
3229popup_masked(win_T *wp, int width, int height, int screencol, int screenline)
3230{
3231 int col = screencol - wp->w_wincol + wp->w_popup_leftoff;
3232 int line = screenline - wp->w_winrow;
3233
3234 return col >= 0 && col < width
3235 && line >= 0 && line < height
3236 && wp->w_popup_mask_cells[line * width + col];
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003237}
3238
3239/*
3240 * Set flags in popup_transparent[] for window "wp" to "val".
3241 */
3242 static void
3243update_popup_transparent(win_T *wp, int val)
3244{
3245 if (wp->w_popup_mask != NULL)
3246 {
3247 int width = popup_width(wp);
3248 int height = popup_height(wp);
3249 listitem_T *lio, *li;
3250 int cols, cole;
3251 int lines, linee;
3252 int col, line;
3253
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003254 FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003255 {
3256 li = lio->li_tv.vval.v_list->lv_first;
3257 cols = tv_get_number(&li->li_tv);
3258 if (cols < 0)
3259 cols = width + cols + 1;
3260 li = li->li_next;
3261 cole = tv_get_number(&li->li_tv);
3262 if (cole < 0)
3263 cole = width + cole + 1;
3264 li = li->li_next;
3265 lines = tv_get_number(&li->li_tv);
3266 if (lines < 0)
3267 lines = height + lines + 1;
3268 li = li->li_next;
3269 linee = tv_get_number(&li->li_tv);
3270 if (linee < 0)
3271 linee = height + linee + 1;
3272
3273 --cols;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003274 cols -= wp->w_popup_leftoff;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02003275 if (cols < 0)
3276 cols = 0;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003277 cole -= wp->w_popup_leftoff;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003278 --lines;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02003279 if (lines < 0)
3280 lines = 0;
Bram Moolenaarb4207472019-07-12 16:05:45 +02003281 for (line = lines; line < linee
3282 && line + wp->w_winrow < screen_Rows; ++line)
3283 for (col = cols; col < cole
3284 && col + wp->w_wincol < screen_Columns; ++col)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003285 popup_transparent[(line + wp->w_winrow) * screen_Columns
3286 + col + wp->w_wincol] = val;
3287 }
3288 }
3289}
3290
3291/*
Bram Moolenaar12034e22019-08-25 22:25:02 +02003292 * Only called when popup window "wp" is hidden: If the window is positioned
3293 * next to a text property, and it is now visible, then unhide the popup.
3294 * We don't check if visible popups become hidden, that is done in
3295 * popup_adjust_position().
3296 * Return TRUE if the popup became unhidden.
3297 */
3298 static int
3299check_popup_unhidden(win_T *wp)
3300{
3301 if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
3302 {
3303 textprop_T prop;
3304 linenr_T lnum;
3305
3306 if (find_visible_prop(wp->w_popup_prop_win,
3307 wp->w_popup_prop_type, wp->w_popup_prop_id,
3308 &prop, &lnum) == OK)
3309 {
3310 wp->w_popup_flags &= ~POPF_HIDDEN;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003311 wp->w_popup_prop_topline = 0; // force repositioning
3312 return TRUE;
3313 }
3314 }
3315 return FALSE;
3316}
3317
3318/*
3319 * Return TRUE if popup_adjust_position() needs to be called for "wp".
3320 * That is when the buffer in the popup was changed, or the popup is following
3321 * a textprop and the referenced buffer was changed.
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02003322 * Or when the cursor line changed and "cursorline" is set.
Bram Moolenaar12034e22019-08-25 22:25:02 +02003323 */
3324 static int
3325popup_need_position_adjust(win_T *wp)
3326{
3327 if (wp->w_popup_last_changedtick != CHANGEDTICK(wp->w_buffer))
3328 return TRUE;
3329 if (win_valid(wp->w_popup_prop_win))
3330 return wp->w_popup_prop_changedtick
3331 != CHANGEDTICK(wp->w_popup_prop_win->w_buffer)
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02003332 || wp->w_popup_prop_topline != wp->w_popup_prop_win->w_topline
3333 || ((wp->w_popup_flags & POPF_CURSORLINE)
3334 && wp->w_cursor.lnum != wp->w_popup_last_curline);
Bram Moolenaar12034e22019-08-25 22:25:02 +02003335 return FALSE;
3336}
3337
3338/*
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003339 * Update "popup_mask" if needed.
3340 * Also recomputes the popup size and positions.
3341 * Also updates "popup_visible".
3342 * Also marks window lines for redrawing.
3343 */
3344 void
3345may_update_popup_mask(int type)
3346{
3347 win_T *wp;
3348 short *mask;
3349 int line, col;
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003350 int redraw_all_popups = FALSE;
3351 int redrawing_all_win;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003352
3353 // Need to recompute when switching tabs.
3354 // Also recompute when the type is CLEAR or NOT_VALID, something basic
3355 // (such as the screen size) must have changed.
3356 if (popup_mask_tab != curtab || type >= NOT_VALID)
3357 {
3358 popup_mask_refresh = TRUE;
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003359 redraw_all_popups = TRUE;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003360 }
Bram Moolenaar12034e22019-08-25 22:25:02 +02003361
3362 // Check if any popup window buffer has changed and if any popup connected
3363 // to a text property has become visible.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003364 FOR_ALL_POPUPWINS(wp)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003365 if (wp->w_popup_flags & POPF_HIDDEN)
3366 popup_mask_refresh |= check_popup_unhidden(wp);
3367 else if (popup_need_position_adjust(wp))
3368 popup_mask_refresh = TRUE;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003369 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003370 if (wp->w_popup_flags & POPF_HIDDEN)
3371 popup_mask_refresh |= check_popup_unhidden(wp);
3372 else if (popup_need_position_adjust(wp))
3373 popup_mask_refresh = TRUE;
3374
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003375 if (!popup_mask_refresh)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003376 return;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003377
3378 // Need to update the mask, something has changed.
3379 popup_mask_refresh = FALSE;
3380 popup_mask_tab = curtab;
3381 popup_visible = FALSE;
3382
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003383 // If redrawing all windows, just update "popup_mask".
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003384 // If redrawing only what is needed, update "popup_mask_next" and then
3385 // compare with "popup_mask" to see what changed.
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003386 redrawing_all_win = TRUE;
3387 FOR_ALL_WINDOWS(wp)
3388 if (wp->w_redr_type < SOME_VALID)
3389 redrawing_all_win = FALSE;
3390 if (redrawing_all_win)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003391 mask = popup_mask;
3392 else
3393 mask = popup_mask_next;
3394 vim_memset(mask, 0, screen_Rows * screen_Columns * sizeof(short));
3395
3396 // Find the window with the lowest zindex that hasn't been handled yet,
3397 // so that the window with a higher zindex overwrites the value in
3398 // popup_mask.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003399 popup_reset_handled(POPUP_HANDLED_4);
3400 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_4)) != NULL)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003401 {
Bram Moolenaard529ba52019-07-02 23:13:53 +02003402 int width;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003403 int height;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003404
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003405 popup_visible = TRUE;
3406
Bram Moolenaar12034e22019-08-25 22:25:02 +02003407 // Recompute the position if the text changed. It may make the popup
3408 // hidden if it's attach to a text property that is no longer visible.
3409 if (redraw_all_popups || popup_need_position_adjust(wp))
3410 {
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003411 popup_adjust_position(wp);
Bram Moolenaar12034e22019-08-25 22:25:02 +02003412 if (wp->w_popup_flags & POPF_HIDDEN)
3413 continue;
3414 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003415
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003416 width = popup_width(wp);
Bram Moolenaard529ba52019-07-02 23:13:53 +02003417 height = popup_height(wp);
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003418 popup_update_mask(wp, width, height);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003419 for (line = wp->w_winrow;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003420 line < wp->w_winrow + height && line < screen_Rows; ++line)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003421 for (col = wp->w_wincol;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003422 col < wp->w_wincol + width - wp->w_popup_leftoff
3423 && col < screen_Columns; ++col)
3424 if (wp->w_popup_mask_cells == NULL
3425 || !popup_masked(wp, width, height, col, line))
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003426 mask[line * screen_Columns + col] = wp->w_zindex;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003427 }
3428
3429 // Only check which lines are to be updated if not already
3430 // updating all lines.
3431 if (mask == popup_mask_next)
Bram Moolenaar9d5ffce2019-07-26 21:01:29 +02003432 {
3433 int *plines_cache = ALLOC_CLEAR_MULT(int, Rows);
3434 win_T *prev_wp = NULL;
3435
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003436 for (line = 0; line < screen_Rows; ++line)
3437 {
3438 int col_done = 0;
3439
3440 for (col = 0; col < screen_Columns; ++col)
3441 {
3442 int off = line * screen_Columns + col;
3443
3444 if (popup_mask[off] != popup_mask_next[off])
3445 {
3446 popup_mask[off] = popup_mask_next[off];
3447
3448 if (line >= cmdline_row)
3449 {
3450 // the command line needs to be cleared if text below
3451 // the popup is now visible.
3452 if (!msg_scrolled && popup_mask_next[off] == 0)
3453 clear_cmdline = TRUE;
3454 }
3455 else if (col >= col_done)
3456 {
3457 linenr_T lnum;
3458 int line_cp = line;
3459 int col_cp = col;
3460
3461 // The screen position "line" / "col" needs to be
3462 // redrawn. Figure out what window that is and update
3463 // w_redraw_top and w_redr_bot. Only needs to be done
3464 // once for each window line.
3465 wp = mouse_find_win(&line_cp, &col_cp, IGNORE_POPUP);
3466 if (wp != NULL)
3467 {
Bram Moolenaar9d5ffce2019-07-26 21:01:29 +02003468 if (wp != prev_wp)
3469 {
3470 vim_memset(plines_cache, 0, sizeof(int) * Rows);
3471 prev_wp = wp;
3472 }
3473
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003474 if (line_cp >= wp->w_height)
3475 // In (or below) status line
3476 wp->w_redr_status = TRUE;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003477 else
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003478 {
3479 // compute the position in the buffer line from
3480 // the position in the window
3481 mouse_comp_pos(wp, &line_cp, &col_cp,
3482 &lnum, plines_cache);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003483 redrawWinline(wp, lnum);
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003484 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003485
3486 // This line is going to be redrawn, no need to
3487 // check until the right side of the window.
3488 col_done = wp->w_wincol + wp->w_width - 1;
3489 }
3490 }
3491 }
3492 }
3493 }
Bram Moolenaar9d5ffce2019-07-26 21:01:29 +02003494
3495 vim_free(plines_cache);
3496 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003497}
3498
3499/*
3500 * Return a string of "len" spaces in IObuff.
3501 */
3502 static char_u *
3503get_spaces(int len)
3504{
3505 vim_memset(IObuff, ' ', (size_t)len);
3506 IObuff[len] = NUL;
3507 return IObuff;
3508}
3509
3510/*
3511 * Update popup windows. They are drawn on top of normal windows.
3512 * "win_update" is called for each popup window, lowest zindex first.
3513 */
3514 void
3515update_popups(void (*win_update)(win_T *wp))
3516{
3517 win_T *wp;
3518 int top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003519 int left_extra;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003520 int total_width;
3521 int total_height;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003522 int top_padding;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003523 int popup_attr;
3524 int border_attr[4];
3525 int border_char[8];
3526 char_u buf[MB_MAXBYTES];
3527 int row;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003528 int wincol;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003529 int padcol = 0;
3530 int padwidth = 0;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003531 int i;
Bram Moolenaar6efd76a2019-06-26 04:06:57 +02003532 int sb_thumb_top = 0;
3533 int sb_thumb_height = 0;
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003534 int attr_scroll = 0;
3535 int attr_thumb = 0;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003536
3537 // Find the window with the lowest zindex that hasn't been updated yet,
3538 // so that the window with a higher zindex is drawn later, thus goes on
3539 // top.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003540 popup_reset_handled(POPUP_HANDLED_5);
3541 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_5)) != NULL)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003542 {
3543 // This drawing uses the zindex of the popup window, so that it's on
3544 // top of the text but doesn't draw when another popup with higher
3545 // zindex is on top of the character.
3546 screen_zindex = wp->w_zindex;
3547
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003548 // Set flags in popup_transparent[] for masked cells.
3549 update_popup_transparent(wp, 1);
3550
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003551 // adjust w_winrow and w_wincol for border and padding, since
3552 // win_update() doesn't handle them.
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003553 top_off = popup_top_extra(wp);
Bram Moolenaard529ba52019-07-02 23:13:53 +02003554 left_extra = wp->w_popup_padding[3] + wp->w_popup_border[3]
3555 - wp->w_popup_leftoff;
3556 if (wp->w_wincol + left_extra < 0)
3557 left_extra = -wp->w_wincol;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003558 wp->w_winrow += top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003559 wp->w_wincol += left_extra;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003560
Bram Moolenaarc2a43162019-06-26 01:03:53 +02003561 // Draw the popup text, unless it's off screen.
3562 if (wp->w_winrow < screen_Rows && wp->w_wincol < screen_Columns)
Bram Moolenaar9e67b6a2019-08-30 17:34:08 +02003563 {
Bram Moolenaarc2a43162019-06-26 01:03:53 +02003564 win_update(wp);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003565
Bram Moolenaar9e67b6a2019-08-30 17:34:08 +02003566 // move the cursor into the visible lines, otherwise executing
3567 // commands with win_execute() may cause the text to jump.
3568 if (wp->w_cursor.lnum < wp->w_topline)
3569 wp->w_cursor.lnum = wp->w_topline;
3570 else if (wp->w_cursor.lnum >= wp->w_botline)
3571 wp->w_cursor.lnum = wp->w_botline - 1;
3572 }
3573
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003574 wp->w_winrow -= top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003575 wp->w_wincol -= left_extra;
Bram Moolenaare52e0c82020-02-28 22:20:10 +01003576 // cursor position matters in terminal in job mode
Bram Moolenaar57c732e2020-02-28 22:51:54 +01003577#ifdef FEAT_TERMINAL
Bram Moolenaare52e0c82020-02-28 22:20:10 +01003578 if (wp != curwin || !term_in_normal_mode())
Bram Moolenaar57c732e2020-02-28 22:51:54 +01003579#endif
Bram Moolenaare52e0c82020-02-28 22:20:10 +01003580 {
3581 wp->w_wrow += top_off;
3582 wp->w_wcol += left_extra;
3583 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003584
Bram Moolenaard529ba52019-07-02 23:13:53 +02003585 total_width = popup_width(wp);
3586 total_height = popup_height(wp);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003587 popup_attr = get_wcr_attr(wp);
3588
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02003589 if (wp->w_winrow + total_height > cmdline_row)
3590 wp->w_popup_flags |= POPF_ON_CMDLINE;
3591 else
3592 wp->w_popup_flags &= ~POPF_ON_CMDLINE;
3593
3594
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003595 // We can only use these line drawing characters when 'encoding' is
3596 // "utf-8" and 'ambiwidth' is "single".
3597 if (enc_utf8 && *p_ambw == 's')
3598 {
3599 border_char[0] = border_char[2] = 0x2550;
3600 border_char[1] = border_char[3] = 0x2551;
3601 border_char[4] = 0x2554;
3602 border_char[5] = 0x2557;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02003603 border_char[6] = (wp->w_popup_flags & POPF_RESIZE)
3604 ? 0x21f2 : 0x255d;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003605 border_char[7] = 0x255a;
3606 }
3607 else
3608 {
3609 border_char[0] = border_char[2] = '-';
3610 border_char[1] = border_char[3] = '|';
3611 for (i = 4; i < 8; ++i)
3612 border_char[i] = '+';
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02003613 if (wp->w_popup_flags & POPF_RESIZE)
3614 border_char[6] = '@';
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003615 }
3616 for (i = 0; i < 8; ++i)
3617 if (wp->w_border_char[i] != 0)
3618 border_char[i] = wp->w_border_char[i];
3619
3620 for (i = 0; i < 4; ++i)
3621 {
3622 border_attr[i] = popup_attr;
3623 if (wp->w_border_highlight[i] != NULL)
3624 border_attr[i] = syn_name2attr(wp->w_border_highlight[i]);
3625 }
3626
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003627 wincol = wp->w_wincol - wp->w_popup_leftoff;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003628 top_padding = wp->w_popup_padding[0];
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003629 if (wp->w_popup_border[0] > 0)
3630 {
3631 // top border
3632 screen_fill(wp->w_winrow, wp->w_winrow + 1,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003633 wincol < 0 ? 0 : wincol, wincol + total_width,
3634 wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003635 ? border_char[4] : border_char[0],
3636 border_char[0], border_attr[0]);
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003637 if (wp->w_popup_border[1] > 0 && wp->w_popup_rightoff == 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003638 {
3639 buf[mb_char2bytes(border_char[5], buf)] = NUL;
3640 screen_puts(buf, wp->w_winrow,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003641 wincol + total_width - 1, border_attr[1]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003642 }
3643 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003644 else if (wp->w_popup_padding[0] == 0 && popup_top_extra(wp) > 0)
3645 top_padding = 1;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003646
Bram Moolenaard529ba52019-07-02 23:13:53 +02003647 if (top_padding > 0 || wp->w_popup_padding[2] > 0)
3648 {
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003649 padcol = wincol + wp->w_popup_border[3];
Bram Moolenaard529ba52019-07-02 23:13:53 +02003650 padwidth = wp->w_wincol + total_width - wp->w_popup_border[1]
3651 - wp->w_has_scrollbar;
3652 if (padcol < 0)
3653 {
3654 padwidth += padcol;
3655 padcol = 0;
3656 }
3657 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003658 if (top_padding > 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003659 {
3660 // top padding
3661 row = wp->w_winrow + wp->w_popup_border[0];
Bram Moolenaard529ba52019-07-02 23:13:53 +02003662 screen_fill(row, row + top_padding, padcol, padwidth,
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003663 ' ', ' ', popup_attr);
3664 }
3665
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003666 // Title goes on top of border or padding.
3667 if (wp->w_popup_title != NULL)
Bram Moolenaar5d458a72019-08-04 21:12:15 +02003668 {
3669 int len = (int)STRLEN(wp->w_popup_title) + 1;
3670 char_u *title = alloc(len);
3671
3672 trunc_string(wp->w_popup_title, title, total_width - 2, len);
3673 screen_puts(title, wp->w_winrow, wp->w_wincol + 1,
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003674 wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
Bram Moolenaar86173482019-10-01 17:02:16 +02003675 vim_free(title);
Bram Moolenaar5d458a72019-08-04 21:12:15 +02003676 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003677
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003678 // Compute scrollbar thumb position and size.
3679 if (wp->w_has_scrollbar)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003680 {
Bram Moolenaar076d9882019-09-14 22:23:29 +02003681 linenr_T linecount = wp->w_buffer->b_ml.ml_line_count;
3682 int height = wp->w_height;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003683
Bram Moolenaar076d9882019-09-14 22:23:29 +02003684 sb_thumb_height = (height * height + linecount / 2) / linecount;
3685 if (wp->w_topline > 1 && sb_thumb_height == height)
3686 --sb_thumb_height; // scrolled, no full thumb
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003687 if (sb_thumb_height == 0)
3688 sb_thumb_height = 1;
Bram Moolenaar437a7462019-07-05 20:17:22 +02003689 if (linecount <= wp->w_height)
3690 // it just fits, avoid divide by zero
3691 sb_thumb_top = 0;
3692 else
3693 sb_thumb_top = (wp->w_topline - 1
3694 + (linecount / wp->w_height) / 2)
Bram Moolenaar68acb412019-06-26 03:40:36 +02003695 * (wp->w_height - sb_thumb_height)
3696 / (linecount - wp->w_height);
Bram Moolenaar076d9882019-09-14 22:23:29 +02003697 if (wp->w_topline > 1 && sb_thumb_top == 0 && height > 1)
3698 sb_thumb_top = 1; // show it's scrolled
3699
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003700 if (wp->w_scrollbar_highlight != NULL)
3701 attr_scroll = syn_name2attr(wp->w_scrollbar_highlight);
3702 else
3703 attr_scroll = highlight_attr[HLF_PSB];
3704 if (wp->w_thumb_highlight != NULL)
3705 attr_thumb = syn_name2attr(wp->w_thumb_highlight);
3706 else
3707 attr_thumb = highlight_attr[HLF_PST];
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003708 }
3709
3710 for (i = wp->w_popup_border[0];
3711 i < total_height - wp->w_popup_border[2]; ++i)
3712 {
Bram Moolenaard529ba52019-07-02 23:13:53 +02003713 int pad_left;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003714 // left and right padding only needed next to the body
3715 int do_padding =
3716 i >= wp->w_popup_border[0] + wp->w_popup_padding[0]
3717 && i < total_height - wp->w_popup_border[2]
3718 - wp->w_popup_padding[2];
3719
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003720 row = wp->w_winrow + i;
3721
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003722 // left border
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003723 if (wp->w_popup_border[3] > 0 && wincol >= 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003724 {
3725 buf[mb_char2bytes(border_char[3], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003726 screen_puts(buf, row, wincol, border_attr[3]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003727 }
Bram Moolenaard529ba52019-07-02 23:13:53 +02003728 if (do_padding && wp->w_popup_padding[3] > 0)
3729 {
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003730 int col = wincol + wp->w_popup_border[3];
3731
Bram Moolenaard529ba52019-07-02 23:13:53 +02003732 // left padding
Bram Moolenaard529ba52019-07-02 23:13:53 +02003733 pad_left = wp->w_popup_padding[3];
3734 if (col < 0)
3735 {
3736 pad_left += col;
3737 col = 0;
3738 }
3739 if (pad_left > 0)
3740 screen_puts(get_spaces(pad_left), row, col, popup_attr);
3741 }
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003742 // scrollbar
3743 if (wp->w_has_scrollbar)
3744 {
3745 int line = i - top_off;
3746 int scroll_col = wp->w_wincol + total_width - 1
3747 - wp->w_popup_border[1];
3748
3749 if (line >= 0 && line < wp->w_height)
3750 screen_putchar(' ', row, scroll_col,
3751 line >= sb_thumb_top
3752 && line < sb_thumb_top + sb_thumb_height
3753 ? attr_thumb : attr_scroll);
3754 else
3755 screen_putchar(' ', row, scroll_col, popup_attr);
3756 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003757 // right border
3758 if (wp->w_popup_border[1] > 0)
3759 {
3760 buf[mb_char2bytes(border_char[1], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003761 screen_puts(buf, row, wincol + total_width - 1, border_attr[1]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003762 }
3763 // right padding
Bram Moolenaard529ba52019-07-02 23:13:53 +02003764 if (do_padding && wp->w_popup_padding[1] > 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003765 screen_puts(get_spaces(wp->w_popup_padding[1]), row,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003766 wincol + wp->w_popup_border[3]
Bram Moolenaard529ba52019-07-02 23:13:53 +02003767 + wp->w_popup_padding[3] + wp->w_width + wp->w_leftcol,
3768 popup_attr);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003769 }
3770
3771 if (wp->w_popup_padding[2] > 0)
3772 {
3773 // bottom padding
3774 row = wp->w_winrow + wp->w_popup_border[0]
3775 + wp->w_popup_padding[0] + wp->w_height;
3776 screen_fill(row, row + wp->w_popup_padding[2],
Bram Moolenaard529ba52019-07-02 23:13:53 +02003777 padcol, padwidth, ' ', ' ', popup_attr);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003778 }
3779
3780 if (wp->w_popup_border[2] > 0)
3781 {
3782 // bottom border
3783 row = wp->w_winrow + total_height - 1;
3784 screen_fill(row , row + 1,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003785 wincol < 0 ? 0 : wincol,
3786 wincol + total_width,
3787 wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003788 ? border_char[7] : border_char[2],
3789 border_char[2], border_attr[2]);
3790 if (wp->w_popup_border[1] > 0)
3791 {
3792 buf[mb_char2bytes(border_char[6], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003793 screen_puts(buf, row, wincol + total_width - 1, border_attr[2]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003794 }
3795 }
3796
Bram Moolenaar2e62b562019-06-30 18:07:00 +02003797 if (wp->w_popup_close == POPCLOSE_BUTTON)
3798 {
3799 // close button goes on top of anything at the top-right corner
3800 buf[mb_char2bytes('X', buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003801 screen_puts(buf, wp->w_winrow, wincol + total_width - 1,
Bram Moolenaar2e62b562019-06-30 18:07:00 +02003802 wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
3803 }
3804
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003805 update_popup_transparent(wp, 0);
3806
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003807 // Back to the normal zindex.
3808 screen_zindex = 0;
3809 }
3810}
3811
Bram Moolenaar75a1a942019-06-20 03:45:36 +02003812/*
3813 * Mark references in callbacks of one popup window.
3814 */
3815 static int
3816set_ref_in_one_popup(win_T *wp, int copyID)
3817{
3818 int abort = FALSE;
3819 typval_T tv;
3820
3821 if (wp->w_close_cb.cb_partial != NULL)
3822 {
3823 tv.v_type = VAR_PARTIAL;
3824 tv.vval.v_partial = wp->w_close_cb.cb_partial;
3825 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
3826 }
3827 if (wp->w_filter_cb.cb_partial != NULL)
3828 {
3829 tv.v_type = VAR_PARTIAL;
3830 tv.vval.v_partial = wp->w_filter_cb.cb_partial;
3831 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
3832 }
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02003833 abort = abort || set_ref_in_list(wp->w_popup_mask, copyID);
Bram Moolenaar75a1a942019-06-20 03:45:36 +02003834 return abort;
3835}
3836
3837/*
3838 * Set reference in callbacks of popup windows.
3839 */
3840 int
3841set_ref_in_popups(int copyID)
3842{
3843 int abort = FALSE;
3844 win_T *wp;
3845 tabpage_T *tp;
3846
3847 for (wp = first_popupwin; !abort && wp != NULL; wp = wp->w_next)
3848 abort = abort || set_ref_in_one_popup(wp, copyID);
3849
3850 FOR_ALL_TABPAGES(tp)
3851 {
3852 for (wp = tp->tp_first_popupwin; !abort && wp != NULL; wp = wp->w_next)
3853 abort = abort || set_ref_in_one_popup(wp, copyID);
3854 if (abort)
3855 break;
3856 }
3857 return abort;
3858}
Bram Moolenaar79648732019-07-18 21:43:07 +02003859
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003860 int
3861popup_is_popup(win_T *wp)
3862{
3863 return wp->w_popup_flags != 0;
3864}
3865
3866#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar79648732019-07-18 21:43:07 +02003867/*
3868 * Find an existing popup used as the preview window, in the current tab page.
3869 * Return NULL if not found.
3870 */
3871 win_T *
3872popup_find_preview_window(void)
3873{
3874 win_T *wp;
3875
3876 // Preview window popup is always local to tab page.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003877 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar79648732019-07-18 21:43:07 +02003878 if (wp->w_p_pvw)
3879 return wp;
Bram Moolenaar56c0c472019-07-28 17:57:43 +02003880 return NULL;
3881}
3882
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003883/*
3884 * Find an existing popup used as the info window, in the current tab page.
3885 * Return NULL if not found.
3886 */
3887 win_T *
3888popup_find_info_window(void)
3889{
3890 win_T *wp;
3891
3892 // info window popup is always local to tab page.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003893 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003894 if (wp->w_popup_flags & POPF_INFO)
3895 return wp;
3896 return NULL;
3897}
Bram Moolenaar36e4d982019-08-20 21:12:16 +02003898#endif
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003899
Bram Moolenaar56c0c472019-07-28 17:57:43 +02003900 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003901f_popup_findinfo(typval_T *argvars UNUSED, typval_T *rettv)
3902{
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003903#ifdef FEAT_QUICKFIX
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003904 win_T *wp = popup_find_info_window();
3905
3906 rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003907#else
3908 rettv->vval.v_number = 0;
3909#endif
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003910}
3911
3912 void
3913f_popup_findpreview(typval_T *argvars UNUSED, typval_T *rettv)
Bram Moolenaar56c0c472019-07-28 17:57:43 +02003914{
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003915#ifdef FEAT_QUICKFIX
Bram Moolenaar56c0c472019-07-28 17:57:43 +02003916 win_T *wp = popup_find_preview_window();
3917
3918 rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003919#else
3920 rettv->vval.v_number = 0;
3921#endif
Bram Moolenaar79648732019-07-18 21:43:07 +02003922}
3923
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003924#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar79648732019-07-18 21:43:07 +02003925/*
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003926 * Create a popup to be used as the preview or info window.
Bram Moolenaar79648732019-07-18 21:43:07 +02003927 * NOTE: this makes the popup the current window, so that the file can be
3928 * edited. However, it must not remain to be the current window, the caller
3929 * must make sure of that.
3930 */
3931 int
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003932popup_create_preview_window(int info)
Bram Moolenaar79648732019-07-18 21:43:07 +02003933{
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003934 win_T *wp = popup_create(NULL, NULL, info ? TYPE_INFO : TYPE_PREVIEW);
Bram Moolenaar79648732019-07-18 21:43:07 +02003935
3936 if (wp == NULL)
3937 return FAIL;
Bram Moolenaar576a4a62019-08-18 15:25:17 +02003938 if (info)
3939 wp->w_popup_flags |= POPF_INFO;
3940 else
3941 wp->w_p_pvw = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02003942
3943 // Set the width to a reasonable value, so that w_topline can be computed.
3944 if (wp->w_minwidth > 0)
3945 wp->w_width = wp->w_minwidth;
3946 else if (wp->w_maxwidth > 0)
3947 wp->w_width = wp->w_maxwidth;
3948 else
3949 wp->w_width = curwin->w_width;
3950
3951 // Will switch to another buffer soon, dummy one can be wiped.
3952 wp->w_buffer->b_locked = FALSE;
3953
3954 win_enter(wp, FALSE);
3955 return OK;
3956}
3957
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003958/*
3959 * Close any preview popup.
3960 */
Bram Moolenaar79648732019-07-18 21:43:07 +02003961 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003962popup_close_preview(void)
Bram Moolenaar79648732019-07-18 21:43:07 +02003963{
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003964 win_T *wp = popup_find_preview_window();
Bram Moolenaar79648732019-07-18 21:43:07 +02003965
3966 if (wp != NULL)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003967 popup_close_with_retval(wp, -1);
Bram Moolenaar79648732019-07-18 21:43:07 +02003968}
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02003969
3970/*
3971 * Hide the info popup.
3972 */
3973 void
3974popup_hide_info(void)
3975{
3976 win_T *wp = popup_find_info_window();
3977
3978 if (wp != NULL)
3979 popup_hide(wp);
3980}
Bram Moolenaar36e4d982019-08-20 21:12:16 +02003981#endif
Bram Moolenaar79648732019-07-18 21:43:07 +02003982
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02003983/*
Bram Moolenaar12034e22019-08-25 22:25:02 +02003984 * Close any popup for a text property associated with "win".
3985 * Return TRUE if a popup was closed.
3986 */
3987 int
3988popup_win_closed(win_T *win)
3989{
Bram Moolenaar1fb08312019-08-29 20:02:11 +02003990 int round;
3991 win_T *wp;
3992 win_T *next;
3993 int ret = FALSE;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003994
Bram Moolenaar1fb08312019-08-29 20:02:11 +02003995 for (round = 1; round <= 2; ++round)
3996 for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
3997 wp != NULL; wp = next)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003998 {
Bram Moolenaar1fb08312019-08-29 20:02:11 +02003999 next = wp->w_next;
4000 if (wp->w_popup_prop_win == win)
4001 {
4002 popup_close_with_retval(wp, -1);
4003 ret = TRUE;
4004 }
Bram Moolenaar12034e22019-08-25 22:25:02 +02004005 }
Bram Moolenaar1fb08312019-08-29 20:02:11 +02004006 return ret;
Bram Moolenaar12034e22019-08-25 22:25:02 +02004007}
4008
4009/*
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004010 * Set the title of the popup window to the file name.
4011 */
4012 void
4013popup_set_title(win_T *wp)
4014{
4015 if (wp->w_buffer->b_fname != NULL)
4016 {
4017 char_u dirname[MAXPATHL];
4018 size_t len;
4019
4020 mch_dirname(dirname, MAXPATHL);
4021 shorten_buf_fname(wp->w_buffer, dirname, FALSE);
4022
4023 vim_free(wp->w_popup_title);
4024 len = STRLEN(wp->w_buffer->b_fname) + 3;
4025 wp->w_popup_title = alloc((int)len);
4026 if (wp->w_popup_title != NULL)
4027 vim_snprintf((char *)wp->w_popup_title, len, " %s ",
4028 wp->w_buffer->b_fname);
4029 redraw_win_later(wp, VALID);
4030 }
4031}
4032
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004033# if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004034/*
4035 * If there is a preview window, update the title.
4036 * Used after changing directory.
4037 */
4038 void
4039popup_update_preview_title(void)
4040{
4041 win_T *wp = popup_find_preview_window();
4042
4043 if (wp != NULL)
4044 popup_set_title(wp);
4045}
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004046# endif
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004047
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004048#endif // FEAT_PROP_POPUP