blob: dd1a6ec99af67f0c586616718bed84a82edd6646 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar4b779472005-10-04 09:12:31 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar30e8e732019-09-27 13:08:36 +020011 * popupmenu.c: Popup menu (PUM)
Bram Moolenaar4b779472005-10-04 09:12:31 +000012 */
13#include "vim.h"
14
Bram Moolenaar63d9e732019-12-05 21:10:38 +010015static pumitem_T *pum_array = NULL; // items of displayed pum
16static int pum_size; // nr of items in "pum_array"
17static int pum_selected; // index of selected item or -1
18static int pum_first = 0; // index of top item
Bram Moolenaar4b779472005-10-04 09:12:31 +000019
Bram Moolenaarae654382019-01-17 21:09:05 +010020static int call_update_screen = FALSE;
Luuk van Baaldcd40cf2023-04-23 16:24:08 +010021static int pum_in_cmdline = FALSE;
Bram Moolenaarae654382019-01-17 21:09:05 +010022
Bram Moolenaar63d9e732019-12-05 21:10:38 +010023static int pum_height; // nr of displayed pum items
24static int pum_width; // width of displayed pum items
25static int pum_base_width; // width of pum items base
26static int pum_kind_width; // width of pum items kind column
27static int pum_extra_width; // width of extra stuff
28static int pum_scrollbar; // TRUE when scrollbar present
Bram Moolenaar4b779472005-10-04 09:12:31 +000029
Bram Moolenaar63d9e732019-12-05 21:10:38 +010030static int pum_row; // top row of pum
31static int pum_col; // left column of pum
Bram Moolenaar4b779472005-10-04 09:12:31 +000032
Bram Moolenaar0e6e1792018-06-17 17:10:59 +020033static win_T *pum_window = NULL;
Bram Moolenaar491ac282018-06-17 14:47:55 +020034static int pum_win_row;
35static int pum_win_height;
36static int pum_win_col;
37static int pum_win_wcol;
38static int pum_win_width;
39
Bram Moolenaar04357fb2019-12-10 21:50:56 +010040// Some parts are not updated when a popup menu is visible. Setting this flag
41// makes pum_visible() return FALSE even when there is a popup menu.
42static int pum_pretend_not_visible = FALSE;
43
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +010044static int pum_set_selected(int n, int repeat);
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +000045
Bram Moolenaar4b779472005-10-04 09:12:31 +000046#define PUM_DEF_HEIGHT 10
Bram Moolenaar4b779472005-10-04 09:12:31 +000047
Bram Moolenaar51b0f372017-11-18 18:52:04 +010048 static void
49pum_compute_size(void)
50{
51 int i;
52 int w;
53
Bram Moolenaar63d9e732019-12-05 21:10:38 +010054 // Compute the width of the widest match and the widest extra.
Bram Moolenaar51b0f372017-11-18 18:52:04 +010055 pum_base_width = 0;
56 pum_kind_width = 0;
57 pum_extra_width = 0;
58 for (i = 0; i < pum_size; ++i)
59 {
Bram Moolenaard58a6622020-05-02 14:52:57 +020060 if (pum_array[i].pum_text != NULL)
61 {
62 w = vim_strsize(pum_array[i].pum_text);
63 if (pum_base_width < w)
64 pum_base_width = w;
65 }
Bram Moolenaar51b0f372017-11-18 18:52:04 +010066 if (pum_array[i].pum_kind != NULL)
67 {
68 w = vim_strsize(pum_array[i].pum_kind) + 1;
69 if (pum_kind_width < w)
70 pum_kind_width = w;
71 }
72 if (pum_array[i].pum_extra != NULL)
73 {
74 w = vim_strsize(pum_array[i].pum_extra) + 1;
75 if (pum_extra_width < w)
76 pum_extra_width = w;
77 }
78 }
79}
80
Bram Moolenaar4b779472005-10-04 09:12:31 +000081/*
82 * Show the popup menu with items "array[size]".
83 * "array" must remain valid until pum_undisplay() is called!
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +010084 * When possible the leftmost character is aligned with cursor column.
Bram Moolenaar4b779472005-10-04 09:12:31 +000085 * The menu appears above the screen line "row" or at "row" + "height" - 1.
86 */
87 void
Bram Moolenaar05540972016-01-30 20:31:25 +010088pum_display(
89 pumitem_T *array,
90 int size,
Bram Moolenaar63d9e732019-12-05 21:10:38 +010091 int selected) // index of initially selected item, none if
92 // out of range
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +000093{
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +000094 int def_width;
95 int max_width;
Bram Moolenaarc1a11ed2008-06-24 22:09:24 +000096 int context_lines;
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +010097 int cursor_col;
Bram Moolenaar91e44a32016-11-04 20:08:52 +010098 int above_row;
99 int below_row;
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000100 int redo_count = 0;
Bram Moolenaar4033c552017-09-16 20:54:51 +0200101#if defined(FEAT_QUICKFIX)
Bram Moolenaar91e44a32016-11-04 20:08:52 +0100102 win_T *pvwin;
Bram Moolenaaraab33832016-11-04 22:08:29 +0100103#endif
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100104#ifdef FEAT_RIGHTLEFT
Bram Moolenaar24959102022-05-07 20:01:16 +0100105 int right_left = State == MODE_CMDLINE ? FALSE : curwin->w_p_rl;
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100106#endif
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000107
Bram Moolenaara5e66212017-09-29 22:42:33 +0200108 do
109 {
Bram Moolenaar42443c72018-02-10 18:28:52 +0100110 def_width = p_pw;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200111 above_row = 0;
112 below_row = cmdline_row;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000113
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100114 // Pretend the pum is already there to avoid that must_redraw is set
115 // when 'cuc' is on.
Bram Moolenaara5e66212017-09-29 22:42:33 +0200116 pum_array = (pumitem_T *)1;
117 validate_cursor_col();
118 pum_array = NULL;
Bram Moolenaar1e607892006-03-13 22:15:53 +0000119
Bram Moolenaar491ac282018-06-17 14:47:55 +0200120 // Remember the essential parts of the window position and size, so we
121 // can decide when to reposition the popup menu.
Bram Moolenaar0e6e1792018-06-17 17:10:59 +0200122 pum_window = curwin;
Bram Moolenaar24959102022-05-07 20:01:16 +0100123 if (State == MODE_CMDLINE)
Yegappan Lakshmanan560dff42022-02-10 19:52:10 +0000124 // cmdline completion popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +0000125 pum_win_row = cmdline_row;
126 else
127 pum_win_row = curwin->w_wrow + W_WINROW(curwin);
Bram Moolenaar491ac282018-06-17 14:47:55 +0200128 pum_win_height = curwin->w_height;
129 pum_win_col = curwin->w_wincol;
130 pum_win_wcol = curwin->w_wcol;
131 pum_win_width = curwin->w_width;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000132
Bram Moolenaar4033c552017-09-16 20:54:51 +0200133#if defined(FEAT_QUICKFIX)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200134 FOR_ALL_WINDOWS(pvwin)
135 if (pvwin->w_p_pvw)
136 break;
137 if (pvwin != NULL)
138 {
139 if (W_WINROW(pvwin) < W_WINROW(curwin))
140 above_row = W_WINROW(pvwin) + pvwin->w_height;
141 else if (W_WINROW(pvwin) > W_WINROW(curwin) + curwin->w_height)
142 below_row = W_WINROW(pvwin);
143 }
Bram Moolenaar0106e3d2016-02-23 18:55:43 +0100144#endif
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000145
Bram Moolenaara5e66212017-09-29 22:42:33 +0200146 /*
147 * Figure out the size and position of the pum.
148 */
149 if (size < PUM_DEF_HEIGHT)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000150 pum_height = size;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000151 else
Bram Moolenaara5e66212017-09-29 22:42:33 +0200152 pum_height = PUM_DEF_HEIGHT;
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000153 if (p_ph > 0 && pum_height > p_ph)
154 pum_height = p_ph;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000155
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100156 // Put the pum below "pum_win_row" if possible. If there are few lines
157 // decide on where there is more room.
Bram Moolenaar491ac282018-06-17 14:47:55 +0200158 if (pum_win_row + 2 >= below_row - pum_height
159 && pum_win_row - above_row > (below_row - above_row) / 2)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200160 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100161 // pum above "pum_win_row"
Bram Moolenaara5e66212017-09-29 22:42:33 +0200162
Bram Moolenaar24959102022-05-07 20:01:16 +0100163 if (State == MODE_CMDLINE)
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100164 // for cmdline pum, no need for context lines
165 context_lines = 0;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200166 else
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100167 {
168 // Leave two lines of context if possible
169 if (curwin->w_wrow - curwin->w_cline_row >= 2)
170 context_lines = 2;
171 else
172 context_lines = curwin->w_wrow - curwin->w_cline_row;
173 }
Bram Moolenaara5e66212017-09-29 22:42:33 +0200174
Bram Moolenaar491ac282018-06-17 14:47:55 +0200175 if (pum_win_row >= size + context_lines)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200176 {
Bram Moolenaar491ac282018-06-17 14:47:55 +0200177 pum_row = pum_win_row - size - context_lines;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200178 pum_height = size;
179 }
180 else
181 {
182 pum_row = 0;
Bram Moolenaar491ac282018-06-17 14:47:55 +0200183 pum_height = pum_win_row - context_lines;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200184 }
185 if (p_ph > 0 && pum_height > p_ph)
186 {
187 pum_row += pum_height - p_ph;
188 pum_height = p_ph;
189 }
190 }
191 else
192 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100193 // pum below "pum_win_row"
Bram Moolenaara5e66212017-09-29 22:42:33 +0200194
Bram Moolenaar24959102022-05-07 20:01:16 +0100195 if (State == MODE_CMDLINE)
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100196 // for cmdline pum, no need for context lines
197 context_lines = 0;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200198 else
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100199 {
200 // Leave two lines of context if possible
201 validate_cheight();
202 if (curwin->w_cline_row
203 + curwin->w_cline_height - curwin->w_wrow >= 3)
204 context_lines = 3;
205 else
206 context_lines = curwin->w_cline_row
207 + curwin->w_cline_height - curwin->w_wrow;
208 }
Bram Moolenaara5e66212017-09-29 22:42:33 +0200209
Bram Moolenaar491ac282018-06-17 14:47:55 +0200210 pum_row = pum_win_row + context_lines;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200211 if (size > below_row - pum_row)
212 pum_height = below_row - pum_row;
213 else
214 pum_height = size;
215 if (p_ph > 0 && pum_height > p_ph)
216 pum_height = p_ph;
217 }
218
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100219 // don't display when we only have room for one line
Bram Moolenaara5e66212017-09-29 22:42:33 +0200220 if (pum_height < 1 || (pum_height == 1 && size > 1))
221 return;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000222
Bram Moolenaar4033c552017-09-16 20:54:51 +0200223#if defined(FEAT_QUICKFIX)
Bram Moolenaar614ab8a2018-12-01 11:59:00 +0100224 // If there is a preview window above avoid drawing over it.
225 if (pvwin != NULL && pum_row < above_row && pum_height > above_row)
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000226 {
Bram Moolenaar614ab8a2018-12-01 11:59:00 +0100227 pum_row = above_row;
228 pum_height = pum_win_row - above_row;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000229 }
Bram Moolenaara5e66212017-09-29 22:42:33 +0200230#endif
231
Bram Moolenaar51b0f372017-11-18 18:52:04 +0100232 pum_array = array;
233 pum_size = size;
234 pum_compute_size();
235 max_width = pum_base_width;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000236
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100237 // Calculate column
Bram Moolenaar24959102022-05-07 20:01:16 +0100238 if (State == MODE_CMDLINE)
Yegappan Lakshmanan560dff42022-02-10 19:52:10 +0000239 // cmdline completion popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +0000240 cursor_col = cmdline_compl_startcol();
241 else
Bram Moolenaar6ac2e432023-03-31 19:32:29 +0100242 {
243 // w_wcol includes virtual text "above"
244 int wcol = curwin->w_wcol % curwin->w_width;
Bram Moolenaarabc97732007-08-08 20:49:37 +0000245#ifdef FEAT_RIGHTLEFT
Bram Moolenaar6ac2e432023-03-31 19:32:29 +0100246 if (right_left)
247 cursor_col = curwin->w_wincol + curwin->w_width - wcol - 1;
248 else
Bram Moolenaarabc97732007-08-08 20:49:37 +0000249#endif
Bram Moolenaar6ac2e432023-03-31 19:32:29 +0100250 cursor_col = curwin->w_wincol + wcol;
251 }
Bram Moolenaarabc97732007-08-08 20:49:37 +0000252
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100253 // if there are more items than room we need a scrollbar
Bram Moolenaara5e66212017-09-29 22:42:33 +0200254 if (pum_height < size)
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000255 {
Bram Moolenaara5e66212017-09-29 22:42:33 +0200256 pum_scrollbar = 1;
257 ++max_width;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000258 }
Bram Moolenaarabc97732007-08-08 20:49:37 +0000259 else
Bram Moolenaara5e66212017-09-29 22:42:33 +0200260 pum_scrollbar = 0;
261
262 if (def_width < max_width)
263 def_width = max_width;
264
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100265 if (((cursor_col < Columns - p_pw || cursor_col < Columns - max_width)
Bram Moolenaarabc97732007-08-08 20:49:37 +0000266#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100267 && !right_left)
268 || (right_left && (cursor_col > p_pw || cursor_col > max_width)
Bram Moolenaarabc97732007-08-08 20:49:37 +0000269#endif
Bram Moolenaara5e66212017-09-29 22:42:33 +0200270 ))
271 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100272 // align pum with "cursor_col"
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +0100273 pum_col = cursor_col;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000274
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100275 // start with the maximum space available
Bram Moolenaara5e66212017-09-29 22:42:33 +0200276#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100277 if (right_left)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200278 pum_width = pum_col - pum_scrollbar + 1;
279 else
280#endif
281 pum_width = Columns - pum_col - pum_scrollbar;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000282
Bram Moolenaar51b0f372017-11-18 18:52:04 +0100283 if (pum_width > max_width + pum_kind_width + pum_extra_width + 1
Bram Moolenaar42443c72018-02-10 18:28:52 +0100284 && pum_width > p_pw)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200285 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100286 // the width is more than needed for the items, make it
287 // narrower
Bram Moolenaar51b0f372017-11-18 18:52:04 +0100288 pum_width = max_width + pum_kind_width + pum_extra_width + 1;
Bram Moolenaar42443c72018-02-10 18:28:52 +0100289 if (pum_width < p_pw)
290 pum_width = p_pw;
Bram Moolenaara5e66212017-09-29 22:42:33 +0200291 }
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +0100292 else if (((cursor_col > p_pw || cursor_col > max_width)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100293#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100294 && !right_left)
295 || (right_left && (cursor_col < Columns - p_pw
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +0100296 || cursor_col < Columns - max_width)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100297#endif
298 ))
299 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100300 // align pum edge with "cursor_col"
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100301#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100302 if (right_left
Bram Moolenaarbb008dd2018-02-24 18:59:55 +0100303 && W_ENDCOL(curwin) < max_width + pum_scrollbar + 1)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100304 {
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +0100305 pum_col = cursor_col + max_width + pum_scrollbar + 1;
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100306 if (pum_col >= Columns)
307 pum_col = Columns - 1;
308 }
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100309 else if (!right_left)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100310#endif
311 {
Bram Moolenaar2b10bcb2018-02-24 21:25:44 +0100312 if (curwin->w_wincol > Columns - max_width - pum_scrollbar
313 && max_width <= p_pw)
Bram Moolenaar4287ed32018-02-17 20:35:29 +0100314 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100315 // use full width to end of the screen
Bram Moolenaar4287ed32018-02-17 20:35:29 +0100316 pum_col = Columns - max_width - pum_scrollbar;
317 if (pum_col < 0)
318 pum_col = 0;
319 }
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100320 }
321
322#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100323 if (right_left)
Bram Moolenaar4287ed32018-02-17 20:35:29 +0100324 pum_width = pum_col - pum_scrollbar + 1;
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100325 else
326#endif
Bram Moolenaar4287ed32018-02-17 20:35:29 +0100327 pum_width = Columns - pum_col - pum_scrollbar;
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100328
Bram Moolenaar42443c72018-02-10 18:28:52 +0100329 if (pum_width < p_pw)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100330 {
Bram Moolenaar42443c72018-02-10 18:28:52 +0100331 pum_width = p_pw;
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100332#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100333 if (right_left)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100334 {
335 if (pum_width > pum_col)
336 pum_width = pum_col;
337 }
338 else
339#endif
340 {
341 if (pum_width >= Columns - pum_col)
342 pum_width = Columns - pum_col - 1;
343 }
344 }
345 else if (pum_width > max_width + pum_kind_width
346 + pum_extra_width + 1
Bram Moolenaar42443c72018-02-10 18:28:52 +0100347 && pum_width > p_pw)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100348 {
349 pum_width = max_width + pum_kind_width
350 + pum_extra_width + 1;
Bram Moolenaar42443c72018-02-10 18:28:52 +0100351 if (pum_width < p_pw)
352 pum_width = p_pw;
Bram Moolenaara8f04aa2018-02-10 15:36:55 +0100353 }
354 }
355
Bram Moolenaara5e66212017-09-29 22:42:33 +0200356 }
357 else if (Columns < def_width)
358 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100359 // not enough room, will use what we have
Bram Moolenaara5e66212017-09-29 22:42:33 +0200360#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100361 if (right_left)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200362 pum_col = Columns - 1;
363 else
364#endif
365 pum_col = 0;
366 pum_width = Columns - 1;
367 }
368 else
369 {
Bram Moolenaar42443c72018-02-10 18:28:52 +0100370 if (max_width > p_pw)
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100371 max_width = p_pw; // truncate
Bram Moolenaara5e66212017-09-29 22:42:33 +0200372#ifdef FEAT_RIGHTLEFT
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +0100373 if (right_left)
Bram Moolenaara5e66212017-09-29 22:42:33 +0200374 pum_col = max_width - 1;
375 else
376#endif
377 pum_col = Columns - max_width;
378 pum_width = max_width - pum_scrollbar;
379 }
380
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100381 // Set selected item and redraw. If the window size changed need to
382 // redo the positioning. Limit this to two times, when there is not
383 // much room the window size will keep changing.
Bram Moolenaara5e66212017-09-29 22:42:33 +0200384 } while (pum_set_selected(selected, redo_count) && ++redo_count <= 2);
Bram Moolenaar714cbe52020-11-16 19:12:00 +0100385
386 pum_redraw();
Bram Moolenaar4b779472005-10-04 09:12:31 +0000387}
388
389/*
Bram Moolenaarae654382019-01-17 21:09:05 +0100390 * Set a flag that when pum_redraw() is called it first calls update_screen().
391 * This will avoid clearing and redrawing the popup menu, prevent flicker.
392 */
393 void
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +0000394pum_call_update_screen(void)
Bram Moolenaarae654382019-01-17 21:09:05 +0100395{
396 call_update_screen = TRUE;
397
398 // Update the cursor position to be able to compute the popup menu
399 // position. The cursor line length may have changed because of the
400 // inserted completion.
Bram Moolenaarc07ff5c2019-01-30 21:41:14 +0100401 curwin->w_valid &= ~(VALID_CROW|VALID_CHEIGHT);
Bram Moolenaarae654382019-01-17 21:09:05 +0100402 validate_cursor();
403}
404
405/*
406 * Return TRUE if we are going to redraw the popup menu and the screen position
407 * "row"/"col" is under the popup menu.
408 */
409 int
Bakudankun65555002021-11-17 20:40:16 +0000410pum_under_menu(int row, int col, int only_redrawing)
Bram Moolenaarae654382019-01-17 21:09:05 +0100411{
Bakudankun65555002021-11-17 20:40:16 +0000412 return (!only_redrawing || pum_will_redraw)
Bram Moolenaarae654382019-01-17 21:09:05 +0100413 && row >= pum_row
414 && row < pum_row + pum_height
415 && col >= pum_col - 1
Bram Moolenaare0c03c82021-04-23 21:01:34 +0200416 && col < pum_col + pum_width + pum_scrollbar;
Bram Moolenaarae654382019-01-17 21:09:05 +0100417}
418
419/*
glepnir40c1c332024-06-11 19:37:04 +0200420 * displays text on the popup menu with specific attributes.
421 */
422 static void
423pum_screen_put_with_attr(int row, int col, char_u *text, int textlen, int attr)
424{
425 int i;
426 int leader_len;
427 int char_len;
428 int cells;
429 int new_attr;
430 char_u *rt_leader = NULL;
431 char_u *match_leader = NULL;
432 char_u *ptr = text;
433 garray_T *ga = NULL;
434 char_u *leader = ins_compl_leader();
435 int in_fuzzy = (get_cot_flags() & COT_FUZZY) != 0;
436
437 if ((highlight_attr[HLF_PMSI] == highlight_attr[HLF_PSI] &&
438 highlight_attr[HLF_PMNI] == highlight_attr[HLF_PNI]))
439 {
440 screen_puts_len(text, textlen, row, col, attr);
441 return;
442 }
443
444#ifdef FEAT_RIGHTLEFT
445 if (leader != NULL && curwin->w_p_rl)
446 rt_leader = reverse_text(leader);
447#endif
448 match_leader = rt_leader != NULL ? rt_leader : leader;
449 leader_len = match_leader ? (int)STRLEN(match_leader) : 0;
450
451 if (match_leader != NULL && leader_len > 0 && in_fuzzy)
452 ga = fuzzy_match_str_with_pos(text, match_leader);
453
454 // Render text with proper attributes
455 while (*ptr != NUL && ptr < text + textlen)
456 {
457 char_len = mb_ptr2len(ptr);
458 cells = mb_ptr2cells(ptr);
459 new_attr = attr;
460
461 if (ga != NULL)
462 {
463 // Handle fuzzy matching
464 for (i = 0; i < ga->ga_len; i++)
465 {
zeertzjq2f95ca92024-06-13 17:14:27 +0200466 int_u *match_pos = ((int_u *)ga->ga_data) + i;
467 int_u actual_char_pos = 0;
glepnir40c1c332024-06-11 19:37:04 +0200468 char_u *temp_ptr = text;
469 while (temp_ptr < ptr)
470 {
471 temp_ptr += mb_ptr2len(temp_ptr);
472 actual_char_pos++;
473 }
474 if (actual_char_pos == match_pos[0])
475 {
476 new_attr = highlight_attr[(attr == highlight_attr[HLF_PSI]
477 ? HLF_PMSI : HLF_PMNI)];
478 break;
479 }
480 }
481 }
482 else if (!in_fuzzy && (ptr - text < leader_len) &&
483 (STRNCMP(text, match_leader, leader_len) == 0))
484 new_attr = highlight_attr[(attr == highlight_attr[HLF_PSI]
485 ? HLF_PMSI : HLF_PMNI)];
486
487 screen_puts_len(ptr, char_len, row, col, new_attr);
488 col += cells;
489 ptr += char_len;
490 }
491
492 if (ga != NULL)
493 {
494 ga_clear(ga);
495 vim_free(ga);
496 }
497 if (rt_leader)
498 vim_free(rt_leader);
499}
500
501/*
Bram Moolenaar4b779472005-10-04 09:12:31 +0000502 * Redraw the popup menu, using "pum_first" and "pum_selected".
503 */
504 void
Bram Moolenaar05540972016-01-30 20:31:25 +0100505pum_redraw(void)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000506{
507 int row = pum_row;
508 int col;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000509 int attr_scroll = highlight_attr[HLF_PSB];
510 int attr_thumb = highlight_attr[HLF_PST];
511 int attr;
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000512 int *attrs; // array used for highlights
Bram Moolenaar4b779472005-10-04 09:12:31 +0000513 int i;
514 int idx;
515 char_u *s;
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000516 char_u *p = NULL;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000517 int totwidth, width, w;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000518 int thumb_pos = 0;
Bram Moolenaarbdace832019-03-02 10:13:42 +0100519 int thumb_height = 1;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000520 int round;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000521 int n;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000522
Bram Moolenaare638acc2023-03-15 17:08:51 +0000523 int attrsNorm[3];
524 int attrsSel[3];
525 // "word"
526 attrsNorm[0] = highlight_attr[HLF_PNI];
527 attrsSel[0] = highlight_attr[HLF_PSI];
528 // "kind"
529 attrsNorm[1] = highlight_attr[HLF_PNK];
530 attrsSel[1] = highlight_attr[HLF_PSK];
531 // "extra text"
532 attrsNorm[2] = highlight_attr[HLF_PNX];
533 attrsSel[2] = highlight_attr[HLF_PSX];
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000534
Bram Moolenaarae654382019-01-17 21:09:05 +0100535 if (call_update_screen)
536 {
537 call_update_screen = FALSE;
Bram Moolenaar04357fb2019-12-10 21:50:56 +0100538 // Do not redraw in pum_may_redraw() and don't draw in the area where
539 // the popup menu will be.
540 pum_will_redraw = TRUE;
Bram Moolenaarae654382019-01-17 21:09:05 +0100541 update_screen(0);
Bram Moolenaar04357fb2019-12-10 21:50:56 +0100542 pum_will_redraw = FALSE;
Bram Moolenaarae654382019-01-17 21:09:05 +0100543 }
544
545 // never display more than we have
Bram Moolenaar4c1e6262013-11-06 04:04:33 +0100546 if (pum_first > pum_size - pum_height)
547 pum_first = pum_size - pum_height;
548
Bram Moolenaar4b779472005-10-04 09:12:31 +0000549 if (pum_scrollbar)
550 {
Bram Moolenaarbdace832019-03-02 10:13:42 +0100551 thumb_height = pum_height * pum_height / pum_size;
552 if (thumb_height == 0)
553 thumb_height = 1;
554 thumb_pos = (pum_first * (pum_height - thumb_height)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000555 + (pum_size - pum_height) / 2)
556 / (pum_size - pum_height);
557 }
558
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100559#ifdef FEAT_PROP_POPUP
Bram Moolenaar33796b32019-06-08 16:01:13 +0200560 // The popup menu is drawn over popup menus with zindex under
561 // POPUPMENU_ZINDEX.
562 screen_zindex = POPUPMENU_ZINDEX;
563#endif
564
Bram Moolenaar4b779472005-10-04 09:12:31 +0000565 for (i = 0; i < pum_height; ++i)
566 {
567 idx = i + pum_first;
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000568 attrs = (idx == pum_selected) ? attrsSel : attrsNorm;
569 attr = attrs[0]; // start with "word" highlight
Bram Moolenaar4b779472005-10-04 09:12:31 +0000570
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100571 // prepend a space if there is room
Bram Moolenaarabc97732007-08-08 20:49:37 +0000572#ifdef FEAT_RIGHTLEFT
573 if (curwin->w_p_rl)
574 {
Bram Moolenaar02631462017-09-22 15:20:32 +0200575 if (pum_col < curwin->w_wincol + curwin->w_width - 1)
Bram Moolenaarabc97732007-08-08 20:49:37 +0000576 screen_putchar(' ', row, pum_col + 1, attr);
577 }
578 else
579#endif
580 if (pum_col > 0)
581 screen_putchar(' ', row, pum_col - 1, attr);
Bram Moolenaar4b779472005-10-04 09:12:31 +0000582
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100583 // Display each entry, use two spaces for a Tab.
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000584 // Do this 3 times:
585 // 0 - main text
586 // 1 - kind
587 // 2 - extra info
Bram Moolenaar4b779472005-10-04 09:12:31 +0000588 col = pum_col;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000589 totwidth = 0;
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000590 for (round = 0; round < 3; ++round)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000591 {
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000592 attr = attrs[round];
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000593 width = 0;
594 s = NULL;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000595 switch (round)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000596 {
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000597 case 0: p = pum_array[idx].pum_text; break;
598 case 1: p = pum_array[idx].pum_kind; break;
599 case 2: p = pum_array[idx].pum_extra; break;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000600 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000601 if (p != NULL)
Bram Moolenaar91acfff2017-03-12 19:22:36 +0100602 for ( ; ; MB_PTR_ADV(p))
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000603 {
604 if (s == NULL)
605 s = p;
606 w = ptr2cells(p);
607 if (*p == NUL || *p == TAB || totwidth + w > pum_width)
608 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100609 // Display the text that fits or comes before a Tab.
610 // First convert it to printable characters.
Bram Moolenaarabc97732007-08-08 20:49:37 +0000611 char_u *st;
612 int saved = *p;
Bram Moolenaar7cc36e92007-03-27 10:42:05 +0000613
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +0100614 if (saved != NUL)
615 *p = NUL;
Bram Moolenaar7cc36e92007-03-27 10:42:05 +0000616 st = transstr(s);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +0100617 if (saved != NUL)
618 *p = saved;
Bram Moolenaarabc97732007-08-08 20:49:37 +0000619#ifdef FEAT_RIGHTLEFT
620 if (curwin->w_p_rl)
Bram Moolenaar7cc36e92007-03-27 10:42:05 +0000621 {
Bram Moolenaarabc97732007-08-08 20:49:37 +0000622 if (st != NULL)
623 {
624 char_u *rt = reverse_text(st);
Bram Moolenaarabc97732007-08-08 20:49:37 +0000625
626 if (rt != NULL)
627 {
Bram Moolenaard836bb92010-01-19 18:06:03 +0100628 char_u *rt_start = rt;
629 int size;
630
631 size = vim_strsize(rt);
632 if (size > pum_width)
Bram Moolenaarabc97732007-08-08 20:49:37 +0000633 {
Bram Moolenaard836bb92010-01-19 18:06:03 +0100634 do
635 {
636 size -= has_mbyte
637 ? (*mb_ptr2cells)(rt) : 1;
Bram Moolenaar91acfff2017-03-12 19:22:36 +0100638 MB_PTR_ADV(rt);
Bram Moolenaard836bb92010-01-19 18:06:03 +0100639 } while (size > pum_width);
640
641 if (size < pum_width)
642 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100643 // Most left character requires
644 // 2-cells but only 1 cell is
645 // available on screen. Put a
646 // '<' on the left of the pum
647 // item
Bram Moolenaard836bb92010-01-19 18:06:03 +0100648 *(--rt) = '<';
649 size++;
650 }
Bram Moolenaarabc97732007-08-08 20:49:37 +0000651 }
glepnir40c1c332024-06-11 19:37:04 +0200652 pum_screen_put_with_attr(row, col -size + 1, rt, (int)STRLEN(rt), attr);
Bram Moolenaard836bb92010-01-19 18:06:03 +0100653 vim_free(rt_start);
Bram Moolenaarabc97732007-08-08 20:49:37 +0000654 }
655 vim_free(st);
656 }
657 col -= width;
Bram Moolenaar7cc36e92007-03-27 10:42:05 +0000658 }
Bram Moolenaarabc97732007-08-08 20:49:37 +0000659 else
660#endif
661 {
662 if (st != NULL)
663 {
Bram Moolenaar714cbe52020-11-16 19:12:00 +0100664 int size = (int)STRLEN(st);
665 int cells = (*mb_string2cells)(st, size);
666
667 // only draw the text that fits
668 while (size > 0
669 && col + cells > pum_width + pum_col)
670 {
671 --size;
672 if (has_mbyte)
673 {
674 size -= (*mb_head_off)(st, st + size);
675 cells -= (*mb_ptr2cells)(st + size);
676 }
677 else
678 --cells;
679 }
glepnir40c1c332024-06-11 19:37:04 +0200680 pum_screen_put_with_attr(row, col, st, size, attr);
Bram Moolenaarabc97732007-08-08 20:49:37 +0000681 vim_free(st);
682 }
683 col += width;
684 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000685
686 if (*p != TAB)
687 break;
688
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100689 // Display two spaces for a Tab.
Bram Moolenaarabc97732007-08-08 20:49:37 +0000690#ifdef FEAT_RIGHTLEFT
691 if (curwin->w_p_rl)
692 {
693 screen_puts_len((char_u *)" ", 2, row, col - 1,
694 attr);
695 col -= 2;
696 }
697 else
698#endif
699 {
700 screen_puts_len((char_u *)" ", 2, row, col, attr);
701 col += 2;
702 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000703 totwidth += 2;
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100704 s = NULL; // start text at next char
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000705 width = 0;
706 }
707 else
708 width += w;
709 }
710
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000711 if (round > 0)
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000712 n = pum_kind_width + 1;
713 else
714 n = 1;
715
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100716 // Stop when there is nothing more to display.
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +0000717 if (round == 2
718 || (round == 1 && pum_array[idx].pum_extra == NULL)
719 || (round == 0 && pum_array[idx].pum_kind == NULL
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000720 && pum_array[idx].pum_extra == NULL)
721 || pum_base_width + n >= pum_width)
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000722 break;
Bram Moolenaarabc97732007-08-08 20:49:37 +0000723#ifdef FEAT_RIGHTLEFT
724 if (curwin->w_p_rl)
725 {
726 screen_fill(row, row + 1, pum_col - pum_base_width - n + 1,
727 col + 1, ' ', ' ', attr);
728 col = pum_col - pum_base_width - n + 1;
729 }
730 else
731#endif
732 {
733 screen_fill(row, row + 1, col, pum_col + pum_base_width + n,
Bram Moolenaar8b6144b2006-02-08 09:20:24 +0000734 ' ', ' ', attr);
Bram Moolenaarabc97732007-08-08 20:49:37 +0000735 col = pum_col + pum_base_width + n;
736 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000737 totwidth = pum_base_width + n;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000738 }
739
Bram Moolenaarabc97732007-08-08 20:49:37 +0000740#ifdef FEAT_RIGHTLEFT
741 if (curwin->w_p_rl)
742 screen_fill(row, row + 1, pum_col - pum_width + 1, col + 1, ' ',
743 ' ', attr);
744 else
745#endif
746 screen_fill(row, row + 1, col, pum_col + pum_width, ' ', ' ',
747 attr);
Bram Moolenaar4b779472005-10-04 09:12:31 +0000748 if (pum_scrollbar > 0)
Bram Moolenaarabc97732007-08-08 20:49:37 +0000749 {
750#ifdef FEAT_RIGHTLEFT
751 if (curwin->w_p_rl)
752 screen_putchar(' ', row, pum_col - pum_width,
Bram Moolenaarbdace832019-03-02 10:13:42 +0100753 i >= thumb_pos && i < thumb_pos + thumb_height
Bram Moolenaar4b779472005-10-04 09:12:31 +0000754 ? attr_thumb : attr_scroll);
Bram Moolenaarabc97732007-08-08 20:49:37 +0000755 else
756#endif
757 screen_putchar(' ', row, pum_col + pum_width,
Bram Moolenaarbdace832019-03-02 10:13:42 +0100758 i >= thumb_pos && i < thumb_pos + thumb_height
Bram Moolenaarabc97732007-08-08 20:49:37 +0000759 ? attr_thumb : attr_scroll);
760 }
Bram Moolenaar4b779472005-10-04 09:12:31 +0000761
762 ++row;
763 }
Bram Moolenaar33796b32019-06-08 16:01:13 +0200764
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100765#ifdef FEAT_PROP_POPUP
Bram Moolenaar33796b32019-06-08 16:01:13 +0200766 screen_zindex = 0;
767#endif
Bram Moolenaar4b779472005-10-04 09:12:31 +0000768}
769
Bram Moolenaar5a4c3082019-12-01 15:23:11 +0100770#if (defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)) || defined(PROTO)
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200771/*
772 * Position the info popup relative to the popup menu item.
773 */
774 void
775pum_position_info_popup(win_T *wp)
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200776{
Bram Moolenaar202c3f72019-11-21 12:12:35 +0100777 int col = pum_col + pum_width + pum_scrollbar + 1;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200778 int row = pum_row;
779 int botpos = POPPOS_BOTLEFT;
Bram Moolenaarde2396f2020-07-18 21:40:41 +0200780 int used_maxwidth_opt = FALSE;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200781
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200782 wp->w_popup_pos = POPPOS_TOPLEFT;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200783 if (Columns - col < 20 && Columns - col < pum_col)
784 {
785 col = pum_col - 1;
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200786 wp->w_popup_pos = POPPOS_TOPRIGHT;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200787 botpos = POPPOS_BOTRIGHT;
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200788 wp->w_maxwidth = pum_col - 1;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200789 }
790 else
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200791 wp->w_maxwidth = Columns - col + 1;
792 wp->w_maxwidth -= popup_extra_width(wp);
Bram Moolenaarde2396f2020-07-18 21:40:41 +0200793 if (wp->w_maxwidth_opt > 0 && wp->w_maxwidth > wp->w_maxwidth_opt)
794 {
795 // option value overrules computed value
796 wp->w_maxwidth = wp->w_maxwidth_opt;
797 used_maxwidth_opt = TRUE;
798 }
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200799
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200800 row -= popup_top_extra(wp);
801 if (wp->w_popup_flags & POPF_INFO_MENU)
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200802 {
803 if (pum_row < pum_win_row)
804 {
805 // menu above cursor line, align with bottom
806 row += pum_height;
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200807 wp->w_popup_pos = botpos;
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200808 }
809 else
810 // menu below cursor line, align with top
811 row += 1;
812 }
813 else
814 // align with the selected item
815 row += pum_selected - pum_first + 1;
816
Bram Moolenaarbef93ac2019-12-06 20:17:35 +0100817 wp->w_popup_flags &= ~POPF_HIDDEN;
Bram Moolenaarde2396f2020-07-18 21:40:41 +0200818 if (wp->w_maxwidth < 10 && !used_maxwidth_opt)
Bram Moolenaarbef93ac2019-12-06 20:17:35 +0100819 // The popup is not going to fit or will overlap with the cursor
820 // position, hide the popup.
821 wp->w_popup_flags |= POPF_HIDDEN;
822 else
823 popup_set_wantpos_rowcol(wp, row, col);
Bram Moolenaarc1f87c92019-08-21 19:33:16 +0200824}
825#endif
826
Bram Moolenaar4b779472005-10-04 09:12:31 +0000827/*
828 * Set the index of the currently selected item. The menu will scroll when
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000829 * necessary. When "n" is out of range don't scroll.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000830 * This may be repeated when the preview window is used:
831 * "repeat" == 0: open preview window normally
832 * "repeat" == 1: open preview window but don't set the size
833 * "repeat" == 2: don't open preview window
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000834 * Returns TRUE when the window was resized and the location of the popup menu
835 * must be recomputed.
Bram Moolenaar4b779472005-10-04 09:12:31 +0000836 */
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000837 static int
Bram Moolenaar9cb698d2019-08-21 15:30:45 +0200838pum_set_selected(int n, int repeat UNUSED)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000839{
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000840 int resized = FALSE;
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000841 int context = pum_height / 2;
Bram Moolenaareaf35242019-08-20 23:14:15 +0200842#ifdef FEAT_QUICKFIX
Bram Moolenaarf0bc15c2019-08-18 19:23:45 +0200843 int prev_selected = pum_selected;
zeertzjq529b9ad2024-06-05 20:27:06 +0200844 unsigned cur_cot_flags = get_cot_flags();
Bram Moolenaareaf35242019-08-20 23:14:15 +0200845#endif
Bram Moolenaar5a4c3082019-12-01 15:23:11 +0100846#if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200847 int has_info = FALSE;
848#endif
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000849
Bram Moolenaar4b779472005-10-04 09:12:31 +0000850 pum_selected = n;
851
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000852 if (pum_selected >= 0 && pum_selected < pum_size)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000853 {
Bram Moolenaare3226be2005-12-18 22:10:00 +0000854 if (pum_first > pum_selected - 4)
855 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100856 // scroll down; when we did a jump it's probably a PageUp then
857 // scroll a whole page
Bram Moolenaare3226be2005-12-18 22:10:00 +0000858 if (pum_first > pum_selected - 2)
859 {
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000860 pum_first -= pum_height - 2;
Bram Moolenaare3226be2005-12-18 22:10:00 +0000861 if (pum_first < 0)
862 pum_first = 0;
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000863 else if (pum_first > pum_selected)
864 pum_first = pum_selected;
Bram Moolenaare3226be2005-12-18 22:10:00 +0000865 }
866 else
867 pum_first = pum_selected;
868 }
869 else if (pum_first < pum_selected - pum_height + 5)
870 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100871 // scroll up; when we did a jump it's probably a PageDown then
872 // scroll a whole page
Bram Moolenaare3226be2005-12-18 22:10:00 +0000873 if (pum_first < pum_selected - pum_height + 1 + 2)
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000874 {
875 pum_first += pum_height - 2;
876 if (pum_first < pum_selected - pum_height + 1)
877 pum_first = pum_selected - pum_height + 1;
878 }
Bram Moolenaare3226be2005-12-18 22:10:00 +0000879 else
880 pum_first = pum_selected - pum_height + 1;
881 }
Bram Moolenaar4b779472005-10-04 09:12:31 +0000882
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100883 // Give a few lines of context when possible.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000884 if (context > 3)
885 context = 3;
886 if (pum_height > 2)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000887 {
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000888 if (pum_first > pum_selected - context)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000889 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100890 // scroll down
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000891 pum_first = pum_selected - context;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000892 if (pum_first < 0)
893 pum_first = 0;
894 }
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000895 else if (pum_first < pum_selected + context - pum_height + 1)
Bram Moolenaar4b779472005-10-04 09:12:31 +0000896 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +0100897 // scroll up
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000898 pum_first = pum_selected + context - pum_height + 1;
Bram Moolenaar4b779472005-10-04 09:12:31 +0000899 }
900 }
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200901 // adjust for the number of lines displayed
902 if (pum_first > pum_size - pum_height)
903 pum_first = pum_size - pum_height;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000904
Bram Moolenaar4033c552017-09-16 20:54:51 +0200905#if defined(FEAT_QUICKFIX)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000906 /*
907 * Show extra info in the preview window if there is something and
Bram Moolenaar202c3f72019-11-21 12:12:35 +0100908 * 'completeopt' contains "preview" or "popup" or "popuphidden".
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000909 * Skip this when tried twice already.
910 * Skip this also when there is not much room.
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000911 * NOTE: Be very careful not to sync undo!
912 */
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000913 if (pum_array[pum_selected].pum_info != NULL
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000914 && Rows > 10
915 && repeat <= 1
zeertzjq529b9ad2024-06-05 20:27:06 +0200916 && (cur_cot_flags & COT_ANY_PREVIEW))
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000917 {
918 win_T *curwin_save = curwin;
Bram Moolenaar9ad89c62017-10-26 22:04:04 +0200919 tabpage_T *curtab_save = curtab;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100920# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200921 use_popup_T use_popup;
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200922# else
Bram Moolenaara2c2ae42019-11-30 20:58:46 +0100923# define use_popup USEPOPUP_NONE
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200924# endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100925# ifdef FEAT_PROP_POPUP
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200926 has_info = TRUE;
zeertzjq529b9ad2024-06-05 20:27:06 +0200927 if (cur_cot_flags & COT_POPUPHIDDEN)
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200928 use_popup = USEPOPUP_HIDDEN;
zeertzjq529b9ad2024-06-05 20:27:06 +0200929 else if (cur_cot_flags & COT_POPUP)
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200930 use_popup = USEPOPUP_NORMAL;
931 else
932 use_popup = USEPOPUP_NONE;
Bram Moolenaar2dfae042020-11-15 14:09:37 +0100933 if (use_popup != USEPOPUP_NONE)
934 // don't use WinEnter or WinLeave autocommands for the info
935 // popup
936 block_autocmds();
Bram Moolenaard570ab92019-09-03 23:20:05 +0200937# endif
Bram Moolenaardca7abe2019-10-20 18:17:57 +0200938 // Open a preview window and set "curwin" to it.
939 // 3 lines by default, prefer 'previewheight' if set and smaller.
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000940 g_do_tagpreview = 3;
Bram Moolenaaree236d02010-10-27 17:11:15 +0200941 if (p_pvh > 0 && p_pvh < g_do_tagpreview)
942 g_do_tagpreview = p_pvh;
Bram Moolenaarc8045152014-07-09 19:58:24 +0200943 ++RedrawingDisabled;
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200944 // Prevent undo sync here, if an autocommand syncs undo weird
945 // things can happen to the undo tree.
Bram Moolenaare7d13762015-10-30 14:23:33 +0100946 ++no_u_sync;
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200947 resized = prepare_tagpreview(FALSE, FALSE, use_popup);
Bram Moolenaare7d13762015-10-30 14:23:33 +0100948 --no_u_sync;
Bram Moolenaar79cdf022023-05-20 14:07:00 +0100949 if (RedrawingDisabled > 0)
950 --RedrawingDisabled;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000951 g_do_tagpreview = 0;
952
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200953 if (curwin->w_p_pvw
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100954# ifdef FEAT_PROP_POPUP
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200955 || (curwin->w_popup_flags & POPF_INFO)
956# endif
957 )
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000958 {
mathew20f61d92023-08-26 18:11:02 +0200959 int res = OK;
960
Bram Moolenaar50e53762016-10-27 14:49:15 +0200961 if (!resized
962 && curbuf->b_nwindows == 1
963 && curbuf->b_fname == NULL
Bram Moolenaar26910de2019-06-15 19:37:15 +0200964 && bt_nofile(curbuf)
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000965 && curbuf->b_p_bh[0] == 'w')
966 {
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200967 // Already a "wipeout" buffer, make it empty.
Bram Moolenaarb5aedf32017-03-12 18:23:53 +0100968 while (!BUFEMPTY())
Bram Moolenaarca70c072020-05-30 20:30:46 +0200969 ml_delete((linenr_T)1);
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000970 }
Bram Moolenaar779b74b2006-04-10 14:55:34 +0000971 else
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000972 {
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200973 // Don't want to sync undo in the current buffer.
Bram Moolenaar779b74b2006-04-10 14:55:34 +0000974 ++no_u_sync;
Bram Moolenaar701f7af2008-11-15 13:12:07 +0000975 res = do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, 0, NULL);
Bram Moolenaar779b74b2006-04-10 14:55:34 +0000976 --no_u_sync;
977 if (res == OK)
978 {
Bram Moolenaar576a4a62019-08-18 15:25:17 +0200979 // Edit a new, empty buffer. Set options for a "wipeout"
980 // buffer.
Bram Moolenaar31e5c602022-04-15 13:53:33 +0100981 set_option_value_give_err((char_u *)"swf",
982 0L, NULL, OPT_LOCAL);
983 set_option_value_give_err((char_u *)"bl",
984 0L, NULL, OPT_LOCAL);
985 set_option_value_give_err((char_u *)"bt",
986 0L, (char_u *)"nofile", OPT_LOCAL);
987 set_option_value_give_err((char_u *)"bh",
988 0L, (char_u *)"wipe", OPT_LOCAL);
989 set_option_value_give_err((char_u *)"diff",
990 0L, NULL, OPT_LOCAL);
Bram Moolenaar779b74b2006-04-10 14:55:34 +0000991 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +0000992 }
993 if (res == OK)
994 {
995 char_u *p, *e;
996 linenr_T lnum = 0;
997
998 for (p = pum_array[pum_selected].pum_info; *p != NUL; )
999 {
1000 e = vim_strchr(p, '\n');
1001 if (e == NULL)
1002 {
1003 ml_append(lnum++, p, 0, FALSE);
1004 break;
1005 }
mathewc51fa7b2023-08-23 20:55:17 +02001006 *e = NUL;
1007 ml_append(lnum++, p, (int)(e - p + 1), FALSE);
1008 *e = '\n';
1009 p = e + 1;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001010 }
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001011 // delete the empty last line
Bram Moolenaarca70c072020-05-30 20:30:46 +02001012 ml_delete(curbuf->b_ml.ml_line_count);
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001013
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001014 // Increase the height of the preview window to show the
1015 // text, but no more than 'previewheight' lines.
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001016 if (repeat == 0 && use_popup == USEPOPUP_NONE)
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001017 {
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001018 if (lnum > p_pvh)
1019 lnum = p_pvh;
1020 if (curwin->w_height < lnum)
1021 {
1022 win_setheight((int)lnum);
1023 resized = TRUE;
1024 }
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001025 }
1026
1027 curbuf->b_changed = 0;
1028 curbuf->b_p_ma = FALSE;
Bram Moolenaarf0bc15c2019-08-18 19:23:45 +02001029 if (pum_selected != prev_selected)
1030 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001031# ifdef FEAT_PROP_POPUP
Bram Moolenaarf0bc15c2019-08-18 19:23:45 +02001032 curwin->w_firstline = 1;
1033# endif
1034 curwin->w_topline = 1;
1035 }
1036 else if (curwin->w_topline > curbuf->b_ml.ml_line_count)
1037 curwin->w_topline = curbuf->b_ml.ml_line_count;
1038 curwin->w_cursor.lnum = curwin->w_topline;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001039 curwin->w_cursor.col = 0;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001040# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001041 if (use_popup != USEPOPUP_NONE)
Bram Moolenaarc1f87c92019-08-21 19:33:16 +02001042 {
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001043 pum_position_info_popup(curwin);
Bram Moolenaarc1f87c92019-08-21 19:33:16 +02001044 if (win_valid(curwin_save))
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001045 redraw_win_later(curwin_save, UPD_SOME_VALID);
Bram Moolenaarc1f87c92019-08-21 19:33:16 +02001046 }
1047# endif
Bram Moolenaar9ad89c62017-10-26 22:04:04 +02001048 if ((curwin != curwin_save && win_valid(curwin_save))
1049 || (curtab != curtab_save
1050 && valid_tabpage(curtab_save)))
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001051 {
Bram Moolenaarb80d2fb2021-04-27 20:06:57 +02001052 int save_redr_status;
1053
Bram Moolenaar9ad89c62017-10-26 22:04:04 +02001054 if (curtab != curtab_save && valid_tabpage(curtab_save))
1055 goto_tabpage_tp(curtab_save, FALSE, FALSE);
1056
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001057 // When the first completion is done and the preview
1058 // window is not resized, skip the preview window's
1059 // status line redrawing.
Bram Moolenaar2bace3e2014-07-23 21:10:43 +02001060 if (ins_compl_active() && !resized)
1061 curwin->w_redr_status = FALSE;
1062
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001063 // Return cursor to where we were
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001064 validate_cursor();
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001065 redraw_later(UPD_SOME_VALID);
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001066
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001067 // When the preview window was resized we need to
1068 // update the view on the buffer. Only go back to
1069 // the window when needed, otherwise it will always be
Bram Moolenaar5e5a98d2019-12-15 14:55:33 +01001070 // redrawn.
Bram Moolenaar5dd143e2019-08-15 21:34:34 +02001071 if (resized && win_valid(curwin_save))
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001072 {
Bram Moolenaare7d13762015-10-30 14:23:33 +01001073 ++no_u_sync;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001074 win_enter(curwin_save, TRUE);
Bram Moolenaare7d13762015-10-30 14:23:33 +01001075 --no_u_sync;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001076 update_topline();
1077 }
1078
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001079 // Update the screen before drawing the popup menu.
1080 // Enable updating the status lines.
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001081 pum_pretend_not_visible = TRUE;
Bram Moolenaarb80d2fb2021-04-27 20:06:57 +02001082
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001083 // But don't draw text at the new popup menu position,
Bram Moolenaar5e5a98d2019-12-15 14:55:33 +01001084 // it causes flicker. When resizing we need to draw
1085 // anyway, the position may change later.
Bram Moolenaarb80d2fb2021-04-27 20:06:57 +02001086 // Also do not redraw the status line of the original
1087 // current window here, to avoid it gets drawn with
1088 // StatusLineNC for a moment and cause flicker.
Bram Moolenaar5e5a98d2019-12-15 14:55:33 +01001089 pum_will_redraw = !resized;
Bram Moolenaarb80d2fb2021-04-27 20:06:57 +02001090 save_redr_status = curwin_save->w_redr_status;
1091 curwin_save->w_redr_status = FALSE;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001092 update_screen(0);
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001093 pum_pretend_not_visible = FALSE;
1094 pum_will_redraw = FALSE;
Bram Moolenaarb80d2fb2021-04-27 20:06:57 +02001095 curwin_save->w_redr_status = save_redr_status;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001096
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00001097 if (!resized && win_valid(curwin_save))
Bram Moolenaare7d13762015-10-30 14:23:33 +01001098 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001099# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001100 win_T *wp = curwin;
1101# endif
Bram Moolenaare7d13762015-10-30 14:23:33 +01001102 ++no_u_sync;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001103 win_enter(curwin_save, TRUE);
Bram Moolenaare7d13762015-10-30 14:23:33 +01001104 --no_u_sync;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001105# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001106 if (use_popup == USEPOPUP_HIDDEN && win_valid(wp))
1107 popup_hide(wp);
1108# endif
Bram Moolenaare7d13762015-10-30 14:23:33 +01001109 }
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001110
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001111 // May need to update the screen again when there are
1112 // autocommands involved.
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001113 pum_pretend_not_visible = TRUE;
Bram Moolenaar5e5a98d2019-12-15 14:55:33 +01001114 pum_will_redraw = !resized;
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001115 update_screen(0);
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001116 pum_pretend_not_visible = FALSE;
1117 pum_will_redraw = FALSE;
Bram Moolenaarae654382019-01-17 21:09:05 +01001118 call_update_screen = FALSE;
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001119 }
1120 }
1121 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001122# if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaar5dd143e2019-08-15 21:34:34 +02001123 if (WIN_IS_POPUP(curwin))
1124 // can't keep focus in a popup window
1125 win_enter(firstwin, TRUE);
1126# endif
Bram Moolenaar2dfae042020-11-15 14:09:37 +01001127# ifdef FEAT_PROP_POPUP
1128 if (use_popup != USEPOPUP_NONE)
1129 unblock_autocmds();
1130# endif
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001131 }
1132#endif
Bram Moolenaar4b779472005-10-04 09:12:31 +00001133 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001134#if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001135 if (!has_info)
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02001136 // hide any popup info window
1137 popup_hide_info();
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001138#endif
Bram Moolenaar4b779472005-10-04 09:12:31 +00001139
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001140 return resized;
Bram Moolenaar4b779472005-10-04 09:12:31 +00001141}
1142
1143/*
1144 * Undisplay the popup menu (later).
1145 */
1146 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001147pum_undisplay(void)
Bram Moolenaar4b779472005-10-04 09:12:31 +00001148{
1149 pum_array = NULL;
Bram Moolenaara4d158b2022-08-14 14:17:45 +01001150 redraw_all_later(UPD_NOT_VALID);
Bram Moolenaar2d694602006-08-22 19:48:48 +00001151 redraw_tabline = TRUE;
Luuk van Baaldcd40cf2023-04-23 16:24:08 +01001152 if (pum_in_cmdline)
1153 {
1154 clear_cmdline = TRUE;
1155 pum_in_cmdline = FALSE;
1156 }
Bram Moolenaar1f4d4de2006-03-14 23:00:46 +00001157 status_redraw_all();
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001158#if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02001159 // hide any popup info window
1160 popup_hide_info();
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001161#endif
Bram Moolenaar4b779472005-10-04 09:12:31 +00001162}
1163
1164/*
1165 * Clear the popup menu. Currently only resets the offset to the first
1166 * displayed item.
1167 */
1168 void
Bram Moolenaar05540972016-01-30 20:31:25 +01001169pum_clear(void)
Bram Moolenaar4b779472005-10-04 09:12:31 +00001170{
1171 pum_first = 0;
1172}
1173
1174/*
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001175 * Return TRUE if the popup menu is displayed. Used to avoid some redrawing
1176 * that could overwrite it. Overruled when "pum_pretend_not_visible" is set,
1177 * used to redraw the status lines.
Bram Moolenaar4b779472005-10-04 09:12:31 +00001178 */
1179 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001180pum_visible(void)
Bram Moolenaar4b779472005-10-04 09:12:31 +00001181{
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001182 return !pum_pretend_not_visible && pum_array != NULL;
Bram Moolenaar4b779472005-10-04 09:12:31 +00001183}
1184
Bram Moolenaare3226be2005-12-18 22:10:00 +00001185/*
Bram Moolenaare0c03c82021-04-23 21:01:34 +02001186 * Return TRUE if the popup can be redrawn in the same position.
1187 */
1188 static int
1189pum_in_same_position(void)
1190{
1191 return pum_window != curwin
1192 || (pum_win_row == curwin->w_wrow + W_WINROW(curwin)
1193 && pum_win_height == curwin->w_height
1194 && pum_win_col == curwin->w_wincol
1195 && pum_win_width == curwin->w_width);
1196}
1197
1198/*
1199 * Return TRUE when pum_may_redraw() will call pum_redraw().
1200 * This means that the pum area should not be overwritten to avoid flicker.
1201 */
1202 int
1203pum_redraw_in_same_position(void)
1204{
1205 if (!pum_visible() || pum_will_redraw)
1206 return FALSE; // nothing to do
1207
1208 return pum_in_same_position();
1209}
1210
1211/*
Bram Moolenaar491ac282018-06-17 14:47:55 +02001212 * Reposition the popup menu to adjust for window layout changes.
1213 */
1214 void
1215pum_may_redraw(void)
1216{
1217 pumitem_T *array = pum_array;
1218 int len = pum_size;
1219 int selected = pum_selected;
1220
Bram Moolenaar04357fb2019-12-10 21:50:56 +01001221 if (!pum_visible() || pum_will_redraw)
Bram Moolenaar491ac282018-06-17 14:47:55 +02001222 return; // nothing to do
1223
Bram Moolenaare0c03c82021-04-23 21:01:34 +02001224 if (pum_in_same_position())
Bram Moolenaar491ac282018-06-17 14:47:55 +02001225 {
1226 // window position didn't change, redraw in the same position
1227 pum_redraw();
1228 }
1229 else
1230 {
1231 int wcol = curwin->w_wcol;
1232
1233 // Window layout changed, recompute the position.
1234 // Use the remembered w_wcol value, the cursor may have moved when a
1235 // completion was inserted, but we want the menu in the same position.
1236 pum_undisplay();
1237 curwin->w_wcol = pum_win_wcol;
1238 curwin->w_valid |= VALID_WCOL;
1239 pum_display(array, len, selected);
1240 curwin->w_wcol = wcol;
1241 }
1242}
1243
1244/*
Bram Moolenaare3226be2005-12-18 22:10:00 +00001245 * Return the height of the popup menu, the number of entries visible.
1246 * Only valid when pum_visible() returns TRUE!
1247 */
1248 int
Bram Moolenaar05540972016-01-30 20:31:25 +01001249pum_get_height(void)
Bram Moolenaare3226be2005-12-18 22:10:00 +00001250{
1251 return pum_height;
1252}
1253
Bram Moolenaar9cb698d2019-08-21 15:30:45 +02001254#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaard7f246c2019-04-08 18:15:41 +02001255/*
1256 * Add size information about the pum to "dict".
1257 */
1258 void
1259pum_set_event_info(dict_T *dict)
1260{
1261 if (!pum_visible())
1262 return;
Bram Moolenaarc0300632020-03-16 20:07:16 +01001263 (void)dict_add_number(dict, "height", pum_height);
1264 (void)dict_add_number(dict, "width", pum_width);
1265 (void)dict_add_number(dict, "row", pum_row);
1266 (void)dict_add_number(dict, "col", pum_col);
1267 (void)dict_add_number(dict, "size", pum_size);
1268 (void)dict_add_bool(dict, "scrollbar",
1269 pum_scrollbar ? VVAL_TRUE : VVAL_FALSE);
Bram Moolenaard7f246c2019-04-08 18:15:41 +02001270}
Bram Moolenaar9cb698d2019-08-21 15:30:45 +02001271#endif
Bram Moolenaard7f246c2019-04-08 18:15:41 +02001272
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001273#if defined(FEAT_BEVAL_TERM) || defined(FEAT_TERM_POPUP_MENU) || defined(PROTO)
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001274 static void
1275pum_position_at_mouse(int min_width)
1276{
1277 if (Rows - mouse_row > pum_size)
1278 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001279 // Enough space below the mouse row.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001280 pum_row = mouse_row + 1;
1281 if (pum_height > Rows - pum_row)
1282 pum_height = Rows - pum_row;
Luuk van Baaldcd40cf2023-04-23 16:24:08 +01001283 if (pum_row + pum_height > cmdline_row)
1284 pum_in_cmdline = TRUE;
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001285 }
1286 else
1287 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001288 // Show above the mouse row, reduce height if it does not fit.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001289 pum_row = mouse_row - pum_size;
1290 if (pum_row < 0)
1291 {
1292 pum_height += pum_row;
1293 pum_row = 0;
1294 }
1295 }
1296 if (Columns - mouse_col >= pum_base_width
1297 || Columns - mouse_col > min_width)
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001298 // Enough space to show at mouse column.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001299 pum_col = mouse_col;
1300 else
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001301 // Not enough space, right align with window.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001302 pum_col = Columns - (pum_base_width > min_width
1303 ? min_width : pum_base_width);
1304
1305 pum_width = Columns - pum_col;
1306 if (pum_width > pum_base_width + 1)
1307 pum_width = pum_base_width + 1;
Bram Moolenaar0e6e1792018-06-17 17:10:59 +02001308
1309 // Do not redraw at cursor position.
1310 pum_window = NULL;
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001311}
1312
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001313#endif
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001314
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001315#if defined(FEAT_BEVAL_TERM) || defined(PROTO)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001316static pumitem_T *balloon_array = NULL;
1317static int balloon_arraysize;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001318
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001319# define BALLOON_MIN_WIDTH 50
1320# define BALLOON_MIN_HEIGHT 10
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001321
Bram Moolenaar246fe032017-11-19 19:56:27 +01001322typedef struct {
1323 char_u *start;
1324 int bytelen;
1325 int cells;
1326 int indent;
1327} balpart_T;
1328
1329/*
1330 * Split a string into parts to display in the balloon.
1331 * Aimed at output from gdb. Attempts to split at white space, preserve quoted
1332 * strings and make a struct look good.
1333 * Resulting array is stored in "array" and returns the size of the array.
1334 */
1335 int
1336split_message(char_u *mesg, pumitem_T **array)
1337{
1338 garray_T ga;
1339 char_u *p;
1340 balpart_T *item;
1341 int quoted = FALSE;
1342 int height;
1343 int line;
1344 int item_idx;
1345 int indent = 0;
1346 int max_cells = 0;
Bram Moolenaard1c1c822019-11-09 16:59:14 +01001347 int max_height = Rows / 2 - 1;
Bram Moolenaar246fe032017-11-19 19:56:27 +01001348 int long_item_count = 0;
1349 int split_long_items = FALSE;
1350
1351 ga_init2(&ga, sizeof(balpart_T), 20);
1352 p = mesg;
1353
1354 while (*p != NUL)
1355 {
1356 if (ga_grow(&ga, 1) == FAIL)
1357 goto failed;
1358 item = ((balpart_T *)ga.ga_data) + ga.ga_len;
1359 item->start = p;
1360 item->indent = indent;
1361 item->cells = indent * 2;
1362 ++ga.ga_len;
1363 while (*p != NUL)
1364 {
1365 if (*p == '"')
1366 quoted = !quoted;
Bram Moolenaard1c1c822019-11-09 16:59:14 +01001367 else if (*p == '\n')
1368 break;
Bram Moolenaar246fe032017-11-19 19:56:27 +01001369 else if (*p == '\\' && p[1] != NUL)
1370 ++p;
1371 else if (!quoted)
1372 {
1373 if ((*p == ',' && p[1] == ' ') || *p == '{' || *p == '}')
1374 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001375 // Looks like a good point to break.
Bram Moolenaar246fe032017-11-19 19:56:27 +01001376 if (*p == '{')
1377 ++indent;
1378 else if (*p == '}' && indent > 0)
1379 --indent;
1380 ++item->cells;
1381 p = skipwhite(p + 1);
1382 break;
1383 }
1384 }
1385 item->cells += ptr2cells(p);
Bram Moolenaar1614a142019-10-06 22:00:13 +02001386 p += mb_ptr2len(p);
Bram Moolenaar246fe032017-11-19 19:56:27 +01001387 }
1388 item->bytelen = p - item->start;
Bram Moolenaard1c1c822019-11-09 16:59:14 +01001389 if (*p == '\n')
1390 ++p;
Bram Moolenaar246fe032017-11-19 19:56:27 +01001391 if (item->cells > max_cells)
1392 max_cells = item->cells;
Bram Moolenaara3571eb2017-11-26 16:53:16 +01001393 long_item_count += (item->cells - 1) / BALLOON_MIN_WIDTH;
Bram Moolenaar246fe032017-11-19 19:56:27 +01001394 }
1395
1396 height = 2 + ga.ga_len;
1397
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001398 // If there are long items and the height is below the limit: split lines
Bram Moolenaar246fe032017-11-19 19:56:27 +01001399 if (long_item_count > 0 && height + long_item_count <= max_height)
1400 {
1401 split_long_items = TRUE;
1402 height += long_item_count;
1403 }
1404
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001405 // Limit to half the window height, it has to fit above or below the mouse
1406 // position.
Bram Moolenaar246fe032017-11-19 19:56:27 +01001407 if (height > max_height)
1408 height = max_height;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001409 *array = ALLOC_CLEAR_MULT(pumitem_T, height);
Bram Moolenaar246fe032017-11-19 19:56:27 +01001410 if (*array == NULL)
1411 goto failed;
1412
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001413 // Add an empty line above and below, looks better.
Bram Moolenaar246fe032017-11-19 19:56:27 +01001414 (*array)->pum_text = vim_strsave((char_u *)"");
1415 (*array + height - 1)->pum_text = vim_strsave((char_u *)"");
1416
1417 for (line = 1, item_idx = 0; line < height - 1; ++item_idx)
1418 {
1419 int skip;
1420 int thislen;
1421 int copylen;
1422 int ind;
1423 int cells;
1424
1425 item = ((balpart_T *)ga.ga_data) + item_idx;
Bram Moolenaar9ae862e2019-11-21 13:27:06 +01001426 if (item->bytelen == 0)
1427 (*array)[line++].pum_text = vim_strsave((char_u *)"");
1428 else
1429 for (skip = 0; skip < item->bytelen; skip += thislen)
Bram Moolenaar246fe032017-11-19 19:56:27 +01001430 {
Bram Moolenaar9ae862e2019-11-21 13:27:06 +01001431 if (split_long_items && item->cells >= BALLOON_MIN_WIDTH)
1432 {
1433 cells = item->indent * 2;
1434 for (p = item->start + skip;
1435 p < item->start + item->bytelen;
Bram Moolenaar1614a142019-10-06 22:00:13 +02001436 p += mb_ptr2len(p))
Bram Moolenaar9ae862e2019-11-21 13:27:06 +01001437 if ((cells += ptr2cells(p)) > BALLOON_MIN_WIDTH)
1438 break;
1439 thislen = p - (item->start + skip);
1440 }
1441 else
1442 thislen = item->bytelen;
1443
1444 // put indent at the start
1445 p = alloc(thislen + item->indent * 2 + 1);
1446 if (p == NULL)
1447 {
1448 for (line = 0; line <= height - 1; ++line)
1449 vim_free((*array)[line].pum_text);
1450 vim_free(*array);
1451 goto failed;
1452 }
1453 for (ind = 0; ind < item->indent * 2; ++ind)
1454 p[ind] = ' ';
1455
1456 // exclude spaces at the end of the string
1457 for (copylen = thislen; copylen > 0; --copylen)
1458 if (item->start[skip + copylen - 1] != ' ')
Bram Moolenaar246fe032017-11-19 19:56:27 +01001459 break;
Bram Moolenaar9ae862e2019-11-21 13:27:06 +01001460
1461 vim_strncpy(p + ind, item->start + skip, copylen);
1462 (*array)[line].pum_text = p;
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001463 item->indent = 0; // wrapped line has no indent
Bram Moolenaar9ae862e2019-11-21 13:27:06 +01001464 ++line;
Bram Moolenaar246fe032017-11-19 19:56:27 +01001465 }
Bram Moolenaar246fe032017-11-19 19:56:27 +01001466 }
1467 ga_clear(&ga);
1468 return height;
1469
1470failed:
1471 ga_clear(&ga);
1472 return 0;
1473}
1474
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001475 void
1476ui_remove_balloon(void)
1477{
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00001478 if (balloon_array == NULL)
1479 return;
1480
1481 pum_undisplay();
1482 while (balloon_arraysize > 0)
1483 vim_free(balloon_array[--balloon_arraysize].pum_text);
1484 VIM_CLEAR(balloon_array);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001485}
1486
1487/*
1488 * Terminal version of a balloon, uses the popup menu code.
1489 */
1490 void
Bram Moolenaar246fe032017-11-19 19:56:27 +01001491ui_post_balloon(char_u *mesg, list_T *list)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001492{
1493 ui_remove_balloon();
1494
Bram Moolenaar246fe032017-11-19 19:56:27 +01001495 if (mesg == NULL && list == NULL)
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02001496 {
1497 pum_undisplay();
Bram Moolenaar246fe032017-11-19 19:56:27 +01001498 return;
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02001499 }
Bram Moolenaar246fe032017-11-19 19:56:27 +01001500 if (list != NULL)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001501 {
Bram Moolenaar246fe032017-11-19 19:56:27 +01001502 listitem_T *li;
1503 int idx;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001504
Bram Moolenaar246fe032017-11-19 19:56:27 +01001505 balloon_arraysize = list->lv_len;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001506 balloon_array = ALLOC_CLEAR_MULT(pumitem_T, list->lv_len);
Bram Moolenaar246fe032017-11-19 19:56:27 +01001507 if (balloon_array == NULL)
1508 return;
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001509 CHECK_LIST_MATERIALIZE(list);
Bram Moolenaar246fe032017-11-19 19:56:27 +01001510 for (idx = 0, li = list->lv_first; li != NULL; li = li->li_next, ++idx)
1511 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001512 char_u *text = tv_get_string_chk(&li->li_tv);
Bram Moolenaar246fe032017-11-19 19:56:27 +01001513
1514 balloon_array[idx].pum_text = vim_strsave(
1515 text == NULL ? (char_u *)"" : text);
1516 }
1517 }
1518 else
1519 balloon_arraysize = split_message(mesg, &balloon_array);
1520
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00001521 if (balloon_arraysize <= 0)
1522 return;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001523
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00001524 pum_array = balloon_array;
1525 pum_size = balloon_arraysize;
1526 pum_compute_size();
1527 pum_scrollbar = 0;
1528 pum_height = balloon_arraysize;
1529
1530 pum_position_at_mouse(BALLOON_MIN_WIDTH);
1531 pum_selected = -1;
1532 pum_first = 0;
1533 pum_redraw();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001534}
1535
1536/*
1537 * Called when the mouse moved, may remove any displayed balloon.
1538 */
1539 void
1540ui_may_remove_balloon(void)
1541{
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02001542 // For now: remove the balloon whenever the mouse moves to another screen
1543 // cell.
1544 ui_remove_balloon();
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001545}
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001546#endif
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01001547
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001548#if defined(FEAT_TERM_POPUP_MENU) || defined(PROTO)
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001549/*
1550 * Select the pum entry at the mouse position.
1551 */
1552 static void
1553pum_select_mouse_pos(void)
1554{
1555 int idx = mouse_row - pum_row;
1556
1557 if (idx < 0 || idx >= pum_size)
1558 pum_selected = -1;
1559 else if (*pum_array[idx].pum_text != NUL)
1560 pum_selected = idx;
1561}
1562
1563/*
1564 * Execute the currently selected popup menu item.
1565 */
1566 static void
Bram Moolenaar987723e2018-03-06 11:43:04 +01001567pum_execute_menu(vimmenu_T *menu, int mode)
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001568{
1569 vimmenu_T *mp;
1570 int idx = 0;
1571 exarg_T ea;
1572
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001573 FOR_ALL_CHILD_MENUS(menu, mp)
Bram Moolenaar987723e2018-03-06 11:43:04 +01001574 if ((mp->modes & mp->enabled & mode) && idx++ == pum_selected)
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001575 {
Bram Moolenaara80faa82020-04-12 19:37:17 +02001576 CLEAR_FIELD(ea);
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02001577 execute_menu(&ea, mp, -1);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001578 break;
1579 }
1580}
1581
1582/*
1583 * Open the terminal version of the popup menu and don't return until it is
1584 * closed.
1585 */
1586 void
1587pum_show_popupmenu(vimmenu_T *menu)
1588{
1589 vimmenu_T *mp;
1590 int idx = 0;
1591 pumitem_T *array;
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001592# ifdef FEAT_BEVAL_TERM
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001593 int save_bevalterm = p_bevalterm;
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001594# endif
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001595 int mode;
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001596
1597 pum_undisplay();
1598 pum_size = 0;
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001599 mode = get_menu_mode_flag();
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001600
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001601 FOR_ALL_CHILD_MENUS(menu, mp)
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001602 if (menu_is_separator(mp->dname)
1603 || (mp->modes & mp->enabled & mode))
1604 ++pum_size;
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001605
Bram Moolenaarf42b45d2019-01-06 13:11:05 +01001606 // When there are only Terminal mode menus, using "popup Edit" results in
1607 // pum_size being zero.
1608 if (pum_size <= 0)
1609 {
zeertzjq276410e2023-05-07 21:59:33 +01001610 emsg(_(e_menu_only_exists_in_another_mode));
Bram Moolenaarf42b45d2019-01-06 13:11:05 +01001611 return;
1612 }
1613
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001614 array = ALLOC_CLEAR_MULT(pumitem_T, pum_size);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001615 if (array == NULL)
1616 return;
1617
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001618 FOR_ALL_CHILD_MENUS(menu, mp)
Bram Moolenaar38455a92020-12-24 18:39:02 +01001619 {
1620 char_u *s = NULL;
1621
1622 // Make a copy of the text, the menu may be redefined in a callback.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001623 if (menu_is_separator(mp->dname))
Bram Moolenaar38455a92020-12-24 18:39:02 +01001624 s = (char_u *)"";
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001625 else if (mp->modes & mp->enabled & mode)
Bram Moolenaar38455a92020-12-24 18:39:02 +01001626 s = mp->dname;
1627 if (s != NULL)
1628 {
1629 s = vim_strsave(s);
1630 if (s != NULL)
1631 array[idx++].pum_text = s;
1632 }
1633 }
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001634
1635 pum_array = array;
1636 pum_compute_size();
1637 pum_scrollbar = 0;
1638 pum_height = pum_size;
1639 pum_position_at_mouse(20);
1640
1641 pum_selected = -1;
1642 pum_first = 0;
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001643# ifdef FEAT_BEVAL_TERM
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001644 p_bevalterm = TRUE; // track mouse movement
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001645 mch_setmouse(TRUE);
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001646# endif
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001647
1648 for (;;)
1649 {
1650 int c;
1651
1652 pum_redraw();
Bram Moolenaar987723e2018-03-06 11:43:04 +01001653 setcursor_mayforce(TRUE);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001654 out_flush();
1655
1656 c = vgetc();
Bram Moolenaar5c3fb042019-05-30 15:53:29 +02001657
zeertzjq92a16782022-07-26 12:24:41 +01001658 // Bail out when typing Esc, CTRL-C or some callback or <expr> mapping
1659 // closed the popup menu.
Bram Moolenaar5c3fb042019-05-30 15:53:29 +02001660 if (c == ESC || c == Ctrl_C || pum_array == NULL)
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001661 break;
1662 else if (c == CAR || c == NL)
1663 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001664 // enter: select current item, if any, and close
Bram Moolenaar987723e2018-03-06 11:43:04 +01001665 pum_execute_menu(menu, mode);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001666 break;
1667 }
1668 else if (c == 'k' || c == K_UP || c == K_MOUSEUP)
1669 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001670 // cursor up: select previous item
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001671 while (pum_selected > 0)
1672 {
1673 --pum_selected;
1674 if (*array[pum_selected].pum_text != NUL)
1675 break;
1676 }
1677 }
1678 else if (c == 'j' || c == K_DOWN || c == K_MOUSEDOWN)
1679 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001680 // cursor down: select next item
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001681 while (pum_selected < pum_size - 1)
1682 {
1683 ++pum_selected;
1684 if (*array[pum_selected].pum_text != NUL)
1685 break;
1686 }
1687 }
1688 else if (c == K_RIGHTMOUSE)
1689 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001690 // Right mouse down: reposition the menu.
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001691 vungetc(c);
1692 break;
1693 }
1694 else if (c == K_LEFTDRAG || c == K_RIGHTDRAG || c == K_MOUSEMOVE)
1695 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001696 // mouse moved: select item in the mouse row
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001697 pum_select_mouse_pos();
1698 }
1699 else if (c == K_LEFTMOUSE || c == K_LEFTMOUSE_NM || c == K_RIGHTRELEASE)
1700 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001701 // left mouse click: select clicked item, if any, and close;
1702 // right mouse release: select clicked item, close if any
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001703 pum_select_mouse_pos();
1704 if (pum_selected >= 0)
1705 {
Bram Moolenaar987723e2018-03-06 11:43:04 +01001706 pum_execute_menu(menu, mode);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001707 break;
1708 }
1709 if (c == K_LEFTMOUSE || c == K_LEFTMOUSE_NM)
1710 break;
1711 }
1712 }
1713
Bram Moolenaar38455a92020-12-24 18:39:02 +01001714 for (idx = 0; idx < pum_size; ++idx)
1715 vim_free(array[idx].pum_text);
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001716 vim_free(array);
1717 pum_undisplay();
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001718# ifdef FEAT_BEVAL_TERM
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001719 p_bevalterm = save_bevalterm;
1720 mch_setmouse(TRUE);
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001721# endif
Bram Moolenaaraef8c3d2018-03-03 18:59:16 +01001722}
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001723
1724 void
1725pum_make_popup(char_u *path_name, int use_mouse_pos)
1726{
1727 vimmenu_T *menu;
1728
1729 if (!use_mouse_pos)
1730 {
Bram Moolenaar63d9e732019-12-05 21:10:38 +01001731 // Hack: set mouse position at the cursor so that the menu pops up
1732 // around there.
zeertzjq4e1ca0d2023-04-27 19:36:55 +01001733 mouse_row = W_WINROW(curwin) + curwin->w_wrow;
Bram Moolenaar29a2c082018-03-05 21:06:23 +01001734 mouse_col = curwin->w_wincol + curwin->w_wcol;
1735 }
1736
1737 menu = gui_find_menu(path_name);
1738 if (menu != NULL)
1739 pum_show_popupmenu(menu);
1740}
Bram Moolenaar4b779472005-10-04 09:12:31 +00001741#endif