summaryrefslogtreecommitdiffstats
path: root/src/popupwin.c
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:09:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:09:20 +0000
commit029f72b1a93430b24b88eb3a72c6114d9f149737 (patch)
tree765d5c2041967f9c6fef195fe343d9234a030e90 /src/popupwin.c
parentInitial commit. (diff)
downloadvim-029f72b1a93430b24b88eb3a72c6114d9f149737.tar.xz
vim-029f72b1a93430b24b88eb3a72c6114d9f149737.zip
Adding upstream version 2:9.1.0016.upstream/2%9.1.0016
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/popupwin.c')
-rw-r--r--src/popupwin.c4735
1 files changed, 4735 insertions, 0 deletions
diff --git a/src/popupwin.c b/src/popupwin.c
new file mode 100644
index 0000000..64bb0b5
--- /dev/null
+++ b/src/popupwin.c
@@ -0,0 +1,4735 @@
+/* vi:set ts=8 sts=4 sw=4 noet:
+ *
+ * VIM - Vi IMproved by Bram Moolenaar
+ *
+ * Do ":help uganda" in Vim to read a list of people who contributed.
+ * Do ":help credits" in Vim to see a list of people who contributed.
+ * See README.txt for an overview of the Vim source code.
+ */
+
+/*
+ * Implementation of popup windows. See ":help popup".
+ */
+
+#include "vim.h"
+
+#if defined(FEAT_PROP_POPUP) || defined(PROTO)
+
+typedef struct {
+ char *pp_name;
+ poppos_T pp_val;
+} poppos_entry_T;
+
+static poppos_entry_T poppos_entries[] = {
+ {"botleft", POPPOS_BOTLEFT},
+ {"topleft", POPPOS_TOPLEFT},
+ {"botright", POPPOS_BOTRIGHT},
+ {"topright", POPPOS_TOPRIGHT},
+ {"center", POPPOS_CENTER}
+};
+
+#ifdef HAS_MESSAGE_WINDOW
+// Window used for ":echowindow"
+static win_T *message_win = NULL;
+
+// Time used for the next ":echowindow" message in msec.
+static int message_win_time = 3000;
+
+// Flag set when a message is added to the message window, timer is started
+// when the message window is drawn. This might be after pressing Enter at the
+// hit-enter prompt.
+static int start_message_win_timer = FALSE;
+
+static void may_start_message_win_timer(win_T *wp);
+#endif
+
+static void popup_adjust_position(win_T *wp);
+
+/*
+ * Get option value for "key", which is "line" or "col".
+ * Handles "cursor+N" and "cursor-N".
+ * Returns MAXCOL if the entry is not present.
+ */
+ static int
+popup_options_one(dict_T *dict, char_u *key)
+{
+ dictitem_T *di;
+ char_u *val;
+ char_u *s;
+ char_u *endp;
+ int n = 0;
+
+ di = dict_find(dict, key, -1);
+ if (di == NULL)
+ return MAXCOL;
+
+ val = tv_get_string(&di->di_tv);
+ if (STRNCMP(val, "cursor", 6) != 0)
+ return dict_get_number_check(dict, key);
+
+ setcursor_mayforce(TRUE);
+ s = val + 6;
+ if (*s != NUL)
+ {
+ endp = s;
+ if (*skipwhite(s) == '+' || *skipwhite(s) == '-')
+ n = strtol((char *)s, (char **)&endp, 10);
+ if (endp != NULL && *skipwhite(endp) != NUL)
+ {
+ semsg(_(e_invalid_expression_str), val);
+ return 0;
+ }
+ }
+
+ if (STRCMP(key, "line") == 0)
+ n = screen_screenrow() + 1 + n;
+ else // "col"
+ n = screen_screencol() + 1 + n;
+
+ // Zero means "not set", use -1 instead.
+ if (n == 0)
+ n = -1;
+ return n;
+}
+
+ static int
+set_padding_border(dict_T *dict, int *array, char *name, int max_val)
+{
+ dictitem_T *di;
+
+ di = dict_find(dict, (char_u *)name, -1);
+ if (di == NULL)
+ return OK;
+
+ if (di->di_tv.v_type != VAR_LIST)
+ {
+ emsg(_(e_list_required));
+ return FAIL;
+ }
+
+ list_T *list = di->di_tv.vval.v_list;
+ listitem_T *li;
+ int i;
+ int nr;
+
+ for (i = 0; i < 4; ++i)
+ array[i] = 1;
+ if (list == NULL)
+ return OK;
+
+ CHECK_LIST_MATERIALIZE(list);
+ for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
+ ++i, li = li->li_next)
+ {
+ nr = (int)tv_get_number(&li->li_tv);
+ if (nr >= 0)
+ array[i] = nr > max_val ? max_val : nr;
+ }
+
+ return OK;
+}
+
+/*
+ * Used when popup options contain "moved": set default moved values.
+ */
+ static void
+set_moved_values(win_T *wp)
+{
+ wp->w_popup_curwin = curwin;
+ wp->w_popup_lnum = curwin->w_cursor.lnum;
+ wp->w_popup_mincol = curwin->w_cursor.col;
+ wp->w_popup_maxcol = curwin->w_cursor.col;
+}
+
+/*
+ * Used when popup options contain "moved" with "word" or "WORD".
+ */
+ static void
+set_moved_columns(win_T *wp, int flags)
+{
+ char_u *ptr;
+ int len = find_ident_under_cursor(&ptr, flags | FIND_NOERROR);
+
+ if (len <= 0)
+ return;
+
+ wp->w_popup_mincol = (int)(ptr - ml_get_curline());
+ wp->w_popup_maxcol = wp->w_popup_mincol + len - 1;
+}
+
+/*
+ * Used when popup options contain "mousemoved": set default moved values.
+ */
+ static void
+set_mousemoved_values(win_T *wp)
+{
+ wp->w_popup_mouse_row = mouse_row;
+ wp->w_popup_mouse_mincol = mouse_col;
+ wp->w_popup_mouse_maxcol = mouse_col;
+}
+
+ static void
+update_popup_uses_mouse_move(void)
+{
+ popup_uses_mouse_move = FALSE;
+ if (!popup_visible)
+ return;
+
+ win_T *wp;
+
+ FOR_ALL_POPUPWINS(wp)
+ if (wp->w_popup_mouse_row != 0)
+ {
+ popup_uses_mouse_move = TRUE;
+ return;
+ }
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ if (wp->w_popup_mouse_row != 0)
+ {
+ popup_uses_mouse_move = TRUE;
+ return;
+ }
+}
+
+/*
+ * Used when popup options contain "moved" with "word" or "WORD".
+ */
+ static void
+set_mousemoved_columns(win_T *wp, int flags)
+{
+ win_T *textwp;
+ char_u *text;
+ int col;
+ pos_T pos;
+ colnr_T mcol;
+
+ if (find_word_under_cursor(mouse_row, mouse_col, TRUE, flags,
+ &textwp, &pos.lnum, &text, NULL, &col) != OK)
+ return;
+
+ // convert text column to mouse column
+ pos.col = col;
+ pos.coladd = 0;
+ getvcol(textwp, &pos, &mcol, NULL, NULL);
+ wp->w_popup_mouse_mincol = mcol;
+
+ pos.col = col + (colnr_T)STRLEN(text) - 1;
+ getvcol(textwp, &pos, NULL, NULL, &mcol);
+ wp->w_popup_mouse_maxcol = mcol;
+ vim_free(text);
+}
+
+/*
+ * Return TRUE if "row"/"col" is on the border of the popup.
+ * The values are relative to the top-left corner.
+ */
+ int
+popup_on_border(win_T *wp, int row, int col)
+{
+ return (row == 0 && wp->w_popup_border[0] > 0)
+ || (row == popup_height(wp) - 1 && wp->w_popup_border[2] > 0)
+ || (col == 0 && wp->w_popup_border[3] > 0)
+ || (col == popup_width(wp) - 1 && wp->w_popup_border[1] > 0);
+}
+
+/*
+ * Return TRUE and close the popup if "row"/"col" is on the "X" button of the
+ * popup and w_popup_close is POPCLOSE_BUTTON.
+ * The values are relative to the top-left corner.
+ * Caller should check the left mouse button was clicked.
+ * Return TRUE if the popup was closed.
+ */
+ int
+popup_close_if_on_X(win_T *wp, int row, int col)
+{
+ if (wp->w_popup_close == POPCLOSE_BUTTON
+ && row == 0 && col == popup_width(wp) - 1)
+ {
+ popup_close_for_mouse_click(wp);
+ return TRUE;
+ }
+ return FALSE;
+}
+
+// Values set when dragging a popup window starts.
+static int drag_start_row;
+static int drag_start_col;
+static int drag_start_wantline;
+static int drag_start_wantcol;
+static int drag_on_resize_handle;
+
+/*
+ * Mouse down on border of popup window: start dragging it.
+ * Uses mouse_col and mouse_row.
+ */
+ void
+popup_start_drag(win_T *wp, int row, int col)
+{
+ drag_start_row = mouse_row;
+ drag_start_col = mouse_col;
+ if (wp->w_wantline <= 0)
+ drag_start_wantline = wp->w_winrow + 1;
+ else
+ drag_start_wantline = wp->w_wantline;
+ if (wp->w_wantcol == 0)
+ drag_start_wantcol = wp->w_wincol + 1;
+ else
+ drag_start_wantcol = wp->w_wantcol;
+
+ // Stop centering the popup
+ if (wp->w_popup_pos == POPPOS_CENTER)
+ wp->w_popup_pos = POPPOS_TOPLEFT;
+
+ drag_on_resize_handle = wp->w_popup_border[1] > 0
+ && wp->w_popup_border[2] > 0
+ && row == popup_height(wp) - 1
+ && col == popup_width(wp) - 1;
+
+ if (wp->w_popup_pos != POPPOS_TOPLEFT && drag_on_resize_handle)
+ {
+ if (wp->w_popup_pos == POPPOS_TOPRIGHT
+ || wp->w_popup_pos == POPPOS_BOTRIGHT)
+ wp->w_wantcol = wp->w_wincol + 1;
+ if (wp->w_popup_pos == POPPOS_BOTLEFT)
+ wp->w_wantline = wp->w_winrow + 1;
+ wp->w_popup_pos = POPPOS_TOPLEFT;
+ }
+}
+
+/*
+ * Mouse moved while dragging a popup window: adjust the window popup position
+ * or resize.
+ */
+ void
+popup_drag(win_T *wp)
+{
+ // The popup may be closed before dragging stops.
+ if (!win_valid_popup(wp))
+ return;
+
+ if ((wp->w_popup_flags & POPF_RESIZE) && drag_on_resize_handle)
+ {
+ int width_inc = mouse_col - drag_start_col;
+ int height_inc = mouse_row - drag_start_row;
+
+ if (width_inc != 0)
+ {
+ int width = wp->w_width + width_inc;
+
+ if (width < 1)
+ width = 1;
+ wp->w_minwidth = width;
+ wp->w_maxwidth = width;
+ drag_start_col = mouse_col;
+ }
+
+ if (height_inc != 0)
+ {
+ int height = wp->w_height + height_inc;
+
+ if (height < 1)
+ height = 1;
+ wp->w_minheight = height;
+ wp->w_maxheight = height;
+ drag_start_row = mouse_row;
+ }
+
+ popup_adjust_position(wp);
+ return;
+ }
+
+ if (!(wp->w_popup_flags & (POPF_DRAG | POPF_DRAGALL)))
+ return;
+ wp->w_wantline = drag_start_wantline + (mouse_row - drag_start_row);
+ if (wp->w_wantline < 1)
+ wp->w_wantline = 1;
+ if (wp->w_wantline > Rows)
+ wp->w_wantline = Rows;
+ wp->w_wantcol = drag_start_wantcol + (mouse_col - drag_start_col);
+ if (wp->w_wantcol < 1)
+ wp->w_wantcol = 1;
+ if (wp->w_wantcol > Columns)
+ wp->w_wantcol = Columns;
+
+ popup_adjust_position(wp);
+}
+
+/*
+ * Set w_firstline to match the current "wp->w_topline".
+ */
+ void
+popup_set_firstline(win_T *wp)
+{
+ int height = wp->w_height;
+
+ wp->w_firstline = wp->w_topline;
+ popup_adjust_position(wp);
+
+ // we don't want the popup to get smaller, decrement the first line
+ // until it doesn't
+ while (wp->w_firstline > 1 && wp->w_height < height)
+ {
+ --wp->w_firstline;
+ popup_adjust_position(wp);
+ }
+}
+
+/*
+ * Return TRUE if the position is in the popup window scrollbar.
+ */
+ int
+popup_is_in_scrollbar(win_T *wp, int row, int col)
+{
+ return wp->w_has_scrollbar
+ && row >= wp->w_popup_border[0]
+ && row < popup_height(wp) - wp->w_popup_border[2]
+ && col == popup_width(wp) - wp->w_popup_border[1] - 1;
+}
+
+
+/*
+ * Handle a click in a popup window, if it is in the scrollbar.
+ */
+ void
+popup_handle_scrollbar_click(win_T *wp, int row, int col)
+{
+ if (!popup_is_in_scrollbar(wp, row, col))
+ return;
+
+ int height = popup_height(wp);
+ int new_topline = wp->w_topline;
+
+ if (row >= height / 2)
+ {
+ // Click in lower half, scroll down.
+ if (wp->w_topline < wp->w_buffer->b_ml.ml_line_count)
+ ++new_topline;
+ }
+ else if (wp->w_topline > 1)
+ // click on upper half, scroll up.
+ --new_topline;
+
+ if (new_topline == wp->w_topline)
+ return;
+
+ set_topline(wp, new_topline);
+ if (wp == curwin)
+ {
+ if (wp->w_cursor.lnum < wp->w_topline)
+ {
+ wp->w_cursor.lnum = wp->w_topline;
+ check_cursor();
+ }
+ else if (wp->w_cursor.lnum >= wp->w_botline)
+ {
+ wp->w_cursor.lnum = wp->w_botline - 1;
+ check_cursor();
+ }
+ }
+ popup_set_firstline(wp);
+ redraw_win_later(wp, UPD_NOT_VALID);
+}
+
+#if defined(FEAT_TIMERS)
+/*
+ * Add a timer to "wp" with "time".
+ * If "close" is true use popup_close(), otherwise popup_hide().
+ */
+ static void
+popup_add_timeout(win_T *wp, int time, int close)
+{
+ char_u cbbuf[50];
+ char_u *ptr = cbbuf;
+ typval_T tv;
+
+ vim_snprintf((char *)cbbuf, sizeof(cbbuf),
+ close ? "(_) => popup_close(%d)" : "(_) => popup_hide(%d)",
+ wp->w_id);
+ if (get_lambda_tv_and_compile(&ptr, &tv, FALSE, &EVALARG_EVALUATE) != OK)
+ return;
+
+ wp->w_popup_timer = create_timer(time, 0);
+ callback_T cb = get_callback(&tv);
+ if (cb.cb_name != NULL && !cb.cb_free_name)
+ {
+ cb.cb_name = vim_strsave(cb.cb_name);
+ cb.cb_free_name = TRUE;
+ }
+ wp->w_popup_timer->tr_callback = cb;
+ clear_tv(&tv);
+}
+#endif
+
+ static poppos_T
+get_pos_entry(dict_T *d, int give_error)
+{
+ char_u *str = dict_get_string(d, "pos", FALSE);
+ int nr;
+
+ if (str == NULL)
+ return POPPOS_NONE;
+
+ for (nr = 0; nr < (int)ARRAY_LENGTH(poppos_entries); ++nr)
+ if (STRCMP(str, poppos_entries[nr].pp_name) == 0)
+ return poppos_entries[nr].pp_val;
+
+ if (give_error)
+ semsg(_(e_invalid_argument_str), str);
+ return POPPOS_NONE;
+}
+
+/*
+ * Shared between popup_create() and f_popup_move().
+ */
+ static void
+apply_move_options(win_T *wp, dict_T *d)
+{
+ int nr;
+ char_u *str;
+ dictitem_T *di;
+
+ if ((nr = dict_get_number_def(d, "minwidth", -1)) >= 0)
+ wp->w_minwidth = nr;
+ if ((nr = dict_get_number_def(d, "minheight", -1)) >= 0)
+ wp->w_minheight = nr;
+ if ((nr = dict_get_number_def(d, "maxwidth", -1)) >= 0)
+ wp->w_maxwidth = nr;
+ if ((nr = dict_get_number_def(d, "maxheight", -1)) >= 0)
+ wp->w_maxheight = nr;
+
+ nr = popup_options_one(d, (char_u *)"line");
+ if (nr != MAXCOL)
+ wp->w_wantline = nr;
+ nr = popup_options_one(d, (char_u *)"col");
+ if (nr != MAXCOL)
+ wp->w_wantcol = nr;
+
+
+ nr = dict_get_bool(d, "fixed", -1);
+ if (nr != -1)
+ wp->w_popup_fixed = nr != 0;
+
+ {
+ poppos_T ppt = get_pos_entry(d, TRUE);
+
+ if (ppt != POPPOS_NONE)
+ wp->w_popup_pos = ppt;
+ }
+
+ str = dict_get_string(d, "textprop", FALSE);
+ if (str != NULL)
+ {
+ wp->w_popup_prop_type = 0;
+ if (*str != NUL)
+ {
+ wp->w_popup_prop_win = curwin;
+ di = dict_find(d, (char_u *)"textpropwin", -1);
+ if (di != NULL)
+ {
+ wp->w_popup_prop_win = find_win_by_nr_or_id(&di->di_tv);
+ if (!win_valid_any_tab(wp->w_popup_prop_win))
+ wp->w_popup_prop_win = curwin;
+ }
+
+ nr = find_prop_type_id(str, wp->w_popup_prop_win->w_buffer);
+ if (nr <= 0)
+ nr = find_prop_type_id(str, NULL);
+ if (nr <= 0)
+ semsg(_(e_invalid_argument_str), str);
+ else
+ wp->w_popup_prop_type = nr;
+ }
+ }
+
+ di = dict_find(d, (char_u *)"textpropid", -1);
+ if (di != NULL)
+ wp->w_popup_prop_id = dict_get_number(d, "textpropid");
+}
+
+/*
+ * Handle "moved" and "mousemoved" arguments.
+ */
+ static void
+handle_moved_argument(win_T *wp, dictitem_T *di, int mousemoved)
+{
+ if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
+ {
+ char_u *s = di->di_tv.vval.v_string;
+ int flags = 0;
+
+ if (STRCMP(s, "word") == 0)
+ flags = FIND_IDENT | FIND_STRING;
+ else if (STRCMP(s, "WORD") == 0)
+ flags = FIND_STRING;
+ else if (STRCMP(s, "expr") == 0)
+ flags = FIND_IDENT | FIND_STRING | FIND_EVAL;
+ else if (STRCMP(s, "any") != 0)
+ semsg(_(e_invalid_argument_str), s);
+ if (flags != 0)
+ {
+ if (mousemoved)
+ set_mousemoved_columns(wp, flags);
+ else
+ set_moved_columns(wp, flags);
+ }
+ }
+ else if (di->di_tv.v_type == VAR_LIST
+ && di->di_tv.vval.v_list != NULL
+ && (di->di_tv.vval.v_list->lv_len == 2
+ || di->di_tv.vval.v_list->lv_len == 3))
+ {
+ list_T *l = di->di_tv.vval.v_list;
+ listitem_T *li;
+ int mincol;
+ int maxcol;
+
+ CHECK_LIST_MATERIALIZE(l);
+ li = l->lv_first;
+ if (l->lv_len == 3)
+ {
+ varnumber_T nr = tv_get_number(&l->lv_first->li_tv);
+
+ // Three numbers, might be from popup_getoptions().
+ if (mousemoved)
+ wp->w_popup_mouse_row = nr;
+ else
+ wp->w_popup_lnum = nr;
+ li = li->li_next;
+ if (nr == 0)
+ wp->w_popup_curwin = NULL;
+ }
+
+ mincol = tv_get_number(&li->li_tv);
+ maxcol = tv_get_number(&li->li_next->li_tv);
+ if (mousemoved)
+ {
+ wp->w_popup_mouse_mincol = mincol;
+ wp->w_popup_mouse_maxcol = maxcol;
+ }
+ else
+ {
+ wp->w_popup_mincol = mincol;
+ wp->w_popup_maxcol = maxcol;
+ }
+ }
+ else
+ semsg(_(e_invalid_argument_str), tv_get_string(&di->di_tv));
+}
+
+ static void
+check_highlight(dict_T *dict, char *name, char_u **pval)
+{
+ dictitem_T *di;
+ char_u *str;
+
+ di = dict_find(dict, (char_u *)name, -1);
+ if (di == NULL)
+ return;
+
+ if (di->di_tv.v_type != VAR_STRING)
+ semsg(_(e_invalid_value_for_argument_str), name);
+ else
+ {
+ str = tv_get_string(&di->di_tv);
+ if (*str != NUL)
+ *pval = vim_strsave(str);
+ }
+}
+
+/*
+ * Scroll to show the line with the cursor.
+ */
+ static void
+popup_show_curline(win_T *wp)
+{
+ if (wp->w_cursor.lnum < wp->w_topline)
+ wp->w_topline = wp->w_cursor.lnum;
+ else if (wp->w_cursor.lnum >= wp->w_botline
+ && (wp->w_valid & VALID_BOTLINE))
+ {
+ wp->w_topline = wp->w_cursor.lnum - wp->w_height + 1;
+ if (wp->w_topline < 1)
+ wp->w_topline = 1;
+ else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
+ wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
+ while (wp->w_topline < wp->w_cursor.lnum
+ && wp->w_topline < wp->w_buffer->b_ml.ml_line_count
+ && plines_m_win(wp, wp->w_topline, wp->w_cursor.lnum, TRUE)
+ > wp->w_height)
+ ++wp->w_topline;
+ }
+
+ // Don't let "firstline" cause a scroll.
+ if (wp->w_firstline > 0)
+ wp->w_firstline = wp->w_topline;
+}
+
+/*
+ * Get the sign group name for window "wp".
+ * Returns a pointer to a static buffer, overwritten on the next call.
+ */
+ static char_u *
+popup_get_sign_name(win_T *wp)
+{
+ static char buf[30];
+
+ vim_snprintf(buf, sizeof(buf), "popup-%d", wp->w_id);
+ return (char_u *)buf;
+}
+
+/*
+ * Highlight the line with the cursor.
+ * Also scrolls the text to put the cursor line in view.
+ */
+ static void
+popup_highlight_curline(win_T *wp)
+{
+ int sign_id = 0;
+ char_u *sign_name = popup_get_sign_name(wp);
+
+ buf_delete_signs(wp->w_buffer, (char_u *)"PopUpMenu");
+
+ if ((wp->w_popup_flags & POPF_CURSORLINE) != 0)
+ {
+ popup_show_curline(wp);
+
+ if (!sign_exists_by_name(sign_name))
+ {
+ char *linehl = "PopupSelected";
+
+ if (syn_name2id((char_u *)linehl) == 0)
+ linehl = "PmenuSel";
+ sign_define_by_name(sign_name, NULL, (char_u *)linehl,
+ NULL, NULL, NULL, NULL);
+ }
+
+ sign_place(&sign_id, (char_u *)"PopUpMenu", sign_name,
+ wp->w_buffer, wp->w_cursor.lnum, SIGN_DEF_PRIO);
+ redraw_win_later(wp, UPD_NOT_VALID);
+ }
+ else
+ sign_undefine_by_name(sign_name, FALSE);
+ wp->w_popup_last_curline = wp->w_cursor.lnum;
+}
+
+/*
+ * Shared between popup_create() and f_popup_setoptions().
+ */
+ static int
+apply_general_options(win_T *wp, dict_T *dict)
+{
+ dictitem_T *di;
+ int nr;
+ char_u *str;
+
+ // TODO: flip
+
+ di = dict_find(dict, (char_u *)"firstline", -1);
+ if (di != NULL)
+ {
+ wp->w_firstline = dict_get_number(dict, "firstline");
+ if (wp->w_firstline < 0)
+ wp->w_firstline = -1;
+ }
+
+ nr = dict_get_bool(dict, "scrollbar", -1);
+ if (nr != -1)
+ wp->w_want_scrollbar = nr;
+
+ str = dict_get_string(dict, "title", FALSE);
+ if (str != NULL)
+ {
+ vim_free(wp->w_popup_title);
+ wp->w_popup_title = vim_strsave(str);
+ }
+
+ nr = dict_get_bool(dict, "wrap", -1);
+ if (nr != -1)
+ wp->w_p_wrap = nr != 0;
+
+ nr = dict_get_bool(dict, "drag", -1);
+ if (nr != -1)
+ {
+ if (nr)
+ wp->w_popup_flags |= POPF_DRAG;
+ else
+ wp->w_popup_flags &= ~POPF_DRAG;
+ }
+ nr = dict_get_bool(dict, "dragall", -1);
+ if (nr != -1)
+ {
+ if (nr)
+ wp->w_popup_flags |= POPF_DRAGALL;
+ else
+ wp->w_popup_flags &= ~POPF_DRAGALL;
+ }
+
+ nr = dict_get_bool(dict, "posinvert", -1);
+ if (nr != -1)
+ {
+ if (nr)
+ wp->w_popup_flags |= POPF_POSINVERT;
+ else
+ wp->w_popup_flags &= ~POPF_POSINVERT;
+ }
+
+ nr = dict_get_bool(dict, "resize", -1);
+ if (nr != -1)
+ {
+ if (nr)
+ wp->w_popup_flags |= POPF_RESIZE;
+ else
+ wp->w_popup_flags &= ~POPF_RESIZE;
+ }
+
+ di = dict_find(dict, (char_u *)"close", -1);
+ if (di != NULL)
+ {
+ int ok = TRUE;
+
+ if (di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
+ {
+ char_u *s = di->di_tv.vval.v_string;
+
+ if (STRCMP(s, "none") == 0)
+ wp->w_popup_close = POPCLOSE_NONE;
+ else if (STRCMP(s, "button") == 0)
+ wp->w_popup_close = POPCLOSE_BUTTON;
+ else if (STRCMP(s, "click") == 0)
+ wp->w_popup_close = POPCLOSE_CLICK;
+ else
+ ok = FALSE;
+ }
+ else
+ ok = FALSE;
+ if (!ok)
+ semsg(_(e_invalid_value_for_argument_str_str), "close", tv_get_string(&di->di_tv));
+ }
+
+ str = dict_get_string(dict, "highlight", FALSE);
+ if (str != NULL)
+ {
+ set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
+ str, OPT_FREE|OPT_LOCAL, 0);
+#ifdef FEAT_TERMINAL
+ term_update_wincolor(wp);
+#endif
+ }
+
+ if (set_padding_border(dict, wp->w_popup_padding, "padding", 999) == FAIL ||
+ set_padding_border(dict, wp->w_popup_border, "border", 1) == FAIL)
+ return FAIL;
+
+ di = dict_find(dict, (char_u *)"borderhighlight", -1);
+ if (di != NULL)
+ {
+ if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
+ {
+ emsg(_(e_list_required));
+ return FAIL;
+ }
+ else
+ {
+ list_T *list = di->di_tv.vval.v_list;
+ listitem_T *li;
+ int i;
+
+ CHECK_LIST_MATERIALIZE(list);
+ for (i = 0, li = list->lv_first; i < 4 && i < list->lv_len;
+ ++i, li = li->li_next)
+ {
+ str = tv_get_string(&li->li_tv);
+ if (*str != NUL)
+ {
+ vim_free(wp->w_border_highlight[i]);
+ wp->w_border_highlight[i] = vim_strsave(str);
+ }
+ }
+ if (list->lv_len == 1 && wp->w_border_highlight[0] != NULL)
+ for (i = 1; i < 4; ++i)
+ {
+ vim_free(wp->w_border_highlight[i]);
+ wp->w_border_highlight[i] =
+ vim_strsave(wp->w_border_highlight[0]);
+ }
+ }
+ }
+
+ di = dict_find(dict, (char_u *)"borderchars", -1);
+ if (di != NULL)
+ {
+ if (di->di_tv.v_type != VAR_LIST)
+ {
+ emsg(_(e_list_required));
+ return FAIL;
+ }
+ else
+ {
+ list_T *list = di->di_tv.vval.v_list;
+ listitem_T *li;
+ int i;
+
+ if (list != NULL)
+ {
+ CHECK_LIST_MATERIALIZE(list);
+ for (i = 0, li = list->lv_first; i < 8 && i < list->lv_len;
+ ++i, li = li->li_next)
+ {
+ str = tv_get_string(&li->li_tv);
+ if (*str != NUL)
+ wp->w_border_char[i] = mb_ptr2char(str);
+ }
+ if (list->lv_len == 1)
+ for (i = 1; i < 8; ++i)
+ wp->w_border_char[i] = wp->w_border_char[0];
+ if (list->lv_len == 2)
+ {
+ for (i = 4; i < 8; ++i)
+ wp->w_border_char[i] = wp->w_border_char[1];
+ for (i = 1; i < 4; ++i)
+ wp->w_border_char[i] = wp->w_border_char[0];
+ }
+ }
+ }
+ }
+
+ check_highlight(dict, "scrollbarhighlight", &wp->w_scrollbar_highlight);
+ check_highlight(dict, "thumbhighlight", &wp->w_thumb_highlight);
+
+ di = dict_find(dict, (char_u *)"zindex", -1);
+ if (di != NULL)
+ {
+ wp->w_zindex = dict_get_number(dict, "zindex");
+ if (wp->w_zindex < 1)
+ wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
+ if (wp->w_zindex > 32000)
+ wp->w_zindex = 32000;
+ }
+
+ di = dict_find(dict, (char_u *)"mask", -1);
+ if (di != NULL)
+ {
+ int ok = FALSE;
+
+ if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
+ {
+ listitem_T *li;
+
+ ok = TRUE;
+ FOR_ALL_LIST_ITEMS(di->di_tv.vval.v_list, li)
+ {
+ if (li->li_tv.v_type != VAR_LIST
+ || li->li_tv.vval.v_list == NULL
+ || li->li_tv.vval.v_list->lv_len != 4)
+ {
+ ok = FALSE;
+ break;
+ }
+ else
+ CHECK_LIST_MATERIALIZE(li->li_tv.vval.v_list);
+ }
+ }
+ if (ok)
+ {
+ wp->w_popup_mask = di->di_tv.vval.v_list;
+ ++wp->w_popup_mask->lv_refcount;
+ VIM_CLEAR(wp->w_popup_mask_cells);
+ }
+ else
+ {
+ semsg(_(e_invalid_value_for_argument_str), "mask");
+ return FAIL;
+ }
+ }
+
+#if defined(FEAT_TIMERS)
+ // Add timer to close the popup after some time.
+ nr = dict_get_number(dict, "time");
+ if (nr > 0)
+ popup_add_timeout(wp, nr, TRUE);
+#endif
+
+ di = dict_find(dict, (char_u *)"moved", -1);
+ if (di != NULL)
+ {
+ set_moved_values(wp);
+ handle_moved_argument(wp, di, FALSE);
+ }
+
+ di = dict_find(dict, (char_u *)"mousemoved", -1);
+ if (di != NULL)
+ {
+ set_mousemoved_values(wp);
+ handle_moved_argument(wp, di, TRUE);
+ }
+
+ nr = dict_get_bool(dict, "cursorline", -1);
+ if (nr != -1)
+ {
+ if (nr != 0)
+ wp->w_popup_flags |= POPF_CURSORLINE;
+ else
+ wp->w_popup_flags &= ~POPF_CURSORLINE;
+ }
+
+ di = dict_find(dict, (char_u *)"filter", -1);
+ if (di != NULL)
+ {
+ callback_T callback = get_callback(&di->di_tv);
+
+ if (callback.cb_name != NULL)
+ {
+ free_callback(&wp->w_filter_cb);
+ set_callback(&wp->w_filter_cb, &callback);
+ if (callback.cb_free_name)
+ vim_free(callback.cb_name);
+ }
+ }
+ nr = dict_get_bool(dict, "mapping", -1);
+ if (nr != -1)
+ {
+ if (nr)
+ wp->w_popup_flags |= POPF_MAPPING;
+ else
+ wp->w_popup_flags &= ~POPF_MAPPING;
+ }
+
+ str = dict_get_string(dict, "filtermode", FALSE);
+ if (str != NULL)
+ {
+ if (STRCMP(str, "a") == 0)
+ wp->w_filter_mode = MODE_ALL;
+ else
+ wp->w_filter_mode = mode_str2flags(str);
+ }
+
+ di = dict_find(dict, (char_u *)"callback", -1);
+ if (di == NULL)
+ return OK;
+
+ callback_T callback = get_callback(&di->di_tv);
+ if (callback.cb_name == NULL)
+ return OK;
+
+ free_callback(&wp->w_close_cb);
+ set_callback(&wp->w_close_cb, &callback);
+ if (callback.cb_free_name)
+ vim_free(callback.cb_name);
+
+ return OK;
+}
+
+/*
+ * Go through the options in "dict" and apply them to popup window "wp".
+ * "create" is TRUE when creating a new popup window.
+ */
+ static int
+apply_options(win_T *wp, dict_T *dict, int create)
+{
+ int nr;
+
+ apply_move_options(wp, dict);
+
+ if (create)
+ set_string_option_direct_in_win(wp, (char_u *)"signcolumn", -1,
+ (char_u *)"no", OPT_FREE|OPT_LOCAL, 0);
+
+ if (apply_general_options(wp, dict) == FAIL)
+ return FAIL;
+
+ nr = dict_get_bool(dict, "hidden", FALSE);
+ if (nr > 0)
+ wp->w_popup_flags |= POPF_HIDDEN | POPF_HIDDEN_FORCE;
+
+ // when "firstline" and "cursorline" are both set and the cursor would be
+ // above or below the displayed lines, move the cursor to "firstline".
+ if (wp->w_firstline > 0 && (wp->w_popup_flags & POPF_CURSORLINE))
+ {
+ if (wp->w_firstline > wp->w_buffer->b_ml.ml_line_count)
+ wp->w_cursor.lnum = wp->w_buffer->b_ml.ml_line_count;
+ else if (wp->w_cursor.lnum < wp->w_firstline
+ || wp->w_cursor.lnum >= wp->w_firstline + wp->w_height)
+ wp->w_cursor.lnum = wp->w_firstline;
+ wp->w_topline = wp->w_firstline;
+ wp->w_valid &= ~VALID_BOTLINE;
+ }
+
+ popup_mask_refresh = TRUE;
+ popup_highlight_curline(wp);
+
+ return OK;
+}
+
+/*
+ * Add lines to the popup from a list of strings.
+ */
+ static void
+add_popup_strings(buf_T *buf, list_T *l)
+{
+ listitem_T *li;
+ linenr_T lnum = 0;
+ char_u *p;
+
+ FOR_ALL_LIST_ITEMS(l, li)
+ if (li->li_tv.v_type == VAR_STRING)
+ {
+ p = li->li_tv.vval.v_string;
+ ml_append_buf(buf, lnum++,
+ p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
+ }
+}
+
+/*
+ * Add lines to the popup from a list of dictionaries.
+ */
+ static void
+add_popup_dicts(buf_T *buf, list_T *l)
+{
+ listitem_T *li;
+ listitem_T *pli;
+ linenr_T lnum = 0;
+ char_u *p;
+ dict_T *dict;
+
+ // first add the text lines
+ FOR_ALL_LIST_ITEMS(l, li)
+ {
+ if (li->li_tv.v_type != VAR_DICT)
+ {
+ semsg(_(e_argument_1_list_item_nr_dictionary_required), lnum + 1);
+ return;
+ }
+ dict = li->li_tv.vval.v_dict;
+ p = dict == NULL ? NULL : dict_get_string(dict, "text", FALSE);
+ ml_append_buf(buf, lnum++,
+ p == NULL ? (char_u *)"" : p, (colnr_T)0, TRUE);
+ }
+
+ // add the text properties
+ lnum = 1;
+ for (li = l->lv_first; li != NULL; li = li->li_next, ++lnum)
+ {
+ dictitem_T *di;
+ list_T *plist;
+
+ dict = li->li_tv.vval.v_dict;
+ di = dict_find(dict, (char_u *)"props", -1);
+ if (di != NULL)
+ {
+ if (di->di_tv.v_type != VAR_LIST)
+ {
+ emsg(_(e_list_required));
+ return;
+ }
+ plist = di->di_tv.vval.v_list;
+ if (plist != NULL)
+ {
+ FOR_ALL_LIST_ITEMS(plist, pli)
+ {
+ if (pli->li_tv.v_type != VAR_DICT)
+ {
+ emsg(_(e_dictionary_required));
+ return;
+ }
+ dict = pli->li_tv.vval.v_dict;
+ if (dict != NULL)
+ {
+ int col = dict_get_number(dict, "col");
+
+ prop_add_common(lnum, col, dict, buf, NULL);
+ }
+ }
+ }
+ }
+ }
+}
+
+/*
+ * Get the padding plus border at the top, adjusted to 1 if there is a title.
+ */
+ int
+popup_top_extra(win_T *wp)
+{
+ int extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
+
+ if (extra == 0 && wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
+ return 1;
+ return extra;
+}
+
+/*
+ * Get the padding plus border at the left.
+ */
+ int
+popup_left_extra(win_T *wp)
+{
+ return wp->w_popup_border[3] + wp->w_popup_padding[3];
+}
+
+/*
+ * Return the height of popup window "wp", including border and padding.
+ */
+ int
+popup_height(win_T *wp)
+{
+ return wp->w_height
+ + popup_top_extra(wp)
+ + wp->w_popup_padding[2] + wp->w_popup_border[2];
+}
+
+/*
+ * Return the width of popup window "wp", including border, padding and
+ * scrollbar.
+ */
+ int
+popup_width(win_T *wp)
+{
+ // w_leftcol is how many columns of the core are left of the screen
+ // w_popup_rightoff is how many columns of the core are right of the screen
+ return wp->w_width + wp->w_leftcol
+ + popup_extra_width(wp)
+ + wp->w_popup_rightoff;
+}
+
+/*
+ * Return the extra width of popup window "wp": border, padding and scrollbar.
+ */
+ int
+popup_extra_width(win_T *wp)
+{
+ return wp->w_popup_padding[3] + wp->w_popup_border[3]
+ + wp->w_popup_padding[1] + wp->w_popup_border[1]
+ + wp->w_has_scrollbar;
+}
+
+/*
+ * Adjust the position and size of the popup to fit on the screen.
+ */
+ static void
+popup_adjust_position(win_T *wp)
+{
+ linenr_T lnum;
+ int wrapped = 0;
+ int maxwidth;
+ int maxwidth_no_scrollbar;
+ int width_with_scrollbar = 0;
+ int used_maxwidth = FALSE;
+ int margin_width = 0;
+ int maxspace;
+ int center_vert = FALSE;
+ int center_hor = FALSE;
+ int allow_adjust_left = !wp->w_popup_fixed;
+ int top_extra = popup_top_extra(wp);
+ int right_extra = wp->w_popup_border[1] + wp->w_popup_padding[1];
+ int bot_extra = wp->w_popup_border[2] + wp->w_popup_padding[2];
+ int left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
+ int extra_height = top_extra + bot_extra;
+ int extra_width = left_extra + right_extra;
+ int w_height_before_limit;
+ int org_winrow = wp->w_winrow;
+ int org_wincol = wp->w_wincol;
+ int org_width = wp->w_width;
+ int org_height = wp->w_height;
+ int org_leftcol = wp->w_leftcol;
+ int org_leftoff = wp->w_popup_leftoff;
+ int minwidth, minheight;
+ int maxheight = Rows;
+ int wantline = wp->w_wantline; // adjusted for textprop
+ int wantcol = wp->w_wantcol; // adjusted for textprop
+ int use_wantcol = wantcol != 0;
+ int adjust_height_for_top_aligned = FALSE;
+
+ wp->w_winrow = 0;
+ wp->w_wincol = 0;
+ wp->w_leftcol = 0;
+ wp->w_popup_leftoff = 0;
+ wp->w_popup_rightoff = 0;
+
+ // May need to update the "cursorline" highlighting, which may also change
+ // "topline"
+ if (wp->w_popup_last_curline != wp->w_cursor.lnum)
+ popup_highlight_curline(wp);
+
+ if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
+ {
+ win_T *prop_win = wp->w_popup_prop_win;
+ textprop_T prop;
+ linenr_T prop_lnum;
+ pos_T pos;
+ int screen_row;
+ int screen_scol;
+ int screen_ccol;
+ int screen_ecol;
+
+ // Popup window is positioned relative to a text property.
+ if (find_visible_prop(prop_win,
+ wp->w_popup_prop_type, wp->w_popup_prop_id,
+ &prop, &prop_lnum) == FAIL)
+ {
+ // Text property is no longer visible, hide the popup.
+ // Unhiding the popup is done in check_popup_unhidden().
+ if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
+ {
+ wp->w_popup_flags |= POPF_HIDDEN;
+ if (win_valid(wp->w_popup_prop_win))
+ redraw_win_later(wp->w_popup_prop_win, UPD_SOME_VALID);
+ }
+ return;
+ }
+
+ // Compute the desired position from the position of the text
+ // property. Use "wantline" and "wantcol" as offsets.
+ pos.lnum = prop_lnum;
+ pos.col = prop.tp_col;
+ if (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_BOTLEFT)
+ pos.col += prop.tp_len - 1;
+ textpos2screenpos(prop_win, &pos, &screen_row,
+ &screen_scol, &screen_ccol, &screen_ecol);
+
+ if (screen_scol == 0)
+ {
+ // position is off screen, make the width zero to hide it.
+ wp->w_width = 0;
+ return;
+ }
+ if (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_TOPRIGHT)
+ // below the text
+ wantline = screen_row + wantline + 1;
+ else
+ // above the text
+ wantline = screen_row + wantline - 1;
+ center_vert = FALSE;
+ if (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_BOTLEFT)
+ // right of the text
+ wantcol = screen_ecol + wantcol;
+ else
+ // left of the text
+ wantcol = screen_scol + wantcol - 2;
+ use_wantcol = TRUE;
+ }
+ else
+ {
+ // If no line was specified default to vertical centering.
+ if (wantline == 0)
+ center_vert = TRUE;
+ else if (wantline < 0)
+ // If "wantline" is negative it actually means zero.
+ wantline = 0;
+ if (wantcol < 0)
+ // If "wantcol" is negative it actually means zero.
+ wantcol = 0;
+ }
+
+ if (wp->w_popup_pos == POPPOS_CENTER)
+ {
+ // center after computing the size
+ center_vert = TRUE;
+ center_hor = TRUE;
+ }
+ else
+ {
+ if (wantline > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_TOPRIGHT))
+ {
+ wp->w_winrow = wantline - 1;
+ if (wp->w_winrow >= Rows)
+ wp->w_winrow = Rows - 1;
+ }
+ if (wp->w_popup_pos == POPPOS_BOTTOM)
+ {
+ // Assume that each buffer line takes one screen line, and one line
+ // for the top border. First make sure cmdline_row is valid,
+ // calling update_screen() will set it only later.
+ compute_cmdrow();
+ wp->w_winrow = MAX(cmdline_row
+ - wp->w_buffer->b_ml.ml_line_count - 1, 0);
+ }
+
+ if (!use_wantcol)
+ center_hor = TRUE;
+ else if (wantcol > 0 && (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_BOTLEFT))
+ {
+ wp->w_wincol = wantcol - 1;
+ // Need to see at least one character after the decoration.
+ if (wp->w_wincol > Columns - left_extra - 1)
+ wp->w_wincol = Columns - left_extra - 1;
+ }
+ }
+
+ // When centering or right aligned, use maximum width.
+ // When left aligned use the space available, but shift to the left when we
+ // hit the right of the screen.
+ maxspace = Columns - wp->w_wincol - left_extra;
+ maxwidth = maxspace;
+ if (wp->w_maxwidth > 0 && maxwidth > wp->w_maxwidth)
+ {
+ allow_adjust_left = FALSE;
+ maxwidth = wp->w_maxwidth;
+ }
+
+ if (wp->w_p_nu || wp->w_p_rnu)
+ margin_width = number_width(wp) + 1;
+#ifdef FEAT_FOLDING
+ margin_width += wp->w_p_fdc;
+#endif
+#ifdef FEAT_SIGNS
+ if (signcolumn_on(wp))
+ margin_width += 2;
+#endif
+ if (margin_width >= maxwidth)
+ margin_width = maxwidth - 1;
+
+ minwidth = wp->w_minwidth;
+ minheight = wp->w_minheight;
+#ifdef FEAT_TERMINAL
+ // A terminal popup initially does not have content, use a default minimal
+ // width of 20 characters and height of 5 lines.
+ if (wp->w_buffer->b_term != NULL)
+ {
+ if (minwidth == 0)
+ minwidth = 20;
+ if (minheight == 0)
+ minheight = 5;
+ }
+#endif
+
+ if (wp->w_maxheight > 0)
+ maxheight = wp->w_maxheight;
+ else if (wp->w_popup_pos == POPPOS_BOTTOM)
+ maxheight = cmdline_row - 1;
+
+ // start at the desired first line
+ if (wp->w_firstline > 0)
+ wp->w_topline = wp->w_firstline;
+ if (wp->w_topline < 1)
+ wp->w_topline = 1;
+ else if (wp->w_topline > wp->w_buffer->b_ml.ml_line_count)
+ wp->w_topline = wp->w_buffer->b_ml.ml_line_count;
+
+ // Compute width based on longest text line and the 'wrap' option.
+ // Use a minimum width of one, so that something shows when there is no
+ // text.
+ // When "firstline" is -1 then start with the last buffer line and go
+ // backwards.
+ // TODO: more accurate wrapping
+ wp->w_width = 1;
+ if (wp->w_firstline < 0)
+ lnum = wp->w_buffer->b_ml.ml_line_count;
+ else
+ lnum = wp->w_topline;
+ while (lnum >= 1 && lnum <= wp->w_buffer->b_ml.ml_line_count)
+ {
+ int len;
+ int w_width = wp->w_width;
+
+ // Count Tabs for what they are worth and compute the length based on
+ // the maximum width (matters when 'showbreak' is set).
+ // "margin_width" is added to "len" where it matters.
+ if (wp->w_width < maxwidth)
+ wp->w_width = maxwidth;
+ len = linetabsize(wp, lnum);
+ wp->w_width = w_width;
+
+ if (wp->w_p_wrap)
+ {
+ while (len + margin_width > maxwidth)
+ {
+ ++wrapped;
+ len -= maxwidth - margin_width;
+ wp->w_width = maxwidth;
+ used_maxwidth = TRUE;
+ }
+ }
+ else if (len + margin_width > maxwidth
+ && allow_adjust_left
+ && (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_BOTLEFT))
+ {
+ // adjust leftwise to fit text on screen
+ int shift_by = len + margin_width - maxwidth;
+
+ if (shift_by > wp->w_wincol)
+ {
+ int truncate_shift = shift_by - wp->w_wincol;
+
+ len -= truncate_shift;
+ shift_by -= truncate_shift;
+ }
+
+ wp->w_wincol -= shift_by;
+ maxwidth += shift_by;
+ wp->w_width = maxwidth;
+ }
+ if (wp->w_width < len + margin_width)
+ {
+ wp->w_width = len + margin_width;
+ if (wp->w_maxwidth > 0 && wp->w_width > wp->w_maxwidth)
+ wp->w_width = wp->w_maxwidth;
+ }
+
+ if (wp->w_firstline < 0)
+ --lnum;
+ else
+ ++lnum;
+
+ // do not use the width of lines we're not going to show
+ if (maxheight > 0
+ && (wp->w_firstline >= 0
+ ? lnum - wp->w_topline
+ : wp->w_buffer->b_ml.ml_line_count - lnum)
+ + wrapped >= maxheight)
+ break;
+ }
+
+ if (wp->w_firstline < 0)
+ wp->w_topline = lnum + 1;
+
+ wp->w_has_scrollbar = wp->w_want_scrollbar
+ && (wp->w_topline > 1 || lnum <= wp->w_buffer->b_ml.ml_line_count);
+#ifdef FEAT_TERMINAL
+ if (wp->w_buffer->b_term != NULL && !term_is_finished(wp->w_buffer))
+ // Terminal window with running job never has a scrollbar, adjusts to
+ // window height.
+ wp->w_has_scrollbar = FALSE;
+#endif
+ maxwidth_no_scrollbar = maxwidth;
+ if (wp->w_has_scrollbar)
+ {
+ ++right_extra;
+ ++extra_width;
+ // make space for the scrollbar if needed, when lines wrap and when
+ // applying minwidth
+ if (maxwidth + right_extra >= maxspace
+ && (used_maxwidth || (minwidth > 0 && wp->w_width < minwidth)))
+ maxwidth -= wp->w_popup_padding[1] + 1;
+ }
+
+ if (wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
+ {
+ int title_len = vim_strsize(wp->w_popup_title) + 2 - extra_width;
+
+ if (minwidth < title_len)
+ minwidth = title_len;
+ }
+
+ if (minwidth > 0 && wp->w_width < minwidth)
+ wp->w_width = minwidth;
+ if (wp->w_width > maxwidth)
+ {
+ if (wp->w_width > maxspace && !wp->w_p_wrap)
+ // some columns cut off on the right
+ wp->w_popup_rightoff = wp->w_width - maxspace;
+
+ // If the window doesn't fit because 'minwidth' is set then the
+ // scrollbar is at the far right of the screen, use the size without
+ // the scrollbar.
+ if (wp->w_has_scrollbar && wp->w_minwidth > 0)
+ {
+ int off = wp->w_width - maxwidth;
+
+ if (off > right_extra)
+ extra_width -= right_extra;
+ else
+ extra_width -= off;
+ wp->w_width = maxwidth_no_scrollbar;
+ }
+ else
+ {
+ wp->w_width = maxwidth;
+
+ // when adding a scrollbar below need to adjust the width
+ width_with_scrollbar = maxwidth_no_scrollbar - right_extra;
+ }
+ }
+ if (center_hor)
+ {
+ wp->w_wincol = (Columns - wp->w_width - extra_width) / 2;
+ if (wp->w_wincol < 0)
+ wp->w_wincol = 0;
+ }
+ else if (wp->w_popup_pos == POPPOS_BOTRIGHT
+ || wp->w_popup_pos == POPPOS_TOPRIGHT)
+ {
+ int leftoff = wantcol - (wp->w_width + extra_width);
+
+ // Right aligned: move to the right if needed.
+ // No truncation, because that would change the height.
+ if (leftoff >= 0)
+ wp->w_wincol = leftoff;
+ else if (wp->w_popup_fixed)
+ {
+ // "col" specifies the right edge, but popup doesn't fit, skip some
+ // columns when displaying the window, minus left border and
+ // padding.
+ if (-leftoff > left_extra)
+ wp->w_leftcol = -leftoff - left_extra;
+ wp->w_width -= wp->w_leftcol;
+ wp->w_popup_leftoff = -leftoff;
+ if (wp->w_width < 0)
+ wp->w_width = 0;
+ }
+ }
+
+ if (wp->w_p_wrap || (!wp->w_popup_fixed
+ && (wp->w_popup_pos == POPPOS_TOPLEFT
+ || wp->w_popup_pos == POPPOS_BOTLEFT)))
+ {
+ int want_col = 0;
+
+ // try to show the right border and any scrollbar
+ want_col = left_extra + wp->w_width + right_extra;
+ if (want_col > 0 && wp->w_wincol > 0
+ && wp->w_wincol + want_col >= Columns)
+ {
+ wp->w_wincol = Columns - want_col;
+ if (wp->w_wincol < 0)
+ wp->w_wincol = 0;
+ }
+ }
+
+ wp->w_height = wp->w_buffer->b_ml.ml_line_count - wp->w_topline
+ + 1 + wrapped;
+ if (minheight > 0 && wp->w_height < minheight)
+ wp->w_height = minheight;
+ if (maxheight > 0 && wp->w_height > maxheight)
+ wp->w_height = maxheight;
+ w_height_before_limit = wp->w_height;
+ if (wp->w_height > Rows - wp->w_winrow)
+ wp->w_height = Rows - wp->w_winrow;
+
+ if (center_vert)
+ {
+ wp->w_winrow = (Rows - wp->w_height - extra_height) / 2;
+ if (wp->w_winrow < 0)
+ wp->w_winrow = 0;
+ }
+ else if (wp->w_popup_pos == POPPOS_BOTRIGHT
+ || wp->w_popup_pos == POPPOS_BOTLEFT)
+ {
+ if ((wp->w_height + extra_height) <= wantline)
+ // bottom aligned: may move down
+ wp->w_winrow = wantline - (wp->w_height + extra_height);
+ else if (wantline * 2 >= Rows || !(wp->w_popup_flags & POPF_POSINVERT))
+ {
+ // Bottom aligned but does not fit, and less space on the other
+ // side or "posinvert" is off: reduce height.
+ wp->w_winrow = 0;
+ wp->w_height = wantline - extra_height;
+ }
+ else
+ {
+ // Not enough space and more space on the other side: make top
+ // aligned.
+ wp->w_winrow = (wantline < 0 ? 0 : wantline) + 1;
+ adjust_height_for_top_aligned = TRUE;
+ }
+ }
+ else if (wp->w_popup_pos == POPPOS_TOPRIGHT
+ || wp->w_popup_pos == POPPOS_TOPLEFT)
+ {
+ if (wp != popup_dragwin
+ && wantline + (wp->w_height + extra_height) - 1 > Rows
+ && wantline * 2 > Rows
+ && (wp->w_popup_flags & POPF_POSINVERT))
+ {
+ // top aligned and not enough space below but there is space above:
+ // make bottom aligned and recompute the height
+ wp->w_height = w_height_before_limit;
+ wp->w_winrow = wantline - 2 - wp->w_height - extra_height;
+ if (wp->w_winrow < 0)
+ {
+ wp->w_height += wp->w_winrow;
+ wp->w_winrow = 0;
+ }
+ }
+ else
+ {
+ wp->w_winrow = wantline - 1;
+ adjust_height_for_top_aligned = TRUE;
+ }
+ }
+
+ if (adjust_height_for_top_aligned && wp->w_want_scrollbar
+ && wp->w_winrow + wp->w_height + extra_height > Rows)
+ {
+ // Bottom of the popup goes below the last line, reduce the height and
+ // add a scrollbar.
+ wp->w_height = Rows - wp->w_winrow - extra_height;
+#ifdef FEAT_TERMINAL
+ if (wp->w_buffer->b_term == NULL || term_is_finished(wp->w_buffer))
+#endif
+ {
+ wp->w_has_scrollbar = TRUE;
+ if (width_with_scrollbar > 0)
+ wp->w_width = width_with_scrollbar;
+ }
+ }
+
+ // make sure w_winrow is valid
+ if (wp->w_winrow >= Rows)
+ wp->w_winrow = Rows - 1;
+ else if (wp->w_winrow < 0)
+ wp->w_winrow = 0;
+
+ if (wp->w_height != org_height)
+ win_comp_scroll(wp);
+
+ wp->w_popup_last_changedtick = CHANGEDTICK(wp->w_buffer);
+ if (win_valid(wp->w_popup_prop_win))
+ {
+ wp->w_popup_prop_changedtick =
+ CHANGEDTICK(wp->w_popup_prop_win->w_buffer);
+ wp->w_popup_prop_topline = wp->w_popup_prop_win->w_topline;
+ }
+
+ // Need to update popup_mask if the position or size changed.
+ // And redraw windows and statuslines that were behind the popup.
+ if (org_winrow != wp->w_winrow
+ || org_wincol != wp->w_wincol
+ || org_leftcol != wp->w_leftcol
+ || org_leftoff != wp->w_popup_leftoff
+ || org_width != wp->w_width
+ || org_height != wp->w_height)
+ {
+ redraw_win_later(wp, UPD_NOT_VALID);
+ if (wp->w_popup_flags & POPF_ON_CMDLINE)
+ clear_cmdline = TRUE;
+ popup_mask_refresh = TRUE;
+ }
+}
+
+typedef enum
+{
+ TYPE_NORMAL,
+ TYPE_ATCURSOR,
+ TYPE_BEVAL,
+ TYPE_NOTIFICATION,
+ TYPE_MESSAGE_WIN, // similar to TYPE_NOTIFICATION
+ TYPE_DIALOG,
+ TYPE_MENU,
+ TYPE_PREVIEW, // preview window
+ TYPE_INFO // popup menu info
+} create_type_T;
+
+/*
+ * Return TRUE if "type" is TYPE_NOTIFICATION or TYPE_MESSAGE_WIN.
+ */
+ static int
+popup_is_notification(create_type_T type)
+{
+ return type == TYPE_NOTIFICATION || type == TYPE_MESSAGE_WIN;
+}
+
+/*
+ * Make "buf" empty and set the contents to "text".
+ * Used by popup_create() and popup_settext().
+ */
+ static void
+popup_set_buffer_text(buf_T *buf, typval_T text)
+{
+ int lnum;
+
+ // Clear the buffer, then replace the lines.
+ curbuf = buf;
+ for (lnum = buf->b_ml.ml_line_count; lnum > 0; --lnum)
+ ml_delete(lnum);
+ curbuf = curwin->w_buffer;
+
+ // Add text to the buffer.
+ if (text.v_type == VAR_STRING)
+ {
+ char_u *s = text.vval.v_string;
+
+ // just a string
+ ml_append_buf(buf, 0, s == NULL ? (char_u *)"" : s, (colnr_T)0, TRUE);
+ }
+ else
+ {
+ list_T *l = text.vval.v_list;
+
+ if (l != NULL && l->lv_len > 0)
+ {
+ if (l->lv_first == &range_list_item)
+ emsg(_(e_using_number_as_string));
+ else if (l->lv_first->li_tv.v_type == VAR_STRING)
+ // list of strings
+ add_popup_strings(buf, l);
+ else
+ // list of dictionaries
+ add_popup_dicts(buf, l);
+ }
+ }
+
+ // delete the line that was in the empty buffer
+ curbuf = buf;
+ ml_delete(buf->b_ml.ml_line_count);
+ curbuf = curwin->w_buffer;
+}
+
+/*
+ * Parse the 'previewpopup' or 'completepopup' option and apply the values to
+ * window "wp" if it is not NULL.
+ * Return FAIL if the parsing fails.
+ */
+ static int
+parse_popup_option(win_T *wp, int is_preview)
+{
+ char_u *p =
+#ifdef FEAT_QUICKFIX
+ !is_preview ? p_cpp :
+#endif
+ p_pvp;
+
+ if (wp != NULL)
+ wp->w_popup_flags &= ~POPF_INFO_MENU;
+
+ for ( ; *p != NUL; p += (*p == ',' ? 1 : 0))
+ {
+ char_u *e, *dig;
+ char_u *s = p;
+ int x;
+
+ e = vim_strchr(p, ':');
+ if (e == NULL || e[1] == NUL)
+ return FAIL;
+
+ p = vim_strchr(e, ',');
+ if (p == NULL)
+ p = e + STRLEN(e);
+ dig = e + 1;
+ x = getdigits(&dig);
+
+ // Note: Keep this in sync with p_popup_option_values.
+ if (STRNCMP(s, "height:", 7) == 0)
+ {
+ if (dig != p)
+ return FAIL;
+ if (wp != NULL)
+ {
+ if (is_preview)
+ wp->w_minheight = x;
+ wp->w_maxheight = x;
+ }
+ }
+ else if (STRNCMP(s, "width:", 6) == 0)
+ {
+ if (dig != p)
+ return FAIL;
+ if (wp != NULL)
+ {
+ if (is_preview)
+ wp->w_minwidth = x;
+ wp->w_maxwidth = x;
+ wp->w_maxwidth_opt = x;
+ }
+ }
+ else if (STRNCMP(s, "highlight:", 10) == 0)
+ {
+ if (wp != NULL)
+ {
+ int c = *p;
+
+ *p = NUL;
+ set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
+ s + 10, OPT_FREE|OPT_LOCAL, 0);
+ *p = c;
+ }
+ }
+ else if (STRNCMP(s, "border:", 7) == 0)
+ {
+ // Note: Keep this in sync with p_popup_option_border_values.
+ char_u *arg = s + 7;
+ int on = STRNCMP(arg, "on", 2) == 0 && arg + 2 == p;
+ int off = STRNCMP(arg, "off", 3) == 0 && arg + 3 == p;
+ int i;
+
+ if (!on && !off)
+ return FAIL;
+ if (wp != NULL)
+ {
+ for (i = 0; i < 4; ++i)
+ wp->w_popup_border[i] = on ? 1 : 0;
+ if (off)
+ // only show the X for close when there is a border
+ wp->w_popup_close = POPCLOSE_NONE;
+ }
+ }
+ else if (STRNCMP(s, "align:", 6) == 0)
+ {
+ // Note: Keep this in sync with p_popup_option_align_values.
+ char_u *arg = s + 6;
+ int item = STRNCMP(arg, "item", 4) == 0 && arg + 4 == p;
+ int menu = STRNCMP(arg, "menu", 4) == 0 && arg + 4 == p;
+
+ if (!menu && !item)
+ return FAIL;
+ if (wp != NULL && menu)
+ wp->w_popup_flags |= POPF_INFO_MENU;
+ }
+ else
+ return FAIL;
+ }
+ return OK;
+}
+
+/*
+ * Parse the 'previewpopup' option and apply the values to window "wp" if it
+ * is not NULL.
+ * Return FAIL if the parsing fails.
+ */
+ int
+parse_previewpopup(win_T *wp)
+{
+ return parse_popup_option(wp, TRUE);
+}
+
+/*
+ * Parse the 'completepopup' option and apply the values to window "wp" if it
+ * is not NULL.
+ * Return FAIL if the parsing fails.
+ */
+ int
+parse_completepopup(win_T *wp)
+{
+ return parse_popup_option(wp, FALSE);
+}
+
+/*
+ * Set w_wantline and w_wantcol for the cursor position in the current window.
+ * Keep at least "width" columns from the right of the screen.
+ */
+ void
+popup_set_wantpos_cursor(win_T *wp, int width, dict_T *d)
+{
+ poppos_T ppt = POPPOS_NONE;
+
+ if (d != NULL)
+ ppt = get_pos_entry(d, FALSE);
+
+ setcursor_mayforce(TRUE);
+ if (ppt == POPPOS_TOPRIGHT || ppt == POPPOS_TOPLEFT)
+ {
+ wp->w_wantline = curwin->w_winrow + curwin->w_wrow + 2;
+ }
+ else
+ {
+ wp->w_wantline = curwin->w_winrow + curwin->w_wrow;
+ if (wp->w_wantline == 0) // cursor in first line
+ {
+ wp->w_wantline = 2;
+ wp->w_popup_pos = ppt == POPPOS_BOTRIGHT
+ ? POPPOS_TOPRIGHT : POPPOS_TOPLEFT;
+ }
+ }
+
+ wp->w_wantcol = curwin->w_wincol + curwin->w_wcol + 1;
+ if (wp->w_wantcol > Columns - width)
+ {
+ wp->w_wantcol = Columns - width;
+ if (wp->w_wantcol < 1)
+ wp->w_wantcol = 1;
+ }
+
+ popup_adjust_position(wp);
+}
+
+/*
+ * Set w_wantline and w_wantcol for the a given screen position.
+ * Caller must take care of running into the window border.
+ */
+ void
+popup_set_wantpos_rowcol(win_T *wp, int row, int col)
+{
+ wp->w_wantline = row;
+ wp->w_wantcol = col;
+ popup_adjust_position(wp);
+}
+
+/*
+ * Add a border and lef&right padding.
+ */
+ static void
+add_border_left_right_padding(win_T *wp)
+{
+ int i;
+
+ for (i = 0; i < 4; ++i)
+ {
+ wp->w_popup_border[i] = 1;
+ wp->w_popup_padding[i] = (i & 1) ? 1 : 0;
+ }
+}
+
+#ifdef FEAT_TERMINAL
+/*
+ * Return TRUE if there is any popup window with a terminal buffer.
+ */
+ static int
+popup_terminal_exists(void)
+{
+ win_T *wp;
+ tabpage_T *tp;
+
+ FOR_ALL_POPUPWINS(wp)
+ if (wp->w_buffer->b_term != NULL)
+ return TRUE;
+ FOR_ALL_TABPAGES(tp)
+ FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
+ if (wp->w_buffer->b_term != NULL)
+ return TRUE;
+ return FALSE;
+}
+#endif
+
+/*
+ * Mark all popup windows in the current tab and global for redrawing.
+ */
+ void
+popup_redraw_all(void)
+{
+ win_T *wp;
+
+ FOR_ALL_POPUPWINS(wp)
+ wp->w_redr_type = UPD_NOT_VALID;
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ wp->w_redr_type = UPD_NOT_VALID;
+}
+
+/*
+ * Set the color for a notification window.
+ */
+ static void
+popup_update_color(win_T *wp, create_type_T type)
+{
+ char *hiname = type == TYPE_MESSAGE_WIN
+ ? "MessageWindow" : "PopupNotification";
+ int nr = syn_name2id((char_u *)hiname);
+
+ set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
+ (char_u *)(nr == 0 ? "WarningMsg" : hiname),
+ OPT_FREE|OPT_LOCAL, 0);
+}
+
+/*
+ * popup_create({text}, {options})
+ * popup_atcursor({text}, {options})
+ * etc.
+ * When creating a preview or info popup "argvars" and "rettv" are NULL.
+ */
+ static win_T *
+popup_create(typval_T *argvars, typval_T *rettv, create_type_T type)
+{
+ win_T *wp;
+ tabpage_T *tp = NULL;
+ int tabnr = 0;
+ int new_buffer;
+ buf_T *buf = NULL;
+ dict_T *d = NULL;
+ int i;
+
+ if (argvars != NULL)
+ {
+ if (in_vim9script()
+ && (check_for_string_or_number_or_list_arg(argvars, 0) == FAIL
+ || check_for_dict_arg(argvars, 1) == FAIL))
+ return NULL;
+
+ // Check that arguments look OK.
+ if (argvars[0].v_type == VAR_NUMBER)
+ {
+ buf = buflist_findnr(argvars[0].vval.v_number);
+ if (buf == NULL)
+ {
+ semsg(_(e_buffer_nr_does_not_exist), argvars[0].vval.v_number);
+ return NULL;
+ }
+#ifdef FEAT_TERMINAL
+ if (buf->b_term != NULL && popup_terminal_exists())
+ {
+ emsg(_(e_cannot_open_second_popup_with_terminal));
+ return NULL;
+ }
+#endif
+ }
+ else if (!(argvars[0].v_type == VAR_STRING
+ && argvars[0].vval.v_string != NULL)
+ && !(argvars[0].v_type == VAR_LIST
+ && argvars[0].vval.v_list != NULL))
+ {
+ emsg(_(e_buffer_number_text_or_list_required));
+ return NULL;
+ }
+ if (check_for_nonnull_dict_arg(argvars, 1) == FAIL)
+ return NULL;
+ d = argvars[1].vval.v_dict;
+ }
+
+ if (d != NULL)
+ {
+ if (dict_has_key(d, "tabpage"))
+ tabnr = (int)dict_get_number(d, "tabpage");
+ else if (popup_is_notification(type))
+ tabnr = -1; // notifications are global by default
+ else
+ tabnr = 0;
+ if (tabnr > 0)
+ {
+ tp = find_tabpage(tabnr);
+ if (tp == NULL)
+ {
+ semsg(_(e_tabpage_not_found_nr), tabnr);
+ return NULL;
+ }
+ }
+ }
+ else if (popup_is_notification(type))
+ tabnr = -1; // show on all tabs
+
+ // Create the window and buffer.
+ wp = win_alloc_popup_win();
+ if (wp == NULL)
+ return NULL;
+ if (rettv != NULL)
+ rettv->vval.v_number = wp->w_id;
+ wp->w_popup_pos = POPPOS_TOPLEFT;
+ wp->w_popup_flags = POPF_IS_POPUP | POPF_MAPPING | POPF_POSINVERT;
+
+ if (buf != NULL)
+ {
+ // use existing buffer
+ new_buffer = FALSE;
+ win_init_popup_win(wp, buf);
+ set_local_options_default(wp, FALSE);
+ swap_exists_action = SEA_READONLY;
+ buffer_ensure_loaded(buf);
+ swap_exists_action = SEA_NONE;
+ }
+ else
+ {
+ // create a new buffer associated with the popup
+ new_buffer = TRUE;
+ buf = buflist_new(NULL, NULL, (linenr_T)0, BLN_NEW|BLN_DUMMY|BLN_REUSE);
+ if (buf == NULL)
+ {
+ win_free_popup(wp);
+ return NULL;
+ }
+ ml_open(buf);
+
+ win_init_popup_win(wp, buf);
+
+ set_local_options_default(wp, TRUE);
+ set_string_option_direct_in_buf(buf, (char_u *)"buftype", -1,
+ (char_u *)"popup", OPT_FREE|OPT_LOCAL, 0);
+ set_string_option_direct_in_buf(buf, (char_u *)"bufhidden", -1,
+ (char_u *)"wipe", OPT_FREE|OPT_LOCAL, 0);
+ buf->b_p_ul = -1; // no undo
+ buf->b_p_swf = FALSE; // no swap file
+ buf->b_p_bl = FALSE; // unlisted buffer
+ buf->b_locked = TRUE; // prevent deleting the buffer
+
+ // Avoid that 'buftype' is reset when this buffer is entered.
+ buf->b_p_initialized = TRUE;
+ }
+ wp->w_p_wrap = TRUE; // 'wrap' is default on
+ wp->w_p_so = 0; // 'scrolloff' zero
+
+ if (tp != NULL)
+ {
+ // popup on specified tab page
+ wp->w_next = tp->tp_first_popupwin;
+ tp->tp_first_popupwin = wp;
+ }
+ else if (tabnr == 0)
+ {
+ // popup on current tab page
+ wp->w_next = curtab->tp_first_popupwin;
+ curtab->tp_first_popupwin = wp;
+ }
+ else // (tabnr < 0)
+ {
+ win_T *prev = first_popupwin;
+
+ // Global popup: add at the end, so that it gets displayed on top of
+ // older ones with the same zindex. Matters for notifications.
+ if (first_popupwin == NULL)
+ first_popupwin = wp;
+ else
+ {
+ while (prev->w_next != NULL)
+ prev = prev->w_next;
+ prev->w_next = wp;
+ }
+ }
+
+ if (new_buffer && argvars != NULL)
+ popup_set_buffer_text(buf, argvars[0]);
+
+ if (type == TYPE_ATCURSOR || type == TYPE_PREVIEW)
+ {
+ wp->w_popup_pos = POPPOS_BOTLEFT;
+ }
+ if (type == TYPE_ATCURSOR)
+ {
+ popup_set_wantpos_cursor(wp, 0, d);
+ set_moved_values(wp);
+ set_moved_columns(wp, FIND_STRING);
+ }
+
+ if (type == TYPE_BEVAL)
+ {
+ wp->w_popup_pos = POPPOS_BOTLEFT;
+
+ // by default use the mouse position
+ wp->w_wantline = mouse_row;
+ if (wp->w_wantline <= 0) // mouse on first line
+ {
+ wp->w_wantline = 2;
+ wp->w_popup_pos = POPPOS_TOPLEFT;
+ }
+ wp->w_wantcol = mouse_col + 1;
+ set_mousemoved_values(wp);
+ set_mousemoved_columns(wp, FIND_IDENT + FIND_STRING + FIND_EVAL);
+ }
+
+ // set default values
+ wp->w_zindex = POPUPWIN_DEFAULT_ZINDEX;
+ wp->w_popup_close = POPCLOSE_NONE;
+
+ if (popup_is_notification(type))
+ {
+ win_T *twp, *nextwin;
+ int height = buf->b_ml.ml_line_count + 3;
+
+ // Try to not overlap with another global popup. Guess we need 3
+ // more screen lines than buffer lines.
+ wp->w_wantline = 1;
+ for (twp = first_popupwin; twp != NULL; twp = nextwin)
+ {
+ nextwin = twp->w_next;
+ if (twp != wp
+ && twp->w_zindex == POPUPWIN_NOTIFICATION_ZINDEX
+ && twp->w_winrow <= wp->w_wantline - 1 + height
+ && twp->w_winrow + popup_height(twp) > wp->w_wantline - 1)
+ {
+ // move to below this popup and restart the loop to check for
+ // overlap with other popups
+ wp->w_wantline = twp->w_winrow + popup_height(twp) + 1;
+ nextwin = first_popupwin;
+ }
+ }
+ if (wp->w_wantline + height > Rows)
+ {
+ // can't avoid overlap, put on top in the hope that message goes
+ // away soon.
+ wp->w_wantline = 1;
+ }
+
+ wp->w_wantcol = 10;
+ wp->w_zindex = POPUPWIN_NOTIFICATION_ZINDEX;
+ wp->w_minwidth = 20;
+ wp->w_popup_flags |= POPF_DRAG;
+ wp->w_popup_close = POPCLOSE_CLICK;
+ for (i = 0; i < 4; ++i)
+ wp->w_popup_border[i] = 1;
+ wp->w_popup_padding[1] = 1;
+ wp->w_popup_padding[3] = 1;
+
+ popup_update_color(wp, type);
+ }
+
+ if (type == TYPE_DIALOG || type == TYPE_MENU)
+ {
+ wp->w_popup_pos = POPPOS_CENTER;
+ wp->w_zindex = POPUPWIN_DIALOG_ZINDEX;
+ wp->w_popup_flags |= POPF_DRAG;
+ wp->w_popup_flags &= ~POPF_MAPPING;
+ add_border_left_right_padding(wp);
+ }
+
+ if (type == TYPE_MENU)
+ {
+ typval_T tv;
+ callback_T callback;
+
+ tv.v_type = VAR_STRING;
+ tv.vval.v_string = (char_u *)"popup_filter_menu";
+ callback = get_callback(&tv);
+ if (callback.cb_name != NULL)
+ {
+ set_callback(&wp->w_filter_cb, &callback);
+ if (callback.cb_free_name)
+ vim_free(callback.cb_name);
+ }
+
+ wp->w_p_wrap = 0;
+ wp->w_popup_flags |= POPF_CURSORLINE;
+ }
+
+ if (type == TYPE_PREVIEW)
+ {
+ wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
+ wp->w_popup_close = POPCLOSE_BUTTON;
+ for (i = 0; i < 4; ++i)
+ wp->w_popup_border[i] = 1;
+ parse_previewpopup(wp);
+ popup_set_wantpos_cursor(wp, wp->w_minwidth, d);
+ }
+# ifdef FEAT_QUICKFIX
+ if (type == TYPE_INFO)
+ {
+ wp->w_popup_pos = POPPOS_TOPLEFT;
+ wp->w_popup_flags |= POPF_DRAG | POPF_RESIZE;
+ wp->w_popup_close = POPCLOSE_BUTTON;
+ add_border_left_right_padding(wp);
+ parse_completepopup(wp);
+ }
+# endif
+
+ for (i = 0; i < 4; ++i)
+ VIM_CLEAR(wp->w_border_highlight[i]);
+ for (i = 0; i < 8; ++i)
+ wp->w_border_char[i] = 0;
+ wp->w_want_scrollbar = 1;
+ wp->w_popup_fixed = 0;
+ wp->w_filter_mode = MODE_ALL;
+
+ if (d != NULL)
+ {
+ // Deal with options.
+ if (apply_options(wp, d, TRUE) == FAIL)
+ {
+ (void)popup_close(wp->w_id, FALSE);
+ return NULL;
+ }
+ }
+
+#ifdef FEAT_TIMERS
+ if (popup_is_notification(type) && wp->w_popup_timer == NULL)
+ popup_add_timeout(wp, 3000, type == TYPE_NOTIFICATION);
+#endif
+
+ popup_adjust_position(wp);
+
+ wp->w_vsep_width = 0;
+
+ redraw_all_later(UPD_NOT_VALID);
+ popup_mask_refresh = TRUE;
+
+#ifdef FEAT_TERMINAL
+ // When running a terminal in the popup it becomes the current window.
+ if (buf->b_term != NULL)
+ win_enter(wp, FALSE);
+#endif
+
+ return wp;
+}
+
+/*
+ * popup_clear()
+ */
+ void
+f_popup_clear(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ int force = FALSE;
+
+ if (in_vim9script() && check_for_opt_bool_arg(argvars, 0) == FAIL)
+ return;
+
+ if (argvars[0].v_type != VAR_UNKNOWN)
+ force = (int)tv_get_bool(&argvars[0]);
+ close_all_popups(force);
+}
+
+/*
+ * popup_create({text}, {options})
+ */
+ void
+f_popup_create(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_NORMAL);
+}
+
+/*
+ * popup_atcursor({text}, {options})
+ */
+ void
+f_popup_atcursor(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_ATCURSOR);
+}
+
+/*
+ * popup_beval({text}, {options})
+ */
+ void
+f_popup_beval(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_BEVAL);
+}
+
+/*
+ * Invoke the close callback for window "wp" with value "result".
+ * Careful: The callback may make "wp" invalid!
+ */
+ static void
+invoke_popup_callback(win_T *wp, typval_T *result)
+{
+ typval_T rettv;
+ typval_T argv[3];
+
+ rettv.v_type = VAR_UNKNOWN;
+
+ argv[0].v_type = VAR_NUMBER;
+ argv[0].vval.v_number = (varnumber_T)wp->w_id;
+
+ if (result != NULL && result->v_type != VAR_UNKNOWN)
+ copy_tv(result, &argv[1]);
+ else
+ {
+ argv[1].v_type = VAR_NUMBER;
+ argv[1].vval.v_number = 0;
+ }
+
+ argv[2].v_type = VAR_UNKNOWN;
+
+ call_callback(&wp->w_close_cb, -1, &rettv, 2, argv);
+ if (result != NULL)
+ clear_tv(&argv[1]);
+ clear_tv(&rettv);
+}
+
+/*
+ * Make "prevwin" the current window, unless it's equal to "wp".
+ * Otherwise make "firstwin" the current window.
+ */
+ static void
+back_to_prevwin(win_T *wp)
+{
+ if (win_valid(prevwin) && wp != prevwin)
+ win_enter(prevwin, FALSE);
+ else
+ win_enter(firstwin, FALSE);
+}
+
+/*
+ * Close popup "wp" and invoke any close callback for it.
+ */
+ static void
+popup_close_and_callback(win_T *wp, typval_T *arg)
+{
+ int id = wp->w_id;
+
+#ifdef FEAT_TERMINAL
+ if (wp == curwin && curbuf->b_term != NULL)
+ {
+ win_T *owp;
+
+ // Closing popup window with a terminal: put focus back on the first
+ // that works:
+ // - another popup window with a terminal
+ // - the previous window
+ // - the first one.
+ FOR_ALL_POPUPWINS(owp)
+ if (owp != curwin && owp->w_buffer->b_term != NULL)
+ break;
+ if (owp != NULL)
+ win_enter(owp, FALSE);
+ else
+ {
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, owp)
+ if (owp != curwin && owp->w_buffer->b_term != NULL)
+ break;
+ if (owp != NULL)
+ win_enter(owp, FALSE);
+ else
+ back_to_prevwin(wp);
+ }
+ }
+#endif
+
+ // Just in case a check higher up is missing.
+ if (wp == curwin && ERROR_IF_POPUP_WINDOW)
+ {
+ // To avoid getting stuck when win_execute() does something that causes
+ // an error, stop calling the filter callback.
+ free_callback(&wp->w_filter_cb);
+
+ return;
+ }
+
+ CHECK_CURBUF;
+ if (wp->w_close_cb.cb_name != NULL)
+ // Careful: This may make "wp" invalid.
+ invoke_popup_callback(wp, arg);
+
+ popup_close(id, FALSE);
+ CHECK_CURBUF;
+}
+
+ void
+popup_close_with_retval(win_T *wp, int retval)
+{
+ typval_T res;
+
+ res.v_type = VAR_NUMBER;
+ res.vval.v_number = retval;
+ popup_close_and_callback(wp, &res);
+}
+
+/*
+ * Close popup "wp" because of a mouse click.
+ */
+ void
+popup_close_for_mouse_click(win_T *wp)
+{
+ popup_close_with_retval(wp, -2);
+}
+
+ static void
+check_mouse_moved(win_T *wp, win_T *mouse_wp)
+{
+ // Close the popup when all if these are true:
+ // - the mouse is not on this popup
+ // - "mousemoved" was used
+ // - the mouse is no longer on the same screen row or the mouse column is
+ // outside of the relevant text
+ if (wp != mouse_wp
+ && wp->w_popup_mouse_row != 0
+ && (wp->w_popup_mouse_row != mouse_row
+ || mouse_col < wp->w_popup_mouse_mincol
+ || mouse_col > wp->w_popup_mouse_maxcol))
+ {
+ // Careful: this makes "wp" invalid.
+ popup_close_with_retval(wp, -2);
+ }
+}
+
+/*
+ * Called when the mouse moved: may close a popup with "mousemoved".
+ */
+ void
+popup_handle_mouse_moved(void)
+{
+ win_T *wp, *nextwp;
+ win_T *mouse_wp;
+ int row = mouse_row;
+ int col = mouse_col;
+
+ // find the window where the mouse is in
+ mouse_wp = mouse_find_win(&row, &col, FIND_POPUP);
+
+ for (wp = first_popupwin; wp != NULL; wp = nextwp)
+ {
+ nextwp = wp->w_next;
+ check_mouse_moved(wp, mouse_wp);
+ }
+ for (wp = curtab->tp_first_popupwin; wp != NULL; wp = nextwp)
+ {
+ nextwp = wp->w_next;
+ check_mouse_moved(wp, mouse_wp);
+ }
+}
+
+/*
+ * In a filter: check if the typed key is a mouse event that is used for
+ * dragging the popup.
+ */
+ static void
+filter_handle_drag(win_T *wp, int c, typval_T *rettv)
+{
+ int row = mouse_row;
+ int col = mouse_col;
+
+ if ((wp->w_popup_flags & (POPF_DRAG | POPF_DRAGALL))
+ && is_mouse_key(c)
+ && (wp == popup_dragwin
+ || wp == mouse_find_win(&row, &col, FIND_POPUP)))
+ // do not consume the key, allow for dragging the popup
+ rettv->vval.v_number = 0;
+}
+
+/*
+ * popup_filter_menu({id}, {key})
+ */
+ void
+f_popup_filter_menu(typval_T *argvars, typval_T *rettv)
+{
+ int id;
+ win_T *wp;
+ char_u *key;
+ typval_T res;
+ int c;
+ linenr_T old_lnum;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_string_arg(argvars, 1) == FAIL))
+ return;
+
+ id = tv_get_number(&argvars[0]);
+ wp = win_id2wp(id);
+ key = tv_get_string(&argvars[1]);
+ // If the popup has been closed do not consume the key.
+ if (wp == NULL)
+ return;
+
+ c = *key;
+ if (c == K_SPECIAL && key[1] != NUL)
+ c = TO_SPECIAL(key[1], key[2]);
+
+ // consume all keys until done
+ rettv->v_type = VAR_BOOL;
+ rettv->vval.v_number = VVAL_TRUE;
+ res.v_type = VAR_NUMBER;
+
+ old_lnum = wp->w_cursor.lnum;
+ if (c == 'k' || c == 'K' || c == K_UP || c == Ctrl_P)
+ {
+ if (wp->w_cursor.lnum > 1)
+ --wp->w_cursor.lnum;
+ else
+ wp->w_cursor.lnum = wp->w_buffer->b_ml.ml_line_count;
+ }
+ if (c == 'j' || c == 'J' || c == K_DOWN || c == Ctrl_N)
+ {
+ if (wp->w_cursor.lnum < wp->w_buffer->b_ml.ml_line_count)
+ ++wp->w_cursor.lnum;
+ else
+ wp->w_cursor.lnum = 1;
+ }
+ if (old_lnum != wp->w_cursor.lnum)
+ {
+ // caller will call popup_highlight_curline()
+ return;
+ }
+
+ if (c == 'x' || c == 'X' || c == ESC || c == Ctrl_C)
+ {
+ // Cancelled, invoke callback with -1
+ res.vval.v_number = -1;
+ popup_close_and_callback(wp, &res);
+ return;
+ }
+ if (c == ' ' || c == K_KENTER || c == CAR || c == NL)
+ {
+ // Invoke callback with current index.
+ res.vval.v_number = wp->w_cursor.lnum;
+ popup_close_and_callback(wp, &res);
+ return;
+ }
+
+ filter_handle_drag(wp, c, rettv);
+}
+
+/*
+ * popup_filter_yesno({id}, {key})
+ */
+ void
+f_popup_filter_yesno(typval_T *argvars, typval_T *rettv)
+{
+ int id;
+ win_T *wp;
+ char_u *key;
+ typval_T res;
+ int c;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_string_arg(argvars, 1) == FAIL))
+ return;
+
+ id = tv_get_number(&argvars[0]);
+ wp = win_id2wp(id);
+ key = tv_get_string(&argvars[1]);
+ // If the popup has been closed don't consume the key.
+ if (wp == NULL)
+ return;
+
+ c = *key;
+ if (c == K_SPECIAL && key[1] != NUL)
+ c = TO_SPECIAL(key[1], key[2]);
+
+ // consume all keys until done
+ rettv->v_type = VAR_BOOL;
+ rettv->vval.v_number = VVAL_TRUE;
+
+ if (c == 'y' || c == 'Y')
+ res.vval.v_number = 1;
+ else if (c == 'n' || c == 'N' || c == 'x' || c == 'X' || c == ESC)
+ res.vval.v_number = 0;
+ else
+ {
+ filter_handle_drag(wp, c, rettv);
+ return;
+ }
+
+ // Invoke callback
+ res.v_type = VAR_NUMBER;
+ popup_close_and_callback(wp, &res);
+}
+
+/*
+ * popup_dialog({text}, {options})
+ */
+ void
+f_popup_dialog(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_DIALOG);
+}
+
+/*
+ * popup_menu({text}, {options})
+ */
+ void
+f_popup_menu(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_MENU);
+}
+
+/*
+ * popup_notification({text}, {options})
+ */
+ void
+f_popup_notification(typval_T *argvars, typval_T *rettv)
+{
+ popup_create(argvars, rettv, TYPE_NOTIFICATION);
+}
+
+/*
+ * Find the popup window with window-ID "id".
+ * If the popup window does not exist NULL is returned.
+ * If the window is not a popup window, and error message is given.
+ */
+ static win_T *
+find_popup_win(int id)
+{
+ win_T *wp = win_id2wp(id);
+
+ if (wp != NULL && !WIN_IS_POPUP(wp))
+ {
+ semsg(_(e_window_nr_is_not_popup_window), id);
+ return NULL;
+ }
+ return wp;
+}
+
+/*
+ * popup_close({id})
+ */
+ void
+f_popup_close(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ int id;
+ win_T *wp;
+
+ if (in_vim9script() && check_for_number_arg(argvars, 0) == FAIL)
+ return;
+
+ id = (int)tv_get_number(argvars);
+ if (
+# ifdef FEAT_TERMINAL
+ // if the popup contains a terminal it will become hidden
+ curbuf->b_term == NULL &&
+# endif
+ ERROR_IF_ANY_POPUP_WINDOW)
+ return;
+
+ wp = find_popup_win(id);
+ if (wp != NULL)
+ popup_close_and_callback(wp, &argvars[1]);
+}
+
+ void
+popup_hide(win_T *wp)
+{
+#ifdef FEAT_TERMINAL
+ if (error_if_term_popup_window())
+ return;
+#endif
+ if ((wp->w_popup_flags & POPF_HIDDEN) != 0)
+ return;
+
+ wp->w_popup_flags |= POPF_HIDDEN;
+ // Do not decrement b_nwindows, we still reference the buffer.
+ redraw_all_later(UPD_NOT_VALID);
+ popup_mask_refresh = TRUE;
+}
+
+/*
+ * popup_hide({id})
+ */
+ void
+f_popup_hide(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ int id;
+ win_T *wp;
+
+ if (in_vim9script() && check_for_number_arg(argvars, 0) == FAIL)
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return;
+
+ popup_hide(wp);
+ wp->w_popup_flags |= POPF_HIDDEN_FORCE;
+}
+
+ void
+popup_show(win_T *wp)
+{
+ if ((wp->w_popup_flags & POPF_HIDDEN) == 0)
+ return;
+
+ wp->w_popup_flags &= ~POPF_HIDDEN;
+ redraw_all_later(UPD_NOT_VALID);
+ popup_mask_refresh = TRUE;
+}
+
+/*
+ * popup_show({id})
+ */
+ void
+f_popup_show(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ int id;
+ win_T *wp;
+
+ if (in_vim9script() && check_for_number_arg(argvars, 0) == FAIL)
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return;
+
+ wp->w_popup_flags &= ~POPF_HIDDEN_FORCE;
+ popup_show(wp);
+#ifdef FEAT_QUICKFIX
+ if (wp->w_popup_flags & POPF_INFO)
+ pum_position_info_popup(wp);
+#endif
+}
+
+/*
+ * popup_settext({id}, {text})
+ */
+ void
+f_popup_settext(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ int id;
+ win_T *wp;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_string_or_list_arg(argvars, 1) == FAIL))
+ return;
+
+ id = (int)tv_get_number(&argvars[0]);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return;
+
+ if (check_for_string_or_list_arg(argvars, 1) == FAIL)
+ return;
+
+ popup_set_buffer_text(wp->w_buffer, argvars[1]);
+ redraw_win_later(wp, UPD_NOT_VALID);
+ popup_adjust_position(wp);
+}
+
+ static void
+popup_free(win_T *wp)
+{
+ sign_undefine_by_name(popup_get_sign_name(wp), FALSE);
+ wp->w_buffer->b_locked = FALSE;
+ if (wp->w_winrow + popup_height(wp) >= cmdline_row)
+ clear_cmdline = TRUE;
+ win_free_popup(wp);
+
+#ifdef HAS_MESSAGE_WINDOW
+ if (wp == message_win)
+ message_win = NULL;
+#endif
+
+ redraw_all_later(UPD_NOT_VALID);
+ popup_mask_refresh = TRUE;
+}
+
+ static void
+error_for_popup_window(void)
+{
+ emsg(_(e_not_allowed_in_popup_window));
+}
+
+ int
+error_if_popup_window(int also_with_term UNUSED)
+{
+ // win_execute() may set "curwin" to a popup window temporarily, but many
+ // commands are disallowed then. When a terminal runs in the popup most
+ // things are allowed. When a terminal is finished it can be closed.
+ if (WIN_IS_POPUP(curwin)
+# ifdef FEAT_TERMINAL
+ && (also_with_term || curbuf->b_term == NULL)
+# endif
+ )
+ {
+ error_for_popup_window();
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/*
+ * Close a popup window by Window-id.
+ * Does not invoke the callback.
+ * Return OK if the popup was closed, FAIL otherwise.
+ */
+ int
+popup_close(int id, int force)
+{
+ win_T *wp;
+ tabpage_T *tp;
+ win_T *prev = NULL;
+
+ // go through global popups
+ for (wp = first_popupwin; wp != NULL; prev = wp, wp = wp->w_next)
+ if (wp->w_id == id)
+ {
+ if (wp == curwin)
+ {
+ if (!force)
+ {
+ error_for_popup_window();
+ return FAIL;
+ }
+ back_to_prevwin(wp);
+ }
+ if (prev == NULL)
+ first_popupwin = wp->w_next;
+ else
+ prev->w_next = wp->w_next;
+ popup_free(wp);
+ return OK;
+ }
+
+ // go through tab-local popups
+ FOR_ALL_TABPAGES(tp)
+ if (popup_close_tabpage(tp, id, force) == OK)
+ return OK;
+ return FAIL;
+}
+
+/*
+ * Close a popup window with Window-id "id" in tabpage "tp".
+ */
+ int
+popup_close_tabpage(tabpage_T *tp, int id, int force)
+{
+ win_T *wp;
+ win_T **root = &tp->tp_first_popupwin;
+ win_T *prev = NULL;
+
+ for (wp = *root; wp != NULL; prev = wp, wp = wp->w_next)
+ if (wp->w_id == id)
+ {
+ if (wp == curwin)
+ {
+ if (!force)
+ {
+ error_for_popup_window();
+ return FAIL;
+ }
+ back_to_prevwin(wp);
+ }
+ if (prev == NULL)
+ *root = wp->w_next;
+ else
+ prev->w_next = wp->w_next;
+ popup_free(wp);
+ return OK;
+ }
+ return FAIL;
+}
+
+ void
+close_all_popups(int force)
+{
+ if (!force && ERROR_IF_ANY_POPUP_WINDOW)
+ return;
+ while (first_popupwin != NULL)
+ if (popup_close(first_popupwin->w_id, force) == FAIL)
+ return;
+ while (curtab->tp_first_popupwin != NULL)
+ if (popup_close(curtab->tp_first_popupwin->w_id, force) == FAIL)
+ return;
+}
+
+/*
+ * popup_move({id}, {options})
+ */
+ void
+f_popup_move(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ dict_T *dict;
+ int id;
+ win_T *wp;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_dict_arg(argvars, 1) == FAIL))
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return; // invalid {id}
+
+ if (check_for_nonnull_dict_arg(argvars, 1) == FAIL)
+ return;
+ dict = argvars[1].vval.v_dict;
+
+ apply_move_options(wp, dict);
+
+ if (wp->w_winrow + wp->w_height >= cmdline_row)
+ clear_cmdline = TRUE;
+ popup_adjust_position(wp);
+}
+
+/*
+ * popup_setoptions({id}, {options})
+ */
+ void
+f_popup_setoptions(typval_T *argvars, typval_T *rettv UNUSED)
+{
+ dict_T *dict;
+ int id;
+ win_T *wp;
+ linenr_T old_firstline;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_dict_arg(argvars, 1) == FAIL))
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return; // invalid {id}
+
+ if (check_for_nonnull_dict_arg(argvars, 1) == FAIL)
+ return;
+ dict = argvars[1].vval.v_dict;
+ old_firstline = wp->w_firstline;
+
+ (void)apply_options(wp, dict, FALSE);
+
+ if (old_firstline != wp->w_firstline)
+ redraw_win_later(wp, UPD_NOT_VALID);
+ popup_adjust_position(wp);
+}
+
+/*
+ * popup_getpos({id})
+ */
+ void
+f_popup_getpos(typval_T *argvars, typval_T *rettv)
+{
+ dict_T *dict;
+ int id;
+ win_T *wp;
+ int top_extra;
+ int left_extra;
+
+ if (rettv_dict_alloc(rettv) == FAIL)
+ return;
+
+ if (in_vim9script() && check_for_number_arg(argvars, 0) == FAIL)
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return; // invalid {id}
+ top_extra = popup_top_extra(wp);
+ left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
+
+ // we know how much space we need, avoid resizing halfway
+ dict = rettv->vval.v_dict;
+ hash_lock_size(&dict->dv_hashtab, 11);
+
+ dict_add_number(dict, "line", wp->w_winrow + 1);
+ dict_add_number(dict, "col", wp->w_wincol + 1);
+ dict_add_number(dict, "width", wp->w_width + left_extra
+ + wp->w_popup_border[1] + wp->w_popup_padding[1]);
+ dict_add_number(dict, "height", wp->w_height + top_extra
+ + wp->w_popup_border[2] + wp->w_popup_padding[2]);
+
+ dict_add_number(dict, "core_line", wp->w_winrow + 1 + top_extra);
+ dict_add_number(dict, "core_col", wp->w_wincol + 1 + left_extra);
+ dict_add_number(dict, "core_width", wp->w_width);
+ dict_add_number(dict, "core_height", wp->w_height);
+
+ dict_add_number(dict, "scrollbar", wp->w_has_scrollbar);
+ dict_add_number(dict, "firstline", wp->w_topline);
+ dict_add_number(dict, "lastline", wp->w_botline - 1);
+ dict_add_number(dict, "visible",
+ win_valid(wp) && (wp->w_popup_flags & POPF_HIDDEN) == 0);
+
+ hash_unlock(&dict->dv_hashtab);
+}
+
+/*
+ * popup_list()
+ */
+ void
+f_popup_list(typval_T *argvars UNUSED, typval_T *rettv)
+{
+ win_T *wp;
+ tabpage_T *tp;
+
+ if (rettv_list_alloc(rettv) == FAIL)
+ return;
+ FOR_ALL_POPUPWINS(wp)
+ list_append_number(rettv->vval.v_list, wp->w_id);
+ FOR_ALL_TABPAGES(tp)
+ FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
+ list_append_number(rettv->vval.v_list, wp->w_id);
+}
+
+/*
+ * popup_locate({row}, {col})
+ */
+ void
+f_popup_locate(typval_T *argvars, typval_T *rettv)
+{
+ int row;
+ int col;
+ win_T *wp;
+
+ if (in_vim9script()
+ && (check_for_number_arg(argvars, 0) == FAIL
+ || check_for_number_arg(argvars, 1) == FAIL))
+ return;
+
+ row = tv_get_number(&argvars[0]) - 1;
+ col = tv_get_number(&argvars[1]) - 1;
+ wp = mouse_find_win(&row, &col, FIND_POPUP);
+ if (wp != NULL && WIN_IS_POPUP(wp))
+ rettv->vval.v_number = wp->w_id;
+}
+
+/*
+ * For popup_getoptions(): add a "border" or "padding" entry to "dict".
+ */
+ static void
+get_padding_border(dict_T *dict, int *array, char *name)
+{
+ list_T *list;
+ int i;
+
+ if (array[0] == 0 && array[1] == 0 && array[2] == 0 && array[3] == 0)
+ return;
+
+ list = list_alloc();
+ if (list == NULL)
+ return;
+
+ dict_add_list(dict, name, list);
+ if (array[0] != 1 || array[1] != 1 || array[2] != 1 || array[3] != 1)
+ for (i = 0; i < 4; ++i)
+ list_append_number(list, array[i]);
+}
+
+/*
+ * For popup_getoptions(): add a "borderhighlight" entry to "dict".
+ */
+ static void
+get_borderhighlight(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+ int i;
+
+ for (i = 0; i < 4; ++i)
+ if (wp->w_border_highlight[i] != NULL)
+ break;
+ if (i == 4)
+ return;
+
+ list = list_alloc();
+ if (list == NULL)
+ return;
+
+ dict_add_list(dict, "borderhighlight", list);
+ for (i = 0; i < 4; ++i)
+ list_append_string(list, wp->w_border_highlight[i], -1);
+}
+
+/*
+ * For popup_getoptions(): add a "borderchars" entry to "dict".
+ */
+ static void
+get_borderchars(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+ int i;
+ char_u buf[NUMBUFLEN];
+ int len;
+
+ for (i = 0; i < 8; ++i)
+ if (wp->w_border_char[i] != 0)
+ break;
+ if (i == 8)
+ return;
+
+ list = list_alloc();
+ if (list == NULL)
+ return;
+
+ dict_add_list(dict, "borderchars", list);
+ for (i = 0; i < 8; ++i)
+ {
+ len = mb_char2bytes(wp->w_border_char[i], buf);
+ list_append_string(list, buf, len);
+ }
+}
+
+/*
+ * For popup_getoptions(): add a "moved" and "mousemoved" entry to "dict".
+ */
+ static void
+get_moved_list(dict_T *dict, win_T *wp)
+{
+ list_T *list;
+
+ list = list_alloc();
+ if (list != NULL)
+ {
+ dict_add_list(dict, "moved", list);
+ list_append_number(list, wp->w_popup_lnum);
+ list_append_number(list, wp->w_popup_mincol);
+ list_append_number(list, wp->w_popup_maxcol);
+ }
+ list = list_alloc();
+ if (list == NULL)
+ return;
+
+ dict_add_list(dict, "mousemoved", list);
+ list_append_number(list, wp->w_popup_mouse_row);
+ list_append_number(list, wp->w_popup_mouse_mincol);
+ list_append_number(list, wp->w_popup_mouse_maxcol);
+}
+
+/*
+ * popup_getoptions({id})
+ */
+ void
+f_popup_getoptions(typval_T *argvars, typval_T *rettv)
+{
+ dict_T *dict;
+ int id;
+ win_T *wp;
+ tabpage_T *tp;
+ int i;
+
+ if (rettv_dict_alloc(rettv) == FAIL)
+ return;
+
+ if (in_vim9script() && check_for_number_arg(argvars, 0) == FAIL)
+ return;
+
+ id = (int)tv_get_number(argvars);
+ wp = find_popup_win(id);
+ if (wp == NULL)
+ return;
+
+ dict = rettv->vval.v_dict;
+ dict_add_number(dict, "line", wp->w_wantline);
+ dict_add_number(dict, "col", wp->w_wantcol);
+ dict_add_number(dict, "minwidth", wp->w_minwidth);
+ dict_add_number(dict, "minheight", wp->w_minheight);
+ dict_add_number(dict, "maxheight", wp->w_maxheight);
+ dict_add_number(dict, "maxwidth", wp->w_maxwidth);
+ dict_add_number(dict, "firstline", wp->w_firstline);
+ dict_add_number(dict, "scrollbar", wp->w_want_scrollbar);
+ dict_add_number(dict, "zindex", wp->w_zindex);
+ dict_add_number(dict, "fixed", wp->w_popup_fixed);
+ if (wp->w_popup_prop_type && win_valid_any_tab(wp->w_popup_prop_win))
+ {
+ proptype_T *pt = text_prop_type_by_id(
+ wp->w_popup_prop_win->w_buffer,
+ wp->w_popup_prop_type);
+
+ if (pt != NULL)
+ dict_add_string(dict, "textprop", pt->pt_name);
+ dict_add_number(dict, "textpropwin", wp->w_popup_prop_win->w_id);
+ dict_add_number(dict, "textpropid", wp->w_popup_prop_id);
+ }
+ dict_add_string(dict, "title", wp->w_popup_title);
+ dict_add_number(dict, "wrap", wp->w_p_wrap);
+ dict_add_number(dict, "drag", (wp->w_popup_flags & POPF_DRAG) != 0);
+ dict_add_number(dict, "dragall",
+ (wp->w_popup_flags & POPF_DRAGALL) != 0);
+ dict_add_number(dict, "mapping",
+ (wp->w_popup_flags & POPF_MAPPING) != 0);
+ dict_add_number(dict, "resize", (wp->w_popup_flags & POPF_RESIZE) != 0);
+ dict_add_number(dict, "posinvert",
+ (wp->w_popup_flags & POPF_POSINVERT) != 0);
+ dict_add_number(dict, "cursorline",
+ (wp->w_popup_flags & POPF_CURSORLINE) != 0);
+ dict_add_string(dict, "highlight", wp->w_p_wcr);
+ if (wp->w_scrollbar_highlight != NULL)
+ dict_add_string(dict, "scrollbarhighlight",
+ wp->w_scrollbar_highlight);
+ if (wp->w_thumb_highlight != NULL)
+ dict_add_string(dict, "thumbhighlight", wp->w_thumb_highlight);
+
+ // find the tabpage that holds this popup
+ i = 1;
+ FOR_ALL_TABPAGES(tp)
+ {
+ win_T *twp;
+
+ FOR_ALL_POPUPWINS_IN_TAB(tp, twp)
+ if (twp->w_id == id)
+ break;
+ if (twp != NULL)
+ break;
+ ++i;
+ }
+ if (tp == NULL)
+ i = -1; // must be global
+ else if (tp == curtab)
+ i = 0;
+ dict_add_number(dict, "tabpage", i);
+
+ get_padding_border(dict, wp->w_popup_padding, "padding");
+ get_padding_border(dict, wp->w_popup_border, "border");
+ get_borderhighlight(dict, wp);
+ get_borderchars(dict, wp);
+ get_moved_list(dict, wp);
+
+ if (wp->w_filter_cb.cb_name != NULL)
+ dict_add_callback(dict, "filter", &wp->w_filter_cb);
+ if (wp->w_close_cb.cb_name != NULL)
+ dict_add_callback(dict, "callback", &wp->w_close_cb);
+
+ for (i = 0; i < (int)ARRAY_LENGTH(poppos_entries); ++i)
+ if (wp->w_popup_pos == poppos_entries[i].pp_val)
+ {
+ dict_add_string(dict, "pos",
+ (char_u *)poppos_entries[i].pp_name);
+ break;
+ }
+
+ dict_add_string(dict, "close", (char_u *)(
+ wp->w_popup_close == POPCLOSE_BUTTON ? "button"
+ : wp->w_popup_close == POPCLOSE_CLICK ? "click" : "none"));
+
+# if defined(FEAT_TIMERS)
+ dict_add_number(dict, "time", wp->w_popup_timer != NULL
+ ? (long)wp->w_popup_timer->tr_interval : 0L);
+# endif
+}
+
+# if defined(FEAT_TERMINAL) || defined(PROTO)
+/*
+ * Return TRUE if the current window is running a terminal in a popup window.
+ * Return FALSE when the job has ended.
+ */
+ int
+error_if_term_popup_window(void)
+{
+ if (WIN_IS_POPUP(curwin) && curbuf->b_term != NULL
+ && term_job_running(curbuf->b_term))
+ {
+ emsg(_(e_not_allowed_for_terminal_in_popup_window));
+ return TRUE;
+ }
+ return FALSE;
+}
+# endif
+
+/*
+ * Reset all the "handled_flag" flags in global popup windows and popup windows
+ * in the current tab page.
+ * Each calling function should use a different flag, see the list at
+ * POPUP_HANDLED_1. This won't work with recursive calls though.
+ */
+ void
+popup_reset_handled(int handled_flag)
+{
+ win_T *wp;
+
+ FOR_ALL_POPUPWINS(wp)
+ wp->w_popup_handled &= ~handled_flag;
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ wp->w_popup_handled &= ~handled_flag;
+}
+
+/*
+ * Find the next visible popup where "handled_flag" is not set.
+ * Must have called popup_reset_handled() first.
+ * When "lowest" is TRUE find the popup with the lowest zindex, otherwise the
+ * popup with the highest zindex.
+ */
+ win_T *
+find_next_popup(int lowest, int handled_flag)
+{
+ win_T *wp;
+ win_T *found_wp;
+ int found_zindex;
+
+ found_zindex = lowest ? INT_MAX : 0;
+ found_wp = NULL;
+ FOR_ALL_POPUPWINS(wp)
+ if ((wp->w_popup_handled & handled_flag) == 0
+ && (wp->w_popup_flags & POPF_HIDDEN) == 0
+ && (lowest ? wp->w_zindex < found_zindex
+ : wp->w_zindex > found_zindex))
+ {
+ found_zindex = wp->w_zindex;
+ found_wp = wp;
+ }
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ if ((wp->w_popup_handled & handled_flag) == 0
+ && (wp->w_popup_flags & POPF_HIDDEN) == 0
+ && (lowest ? wp->w_zindex < found_zindex
+ : wp->w_zindex > found_zindex))
+ {
+ found_zindex = wp->w_zindex;
+ found_wp = wp;
+ }
+
+ if (found_wp != NULL)
+ found_wp->w_popup_handled |= handled_flag;
+ return found_wp;
+}
+
+/*
+ * Invoke the filter callback for window "wp" with typed character "c".
+ * Uses the global "mod_mask" for modifiers.
+ * Returns the return value of the filter or -1 for CTRL-C in the current
+ * window.
+ * Careful: The filter may make "wp" invalid!
+ */
+ static int
+invoke_popup_filter(win_T *wp, int c)
+{
+ int res;
+ typval_T rettv;
+ typval_T argv[3];
+ char_u buf[NUMBUFLEN];
+ linenr_T old_lnum = wp->w_cursor.lnum;
+ int prev_did_emsg = did_emsg;
+
+ // Emergency exit: CTRL-C closes the popup.
+ if (c == Ctrl_C)
+ {
+ int save_got_int = got_int;
+ int was_curwin = wp == curwin;
+
+ // Reset got_int to avoid the callback isn't called.
+ got_int = FALSE;
+ popup_close_with_retval(wp, -1);
+ got_int |= save_got_int;
+
+ // If the popup is the current window it probably fails to close. Then
+ // do not consume the key.
+ if (was_curwin && wp == curwin)
+ return -1;
+ return TRUE;
+ }
+
+ argv[0].v_type = VAR_NUMBER;
+ argv[0].vval.v_number = (varnumber_T)wp->w_id;
+
+ // Convert the number to a string, so that the function can use:
+ // if a:c == "\<F2>"
+ buf[special_to_buf(c, mod_mask, FALSE, buf)] = NUL;
+ argv[1].v_type = VAR_STRING;
+ argv[1].vval.v_string = vim_strsave(buf);
+
+ argv[2].v_type = VAR_UNKNOWN;
+
+ // NOTE: The callback might close the popup and make "wp" invalid.
+ if (call_callback(&wp->w_filter_cb, -1, &rettv, 2, argv) == FAIL)
+ {
+ // Cannot call the function, close the popup to avoid that the filter
+ // eats keys and the user is stuck. Might as well eat the key.
+ popup_close_with_retval(wp, -1);
+ res = TRUE;
+ }
+ else
+ {
+ if (win_valid_popup(wp) && old_lnum != wp->w_cursor.lnum)
+ popup_highlight_curline(wp);
+
+ // If an error message was given always return FALSE, so that keys are
+ // not consumed and the user can type something.
+ // If we get three errors in a row then close the popup. Decrement the
+ // error count by 1/10 if there are no errors, thus allowing up to 1 in
+ // 10 calls to cause an error.
+ if (win_valid_popup(wp) && did_emsg > prev_did_emsg)
+ {
+ wp->w_filter_errors += 10;
+ if (wp->w_filter_errors >= 30)
+ popup_close_with_retval(wp, -1);
+ res = FALSE;
+ }
+ else
+ {
+ if (win_valid_popup(wp) && wp->w_filter_errors > 0)
+ --wp->w_filter_errors;
+ res = tv_get_bool(&rettv);
+ }
+ }
+
+ vim_free(argv[1].vval.v_string);
+ clear_tv(&rettv);
+ return res;
+}
+
+/*
+ * Called when "c" was typed: invoke popup filter callbacks.
+ * Returns TRUE when the character was consumed,
+ */
+ int
+popup_do_filter(int c)
+{
+ static int recursive = FALSE;
+ int res = FALSE;
+ win_T *wp;
+ int save_KeyTyped = KeyTyped;
+ int state;
+ int was_must_redraw = must_redraw;
+
+#ifdef FEAT_TERMINAL
+ // Popup window with terminal always gets focus.
+ if (popup_is_popup(curwin) && curbuf->b_term != NULL)
+ return FALSE;
+#endif
+
+ if (recursive)
+ return FALSE;
+ recursive = TRUE;
+
+ if (c == K_LEFTMOUSE)
+ {
+ int row = mouse_row;
+ int col = mouse_col;
+
+ wp = mouse_find_win(&row, &col, FIND_POPUP);
+ if (wp != NULL && popup_close_if_on_X(wp, row, col))
+ res = TRUE;
+ }
+
+ popup_reset_handled(POPUP_HANDLED_2);
+ state = get_real_state();
+ while (res == FALSE
+ && (wp = find_next_popup(FALSE, POPUP_HANDLED_2)) != NULL)
+ if (wp->w_filter_cb.cb_name != NULL
+ && (wp->w_filter_mode & state) != 0)
+ res = invoke_popup_filter(wp, c);
+
+ if (must_redraw > was_must_redraw)
+ {
+ int save_got_int = got_int;
+
+ // Reset got_int to avoid a function used in the statusline aborts.
+ got_int = FALSE;
+ redraw_after_callback(FALSE, FALSE);
+ got_int |= save_got_int;
+ }
+ recursive = FALSE;
+ KeyTyped = save_KeyTyped;
+
+ // When interrupted return FALSE to avoid looping.
+ return res == -1 ? FALSE : res;
+}
+
+/*
+ * Return TRUE if there is a popup visible with a filter callback and the
+ * "mapping" property off.
+ */
+ int
+popup_no_mapping(void)
+{
+ int round;
+ win_T *wp;
+
+ for (round = 1; round <= 2; ++round)
+ for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
+ wp != NULL; wp = wp->w_next)
+ if (wp->w_filter_cb.cb_name != NULL
+ && (wp->w_popup_flags & (POPF_HIDDEN | POPF_MAPPING)) == 0)
+ return TRUE;
+ return FALSE;
+}
+
+/*
+ * Called when the cursor moved: check if any popup needs to be closed if the
+ * cursor moved far enough.
+ */
+ void
+popup_check_cursor_pos(void)
+{
+ win_T *wp;
+
+ popup_reset_handled(POPUP_HANDLED_3);
+ while ((wp = find_next_popup(TRUE, POPUP_HANDLED_3)) != NULL)
+ if (wp->w_popup_curwin != NULL
+ && (curwin != wp->w_popup_curwin
+ || curwin->w_cursor.lnum != wp->w_popup_lnum
+ || curwin->w_cursor.col < wp->w_popup_mincol
+ || curwin->w_cursor.col > wp->w_popup_maxcol))
+ popup_close_with_retval(wp, -1);
+}
+
+/*
+ * Update "w_popup_mask_cells".
+ */
+ static void
+popup_update_mask(win_T *wp, int width, int height)
+{
+ listitem_T *lio, *li;
+ char_u *cells;
+ int row, col;
+
+ if (wp->w_popup_mask == NULL || width == 0 || height == 0)
+ {
+ VIM_CLEAR(wp->w_popup_mask_cells);
+ return;
+ }
+ if (wp->w_popup_mask_cells != NULL
+ && wp->w_popup_mask_height == height
+ && wp->w_popup_mask_width == width)
+ return; // cache is still valid
+
+ vim_free(wp->w_popup_mask_cells);
+ wp->w_popup_mask_cells = alloc_clear((size_t)width * height);
+ if (wp->w_popup_mask_cells == NULL)
+ return;
+ cells = wp->w_popup_mask_cells;
+
+ FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
+ {
+ int cols, cole;
+ int lines, linee;
+
+ li = lio->li_tv.vval.v_list->lv_first;
+ cols = tv_get_number(&li->li_tv);
+ if (cols < 0)
+ cols = width + cols + 1;
+ if (cols <= 0)
+ cols = 1;
+ li = li->li_next;
+ cole = tv_get_number(&li->li_tv);
+ if (cole < 0)
+ cole = width + cole + 1;
+ if (cole > width)
+ cole = width;
+ li = li->li_next;
+ lines = tv_get_number(&li->li_tv);
+ if (lines < 0)
+ lines = height + lines + 1;
+ if (lines <= 0)
+ lines = 1;
+ li = li->li_next;
+ linee = tv_get_number(&li->li_tv);
+ if (linee < 0)
+ linee = height + linee + 1;
+ if (linee > height)
+ linee = height;
+
+ for (row = lines - 1; row < linee; ++row)
+ for (col = cols - 1; col < cole; ++col)
+ cells[row * width + col] = 1;
+ }
+}
+
+/*
+ * Return TRUE if "col" / "line" matches with an entry in w_popup_mask.
+ * "col" and "line" are screen coordinates.
+ */
+ static int
+popup_masked(win_T *wp, int width, int height, int screencol, int screenline)
+{
+ int col = screencol - wp->w_wincol + wp->w_popup_leftoff;
+ int line = screenline - wp->w_winrow;
+
+ return col >= 0 && col < width
+ && line >= 0 && line < height
+ && wp->w_popup_mask_cells[line * width + col];
+}
+
+/*
+ * Set flags in popup_transparent[] for window "wp" to "val".
+ */
+ static void
+update_popup_transparent(win_T *wp, int val)
+{
+ if (wp->w_popup_mask == NULL)
+ return;
+
+ int width = popup_width(wp);
+ int height = popup_height(wp);
+ listitem_T *lio, *li;
+ int cols, cole;
+ int lines, linee;
+ int col, line;
+
+ FOR_ALL_LIST_ITEMS(wp->w_popup_mask, lio)
+ {
+ li = lio->li_tv.vval.v_list->lv_first;
+ cols = tv_get_number(&li->li_tv);
+ if (cols < 0)
+ cols = width + cols + 1;
+ li = li->li_next;
+ cole = tv_get_number(&li->li_tv);
+ if (cole < 0)
+ cole = width + cole + 1;
+ li = li->li_next;
+ lines = tv_get_number(&li->li_tv);
+ if (lines < 0)
+ lines = height + lines + 1;
+ li = li->li_next;
+ linee = tv_get_number(&li->li_tv);
+ if (linee < 0)
+ linee = height + linee + 1;
+
+ --cols;
+ cols -= wp->w_popup_leftoff;
+ if (cols < 0)
+ cols = 0;
+ cole -= wp->w_popup_leftoff;
+ --lines;
+ if (lines < 0)
+ lines = 0;
+ for (line = lines; line < linee
+ && line + wp->w_winrow < screen_Rows; ++line)
+ for (col = cols; col < cole
+ && col + wp->w_wincol < screen_Columns; ++col)
+ popup_transparent[(line + wp->w_winrow) * screen_Columns
+ + col + wp->w_wincol] = val;
+ }
+}
+
+/*
+ * Only called when popup window "wp" is hidden: If the window is positioned
+ * next to a text property, and it is now visible, then unhide the popup.
+ * We don't check if visible popups become hidden, that is done in
+ * popup_adjust_position().
+ * Return TRUE if the popup became unhidden.
+ */
+ static int
+check_popup_unhidden(win_T *wp)
+{
+ if (wp->w_popup_prop_type > 0 && win_valid(wp->w_popup_prop_win))
+ {
+ textprop_T prop;
+ linenr_T lnum;
+
+ if ((wp->w_popup_flags & POPF_HIDDEN_FORCE) == 0
+ && find_visible_prop(wp->w_popup_prop_win,
+ wp->w_popup_prop_type, wp->w_popup_prop_id,
+ &prop, &lnum) == OK)
+ {
+ wp->w_popup_flags &= ~POPF_HIDDEN;
+ wp->w_popup_prop_topline = 0; // force repositioning
+ return TRUE;
+ }
+ }
+ return FALSE;
+}
+
+/*
+ * Return TRUE if popup_adjust_position() needs to be called for "wp".
+ * That is when the buffer in the popup was changed, or the popup is following
+ * a textprop and the referenced buffer was changed.
+ * Or when the cursor line changed and "cursorline" is set.
+ */
+ static int
+popup_need_position_adjust(win_T *wp)
+{
+ if (wp->w_popup_last_changedtick != CHANGEDTICK(wp->w_buffer))
+ return TRUE;
+ if (win_valid(wp->w_popup_prop_win)
+ && (wp->w_popup_prop_changedtick
+ != CHANGEDTICK(wp->w_popup_prop_win->w_buffer)
+ || wp->w_popup_prop_topline != wp->w_popup_prop_win->w_topline))
+ return TRUE;
+
+ // May need to adjust the width if the cursor moved.
+ return wp->w_cursor.lnum != wp->w_popup_last_curline;
+}
+
+/*
+ * Update "popup_mask" if needed.
+ * Also recomputes the popup size and positions.
+ * Also updates "popup_visible" and "popup_uses_mouse_move".
+ * Also marks window lines for redrawing.
+ */
+ void
+may_update_popup_mask(int type)
+{
+ win_T *wp;
+ short *mask;
+ int line, col;
+ int redraw_all_popups = FALSE;
+ int redrawing_all_win;
+
+ // Need to recompute when switching tabs.
+ // Also recompute when the type is UPD_CLEAR or UPD_NOT_VALID, something
+ // basic (such as the screen size) must have changed.
+ if (popup_mask_tab != curtab || type >= UPD_NOT_VALID)
+ {
+ popup_mask_refresh = TRUE;
+ redraw_all_popups = TRUE;
+ }
+
+ // Check if any popup window buffer has changed and if any popup connected
+ // to a text property has become visible.
+ FOR_ALL_POPUPWINS(wp)
+ if (wp->w_popup_flags & POPF_HIDDEN)
+ popup_mask_refresh |= check_popup_unhidden(wp);
+ else if (popup_need_position_adjust(wp))
+ popup_mask_refresh = TRUE;
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ if (wp->w_popup_flags & POPF_HIDDEN)
+ popup_mask_refresh |= check_popup_unhidden(wp);
+ else if (popup_need_position_adjust(wp))
+ popup_mask_refresh = TRUE;
+
+ if (!popup_mask_refresh)
+ return;
+
+ // Need to update the mask, something has changed.
+ popup_mask_refresh = FALSE;
+ popup_mask_tab = curtab;
+ popup_visible = FALSE;
+
+ // If redrawing all windows, just update "popup_mask".
+ // If redrawing only what is needed, update "popup_mask_next" and then
+ // compare with "popup_mask" to see what changed.
+ redrawing_all_win = TRUE;
+ FOR_ALL_WINDOWS(wp)
+ if (wp->w_redr_type < UPD_SOME_VALID)
+ redrawing_all_win = FALSE;
+ if (redrawing_all_win)
+ mask = popup_mask;
+ else
+ mask = popup_mask_next;
+ vim_memset(mask, 0, (size_t)screen_Rows * screen_Columns * sizeof(short));
+
+ // Find the window with the lowest zindex that hasn't been handled yet,
+ // so that the window with a higher zindex overwrites the value in
+ // popup_mask.
+ popup_reset_handled(POPUP_HANDLED_4);
+ while ((wp = find_next_popup(TRUE, POPUP_HANDLED_4)) != NULL)
+ {
+ int width;
+ int height;
+
+ popup_visible = TRUE;
+
+ // Recompute the position if the text changed. It may make the popup
+ // hidden if it's attach to a text property that is no longer visible.
+ if (redraw_all_popups || popup_need_position_adjust(wp))
+ {
+ popup_adjust_position(wp);
+ if (wp->w_popup_flags & POPF_HIDDEN)
+ continue;
+ }
+
+ width = popup_width(wp);
+ height = popup_height(wp);
+ popup_update_mask(wp, width, height);
+ for (line = wp->w_winrow;
+ line < wp->w_winrow + height && line < screen_Rows; ++line)
+ for (col = wp->w_wincol;
+ col < wp->w_wincol + width - wp->w_popup_leftoff
+ && col < screen_Columns; ++col)
+ if (wp->w_zindex < POPUPMENU_ZINDEX
+ && pum_visible()
+ && pum_under_menu(line, col, FALSE))
+ mask[line * screen_Columns + col] = POPUPMENU_ZINDEX;
+ else if (wp->w_popup_mask_cells == NULL
+ || !popup_masked(wp, width, height, col, line))
+ mask[line * screen_Columns + col] = wp->w_zindex;
+ }
+
+ // Only check which lines are to be updated if not already
+ // updating all lines.
+ if (mask == popup_mask_next)
+ {
+ int *plines_cache = ALLOC_CLEAR_MULT(int, Rows);
+ win_T *prev_wp = NULL;
+
+ for (line = 0; line < screen_Rows; ++line)
+ {
+ int col_done = 0;
+
+ for (col = 0; col < screen_Columns; ++col)
+ {
+ int off = line * screen_Columns + col;
+
+ if (popup_mask[off] != popup_mask_next[off])
+ {
+ popup_mask[off] = popup_mask_next[off];
+
+ if (line >= cmdline_row)
+ {
+ // the command line needs to be cleared if text below
+ // the popup is now visible.
+ if (!msg_scrolled && popup_mask_next[off] == 0)
+ clear_cmdline = TRUE;
+ }
+ else if (col >= col_done)
+ {
+ linenr_T lnum;
+ int line_cp = line;
+ int col_cp = col;
+
+ // The screen position "line" / "col" needs to be
+ // redrawn. Figure out what window that is and update
+ // w_redraw_top and w_redr_bot. Only needs to be done
+ // once for each window line.
+ wp = mouse_find_win(&line_cp, &col_cp, IGNORE_POPUP);
+ if (wp != NULL)
+ {
+#if defined(FEAT_TERMINAL)
+ // A terminal window needs to be redrawn.
+ if (bt_terminal(wp->w_buffer))
+ redraw_win_later(wp, UPD_NOT_VALID);
+ else
+#endif
+ {
+ if (wp != prev_wp)
+ {
+ vim_memset(plines_cache, 0,
+ sizeof(int) * Rows);
+ prev_wp = wp;
+ }
+
+ if (line_cp >= wp->w_height)
+ // In (or below) status line
+ wp->w_redr_status = TRUE;
+ else
+ {
+ // compute the position in the buffer line
+ // from the position in the window
+ (void)mouse_comp_pos(wp, &line_cp, &col_cp,
+ &lnum, plines_cache);
+ redrawWinline(wp, lnum);
+ }
+ }
+
+ // This line is going to be redrawn, no need to
+ // check until the right side of the window.
+ col_done = wp->w_wincol + wp->w_width - 1;
+ }
+ }
+ }
+ }
+ }
+
+ vim_free(plines_cache);
+ }
+
+ update_popup_uses_mouse_move();
+}
+
+/*
+ * If the current window is a popup and something relevant changed, recompute
+ * the position and size.
+ */
+ void
+may_update_popup_position(void)
+{
+ if (popup_is_popup(curwin) && popup_need_position_adjust(curwin))
+ popup_adjust_position(curwin);
+}
+
+/*
+ * Return a string of "len" spaces in IObuff.
+ */
+ static char_u *
+get_spaces(int len)
+{
+ vim_memset(IObuff, ' ', (size_t)len);
+ IObuff[len] = NUL;
+ return IObuff;
+}
+
+/*
+ * Update popup windows. They are drawn on top of normal windows.
+ * "win_update" is called for each popup window, lowest zindex first.
+ */
+ void
+update_popups(void (*win_update)(win_T *wp))
+{
+ win_T *wp;
+ int top_off;
+ int left_extra;
+ int total_width;
+ int total_height;
+ int top_padding;
+ int popup_attr;
+ int border_attr[4];
+ int border_char[8];
+ char_u buf[MB_MAXBYTES];
+ int row;
+ int wincol;
+ int padcol = 0;
+ int padendcol = 0;
+ int i;
+ int sb_thumb_top = 0;
+ int sb_thumb_height = 0;
+ int attr_scroll = 0;
+ int attr_thumb = 0;
+
+ // hide the cursor until redrawing is done.
+ cursor_off();
+
+ // Find the window with the lowest zindex that hasn't been updated yet,
+ // so that the window with a higher zindex is drawn later, thus goes on
+ // top.
+ popup_reset_handled(POPUP_HANDLED_5);
+ while ((wp = find_next_popup(TRUE, POPUP_HANDLED_5)) != NULL)
+ {
+ int title_len = 0;
+ int title_wincol;
+
+ // This drawing uses the zindex of the popup window, so that it's on
+ // top of the text but doesn't draw when another popup with higher
+ // zindex is on top of the character.
+ screen_zindex = wp->w_zindex;
+
+ // Set flags in popup_transparent[] for masked cells.
+ update_popup_transparent(wp, 1);
+
+ // adjust w_winrow and w_wincol for border and padding, since
+ // win_update() doesn't handle them.
+ top_off = popup_top_extra(wp);
+ left_extra = wp->w_popup_padding[3] + wp->w_popup_border[3]
+ - wp->w_popup_leftoff;
+ if (wp->w_wincol + left_extra < 0)
+ left_extra = -wp->w_wincol;
+ wp->w_winrow += top_off;
+ wp->w_wincol += left_extra;
+
+ // Draw the popup text, unless it's off screen.
+ if (wp->w_winrow < screen_Rows && wp->w_wincol < screen_Columns)
+ {
+ // May need to update the "cursorline" highlighting, which may also
+ // change "topline"
+ if (wp->w_popup_last_curline != wp->w_cursor.lnum)
+ popup_highlight_curline(wp);
+
+ win_update(wp);
+
+ // move the cursor into the visible lines, otherwise executing
+ // commands with win_execute() may cause the text to jump.
+ if (wp->w_cursor.lnum < wp->w_topline)
+ wp->w_cursor.lnum = wp->w_topline;
+ else if (wp->w_cursor.lnum >= wp->w_botline)
+ wp->w_cursor.lnum = wp->w_botline - 1;
+ }
+
+ wp->w_winrow -= top_off;
+ wp->w_wincol -= left_extra;
+
+ // Add offset for border and padding if not done already.
+ if ((wp->w_flags & WFLAG_WCOL_OFF_ADDED) == 0)
+ {
+ wp->w_wcol += left_extra;
+ wp->w_flags |= WFLAG_WCOL_OFF_ADDED;
+ }
+ if ((wp->w_flags & WFLAG_WROW_OFF_ADDED) == 0)
+ {
+ wp->w_wrow += top_off;
+ wp->w_flags |= WFLAG_WROW_OFF_ADDED;
+ }
+
+ total_width = popup_width(wp) - wp->w_popup_rightoff;
+ total_height = popup_height(wp);
+ popup_attr = get_wcr_attr(wp);
+
+ if (wp->w_winrow + total_height > cmdline_row)
+ wp->w_popup_flags |= POPF_ON_CMDLINE;
+ else
+ wp->w_popup_flags &= ~POPF_ON_CMDLINE;
+
+
+ // We can only use these line drawing characters when 'encoding' is
+ // "utf-8" and 'ambiwidth' is "single".
+ if (enc_utf8 && *p_ambw == 's')
+ {
+ border_char[0] = border_char[2] = 0x2550;
+ border_char[1] = border_char[3] = 0x2551;
+ border_char[4] = 0x2554;
+ border_char[5] = 0x2557;
+ border_char[6] = (wp->w_popup_flags & POPF_RESIZE)
+ ? 0x21f2 : 0x255d;
+ border_char[7] = 0x255a;
+ }
+ else
+ {
+ border_char[0] = border_char[2] = '-';
+ border_char[1] = border_char[3] = '|';
+ for (i = 4; i < 8; ++i)
+ border_char[i] = '+';
+ if (wp->w_popup_flags & POPF_RESIZE)
+ border_char[6] = '@';
+ }
+ for (i = 0; i < 8; ++i)
+ if (wp->w_border_char[i] != 0)
+ border_char[i] = wp->w_border_char[i];
+
+ for (i = 0; i < 4; ++i)
+ {
+ border_attr[i] = popup_attr;
+ if (wp->w_border_highlight[i] != NULL)
+ border_attr[i] = syn_name2attr(wp->w_border_highlight[i]);
+ }
+
+ // Title goes on top of border or padding.
+ title_wincol = wp->w_wincol + 1;
+ if (wp->w_popup_title != NULL)
+ {
+ title_len = vim_strsize(wp->w_popup_title);
+
+ // truncate the title if too long
+ if (title_len > total_width - 2)
+ {
+ int title_byte_len = (int)STRLEN(wp->w_popup_title);
+ char_u *title_text = alloc(title_byte_len + 1);
+
+ if (title_text != NULL)
+ {
+ trunc_string(wp->w_popup_title, title_text,
+ total_width - 2, title_byte_len + 1);
+ screen_puts(title_text, wp->w_winrow, title_wincol,
+ wp->w_popup_border[0] > 0
+ ? border_attr[0] : popup_attr);
+ vim_free(title_text);
+ }
+
+ title_len = total_width - 2;
+ }
+ else
+ screen_puts(wp->w_popup_title, wp->w_winrow, title_wincol,
+ wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
+ }
+
+ wincol = wp->w_wincol - wp->w_popup_leftoff;
+ top_padding = wp->w_popup_padding[0];
+ if (wp->w_popup_border[0] > 0)
+ {
+ // top border; do not draw over the title
+ if (title_len > 0)
+ {
+ screen_fill(wp->w_winrow, wp->w_winrow + 1,
+ wincol < 0 ? 0 : wincol, title_wincol,
+ wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
+ ? border_char[4] : border_char[0],
+ border_char[0], border_attr[0]);
+ screen_fill(wp->w_winrow, wp->w_winrow + 1,
+ title_wincol + title_len, wincol + total_width,
+ border_char[0], border_char[0], border_attr[0]);
+ }
+ else
+ {
+ screen_fill(wp->w_winrow, wp->w_winrow + 1,
+ wincol < 0 ? 0 : wincol, wincol + total_width,
+ wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
+ ? border_char[4] : border_char[0],
+ border_char[0], border_attr[0]);
+ }
+ if (wp->w_popup_border[1] > 0)
+ {
+ buf[mb_char2bytes(border_char[5], buf)] = NUL;
+ screen_puts(buf, wp->w_winrow,
+ wincol + total_width - 1, border_attr[1]);
+ }
+ }
+ else if (wp->w_popup_padding[0] == 0 && popup_top_extra(wp) > 0)
+ top_padding = 1;
+
+ if (top_padding > 0 || wp->w_popup_padding[2] > 0)
+ {
+ padcol = wincol + wp->w_popup_border[3];
+ padendcol = wp->w_wincol + total_width - wp->w_popup_border[1]
+ - wp->w_has_scrollbar;
+ if (padcol < 0)
+ {
+ padendcol += padcol;
+ padcol = 0;
+ }
+ }
+ if (top_padding > 0)
+ {
+ row = wp->w_winrow + wp->w_popup_border[0];
+ if (title_len > 0 && row == wp->w_winrow)
+ {
+ // top padding and no border; do not draw over the title
+ screen_fill(row, row + 1, padcol, title_wincol,
+ ' ', ' ', popup_attr);
+ screen_fill(row, row + 1, title_wincol + title_len,
+ padendcol, ' ', ' ', popup_attr);
+ row += 1;
+ top_padding -= 1;
+ }
+ screen_fill(row, row + top_padding, padcol, padendcol,
+ ' ', ' ', popup_attr);
+ }
+
+ // Compute scrollbar thumb position and size.
+ if (wp->w_has_scrollbar)
+ {
+ linenr_T linecount = wp->w_buffer->b_ml.ml_line_count;
+ int height = wp->w_height;
+ int last;
+
+ sb_thumb_height = ((linenr_T)height * height + linecount / 2)
+ / linecount;
+ if (wp->w_topline > 1 && sb_thumb_height == height)
+ --sb_thumb_height; // scrolled, no full thumb
+ if (sb_thumb_height == 0)
+ sb_thumb_height = 1;
+ if (linecount <= wp->w_height || wp->w_height == 0)
+ // it just fits, avoid divide by zero
+ sb_thumb_top = 0;
+ else
+ sb_thumb_top = (wp->w_topline - 1
+ + (linecount / wp->w_height) / 2)
+ * (wp->w_height - sb_thumb_height)
+ / (linecount - wp->w_height);
+ if (wp->w_topline > 1 && sb_thumb_top == 0 && height > 1)
+ sb_thumb_top = 1; // show it's scrolled
+ last = total_height - top_off - wp->w_popup_border[2];
+ if (sb_thumb_top >= last)
+ // show at least one character
+ sb_thumb_top = last - 1;
+
+ if (wp->w_scrollbar_highlight != NULL)
+ attr_scroll = syn_name2attr(wp->w_scrollbar_highlight);
+ else
+ attr_scroll = highlight_attr[HLF_PSB];
+ if (wp->w_thumb_highlight != NULL)
+ attr_thumb = syn_name2attr(wp->w_thumb_highlight);
+ else
+ attr_thumb = highlight_attr[HLF_PST];
+ }
+
+ for (i = wp->w_popup_border[0];
+ i < total_height - wp->w_popup_border[2]; ++i)
+ {
+ int pad_left;
+ // left and right padding only needed next to the body
+ int do_padding =
+ i >= wp->w_popup_border[0] + wp->w_popup_padding[0]
+ && i < total_height - wp->w_popup_border[2]
+ - wp->w_popup_padding[2];
+
+ row = wp->w_winrow + i;
+
+ // left border
+ if (wp->w_popup_border[3] > 0 && wincol >= 0)
+ {
+ buf[mb_char2bytes(border_char[3], buf)] = NUL;
+ screen_puts(buf, row, wincol, border_attr[3]);
+ }
+ if (do_padding && wp->w_popup_padding[3] > 0)
+ {
+ int col = wincol + wp->w_popup_border[3];
+
+ // left padding
+ pad_left = wp->w_popup_padding[3];
+ if (col < 0)
+ {
+ pad_left += col;
+ col = 0;
+ }
+ if (pad_left > 0)
+ screen_puts(get_spaces(pad_left), row, col, popup_attr);
+ }
+ // scrollbar
+ if (wp->w_has_scrollbar)
+ {
+ int line = i - top_off;
+ int scroll_col = wp->w_wincol + total_width - 1
+ - wp->w_popup_border[1];
+
+ if (line >= 0 && line < wp->w_height)
+ screen_putchar(' ', row, scroll_col,
+ line >= sb_thumb_top
+ && line < sb_thumb_top + sb_thumb_height
+ ? attr_thumb : attr_scroll);
+ else
+ screen_putchar(' ', row, scroll_col, popup_attr);
+ }
+ // right border
+ if (wp->w_popup_border[1] > 0)
+ {
+ buf[mb_char2bytes(border_char[1], buf)] = NUL;
+ screen_puts(buf, row, wincol + total_width - 1, border_attr[1]);
+ }
+ // right padding
+ if (do_padding && wp->w_popup_padding[1] > 0)
+ screen_puts(get_spaces(wp->w_popup_padding[1]), row,
+ wincol + wp->w_popup_border[3]
+ + wp->w_popup_padding[3] + wp->w_width + wp->w_leftcol,
+ popup_attr);
+ }
+
+ if (wp->w_popup_padding[2] > 0)
+ {
+ // bottom padding
+ row = wp->w_winrow + wp->w_popup_border[0]
+ + wp->w_popup_padding[0] + wp->w_height;
+ screen_fill(row, row + wp->w_popup_padding[2],
+ padcol, padendcol, ' ', ' ', popup_attr);
+ }
+
+ if (wp->w_popup_border[2] > 0)
+ {
+ // bottom border
+ row = wp->w_winrow + total_height - 1;
+ screen_fill(row , row + 1,
+ wincol < 0 ? 0 : wincol,
+ wincol + total_width,
+ wp->w_popup_border[3] != 0 && wp->w_popup_leftoff == 0
+ ? border_char[7] : border_char[2],
+ border_char[2], border_attr[2]);
+ if (wp->w_popup_border[1] > 0)
+ {
+ buf[mb_char2bytes(border_char[6], buf)] = NUL;
+ screen_puts(buf, row, wincol + total_width - 1, border_attr[2]);
+ }
+ }
+
+ if (wp->w_popup_close == POPCLOSE_BUTTON)
+ {
+ // close button goes on top of anything at the top-right corner
+ buf[mb_char2bytes('X', buf)] = NUL;
+ screen_puts(buf, wp->w_winrow, wincol + total_width - 1,
+ wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
+ }
+
+ update_popup_transparent(wp, 0);
+
+ // Back to the normal zindex.
+ screen_zindex = 0;
+
+#ifdef HAS_MESSAGE_WINDOW
+ // if this was the message window popup may start the timer now
+ may_start_message_win_timer(wp);
+#endif
+ }
+
+#if defined(FEAT_SEARCH_EXTRA)
+ // In case win_update() called start_search_hl().
+ end_search_hl();
+#endif
+}
+
+/*
+ * Mark references in callbacks of one popup window.
+ */
+ static int
+set_ref_in_one_popup(win_T *wp, int copyID)
+{
+ int abort = FALSE;
+ typval_T tv;
+
+ if (wp->w_close_cb.cb_partial != NULL)
+ {
+ tv.v_type = VAR_PARTIAL;
+ tv.vval.v_partial = wp->w_close_cb.cb_partial;
+ abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
+ }
+ if (wp->w_filter_cb.cb_partial != NULL)
+ {
+ tv.v_type = VAR_PARTIAL;
+ tv.vval.v_partial = wp->w_filter_cb.cb_partial;
+ abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
+ }
+ abort = abort || set_ref_in_list(wp->w_popup_mask, copyID);
+ return abort;
+}
+
+/*
+ * Set reference in callbacks of popup windows.
+ */
+ int
+set_ref_in_popups(int copyID)
+{
+ int abort = FALSE;
+ win_T *wp;
+ tabpage_T *tp;
+
+ for (wp = first_popupwin; !abort && wp != NULL; wp = wp->w_next)
+ abort = abort || set_ref_in_one_popup(wp, copyID);
+
+ FOR_ALL_TABPAGES(tp)
+ {
+ for (wp = tp->tp_first_popupwin; !abort && wp != NULL; wp = wp->w_next)
+ abort = abort || set_ref_in_one_popup(wp, copyID);
+ if (abort)
+ break;
+ }
+ return abort;
+}
+
+ int
+popup_is_popup(win_T *wp)
+{
+ return wp->w_popup_flags != 0;
+}
+
+#if defined(FEAT_QUICKFIX) || defined(PROTO)
+/*
+ * Find an existing popup used as the preview window, in the current tab page.
+ * Return NULL if not found.
+ */
+ win_T *
+popup_find_preview_window(void)
+{
+ win_T *wp;
+
+ // Preview window popup is always local to tab page.
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ if (wp->w_p_pvw)
+ return wp;
+ return NULL;
+}
+
+/*
+ * Find an existing popup used as the info window, in the current tab page.
+ * Return NULL if not found.
+ */
+ win_T *
+popup_find_info_window(void)
+{
+ win_T *wp;
+
+ // info window popup is always local to tab page.
+ FOR_ALL_POPUPWINS_IN_TAB(curtab, wp)
+ if (wp->w_popup_flags & POPF_INFO)
+ return wp;
+ return NULL;
+}
+#endif
+
+ void
+f_popup_findecho(typval_T *argvars UNUSED, typval_T *rettv)
+{
+#ifdef HAS_MESSAGE_WINDOW
+ rettv->vval.v_number = message_win == NULL ? 0 : message_win->w_id;
+#else
+ rettv->vval.v_number = 0;
+#endif
+}
+
+ void
+f_popup_findinfo(typval_T *argvars UNUSED, typval_T *rettv)
+{
+#ifdef FEAT_QUICKFIX
+ win_T *wp = popup_find_info_window();
+
+ rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
+#else
+ rettv->vval.v_number = 0;
+#endif
+}
+
+ void
+f_popup_findpreview(typval_T *argvars UNUSED, typval_T *rettv)
+{
+#ifdef FEAT_QUICKFIX
+ win_T *wp = popup_find_preview_window();
+
+ rettv->vval.v_number = wp == NULL ? 0 : wp->w_id;
+#else
+ rettv->vval.v_number = 0;
+#endif
+}
+
+#if defined(FEAT_QUICKFIX) || defined(PROTO)
+/*
+ * Create a popup to be used as the preview or info window.
+ * NOTE: this makes the popup the current window, so that the file can be
+ * edited. However, it must not remain to be the current window, the caller
+ * must make sure of that.
+ */
+ int
+popup_create_preview_window(int info)
+{
+ win_T *wp = popup_create(NULL, NULL, info ? TYPE_INFO : TYPE_PREVIEW);
+
+ if (wp == NULL)
+ return FAIL;
+ if (info)
+ wp->w_popup_flags |= POPF_INFO;
+ else
+ wp->w_p_pvw = TRUE;
+
+ // Set the width to a reasonable value, so that w_topline can be computed.
+ if (wp->w_minwidth > 0)
+ wp->w_width = wp->w_minwidth;
+ else if (wp->w_maxwidth > 0)
+ wp->w_width = wp->w_maxwidth;
+ else
+ wp->w_width = curwin->w_width;
+
+ // Will switch to another buffer soon, dummy one can be wiped.
+ wp->w_buffer->b_locked = FALSE;
+
+ win_enter(wp, FALSE);
+ return OK;
+}
+
+/*
+ * Close any preview popup.
+ */
+ void
+popup_close_preview(void)
+{
+ win_T *wp = popup_find_preview_window();
+
+ if (wp != NULL)
+ popup_close_with_retval(wp, -1);
+}
+
+/*
+ * Hide the info popup.
+ */
+ void
+popup_hide_info(void)
+{
+ win_T *wp = popup_find_info_window();
+
+ if (wp != NULL)
+ popup_hide(wp);
+}
+
+/*
+ * Close any info popup.
+ */
+ void
+popup_close_info(void)
+{
+ win_T *wp = popup_find_info_window();
+
+ if (wp != NULL)
+ popup_close_with_retval(wp, -1);
+}
+#endif
+
+#if defined(HAS_MESSAGE_WINDOW) || defined(PROTO)
+
+/*
+ * Get the message window.
+ * Returns NULL if something failed.
+ */
+ win_T *
+popup_get_message_win(void)
+{
+ if (message_win != NULL)
+ return message_win;
+
+ int i;
+
+ message_win = popup_create(NULL, NULL, TYPE_MESSAGE_WIN);
+
+ if (message_win == NULL)
+ return NULL;
+
+ // use the full screen width
+ message_win->w_width = Columns;
+
+ // position at bottom of screen
+ message_win->w_popup_pos = POPPOS_BOTTOM;
+ message_win->w_wantcol = 1;
+ message_win->w_minwidth = 9999;
+ message_win->w_firstline = -1;
+
+ // no padding, border at the top
+ for (i = 0; i < 4; ++i)
+ message_win->w_popup_padding[i] = 0;
+ for (i = 1; i < 4; ++i)
+ message_win->w_popup_border[i] = 0;
+
+ if (message_win->w_popup_timer != NULL)
+ message_win->w_popup_timer->tr_keep = TRUE;
+ return message_win;
+}
+
+/*
+ * If the message window is not visible: show it
+ * If the message window is visible: reset the timeout
+ */
+ void
+popup_show_message_win(void)
+{
+ if (message_win == NULL)
+ return;
+
+ if ((message_win->w_popup_flags & POPF_HIDDEN) != 0)
+ {
+ // the highlight may have changed.
+ popup_update_color(message_win, TYPE_MESSAGE_WIN);
+ popup_show(message_win);
+ }
+ start_message_win_timer = TRUE;
+}
+
+ static void
+may_start_message_win_timer(win_T *wp)
+{
+ if (wp == message_win && start_message_win_timer)
+ {
+ if (message_win->w_popup_timer != NULL)
+ {
+ message_win->w_popup_timer->tr_interval = message_win_time;
+ timer_start(message_win->w_popup_timer);
+ message_win_time = 3000;
+ }
+ start_message_win_timer = FALSE;
+ }
+}
+
+ int
+popup_message_win_visible(void)
+{
+ return message_win != NULL
+ && (message_win->w_popup_flags & POPF_HIDDEN) == 0;
+}
+
+/*
+ * If the message window is visible: hide it.
+ */
+ void
+popup_hide_message_win(void)
+{
+ if (message_win != NULL)
+ popup_hide(message_win);
+}
+
+// Values saved in start_echowindow() and restored in end_echowindow()
+static int save_msg_didout = FALSE;
+static int save_msg_col = 0;
+// Values saved in end_echowindow() and restored in start_echowindow()
+static int ew_msg_didout = FALSE;
+static int ew_msg_col = 0;
+
+/*
+ * Invoked before outputting a message for ":echowindow".
+ * "time_sec" is the display time, zero means using the default 3 sec.
+ */
+ void
+start_echowindow(int time_sec)
+{
+ in_echowindow = TRUE;
+ save_msg_didout = msg_didout;
+ save_msg_col = msg_col;
+ msg_didout = ew_msg_didout;
+ msg_col = ew_msg_col;
+ if (time_sec != 0)
+ message_win_time = time_sec * 1000;
+}
+
+/*
+ * Invoked after outputting a message for ":echowindow".
+ */
+ void
+end_echowindow(void)
+{
+ in_echowindow = FALSE;
+
+ if ((State & MODE_HITRETURN) == 0)
+ // show the message window now
+ redraw_cmd(FALSE);
+
+ // do not overwrite messages
+ ew_msg_didout = TRUE;
+ ew_msg_col = msg_col == 0 ? 1 : msg_col;
+ msg_didout = save_msg_didout;
+ msg_col = save_msg_col;
+}
+#endif
+
+/*
+ * Close any popup for a text property associated with "win".
+ * Return TRUE if a popup was closed.
+ */
+ int
+popup_win_closed(win_T *win)
+{
+ int round;
+ win_T *wp;
+ win_T *next;
+ int ret = FALSE;
+
+ for (round = 1; round <= 2; ++round)
+ for (wp = round == 1 ? first_popupwin : curtab->tp_first_popupwin;
+ wp != NULL; wp = next)
+ {
+ next = wp->w_next;
+ if (wp->w_popup_prop_win == win)
+ {
+ popup_close_with_retval(wp, -1);
+ ret = TRUE;
+ }
+ }
+ return ret;
+}
+
+/*
+ * Set the title of the popup window to the file name.
+ */
+ void
+popup_set_title(win_T *wp)
+{
+ if (wp->w_buffer->b_fname == NULL)
+ return;
+
+ char_u dirname[MAXPATHL];
+ size_t len;
+
+ mch_dirname(dirname, MAXPATHL);
+ shorten_buf_fname(wp->w_buffer, dirname, FALSE);
+
+ vim_free(wp->w_popup_title);
+ len = STRLEN(wp->w_buffer->b_fname) + 3;
+ wp->w_popup_title = alloc((int)len);
+ if (wp->w_popup_title != NULL)
+ vim_snprintf((char *)wp->w_popup_title, len, " %s ",
+ wp->w_buffer->b_fname);
+ redraw_win_later(wp, UPD_VALID);
+}
+
+# if defined(FEAT_QUICKFIX) || defined(PROTO)
+/*
+ * If there is a preview window, update the title.
+ * Used after changing directory.
+ */
+ void
+popup_update_preview_title(void)
+{
+ win_T *wp = popup_find_preview_window();
+
+ if (wp != NULL)
+ popup_set_title(wp);
+}
+# endif
+
+#endif // FEAT_PROP_POPUP