blob: 436238f9ba897ba5a8fe06fbbfb079a5c06e7373 [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 {
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200101 CHECK_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);
Bram Moolenaarb885b432020-11-05 19:34:41 +0100387 if (get_lambda_tv(&ptr, &tv, FALSE, &EVALARG_EVALUATE) == OK)
Bram Moolenaar68d48f42019-06-12 22:42:41 +0200388 {
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
Bram Moolenaar55881332020-08-18 13:04:15 +0200441
442 nr = dict_get_bool(d, (char_u *)"fixed", -1);
443 if (nr != -1)
444 wp->w_popup_fixed = nr != 0;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200445
Bram Moolenaar12034e22019-08-25 22:25:02 +0200446 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +0100447 poppos_T ppt = get_pos_entry(d, TRUE);
448
449 if (ppt != POPPOS_NONE)
450 wp->w_popup_pos = ppt;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200451 }
452
453 str = dict_get_string(d, (char_u *)"textprop", FALSE);
454 if (str != NULL)
455 {
456 wp->w_popup_prop_type = 0;
457 if (*str != NUL)
458 {
Bram Moolenaara37cb552019-11-16 20:03:31 +0100459 wp->w_popup_prop_win = curwin;
460 di = dict_find(d, (char_u *)"textpropwin", -1);
461 if (di != NULL)
462 {
463 wp->w_popup_prop_win = find_win_by_nr_or_id(&di->di_tv);
Bram Moolenaarefa19232021-02-06 14:59:27 +0100464 if (!win_valid_any_tab(wp->w_popup_prop_win))
Bram Moolenaara37cb552019-11-16 20:03:31 +0100465 wp->w_popup_prop_win = curwin;
466 }
467
468 nr = find_prop_type_id(str, wp->w_popup_prop_win->w_buffer);
Bram Moolenaar12034e22019-08-25 22:25:02 +0200469 if (nr <= 0)
470 nr = find_prop_type_id(str, NULL);
471 if (nr <= 0)
472 semsg(_(e_invarg2), str);
473 else
Bram Moolenaar12034e22019-08-25 22:25:02 +0200474 wp->w_popup_prop_type = nr;
Bram Moolenaar12034e22019-08-25 22:25:02 +0200475 }
476 }
477
478 di = dict_find(d, (char_u *)"textpropid", -1);
479 if (di != NULL)
480 wp->w_popup_prop_id = dict_get_number(d, (char_u *)"textpropid");
Bram Moolenaarae943152019-06-16 22:54:14 +0200481}
482
Bram Moolenaarb0992022020-01-30 14:55:42 +0100483/*
484 * Handle "moved" and "mousemoved" arguments.
485 */
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200486 static void
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200487handle_moved_argument(win_T *wp, dictitem_T *di, int mousemoved)
488{
489 if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
490 {
491 char_u *s = di->di_tv.vval.v_string;
492 int flags = 0;
493
494 if (STRCMP(s, "word") == 0)
495 flags = FIND_IDENT | FIND_STRING;
496 else if (STRCMP(s, "WORD") == 0)
497 flags = FIND_STRING;
498 else if (STRCMP(s, "expr") == 0)
499 flags = FIND_IDENT | FIND_STRING | FIND_EVAL;
500 else if (STRCMP(s, "any") != 0)
501 semsg(_(e_invarg2), s);
502 if (flags != 0)
503 {
504 if (mousemoved)
505 set_mousemoved_columns(wp, flags);
506 else
507 set_moved_columns(wp, flags);
508 }
509 }
510 else if (di->di_tv.v_type == VAR_LIST
511 && di->di_tv.vval.v_list != NULL
Bram Moolenaara1396152019-10-20 18:46:05 +0200512 && (di->di_tv.vval.v_list->lv_len == 2
513 || di->di_tv.vval.v_list->lv_len == 3))
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200514 {
Bram Moolenaara1396152019-10-20 18:46:05 +0200515 list_T *l = di->di_tv.vval.v_list;
Bram Moolenaarb0992022020-01-30 14:55:42 +0100516 listitem_T *li;
Bram Moolenaara1396152019-10-20 18:46:05 +0200517 int mincol;
518 int maxcol;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200519
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200520 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaarb0992022020-01-30 14:55:42 +0100521 li = l->lv_first;
522 if (l->lv_len == 3)
Bram Moolenaara1396152019-10-20 18:46:05 +0200523 {
524 varnumber_T nr = tv_get_number(&l->lv_first->li_tv);
525
526 // Three numbers, might be from popup_getoptions().
527 if (mousemoved)
528 wp->w_popup_mouse_row = nr;
529 else
530 wp->w_popup_lnum = nr;
531 li = li->li_next;
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +0100532 if (nr == 0)
533 wp->w_popup_curwin = NULL;
Bram Moolenaara1396152019-10-20 18:46:05 +0200534 }
535
536 mincol = tv_get_number(&li->li_tv);
537 maxcol = tv_get_number(&li->li_next->li_tv);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200538 if (mousemoved)
539 {
540 wp->w_popup_mouse_mincol = mincol;
541 wp->w_popup_mouse_maxcol = maxcol;
542 }
543 else
544 {
545 wp->w_popup_mincol = mincol;
546 wp->w_popup_maxcol = maxcol;
547 }
548 }
549 else
550 semsg(_(e_invarg2), tv_get_string(&di->di_tv));
551}
552
553 static void
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200554check_highlight(dict_T *dict, char *name, char_u **pval)
555{
556 dictitem_T *di;
557 char_u *str;
558
559 di = dict_find(dict, (char_u *)name, -1);
560 if (di != NULL)
561 {
562 if (di->di_tv.v_type != VAR_STRING)
563 semsg(_(e_invargval), name);
564 else
565 {
566 str = tv_get_string(&di->di_tv);
567 if (*str != NUL)
568 *pval = vim_strsave(str);
569 }
570 }
571}
572
Bram Moolenaarae943152019-06-16 22:54:14 +0200573/*
Bram Moolenaar7b3d9392019-10-16 22:17:07 +0200574 * Scroll to show the line with the cursor.
Bram Moolenaar79648732019-07-18 21:43:07 +0200575 */
576 static void
577popup_show_curline(win_T *wp)
578{
579 if (wp->w_cursor.lnum < wp->w_topline)
580 wp->w_topline = wp->w_cursor.lnum;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200581 else if (wp->w_cursor.lnum >= wp->w_botline
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200582 && (wp->w_valid & VALID_BOTLINE))
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200583 {
Bram Moolenaar79648732019-07-18 21:43:07 +0200584 wp->w_topline = wp->w_cursor.lnum - wp->w_height + 1;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200585 if (wp->w_topline < 1)
586 wp->w_topline = 1;
587 else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
588 wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +0200589 while (wp->w_topline < wp->w_cursor.lnum
590 && wp->w_topline < wp->w_buffer->b_ml.ml_line_count
591 && plines_m_win(wp, wp->w_topline, wp->w_cursor.lnum)
592 > wp->w_height)
593 ++wp->w_topline;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200594 }
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200595
Bram Moolenaar99ca9c42020-09-22 21:55:41 +0200596 // Don't let "firstline" cause a scroll.
597 if (wp->w_firstline > 0)
598 wp->w_firstline = wp->w_topline;
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200599}
600
601/*
602 * Get the sign group name for window "wp".
603 * Returns a pointer to a static buffer, overwritten on the next call.
604 */
605 static char_u *
606popup_get_sign_name(win_T *wp)
607{
608 static char buf[30];
609
610 vim_snprintf(buf, sizeof(buf), "popup-%d", wp->w_id);
611 return (char_u *)buf;
Bram Moolenaar79648732019-07-18 21:43:07 +0200612}
613
614/*
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200615 * Highlight the line with the cursor.
616 * Also scrolls the text to put the cursor line in view.
617 */
618 static void
619popup_highlight_curline(win_T *wp)
620{
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200621 int sign_id = 0;
622 char_u *sign_name = popup_get_sign_name(wp);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200623
Bram Moolenaar72570732019-11-30 14:21:53 +0100624 buf_delete_signs(wp->w_buffer, (char_u *)"PopUpMenu");
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200625
626 if ((wp->w_popup_flags & POPF_CURSORLINE) != 0)
627 {
Bram Moolenaar79648732019-07-18 21:43:07 +0200628 popup_show_curline(wp);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200629
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200630 if (!sign_exists_by_name(sign_name))
631 {
632 char *linehl = "PopupSelected";
633
634 if (syn_name2id((char_u *)linehl) == 0)
635 linehl = "PmenuSel";
Bram Moolenaar62a0cb42019-08-18 16:35:23 +0200636 sign_define_by_name(sign_name, NULL, (char_u *)linehl, NULL, NULL);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200637 }
638
Bram Moolenaar72570732019-11-30 14:21:53 +0100639 sign_place(&sign_id, (char_u *)"PopUpMenu", sign_name,
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200640 wp->w_buffer, wp->w_cursor.lnum, SIGN_DEF_PRIO);
641 redraw_win_later(wp, NOT_VALID);
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200642 }
Bram Moolenaarcb5ff342019-07-20 16:51:19 +0200643 else
644 sign_undefine_by_name(sign_name, FALSE);
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +0200645 wp->w_popup_last_curline = wp->w_cursor.lnum;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200646}
647
648/*
Bram Moolenaarae943152019-06-16 22:54:14 +0200649 * Shared between popup_create() and f_popup_setoptions().
650 */
651 static void
652apply_general_options(win_T *wp, dict_T *dict)
653{
654 dictitem_T *di;
Bram Moolenaar402502d2019-05-30 22:07:36 +0200655 int nr;
656 char_u *str;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +0200657
Bram Moolenaarae943152019-06-16 22:54:14 +0200658 // TODO: flip
659
660 di = dict_find(dict, (char_u *)"firstline", -1);
Bram Moolenaardfa97f22019-06-15 14:31:55 +0200661 if (di != NULL)
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200662 {
Bram Moolenaarae943152019-06-16 22:54:14 +0200663 wp->w_firstline = dict_get_number(dict, (char_u *)"firstline");
Bram Moolenaar8c6173c2019-08-30 22:08:34 +0200664 if (wp->w_firstline < 0)
665 wp->w_firstline = -1;
666 }
Bram Moolenaarbf0eff02019-06-01 17:13:36 +0200667
Bram Moolenaar6c542f72020-09-27 21:16:45 +0200668 nr = dict_get_bool(dict, (char_u *)"scrollbar", -1);
669 if (nr != -1)
670 wp->w_want_scrollbar = nr;
Bram Moolenaar75fb0852019-06-25 05:15:58 +0200671
Bram Moolenaareb2310d2019-06-16 20:09:10 +0200672 str = dict_get_string(dict, (char_u *)"title", FALSE);
673 if (str != NULL)
674 {
675 vim_free(wp->w_popup_title);
676 wp->w_popup_title = vim_strsave(str);
677 }
678
Bram Moolenaar55881332020-08-18 13:04:15 +0200679 nr = dict_get_bool(dict, (char_u *)"wrap", -1);
680 if (nr != -1)
Bram Moolenaar402502d2019-05-30 22:07:36 +0200681 wp->w_p_wrap = nr != 0;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +0200682
Bram Moolenaar55881332020-08-18 13:04:15 +0200683 nr = dict_get_bool(dict, (char_u *)"drag", -1);
684 if (nr != -1)
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200685 {
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200686 if (nr)
687 wp->w_popup_flags |= POPF_DRAG;
688 else
689 wp->w_popup_flags &= ~POPF_DRAG;
690 }
691
Bram Moolenaar55881332020-08-18 13:04:15 +0200692 nr = dict_get_bool(dict, (char_u *)"posinvert", -1);
693 if (nr != -1)
Bram Moolenaar638a4a72019-11-06 19:25:22 +0100694 {
Bram Moolenaar638a4a72019-11-06 19:25:22 +0100695 if (nr)
696 wp->w_popup_flags |= POPF_POSINVERT;
697 else
698 wp->w_popup_flags &= ~POPF_POSINVERT;
699 }
700
Bram Moolenaar55881332020-08-18 13:04:15 +0200701 nr = dict_get_bool(dict, (char_u *)"resize", -1);
702 if (nr != -1)
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200703 {
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +0200704 if (nr)
705 wp->w_popup_flags |= POPF_RESIZE;
706 else
707 wp->w_popup_flags &= ~POPF_RESIZE;
708 }
Bram Moolenaarb53fb312019-06-13 23:59:52 +0200709
Bram Moolenaar2e62b562019-06-30 18:07:00 +0200710 di = dict_find(dict, (char_u *)"close", -1);
711 if (di != NULL)
712 {
713 int ok = TRUE;
714
715 if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
716 {
717 char_u *s = di->di_tv.vval.v_string;
718
719 if (STRCMP(s, "none") == 0)
720 wp->w_popup_close = POPCLOSE_NONE;
721 else if (STRCMP(s, "button") == 0)
722 wp->w_popup_close = POPCLOSE_BUTTON;
723 else if (STRCMP(s, "click") == 0)
724 wp->w_popup_close = POPCLOSE_CLICK;
725 else
726 ok = FALSE;
727 }
728 else
729 ok = FALSE;
730 if (!ok)
731 semsg(_(e_invargNval), "close", tv_get_string(&di->di_tv));
732 }
733
Bram Moolenaarae943152019-06-16 22:54:14 +0200734 str = dict_get_string(dict, (char_u *)"highlight", FALSE);
735 if (str != NULL)
736 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
737 str, OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar9eaac892019-06-01 22:49:29 +0200738
Bram Moolenaarae943152019-06-16 22:54:14 +0200739 set_padding_border(dict, wp->w_popup_padding, "padding", 999);
740 set_padding_border(dict, wp->w_popup_border, "border", 1);
Bram Moolenaar9eaac892019-06-01 22:49:29 +0200741
Bram Moolenaar790498b2019-06-01 22:15:29 +0200742 di = dict_find(dict, (char_u *)"borderhighlight", -1);
743 if (di != NULL)
744 {
Bram Moolenaar403d0902019-07-17 21:37:32 +0200745 if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
Bram Moolenaar790498b2019-06-01 22:15:29 +0200746 emsg(_(e_listreq));
747 else
748 {
749 list_T *list = di->di_tv.vval.v_list;
750 listitem_T *li;
Bram Moolenaarae943152019-06-16 22:54:14 +0200751 int i;
Bram Moolenaar790498b2019-06-01 22:15:29 +0200752
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200753 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200754 for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
755 ++i, li = li->li_next)
756 {
757 str = tv_get_string(&li->li_tv);
758 if (*str != NUL)
Bram Moolenaar622b6462019-11-10 15:16:54 +0100759 {
760 vim_free(wp->w_border_highlight[i]);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200761 wp->w_border_highlight[i] = vim_strsave(str);
Bram Moolenaar622b6462019-11-10 15:16:54 +0100762 }
Bram Moolenaar403d0902019-07-17 21:37:32 +0200763 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200764 if (list->lv_len == 1 && wp->w_border_highlight[0] != NULL)
765 for (i = 1; i < 4; ++i)
Bram Moolenaar622b6462019-11-10 15:16:54 +0100766 {
767 vim_free(wp->w_border_highlight[i]);
Bram Moolenaar403d0902019-07-17 21:37:32 +0200768 wp->w_border_highlight[i] =
Bram Moolenaar790498b2019-06-01 22:15:29 +0200769 vim_strsave(wp->w_border_highlight[0]);
Bram Moolenaar622b6462019-11-10 15:16:54 +0100770 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200771 }
772 }
773
Bram Moolenaar790498b2019-06-01 22:15:29 +0200774 di = dict_find(dict, (char_u *)"borderchars", -1);
775 if (di != NULL)
776 {
777 if (di->di_tv.v_type != VAR_LIST)
778 emsg(_(e_listreq));
779 else
780 {
781 list_T *list = di->di_tv.vval.v_list;
782 listitem_T *li;
Bram Moolenaarae943152019-06-16 22:54:14 +0200783 int i;
Bram Moolenaar790498b2019-06-01 22:15:29 +0200784
785 if (list != NULL)
Bram Moolenaarb0992022020-01-30 14:55:42 +0100786 {
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200787 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaar790498b2019-06-01 22:15:29 +0200788 for (i = 0, li = list->lv_first; i < 8 && i < list->lv_len;
789 ++i, li = li->li_next)
790 {
791 str = tv_get_string(&li->li_tv);
792 if (*str != NUL)
793 wp->w_border_char[i] = mb_ptr2char(str);
794 }
Bram Moolenaar8d4ed112020-04-04 14:50:32 +0200795 if (list->lv_len == 1)
796 for (i = 1; i < 8; ++i)
797 wp->w_border_char[i] = wp->w_border_char[0];
798 if (list->lv_len == 2)
799 {
800 for (i = 4; i < 8; ++i)
801 wp->w_border_char[i] = wp->w_border_char[1];
802 for (i = 1; i < 4; ++i)
803 wp->w_border_char[i] = wp->w_border_char[0];
804 }
Bram Moolenaar790498b2019-06-01 22:15:29 +0200805 }
806 }
807 }
Bram Moolenaar3397f742019-06-02 18:40:06 +0200808
Bram Moolenaar4cd583c2019-06-26 05:13:57 +0200809 check_highlight(dict, "scrollbarhighlight", &wp->w_scrollbar_highlight);
810 check_highlight(dict, "thumbhighlight", &wp->w_thumb_highlight);
811
Bram Moolenaarae943152019-06-16 22:54:14 +0200812 di = dict_find(dict, (char_u *)"zindex", -1);
813 if (di != NULL)
814 {
815 wp->w_zindex = dict_get_number(dict, (char_u *)"zindex");
816 if (wp->w_zindex < 1)
817 wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
818 if (wp->w_zindex > 32000)
819 wp->w_zindex = 32000;
820 }
821
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200822 di = dict_find(dict, (char_u *)"mask", -1);
823 if (di != NULL)
824 {
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200825 int ok = FALSE;
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200826
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200827 if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200828 {
829 listitem_T *li;
830
Bram Moolenaarcfdbc5a2019-07-17 21:27:52 +0200831 ok = TRUE;
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200832 FOR_ALL_LIST_ITEMS(di->di_tv.vval.v_list, li)
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200833 {
834 if (li->li_tv.v_type != VAR_LIST
835 || li->li_tv.vval.v_list == NULL
836 || li->li_tv.vval.v_list->lv_len != 4)
837 {
838 ok = FALSE;
839 break;
840 }
Bram Moolenaarb0992022020-01-30 14:55:42 +0100841 else
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200842 CHECK_LIST_MATERIALIZE(li->li_tv.vval.v_list);
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200843 }
844 }
845 if (ok)
846 {
847 wp->w_popup_mask = di->di_tv.vval.v_list;
848 ++wp->w_popup_mask->lv_refcount;
Bram Moolenaare865dcb2019-07-26 22:15:50 +0200849 VIM_CLEAR(wp->w_popup_mask_cells);
Bram Moolenaarc662ec92019-06-23 00:15:57 +0200850 }
851 else
852 semsg(_(e_invargval), "mask");
853 }
854
Bram Moolenaarae943152019-06-16 22:54:14 +0200855#if defined(FEAT_TIMERS)
856 // Add timer to close the popup after some time.
857 nr = dict_get_number(dict, (char_u *)"time");
858 if (nr > 0)
859 popup_add_timeout(wp, nr);
860#endif
861
Bram Moolenaar3397f742019-06-02 18:40:06 +0200862 di = dict_find(dict, (char_u *)"moved", -1);
863 if (di != NULL)
864 {
Bram Moolenaar17627312019-06-02 19:53:44 +0200865 set_moved_values(wp);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200866 handle_moved_argument(wp, di, FALSE);
867 }
Bram Moolenaar3397f742019-06-02 18:40:06 +0200868
Bram Moolenaarb3d17a22019-07-07 18:28:14 +0200869 di = dict_find(dict, (char_u *)"mousemoved", -1);
870 if (di != NULL)
871 {
872 set_mousemoved_values(wp);
873 handle_moved_argument(wp, di, TRUE);
Bram Moolenaar3397f742019-06-02 18:40:06 +0200874 }
Bram Moolenaar33796b32019-06-08 16:01:13 +0200875
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200876 di = dict_find(dict, (char_u *)"cursorline", -1);
877 if (di != NULL)
878 {
879 if (di->di_tv.v_type == VAR_NUMBER)
880 {
881 if (di->di_tv.vval.v_number != 0)
882 wp->w_popup_flags |= POPF_CURSORLINE;
883 else
884 wp->w_popup_flags &= ~POPF_CURSORLINE;
885 }
886 else
887 semsg(_(e_invargval), "cursorline");
888 }
889
Bram Moolenaarae943152019-06-16 22:54:14 +0200890 di = dict_find(dict, (char_u *)"filter", -1);
891 if (di != NULL)
892 {
893 callback_T callback = get_callback(&di->di_tv);
894
895 if (callback.cb_name != NULL)
896 {
897 free_callback(&wp->w_filter_cb);
898 set_callback(&wp->w_filter_cb, &callback);
899 }
900 }
Bram Moolenaar55881332020-08-18 13:04:15 +0200901 nr = dict_get_bool(dict, (char_u *)"mapping", -1);
902 if (nr != -1)
Bram Moolenaar749fa0a2019-08-03 16:18:07 +0200903 {
Bram Moolenaar749fa0a2019-08-03 16:18:07 +0200904 if (nr)
905 wp->w_popup_flags |= POPF_MAPPING;
906 else
907 wp->w_popup_flags &= ~POPF_MAPPING;
908 }
Bram Moolenaarae943152019-06-16 22:54:14 +0200909
Bram Moolenaar581ba392019-09-03 22:08:33 +0200910 str = dict_get_string(dict, (char_u *)"filtermode", FALSE);
911 if (str != NULL)
912 {
913 if (STRCMP(str, "a") == 0)
914 wp->w_filter_mode = MODE_ALL;
915 else
916 wp->w_filter_mode = mode_str2flags(str);
917 }
918
Bram Moolenaarae943152019-06-16 22:54:14 +0200919 di = dict_find(dict, (char_u *)"callback", -1);
920 if (di != NULL)
921 {
922 callback_T callback = get_callback(&di->di_tv);
923
924 if (callback.cb_name != NULL)
925 {
926 free_callback(&wp->w_close_cb);
927 set_callback(&wp->w_close_cb, &callback);
928 }
929 }
930}
931
932/*
933 * Go through the options in "dict" and apply them to popup window "wp".
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200934 * "create" is TRUE when creating a new popup window.
Bram Moolenaarae943152019-06-16 22:54:14 +0200935 */
936 static void
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200937apply_options(win_T *wp, dict_T *dict, int create)
Bram Moolenaarae943152019-06-16 22:54:14 +0200938{
939 int nr;
940
941 apply_move_options(wp, dict);
Bram Moolenaar6d585f42020-07-26 22:20:54 +0200942
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200943 if (create)
944 set_string_option_direct_in_win(wp, (char_u *)"signcolumn", -1,
Bram Moolenaar6d585f42020-07-26 22:20:54 +0200945 (char_u *)"no", OPT_FREE|OPT_LOCAL, 0);
946
Bram Moolenaarae943152019-06-16 22:54:14 +0200947 apply_general_options(wp, dict);
948
Bram Moolenaar55881332020-08-18 13:04:15 +0200949 nr = dict_get_bool(dict, (char_u *)"hidden", FALSE);
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200950 if (nr > 0)
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200951 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaar6313c4f2019-06-16 20:39:13 +0200952
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200953 // when "firstline" and "cursorline" are both set and the cursor would be
954 // above or below the displayed lines, move the cursor to "firstline".
Bram Moolenaar99ca9c42020-09-22 21:55:41 +0200955 if (wp->w_firstline > 0 && (wp->w_popup_flags & POPF_CURSORLINE))
956 {
957 if (wp->w_firstline > wp->w_buffer->b_ml.ml_line_count)
958 wp->w_cursor.lnum = wp->w_buffer->b_ml.ml_line_count;
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200959 else if (wp->w_cursor.lnum < wp->w_firstline
960 || wp->w_cursor.lnum >= wp->w_firstline + wp->w_height)
Bram Moolenaar99ca9c42020-09-22 21:55:41 +0200961 wp->w_cursor.lnum = wp->w_firstline;
Bram Moolenaar3697c9b2020-09-26 22:03:00 +0200962 wp->w_topline = wp->w_firstline;
963 wp->w_valid &= ~VALID_BOTLINE;
Bram Moolenaar99ca9c42020-09-22 21:55:41 +0200964 }
965
Bram Moolenaar33796b32019-06-08 16:01:13 +0200966 popup_mask_refresh = TRUE;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +0200967 popup_highlight_curline(wp);
Bram Moolenaar4d784b22019-05-25 19:51:39 +0200968}
969
970/*
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200971 * Add lines to the popup from a list of strings.
972 */
973 static void
974add_popup_strings(buf_T *buf, list_T *l)
975{
976 listitem_T *li;
977 linenr_T lnum = 0;
978 char_u *p;
979
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200980 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +0200981 if (li->li_tv.v_type == VAR_STRING)
982 {
983 p = li->li_tv.vval.v_string;
984 ml_append_buf(buf, lnum++,
985 p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
986 }
987}
988
989/*
990 * Add lines to the popup from a list of dictionaries.
991 */
992 static void
993add_popup_dicts(buf_T *buf, list_T *l)
994{
995 listitem_T *li;
996 listitem_T *pli;
997 linenr_T lnum = 0;
998 char_u *p;
999 dict_T *dict;
1000
1001 // first add the text lines
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001002 FOR_ALL_LIST_ITEMS(l, li)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +02001003 {
1004 if (li->li_tv.v_type != VAR_DICT)
1005 {
1006 emsg(_(e_dictreq));
1007 return;
1008 }
1009 dict = li->li_tv.vval.v_dict;
1010 p = dict == NULL ? NULL
1011 : dict_get_string(dict, (char_u *)"text", FALSE);
1012 ml_append_buf(buf, lnum++,
1013 p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
1014 }
1015
1016 // add the text properties
1017 lnum = 1;
1018 for (li = l->lv_first; li != NULL; li = li->li_next, ++lnum)
1019 {
1020 dictitem_T *di;
1021 list_T *plist;
1022
1023 dict = li->li_tv.vval.v_dict;
1024 di = dict_find(dict, (char_u *)"props", -1);
1025 if (di != NULL)
1026 {
1027 if (di->di_tv.v_type != VAR_LIST)
1028 {
1029 emsg(_(e_listreq));
1030 return;
1031 }
1032 plist = di->di_tv.vval.v_list;
1033 if (plist != NULL)
1034 {
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001035 FOR_ALL_LIST_ITEMS(plist, pli)
Bram Moolenaar7a8d0272019-05-26 23:32:06 +02001036 {
1037 if (pli->li_tv.v_type != VAR_DICT)
1038 {
1039 emsg(_(e_dictreq));
1040 return;
1041 }
1042 dict = pli->li_tv.vval.v_dict;
1043 if (dict != NULL)
1044 {
1045 int col = dict_get_number(dict, (char_u *)"col");
1046
1047 prop_add_common( lnum, col, dict, buf, NULL);
1048 }
1049 }
1050 }
1051 }
1052 }
1053}
1054
1055/*
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001056 * Get the padding plus border at the top, adjusted to 1 if there is a title.
1057 */
Bram Moolenaarbd483b32019-08-21 15:13:41 +02001058 int
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001059popup_top_extra(win_T *wp)
1060{
1061 int extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
1062
1063 if (extra == 0 && wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
1064 return 1;
1065 return extra;
1066}
1067
1068/*
Bram Moolenaardb3a2052019-11-16 18:22:41 +01001069 * Get the padding plus border at the left.
1070 */
1071 int
1072popup_left_extra(win_T *wp)
1073{
1074 return wp->w_popup_border[3] + wp->w_popup_padding[3];
1075}
1076
1077/*
Bram Moolenaard529ba52019-07-02 23:13:53 +02001078 * Return the height of popup window "wp", including border and padding.
1079 */
1080 int
1081popup_height(win_T *wp)
1082{
1083 return wp->w_height
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001084 + popup_top_extra(wp)
1085 + wp->w_popup_padding[2] + wp->w_popup_border[2];
Bram Moolenaard529ba52019-07-02 23:13:53 +02001086}
1087
1088/*
1089 * Return the width of popup window "wp", including border, padding and
1090 * scrollbar.
1091 */
1092 int
1093popup_width(win_T *wp)
1094{
Bram Moolenaar017c2692019-07-13 14:17:51 +02001095 // w_leftcol is how many columns of the core are left of the screen
1096 // w_popup_rightoff is how many columns of the core are right of the screen
Bram Moolenaard529ba52019-07-02 23:13:53 +02001097 return wp->w_width + wp->w_leftcol
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001098 + popup_extra_width(wp)
1099 + wp->w_popup_rightoff;
1100}
1101
1102/*
1103 * Return the extra width of popup window "wp": border, padding and scrollbar.
1104 */
1105 int
1106popup_extra_width(win_T *wp)
1107{
1108 return wp->w_popup_padding[3] + wp->w_popup_border[3]
1109 + wp->w_popup_padding[1] + wp->w_popup_border[1]
1110 + wp->w_has_scrollbar;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001111}
1112
1113/*
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001114 * Adjust the position and size of the popup to fit on the screen.
1115 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001116 static void
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001117popup_adjust_position(win_T *wp)
1118{
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001119 linenr_T lnum;
1120 int wrapped = 0;
1121 int maxwidth;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +02001122 int used_maxwidth = FALSE;
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001123 int margin_width = 0;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001124 int maxspace;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001125 int center_vert = FALSE;
1126 int center_hor = FALSE;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001127 int allow_adjust_left = !wp->w_popup_fixed;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001128 int top_extra = popup_top_extra(wp);
Bram Moolenaar399d8982019-06-02 15:34:29 +02001129 int right_extra = wp->w_popup_border[1] + wp->w_popup_padding[1];
1130 int bot_extra = wp->w_popup_border[2] + wp->w_popup_padding[2];
1131 int left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
1132 int extra_height = top_extra + bot_extra;
1133 int extra_width = left_extra + right_extra;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001134 int w_height_before_limit;
Bram Moolenaar33796b32019-06-08 16:01:13 +02001135 int org_winrow = wp->w_winrow;
1136 int org_wincol = wp->w_wincol;
1137 int org_width = wp->w_width;
1138 int org_height = wp->w_height;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001139 int org_leftcol = wp->w_leftcol;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001140 int org_leftoff = wp->w_popup_leftoff;
Bram Moolenaar19398262020-03-14 15:28:08 +01001141 int minwidth, minheight;
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001142 int maxheight = Rows;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001143 int wantline = wp->w_wantline; // adjusted for textprop
1144 int wantcol = wp->w_wantcol; // adjusted for textprop
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001145 int use_wantcol = wantcol != 0;
Bram Moolenaarbf61fdd2020-08-10 20:39:17 +02001146 int adjust_height_for_top_aligned = FALSE;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001147
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001148 wp->w_winrow = 0;
1149 wp->w_wincol = 0;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001150 wp->w_leftcol = 0;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001151 wp->w_popup_leftoff = 0;
1152 wp->w_popup_rightoff = 0;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001153
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02001154 // May need to update the "cursorline" highlighting, which may also change
1155 // "topline"
1156 if (wp->w_popup_last_curline != wp->w_cursor.lnum)
1157 popup_highlight_curline(wp);
1158
Bram Moolenaar12034e22019-08-25 22:25:02 +02001159 if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
1160 {
1161 win_T *prop_win = wp->w_popup_prop_win;
1162 textprop_T prop;
1163 linenr_T prop_lnum;
1164 pos_T pos;
1165 int screen_row;
1166 int screen_scol;
1167 int screen_ccol;
1168 int screen_ecol;
1169
1170 // Popup window is positioned relative to a text property.
1171 if (find_visible_prop(prop_win,
1172 wp->w_popup_prop_type, wp->w_popup_prop_id,
1173 &prop, &prop_lnum) == FAIL)
1174 {
1175 // Text property is no longer visible, hide the popup.
1176 // Unhiding the popup is done in check_popup_unhidden().
1177 if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
1178 {
1179 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001180 if (win_valid(wp->w_popup_prop_win))
1181 redraw_win_later(wp->w_popup_prop_win, SOME_VALID);
1182 }
1183 return;
1184 }
1185
1186 // Compute the desired position from the position of the text
1187 // property. Use "wantline" and "wantcol" as offsets.
1188 pos.lnum = prop_lnum;
1189 pos.col = prop.tp_col;
1190 if (wp->w_popup_pos == POPPOS_TOPLEFT
1191 || wp->w_popup_pos == POPPOS_BOTLEFT)
1192 pos.col += prop.tp_len - 1;
1193 textpos2screenpos(prop_win, &pos, &screen_row,
1194 &screen_scol, &screen_ccol, &screen_ecol);
1195
1196 if (wp->w_popup_pos == POPPOS_TOPLEFT
1197 || wp->w_popup_pos == POPPOS_TOPRIGHT)
1198 // below the text
1199 wantline = screen_row + wantline + 1;
1200 else
1201 // above the text
1202 wantline = screen_row + wantline - 1;
1203 center_vert = FALSE;
1204 if (wp->w_popup_pos == POPPOS_TOPLEFT
1205 || wp->w_popup_pos == POPPOS_BOTLEFT)
1206 // right of the text
1207 wantcol = screen_ecol + wantcol;
1208 else
1209 // left of the text
Bram Moolenaarbc2d4c12019-08-28 22:18:30 +02001210 wantcol = screen_scol + wantcol - 2;
Bram Moolenaaraa1f04d2019-10-24 22:12:54 +02001211 use_wantcol = TRUE;
1212 }
1213 else
1214 {
1215 // If no line was specified default to vertical centering.
1216 if (wantline == 0)
1217 center_vert = TRUE;
1218 else if (wantline < 0)
1219 // If "wantline" is negative it actually means zero.
1220 wantline = 0;
1221 if (wantcol < 0)
1222 // If "wantcol" is negative it actually means zero.
1223 wantcol = 0;
Bram Moolenaar12034e22019-08-25 22:25:02 +02001224 }
1225
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001226 if (wp->w_popup_pos == POPPOS_CENTER)
1227 {
1228 // center after computing the size
1229 center_vert = TRUE;
1230 center_hor = TRUE;
1231 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001232 else
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001233 {
Bram Moolenaaraa1f04d2019-10-24 22:12:54 +02001234 if (wantline > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
1235 || wp->w_popup_pos == POPPOS_TOPRIGHT))
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001236 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001237 wp->w_winrow = wantline - 1;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001238 if (wp->w_winrow >= Rows)
1239 wp->w_winrow = Rows - 1;
1240 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001241
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001242 if (!use_wantcol)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001243 center_hor = TRUE;
Bram Moolenaar1fb08312019-08-29 20:02:11 +02001244 else if (wantcol > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
1245 || wp->w_popup_pos == POPPOS_BOTLEFT))
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001246 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001247 wp->w_wincol = wantcol - 1;
Bram Moolenaarba2920f2020-03-06 21:43:17 +01001248 // Need to see at least one character after the decoration.
1249 if (wp->w_wincol > Columns - left_extra - 1)
1250 wp->w_wincol = Columns - left_extra - 1;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001251 }
1252 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001253
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001254 // When centering or right aligned, use maximum width.
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001255 // When left aligned use the space available, but shift to the left when we
1256 // hit the right of the screen.
Bram Moolenaard529ba52019-07-02 23:13:53 +02001257 maxspace = Columns - wp->w_wincol - left_extra;
1258 maxwidth = maxspace;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001259 if (wp->w_maxwidth > 0 && maxwidth > wp->w_maxwidth)
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001260 {
1261 allow_adjust_left = FALSE;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001262 maxwidth = wp->w_maxwidth;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001263 }
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001264
1265 if (wp->w_p_nu || wp->w_p_rnu)
1266 margin_width = number_width(wp) + 1;
1267#ifdef FEAT_FOLDING
1268 margin_width += wp->w_p_fdc;
1269#endif
1270#ifdef FEAT_SIGNS
1271 if (signcolumn_on(wp))
1272 margin_width += 2;
1273#endif
1274 if (margin_width >= maxwidth)
1275 margin_width = maxwidth - 1;
1276
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001277 minwidth = wp->w_minwidth;
Bram Moolenaar19398262020-03-14 15:28:08 +01001278 minheight = wp->w_minheight;
1279#ifdef FEAT_TERMINAL
1280 // A terminal popup initially does not have content, use a default minimal
1281 // width of 20 characters and height of 5 lines.
1282 if (wp->w_buffer->b_term != NULL)
1283 {
1284 if (minwidth == 0)
1285 minwidth = 20;
1286 if (minheight == 0)
1287 minheight = 5;
1288 }
1289#endif
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001290
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001291 if (wp->w_maxheight > 0)
1292 maxheight = wp->w_maxheight;
1293
Bram Moolenaar8d241042019-06-12 23:40:01 +02001294 // start at the desired first line
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001295 if (wp->w_firstline > 0)
Bram Moolenaar79648732019-07-18 21:43:07 +02001296 wp->w_topline = wp->w_firstline;
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02001297 if (wp->w_topline < 1)
1298 wp->w_topline = 1;
1299 else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
Bram Moolenaar8d241042019-06-12 23:40:01 +02001300 wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
1301
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001302 // Compute width based on longest text line and the 'wrap' option.
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001303 // Use a minimum width of one, so that something shows when there is no
1304 // text.
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001305 // When "firstline" is -1 then start with the last buffer line and go
1306 // backwards.
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001307 // TODO: more accurate wrapping
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001308 wp->w_width = 1;
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001309 if (wp->w_firstline < 0)
1310 lnum = wp->w_buffer->b_ml.ml_line_count;
1311 else
1312 lnum = wp->w_topline;
1313 while (lnum >= 1 && lnum <= wp->w_buffer->b_ml.ml_line_count)
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001314 {
Bram Moolenaar331bafd2019-07-20 17:46:05 +02001315 int len;
1316 int w_width = wp->w_width;
1317
1318 // Count Tabs for what they are worth and compute the length based on
1319 // the maximum width (matters when 'showbreak' is set).
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001320 // "margin_width" is added to "len" where it matters.
Bram Moolenaar331bafd2019-07-20 17:46:05 +02001321 if (wp->w_width < maxwidth)
1322 wp->w_width = maxwidth;
1323 len = win_linetabsize(wp, ml_get_buf(wp->w_buffer, lnum, FALSE),
Bram Moolenaare089c3f2019-07-09 20:25:25 +02001324 (colnr_T)MAXCOL);
Bram Moolenaar331bafd2019-07-20 17:46:05 +02001325 wp->w_width = w_width;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001326
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001327 if (wp->w_p_wrap)
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001328 {
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001329 while (len + margin_width > maxwidth)
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001330 {
1331 ++wrapped;
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001332 len -= maxwidth - margin_width;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001333 wp->w_width = maxwidth;
Bram Moolenaar7b3d9392019-10-16 22:17:07 +02001334 used_maxwidth = TRUE;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001335 }
1336 }
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001337 else if (len + margin_width > maxwidth
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001338 && allow_adjust_left
1339 && (wp->w_popup_pos == POPPOS_TOPLEFT
1340 || wp->w_popup_pos == POPPOS_BOTLEFT))
1341 {
1342 // adjust leftwise to fit text on screen
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001343 int shift_by = len + margin_width - maxwidth;
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001344
Bram Moolenaar51c31312019-06-15 22:27:23 +02001345 if (shift_by > wp->w_wincol)
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001346 {
1347 int truncate_shift = shift_by - wp->w_wincol;
Bram Moolenaar51c31312019-06-15 22:27:23 +02001348
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02001349 len -= truncate_shift;
1350 shift_by -= truncate_shift;
1351 }
1352
1353 wp->w_wincol -= shift_by;
1354 maxwidth += shift_by;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001355 wp->w_width = maxwidth;
1356 }
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001357 if (wp->w_width < len + margin_width)
Bram Moolenaar017c2692019-07-13 14:17:51 +02001358 {
Bram Moolenaar0aac67a2020-07-27 22:40:37 +02001359 wp->w_width = len + margin_width;
Bram Moolenaar017c2692019-07-13 14:17:51 +02001360 if (wp->w_maxwidth > 0 && wp->w_width > wp->w_maxwidth)
1361 wp->w_width = wp->w_maxwidth;
1362 }
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001363
1364 if (wp->w_firstline < 0)
1365 --lnum;
1366 else
1367 ++lnum;
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001368
1369 // do not use the width of lines we're not going to show
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001370 if (maxheight > 0
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001371 && (wp->w_firstline >= 0
1372 ? lnum - wp->w_topline
1373 : wp->w_buffer->b_ml.ml_line_count - lnum)
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001374 + wrapped >= maxheight)
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001375 break;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001376 }
1377
Bram Moolenaar8c6173c2019-08-30 22:08:34 +02001378 if (wp->w_firstline < 0)
1379 wp->w_topline = lnum > 0 ? lnum + 1 : lnum;
1380
Bram Moolenaar75fb0852019-06-25 05:15:58 +02001381 wp->w_has_scrollbar = wp->w_want_scrollbar
1382 && (wp->w_topline > 1 || lnum <= wp->w_buffer->b_ml.ml_line_count);
Bram Moolenaar219c7d02020-02-01 21:57:29 +01001383#ifdef FEAT_TERMINAL
1384 if (wp->w_buffer->b_term != NULL)
1385 // Terminal window never has a scrollbar, adjusts to window height.
1386 wp->w_has_scrollbar = FALSE;
1387#endif
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001388 if (wp->w_has_scrollbar)
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001389 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001390 ++right_extra;
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001391 ++extra_width;
Bram Moolenaarf2885d32019-11-02 20:21:25 +01001392 // make space for the scrollbar if needed, when lines wrap and when
1393 // applying minwidth
1394 if (maxwidth + right_extra >= maxspace
1395 && (used_maxwidth || (minwidth > 0 && wp->w_width < minwidth)))
1396 maxwidth -= wp->w_popup_padding[1] + 1;
Bram Moolenaarfe6e7612019-08-21 20:57:20 +02001397 }
Bram Moolenaar75fb0852019-06-25 05:15:58 +02001398
Bram Moolenaareb2310d2019-06-16 20:09:10 +02001399 if (wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
1400 {
1401 int title_len = vim_strsize(wp->w_popup_title) + 2 - extra_width;
1402
1403 if (minwidth < title_len)
1404 minwidth = title_len;
1405 }
1406
1407 if (minwidth > 0 && wp->w_width < minwidth)
1408 wp->w_width = minwidth;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001409 if (wp->w_width > maxwidth)
Bram Moolenaard529ba52019-07-02 23:13:53 +02001410 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001411 if (wp->w_width > maxspace && !wp->w_p_wrap)
Bram Moolenaard529ba52019-07-02 23:13:53 +02001412 // some columns cut off on the right
1413 wp->w_popup_rightoff = wp->w_width - maxspace;
Bram Moolenaar88c4e1f2019-05-29 23:14:28 +02001414 wp->w_width = maxwidth;
Bram Moolenaard529ba52019-07-02 23:13:53 +02001415 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001416 if (center_hor)
Bram Moolenaara730e552019-06-16 19:05:31 +02001417 {
1418 wp->w_wincol = (Columns - wp->w_width - extra_width) / 2;
1419 if (wp->w_wincol < 0)
1420 wp->w_wincol = 0;
1421 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001422 else if (wp->w_popup_pos == POPPOS_BOTRIGHT
1423 || wp->w_popup_pos == POPPOS_TOPRIGHT)
1424 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001425 int leftoff = wantcol - (wp->w_width + extra_width);
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001426
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001427 // Right aligned: move to the right if needed.
1428 // No truncation, because that would change the height.
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001429 if (leftoff >= 0)
1430 wp->w_wincol = leftoff;
1431 else if (wp->w_popup_fixed)
1432 {
1433 // "col" specifies the right edge, but popup doesn't fit, skip some
Bram Moolenaard529ba52019-07-02 23:13:53 +02001434 // columns when displaying the window, minus left border and
1435 // padding.
1436 if (-leftoff > left_extra)
1437 wp->w_leftcol = -leftoff - left_extra;
1438 wp->w_width -= wp->w_leftcol;
1439 wp->w_popup_leftoff = -leftoff;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001440 if (wp->w_width < 0)
1441 wp->w_width = 0;
1442 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001443 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001444
Bram Moolenaar8edf0e32019-07-30 21:19:26 +02001445 if (wp->w_p_wrap || (!wp->w_popup_fixed
1446 && (wp->w_popup_pos == POPPOS_TOPLEFT
1447 || wp->w_popup_pos == POPPOS_BOTLEFT)))
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001448 {
1449 int want_col = 0;
1450
Bram Moolenaar8c8b88d2019-07-30 20:32:41 +02001451 // try to show the right border and any scrollbar
1452 want_col = left_extra + wp->w_width + right_extra;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001453 if (want_col > 0 && wp->w_wincol > 0
1454 && wp->w_wincol + want_col >= Columns)
1455 {
1456 wp->w_wincol = Columns - want_col;
1457 if (wp->w_wincol < 0)
1458 wp->w_wincol = 0;
1459 }
1460 }
1461
Bram Moolenaar8d241042019-06-12 23:40:01 +02001462 wp->w_height = wp->w_buffer->b_ml.ml_line_count - wp->w_topline
1463 + 1 + wrapped;
Bram Moolenaar19398262020-03-14 15:28:08 +01001464 if (minheight > 0 && wp->w_height < minheight)
1465 wp->w_height = minheight;
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001466 if (maxheight > 0 && wp->w_height > maxheight)
1467 wp->w_height = maxheight;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001468 w_height_before_limit = wp->w_height;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001469 if (wp->w_height > Rows - wp->w_winrow)
1470 wp->w_height = Rows - wp->w_winrow;
Bram Moolenaar17146962019-05-30 00:12:11 +02001471
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001472 if (center_vert)
Bram Moolenaara730e552019-06-16 19:05:31 +02001473 {
1474 wp->w_winrow = (Rows - wp->w_height - extra_height) / 2;
1475 if (wp->w_winrow < 0)
1476 wp->w_winrow = 0;
1477 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001478 else if (wp->w_popup_pos == POPPOS_BOTRIGHT
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001479 || wp->w_popup_pos == POPPOS_BOTLEFT)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001480 {
Bram Moolenaar12034e22019-08-25 22:25:02 +02001481 if ((wp->w_height + extra_height) <= wantline)
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001482 // bottom aligned: may move down
Bram Moolenaar12034e22019-08-25 22:25:02 +02001483 wp->w_winrow = wantline - (wp->w_height + extra_height);
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001484 else if (wantline * 2 >= Rows || !(wp->w_popup_flags & POPF_POSINVERT))
1485 {
1486 // Bottom aligned but does not fit, and less space on the other
1487 // side or "posinvert" is off: reduce height.
1488 wp->w_winrow = 0;
1489 wp->w_height = wantline - extra_height;
1490 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001491 else
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001492 {
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001493 // Not enough space and more space on the other side: make top
1494 // aligned.
Bram Moolenaarb754b5b2019-10-24 19:25:00 +02001495 wp->w_winrow = (wantline < 0 ? 0 : wantline) + 1;
Bram Moolenaarbf61fdd2020-08-10 20:39:17 +02001496 adjust_height_for_top_aligned = TRUE;
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001497 }
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001498 }
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001499 else if (wp->w_popup_pos == POPPOS_TOPRIGHT
1500 || wp->w_popup_pos == POPPOS_TOPLEFT)
1501 {
1502 if (wantline + (wp->w_height + extra_height) - 1 > Rows
1503 && wantline * 2 > Rows
1504 && (wp->w_popup_flags & POPF_POSINVERT))
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001505 {
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001506 // top aligned and not enough space below but there is space above:
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001507 // make bottom aligned and recompute the height
1508 wp->w_height = w_height_before_limit;
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001509 wp->w_winrow = wantline - 2 - wp->w_height - extra_height;
Bram Moolenaar5c6b6182019-11-10 17:51:38 +01001510 if (wp->w_winrow < 0)
1511 {
1512 wp->w_height += wp->w_winrow;
1513 wp->w_winrow = 0;
1514 }
1515 }
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001516 else
Bram Moolenaarbf61fdd2020-08-10 20:39:17 +02001517 {
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001518 wp->w_winrow = wantline - 1;
Bram Moolenaarbf61fdd2020-08-10 20:39:17 +02001519 adjust_height_for_top_aligned = TRUE;
1520 }
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001521 }
Bram Moolenaarbf61fdd2020-08-10 20:39:17 +02001522
1523 if (adjust_height_for_top_aligned && wp->w_want_scrollbar
1524 && wp->w_winrow + wp->w_height + extra_height > Rows)
1525 {
1526 // Bottom of the popup goes below the last line, reduce the height and
1527 // add a scrollbar.
1528 wp->w_height = Rows - wp->w_winrow - extra_height;
1529#ifdef FEAT_TERMINAL
1530 if (wp->w_buffer->b_term == NULL)
1531#endif
1532 wp->w_has_scrollbar = TRUE;
1533 }
1534
1535 // make sure w_winrow is valid
Bram Moolenaar12034e22019-08-25 22:25:02 +02001536 if (wp->w_winrow >= Rows)
1537 wp->w_winrow = Rows - 1;
1538 else if (wp->w_winrow < 0)
1539 wp->w_winrow = 0;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001540
Bram Moolenaara1b9b0c2020-08-09 16:37:48 +02001541 if (wp->w_height != org_height)
1542 win_comp_scroll(wp);
1543
Bram Moolenaar17146962019-05-30 00:12:11 +02001544 wp->w_popup_last_changedtick = CHANGEDTICK(wp->w_buffer);
Bram Moolenaar12034e22019-08-25 22:25:02 +02001545 if (win_valid(wp->w_popup_prop_win))
1546 {
1547 wp->w_popup_prop_changedtick =
1548 CHANGEDTICK(wp->w_popup_prop_win->w_buffer);
1549 wp->w_popup_prop_topline = wp->w_popup_prop_win->w_topline;
1550 }
Bram Moolenaar33796b32019-06-08 16:01:13 +02001551
1552 // Need to update popup_mask if the position or size changed.
Bram Moolenaar356375f2019-08-24 14:46:29 +02001553 // And redraw windows and statuslines that were behind the popup.
Bram Moolenaar33796b32019-06-08 16:01:13 +02001554 if (org_winrow != wp->w_winrow
1555 || org_wincol != wp->w_wincol
Bram Moolenaar711d02c2019-06-28 04:06:50 +02001556 || org_leftcol != wp->w_leftcol
Bram Moolenaard529ba52019-07-02 23:13:53 +02001557 || org_leftoff != wp->w_popup_leftoff
Bram Moolenaar33796b32019-06-08 16:01:13 +02001558 || org_width != wp->w_width
1559 || org_height != wp->w_height)
1560 {
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001561 redraw_win_later(wp, NOT_VALID);
1562 if (wp->w_popup_flags & POPF_ON_CMDLINE)
1563 clear_cmdline = TRUE;
Bram Moolenaar33796b32019-06-08 16:01:13 +02001564 popup_mask_refresh = TRUE;
1565 }
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001566}
1567
Bram Moolenaar17627312019-06-02 19:53:44 +02001568typedef enum
1569{
1570 TYPE_NORMAL,
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001571 TYPE_ATCURSOR,
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02001572 TYPE_BEVAL,
Bram Moolenaara42d9452019-06-15 21:46:30 +02001573 TYPE_NOTIFICATION,
Bram Moolenaara730e552019-06-16 19:05:31 +02001574 TYPE_DIALOG,
Bram Moolenaar79648732019-07-18 21:43:07 +02001575 TYPE_MENU,
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001576 TYPE_PREVIEW, // preview window
1577 TYPE_INFO // popup menu info
Bram Moolenaar17627312019-06-02 19:53:44 +02001578} create_type_T;
1579
Bram Moolenaar60cdb302019-05-27 21:54:10 +02001580/*
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001581 * Make "buf" empty and set the contents to "text".
1582 * Used by popup_create() and popup_settext().
1583 */
1584 static void
1585popup_set_buffer_text(buf_T *buf, typval_T text)
1586{
1587 int lnum;
1588
1589 // Clear the buffer, then replace the lines.
1590 curbuf = buf;
1591 for (lnum = buf->b_ml.ml_line_count; lnum > 0; --lnum)
Bram Moolenaarca70c072020-05-30 20:30:46 +02001592 ml_delete(lnum);
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001593 curbuf = curwin->w_buffer;
1594
1595 // Add text to the buffer.
1596 if (text.v_type == VAR_STRING)
1597 {
Bram Moolenaar74f8eec2020-10-15 19:10:56 +02001598 char_u *s = text.vval.v_string;
1599
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001600 // just a string
Bram Moolenaar74f8eec2020-10-15 19:10:56 +02001601 ml_append_buf(buf, 0, s == NULL ? (char_u *)"" : s, (colnr_T)0, TRUE);
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001602 }
1603 else
1604 {
1605 list_T *l = text.vval.v_list;
1606
Bram Moolenaar74f8eec2020-10-15 19:10:56 +02001607 if (l != NULL && l->lv_len > 0)
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001608 {
1609 if (l->lv_first->li_tv.v_type == VAR_STRING)
1610 // list of strings
1611 add_popup_strings(buf, l);
1612 else
1613 // list of dictionaries
1614 add_popup_dicts(buf, l);
1615 }
1616 }
1617
1618 // delete the line that was in the empty buffer
1619 curbuf = buf;
Bram Moolenaarca70c072020-05-30 20:30:46 +02001620 ml_delete(buf->b_ml.ml_line_count);
Bram Moolenaardc2ce582019-06-16 15:32:14 +02001621 curbuf = curwin->w_buffer;
1622}
1623
1624/*
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001625 * Parse the 'previewpopup' or 'completepopup' option and apply the values to
1626 * window "wp" if it is not NULL.
Bram Moolenaar79648732019-07-18 21:43:07 +02001627 * Return FAIL if the parsing fails.
1628 */
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001629 static int
1630parse_popup_option(win_T *wp, int is_preview)
Bram Moolenaar79648732019-07-18 21:43:07 +02001631{
Bram Moolenaar36e4d982019-08-20 21:12:16 +02001632 char_u *p =
1633#ifdef FEAT_QUICKFIX
1634 !is_preview ? p_cpp :
1635#endif
1636 p_pvp;
Bram Moolenaar79648732019-07-18 21:43:07 +02001637
Bram Moolenaar258cef52019-08-21 17:29:29 +02001638 if (wp != NULL)
1639 wp->w_popup_flags &= ~POPF_INFO_MENU;
1640
Bram Moolenaar36e4d982019-08-20 21:12:16 +02001641 for ( ; *p != NUL; p += (*p == ',' ? 1 : 0))
Bram Moolenaar79648732019-07-18 21:43:07 +02001642 {
1643 char_u *e, *dig;
1644 char_u *s = p;
1645 int x;
1646
1647 e = vim_strchr(p, ':');
1648 if (e == NULL || e[1] == NUL)
1649 return FAIL;
1650
1651 p = vim_strchr(e, ',');
1652 if (p == NULL)
1653 p = e + STRLEN(e);
1654 dig = e + 1;
1655 x = getdigits(&dig);
Bram Moolenaar79648732019-07-18 21:43:07 +02001656
1657 if (STRNCMP(s, "height:", 7) == 0)
1658 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001659 if (dig != p)
1660 return FAIL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001661 if (wp != NULL)
1662 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001663 if (is_preview)
1664 wp->w_minheight = x;
Bram Moolenaar79648732019-07-18 21:43:07 +02001665 wp->w_maxheight = x;
1666 }
1667 }
1668 else if (STRNCMP(s, "width:", 6) == 0)
1669 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001670 if (dig != p)
1671 return FAIL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001672 if (wp != NULL)
1673 {
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001674 if (is_preview)
1675 wp->w_minwidth = x;
Bram Moolenaar79648732019-07-18 21:43:07 +02001676 wp->w_maxwidth = x;
Bram Moolenaarde2396f2020-07-18 21:40:41 +02001677 wp->w_maxwidth_opt = x;
Bram Moolenaar79648732019-07-18 21:43:07 +02001678 }
1679 }
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001680 else if (STRNCMP(s, "highlight:", 10) == 0)
1681 {
1682 if (wp != NULL)
1683 {
1684 int c = *p;
1685
1686 *p = NUL;
1687 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
1688 s + 10, OPT_FREE|OPT_LOCAL, 0);
1689 *p = c;
1690 }
1691 }
Bram Moolenaarbd483b32019-08-21 15:13:41 +02001692 else if (STRNCMP(s, "border:", 7) == 0)
1693 {
1694 char_u *arg = s + 7;
1695 int on = STRNCMP(arg, "on", 2) == 0 && arg + 2 == p;
1696 int off = STRNCMP(arg, "off", 3) == 0 && arg + 3 == p;
1697 int i;
1698
1699 if (!on && !off)
1700 return FAIL;
1701 if (wp != NULL)
1702 {
1703 for (i = 0; i < 4; ++i)
1704 wp->w_popup_border[i] = on ? 1 : 0;
1705 if (off)
1706 // only show the X for close when there is a border
1707 wp->w_popup_close = POPCLOSE_NONE;
1708 }
1709 }
Bram Moolenaar258cef52019-08-21 17:29:29 +02001710 else if (STRNCMP(s, "align:", 6) == 0)
1711 {
1712 char_u *arg = s + 6;
1713 int item = STRNCMP(arg, "item", 4) == 0 && arg + 4 == p;
1714 int menu = STRNCMP(arg, "menu", 4) == 0 && arg + 4 == p;
1715
1716 if (!menu && !item)
1717 return FAIL;
1718 if (wp != NULL && menu)
1719 wp->w_popup_flags |= POPF_INFO_MENU;
1720 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001721 else
1722 return FAIL;
1723 }
1724 return OK;
1725}
1726
1727/*
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001728 * Parse the 'previewpopup' option and apply the values to window "wp" if it
1729 * is not NULL.
1730 * Return FAIL if the parsing fails.
1731 */
1732 int
1733parse_previewpopup(win_T *wp)
1734{
1735 return parse_popup_option(wp, TRUE);
1736}
1737
1738/*
1739 * Parse the 'completepopup' option and apply the values to window "wp" if it
1740 * is not NULL.
1741 * Return FAIL if the parsing fails.
1742 */
1743 int
1744parse_completepopup(win_T *wp)
1745{
1746 return parse_popup_option(wp, FALSE);
1747}
1748
1749/*
Bram Moolenaar79648732019-07-18 21:43:07 +02001750 * Set w_wantline and w_wantcol for the cursor position in the current window.
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001751 * Keep at least "width" columns from the right of the screen.
Bram Moolenaar79648732019-07-18 21:43:07 +02001752 */
1753 void
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001754popup_set_wantpos_cursor(win_T *wp, int width, dict_T *d)
Bram Moolenaar79648732019-07-18 21:43:07 +02001755{
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001756 poppos_T ppt = POPPOS_NONE;
1757
1758 if (d != NULL)
1759 ppt = get_pos_entry(d, FALSE);
1760
Bram Moolenaar79648732019-07-18 21:43:07 +02001761 setcursor_mayforce(TRUE);
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001762 if (ppt == POPPOS_TOPRIGHT || ppt == POPPOS_TOPLEFT)
Bram Moolenaar79648732019-07-18 21:43:07 +02001763 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001764 wp->w_wantline = curwin->w_winrow + curwin->w_wrow + 2;
1765 }
1766 else
1767 {
1768 wp->w_wantline = curwin->w_winrow + curwin->w_wrow;
1769 if (wp->w_wantline == 0) // cursor in first line
1770 {
1771 wp->w_wantline = 2;
1772 wp->w_popup_pos = ppt == POPPOS_BOTRIGHT
1773 ? POPPOS_TOPRIGHT : POPPOS_TOPLEFT;
1774 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001775 }
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001776
Bram Moolenaar79648732019-07-18 21:43:07 +02001777 wp->w_wantcol = curwin->w_wincol + curwin->w_wcol + 1;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02001778 if (wp->w_wantcol > Columns - width)
1779 {
1780 wp->w_wantcol = Columns - width;
1781 if (wp->w_wantcol < 1)
1782 wp->w_wantcol = 1;
1783 }
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001784
Bram Moolenaar79648732019-07-18 21:43:07 +02001785 popup_adjust_position(wp);
1786}
1787
1788/*
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001789 * Set w_wantline and w_wantcol for the a given screen position.
1790 * Caller must take care of running into the window border.
1791 */
1792 void
1793popup_set_wantpos_rowcol(win_T *wp, int row, int col)
1794{
1795 wp->w_wantline = row;
1796 wp->w_wantcol = col;
1797 popup_adjust_position(wp);
1798}
1799
1800/*
1801 * Add a border and lef&right padding.
1802 */
1803 static void
1804add_border_left_right_padding(win_T *wp)
1805{
1806 int i;
1807
1808 for (i = 0; i < 4; ++i)
1809 {
1810 wp->w_popup_border[i] = 1;
1811 wp->w_popup_padding[i] = (i & 1) ? 1 : 0;
1812 }
1813}
1814
Bram Moolenaarc33b3212020-05-18 20:12:09 +02001815#ifdef FEAT_TERMINAL
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001816/*
Bram Moolenaarb5383b12020-05-18 19:46:48 +02001817 * Return TRUE if there is any popup window with a terminal buffer.
1818 */
1819 static int
1820popup_terminal_exists(void)
1821{
1822 win_T *wp;
1823 tabpage_T *tp;
1824
1825 FOR_ALL_POPUPWINS(wp)
1826 if (wp->w_buffer->b_term != NULL)
1827 return TRUE;
1828 FOR_ALL_TABPAGES(tp)
1829 FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
1830 if (wp->w_buffer->b_term != NULL)
1831 return TRUE;
1832 return FALSE;
1833}
Bram Moolenaarc33b3212020-05-18 20:12:09 +02001834#endif
Bram Moolenaarb5383b12020-05-18 19:46:48 +02001835
1836/*
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001837 * popup_create({text}, {options})
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02001838 * popup_atcursor({text}, {options})
Bram Moolenaar79648732019-07-18 21:43:07 +02001839 * etc.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001840 * When creating a preview or info popup "argvars" and "rettv" are NULL.
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001841 */
Bram Moolenaara730e552019-06-16 19:05:31 +02001842 static win_T *
Bram Moolenaar17627312019-06-02 19:53:44 +02001843popup_create(typval_T *argvars, typval_T *rettv, create_type_T type)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001844{
Bram Moolenaara3fce622019-06-20 02:31:49 +02001845 win_T *wp;
1846 tabpage_T *tp = NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001847 int tabnr = 0;
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001848 int new_buffer;
1849 buf_T *buf = NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001850 dict_T *d = NULL;
Bram Moolenaara3fce622019-06-20 02:31:49 +02001851 int nr;
1852 int i;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001853
Bram Moolenaar79648732019-07-18 21:43:07 +02001854 if (argvars != NULL)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001855 {
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02001856 // Check that arguments look OK.
Bram Moolenaar79648732019-07-18 21:43:07 +02001857 if (argvars[0].v_type == VAR_NUMBER)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001858 {
Bram Moolenaar49540192019-12-11 19:34:54 +01001859 buf = buflist_findnr(argvars[0].vval.v_number);
Bram Moolenaar79648732019-07-18 21:43:07 +02001860 if (buf == NULL)
1861 {
1862 semsg(_(e_nobufnr), argvars[0].vval.v_number);
1863 return NULL;
1864 }
Bram Moolenaarb5383b12020-05-18 19:46:48 +02001865#ifdef FEAT_TERMINAL
1866 if (buf->b_term != NULL && popup_terminal_exists())
1867 {
1868 emsg(_("E861: Cannot open a second popup with a terminal"));
1869 return NULL;
1870 }
1871#endif
Bram Moolenaar79648732019-07-18 21:43:07 +02001872 }
1873 else if (!(argvars[0].v_type == VAR_STRING
1874 && argvars[0].vval.v_string != NULL)
1875 && !(argvars[0].v_type == VAR_LIST
1876 && argvars[0].vval.v_list != NULL))
1877 {
Bram Moolenaar219c7d02020-02-01 21:57:29 +01001878 emsg(_("E450: buffer number, text or a list required"));
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001879 return NULL;
1880 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001881 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
Bram Moolenaara3fce622019-06-20 02:31:49 +02001882 {
Bram Moolenaar79648732019-07-18 21:43:07 +02001883 emsg(_(e_dictreq));
Bram Moolenaara3fce622019-06-20 02:31:49 +02001884 return NULL;
1885 }
Bram Moolenaar79648732019-07-18 21:43:07 +02001886 d = argvars[1].vval.v_dict;
1887 }
1888
1889 if (d != NULL)
1890 {
1891 if (dict_find(d, (char_u *)"tabpage", -1) != NULL)
1892 tabnr = (int)dict_get_number(d, (char_u *)"tabpage");
1893 else if (type == TYPE_NOTIFICATION)
1894 tabnr = -1; // notifications are global by default
1895 else
1896 tabnr = 0;
1897 if (tabnr > 0)
1898 {
1899 tp = find_tabpage(tabnr);
1900 if (tp == NULL)
1901 {
1902 semsg(_("E997: Tabpage not found: %d"), tabnr);
1903 return NULL;
1904 }
1905 }
Bram Moolenaara3fce622019-06-20 02:31:49 +02001906 }
1907
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001908 // Create the window and buffer.
1909 wp = win_alloc_popup_win();
1910 if (wp == NULL)
Bram Moolenaara730e552019-06-16 19:05:31 +02001911 return NULL;
Bram Moolenaar79648732019-07-18 21:43:07 +02001912 if (rettv != NULL)
1913 rettv->vval.v_number = wp->w_id;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001914 wp->w_popup_pos = POPPOS_TOPLEFT;
Bram Moolenaar638a4a72019-11-06 19:25:22 +01001915 wp->w_popup_flags = POPF_IS_POPUP | POPF_MAPPING | POPF_POSINVERT;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001916
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001917 if (buf != NULL)
1918 {
1919 // use existing buffer
1920 new_buffer = FALSE;
Bram Moolenaar7866b872019-07-01 22:21:01 +02001921 win_init_popup_win(wp, buf);
Bram Moolenaar46451042019-08-24 15:50:46 +02001922 set_local_options_default(wp, FALSE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001923 buffer_ensure_loaded(buf);
1924 }
1925 else
1926 {
1927 // create a new buffer associated with the popup
1928 new_buffer = TRUE;
Bram Moolenaar00b0d6d2019-08-21 22:25:30 +02001929 buf = buflist_new(NULL, NULL, (linenr_T)0, BLN_NEW|BLN_DUMMY|BLN_REUSE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001930 if (buf == NULL)
1931 return NULL;
1932 ml_open(buf);
Bram Moolenaarcacc6a52019-05-30 15:22:43 +02001933
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001934 win_init_popup_win(wp, buf);
Bram Moolenaarcacc6a52019-05-30 15:22:43 +02001935
Bram Moolenaar46451042019-08-24 15:50:46 +02001936 set_local_options_default(wp, TRUE);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001937 set_string_option_direct_in_buf(buf, (char_u *)"buftype", -1,
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001938 (char_u *)"popup", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001939 set_string_option_direct_in_buf(buf, (char_u *)"bufhidden", -1,
Bram Moolenaar79648732019-07-18 21:43:07 +02001940 (char_u *)"wipe", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001941 buf->b_p_ul = -1; // no undo
1942 buf->b_p_swf = FALSE; // no swap file
1943 buf->b_p_bl = FALSE; // unlisted buffer
1944 buf->b_locked = TRUE;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02001945
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001946 // Avoid that 'buftype' is reset when this buffer is entered.
1947 buf->b_p_initialized = TRUE;
1948 }
Bram Moolenaara112f2d2019-09-01 17:38:09 +02001949 wp->w_p_wrap = TRUE; // 'wrap' is default on
1950 wp->w_p_so = 0; // 'scrolloff' zero
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001951
Bram Moolenaara3fce622019-06-20 02:31:49 +02001952 if (tp != NULL)
1953 {
1954 // popup on specified tab page
1955 wp->w_next = tp->tp_first_popupwin;
1956 tp->tp_first_popupwin = wp;
1957 }
1958 else if (tabnr == 0)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001959 {
Bram Moolenaarfc06cbb2019-06-15 14:14:31 +02001960 // popup on current tab page
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02001961 wp->w_next = curtab->tp_first_popupwin;
1962 curtab->tp_first_popupwin = wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001963 }
Bram Moolenaara3fce622019-06-20 02:31:49 +02001964 else // (tabnr < 0)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001965 {
Bram Moolenaar68d48f42019-06-12 22:42:41 +02001966 win_T *prev = first_popupwin;
1967
1968 // Global popup: add at the end, so that it gets displayed on top of
1969 // older ones with the same zindex. Matters for notifications.
1970 if (first_popupwin == NULL)
1971 first_popupwin = wp;
1972 else
1973 {
1974 while (prev->w_next != NULL)
1975 prev = prev->w_next;
1976 prev->w_next = wp;
1977 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001978 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001979
Bram Moolenaar79648732019-07-18 21:43:07 +02001980 if (new_buffer && argvars != NULL)
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02001981 popup_set_buffer_text(buf, argvars[0]);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001982
Bram Moolenaar79648732019-07-18 21:43:07 +02001983 if (type == TYPE_ATCURSOR || type == TYPE_PREVIEW)
Bram Moolenaar17627312019-06-02 19:53:44 +02001984 {
1985 wp->w_popup_pos = POPPOS_BOTLEFT;
Bram Moolenaar79648732019-07-18 21:43:07 +02001986 }
1987 if (type == TYPE_ATCURSOR)
1988 {
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01001989 popup_set_wantpos_cursor(wp, 0, d);
Bram Moolenaar17627312019-06-02 19:53:44 +02001990 set_moved_values(wp);
1991 set_moved_columns(wp, FIND_STRING);
1992 }
1993
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02001994 if (type == TYPE_BEVAL)
1995 {
1996 wp->w_popup_pos = POPPOS_BOTLEFT;
1997
1998 // by default use the mouse position
1999 wp->w_wantline = mouse_row;
2000 if (wp->w_wantline <= 0) // mouse on first line
2001 {
2002 wp->w_wantline = 2;
2003 wp->w_popup_pos = POPPOS_TOPLEFT;
2004 }
2005 wp->w_wantcol = mouse_col + 1;
2006 set_mousemoved_values(wp);
2007 set_mousemoved_columns(wp, FIND_IDENT + FIND_STRING + FIND_EVAL);
2008 }
2009
Bram Moolenaar33796b32019-06-08 16:01:13 +02002010 // set default values
2011 wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002012 wp->w_popup_close = POPCLOSE_NONE;
Bram Moolenaar33796b32019-06-08 16:01:13 +02002013
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002014 if (type == TYPE_NOTIFICATION)
2015 {
2016 win_T *twp, *nextwin;
2017 int height = buf->b_ml.ml_line_count + 3;
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002018
2019 // Try to not overlap with another global popup. Guess we need 3
2020 // more screen lines than buffer lines.
2021 wp->w_wantline = 1;
2022 for (twp = first_popupwin; twp != NULL; twp = nextwin)
2023 {
2024 nextwin = twp->w_next;
2025 if (twp != wp
2026 && twp->w_zindex == POPUPWIN_NOTIFICATION_ZINDEX
2027 && twp->w_winrow <= wp->w_wantline - 1 + height
2028 && twp->w_winrow + popup_height(twp) > wp->w_wantline - 1)
2029 {
2030 // move to below this popup and restart the loop to check for
2031 // overlap with other popups
2032 wp->w_wantline = twp->w_winrow + popup_height(twp) + 1;
2033 nextwin = first_popupwin;
2034 }
2035 }
2036 if (wp->w_wantline + height > Rows)
2037 {
2038 // can't avoid overlap, put on top in the hope that message goes
2039 // away soon.
2040 wp->w_wantline = 1;
2041 }
2042
2043 wp->w_wantcol = 10;
2044 wp->w_zindex = POPUPWIN_NOTIFICATION_ZINDEX;
Bram Moolenaardfa97f22019-06-15 14:31:55 +02002045 wp->w_minwidth = 20;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002046 wp->w_popup_flags |= POPF_DRAG;
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002047 wp->w_popup_close = POPCLOSE_CLICK;
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002048 for (i = 0; i < 4; ++i)
2049 wp->w_popup_border[i] = 1;
2050 wp->w_popup_padding[1] = 1;
2051 wp->w_popup_padding[3] = 1;
Bram Moolenaardfa97f22019-06-15 14:31:55 +02002052
2053 nr = syn_name2id((char_u *)"PopupNotification");
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002054 set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
Bram Moolenaardfa97f22019-06-15 14:31:55 +02002055 (char_u *)(nr == 0 ? "WarningMsg" : "PopupNotification"),
2056 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002057 }
2058
Bram Moolenaara730e552019-06-16 19:05:31 +02002059 if (type == TYPE_DIALOG || type == TYPE_MENU)
Bram Moolenaara42d9452019-06-15 21:46:30 +02002060 {
Bram Moolenaara42d9452019-06-15 21:46:30 +02002061 wp->w_popup_pos = POPPOS_CENTER;
2062 wp->w_zindex = POPUPWIN_DIALOG_ZINDEX;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002063 wp->w_popup_flags |= POPF_DRAG;
Bram Moolenaar749fa0a2019-08-03 16:18:07 +02002064 wp->w_popup_flags &= ~POPF_MAPPING;
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002065 add_border_left_right_padding(wp);
Bram Moolenaara42d9452019-06-15 21:46:30 +02002066 }
2067
Bram Moolenaara730e552019-06-16 19:05:31 +02002068 if (type == TYPE_MENU)
2069 {
2070 typval_T tv;
2071 callback_T callback;
2072
2073 tv.v_type = VAR_STRING;
2074 tv.vval.v_string = (char_u *)"popup_filter_menu";
2075 callback = get_callback(&tv);
2076 if (callback.cb_name != NULL)
2077 set_callback(&wp->w_filter_cb, &callback);
2078
2079 wp->w_p_wrap = 0;
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02002080 wp->w_popup_flags |= POPF_CURSORLINE;
Bram Moolenaara730e552019-06-16 19:05:31 +02002081 }
2082
Bram Moolenaar79648732019-07-18 21:43:07 +02002083 if (type == TYPE_PREVIEW)
2084 {
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002085 wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
Bram Moolenaar79648732019-07-18 21:43:07 +02002086 wp->w_popup_close = POPCLOSE_BUTTON;
2087 for (i = 0; i < 4; ++i)
2088 wp->w_popup_border[i] = 1;
2089 parse_previewpopup(wp);
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01002090 popup_set_wantpos_cursor(wp, wp->w_minwidth, d);
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002091 }
Bram Moolenaar36e4d982019-08-20 21:12:16 +02002092# ifdef FEAT_QUICKFIX
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002093 if (type == TYPE_INFO)
2094 {
2095 wp->w_popup_pos = POPPOS_TOPLEFT;
2096 wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
2097 wp->w_popup_close = POPCLOSE_BUTTON;
2098 add_border_left_right_padding(wp);
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002099 parse_completepopup(wp);
Bram Moolenaar79648732019-07-18 21:43:07 +02002100 }
Bram Moolenaar36e4d982019-08-20 21:12:16 +02002101# endif
Bram Moolenaar79648732019-07-18 21:43:07 +02002102
Bram Moolenaarae943152019-06-16 22:54:14 +02002103 for (i = 0; i < 4; ++i)
2104 VIM_CLEAR(wp->w_border_highlight[i]);
2105 for (i = 0; i < 8; ++i)
2106 wp->w_border_char[i] = 0;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002107 wp->w_want_scrollbar = 1;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02002108 wp->w_popup_fixed = 0;
Bram Moolenaar581ba392019-09-03 22:08:33 +02002109 wp->w_filter_mode = MODE_ALL;
Bram Moolenaarae943152019-06-16 22:54:14 +02002110
Bram Moolenaar79648732019-07-18 21:43:07 +02002111 if (d != NULL)
2112 // Deal with options.
Bram Moolenaar3697c9b2020-09-26 22:03:00 +02002113 apply_options(wp, d, TRUE);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002114
Bram Moolenaar0fcf26b2019-06-23 01:03:51 +02002115#ifdef FEAT_TIMERS
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002116 if (type == TYPE_NOTIFICATION && wp->w_popup_timer == NULL)
2117 popup_add_timeout(wp, 3000);
Bram Moolenaar0fcf26b2019-06-23 01:03:51 +02002118#endif
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002119
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002120 popup_adjust_position(wp);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002121
2122 wp->w_vsep_width = 0;
2123
2124 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002125 popup_mask_refresh = TRUE;
Bram Moolenaara730e552019-06-16 19:05:31 +02002126
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002127#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002128 // When running a terminal in the popup it becomes the current window.
2129 if (buf->b_term != NULL)
2130 win_enter(wp, FALSE);
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002131#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002132
Bram Moolenaara730e552019-06-16 19:05:31 +02002133 return wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002134}
2135
2136/*
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002137 * popup_clear()
2138 */
2139 void
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002140f_popup_clear(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002141{
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002142 int force = FALSE;
2143
2144 if (argvars[0].v_type != VAR_UNKNOWN)
Bram Moolenaar62f93f42020-09-02 22:33:24 +02002145 force = (int)tv_get_bool(&argvars[0]);
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002146 close_all_popups(force);
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002147}
2148
2149/*
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002150 * popup_create({text}, {options})
2151 */
2152 void
2153f_popup_create(typval_T *argvars, typval_T *rettv)
2154{
Bram Moolenaar17627312019-06-02 19:53:44 +02002155 popup_create(argvars, rettv, TYPE_NORMAL);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002156}
2157
2158/*
2159 * popup_atcursor({text}, {options})
2160 */
2161 void
2162f_popup_atcursor(typval_T *argvars, typval_T *rettv)
2163{
Bram Moolenaar17627312019-06-02 19:53:44 +02002164 popup_create(argvars, rettv, TYPE_ATCURSOR);
Bram Moolenaarcc31ad92019-05-30 19:25:06 +02002165}
2166
2167/*
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002168 * popup_beval({text}, {options})
2169 */
2170 void
2171f_popup_beval(typval_T *argvars, typval_T *rettv)
2172{
2173 popup_create(argvars, rettv, TYPE_BEVAL);
2174}
2175
2176/*
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002177 * Invoke the close callback for window "wp" with value "result".
2178 * Careful: The callback may make "wp" invalid!
2179 */
2180 static void
2181invoke_popup_callback(win_T *wp, typval_T *result)
2182{
2183 typval_T rettv;
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002184 typval_T argv[3];
2185
2186 argv[0].v_type = VAR_NUMBER;
2187 argv[0].vval.v_number = (varnumber_T)wp->w_id;
2188
2189 if (result != NULL && result->v_type != VAR_UNKNOWN)
2190 copy_tv(result, &argv[1]);
2191 else
2192 {
2193 argv[1].v_type = VAR_NUMBER;
2194 argv[1].vval.v_number = 0;
2195 }
2196
2197 argv[2].v_type = VAR_UNKNOWN;
2198
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002199 call_callback(&wp->w_close_cb, -1, &rettv, 2, argv);
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002200 if (result != NULL)
2201 clear_tv(&argv[1]);
2202 clear_tv(&rettv);
2203}
2204
2205/*
Bram Moolenaarab176ce2020-06-15 21:19:08 +02002206 * Make "prevwin" the current window, unless it's equal to "wp".
2207 * Otherwise make "firstwin" the current window.
2208 */
2209 static void
2210back_to_prevwin(win_T *wp)
2211{
2212 if (win_valid(prevwin) && wp != prevwin)
2213 win_enter(prevwin, FALSE);
2214 else
2215 win_enter(firstwin, FALSE);
2216}
2217
2218/*
Bram Moolenaar3397f742019-06-02 18:40:06 +02002219 * Close popup "wp" and invoke any close callback for it.
2220 */
2221 static void
2222popup_close_and_callback(win_T *wp, typval_T *arg)
2223{
2224 int id = wp->w_id;
2225
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002226#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002227 if (wp == curwin && curbuf->b_term != NULL)
2228 {
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002229 win_T *owp;
2230
2231 // Closing popup window with a terminal: put focus back on the first
2232 // that works:
2233 // - another popup window with a terminal
2234 // - the previous window
2235 // - the first one.
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002236 FOR_ALL_POPUPWINS(owp)
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002237 if (owp != curwin && owp->w_buffer->b_term != NULL)
2238 break;
2239 if (owp != NULL)
2240 win_enter(owp, FALSE);
2241 else
2242 {
2243 for (owp = curtab->tp_first_popupwin; owp != NULL;
2244 owp = owp->w_next)
2245 if (owp != curwin && owp->w_buffer->b_term != NULL)
2246 break;
2247 if (owp != NULL)
2248 win_enter(owp, FALSE);
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002249 else
Bram Moolenaarab176ce2020-06-15 21:19:08 +02002250 back_to_prevwin(wp);
Bram Moolenaar80ae8802020-02-28 19:11:18 +01002251 }
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002252 }
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01002253#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002254
Bram Moolenaar49540192019-12-11 19:34:54 +01002255 // Just in case a check higher up is missing.
2256 if (wp == curwin && ERROR_IF_POPUP_WINDOW)
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02002257 {
2258 // To avoid getting stuck when win_execute() does something that causes
2259 // an error, stop calling the filter callback.
2260 free_callback(&wp->w_filter_cb);
2261
Bram Moolenaar49540192019-12-11 19:34:54 +01002262 return;
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02002263 }
Bram Moolenaar49540192019-12-11 19:34:54 +01002264
Bram Moolenaarcee52202020-03-11 14:19:58 +01002265 CHECK_CURBUF;
Bram Moolenaar3397f742019-06-02 18:40:06 +02002266 if (wp->w_close_cb.cb_name != NULL)
2267 // Careful: This may make "wp" invalid.
2268 invoke_popup_callback(wp, arg);
2269
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002270 popup_close(id, FALSE);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002271 CHECK_CURBUF;
Bram Moolenaar3397f742019-06-02 18:40:06 +02002272}
2273
Bram Moolenaar219c7d02020-02-01 21:57:29 +01002274 void
Bram Moolenaar12034e22019-08-25 22:25:02 +02002275popup_close_with_retval(win_T *wp, int retval)
2276{
2277 typval_T res;
2278
2279 res.v_type = VAR_NUMBER;
2280 res.vval.v_number = retval;
2281 popup_close_and_callback(wp, &res);
2282}
2283
Bram Moolenaar3397f742019-06-02 18:40:06 +02002284/*
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002285 * Close popup "wp" because of a mouse click.
2286 */
2287 void
2288popup_close_for_mouse_click(win_T *wp)
2289{
Bram Moolenaar12034e22019-08-25 22:25:02 +02002290 popup_close_with_retval(wp, -2);
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002291}
2292
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002293 static void
2294check_mouse_moved(win_T *wp, win_T *mouse_wp)
2295{
2296 // Close the popup when all if these are true:
2297 // - the mouse is not on this popup
2298 // - "mousemoved" was used
2299 // - the mouse is no longer on the same screen row or the mouse column is
2300 // outside of the relevant text
2301 if (wp != mouse_wp
2302 && wp->w_popup_mouse_row != 0
2303 && (wp->w_popup_mouse_row != mouse_row
2304 || mouse_col < wp->w_popup_mouse_mincol
2305 || mouse_col > wp->w_popup_mouse_maxcol))
2306 {
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002307 // Careful: this makes "wp" invalid.
Bram Moolenaar12034e22019-08-25 22:25:02 +02002308 popup_close_with_retval(wp, -2);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002309 }
2310}
2311
2312/*
2313 * Called when the mouse moved: may close a popup with "mousemoved".
2314 */
2315 void
2316popup_handle_mouse_moved(void)
2317{
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002318 win_T *wp, *nextwp;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002319 win_T *mouse_wp;
2320 int row = mouse_row;
2321 int col = mouse_col;
2322
2323 // find the window where the mouse is in
2324 mouse_wp = mouse_find_win(&row, &col, FIND_POPUP);
2325
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002326 for (wp = first_popupwin; wp != NULL; wp = nextwp)
2327 {
2328 nextwp = wp->w_next;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002329 check_mouse_moved(wp, mouse_wp);
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002330 }
2331 for (wp = curtab->tp_first_popupwin; wp != NULL; wp = nextwp)
2332 {
2333 nextwp = wp->w_next;
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002334 check_mouse_moved(wp, mouse_wp);
Bram Moolenaar3e35d052019-07-07 20:43:34 +02002335 }
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002336}
2337
Bram Moolenaar2e62b562019-06-30 18:07:00 +02002338/*
Bram Moolenaara730e552019-06-16 19:05:31 +02002339 * In a filter: check if the typed key is a mouse event that is used for
2340 * dragging the popup.
2341 */
2342 static void
2343filter_handle_drag(win_T *wp, int c, typval_T *rettv)
2344{
2345 int row = mouse_row;
2346 int col = mouse_col;
2347
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002348 if ((wp->w_popup_flags & POPF_DRAG)
Bram Moolenaara730e552019-06-16 19:05:31 +02002349 && is_mouse_key(c)
2350 && (wp == popup_dragwin
2351 || wp == mouse_find_win(&row, &col, FIND_POPUP)))
2352 // do not consume the key, allow for dragging the popup
2353 rettv->vval.v_number = 0;
2354}
2355
Bram Moolenaara730e552019-06-16 19:05:31 +02002356/*
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002357 * popup_filter_menu({id}, {key})
Bram Moolenaara730e552019-06-16 19:05:31 +02002358 */
2359 void
2360f_popup_filter_menu(typval_T *argvars, typval_T *rettv)
2361{
2362 int id = tv_get_number(&argvars[0]);
2363 win_T *wp = win_id2wp(id);
2364 char_u *key = tv_get_string(&argvars[1]);
2365 typval_T res;
2366 int c;
2367 linenr_T old_lnum;
2368
2369 // If the popup has been closed do not consume the key.
2370 if (wp == NULL)
2371 return;
2372
2373 c = *key;
2374 if (c == K_SPECIAL && key[1] != NUL)
2375 c = TO_SPECIAL(key[1], key[2]);
2376
2377 // consume all keys until done
Bram Moolenaar403dc312020-10-17 19:29:51 +02002378 rettv->v_type = VAR_BOOL;
2379 rettv->vval.v_number = VVAL_TRUE;
Bram Moolenaara730e552019-06-16 19:05:31 +02002380 res.v_type = VAR_NUMBER;
2381
2382 old_lnum = wp->w_cursor.lnum;
Bram Moolenaar014f6982021-01-04 13:18:30 +01002383 if ((c == 'k' || c == 'K' || c == K_UP || c == Ctrl_P)
2384 && wp->w_cursor.lnum > 1)
Bram Moolenaara730e552019-06-16 19:05:31 +02002385 --wp->w_cursor.lnum;
Bram Moolenaar014f6982021-01-04 13:18:30 +01002386 if ((c == 'j' || c == 'J' || c == K_DOWN || c == Ctrl_N)
Bram Moolenaara730e552019-06-16 19:05:31 +02002387 && wp->w_cursor.lnum < wp->w_buffer->b_ml.ml_line_count)
2388 ++wp->w_cursor.lnum;
2389 if (old_lnum != wp->w_cursor.lnum)
2390 {
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002391 // caller will call popup_highlight_curline()
Bram Moolenaara730e552019-06-16 19:05:31 +02002392 return;
2393 }
2394
2395 if (c == 'x' || c == 'X' || c == ESC || c == Ctrl_C)
2396 {
2397 // Cancelled, invoke callback with -1
2398 res.vval.v_number = -1;
2399 popup_close_and_callback(wp, &res);
2400 return;
2401 }
2402 if (c == ' ' || c == K_KENTER || c == CAR || c == NL)
2403 {
2404 // Invoke callback with current index.
2405 res.vval.v_number = wp->w_cursor.lnum;
2406 popup_close_and_callback(wp, &res);
2407 return;
2408 }
2409
2410 filter_handle_drag(wp, c, rettv);
2411}
2412
2413/*
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002414 * popup_filter_yesno({id}, {key})
Bram Moolenaara42d9452019-06-15 21:46:30 +02002415 */
2416 void
2417f_popup_filter_yesno(typval_T *argvars, typval_T *rettv)
2418{
2419 int id = tv_get_number(&argvars[0]);
2420 win_T *wp = win_id2wp(id);
2421 char_u *key = tv_get_string(&argvars[1]);
2422 typval_T res;
Bram Moolenaara730e552019-06-16 19:05:31 +02002423 int c;
Bram Moolenaara42d9452019-06-15 21:46:30 +02002424
2425 // If the popup has been closed don't consume the key.
2426 if (wp == NULL)
2427 return;
2428
Bram Moolenaara730e552019-06-16 19:05:31 +02002429 c = *key;
2430 if (c == K_SPECIAL && key[1] != NUL)
2431 c = TO_SPECIAL(key[1], key[2]);
2432
Bram Moolenaara42d9452019-06-15 21:46:30 +02002433 // consume all keys until done
Bram Moolenaar403dc312020-10-17 19:29:51 +02002434 rettv->v_type = VAR_BOOL;
2435 rettv->vval.v_number = VVAL_TRUE;
Bram Moolenaara42d9452019-06-15 21:46:30 +02002436
Bram Moolenaara730e552019-06-16 19:05:31 +02002437 if (c == 'y' || c == 'Y')
Bram Moolenaara42d9452019-06-15 21:46:30 +02002438 res.vval.v_number = 1;
Bram Moolenaara730e552019-06-16 19:05:31 +02002439 else if (c == 'n' || c == 'N' || c == 'x' || c == 'X' || c == ESC)
Bram Moolenaara42d9452019-06-15 21:46:30 +02002440 res.vval.v_number = 0;
2441 else
2442 {
Bram Moolenaara730e552019-06-16 19:05:31 +02002443 filter_handle_drag(wp, c, rettv);
Bram Moolenaara42d9452019-06-15 21:46:30 +02002444 return;
2445 }
2446
2447 // Invoke callback
2448 res.v_type = VAR_NUMBER;
2449 popup_close_and_callback(wp, &res);
2450}
2451
2452/*
2453 * popup_dialog({text}, {options})
2454 */
2455 void
2456f_popup_dialog(typval_T *argvars, typval_T *rettv)
2457{
2458 popup_create(argvars, rettv, TYPE_DIALOG);
2459}
2460
2461/*
Bram Moolenaara730e552019-06-16 19:05:31 +02002462 * popup_menu({text}, {options})
2463 */
2464 void
2465f_popup_menu(typval_T *argvars, typval_T *rettv)
2466{
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02002467 popup_create(argvars, rettv, TYPE_MENU);
Bram Moolenaara730e552019-06-16 19:05:31 +02002468}
2469
2470/*
Bram Moolenaara42d9452019-06-15 21:46:30 +02002471 * popup_notification({text}, {options})
2472 */
2473 void
2474f_popup_notification(typval_T *argvars, typval_T *rettv)
2475{
2476 popup_create(argvars, rettv, TYPE_NOTIFICATION);
2477}
2478
2479/*
2480 * Find the popup window with window-ID "id".
2481 * If the popup window does not exist NULL is returned.
2482 * If the window is not a popup window, and error message is given.
2483 */
2484 static win_T *
2485find_popup_win(int id)
2486{
2487 win_T *wp = win_id2wp(id);
2488
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002489 if (wp != NULL && !WIN_IS_POPUP(wp))
Bram Moolenaara42d9452019-06-15 21:46:30 +02002490 {
2491 semsg(_("E993: window %d is not a popup window"), id);
2492 return NULL;
2493 }
2494 return wp;
2495}
2496
2497/*
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002498 * popup_close({id})
2499 */
2500 void
2501f_popup_close(typval_T *argvars, typval_T *rettv UNUSED)
2502{
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002503 int id = (int)tv_get_number(argvars);
Bram Moolenaar49540192019-12-11 19:34:54 +01002504 win_T *wp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002505
Bram Moolenaar11ec8072020-02-20 20:12:29 +01002506 if (
2507# ifdef FEAT_TERMINAL
2508 // if the popup contains a terminal it will become hidden
2509 curbuf->b_term == NULL &&
2510# endif
2511 ERROR_IF_ANY_POPUP_WINDOW)
Bram Moolenaar49540192019-12-11 19:34:54 +01002512 return;
2513
2514 wp = find_popup_win(id);
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002515 if (wp != NULL)
Bram Moolenaar3397f742019-06-02 18:40:06 +02002516 popup_close_and_callback(wp, &argvars[1]);
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002517}
2518
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002519 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002520popup_hide(win_T *wp)
2521{
Bram Moolenaar2e6638d2020-02-05 21:07:18 +01002522#ifdef FEAT_TERMINAL
2523 if (error_if_term_popup_window())
2524 return;
2525#endif
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002526 if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
2527 {
2528 wp->w_popup_flags |= POPF_HIDDEN;
Bram Moolenaarca7c0782020-01-14 20:42:48 +01002529 // Do not decrement b_nwindows, we still reference the buffer.
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002530 redraw_all_later(NOT_VALID);
2531 popup_mask_refresh = TRUE;
2532 }
2533}
2534
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002535/*
2536 * popup_hide({id})
2537 */
2538 void
2539f_popup_hide(typval_T *argvars, typval_T *rettv UNUSED)
2540{
2541 int id = (int)tv_get_number(argvars);
2542 win_T *wp = find_popup_win(id);
2543
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002544 if (wp != NULL)
2545 popup_hide(wp);
2546}
2547
2548 void
2549popup_show(win_T *wp)
2550{
2551 if ((wp->w_popup_flags & POPF_HIDDEN) != 0)
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002552 {
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002553 wp->w_popup_flags &= ~POPF_HIDDEN;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002554 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002555 popup_mask_refresh = TRUE;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002556 }
2557}
2558
2559/*
2560 * popup_show({id})
2561 */
2562 void
2563f_popup_show(typval_T *argvars, typval_T *rettv UNUSED)
2564{
2565 int id = (int)tv_get_number(argvars);
2566 win_T *wp = find_popup_win(id);
2567
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002568 if (wp != NULL)
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002569 {
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02002570 popup_show(wp);
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01002571#ifdef FEAT_QUICKFIX
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002572 if (wp->w_popup_flags & POPF_INFO)
2573 pum_position_info_popup(wp);
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01002574#endif
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002575 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002576}
2577
Bram Moolenaardc2ce582019-06-16 15:32:14 +02002578/*
2579 * popup_settext({id}, {text})
2580 */
2581 void
2582f_popup_settext(typval_T *argvars, typval_T *rettv UNUSED)
2583{
2584 int id = (int)tv_get_number(&argvars[0]);
2585 win_T *wp = find_popup_win(id);
2586
2587 if (wp != NULL)
2588 {
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002589 if (argvars[1].v_type != VAR_STRING && argvars[1].v_type != VAR_LIST)
2590 semsg(_(e_invarg2), tv_get_string(&argvars[1]));
2591 else
2592 {
2593 popup_set_buffer_text(wp->w_buffer, argvars[1]);
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02002594 redraw_win_later(wp, NOT_VALID);
Bram Moolenaar5b8cfed2019-06-30 22:16:10 +02002595 popup_adjust_position(wp);
2596 }
Bram Moolenaardc2ce582019-06-16 15:32:14 +02002597 }
2598}
2599
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002600 static void
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002601popup_free(win_T *wp)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002602{
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002603 sign_undefine_by_name(popup_get_sign_name(wp), FALSE);
Bram Moolenaar868b7b62019-05-29 21:44:40 +02002604 wp->w_buffer->b_locked = FALSE;
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02002605 if (wp->w_winrow + popup_height(wp) >= cmdline_row)
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002606 clear_cmdline = TRUE;
2607 win_free_popup(wp);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02002608
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002609 redraw_all_later(NOT_VALID);
Bram Moolenaar33796b32019-06-08 16:01:13 +02002610 popup_mask_refresh = TRUE;
Bram Moolenaar51fe3b12019-05-26 20:10:06 +02002611}
2612
Bram Moolenaar82106932020-03-13 14:34:38 +01002613 static void
2614error_for_popup_window(void)
2615{
2616 emsg(_("E994: Not allowed in a popup window"));
2617}
2618
2619 int
2620error_if_popup_window(int also_with_term UNUSED)
2621{
2622 // win_execute() may set "curwin" to a popup window temporarily, but many
2623 // commands are disallowed then. When a terminal runs in the popup most
2624 // things are allowed. When a terminal is finished it can be closed.
2625 if (WIN_IS_POPUP(curwin)
2626# ifdef FEAT_TERMINAL
2627 && (also_with_term || curbuf->b_term == NULL)
2628 && !term_is_finished(curbuf)
2629# endif
2630 )
2631 {
2632 error_for_popup_window();
2633 return TRUE;
2634 }
2635 return FALSE;
2636}
2637
Bram Moolenaarec583842019-05-26 14:11:23 +02002638/*
2639 * Close a popup window by Window-id.
Bram Moolenaar9eaac892019-06-01 22:49:29 +02002640 * Does not invoke the callback.
Bram Moolenaard502aa42020-05-13 01:04:32 +02002641 * Return OK if the popup was closed, FAIL otherwise.
Bram Moolenaarec583842019-05-26 14:11:23 +02002642 */
Bram Moolenaard502aa42020-05-13 01:04:32 +02002643 int
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002644popup_close(int id, int force)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002645{
2646 win_T *wp;
Bram Moolenaarec583842019-05-26 14:11:23 +02002647 tabpage_T *tp;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002648 win_T *prev = NULL;
2649
Bram Moolenaarec583842019-05-26 14:11:23 +02002650 // go through global popups
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002651 for (wp = first_popupwin; wp != NULL; prev = wp, wp = wp->w_next)
Bram Moolenaarec583842019-05-26 14:11:23 +02002652 if (wp->w_id == id)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002653 {
Bram Moolenaarcee52202020-03-11 14:19:58 +01002654 if (wp == curwin)
2655 {
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002656 if (!force)
2657 {
2658 error_for_popup_window();
2659 return FAIL;
2660 }
Bram Moolenaarab176ce2020-06-15 21:19:08 +02002661 back_to_prevwin(wp);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002662 }
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002663 if (prev == NULL)
2664 first_popupwin = wp->w_next;
2665 else
2666 prev->w_next = wp->w_next;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002667 popup_free(wp);
Bram Moolenaard502aa42020-05-13 01:04:32 +02002668 return OK;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002669 }
2670
Bram Moolenaarec583842019-05-26 14:11:23 +02002671 // go through tab-local popups
2672 FOR_ALL_TABPAGES(tp)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002673 if (popup_close_tabpage(tp, id, force) == OK)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002674 return OK;
2675 return FAIL;
Bram Moolenaarec583842019-05-26 14:11:23 +02002676}
2677
2678/*
2679 * Close a popup window with Window-id "id" in tabpage "tp".
2680 */
Bram Moolenaard502aa42020-05-13 01:04:32 +02002681 int
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002682popup_close_tabpage(tabpage_T *tp, int id, int force)
Bram Moolenaarec583842019-05-26 14:11:23 +02002683{
2684 win_T *wp;
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02002685 win_T **root = &tp->tp_first_popupwin;
Bram Moolenaarec583842019-05-26 14:11:23 +02002686 win_T *prev = NULL;
2687
Bram Moolenaarec583842019-05-26 14:11:23 +02002688 for (wp = *root; wp != NULL; prev = wp, wp = wp->w_next)
2689 if (wp->w_id == id)
2690 {
Bram Moolenaarcee52202020-03-11 14:19:58 +01002691 if (wp == curwin)
2692 {
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002693 if (!force)
2694 {
2695 error_for_popup_window();
2696 return FAIL;
2697 }
Bram Moolenaarab176ce2020-06-15 21:19:08 +02002698 back_to_prevwin(wp);
Bram Moolenaarcee52202020-03-11 14:19:58 +01002699 }
Bram Moolenaarec583842019-05-26 14:11:23 +02002700 if (prev == NULL)
2701 *root = wp->w_next;
2702 else
2703 prev->w_next = wp->w_next;
Bram Moolenaar2cd0dce2019-05-26 22:17:52 +02002704 popup_free(wp);
Bram Moolenaard502aa42020-05-13 01:04:32 +02002705 return OK;
Bram Moolenaarec583842019-05-26 14:11:23 +02002706 }
Bram Moolenaard502aa42020-05-13 01:04:32 +02002707 return FAIL;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002708}
2709
2710 void
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002711close_all_popups(int force)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002712{
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002713 if (!force && ERROR_IF_ANY_POPUP_WINDOW)
Bram Moolenaar8bf716c2020-01-23 15:33:54 +01002714 return;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002715 while (first_popupwin != NULL)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002716 if (popup_close(first_popupwin->w_id, force) == FAIL)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002717 return;
Bram Moolenaar9c27b1c2019-05-26 18:48:13 +02002718 while (curtab->tp_first_popupwin != NULL)
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002719 if (popup_close(curtab->tp_first_popupwin->w_id, force) == FAIL)
Bram Moolenaard502aa42020-05-13 01:04:32 +02002720 return;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02002721}
2722
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002723/*
2724 * popup_move({id}, {options})
2725 */
2726 void
2727f_popup_move(typval_T *argvars, typval_T *rettv UNUSED)
2728{
Bram Moolenaarae943152019-06-16 22:54:14 +02002729 dict_T *dict;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002730 int id = (int)tv_get_number(argvars);
2731 win_T *wp = find_popup_win(id);
2732
2733 if (wp == NULL)
2734 return; // invalid {id}
2735
2736 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
2737 {
2738 emsg(_(e_dictreq));
2739 return;
2740 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002741 dict = argvars[1].vval.v_dict;
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002742
Bram Moolenaarae943152019-06-16 22:54:14 +02002743 apply_move_options(wp, dict);
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002744
2745 if (wp->w_winrow + wp->w_height >= cmdline_row)
2746 clear_cmdline = TRUE;
2747 popup_adjust_position(wp);
Bram Moolenaar60cdb302019-05-27 21:54:10 +02002748}
2749
Bram Moolenaarbc133542019-05-29 20:26:46 +02002750/*
Bram Moolenaarae943152019-06-16 22:54:14 +02002751 * popup_setoptions({id}, {options})
2752 */
2753 void
2754f_popup_setoptions(typval_T *argvars, typval_T *rettv UNUSED)
2755{
2756 dict_T *dict;
2757 int id = (int)tv_get_number(argvars);
2758 win_T *wp = find_popup_win(id);
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002759 linenr_T old_firstline;
Bram Moolenaarae943152019-06-16 22:54:14 +02002760
2761 if (wp == NULL)
2762 return; // invalid {id}
2763
2764 if (argvars[1].v_type != VAR_DICT || argvars[1].vval.v_dict == NULL)
2765 {
2766 emsg(_(e_dictreq));
2767 return;
2768 }
2769 dict = argvars[1].vval.v_dict;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002770 old_firstline = wp->w_firstline;
Bram Moolenaarae943152019-06-16 22:54:14 +02002771
Bram Moolenaar3697c9b2020-09-26 22:03:00 +02002772 apply_options(wp, dict, FALSE);
Bram Moolenaarae943152019-06-16 22:54:14 +02002773
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002774 if (old_firstline != wp->w_firstline)
2775 redraw_win_later(wp, NOT_VALID);
Bram Moolenaarae943152019-06-16 22:54:14 +02002776 popup_adjust_position(wp);
2777}
2778
2779/*
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002780 * popup_getpos({id})
Bram Moolenaarbc133542019-05-29 20:26:46 +02002781 */
2782 void
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002783f_popup_getpos(typval_T *argvars, typval_T *rettv)
Bram Moolenaarbc133542019-05-29 20:26:46 +02002784{
2785 dict_T *dict;
2786 int id = (int)tv_get_number(argvars);
2787 win_T *wp = find_popup_win(id);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002788 int top_extra;
2789 int left_extra;
Bram Moolenaarbc133542019-05-29 20:26:46 +02002790
2791 if (rettv_dict_alloc(rettv) == OK)
2792 {
2793 if (wp == NULL)
2794 return; // invalid {id}
Bram Moolenaareb2310d2019-06-16 20:09:10 +02002795 top_extra = popup_top_extra(wp);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002796 left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
2797
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002798 // we know how much space we need, avoid resizing halfway
Bram Moolenaarbc133542019-05-29 20:26:46 +02002799 dict = rettv->vval.v_dict;
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002800 hash_lock_size(&dict->dv_hashtab, 11);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002801
Bram Moolenaarbc133542019-05-29 20:26:46 +02002802 dict_add_number(dict, "line", wp->w_winrow + 1);
2803 dict_add_number(dict, "col", wp->w_wincol + 1);
Bram Moolenaar68d48f42019-06-12 22:42:41 +02002804 dict_add_number(dict, "width", wp->w_width + left_extra
2805 + wp->w_popup_border[1] + wp->w_popup_padding[1]);
2806 dict_add_number(dict, "height", wp->w_height + top_extra
2807 + wp->w_popup_border[2] + wp->w_popup_padding[2]);
Bram Moolenaar2fd8e352019-06-01 20:16:48 +02002808
2809 dict_add_number(dict, "core_line", wp->w_winrow + 1 + top_extra);
2810 dict_add_number(dict, "core_col", wp->w_wincol + 1 + left_extra);
2811 dict_add_number(dict, "core_width", wp->w_width);
2812 dict_add_number(dict, "core_height", wp->w_height);
2813
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002814 dict_add_number(dict, "scrollbar", wp->w_has_scrollbar);
Bram Moolenaar68acb412019-06-26 03:40:36 +02002815 dict_add_number(dict, "firstline", wp->w_topline);
Bram Moolenaar30efcf32019-11-03 22:29:38 +01002816 dict_add_number(dict, "lastline", wp->w_botline - 1);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002817 dict_add_number(dict, "visible",
Bram Moolenaarb0ebbda2019-06-02 16:51:21 +02002818 win_valid(wp) && (wp->w_popup_flags & POPF_HIDDEN) == 0);
Bram Moolenaar7b73d7e2019-07-26 21:26:34 +02002819
2820 hash_unlock(&dict->dv_hashtab);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002821 }
2822}
Bram Moolenaaref6b9792020-05-13 16:34:15 +02002823
2824/*
2825 * popup_list()
2826 */
2827 void
2828f_popup_list(typval_T *argvars UNUSED, typval_T *rettv)
2829{
2830 win_T *wp;
2831 tabpage_T *tp;
2832
2833 if (rettv_list_alloc(rettv) != OK)
2834 return;
2835 FOR_ALL_POPUPWINS(wp)
2836 list_append_number(rettv->vval.v_list, wp->w_id);
2837 FOR_ALL_TABPAGES(tp)
2838 FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
2839 list_append_number(rettv->vval.v_list, wp->w_id);
2840}
2841
Bram Moolenaarb4f06282019-07-12 21:07:54 +02002842/*
2843 * popup_locate({row}, {col})
2844 */
2845 void
2846f_popup_locate(typval_T *argvars, typval_T *rettv)
2847{
2848 int row = tv_get_number(&argvars[0]) - 1;
2849 int col = tv_get_number(&argvars[1]) - 1;
2850 win_T *wp;
2851
2852 wp = mouse_find_win(&row, &col, FIND_POPUP);
Bram Moolenaarfd318112019-11-22 19:22:08 +01002853 if (wp != NULL && WIN_IS_POPUP(wp))
Bram Moolenaarb4f06282019-07-12 21:07:54 +02002854 rettv->vval.v_number = wp->w_id;
2855}
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002856
2857/*
Bram Moolenaarae943152019-06-16 22:54:14 +02002858 * For popup_getoptions(): add a "border" or "padding" entry to "dict".
2859 */
2860 static void
2861get_padding_border(dict_T *dict, int *array, char *name)
2862{
2863 list_T *list;
2864 int i;
2865
2866 if (array[0] == 0 && array[1] == 0 && array[2] == 0 && array[3] == 0)
2867 return;
2868
2869 list = list_alloc();
2870 if (list != NULL)
2871 {
2872 dict_add_list(dict, name, list);
2873 if (array[0] != 1 || array[1] != 1 || array[2] != 1 || array[3] != 1)
2874 for (i = 0; i < 4; ++i)
2875 list_append_number(list, array[i]);
2876 }
2877}
2878
2879/*
2880 * For popup_getoptions(): add a "borderhighlight" entry to "dict".
2881 */
2882 static void
2883get_borderhighlight(dict_T *dict, win_T *wp)
2884{
2885 list_T *list;
2886 int i;
2887
2888 for (i = 0; i < 4; ++i)
2889 if (wp->w_border_highlight[i] != NULL)
2890 break;
2891 if (i == 4)
2892 return;
2893
2894 list = list_alloc();
2895 if (list != NULL)
2896 {
2897 dict_add_list(dict, "borderhighlight", list);
2898 for (i = 0; i < 4; ++i)
2899 list_append_string(list, wp->w_border_highlight[i], -1);
2900 }
2901}
2902
2903/*
2904 * For popup_getoptions(): add a "borderchars" entry to "dict".
2905 */
2906 static void
2907get_borderchars(dict_T *dict, win_T *wp)
2908{
2909 list_T *list;
2910 int i;
2911 char_u buf[NUMBUFLEN];
2912 int len;
2913
2914 for (i = 0; i < 8; ++i)
2915 if (wp->w_border_char[i] != 0)
2916 break;
2917 if (i == 8)
2918 return;
2919
2920 list = list_alloc();
2921 if (list != NULL)
2922 {
2923 dict_add_list(dict, "borderchars", list);
2924 for (i = 0; i < 8; ++i)
2925 {
2926 len = mb_char2bytes(wp->w_border_char[i], buf);
2927 list_append_string(list, buf, len);
2928 }
2929 }
2930}
2931
2932/*
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002933 * For popup_getoptions(): add a "moved" and "mousemoved" entry to "dict".
Bram Moolenaarae943152019-06-16 22:54:14 +02002934 */
2935 static void
2936get_moved_list(dict_T *dict, win_T *wp)
2937{
2938 list_T *list;
2939
2940 list = list_alloc();
2941 if (list != NULL)
2942 {
2943 dict_add_list(dict, "moved", list);
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002944 list_append_number(list, wp->w_popup_lnum);
Bram Moolenaarae943152019-06-16 22:54:14 +02002945 list_append_number(list, wp->w_popup_mincol);
2946 list_append_number(list, wp->w_popup_maxcol);
2947 }
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002948 list = list_alloc();
2949 if (list != NULL)
2950 {
2951 dict_add_list(dict, "mousemoved", list);
2952 list_append_number(list, wp->w_popup_mouse_row);
2953 list_append_number(list, wp->w_popup_mouse_mincol);
2954 list_append_number(list, wp->w_popup_mouse_maxcol);
2955 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002956}
2957
2958/*
Bram Moolenaar33796b32019-06-08 16:01:13 +02002959 * popup_getoptions({id})
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002960 */
2961 void
2962f_popup_getoptions(typval_T *argvars, typval_T *rettv)
2963{
2964 dict_T *dict;
2965 int id = (int)tv_get_number(argvars);
2966 win_T *wp = find_popup_win(id);
Bram Moolenaara3fce622019-06-20 02:31:49 +02002967 tabpage_T *tp;
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02002968 int i;
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002969
2970 if (rettv_dict_alloc(rettv) == OK)
2971 {
2972 if (wp == NULL)
2973 return;
2974
2975 dict = rettv->vval.v_dict;
2976 dict_add_number(dict, "line", wp->w_wantline);
2977 dict_add_number(dict, "col", wp->w_wantcol);
2978 dict_add_number(dict, "minwidth", wp->w_minwidth);
2979 dict_add_number(dict, "minheight", wp->w_minheight);
2980 dict_add_number(dict, "maxheight", wp->w_maxheight);
2981 dict_add_number(dict, "maxwidth", wp->w_maxwidth);
Bram Moolenaar8d241042019-06-12 23:40:01 +02002982 dict_add_number(dict, "firstline", wp->w_firstline);
Bram Moolenaar75fb0852019-06-25 05:15:58 +02002983 dict_add_number(dict, "scrollbar", wp->w_want_scrollbar);
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02002984 dict_add_number(dict, "zindex", wp->w_zindex);
Bram Moolenaar042fb4b2019-06-02 14:49:56 +02002985 dict_add_number(dict, "fixed", wp->w_popup_fixed);
Bram Moolenaar65026432021-02-06 14:22:32 +01002986 if (wp->w_popup_prop_type && win_valid_any_tab(wp->w_popup_prop_win))
Bram Moolenaar12034e22019-08-25 22:25:02 +02002987 {
2988 proptype_T *pt = text_prop_type_by_id(
2989 wp->w_popup_prop_win->w_buffer,
2990 wp->w_popup_prop_type);
2991
2992 if (pt != NULL)
2993 dict_add_string(dict, "textprop", pt->pt_name);
2994 dict_add_number(dict, "textpropwin", wp->w_popup_prop_win->w_id);
2995 dict_add_number(dict, "textpropid", wp->w_popup_prop_id);
2996 }
Bram Moolenaarae943152019-06-16 22:54:14 +02002997 dict_add_string(dict, "title", wp->w_popup_title);
2998 dict_add_number(dict, "wrap", wp->w_p_wrap);
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02002999 dict_add_number(dict, "drag", (wp->w_popup_flags & POPF_DRAG) != 0);
Bram Moolenaar12034e22019-08-25 22:25:02 +02003000 dict_add_number(dict, "mapping",
3001 (wp->w_popup_flags & POPF_MAPPING) != 0);
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02003002 dict_add_number(dict, "resize", (wp->w_popup_flags & POPF_RESIZE) != 0);
Bram Moolenaar638a4a72019-11-06 19:25:22 +01003003 dict_add_number(dict, "posinvert",
3004 (wp->w_popup_flags & POPF_POSINVERT) != 0);
Bram Moolenaarcb5ff342019-07-20 16:51:19 +02003005 dict_add_number(dict, "cursorline",
3006 (wp->w_popup_flags & POPF_CURSORLINE) != 0);
Bram Moolenaarae943152019-06-16 22:54:14 +02003007 dict_add_string(dict, "highlight", wp->w_p_wcr);
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003008 if (wp->w_scrollbar_highlight != NULL)
3009 dict_add_string(dict, "scrollbarhighlight",
3010 wp->w_scrollbar_highlight);
3011 if (wp->w_thumb_highlight != NULL)
3012 dict_add_string(dict, "thumbhighlight", wp->w_thumb_highlight);
Bram Moolenaarae943152019-06-16 22:54:14 +02003013
Bram Moolenaara3fce622019-06-20 02:31:49 +02003014 // find the tabpage that holds this popup
3015 i = 1;
3016 FOR_ALL_TABPAGES(tp)
3017 {
Bram Moolenaar1824f452019-10-02 23:06:46 +02003018 win_T *twp;
Bram Moolenaara3fce622019-06-20 02:31:49 +02003019
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003020 FOR_ALL_POPUPWINS_IN_TAB(tp, twp)
3021 if (twp->w_id == id)
3022 break;
3023 if (twp != NULL)
3024 break;
3025 ++i;
Bram Moolenaara3fce622019-06-20 02:31:49 +02003026 }
3027 if (tp == NULL)
3028 i = -1; // must be global
3029 else if (tp == curtab)
3030 i = 0;
3031 dict_add_number(dict, "tabpage", i);
3032
Bram Moolenaarae943152019-06-16 22:54:14 +02003033 get_padding_border(dict, wp->w_popup_padding, "padding");
3034 get_padding_border(dict, wp->w_popup_border, "border");
3035 get_borderhighlight(dict, wp);
3036 get_borderchars(dict, wp);
3037 get_moved_list(dict, wp);
3038
3039 if (wp->w_filter_cb.cb_name != NULL)
3040 dict_add_callback(dict, "filter", &wp->w_filter_cb);
3041 if (wp->w_close_cb.cb_name != NULL)
3042 dict_add_callback(dict, "callback", &wp->w_close_cb);
Bram Moolenaarac1f1bc2019-05-30 21:24:26 +02003043
3044 for (i = 0; i < (int)(sizeof(poppos_entries) / sizeof(poppos_entry_T));
3045 ++i)
3046 if (wp->w_popup_pos == poppos_entries[i].pp_val)
3047 {
3048 dict_add_string(dict, "pos",
3049 (char_u *)poppos_entries[i].pp_name);
3050 break;
3051 }
3052
Bram Moolenaar2e62b562019-06-30 18:07:00 +02003053 dict_add_string(dict, "close", (char_u *)(
3054 wp->w_popup_close == POPCLOSE_BUTTON ? "button"
3055 : wp->w_popup_close == POPCLOSE_CLICK ? "click" : "none"));
3056
Bram Moolenaar8c2a6002019-05-30 14:29:45 +02003057# if defined(FEAT_TIMERS)
3058 dict_add_number(dict, "time", wp->w_popup_timer != NULL
3059 ? (long)wp->w_popup_timer->tr_interval : 0L);
3060# endif
Bram Moolenaarbc133542019-05-29 20:26:46 +02003061 }
3062}
Bram Moolenaar815b76b2019-06-01 14:15:52 +02003063
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003064# if defined(FEAT_TERMINAL) || defined(PROTO)
Bram Moolenaard98c0b62020-02-02 15:25:16 +01003065/*
3066 * Return TRUE if the current window is running a terminal in a popup window.
3067 * Return FALSE when the job has ended.
3068 */
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003069 int
3070error_if_term_popup_window()
3071{
Bram Moolenaard98c0b62020-02-02 15:25:16 +01003072 if (WIN_IS_POPUP(curwin) && curbuf->b_term != NULL
3073 && term_job_running(curbuf->b_term))
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003074 {
Bram Moolenaara5edb672020-02-03 22:58:48 +01003075 emsg(_("E863: Not allowed for a terminal in a popup window"));
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003076 return TRUE;
3077 }
3078 return FALSE;
3079}
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003080# endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003081
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003082/*
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003083 * Reset all the "handled_flag" flags in global popup windows and popup windows
Bram Moolenaarfc06cbb2019-06-15 14:14:31 +02003084 * in the current tab page.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003085 * Each calling function should use a different flag, see the list at
3086 * POPUP_HANDLED_1. This won't work with recursive calls though.
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003087 */
3088 void
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003089popup_reset_handled(int handled_flag)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003090{
3091 win_T *wp;
3092
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003093 FOR_ALL_POPUPWINS(wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003094 wp->w_popup_handled &= ~handled_flag;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003095 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003096 wp->w_popup_handled &= ~handled_flag;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003097}
3098
3099/*
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003100 * Find the next visible popup where "handled_flag" is not set.
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003101 * Must have called popup_reset_handled() first.
3102 * When "lowest" is TRUE find the popup with the lowest zindex, otherwise the
3103 * popup with the highest zindex.
3104 */
3105 win_T *
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003106find_next_popup(int lowest, int handled_flag)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003107{
3108 win_T *wp;
3109 win_T *found_wp;
3110 int found_zindex;
3111
3112 found_zindex = lowest ? INT_MAX : 0;
3113 found_wp = NULL;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003114 FOR_ALL_POPUPWINS(wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003115 if ((wp->w_popup_handled & handled_flag) == 0
3116 && (wp->w_popup_flags & POPF_HIDDEN) == 0
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003117 && (lowest ? wp->w_zindex < found_zindex
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003118 : wp->w_zindex > found_zindex))
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003119 {
3120 found_zindex = wp->w_zindex;
3121 found_wp = wp;
3122 }
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003123 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003124 if ((wp->w_popup_handled & handled_flag) == 0
3125 && (wp->w_popup_flags & POPF_HIDDEN) == 0
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003126 && (lowest ? wp->w_zindex < found_zindex
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003127 : wp->w_zindex > found_zindex))
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003128 {
3129 found_zindex = wp->w_zindex;
3130 found_wp = wp;
3131 }
3132
3133 if (found_wp != NULL)
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003134 found_wp->w_popup_handled |= handled_flag;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003135 return found_wp;
3136}
3137
3138/*
3139 * Invoke the filter callback for window "wp" with typed character "c".
3140 * Uses the global "mod_mask" for modifiers.
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02003141 * Returns the return value of the filter or -1 for CTRL-C in the current
3142 * window.
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003143 * Careful: The filter may make "wp" invalid!
3144 */
3145 static int
3146invoke_popup_filter(win_T *wp, int c)
3147{
3148 int res;
3149 typval_T rettv;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003150 typval_T argv[3];
3151 char_u buf[NUMBUFLEN];
Bram Moolenaardf9c6ca2019-07-18 13:46:42 +02003152 linenr_T old_lnum = wp->w_cursor.lnum;
Bram Moolenaar371806e2020-10-22 13:44:54 +02003153 int prev_did_emsg = did_emsg;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003154
Bram Moolenaara42d9452019-06-15 21:46:30 +02003155 // Emergency exit: CTRL-C closes the popup.
3156 if (c == Ctrl_C)
3157 {
Bram Moolenaarfd00c042019-10-05 11:56:54 +02003158 int save_got_int = got_int;
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02003159 int was_curwin = wp == curwin;
Bram Moolenaarfd00c042019-10-05 11:56:54 +02003160
3161 // Reset got_int to avoid the callback isn't called.
3162 got_int = FALSE;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003163 popup_close_with_retval(wp, -1);
Bram Moolenaarfd00c042019-10-05 11:56:54 +02003164 got_int |= save_got_int;
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02003165
3166 // If the popup is the current window it probably fails to close. Then
3167 // do not consume the key.
3168 if (was_curwin && wp == curwin)
3169 return -1;
3170 return TRUE;
Bram Moolenaara42d9452019-06-15 21:46:30 +02003171 }
3172
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003173 argv[0].v_type = VAR_NUMBER;
3174 argv[0].vval.v_number = (varnumber_T)wp->w_id;
3175
3176 // Convert the number to a string, so that the function can use:
3177 // if a:c == "\<F2>"
Bram Moolenaarec084d32020-02-28 22:44:47 +01003178 buf[special_to_buf(c, mod_mask, FALSE, buf)] = NUL;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003179 argv[1].v_type = VAR_STRING;
3180 argv[1].vval.v_string = vim_strsave(buf);
3181
3182 argv[2].v_type = VAR_UNKNOWN;
3183
Bram Moolenaar638a4a72019-11-06 19:25:22 +01003184 // NOTE: The callback might close the popup and make "wp" invalid.
Bram Moolenaar6defa7b2020-09-08 22:06:44 +02003185 if (call_callback(&wp->w_filter_cb, -1, &rettv, 2, argv) == FAIL)
3186 {
3187 // Cannot call the function, close the popup to avoid that the filter
Bram Moolenaar8e9be202020-09-08 22:55:26 +02003188 // eats keys and the user is stuck. Might as well eat the key.
Bram Moolenaar6defa7b2020-09-08 22:06:44 +02003189 popup_close_with_retval(wp, -1);
Bram Moolenaar8e9be202020-09-08 22:55:26 +02003190 res = TRUE;
Bram Moolenaar6defa7b2020-09-08 22:06:44 +02003191 }
3192 else
3193 {
Bram Moolenaar8e9be202020-09-08 22:55:26 +02003194 if (win_valid_popup(wp) && old_lnum != wp->w_cursor.lnum)
3195 popup_highlight_curline(wp);
3196
Bram Moolenaar371806e2020-10-22 13:44:54 +02003197 // If an error message was given always return FALSE, so that keys are
3198 // not consumed and the user can type something.
Bram Moolenaar8e9be202020-09-08 22:55:26 +02003199 // If we get three errors in a row then close the popup. Decrement the
3200 // error count by 1/10 if there are no errors, thus allowing up to 1 in
3201 // 10 calls to cause an error.
Bram Moolenaar371806e2020-10-22 13:44:54 +02003202 if (win_valid_popup(wp) && did_emsg > prev_did_emsg)
Bram Moolenaar8e9be202020-09-08 22:55:26 +02003203 {
3204 wp->w_filter_errors += 10;
3205 if (wp->w_filter_errors >= 30)
3206 popup_close_with_retval(wp, -1);
3207 res = FALSE;
3208 }
3209 else
3210 {
3211 if (win_valid_popup(wp) && wp->w_filter_errors > 0)
3212 --wp->w_filter_errors;
3213 res = tv_get_bool(&rettv);
3214 }
Bram Moolenaar6defa7b2020-09-08 22:06:44 +02003215 }
Bram Moolenaarf8b036b2019-11-06 21:09:17 +01003216
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003217 vim_free(argv[1].vval.v_string);
3218 clear_tv(&rettv);
3219 return res;
3220}
3221
3222/*
3223 * Called when "c" was typed: invoke popup filter callbacks.
3224 * Returns TRUE when the character was consumed,
3225 */
3226 int
3227popup_do_filter(int c)
3228{
Bram Moolenaar934470e2019-09-01 23:27:05 +02003229 static int recursive = FALSE;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003230 int res = FALSE;
Bram Moolenaara42d9452019-06-15 21:46:30 +02003231 win_T *wp;
Bram Moolenaar934470e2019-09-01 23:27:05 +02003232 int save_KeyTyped = KeyTyped;
Bram Moolenaar581ba392019-09-03 22:08:33 +02003233 int state;
Bram Moolenaarfbb3bc82019-09-07 14:33:36 +02003234 int was_must_redraw = must_redraw;
Bram Moolenaar934470e2019-09-01 23:27:05 +02003235
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003236#ifdef FEAT_TERMINAL
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003237 // Popup window with terminal always gets focus.
3238 if (popup_is_popup(curwin) && curbuf->b_term != NULL)
3239 return FALSE;
Bram Moolenaar91cd59a2020-02-01 22:18:37 +01003240#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01003241
Bram Moolenaar934470e2019-09-01 23:27:05 +02003242 if (recursive)
3243 return FALSE;
3244 recursive = TRUE;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003245
Bram Moolenaarf6396232019-08-24 19:36:00 +02003246 if (c == K_LEFTMOUSE)
3247 {
3248 int row = mouse_row;
3249 int col = mouse_col;
3250
3251 wp = mouse_find_win(&row, &col, FIND_POPUP);
3252 if (wp != NULL && popup_close_if_on_X(wp, row, col))
Bram Moolenaar934470e2019-09-01 23:27:05 +02003253 res = TRUE;
Bram Moolenaarf6396232019-08-24 19:36:00 +02003254 }
3255
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003256 popup_reset_handled(POPUP_HANDLED_2);
Bram Moolenaar581ba392019-09-03 22:08:33 +02003257 state = get_real_state();
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02003258 while (res == FALSE
3259 && (wp = find_next_popup(FALSE, POPUP_HANDLED_2)) != NULL)
Bram Moolenaar581ba392019-09-03 22:08:33 +02003260 if (wp->w_filter_cb.cb_name != NULL
3261 && (wp->w_filter_mode & state) != 0)
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003262 res = invoke_popup_filter(wp, c);
3263
Bram Moolenaarfbb3bc82019-09-07 14:33:36 +02003264 if (must_redraw > was_must_redraw)
Bram Moolenaar6f8f7332020-08-10 21:19:23 +02003265 {
3266 int save_got_int = got_int;
3267
3268 // Reset got_int to avoid a function used in the statusline aborts.
3269 got_int = FALSE;
Bram Moolenaarbcb4c8f2019-09-07 14:06:52 +02003270 redraw_after_callback(FALSE);
Bram Moolenaar6f8f7332020-08-10 21:19:23 +02003271 got_int |= save_got_int;
3272 }
Bram Moolenaar934470e2019-09-01 23:27:05 +02003273 recursive = FALSE;
3274 KeyTyped = save_KeyTyped;
Bram Moolenaar6bf1b522020-09-23 17:41:26 +02003275
3276 // When interrupted return FALSE to avoid looping.
3277 return res == -1 ? FALSE : res;
Bram Moolenaarbf0eff02019-06-01 17:13:36 +02003278}
3279
Bram Moolenaar3397f742019-06-02 18:40:06 +02003280/*
Bram Moolenaar749fa0a2019-08-03 16:18:07 +02003281 * Return TRUE if there is a popup visible with a filter callback and the
3282 * "mapping" property off.
3283 */
3284 int
3285popup_no_mapping(void)
3286{
3287 int round;
3288 win_T *wp;
3289
3290 for (round = 1; round <= 2; ++round)
3291 for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
3292 wp != NULL; wp = wp->w_next)
3293 if (wp->w_filter_cb.cb_name != NULL
3294 && (wp->w_popup_flags & (POPF_HIDDEN | POPF_MAPPING)) == 0)
3295 return TRUE;
3296 return FALSE;
3297}
3298
3299/*
Bram Moolenaar3397f742019-06-02 18:40:06 +02003300 * Called when the cursor moved: check if any popup needs to be closed if the
3301 * cursor moved far enough.
3302 */
3303 void
3304popup_check_cursor_pos()
3305{
3306 win_T *wp;
Bram Moolenaar3397f742019-06-02 18:40:06 +02003307
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003308 popup_reset_handled(POPUP_HANDLED_3);
3309 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_3)) != NULL)
Bram Moolenaar3397f742019-06-02 18:40:06 +02003310 if (wp->w_popup_curwin != NULL
3311 && (curwin != wp->w_popup_curwin
3312 || curwin->w_cursor.lnum != wp->w_popup_lnum
3313 || curwin->w_cursor.col < wp->w_popup_mincol
3314 || curwin->w_cursor.col > wp->w_popup_maxcol))
Bram Moolenaar12034e22019-08-25 22:25:02 +02003315 popup_close_with_retval(wp, -1);
Bram Moolenaar3397f742019-06-02 18:40:06 +02003316}
3317
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003318/*
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003319 * Update "w_popup_mask_cells".
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003320 */
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003321 static void
3322popup_update_mask(win_T *wp, int width, int height)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003323{
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003324 listitem_T *lio, *li;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003325 char_u *cells;
3326 int row, col;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003327
3328 if (wp->w_popup_mask == NULL)
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003329 return;
3330 if (wp->w_popup_mask_cells != NULL
3331 && wp->w_popup_mask_height == height
3332 && wp->w_popup_mask_width == width)
3333 return; // cache is still valid
3334
3335 vim_free(wp->w_popup_mask_cells);
3336 wp->w_popup_mask_cells = alloc_clear(width * height);
3337 if (wp->w_popup_mask_cells == NULL)
3338 return;
3339 cells = wp->w_popup_mask_cells;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003340
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003341 FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003342 {
3343 int cols, cole;
3344 int lines, linee;
3345
3346 li = lio->li_tv.vval.v_list->lv_first;
3347 cols = tv_get_number(&li->li_tv);
3348 if (cols < 0)
3349 cols = width + cols + 1;
Bram Moolenaar4012d262020-12-29 11:57:46 +01003350 if (cols <= 0)
3351 cols = 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003352 li = li->li_next;
3353 cole = tv_get_number(&li->li_tv);
3354 if (cole < 0)
3355 cole = width + cole + 1;
Bram Moolenaar4012d262020-12-29 11:57:46 +01003356 if (cole > width)
3357 cole = width;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003358 li = li->li_next;
3359 lines = tv_get_number(&li->li_tv);
3360 if (lines < 0)
3361 lines = height + lines + 1;
Bram Moolenaar4012d262020-12-29 11:57:46 +01003362 if (lines <= 0)
3363 lines = 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003364 li = li->li_next;
3365 linee = tv_get_number(&li->li_tv);
3366 if (linee < 0)
3367 linee = height + linee + 1;
Bram Moolenaar4012d262020-12-29 11:57:46 +01003368 if (linee > height)
3369 linee = height;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003370
Bram Moolenaar4012d262020-12-29 11:57:46 +01003371 for (row = lines - 1; row < linee; ++row)
3372 for (col = cols - 1; col < cole; ++col)
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003373 cells[row * width + col] = 1;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003374 }
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003375}
3376
3377/*
3378 * Return TRUE if "col" / "line" matches with an entry in w_popup_mask.
3379 * "col" and "line" are screen coordinates.
3380 */
3381 static int
3382popup_masked(win_T *wp, int width, int height, int screencol, int screenline)
3383{
3384 int col = screencol - wp->w_wincol + wp->w_popup_leftoff;
3385 int line = screenline - wp->w_winrow;
3386
3387 return col >= 0 && col < width
3388 && line >= 0 && line < height
3389 && wp->w_popup_mask_cells[line * width + col];
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003390}
3391
3392/*
3393 * Set flags in popup_transparent[] for window "wp" to "val".
3394 */
3395 static void
3396update_popup_transparent(win_T *wp, int val)
3397{
3398 if (wp->w_popup_mask != NULL)
3399 {
3400 int width = popup_width(wp);
3401 int height = popup_height(wp);
3402 listitem_T *lio, *li;
3403 int cols, cole;
3404 int lines, linee;
3405 int col, line;
3406
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003407 FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003408 {
3409 li = lio->li_tv.vval.v_list->lv_first;
3410 cols = tv_get_number(&li->li_tv);
3411 if (cols < 0)
3412 cols = width + cols + 1;
3413 li = li->li_next;
3414 cole = tv_get_number(&li->li_tv);
3415 if (cole < 0)
3416 cole = width + cole + 1;
3417 li = li->li_next;
3418 lines = tv_get_number(&li->li_tv);
3419 if (lines < 0)
3420 lines = height + lines + 1;
3421 li = li->li_next;
3422 linee = tv_get_number(&li->li_tv);
3423 if (linee < 0)
3424 linee = height + linee + 1;
3425
3426 --cols;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003427 cols -= wp->w_popup_leftoff;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02003428 if (cols < 0)
3429 cols = 0;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003430 cole -= wp->w_popup_leftoff;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003431 --lines;
Bram Moolenaar711d02c2019-06-28 04:06:50 +02003432 if (lines < 0)
3433 lines = 0;
Bram Moolenaarb4207472019-07-12 16:05:45 +02003434 for (line = lines; line < linee
3435 && line + wp->w_winrow < screen_Rows; ++line)
3436 for (col = cols; col < cole
3437 && col + wp->w_wincol < screen_Columns; ++col)
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003438 popup_transparent[(line + wp->w_winrow) * screen_Columns
3439 + col + wp->w_wincol] = val;
3440 }
3441 }
3442}
3443
3444/*
Bram Moolenaar12034e22019-08-25 22:25:02 +02003445 * Only called when popup window "wp" is hidden: If the window is positioned
3446 * next to a text property, and it is now visible, then unhide the popup.
3447 * We don't check if visible popups become hidden, that is done in
3448 * popup_adjust_position().
3449 * Return TRUE if the popup became unhidden.
3450 */
3451 static int
3452check_popup_unhidden(win_T *wp)
3453{
3454 if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
3455 {
3456 textprop_T prop;
3457 linenr_T lnum;
3458
3459 if (find_visible_prop(wp->w_popup_prop_win,
3460 wp->w_popup_prop_type, wp->w_popup_prop_id,
3461 &prop, &lnum) == OK)
3462 {
3463 wp->w_popup_flags &= ~POPF_HIDDEN;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003464 wp->w_popup_prop_topline = 0; // force repositioning
3465 return TRUE;
3466 }
3467 }
3468 return FALSE;
3469}
3470
3471/*
3472 * Return TRUE if popup_adjust_position() needs to be called for "wp".
3473 * That is when the buffer in the popup was changed, or the popup is following
3474 * a textprop and the referenced buffer was changed.
Bram Moolenaar3d2a3cb2019-09-08 17:12:01 +02003475 * Or when the cursor line changed and "cursorline" is set.
Bram Moolenaar12034e22019-08-25 22:25:02 +02003476 */
3477 static int
3478popup_need_position_adjust(win_T *wp)
3479{
3480 if (wp->w_popup_last_changedtick != CHANGEDTICK(wp->w_buffer))
3481 return TRUE;
Bram Moolenaar3697c9b2020-09-26 22:03:00 +02003482 if (win_valid(wp->w_popup_prop_win)
3483 && (wp->w_popup_prop_changedtick
3484 != CHANGEDTICK(wp->w_popup_prop_win->w_buffer)
3485 || wp->w_popup_prop_topline != wp->w_popup_prop_win->w_topline))
3486 return TRUE;
3487
3488 // May need to adjust the width if the cursor moved.
3489 return wp->w_cursor.lnum != wp->w_popup_last_curline;
Bram Moolenaar12034e22019-08-25 22:25:02 +02003490}
3491
3492/*
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003493 * Update "popup_mask" if needed.
3494 * Also recomputes the popup size and positions.
3495 * Also updates "popup_visible".
3496 * Also marks window lines for redrawing.
3497 */
3498 void
3499may_update_popup_mask(int type)
3500{
3501 win_T *wp;
3502 short *mask;
3503 int line, col;
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003504 int redraw_all_popups = FALSE;
3505 int redrawing_all_win;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003506
3507 // Need to recompute when switching tabs.
3508 // Also recompute when the type is CLEAR or NOT_VALID, something basic
3509 // (such as the screen size) must have changed.
3510 if (popup_mask_tab != curtab || type >= NOT_VALID)
3511 {
3512 popup_mask_refresh = TRUE;
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003513 redraw_all_popups = TRUE;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003514 }
Bram Moolenaar12034e22019-08-25 22:25:02 +02003515
3516 // Check if any popup window buffer has changed and if any popup connected
3517 // to a text property has become visible.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003518 FOR_ALL_POPUPWINS(wp)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003519 if (wp->w_popup_flags & POPF_HIDDEN)
3520 popup_mask_refresh |= check_popup_unhidden(wp);
3521 else if (popup_need_position_adjust(wp))
3522 popup_mask_refresh = TRUE;
Bram Moolenaaraeea7212020-04-02 18:50:46 +02003523 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003524 if (wp->w_popup_flags & POPF_HIDDEN)
3525 popup_mask_refresh |= check_popup_unhidden(wp);
3526 else if (popup_need_position_adjust(wp))
3527 popup_mask_refresh = TRUE;
3528
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003529 if (!popup_mask_refresh)
Bram Moolenaar12034e22019-08-25 22:25:02 +02003530 return;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003531
3532 // Need to update the mask, something has changed.
3533 popup_mask_refresh = FALSE;
3534 popup_mask_tab = curtab;
3535 popup_visible = FALSE;
3536
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003537 // If redrawing all windows, just update "popup_mask".
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003538 // If redrawing only what is needed, update "popup_mask_next" and then
3539 // compare with "popup_mask" to see what changed.
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003540 redrawing_all_win = TRUE;
3541 FOR_ALL_WINDOWS(wp)
3542 if (wp->w_redr_type < SOME_VALID)
3543 redrawing_all_win = FALSE;
3544 if (redrawing_all_win)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003545 mask = popup_mask;
3546 else
3547 mask = popup_mask_next;
3548 vim_memset(mask, 0, screen_Rows * screen_Columns * sizeof(short));
3549
3550 // Find the window with the lowest zindex that hasn't been handled yet,
3551 // so that the window with a higher zindex overwrites the value in
3552 // popup_mask.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003553 popup_reset_handled(POPUP_HANDLED_4);
3554 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_4)) != NULL)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003555 {
Bram Moolenaard529ba52019-07-02 23:13:53 +02003556 int width;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003557 int height;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003558
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003559 popup_visible = TRUE;
3560
Bram Moolenaar12034e22019-08-25 22:25:02 +02003561 // Recompute the position if the text changed. It may make the popup
3562 // hidden if it's attach to a text property that is no longer visible.
3563 if (redraw_all_popups || popup_need_position_adjust(wp))
3564 {
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003565 popup_adjust_position(wp);
Bram Moolenaar12034e22019-08-25 22:25:02 +02003566 if (wp->w_popup_flags & POPF_HIDDEN)
3567 continue;
3568 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003569
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003570 width = popup_width(wp);
Bram Moolenaard529ba52019-07-02 23:13:53 +02003571 height = popup_height(wp);
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003572 popup_update_mask(wp, width, height);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003573 for (line = wp->w_winrow;
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003574 line < wp->w_winrow + height && line < screen_Rows; ++line)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003575 for (col = wp->w_wincol;
Bram Moolenaare865dcb2019-07-26 22:15:50 +02003576 col < wp->w_wincol + width - wp->w_popup_leftoff
3577 && col < screen_Columns; ++col)
3578 if (wp->w_popup_mask_cells == NULL
3579 || !popup_masked(wp, width, height, col, line))
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003580 mask[line * screen_Columns + col] = wp->w_zindex;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003581 }
3582
3583 // Only check which lines are to be updated if not already
3584 // updating all lines.
3585 if (mask == popup_mask_next)
Bram Moolenaar9d5ffce2019-07-26 21:01:29 +02003586 {
3587 int *plines_cache = ALLOC_CLEAR_MULT(int, Rows);
3588 win_T *prev_wp = NULL;
3589
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003590 for (line = 0; line < screen_Rows; ++line)
3591 {
3592 int col_done = 0;
3593
3594 for (col = 0; col < screen_Columns; ++col)
3595 {
3596 int off = line * screen_Columns + col;
3597
3598 if (popup_mask[off] != popup_mask_next[off])
3599 {
3600 popup_mask[off] = popup_mask_next[off];
3601
3602 if (line >= cmdline_row)
3603 {
3604 // the command line needs to be cleared if text below
3605 // the popup is now visible.
3606 if (!msg_scrolled && popup_mask_next[off] == 0)
3607 clear_cmdline = TRUE;
3608 }
3609 else if (col >= col_done)
3610 {
3611 linenr_T lnum;
3612 int line_cp = line;
3613 int col_cp = col;
3614
3615 // The screen position "line" / "col" needs to be
3616 // redrawn. Figure out what window that is and update
3617 // w_redraw_top and w_redr_bot. Only needs to be done
3618 // once for each window line.
3619 wp = mouse_find_win(&line_cp, &col_cp, IGNORE_POPUP);
3620 if (wp != NULL)
3621 {
Bram Moolenaar83e74502020-07-12 20:44:37 +02003622#if defined(FEAT_TERMINAL)
Bram Moolenaar35910f22020-07-12 19:24:10 +02003623 // A terminal window needs to be redrawn.
3624 if (bt_terminal(wp->w_buffer))
3625 redraw_win_later(wp, NOT_VALID);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003626 else
Bram Moolenaar83e74502020-07-12 20:44:37 +02003627#endif
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003628 {
Bram Moolenaar35910f22020-07-12 19:24:10 +02003629 if (wp != prev_wp)
3630 {
3631 vim_memset(plines_cache, 0,
3632 sizeof(int) * Rows);
3633 prev_wp = wp;
3634 }
3635
3636 if (line_cp >= wp->w_height)
3637 // In (or below) status line
3638 wp->w_redr_status = TRUE;
3639 else
3640 {
3641 // compute the position in the buffer line
3642 // from the position in the window
3643 mouse_comp_pos(wp, &line_cp, &col_cp,
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003644 &lnum, plines_cache);
Bram Moolenaar35910f22020-07-12 19:24:10 +02003645 redrawWinline(wp, lnum);
3646 }
Bram Moolenaare9a891f2019-08-24 15:26:24 +02003647 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003648
3649 // This line is going to be redrawn, no need to
3650 // check until the right side of the window.
3651 col_done = wp->w_wincol + wp->w_width - 1;
3652 }
3653 }
3654 }
3655 }
3656 }
Bram Moolenaar9d5ffce2019-07-26 21:01:29 +02003657
3658 vim_free(plines_cache);
3659 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003660}
3661
3662/*
Bram Moolenaar3697c9b2020-09-26 22:03:00 +02003663 * If the current window is a popup and something relevant changed, recompute
3664 * the position and size.
3665 */
3666 void
3667may_update_popup_position(void)
3668{
3669 if (popup_is_popup(curwin) && popup_need_position_adjust(curwin))
3670 popup_adjust_position(curwin);
3671}
3672
3673/*
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003674 * Return a string of "len" spaces in IObuff.
3675 */
3676 static char_u *
3677get_spaces(int len)
3678{
3679 vim_memset(IObuff, ' ', (size_t)len);
3680 IObuff[len] = NUL;
3681 return IObuff;
3682}
3683
3684/*
3685 * Update popup windows. They are drawn on top of normal windows.
3686 * "win_update" is called for each popup window, lowest zindex first.
3687 */
3688 void
3689update_popups(void (*win_update)(win_T *wp))
3690{
3691 win_T *wp;
3692 int top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003693 int left_extra;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003694 int total_width;
3695 int total_height;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003696 int top_padding;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003697 int popup_attr;
3698 int border_attr[4];
3699 int border_char[8];
3700 char_u buf[MB_MAXBYTES];
3701 int row;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003702 int wincol;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003703 int padcol = 0;
Bram Moolenaard91467f2020-11-21 12:42:09 +01003704 int padendcol = 0;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003705 int i;
Bram Moolenaar6efd76a2019-06-26 04:06:57 +02003706 int sb_thumb_top = 0;
3707 int sb_thumb_height = 0;
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003708 int attr_scroll = 0;
3709 int attr_thumb = 0;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003710
Bram Moolenaarebec3e22020-11-28 20:22:06 +01003711 // hide the cursor until redrawing is done.
3712 cursor_off();
3713
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003714 // Find the window with the lowest zindex that hasn't been updated yet,
3715 // so that the window with a higher zindex is drawn later, thus goes on
3716 // top.
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003717 popup_reset_handled(POPUP_HANDLED_5);
3718 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_5)) != NULL)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003719 {
Bram Moolenaard91467f2020-11-21 12:42:09 +01003720 int title_len = 0;
3721 int title_wincol;
3722
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003723 // This drawing uses the zindex of the popup window, so that it's on
3724 // top of the text but doesn't draw when another popup with higher
3725 // zindex is on top of the character.
3726 screen_zindex = wp->w_zindex;
3727
Bram Moolenaarc662ec92019-06-23 00:15:57 +02003728 // Set flags in popup_transparent[] for masked cells.
3729 update_popup_transparent(wp, 1);
3730
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003731 // adjust w_winrow and w_wincol for border and padding, since
3732 // win_update() doesn't handle them.
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003733 top_off = popup_top_extra(wp);
Bram Moolenaard529ba52019-07-02 23:13:53 +02003734 left_extra = wp->w_popup_padding[3] + wp->w_popup_border[3]
3735 - wp->w_popup_leftoff;
3736 if (wp->w_wincol + left_extra < 0)
3737 left_extra = -wp->w_wincol;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003738 wp->w_winrow += top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003739 wp->w_wincol += left_extra;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003740
Bram Moolenaarc2a43162019-06-26 01:03:53 +02003741 // Draw the popup text, unless it's off screen.
3742 if (wp->w_winrow < screen_Rows && wp->w_wincol < screen_Columns)
Bram Moolenaar9e67b6a2019-08-30 17:34:08 +02003743 {
Bram Moolenaar10476522020-09-24 22:57:31 +02003744 // May need to update the "cursorline" highlighting, which may also
3745 // change "topline"
3746 if (wp->w_popup_last_curline != wp->w_cursor.lnum)
3747 popup_highlight_curline(wp);
3748
Bram Moolenaarc2a43162019-06-26 01:03:53 +02003749 win_update(wp);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003750
Bram Moolenaar9e67b6a2019-08-30 17:34:08 +02003751 // move the cursor into the visible lines, otherwise executing
3752 // commands with win_execute() may cause the text to jump.
3753 if (wp->w_cursor.lnum < wp->w_topline)
3754 wp->w_cursor.lnum = wp->w_topline;
3755 else if (wp->w_cursor.lnum >= wp->w_botline)
3756 wp->w_cursor.lnum = wp->w_botline - 1;
3757 }
3758
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003759 wp->w_winrow -= top_off;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003760 wp->w_wincol -= left_extra;
Bram Moolenaar6a076442020-11-15 20:32:58 +01003761
3762 // Add offset for border and padding if not done already.
3763 if ((wp->w_flags & WFLAG_WCOL_OFF_ADDED) == 0)
3764 {
3765 wp->w_wcol += left_extra;
3766 wp->w_flags |= WFLAG_WCOL_OFF_ADDED;
3767 }
3768 if ((wp->w_flags & WFLAG_WROW_OFF_ADDED) == 0)
Bram Moolenaare52e0c82020-02-28 22:20:10 +01003769 {
3770 wp->w_wrow += top_off;
Bram Moolenaar6a076442020-11-15 20:32:58 +01003771 wp->w_flags |= WFLAG_WROW_OFF_ADDED;
Bram Moolenaare52e0c82020-02-28 22:20:10 +01003772 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003773
Bram Moolenaard529ba52019-07-02 23:13:53 +02003774 total_width = popup_width(wp);
3775 total_height = popup_height(wp);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003776 popup_attr = get_wcr_attr(wp);
3777
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02003778 if (wp->w_winrow + total_height > cmdline_row)
3779 wp->w_popup_flags |= POPF_ON_CMDLINE;
3780 else
3781 wp->w_popup_flags &= ~POPF_ON_CMDLINE;
3782
3783
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003784 // We can only use these line drawing characters when 'encoding' is
3785 // "utf-8" and 'ambiwidth' is "single".
3786 if (enc_utf8 && *p_ambw == 's')
3787 {
3788 border_char[0] = border_char[2] = 0x2550;
3789 border_char[1] = border_char[3] = 0x2551;
3790 border_char[4] = 0x2554;
3791 border_char[5] = 0x2557;
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02003792 border_char[6] = (wp->w_popup_flags & POPF_RESIZE)
3793 ? 0x21f2 : 0x255d;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003794 border_char[7] = 0x255a;
3795 }
3796 else
3797 {
3798 border_char[0] = border_char[2] = '-';
3799 border_char[1] = border_char[3] = '|';
3800 for (i = 4; i < 8; ++i)
3801 border_char[i] = '+';
Bram Moolenaar9bcb70c2019-08-01 21:11:05 +02003802 if (wp->w_popup_flags & POPF_RESIZE)
3803 border_char[6] = '@';
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003804 }
3805 for (i = 0; i < 8; ++i)
3806 if (wp->w_border_char[i] != 0)
3807 border_char[i] = wp->w_border_char[i];
3808
3809 for (i = 0; i < 4; ++i)
3810 {
3811 border_attr[i] = popup_attr;
3812 if (wp->w_border_highlight[i] != NULL)
3813 border_attr[i] = syn_name2attr(wp->w_border_highlight[i]);
3814 }
3815
Bram Moolenaard91467f2020-11-21 12:42:09 +01003816 // Title goes on top of border or padding.
3817 title_wincol = wp->w_wincol + 1;
3818 if (wp->w_popup_title != NULL)
3819 {
3820 char_u *title_text;
3821
3822 title_len = (int)STRLEN(wp->w_popup_title);
3823 title_text = alloc(title_len + 1);
3824 trunc_string(wp->w_popup_title, title_text,
3825 total_width - 2, title_len + 1);
3826 screen_puts(title_text, wp->w_winrow, title_wincol,
3827 wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
3828 vim_free(title_text);
3829 if (title_len > total_width - 2)
3830 title_len = total_width - 2;
3831 }
3832
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003833 wincol = wp->w_wincol - wp->w_popup_leftoff;
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003834 top_padding = wp->w_popup_padding[0];
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003835 if (wp->w_popup_border[0] > 0)
3836 {
Bram Moolenaard91467f2020-11-21 12:42:09 +01003837 // top border; do not draw over the title
3838 if (title_len > 0)
3839 {
3840 screen_fill(wp->w_winrow, wp->w_winrow + 1,
3841 wincol < 0 ? 0 : wincol, title_wincol,
3842 wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003843 ? border_char[4] : border_char[0],
Bram Moolenaard91467f2020-11-21 12:42:09 +01003844 border_char[0], border_attr[0]);
3845 screen_fill(wp->w_winrow, wp->w_winrow + 1,
3846 title_wincol + title_len, wincol + total_width,
3847 border_char[0], border_char[0], border_attr[0]);
3848 }
3849 else
3850 {
3851 screen_fill(wp->w_winrow, wp->w_winrow + 1,
3852 wincol < 0 ? 0 : wincol, wincol + total_width,
3853 wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
3854 ? border_char[4] : border_char[0],
3855 border_char[0], border_attr[0]);
3856 }
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003857 if (wp->w_popup_border[1] > 0 && wp->w_popup_rightoff == 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003858 {
3859 buf[mb_char2bytes(border_char[5], buf)] = NUL;
3860 screen_puts(buf, wp->w_winrow,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003861 wincol + total_width - 1, border_attr[1]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003862 }
3863 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003864 else if (wp->w_popup_padding[0] == 0 && popup_top_extra(wp) > 0)
3865 top_padding = 1;
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003866
Bram Moolenaard529ba52019-07-02 23:13:53 +02003867 if (top_padding > 0 || wp->w_popup_padding[2] > 0)
3868 {
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003869 padcol = wincol + wp->w_popup_border[3];
Bram Moolenaard91467f2020-11-21 12:42:09 +01003870 padendcol = wp->w_wincol + total_width - wp->w_popup_border[1]
Bram Moolenaard529ba52019-07-02 23:13:53 +02003871 - wp->w_has_scrollbar;
3872 if (padcol < 0)
3873 {
Bram Moolenaard91467f2020-11-21 12:42:09 +01003874 padendcol += padcol;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003875 padcol = 0;
3876 }
3877 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003878 if (top_padding > 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003879 {
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003880 row = wp->w_winrow + wp->w_popup_border[0];
Bram Moolenaar3ae50c72020-12-12 18:18:06 +01003881 if (title_len > 0 && row == wp->w_winrow)
Bram Moolenaard91467f2020-11-21 12:42:09 +01003882 {
Bram Moolenaar3ae50c72020-12-12 18:18:06 +01003883 // top padding and no border; do not draw over the title
3884 screen_fill(row, row + 1, padcol, title_wincol,
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003885 ' ', ' ', popup_attr);
Bram Moolenaar3ae50c72020-12-12 18:18:06 +01003886 screen_fill(row, row + 1, title_wincol + title_len,
Bram Moolenaard91467f2020-11-21 12:42:09 +01003887 padendcol, ' ', ' ', popup_attr);
Bram Moolenaar3ae50c72020-12-12 18:18:06 +01003888 row += 1;
3889 top_padding -= 1;
Bram Moolenaard91467f2020-11-21 12:42:09 +01003890 }
Bram Moolenaar3ae50c72020-12-12 18:18:06 +01003891 screen_fill(row, row + top_padding, padcol, padendcol,
Bram Moolenaard91467f2020-11-21 12:42:09 +01003892 ' ', ' ', popup_attr);
Bram Moolenaar5d458a72019-08-04 21:12:15 +02003893 }
Bram Moolenaareb2310d2019-06-16 20:09:10 +02003894
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003895 // Compute scrollbar thumb position and size.
3896 if (wp->w_has_scrollbar)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003897 {
Bram Moolenaar076d9882019-09-14 22:23:29 +02003898 linenr_T linecount = wp->w_buffer->b_ml.ml_line_count;
3899 int height = wp->w_height;
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003900
Bram Moolenaar076d9882019-09-14 22:23:29 +02003901 sb_thumb_height = (height * height + linecount / 2) / linecount;
3902 if (wp->w_topline > 1 && sb_thumb_height == height)
3903 --sb_thumb_height; // scrolled, no full thumb
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003904 if (sb_thumb_height == 0)
3905 sb_thumb_height = 1;
Bram Moolenaar437a7462019-07-05 20:17:22 +02003906 if (linecount <= wp->w_height)
3907 // it just fits, avoid divide by zero
3908 sb_thumb_top = 0;
3909 else
3910 sb_thumb_top = (wp->w_topline - 1
3911 + (linecount / wp->w_height) / 2)
Bram Moolenaar68acb412019-06-26 03:40:36 +02003912 * (wp->w_height - sb_thumb_height)
3913 / (linecount - wp->w_height);
Bram Moolenaar076d9882019-09-14 22:23:29 +02003914 if (wp->w_topline > 1 && sb_thumb_top == 0 && height > 1)
3915 sb_thumb_top = 1; // show it's scrolled
3916
Bram Moolenaar4cd583c2019-06-26 05:13:57 +02003917 if (wp->w_scrollbar_highlight != NULL)
3918 attr_scroll = syn_name2attr(wp->w_scrollbar_highlight);
3919 else
3920 attr_scroll = highlight_attr[HLF_PSB];
3921 if (wp->w_thumb_highlight != NULL)
3922 attr_thumb = syn_name2attr(wp->w_thumb_highlight);
3923 else
3924 attr_thumb = highlight_attr[HLF_PST];
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003925 }
3926
3927 for (i = wp->w_popup_border[0];
3928 i < total_height - wp->w_popup_border[2]; ++i)
3929 {
Bram Moolenaard529ba52019-07-02 23:13:53 +02003930 int pad_left;
Bram Moolenaard529ba52019-07-02 23:13:53 +02003931 // left and right padding only needed next to the body
3932 int do_padding =
3933 i >= wp->w_popup_border[0] + wp->w_popup_padding[0]
3934 && i < total_height - wp->w_popup_border[2]
3935 - wp->w_popup_padding[2];
3936
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003937 row = wp->w_winrow + i;
3938
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003939 // left border
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003940 if (wp->w_popup_border[3] > 0 && wincol >= 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003941 {
3942 buf[mb_char2bytes(border_char[3], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003943 screen_puts(buf, row, wincol, border_attr[3]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003944 }
Bram Moolenaard529ba52019-07-02 23:13:53 +02003945 if (do_padding && wp->w_popup_padding[3] > 0)
3946 {
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003947 int col = wincol + wp->w_popup_border[3];
3948
Bram Moolenaard529ba52019-07-02 23:13:53 +02003949 // left padding
Bram Moolenaard529ba52019-07-02 23:13:53 +02003950 pad_left = wp->w_popup_padding[3];
3951 if (col < 0)
3952 {
3953 pad_left += col;
3954 col = 0;
3955 }
3956 if (pad_left > 0)
3957 screen_puts(get_spaces(pad_left), row, col, popup_attr);
3958 }
Bram Moolenaar75fb0852019-06-25 05:15:58 +02003959 // scrollbar
3960 if (wp->w_has_scrollbar)
3961 {
3962 int line = i - top_off;
3963 int scroll_col = wp->w_wincol + total_width - 1
3964 - wp->w_popup_border[1];
3965
3966 if (line >= 0 && line < wp->w_height)
3967 screen_putchar(' ', row, scroll_col,
3968 line >= sb_thumb_top
3969 && line < sb_thumb_top + sb_thumb_height
3970 ? attr_thumb : attr_scroll);
3971 else
3972 screen_putchar(' ', row, scroll_col, popup_attr);
3973 }
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003974 // right border
3975 if (wp->w_popup_border[1] > 0)
3976 {
3977 buf[mb_char2bytes(border_char[1], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003978 screen_puts(buf, row, wincol + total_width - 1, border_attr[1]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003979 }
3980 // right padding
Bram Moolenaard529ba52019-07-02 23:13:53 +02003981 if (do_padding && wp->w_popup_padding[1] > 0)
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003982 screen_puts(get_spaces(wp->w_popup_padding[1]), row,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02003983 wincol + wp->w_popup_border[3]
Bram Moolenaard529ba52019-07-02 23:13:53 +02003984 + wp->w_popup_padding[3] + wp->w_width + wp->w_leftcol,
3985 popup_attr);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003986 }
3987
3988 if (wp->w_popup_padding[2] > 0)
3989 {
3990 // bottom padding
3991 row = wp->w_winrow + wp->w_popup_border[0]
3992 + wp->w_popup_padding[0] + wp->w_height;
3993 screen_fill(row, row + wp->w_popup_padding[2],
Bram Moolenaard91467f2020-11-21 12:42:09 +01003994 padcol, padendcol, ' ', ' ', popup_attr);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02003995 }
3996
3997 if (wp->w_popup_border[2] > 0)
3998 {
3999 // bottom border
4000 row = wp->w_winrow + total_height - 1;
4001 screen_fill(row , row + 1,
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02004002 wincol < 0 ? 0 : wincol,
4003 wincol + total_width,
4004 wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
Bram Moolenaara540f8a2019-06-14 19:23:57 +02004005 ? border_char[7] : border_char[2],
4006 border_char[2], border_attr[2]);
4007 if (wp->w_popup_border[1] > 0)
4008 {
4009 buf[mb_char2bytes(border_char[6], buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02004010 screen_puts(buf, row, wincol + total_width - 1, border_attr[2]);
Bram Moolenaara540f8a2019-06-14 19:23:57 +02004011 }
4012 }
4013
Bram Moolenaar2e62b562019-06-30 18:07:00 +02004014 if (wp->w_popup_close == POPCLOSE_BUTTON)
4015 {
4016 // close button goes on top of anything at the top-right corner
4017 buf[mb_char2bytes('X', buf)] = NUL;
Bram Moolenaarba45f1f2019-07-03 22:50:41 +02004018 screen_puts(buf, wp->w_winrow, wincol + total_width - 1,
Bram Moolenaar2e62b562019-06-30 18:07:00 +02004019 wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
4020 }
4021
Bram Moolenaarc662ec92019-06-23 00:15:57 +02004022 update_popup_transparent(wp, 0);
4023
Bram Moolenaara540f8a2019-06-14 19:23:57 +02004024 // Back to the normal zindex.
4025 screen_zindex = 0;
4026 }
Bram Moolenaar02f9e6a2020-07-15 18:27:08 +02004027
4028#if defined(FEAT_SEARCH_EXTRA)
4029 // In case win_update() called start_search_hl().
4030 end_search_hl();
4031#endif
Bram Moolenaara540f8a2019-06-14 19:23:57 +02004032}
4033
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004034/*
4035 * Mark references in callbacks of one popup window.
4036 */
4037 static int
4038set_ref_in_one_popup(win_T *wp, int copyID)
4039{
4040 int abort = FALSE;
4041 typval_T tv;
4042
4043 if (wp->w_close_cb.cb_partial != NULL)
4044 {
4045 tv.v_type = VAR_PARTIAL;
4046 tv.vval.v_partial = wp->w_close_cb.cb_partial;
4047 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
4048 }
4049 if (wp->w_filter_cb.cb_partial != NULL)
4050 {
4051 tv.v_type = VAR_PARTIAL;
4052 tv.vval.v_partial = wp->w_filter_cb.cb_partial;
4053 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
4054 }
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004055 abort = abort || set_ref_in_list(wp->w_popup_mask, copyID);
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004056 return abort;
4057}
4058
4059/*
4060 * Set reference in callbacks of popup windows.
4061 */
4062 int
4063set_ref_in_popups(int copyID)
4064{
4065 int abort = FALSE;
4066 win_T *wp;
4067 tabpage_T *tp;
4068
4069 for (wp = first_popupwin; !abort && wp != NULL; wp = wp->w_next)
4070 abort = abort || set_ref_in_one_popup(wp, copyID);
4071
4072 FOR_ALL_TABPAGES(tp)
4073 {
4074 for (wp = tp->tp_first_popupwin; !abort && wp != NULL; wp = wp->w_next)
4075 abort = abort || set_ref_in_one_popup(wp, copyID);
4076 if (abort)
4077 break;
4078 }
4079 return abort;
4080}
Bram Moolenaar79648732019-07-18 21:43:07 +02004081
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004082 int
4083popup_is_popup(win_T *wp)
4084{
4085 return wp->w_popup_flags != 0;
4086}
4087
4088#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar79648732019-07-18 21:43:07 +02004089/*
4090 * Find an existing popup used as the preview window, in the current tab page.
4091 * Return NULL if not found.
4092 */
4093 win_T *
4094popup_find_preview_window(void)
4095{
4096 win_T *wp;
4097
4098 // Preview window popup is always local to tab page.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02004099 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar79648732019-07-18 21:43:07 +02004100 if (wp->w_p_pvw)
4101 return wp;
Bram Moolenaar56c0c472019-07-28 17:57:43 +02004102 return NULL;
4103}
4104
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004105/*
4106 * Find an existing popup used as the info window, in the current tab page.
4107 * Return NULL if not found.
4108 */
4109 win_T *
4110popup_find_info_window(void)
4111{
4112 win_T *wp;
4113
4114 // info window popup is always local to tab page.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02004115 FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004116 if (wp->w_popup_flags & POPF_INFO)
4117 return wp;
4118 return NULL;
4119}
Bram Moolenaar36e4d982019-08-20 21:12:16 +02004120#endif
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004121
Bram Moolenaar56c0c472019-07-28 17:57:43 +02004122 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004123f_popup_findinfo(typval_T *argvars UNUSED, typval_T *rettv)
4124{
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004125#ifdef FEAT_QUICKFIX
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004126 win_T *wp = popup_find_info_window();
4127
4128 rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004129#else
4130 rettv->vval.v_number = 0;
4131#endif
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004132}
4133
4134 void
4135f_popup_findpreview(typval_T *argvars UNUSED, typval_T *rettv)
Bram Moolenaar56c0c472019-07-28 17:57:43 +02004136{
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004137#ifdef FEAT_QUICKFIX
Bram Moolenaar56c0c472019-07-28 17:57:43 +02004138 win_T *wp = popup_find_preview_window();
4139
4140 rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004141#else
4142 rettv->vval.v_number = 0;
4143#endif
Bram Moolenaar79648732019-07-18 21:43:07 +02004144}
4145
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004146#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar79648732019-07-18 21:43:07 +02004147/*
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004148 * Create a popup to be used as the preview or info window.
Bram Moolenaar79648732019-07-18 21:43:07 +02004149 * NOTE: this makes the popup the current window, so that the file can be
4150 * edited. However, it must not remain to be the current window, the caller
4151 * must make sure of that.
4152 */
4153 int
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004154popup_create_preview_window(int info)
Bram Moolenaar79648732019-07-18 21:43:07 +02004155{
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004156 win_T *wp = popup_create(NULL, NULL, info ? TYPE_INFO : TYPE_PREVIEW);
Bram Moolenaar79648732019-07-18 21:43:07 +02004157
4158 if (wp == NULL)
4159 return FAIL;
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004160 if (info)
4161 wp->w_popup_flags |= POPF_INFO;
4162 else
4163 wp->w_p_pvw = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02004164
4165 // Set the width to a reasonable value, so that w_topline can be computed.
4166 if (wp->w_minwidth > 0)
4167 wp->w_width = wp->w_minwidth;
4168 else if (wp->w_maxwidth > 0)
4169 wp->w_width = wp->w_maxwidth;
4170 else
4171 wp->w_width = curwin->w_width;
4172
4173 // Will switch to another buffer soon, dummy one can be wiped.
4174 wp->w_buffer->b_locked = FALSE;
4175
4176 win_enter(wp, FALSE);
4177 return OK;
4178}
4179
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004180/*
4181 * Close any preview popup.
4182 */
Bram Moolenaar79648732019-07-18 21:43:07 +02004183 void
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004184popup_close_preview(void)
Bram Moolenaar79648732019-07-18 21:43:07 +02004185{
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004186 win_T *wp = popup_find_preview_window();
Bram Moolenaar79648732019-07-18 21:43:07 +02004187
4188 if (wp != NULL)
Bram Moolenaar12034e22019-08-25 22:25:02 +02004189 popup_close_with_retval(wp, -1);
Bram Moolenaar79648732019-07-18 21:43:07 +02004190}
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004191
4192/*
4193 * Hide the info popup.
4194 */
4195 void
4196popup_hide_info(void)
4197{
4198 win_T *wp = popup_find_info_window();
4199
4200 if (wp != NULL)
4201 popup_hide(wp);
4202}
Bram Moolenaar447bfba2020-07-18 16:07:16 +02004203
4204/*
4205 * Close any info popup.
4206 */
4207 void
4208popup_close_info(void)
4209{
4210 win_T *wp = popup_find_info_window();
4211
4212 if (wp != NULL)
4213 popup_close_with_retval(wp, -1);
4214}
Bram Moolenaar36e4d982019-08-20 21:12:16 +02004215#endif
Bram Moolenaar79648732019-07-18 21:43:07 +02004216
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004217/*
Bram Moolenaar12034e22019-08-25 22:25:02 +02004218 * Close any popup for a text property associated with "win".
4219 * Return TRUE if a popup was closed.
4220 */
4221 int
4222popup_win_closed(win_T *win)
4223{
Bram Moolenaar1fb08312019-08-29 20:02:11 +02004224 int round;
4225 win_T *wp;
4226 win_T *next;
4227 int ret = FALSE;
Bram Moolenaar12034e22019-08-25 22:25:02 +02004228
Bram Moolenaar1fb08312019-08-29 20:02:11 +02004229 for (round = 1; round <= 2; ++round)
4230 for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
4231 wp != NULL; wp = next)
Bram Moolenaar12034e22019-08-25 22:25:02 +02004232 {
Bram Moolenaar1fb08312019-08-29 20:02:11 +02004233 next = wp->w_next;
4234 if (wp->w_popup_prop_win == win)
4235 {
4236 popup_close_with_retval(wp, -1);
4237 ret = TRUE;
4238 }
Bram Moolenaar12034e22019-08-25 22:25:02 +02004239 }
Bram Moolenaar1fb08312019-08-29 20:02:11 +02004240 return ret;
Bram Moolenaar12034e22019-08-25 22:25:02 +02004241}
4242
4243/*
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004244 * Set the title of the popup window to the file name.
4245 */
4246 void
4247popup_set_title(win_T *wp)
4248{
4249 if (wp->w_buffer->b_fname != NULL)
4250 {
4251 char_u dirname[MAXPATHL];
4252 size_t len;
4253
4254 mch_dirname(dirname, MAXPATHL);
4255 shorten_buf_fname(wp->w_buffer, dirname, FALSE);
4256
4257 vim_free(wp->w_popup_title);
4258 len = STRLEN(wp->w_buffer->b_fname) + 3;
4259 wp->w_popup_title = alloc((int)len);
4260 if (wp->w_popup_title != NULL)
4261 vim_snprintf((char *)wp->w_popup_title, len, " %s ",
4262 wp->w_buffer->b_fname);
4263 redraw_win_later(wp, VALID);
4264 }
4265}
4266
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004267# if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004268/*
4269 * If there is a preview window, update the title.
4270 * Used after changing directory.
4271 */
4272 void
4273popup_update_preview_title(void)
4274{
4275 win_T *wp = popup_find_preview_window();
4276
4277 if (wp != NULL)
4278 popup_set_title(wp);
4279}
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01004280# endif
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02004281
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004282#endif // FEAT_PROP_POPUP