blob: 57b0f1405b74fa15f40e0cc371bc77823a7010ec [file] [log] [blame]
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read 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/*
11 * mouse.c: mouse handling functions
12 */
13
14#include "vim.h"
15
LemonBoyc27747e2022-05-07 12:25:40 +010016/*
17 * Horiziontal and vertical steps used when scrolling.
18 * When negative scroll by a whole page.
19 */
20static long mouse_hor_step = 6;
21static long mouse_vert_step = 3;
22
23 void
24mouse_set_vert_scroll_step(long step)
25{
26 mouse_vert_step = step;
27}
28
29 void
30mouse_set_hor_scroll_step(long step)
31{
32 mouse_hor_step = step;
33}
34
Bram Moolenaar85c35022019-11-22 22:21:59 +010035#ifdef CHECK_DOUBLE_CLICK
36/*
37 * Return the duration from t1 to t2 in milliseconds.
38 */
39 static long
40time_diff_ms(struct timeval *t1, struct timeval *t2)
41{
42 // This handles wrapping of tv_usec correctly without any special case.
43 // Example of 2 pairs (tv_sec, tv_usec) with a duration of 5 ms:
44 // t1 = (1, 998000) t2 = (2, 3000) gives:
45 // (2 - 1) * 1000 + (3000 - 998000) / 1000 -> 5 ms.
46 return (t2->tv_sec - t1->tv_sec) * 1000
47 + (t2->tv_usec - t1->tv_usec) / 1000;
48}
49#endif
50
Bram Moolenaarb20b9e12019-09-21 20:48:04 +020051/*
52 * Get class of a character for selection: same class means same word.
53 * 0: blank
54 * 1: punctuation groups
55 * 2: normal word character
56 * >2: multi-byte word character.
57 */
58 static int
59get_mouse_class(char_u *p)
60{
61 int c;
62
63 if (has_mbyte && MB_BYTE2LEN(p[0]) > 1)
64 return mb_get_class(p);
65
66 c = *p;
67 if (c == ' ' || c == '\t')
68 return 0;
69
70 if (vim_iswordc(c))
71 return 2;
72
73 // There are a few special cases where we want certain combinations of
74 // characters to be considered as a single word. These are things like
75 // "->", "/ *", "*=", "+=", "&=", "<=", ">=", "!=" etc. Otherwise, each
76 // character is in its own class.
77 if (c != NUL && vim_strchr((char_u *)"-+*/%<>&|^!=", c) != NULL)
78 return 1;
79 return c;
80}
81
82/*
83 * Move "pos" back to the start of the word it's in.
84 */
85 static void
86find_start_of_word(pos_T *pos)
87{
88 char_u *line;
89 int cclass;
90 int col;
91
92 line = ml_get(pos->lnum);
93 cclass = get_mouse_class(line + pos->col);
94
95 while (pos->col > 0)
96 {
97 col = pos->col - 1;
98 col -= (*mb_head_off)(line, line + col);
99 if (get_mouse_class(line + col) != cclass)
100 break;
101 pos->col = col;
102 }
103}
104
105/*
106 * Move "pos" forward to the end of the word it's in.
107 * When 'selection' is "exclusive", the position is just after the word.
108 */
109 static void
110find_end_of_word(pos_T *pos)
111{
112 char_u *line;
113 int cclass;
114 int col;
115
116 line = ml_get(pos->lnum);
117 if (*p_sel == 'e' && pos->col > 0)
118 {
119 --pos->col;
120 pos->col -= (*mb_head_off)(line, line + pos->col);
121 }
122 cclass = get_mouse_class(line + pos->col);
123 while (line[pos->col] != NUL)
124 {
125 col = pos->col + (*mb_ptr2len)(line + pos->col);
126 if (get_mouse_class(line + col) != cclass)
127 {
128 if (*p_sel == 'e')
129 pos->col = col;
130 break;
131 }
132 pos->col = col;
133 }
134}
135
Bram Moolenaar910c3782019-09-22 14:11:50 +0200136#if defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_GTK) \
Bram Moolenaar0b962e52022-04-03 18:02:37 +0100137 || defined(FEAT_GUI_MSWIN) \
Bram Moolenaar097148e2020-08-11 21:58:20 +0200138 || defined(FEAT_GUI_PHOTON) \
Bram Moolenaar910c3782019-09-22 14:11:50 +0200139 || defined(FEAT_TERM_POPUP_MENU)
140# define USE_POPUP_SETPOS
141# define NEED_VCOL2COL
142
143/*
144 * Translate window coordinates to buffer position without any side effects
145 */
146 static int
147get_fpos_of_mouse(pos_T *mpos)
148{
149 win_T *wp;
150 int row = mouse_row;
151 int col = mouse_col;
152
153 if (row < 0 || col < 0) // check if it makes sense
154 return IN_UNKNOWN;
155
156 // find the window where the row is in
157 wp = mouse_find_win(&row, &col, FAIL_POPUP);
158 if (wp == NULL)
159 return IN_UNKNOWN;
160 // winpos and height may change in win_enter()!
161 if (row >= wp->w_height) // In (or below) status line
162 return IN_STATUS_LINE;
163 if (col >= wp->w_width) // In vertical separator line
164 return IN_SEP_LINE;
165
166 if (wp != curwin)
167 return IN_UNKNOWN;
168
169 // compute the position in the buffer line from the posn on the screen
170 if (mouse_comp_pos(curwin, &row, &col, &mpos->lnum, NULL))
171 return IN_STATUS_LINE; // past bottom
172
173 mpos->col = vcol2col(wp, mpos->lnum, col);
174
175 if (mpos->col > 0)
176 --mpos->col;
177 mpos->coladd = 0;
178 return IN_BUFFER;
179}
180#endif
181
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200182/*
183 * Do the appropriate action for the current mouse click in the current mode.
184 * Not used for Command-line mode.
185 *
186 * Normal and Visual Mode:
187 * event modi- position visual change action
188 * fier cursor window
189 * left press - yes end yes
190 * left press C yes end yes "^]" (2)
191 * left press S yes end (popup: extend) yes "*" (2)
192 * left drag - yes start if moved no
193 * left relse - yes start if moved no
194 * middle press - yes if not active no put register
195 * middle press - yes if active no yank and put
196 * right press - yes start or extend yes
197 * right press S yes no change yes "#" (2)
198 * right drag - yes extend no
199 * right relse - yes extend no
200 *
201 * Insert or Replace Mode:
202 * event modi- position visual change action
203 * fier cursor window
204 * left press - yes (cannot be active) yes
205 * left press C yes (cannot be active) yes "CTRL-O^]" (2)
206 * left press S yes (cannot be active) yes "CTRL-O*" (2)
207 * left drag - yes start or extend (1) no CTRL-O (1)
208 * left relse - yes start or extend (1) no CTRL-O (1)
209 * middle press - no (cannot be active) no put register
210 * right press - yes start or extend yes CTRL-O
211 * right press S yes (cannot be active) yes "CTRL-O#" (2)
212 *
213 * (1) only if mouse pointer moved since press
214 * (2) only if click is in same buffer
215 *
216 * Return TRUE if start_arrow() should be called for edit mode.
217 */
218 int
219do_mouse(
220 oparg_T *oap, // operator argument, can be NULL
221 int c, // K_LEFTMOUSE, etc
222 int dir, // Direction to 'put' if necessary
223 long count,
224 int fixindent) // PUT_FIXINDENT if fixing indent necessary
225{
226 static int do_always = FALSE; // ignore 'mouse' setting next time
227 static int got_click = FALSE; // got a click some time back
228
229 int which_button; // MOUSE_LEFT, _MIDDLE or _RIGHT
230 int is_click = FALSE; // If FALSE it's a drag or release event
231 int is_drag = FALSE; // If TRUE it's a drag event
232 int jump_flags = 0; // flags for jump_to_mouse()
233 pos_T start_visual;
234 int moved; // Has cursor moved?
235 int in_status_line; // mouse in status line
236 static int in_tab_line = FALSE; // mouse clicked in tab line
237 int in_sep_line; // mouse in vertical separator line
238 int c1, c2;
239#if defined(FEAT_FOLDING)
240 pos_T save_cursor;
241#endif
242 win_T *old_curwin = curwin;
243 static pos_T orig_cursor;
244 colnr_T leftcol, rightcol;
245 pos_T end_visual;
246 int diff;
247 int old_active = VIsual_active;
248 int old_mode = VIsual_mode;
249 int regname;
250
251#if defined(FEAT_FOLDING)
252 save_cursor = curwin->w_cursor;
253#endif
254
255 // When GUI is active, always recognize mouse events, otherwise:
256 // - Ignore mouse event in normal mode if 'mouse' doesn't include 'n'.
257 // - Ignore mouse event in visual mode if 'mouse' doesn't include 'v'.
258 // - For command line and insert mode 'mouse' is checked before calling
259 // do_mouse().
260 if (do_always)
261 do_always = FALSE;
262 else
263#ifdef FEAT_GUI
264 if (!gui.in_use)
265#endif
266 {
267 if (VIsual_active)
268 {
269 if (!mouse_has(MOUSE_VISUAL))
270 return FALSE;
271 }
272 else if (State == NORMAL && !mouse_has(MOUSE_NORMAL))
273 return FALSE;
274 }
275
276 for (;;)
277 {
278 which_button = get_mouse_button(KEY2TERMCAP1(c), &is_click, &is_drag);
279 if (is_drag)
280 {
281 // If the next character is the same mouse event then use that
282 // one. Speeds up dragging the status line.
zeertzjq0f68e6c2022-04-05 13:17:01 +0100283 // Note: Since characters added to the stuff buffer in the code
284 // below need to come before the next character, do not do this
285 // when the current character was stuffed.
286 if (!KeyStuffed && vpeekc() != NUL)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200287 {
288 int nc;
289 int save_mouse_row = mouse_row;
290 int save_mouse_col = mouse_col;
291
292 // Need to get the character, peeking doesn't get the actual
293 // one.
294 nc = safe_vgetc();
295 if (c == nc)
296 continue;
297 vungetc(nc);
298 mouse_row = save_mouse_row;
299 mouse_col = save_mouse_col;
300 }
301 }
302 break;
303 }
304
305 if (c == K_MOUSEMOVE)
306 {
307 // Mouse moved without a button pressed.
308#ifdef FEAT_BEVAL_TERM
309 ui_may_remove_balloon();
310 if (p_bevalterm)
311 {
312 profile_setlimit(p_bdlay, &bevalexpr_due);
313 bevalexpr_due_set = TRUE;
314 }
315#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100316#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200317 popup_handle_mouse_moved();
318#endif
319 return FALSE;
320 }
321
322#ifdef FEAT_MOUSESHAPE
323 // May have stopped dragging the status or separator line. The pointer is
324 // most likely still on the status or separator line.
325 if (!is_drag && drag_status_line)
326 {
327 drag_status_line = FALSE;
328 update_mouseshape(SHAPE_IDX_STATUS);
329 }
330 if (!is_drag && drag_sep_line)
331 {
332 drag_sep_line = FALSE;
333 update_mouseshape(SHAPE_IDX_VSEP);
334 }
335#endif
336
337 // Ignore drag and release events if we didn't get a click.
338 if (is_click)
339 got_click = TRUE;
340 else
341 {
342 if (!got_click) // didn't get click, ignore
343 return FALSE;
344 if (!is_drag) // release, reset got_click
345 {
346 got_click = FALSE;
347 if (in_tab_line)
348 {
349 in_tab_line = FALSE;
350 return FALSE;
351 }
352 }
353 }
354
355 // CTRL right mouse button does CTRL-T
356 if (is_click && (mod_mask & MOD_MASK_CTRL) && which_button == MOUSE_RIGHT)
357 {
358 if (State & INSERT)
359 stuffcharReadbuff(Ctrl_O);
360 if (count > 1)
361 stuffnumReadbuff(count);
362 stuffcharReadbuff(Ctrl_T);
363 got_click = FALSE; // ignore drag&release now
364 return FALSE;
365 }
366
367 // CTRL only works with left mouse button
368 if ((mod_mask & MOD_MASK_CTRL) && which_button != MOUSE_LEFT)
369 return FALSE;
370
371 // When a modifier is down, ignore drag and release events, as well as
372 // multiple clicks and the middle mouse button.
373 // Accept shift-leftmouse drags when 'mousemodel' is "popup.*".
374 if ((mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT
375 | MOD_MASK_META))
376 && (!is_click
377 || (mod_mask & MOD_MASK_MULTI_CLICK)
378 || which_button == MOUSE_MIDDLE)
379 && !((mod_mask & (MOD_MASK_SHIFT|MOD_MASK_ALT))
380 && mouse_model_popup()
381 && which_button == MOUSE_LEFT)
382 && !((mod_mask & MOD_MASK_ALT)
383 && !mouse_model_popup()
384 && which_button == MOUSE_RIGHT)
385 )
386 return FALSE;
387
388 // If the button press was used as the movement command for an operator
389 // (eg "d<MOUSE>"), or it is the middle button that is held down, ignore
390 // drag/release events.
391 if (!is_click && which_button == MOUSE_MIDDLE)
392 return FALSE;
393
394 if (oap != NULL)
395 regname = oap->regname;
396 else
397 regname = 0;
398
399 // Middle mouse button does a 'put' of the selected text
400 if (which_button == MOUSE_MIDDLE)
401 {
402 if (State == NORMAL)
403 {
404 // If an operator was pending, we don't know what the user wanted
405 // to do. Go back to normal mode: Clear the operator and beep().
406 if (oap != NULL && oap->op_type != OP_NOP)
407 {
408 clearopbeep(oap);
409 return FALSE;
410 }
411
412 // If visual was active, yank the highlighted text and put it
413 // before the mouse pointer position.
414 // In Select mode replace the highlighted text with the clipboard.
415 if (VIsual_active)
416 {
417 if (VIsual_select)
418 {
419 stuffcharReadbuff(Ctrl_G);
420 stuffReadbuff((char_u *)"\"+p");
421 }
422 else
423 {
424 stuffcharReadbuff('y');
425 stuffcharReadbuff(K_MIDDLEMOUSE);
426 }
427 do_always = TRUE; // ignore 'mouse' setting next time
428 return FALSE;
429 }
430 // The rest is below jump_to_mouse()
431 }
432
433 else if ((State & INSERT) == 0)
434 return FALSE;
435
436 // Middle click in insert mode doesn't move the mouse, just insert the
437 // contents of a register. '.' register is special, can't insert that
438 // with do_put().
439 // Also paste at the cursor if the current mode isn't in 'mouse' (only
440 // happens for the GUI).
441 if ((State & INSERT) || !mouse_has(MOUSE_NORMAL))
442 {
443 if (regname == '.')
444 insert_reg(regname, TRUE);
445 else
446 {
447#ifdef FEAT_CLIPBOARD
448 if (clip_star.available && regname == 0)
449 regname = '*';
450#endif
451 if ((State & REPLACE_FLAG) && !yank_register_mline(regname))
452 insert_reg(regname, TRUE);
453 else
454 {
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200455 do_put(regname, NULL, BACKWARD, 1L,
456 fixindent | PUT_CURSEND);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200457
458 // Repeat it with CTRL-R CTRL-O r or CTRL-R CTRL-P r
459 AppendCharToRedobuff(Ctrl_R);
460 AppendCharToRedobuff(fixindent ? Ctrl_P : Ctrl_O);
461 AppendCharToRedobuff(regname == 0 ? '"' : regname);
462 }
463 }
464 return FALSE;
465 }
466 }
467
468 // When dragging or button-up stay in the same window.
469 if (!is_click)
470 jump_flags |= MOUSE_FOCUS | MOUSE_DID_MOVE;
471
472 start_visual.lnum = 0;
473
474 // Check for clicking in the tab page line.
475 if (mouse_row == 0 && firstwin->w_winrow > 0)
476 {
477 if (is_drag)
478 {
479 if (in_tab_line)
480 {
481 c1 = TabPageIdxs[mouse_col];
482 tabpage_move(c1 <= 0 ? 9999 : c1 < tabpage_index(curtab)
483 ? c1 - 1 : c1);
484 }
485 return FALSE;
486 }
487
488 // click in a tab selects that tab page
489 if (is_click
490# ifdef FEAT_CMDWIN
491 && cmdwin_type == 0
492# endif
493 && mouse_col < Columns)
494 {
495 in_tab_line = TRUE;
496 c1 = TabPageIdxs[mouse_col];
497 if (c1 >= 0)
498 {
499 if ((mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_2CLICK)
500 {
501 // double click opens new page
Bram Moolenaar4f3c57f2021-06-03 22:11:08 +0200502 end_visual_mode_keep_button();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200503 tabpage_new();
504 tabpage_move(c1 == 0 ? 9999 : c1 - 1);
505 }
506 else
507 {
508 // Go to specified tab page, or next one if not clicking
509 // on a label.
510 goto_tabpage(c1);
511
512 // It's like clicking on the status line of a window.
513 if (curwin != old_curwin)
Bram Moolenaar4f3c57f2021-06-03 22:11:08 +0200514 end_visual_mode_keep_button();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200515 }
516 }
517 else
518 {
519 tabpage_T *tp;
520
521 // Close the current or specified tab page.
522 if (c1 == -999)
523 tp = curtab;
524 else
525 tp = find_tabpage(-c1);
526 if (tp == curtab)
527 {
528 if (first_tabpage->tp_next != NULL)
529 tabpage_close(FALSE);
530 }
531 else if (tp != NULL)
532 tabpage_close_other(tp, FALSE);
533 }
534 }
535 return TRUE;
536 }
537 else if (is_drag && in_tab_line)
538 {
539 c1 = TabPageIdxs[mouse_col];
540 tabpage_move(c1 <= 0 ? 9999 : c1 - 1);
541 return FALSE;
542 }
543
544 // When 'mousemodel' is "popup" or "popup_setpos", translate mouse events:
545 // right button up -> pop-up menu
546 // shift-left button -> right button
547 // alt-left button -> alt-right button
548 if (mouse_model_popup())
549 {
550 if (which_button == MOUSE_RIGHT
551 && !(mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL)))
552 {
Bram Moolenaar910c3782019-09-22 14:11:50 +0200553#ifdef USE_POPUP_SETPOS
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200554# ifdef FEAT_GUI
555 if (gui.in_use)
556 {
557# if defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_GTK) \
Bram Moolenaar097148e2020-08-11 21:58:20 +0200558 || defined(FEAT_GUI_PHOTON)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200559 if (!is_click)
560 // Ignore right button release events, only shows the popup
561 // menu on the button down event.
562 return FALSE;
563# endif
Bram Moolenaar0b962e52022-04-03 18:02:37 +0100564# if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_HAIKU)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200565 if (is_click || is_drag)
566 // Ignore right button down and drag mouse events. Windows
567 // only shows the popup menu on the button up event.
568 return FALSE;
569# endif
570 }
571# endif
572# if defined(FEAT_GUI) && defined(FEAT_TERM_POPUP_MENU)
573 else
574# endif
575# if defined(FEAT_TERM_POPUP_MENU)
576 if (!is_click)
577 // Ignore right button release events, only shows the popup
578 // menu on the button down event.
579 return FALSE;
580#endif
581
582 jump_flags = 0;
583 if (STRCMP(p_mousem, "popup_setpos") == 0)
584 {
585 // First set the cursor position before showing the popup
586 // menu.
587 if (VIsual_active)
588 {
589 pos_T m_pos;
590
591 // set MOUSE_MAY_STOP_VIS if we are outside the
592 // selection or the current window (might have false
593 // negative here)
594 if (mouse_row < curwin->w_winrow
595 || mouse_row
596 > (curwin->w_winrow + curwin->w_height))
597 jump_flags = MOUSE_MAY_STOP_VIS;
598 else if (get_fpos_of_mouse(&m_pos) != IN_BUFFER)
599 jump_flags = MOUSE_MAY_STOP_VIS;
600 else
601 {
602 if ((LT_POS(curwin->w_cursor, VIsual)
603 && (LT_POS(m_pos, curwin->w_cursor)
604 || LT_POS(VIsual, m_pos)))
605 || (LT_POS(VIsual, curwin->w_cursor)
606 && (LT_POS(m_pos, VIsual)
607 || LT_POS(curwin->w_cursor, m_pos))))
608 {
609 jump_flags = MOUSE_MAY_STOP_VIS;
610 }
611 else if (VIsual_mode == Ctrl_V)
612 {
613 getvcols(curwin, &curwin->w_cursor, &VIsual,
614 &leftcol, &rightcol);
615 getvcol(curwin, &m_pos, NULL, &m_pos.col, NULL);
616 if (m_pos.col < leftcol || m_pos.col > rightcol)
617 jump_flags = MOUSE_MAY_STOP_VIS;
618 }
619 }
620 }
621 else
622 jump_flags = MOUSE_MAY_STOP_VIS;
623 }
624 if (jump_flags)
625 {
626 jump_flags = jump_to_mouse(jump_flags, NULL, which_button);
627 update_curbuf(VIsual_active ? INVERTED : VALID);
628 setcursor();
629 out_flush(); // Update before showing popup menu
630 }
631# ifdef FEAT_MENU
632 show_popupmenu();
633 got_click = FALSE; // ignore release events
634# endif
635 return (jump_flags & CURSOR_MOVED) != 0;
636#else
637 return FALSE;
638#endif
639 }
640 if (which_button == MOUSE_LEFT
641 && (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_ALT)))
642 {
643 which_button = MOUSE_RIGHT;
644 mod_mask &= ~MOD_MASK_SHIFT;
645 }
646 }
647
648 if ((State & (NORMAL | INSERT))
649 && !(mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL)))
650 {
651 if (which_button == MOUSE_LEFT)
652 {
653 if (is_click)
654 {
655 // stop Visual mode for a left click in a window, but not when
656 // on a status line
657 if (VIsual_active)
658 jump_flags |= MOUSE_MAY_STOP_VIS;
659 }
660 else if (mouse_has(MOUSE_VISUAL))
661 jump_flags |= MOUSE_MAY_VIS;
662 }
663 else if (which_button == MOUSE_RIGHT)
664 {
665 if (is_click && VIsual_active)
666 {
667 // Remember the start and end of visual before moving the
668 // cursor.
669 if (LT_POS(curwin->w_cursor, VIsual))
670 {
671 start_visual = curwin->w_cursor;
672 end_visual = VIsual;
673 }
674 else
675 {
676 start_visual = VIsual;
677 end_visual = curwin->w_cursor;
678 }
679 }
680 jump_flags |= MOUSE_FOCUS;
681 if (mouse_has(MOUSE_VISUAL))
682 jump_flags |= MOUSE_MAY_VIS;
683 }
684 }
685
686 // If an operator is pending, ignore all drags and releases until the
687 // next mouse click.
688 if (!is_drag && oap != NULL && oap->op_type != OP_NOP)
689 {
690 got_click = FALSE;
691 oap->motion_type = MCHAR;
692 }
693
694 // When releasing the button let jump_to_mouse() know.
695 if (!is_click && !is_drag)
696 jump_flags |= MOUSE_RELEASED;
697
698 // JUMP!
699 jump_flags = jump_to_mouse(jump_flags,
700 oap == NULL ? NULL : &(oap->inclusive), which_button);
701
702#ifdef FEAT_MENU
703 // A click in the window toolbar has no side effects.
704 if (jump_flags & MOUSE_WINBAR)
705 return FALSE;
706#endif
707 moved = (jump_flags & CURSOR_MOVED);
708 in_status_line = (jump_flags & IN_STATUS_LINE);
709 in_sep_line = (jump_flags & IN_SEP_LINE);
710
711#ifdef FEAT_NETBEANS_INTG
712 if (isNetbeansBuffer(curbuf)
713 && !(jump_flags & (IN_STATUS_LINE | IN_SEP_LINE)))
714 {
715 int key = KEY2TERMCAP1(c);
716
717 if (key == (int)KE_LEFTRELEASE || key == (int)KE_MIDDLERELEASE
718 || key == (int)KE_RIGHTRELEASE)
719 netbeans_button_release(which_button);
720 }
721#endif
722
723 // When jumping to another window, clear a pending operator. That's a bit
724 // friendlier than beeping and not jumping to that window.
725 if (curwin != old_curwin && oap != NULL && oap->op_type != OP_NOP)
726 clearop(oap);
727
728#ifdef FEAT_FOLDING
729 if (mod_mask == 0
730 && !is_drag
731 && (jump_flags & (MOUSE_FOLD_CLOSE | MOUSE_FOLD_OPEN))
732 && which_button == MOUSE_LEFT)
733 {
734 // open or close a fold at this line
735 if (jump_flags & MOUSE_FOLD_OPEN)
736 openFold(curwin->w_cursor.lnum, 1L);
737 else
738 closeFold(curwin->w_cursor.lnum, 1L);
739 // don't move the cursor if still in the same window
740 if (curwin == old_curwin)
741 curwin->w_cursor = save_cursor;
742 }
743#endif
744
745#if defined(FEAT_CLIPBOARD) && defined(FEAT_CMDWIN)
746 if ((jump_flags & IN_OTHER_WIN) && !VIsual_active && clip_star.available)
747 {
748 clip_modeless(which_button, is_click, is_drag);
749 return FALSE;
750 }
751#endif
752
753 // Set global flag that we are extending the Visual area with mouse
754 // dragging; temporarily minimize 'scrolloff'.
755 if (VIsual_active && is_drag && get_scrolloff_value())
756 {
757 // In the very first line, allow scrolling one line
758 if (mouse_row == 0)
759 mouse_dragging = 2;
760 else
761 mouse_dragging = 1;
762 }
763
764 // When dragging the mouse above the window, scroll down.
765 if (is_drag && mouse_row < 0 && !in_status_line)
766 {
767 scroll_redraw(FALSE, 1L);
768 mouse_row = 0;
769 }
770
771 if (start_visual.lnum) // right click in visual mode
772 {
773 // When ALT is pressed make Visual mode blockwise.
774 if (mod_mask & MOD_MASK_ALT)
775 VIsual_mode = Ctrl_V;
776
777 // In Visual-block mode, divide the area in four, pick up the corner
778 // that is in the quarter that the cursor is in.
779 if (VIsual_mode == Ctrl_V)
780 {
781 getvcols(curwin, &start_visual, &end_visual, &leftcol, &rightcol);
782 if (curwin->w_curswant > (leftcol + rightcol) / 2)
783 end_visual.col = leftcol;
784 else
785 end_visual.col = rightcol;
786 if (curwin->w_cursor.lnum >=
787 (start_visual.lnum + end_visual.lnum) / 2)
788 end_visual.lnum = start_visual.lnum;
789
790 // move VIsual to the right column
791 start_visual = curwin->w_cursor; // save the cursor pos
792 curwin->w_cursor = end_visual;
793 coladvance(end_visual.col);
794 VIsual = curwin->w_cursor;
795 curwin->w_cursor = start_visual; // restore the cursor
796 }
797 else
798 {
799 // If the click is before the start of visual, change the start.
800 // If the click is after the end of visual, change the end. If
801 // the click is inside the visual, change the closest side.
802 if (LT_POS(curwin->w_cursor, start_visual))
803 VIsual = end_visual;
804 else if (LT_POS(end_visual, curwin->w_cursor))
805 VIsual = start_visual;
806 else
807 {
808 // In the same line, compare column number
809 if (end_visual.lnum == start_visual.lnum)
810 {
811 if (curwin->w_cursor.col - start_visual.col >
812 end_visual.col - curwin->w_cursor.col)
813 VIsual = start_visual;
814 else
815 VIsual = end_visual;
816 }
817
818 // In different lines, compare line number
819 else
820 {
821 diff = (curwin->w_cursor.lnum - start_visual.lnum) -
822 (end_visual.lnum - curwin->w_cursor.lnum);
823
824 if (diff > 0) // closest to end
825 VIsual = start_visual;
826 else if (diff < 0) // closest to start
827 VIsual = end_visual;
828 else // in the middle line
829 {
830 if (curwin->w_cursor.col <
831 (start_visual.col + end_visual.col) / 2)
832 VIsual = end_visual;
833 else
834 VIsual = start_visual;
835 }
836 }
837 }
838 }
839 }
840 // If Visual mode started in insert mode, execute "CTRL-O"
841 else if ((State & INSERT) && VIsual_active)
842 stuffcharReadbuff(Ctrl_O);
843
844 // Middle mouse click: Put text before cursor.
845 if (which_button == MOUSE_MIDDLE)
846 {
847#ifdef FEAT_CLIPBOARD
848 if (clip_star.available && regname == 0)
849 regname = '*';
850#endif
851 if (yank_register_mline(regname))
852 {
853 if (mouse_past_bottom)
854 dir = FORWARD;
855 }
856 else if (mouse_past_eol)
857 dir = FORWARD;
858
859 if (fixindent)
860 {
861 c1 = (dir == BACKWARD) ? '[' : ']';
862 c2 = 'p';
863 }
864 else
865 {
866 c1 = (dir == FORWARD) ? 'p' : 'P';
867 c2 = NUL;
868 }
869 prep_redo(regname, count, NUL, c1, NUL, c2, NUL);
870
871 // Remember where the paste started, so in edit() Insstart can be set
872 // to this position
873 if (restart_edit != 0)
874 where_paste_started = curwin->w_cursor;
Bram Moolenaarc3516f72020-09-08 22:45:35 +0200875 do_put(regname, NULL, dir, count, fixindent | PUT_CURSEND);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +0200876 }
877
878#if defined(FEAT_QUICKFIX)
879 // Ctrl-Mouse click or double click in a quickfix window jumps to the
880 // error under the mouse pointer.
881 else if (((mod_mask & MOD_MASK_CTRL)
882 || (mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_2CLICK)
883 && bt_quickfix(curbuf))
884 {
885 if (curwin->w_llist_ref == NULL) // quickfix window
886 do_cmdline_cmd((char_u *)".cc");
887 else // location list window
888 do_cmdline_cmd((char_u *)".ll");
889 got_click = FALSE; // ignore drag&release now
890 }
891#endif
892
893 // Ctrl-Mouse click (or double click in a help window) jumps to the tag
894 // under the mouse pointer.
895 else if ((mod_mask & MOD_MASK_CTRL) || (curbuf->b_help
896 && (mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_2CLICK))
897 {
898 if (State & INSERT)
899 stuffcharReadbuff(Ctrl_O);
900 stuffcharReadbuff(Ctrl_RSB);
901 got_click = FALSE; // ignore drag&release now
902 }
903
904 // Shift-Mouse click searches for the next occurrence of the word under
905 // the mouse pointer
906 else if ((mod_mask & MOD_MASK_SHIFT))
907 {
908 if ((State & INSERT) || (VIsual_active && VIsual_select))
909 stuffcharReadbuff(Ctrl_O);
910 if (which_button == MOUSE_LEFT)
911 stuffcharReadbuff('*');
912 else // MOUSE_RIGHT
913 stuffcharReadbuff('#');
914 }
915
916 // Handle double clicks, unless on status line
917 else if (in_status_line)
918 {
919#ifdef FEAT_MOUSESHAPE
920 if ((is_drag || is_click) && !drag_status_line)
921 {
922 drag_status_line = TRUE;
923 update_mouseshape(-1);
924 }
925#endif
926 }
927 else if (in_sep_line)
928 {
929#ifdef FEAT_MOUSESHAPE
930 if ((is_drag || is_click) && !drag_sep_line)
931 {
932 drag_sep_line = TRUE;
933 update_mouseshape(-1);
934 }
935#endif
936 }
937 else if ((mod_mask & MOD_MASK_MULTI_CLICK) && (State & (NORMAL | INSERT))
938 && mouse_has(MOUSE_VISUAL))
939 {
940 if (is_click || !VIsual_active)
941 {
942 if (VIsual_active)
943 orig_cursor = VIsual;
944 else
945 {
946 check_visual_highlight();
947 VIsual = curwin->w_cursor;
948 orig_cursor = VIsual;
949 VIsual_active = TRUE;
950 VIsual_reselect = TRUE;
951 // start Select mode if 'selectmode' contains "mouse"
952 may_start_select('o');
953 setmouse();
954 }
955 if ((mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_2CLICK)
956 {
957 // Double click with ALT pressed makes it blockwise.
958 if (mod_mask & MOD_MASK_ALT)
959 VIsual_mode = Ctrl_V;
960 else
961 VIsual_mode = 'v';
962 }
963 else if ((mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_3CLICK)
964 VIsual_mode = 'V';
965 else if ((mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_4CLICK)
966 VIsual_mode = Ctrl_V;
967#ifdef FEAT_CLIPBOARD
968 // Make sure the clipboard gets updated. Needed because start and
969 // end may still be the same, and the selection needs to be owned
970 clip_star.vmode = NUL;
971#endif
972 }
973 // A double click selects a word or a block.
974 if ((mod_mask & MOD_MASK_MULTI_CLICK) == MOD_MASK_2CLICK)
975 {
976 pos_T *pos = NULL;
977 int gc;
978
979 if (is_click)
980 {
981 // If the character under the cursor (skipping white space) is
982 // not a word character, try finding a match and select a (),
983 // {}, [], #if/#endif, etc. block.
984 end_visual = curwin->w_cursor;
985 while (gc = gchar_pos(&end_visual), VIM_ISWHITE(gc))
986 inc(&end_visual);
987 if (oap != NULL)
988 oap->motion_type = MCHAR;
989 if (oap != NULL
990 && VIsual_mode == 'v'
991 && !vim_iswordc(gchar_pos(&end_visual))
992 && EQUAL_POS(curwin->w_cursor, VIsual)
993 && (pos = findmatch(oap, NUL)) != NULL)
994 {
995 curwin->w_cursor = *pos;
996 if (oap->motion_type == MLINE)
997 VIsual_mode = 'V';
998 else if (*p_sel == 'e')
999 {
1000 if (LT_POS(curwin->w_cursor, VIsual))
1001 ++VIsual.col;
1002 else
1003 ++curwin->w_cursor.col;
1004 }
1005 }
1006 }
1007
1008 if (pos == NULL && (is_click || is_drag))
1009 {
1010 // When not found a match or when dragging: extend to include
1011 // a word.
1012 if (LT_POS(curwin->w_cursor, orig_cursor))
1013 {
1014 find_start_of_word(&curwin->w_cursor);
1015 find_end_of_word(&VIsual);
1016 }
1017 else
1018 {
1019 find_start_of_word(&VIsual);
1020 if (*p_sel == 'e' && *ml_get_cursor() != NUL)
1021 curwin->w_cursor.col +=
1022 (*mb_ptr2len)(ml_get_cursor());
1023 find_end_of_word(&curwin->w_cursor);
1024 }
1025 }
1026 curwin->w_set_curswant = TRUE;
1027 }
1028 if (is_click)
1029 redraw_curbuf_later(INVERTED); // update the inversion
1030 }
1031 else if (VIsual_active && !old_active)
1032 {
1033 if (mod_mask & MOD_MASK_ALT)
1034 VIsual_mode = Ctrl_V;
1035 else
1036 VIsual_mode = 'v';
1037 }
1038
1039 // If Visual mode changed show it later.
1040 if ((!VIsual_active && old_active && mode_displayed)
1041 || (VIsual_active && p_smd && msg_silent == 0
1042 && (!old_active || VIsual_mode != old_mode)))
1043 redraw_cmdline = TRUE;
1044
1045 return moved;
1046}
1047
1048 void
1049ins_mouse(int c)
1050{
1051 pos_T tpos;
1052 win_T *old_curwin = curwin;
1053
1054# ifdef FEAT_GUI
1055 // When GUI is active, also move/paste when 'mouse' is empty
1056 if (!gui.in_use)
1057# endif
1058 if (!mouse_has(MOUSE_INSERT))
1059 return;
1060
1061 undisplay_dollar();
1062 tpos = curwin->w_cursor;
1063 if (do_mouse(NULL, c, BACKWARD, 1L, 0))
1064 {
1065 win_T *new_curwin = curwin;
1066
1067 if (curwin != old_curwin && win_valid(old_curwin))
1068 {
1069 // Mouse took us to another window. We need to go back to the
1070 // previous one to stop insert there properly.
1071 curwin = old_curwin;
1072 curbuf = curwin->w_buffer;
1073#ifdef FEAT_JOB_CHANNEL
1074 if (bt_prompt(curbuf))
1075 // Restart Insert mode when re-entering the prompt buffer.
1076 curbuf->b_prompt_insert = 'A';
1077#endif
1078 }
1079 start_arrow(curwin == old_curwin ? &tpos : NULL);
1080 if (curwin != new_curwin && win_valid(new_curwin))
1081 {
1082 curwin = new_curwin;
1083 curbuf = curwin->w_buffer;
1084 }
1085# ifdef FEAT_CINDENT
1086 set_can_cindent(TRUE);
1087# endif
1088 }
1089
1090 // redraw status lines (in case another window became active)
1091 redraw_statuslines();
1092}
1093
1094 void
1095ins_mousescroll(int dir)
1096{
1097 pos_T tpos;
1098 win_T *old_curwin = curwin, *wp;
1099 int did_scroll = FALSE;
1100
1101 tpos = curwin->w_cursor;
1102
1103 if (mouse_row >= 0 && mouse_col >= 0)
1104 {
1105 int row, col;
1106
1107 row = mouse_row;
1108 col = mouse_col;
1109
1110 // find the window at the pointer coordinates
1111 wp = mouse_find_win(&row, &col, FIND_POPUP);
1112 if (wp == NULL)
1113 return;
1114 curwin = wp;
1115 curbuf = curwin->w_buffer;
1116 }
1117 if (curwin == old_curwin)
1118 undisplay_dollar();
1119
1120 // Don't scroll the window in which completion is being done.
1121 if (!pum_visible() || curwin != old_curwin)
1122 {
LemonBoyc27747e2022-05-07 12:25:40 +01001123 long step;
1124
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001125 if (dir == MSCR_DOWN || dir == MSCR_UP)
1126 {
LemonBoyc27747e2022-05-07 12:25:40 +01001127 if (mouse_vert_step < 0
1128 || mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
1129 step = (long)(curwin->w_botline - curwin->w_topline);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001130 else
LemonBoyc27747e2022-05-07 12:25:40 +01001131 step = mouse_vert_step;
1132 scroll_redraw(dir, step);
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001133# ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001134 if (WIN_IS_POPUP(curwin))
1135 popup_set_firstline(curwin);
1136# endif
1137 }
1138#ifdef FEAT_GUI
1139 else
1140 {
LemonBoyc27747e2022-05-07 12:25:40 +01001141 int val;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001142
LemonBoyc27747e2022-05-07 12:25:40 +01001143 if (mouse_hor_step < 0
1144 || mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001145 step = curwin->w_width;
LemonBoyc27747e2022-05-07 12:25:40 +01001146 else
1147 step = mouse_hor_step;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001148 val = curwin->w_leftcol + (dir == MSCR_RIGHT ? -step : step);
1149 if (val < 0)
1150 val = 0;
1151 gui_do_horiz_scroll(val, TRUE);
1152 }
1153#endif
1154 did_scroll = TRUE;
LemonBoy66e13ae2022-04-21 22:52:11 +01001155 may_trigger_winscrolled();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001156 }
1157
1158 curwin->w_redr_status = TRUE;
1159
1160 curwin = old_curwin;
1161 curbuf = curwin->w_buffer;
1162
1163 // The popup menu may overlay the window, need to redraw it.
1164 // TODO: Would be more efficient to only redraw the windows that are
1165 // overlapped by the popup menu.
1166 if (pum_visible() && did_scroll)
1167 {
1168 redraw_all_later(NOT_VALID);
1169 ins_compl_show_pum();
1170 }
1171
1172 if (!EQUAL_POS(curwin->w_cursor, tpos))
1173 {
1174 start_arrow(&tpos);
1175# ifdef FEAT_CINDENT
1176 set_can_cindent(TRUE);
1177# endif
1178 }
1179}
1180
1181/*
1182 * Return TRUE if "c" is a mouse key.
1183 */
1184 int
1185is_mouse_key(int c)
1186{
1187 return c == K_LEFTMOUSE
1188 || c == K_LEFTMOUSE_NM
1189 || c == K_LEFTDRAG
1190 || c == K_LEFTRELEASE
1191 || c == K_LEFTRELEASE_NM
1192 || c == K_MOUSEMOVE
1193 || c == K_MIDDLEMOUSE
1194 || c == K_MIDDLEDRAG
1195 || c == K_MIDDLERELEASE
1196 || c == K_RIGHTMOUSE
1197 || c == K_RIGHTDRAG
1198 || c == K_RIGHTRELEASE
1199 || c == K_MOUSEDOWN
1200 || c == K_MOUSEUP
1201 || c == K_MOUSELEFT
1202 || c == K_MOUSERIGHT
1203 || c == K_X1MOUSE
1204 || c == K_X1DRAG
1205 || c == K_X1RELEASE
1206 || c == K_X2MOUSE
1207 || c == K_X2DRAG
1208 || c == K_X2RELEASE;
1209}
1210
1211static struct mousetable
1212{
1213 int pseudo_code; // Code for pseudo mouse event
1214 int button; // Which mouse button is it?
1215 int is_click; // Is it a mouse button click event?
1216 int is_drag; // Is it a mouse drag event?
1217} mouse_table[] =
1218{
1219 {(int)KE_LEFTMOUSE, MOUSE_LEFT, TRUE, FALSE},
1220#ifdef FEAT_GUI
1221 {(int)KE_LEFTMOUSE_NM, MOUSE_LEFT, TRUE, FALSE},
1222#endif
1223 {(int)KE_LEFTDRAG, MOUSE_LEFT, FALSE, TRUE},
1224 {(int)KE_LEFTRELEASE, MOUSE_LEFT, FALSE, FALSE},
1225#ifdef FEAT_GUI
1226 {(int)KE_LEFTRELEASE_NM, MOUSE_LEFT, FALSE, FALSE},
1227#endif
1228 {(int)KE_MIDDLEMOUSE, MOUSE_MIDDLE, TRUE, FALSE},
1229 {(int)KE_MIDDLEDRAG, MOUSE_MIDDLE, FALSE, TRUE},
1230 {(int)KE_MIDDLERELEASE, MOUSE_MIDDLE, FALSE, FALSE},
1231 {(int)KE_RIGHTMOUSE, MOUSE_RIGHT, TRUE, FALSE},
1232 {(int)KE_RIGHTDRAG, MOUSE_RIGHT, FALSE, TRUE},
1233 {(int)KE_RIGHTRELEASE, MOUSE_RIGHT, FALSE, FALSE},
1234 {(int)KE_X1MOUSE, MOUSE_X1, TRUE, FALSE},
1235 {(int)KE_X1DRAG, MOUSE_X1, FALSE, TRUE},
1236 {(int)KE_X1RELEASE, MOUSE_X1, FALSE, FALSE},
1237 {(int)KE_X2MOUSE, MOUSE_X2, TRUE, FALSE},
1238 {(int)KE_X2DRAG, MOUSE_X2, FALSE, TRUE},
1239 {(int)KE_X2RELEASE, MOUSE_X2, FALSE, FALSE},
1240 // DRAG without CLICK
1241 {(int)KE_MOUSEMOVE, MOUSE_RELEASE, FALSE, TRUE},
1242 // RELEASE without CLICK
1243 {(int)KE_IGNORE, MOUSE_RELEASE, FALSE, FALSE},
1244 {0, 0, 0, 0},
1245};
1246
1247/*
1248 * Look up the given mouse code to return the relevant information in the other
1249 * arguments. Return which button is down or was released.
1250 */
1251 int
1252get_mouse_button(int code, int *is_click, int *is_drag)
1253{
1254 int i;
1255
1256 for (i = 0; mouse_table[i].pseudo_code; i++)
1257 if (code == mouse_table[i].pseudo_code)
1258 {
1259 *is_click = mouse_table[i].is_click;
1260 *is_drag = mouse_table[i].is_drag;
1261 return mouse_table[i].button;
1262 }
1263 return 0; // Shouldn't get here
1264}
1265
1266/*
1267 * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on
1268 * the given information about which mouse button is down, and whether the
1269 * mouse was clicked, dragged or released.
1270 */
1271 int
1272get_pseudo_mouse_code(
1273 int button, // eg MOUSE_LEFT
1274 int is_click,
1275 int is_drag)
1276{
1277 int i;
1278
1279 for (i = 0; mouse_table[i].pseudo_code; i++)
1280 if (button == mouse_table[i].button
1281 && is_click == mouse_table[i].is_click
1282 && is_drag == mouse_table[i].is_drag)
1283 {
1284#ifdef FEAT_GUI
1285 // Trick: a non mappable left click and release has mouse_col -1
1286 // or added MOUSE_COLOFF. Used for 'mousefocus' in
1287 // gui_mouse_moved()
1288 if (mouse_col < 0 || mouse_col > MOUSE_COLOFF)
1289 {
1290 if (mouse_col < 0)
1291 mouse_col = 0;
1292 else
1293 mouse_col -= MOUSE_COLOFF;
1294 if (mouse_table[i].pseudo_code == (int)KE_LEFTMOUSE)
1295 return (int)KE_LEFTMOUSE_NM;
1296 if (mouse_table[i].pseudo_code == (int)KE_LEFTRELEASE)
1297 return (int)KE_LEFTRELEASE_NM;
1298 }
1299#endif
1300 return mouse_table[i].pseudo_code;
1301 }
1302 return (int)KE_IGNORE; // not recognized, ignore it
1303}
1304
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001305# define HMT_NORMAL 1
1306# define HMT_NETTERM 2
1307# define HMT_DEC 4
1308# define HMT_JSBTERM 8
1309# define HMT_PTERM 16
1310# define HMT_URXVT 32
1311# define HMT_GPM 64
1312# define HMT_SGR 128
1313# define HMT_SGR_REL 256
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001314static int has_mouse_termcode = 0;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001315
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001316 void
1317set_mouse_termcode(
1318 int n, // KS_MOUSE, KS_NETTERM_MOUSE or KS_DEC_MOUSE
1319 char_u *s)
1320{
1321 char_u name[2];
1322
1323 name[0] = n;
1324 name[1] = KE_FILLER;
1325 add_termcode(name, s, FALSE);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001326# ifdef FEAT_MOUSE_JSB
1327 if (n == KS_JSBTERM_MOUSE)
1328 has_mouse_termcode |= HMT_JSBTERM;
1329 else
1330# endif
1331# ifdef FEAT_MOUSE_NET
1332 if (n == KS_NETTERM_MOUSE)
1333 has_mouse_termcode |= HMT_NETTERM;
1334 else
1335# endif
1336# ifdef FEAT_MOUSE_DEC
1337 if (n == KS_DEC_MOUSE)
1338 has_mouse_termcode |= HMT_DEC;
1339 else
1340# endif
1341# ifdef FEAT_MOUSE_PTERM
1342 if (n == KS_PTERM_MOUSE)
1343 has_mouse_termcode |= HMT_PTERM;
1344 else
1345# endif
1346# ifdef FEAT_MOUSE_URXVT
1347 if (n == KS_URXVT_MOUSE)
1348 has_mouse_termcode |= HMT_URXVT;
1349 else
1350# endif
1351# ifdef FEAT_MOUSE_GPM
1352 if (n == KS_GPM_MOUSE)
1353 has_mouse_termcode |= HMT_GPM;
1354 else
1355# endif
1356 if (n == KS_SGR_MOUSE)
1357 has_mouse_termcode |= HMT_SGR;
1358 else if (n == KS_SGR_MOUSE_RELEASE)
1359 has_mouse_termcode |= HMT_SGR_REL;
1360 else
1361 has_mouse_termcode |= HMT_NORMAL;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001362}
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001363
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001364# if defined(UNIX) || defined(VMS) || defined(PROTO)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001365 void
1366del_mouse_termcode(
1367 int n) // KS_MOUSE, KS_NETTERM_MOUSE or KS_DEC_MOUSE
1368{
1369 char_u name[2];
1370
1371 name[0] = n;
1372 name[1] = KE_FILLER;
1373 del_termcode(name);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001374# ifdef FEAT_MOUSE_JSB
1375 if (n == KS_JSBTERM_MOUSE)
1376 has_mouse_termcode &= ~HMT_JSBTERM;
1377 else
1378# endif
1379# ifdef FEAT_MOUSE_NET
1380 if (n == KS_NETTERM_MOUSE)
1381 has_mouse_termcode &= ~HMT_NETTERM;
1382 else
1383# endif
1384# ifdef FEAT_MOUSE_DEC
1385 if (n == KS_DEC_MOUSE)
1386 has_mouse_termcode &= ~HMT_DEC;
1387 else
1388# endif
1389# ifdef FEAT_MOUSE_PTERM
1390 if (n == KS_PTERM_MOUSE)
1391 has_mouse_termcode &= ~HMT_PTERM;
1392 else
1393# endif
1394# ifdef FEAT_MOUSE_URXVT
1395 if (n == KS_URXVT_MOUSE)
1396 has_mouse_termcode &= ~HMT_URXVT;
1397 else
1398# endif
1399# ifdef FEAT_MOUSE_GPM
1400 if (n == KS_GPM_MOUSE)
1401 has_mouse_termcode &= ~HMT_GPM;
1402 else
1403# endif
1404 if (n == KS_SGR_MOUSE)
1405 has_mouse_termcode &= ~HMT_SGR;
1406 else if (n == KS_SGR_MOUSE_RELEASE)
1407 has_mouse_termcode &= ~HMT_SGR_REL;
1408 else
1409 has_mouse_termcode &= ~HMT_NORMAL;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001410}
1411# endif
1412
1413/*
1414 * setmouse() - switch mouse on/off depending on current mode and 'mouse'
1415 */
1416 void
1417setmouse(void)
1418{
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001419 int checkfor;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001420
1421# ifdef FEAT_MOUSESHAPE
1422 update_mouseshape(-1);
1423# endif
1424
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001425 // Should be outside proc, but may break MOUSESHAPE
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001426# ifdef FEAT_GUI
1427 // In the GUI the mouse is always enabled.
1428 if (gui.in_use)
1429 return;
1430# endif
1431 // be quick when mouse is off
1432 if (*p_mouse == NUL || has_mouse_termcode == 0)
1433 return;
1434
1435 // don't switch mouse on when not in raw mode (Ex mode)
1436 if (cur_tmode != TMODE_RAW)
1437 {
1438 mch_setmouse(FALSE);
1439 return;
1440 }
1441
1442 if (VIsual_active)
1443 checkfor = MOUSE_VISUAL;
1444 else if (State == HITRETURN || State == ASKMORE || State == SETWSIZE)
1445 checkfor = MOUSE_RETURN;
1446 else if (State & INSERT)
1447 checkfor = MOUSE_INSERT;
1448 else if (State & CMDLINE)
1449 checkfor = MOUSE_COMMAND;
1450 else if (State == CONFIRM || State == EXTERNCMD)
1451 checkfor = ' '; // don't use mouse for ":confirm" or ":!cmd"
1452 else
1453 checkfor = MOUSE_NORMAL; // assume normal mode
1454
1455 if (mouse_has(checkfor))
1456 mch_setmouse(TRUE);
1457 else
1458 mch_setmouse(FALSE);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001459}
1460
1461/*
1462 * Return TRUE if
1463 * - "c" is in 'mouse', or
1464 * - 'a' is in 'mouse' and "c" is in MOUSE_A, or
1465 * - the current buffer is a help file and 'h' is in 'mouse' and we are in a
1466 * normal editing mode (not at hit-return message).
1467 */
1468 int
1469mouse_has(int c)
1470{
1471 char_u *p;
1472
1473 for (p = p_mouse; *p; ++p)
1474 switch (*p)
1475 {
1476 case 'a': if (vim_strchr((char_u *)MOUSE_A, c) != NULL)
1477 return TRUE;
1478 break;
1479 case MOUSE_HELP: if (c != MOUSE_RETURN && curbuf->b_help)
1480 return TRUE;
1481 break;
1482 default: if (c == *p) return TRUE; break;
1483 }
1484 return FALSE;
1485}
1486
1487/*
1488 * Return TRUE when 'mousemodel' is set to "popup" or "popup_setpos".
1489 */
1490 int
1491mouse_model_popup(void)
1492{
1493 return (p_mousem[0] == 'p');
1494}
1495
1496/*
1497 * Move the cursor to the specified row and column on the screen.
1498 * Change current window if necessary. Returns an integer with the
1499 * CURSOR_MOVED bit set if the cursor has moved or unset otherwise.
1500 *
1501 * The MOUSE_FOLD_CLOSE bit is set when clicked on the '-' in a fold column.
1502 * The MOUSE_FOLD_OPEN bit is set when clicked on the '+' in a fold column.
1503 *
1504 * If flags has MOUSE_FOCUS, then the current window will not be changed, and
1505 * if the mouse is outside the window then the text will scroll, or if the
1506 * mouse was previously on a status line, then the status line may be dragged.
1507 *
1508 * If flags has MOUSE_MAY_VIS, then VIsual mode will be started before the
1509 * cursor is moved unless the cursor was on a status line.
1510 * This function returns one of IN_UNKNOWN, IN_BUFFER, IN_STATUS_LINE or
1511 * IN_SEP_LINE depending on where the cursor was clicked.
1512 *
1513 * If flags has MOUSE_MAY_STOP_VIS, then Visual mode will be stopped, unless
1514 * the mouse is on the status line of the same window.
1515 *
1516 * If flags has MOUSE_DID_MOVE, nothing is done if the mouse didn't move since
1517 * the last call.
1518 *
1519 * If flags has MOUSE_SETPOS, nothing is done, only the current position is
1520 * remembered.
1521 */
1522 int
1523jump_to_mouse(
1524 int flags,
1525 int *inclusive, // used for inclusive operator, can be NULL
1526 int which_button) // MOUSE_LEFT, MOUSE_RIGHT, MOUSE_MIDDLE
1527{
1528 static int on_status_line = 0; // #lines below bottom of window
1529 static int on_sep_line = 0; // on separator right of window
1530#ifdef FEAT_MENU
1531 static int in_winbar = FALSE;
1532#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001533#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001534 static int in_popup_win = FALSE;
1535 static win_T *click_in_popup_win = NULL;
1536#endif
1537 static int prev_row = -1;
1538 static int prev_col = -1;
1539 static win_T *dragwin = NULL; // window being dragged
1540 static int did_drag = FALSE; // drag was noticed
1541
1542 win_T *wp, *old_curwin;
1543 pos_T old_cursor;
1544 int count;
1545 int first;
1546 int row = mouse_row;
1547 int col = mouse_col;
1548#ifdef FEAT_FOLDING
1549 int mouse_char;
1550#endif
1551
1552 mouse_past_bottom = FALSE;
1553 mouse_past_eol = FALSE;
1554
1555 if (flags & MOUSE_RELEASED)
1556 {
1557 // On button release we may change window focus if positioned on a
1558 // status line and no dragging happened.
1559 if (dragwin != NULL && !did_drag)
1560 flags &= ~(MOUSE_FOCUS | MOUSE_DID_MOVE);
1561 dragwin = NULL;
1562 did_drag = FALSE;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001563#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001564 if (click_in_popup_win != NULL && popup_dragwin == NULL)
1565 popup_close_for_mouse_click(click_in_popup_win);
1566
1567 popup_dragwin = NULL;
1568 click_in_popup_win = NULL;
1569#endif
1570 }
1571
1572 if ((flags & MOUSE_DID_MOVE)
1573 && prev_row == mouse_row
1574 && prev_col == mouse_col)
1575 {
1576retnomove:
1577 // before moving the cursor for a left click which is NOT in a status
1578 // line, stop Visual mode
1579 if (on_status_line)
1580 return IN_STATUS_LINE;
1581 if (on_sep_line)
1582 return IN_SEP_LINE;
1583#ifdef FEAT_MENU
1584 if (in_winbar)
1585 {
1586 // A quick second click may arrive as a double-click, but we use it
1587 // as a second click in the WinBar.
1588 if ((mod_mask & MOD_MASK_MULTI_CLICK) && !(flags & MOUSE_RELEASED))
1589 {
1590 wp = mouse_find_win(&row, &col, FAIL_POPUP);
1591 if (wp == NULL)
1592 return IN_UNKNOWN;
1593 winbar_click(wp, col);
1594 }
1595 return IN_OTHER_WIN | MOUSE_WINBAR;
1596 }
1597#endif
1598 if (flags & MOUSE_MAY_STOP_VIS)
1599 {
Bram Moolenaar4f3c57f2021-06-03 22:11:08 +02001600 end_visual_mode_keep_button();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001601 redraw_curbuf_later(INVERTED); // delete the inversion
1602 }
1603#if defined(FEAT_CMDWIN) && defined(FEAT_CLIPBOARD)
1604 // Continue a modeless selection in another window.
1605 if (cmdwin_type != 0 && row < curwin->w_winrow)
1606 return IN_OTHER_WIN;
1607#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001608#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001609 // Continue a modeless selection in a popup window or dragging it.
1610 if (in_popup_win)
1611 {
1612 click_in_popup_win = NULL; // don't close it on release
1613 if (popup_dragwin != NULL)
1614 {
1615 // dragging a popup window
1616 popup_drag(popup_dragwin);
1617 return IN_UNKNOWN;
1618 }
1619 return IN_OTHER_WIN;
1620 }
1621#endif
1622 return IN_BUFFER;
1623 }
1624
1625 prev_row = mouse_row;
1626 prev_col = mouse_col;
1627
1628 if (flags & MOUSE_SETPOS)
1629 goto retnomove; // ugly goto...
1630
1631#ifdef FEAT_FOLDING
1632 // Remember the character under the mouse, it might be a '-' or '+' in the
1633 // fold column.
1634 if (row >= 0 && row < Rows && col >= 0 && col <= Columns
1635 && ScreenLines != NULL)
1636 mouse_char = ScreenLines[LineOffset[row] + col];
1637 else
1638 mouse_char = ' ';
1639#endif
1640
1641 old_curwin = curwin;
1642 old_cursor = curwin->w_cursor;
1643
1644 if (!(flags & MOUSE_FOCUS))
1645 {
1646 if (row < 0 || col < 0) // check if it makes sense
1647 return IN_UNKNOWN;
1648
1649 // find the window where the row is in and adjust "row" and "col" to be
1650 // relative to top-left of the window
1651 wp = mouse_find_win(&row, &col, FIND_POPUP);
1652 if (wp == NULL)
1653 return IN_UNKNOWN;
1654 dragwin = NULL;
1655
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001656#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001657 // Click in a popup window may start dragging or modeless selection,
1658 // but not much else.
1659 if (WIN_IS_POPUP(wp))
1660 {
1661 on_sep_line = 0;
Bram Moolenaarbfc57862021-11-26 15:57:40 +00001662 on_status_line = 0;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001663 in_popup_win = TRUE;
1664 if (which_button == MOUSE_LEFT && popup_close_if_on_X(wp, row, col))
1665 {
1666 return IN_UNKNOWN;
1667 }
Bram Moolenaar0b74d002021-11-29 17:38:02 +00001668 else if (((wp->w_popup_flags & (POPF_DRAG | POPF_RESIZE))
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001669 && popup_on_border(wp, row, col))
Bram Moolenaar0b74d002021-11-29 17:38:02 +00001670 || (wp->w_popup_flags & POPF_DRAGALL))
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001671 {
1672 popup_dragwin = wp;
1673 popup_start_drag(wp, row, col);
1674 return IN_UNKNOWN;
1675 }
1676 // Only close on release, otherwise it's not possible to drag or do
1677 // modeless selection.
1678 else if (wp->w_popup_close == POPCLOSE_CLICK
1679 && which_button == MOUSE_LEFT)
1680 {
1681 click_in_popup_win = wp;
1682 }
1683 else if (which_button == MOUSE_LEFT)
1684 // If the click is in the scrollbar, may scroll up/down.
1685 popup_handle_scrollbar_click(wp, row, col);
1686# ifdef FEAT_CLIPBOARD
1687 return IN_OTHER_WIN;
1688# else
1689 return IN_UNKNOWN;
1690# endif
1691 }
1692 in_popup_win = FALSE;
1693 popup_dragwin = NULL;
1694#endif
1695#ifdef FEAT_MENU
1696 if (row == -1)
1697 {
1698 // A click in the window toolbar does not enter another window or
1699 // change Visual highlighting.
1700 winbar_click(wp, col);
1701 in_winbar = TRUE;
1702 return IN_OTHER_WIN | MOUSE_WINBAR;
1703 }
1704 in_winbar = FALSE;
1705#endif
1706
1707 // winpos and height may change in win_enter()!
1708 if (row >= wp->w_height) // In (or below) status line
1709 {
1710 on_status_line = row - wp->w_height + 1;
1711 dragwin = wp;
1712 }
1713 else
1714 on_status_line = 0;
1715 if (col >= wp->w_width) // In separator line
1716 {
1717 on_sep_line = col - wp->w_width + 1;
1718 dragwin = wp;
1719 }
1720 else
1721 on_sep_line = 0;
1722
1723 // The rightmost character of the status line might be a vertical
1724 // separator character if there is no connecting window to the right.
1725 if (on_status_line && on_sep_line)
1726 {
1727 if (stl_connected(wp))
1728 on_sep_line = 0;
1729 else
1730 on_status_line = 0;
1731 }
1732
1733 // Before jumping to another buffer, or moving the cursor for a left
1734 // click, stop Visual mode.
1735 if (VIsual_active
1736 && (wp->w_buffer != curwin->w_buffer
1737 || (!on_status_line && !on_sep_line
1738#ifdef FEAT_FOLDING
1739 && (
1740# ifdef FEAT_RIGHTLEFT
1741 wp->w_p_rl ? col < wp->w_width - wp->w_p_fdc :
1742# endif
1743 col >= wp->w_p_fdc
1744# ifdef FEAT_CMDWIN
1745 + (cmdwin_type == 0 && wp == curwin ? 0 : 1)
1746# endif
1747 )
1748#endif
1749 && (flags & MOUSE_MAY_STOP_VIS))))
1750 {
Bram Moolenaar4f3c57f2021-06-03 22:11:08 +02001751 end_visual_mode_keep_button();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001752 redraw_curbuf_later(INVERTED); // delete the inversion
1753 }
1754#ifdef FEAT_CMDWIN
1755 if (cmdwin_type != 0 && wp != curwin)
1756 {
1757 // A click outside the command-line window: Use modeless
1758 // selection if possible. Allow dragging the status lines.
1759 on_sep_line = 0;
1760# ifdef FEAT_CLIPBOARD
1761 if (on_status_line)
1762 return IN_STATUS_LINE;
1763 return IN_OTHER_WIN;
1764# else
1765 row = 0;
1766 col += wp->w_wincol;
1767 wp = curwin;
1768# endif
1769 }
1770#endif
Bram Moolenaar219c7d02020-02-01 21:57:29 +01001771#if defined(FEAT_PROP_POPUP) && defined(FEAT_TERMINAL)
1772 if (popup_is_popup(curwin) && curbuf->b_term != NULL)
1773 // terminal in popup window: don't jump to another window
1774 return IN_OTHER_WIN;
1775#endif
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001776 // Only change window focus when not clicking on or dragging the
1777 // status line. Do change focus when releasing the mouse button
1778 // (MOUSE_FOCUS was set above if we dragged first).
1779 if (dragwin == NULL || (flags & MOUSE_RELEASED))
1780 win_enter(wp, TRUE); // can make wp invalid!
1781
1782 if (curwin != old_curwin)
1783 {
1784#ifdef CHECK_DOUBLE_CLICK
1785 // set topline, to be able to check for double click ourselves
1786 set_mouse_topline(curwin);
1787#endif
1788#ifdef FEAT_TERMINAL
1789 // when entering a terminal window may change state
1790 term_win_entered();
1791#endif
1792 }
1793 if (on_status_line) // In (or below) status line
1794 {
1795 // Don't use start_arrow() if we're in the same window
1796 if (curwin == old_curwin)
1797 return IN_STATUS_LINE;
1798 else
1799 return IN_STATUS_LINE | CURSOR_MOVED;
1800 }
1801 if (on_sep_line) // In (or below) status line
1802 {
1803 // Don't use start_arrow() if we're in the same window
1804 if (curwin == old_curwin)
1805 return IN_SEP_LINE;
1806 else
1807 return IN_SEP_LINE | CURSOR_MOVED;
1808 }
1809
1810 curwin->w_cursor.lnum = curwin->w_topline;
1811#ifdef FEAT_GUI
1812 // remember topline, needed for double click
1813 gui_prev_topline = curwin->w_topline;
1814# ifdef FEAT_DIFF
1815 gui_prev_topfill = curwin->w_topfill;
1816# endif
1817#endif
1818 }
1819 else if (on_status_line && which_button == MOUSE_LEFT)
1820 {
1821 if (dragwin != NULL)
1822 {
1823 // Drag the status line
1824 count = row - dragwin->w_winrow - dragwin->w_height + 1
1825 - on_status_line;
1826 win_drag_status_line(dragwin, count);
1827 did_drag |= count;
1828 }
1829 return IN_STATUS_LINE; // Cursor didn't move
1830 }
1831 else if (on_sep_line && which_button == MOUSE_LEFT)
1832 {
1833 if (dragwin != NULL)
1834 {
1835 // Drag the separator column
1836 count = col - dragwin->w_wincol - dragwin->w_width + 1
1837 - on_sep_line;
1838 win_drag_vsep_line(dragwin, count);
1839 did_drag |= count;
1840 }
1841 return IN_SEP_LINE; // Cursor didn't move
1842 }
1843#ifdef FEAT_MENU
1844 else if (in_winbar)
1845 {
1846 // After a click on the window toolbar don't start Visual mode.
1847 return IN_OTHER_WIN | MOUSE_WINBAR;
1848 }
1849#endif
1850 else // keep_window_focus must be TRUE
1851 {
1852 // before moving the cursor for a left click, stop Visual mode
1853 if (flags & MOUSE_MAY_STOP_VIS)
1854 {
Bram Moolenaar4f3c57f2021-06-03 22:11:08 +02001855 end_visual_mode_keep_button();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001856 redraw_curbuf_later(INVERTED); // delete the inversion
1857 }
1858
1859#if defined(FEAT_CMDWIN) && defined(FEAT_CLIPBOARD)
1860 // Continue a modeless selection in another window.
1861 if (cmdwin_type != 0 && row < curwin->w_winrow)
1862 return IN_OTHER_WIN;
1863#endif
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01001864#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02001865 if (in_popup_win)
1866 {
1867 if (popup_dragwin != NULL)
1868 {
1869 // dragging a popup window
1870 popup_drag(popup_dragwin);
1871 return IN_UNKNOWN;
1872 }
1873 // continue a modeless selection in a popup window
1874 click_in_popup_win = NULL;
1875 return IN_OTHER_WIN;
1876 }
1877#endif
1878
1879 row -= W_WINROW(curwin);
1880 col -= curwin->w_wincol;
1881
1882 // When clicking beyond the end of the window, scroll the screen.
1883 // Scroll by however many rows outside the window we are.
1884 if (row < 0)
1885 {
1886 count = 0;
1887 for (first = TRUE; curwin->w_topline > 1; )
1888 {
1889#ifdef FEAT_DIFF
1890 if (curwin->w_topfill < diff_check(curwin, curwin->w_topline))
1891 ++count;
1892 else
1893#endif
1894 count += plines(curwin->w_topline - 1);
1895 if (!first && count > -row)
1896 break;
1897 first = FALSE;
1898#ifdef FEAT_FOLDING
1899 (void)hasFolding(curwin->w_topline, &curwin->w_topline, NULL);
1900#endif
1901#ifdef FEAT_DIFF
1902 if (curwin->w_topfill < diff_check(curwin, curwin->w_topline))
1903 ++curwin->w_topfill;
1904 else
1905#endif
1906 {
1907 --curwin->w_topline;
1908#ifdef FEAT_DIFF
1909 curwin->w_topfill = 0;
1910#endif
1911 }
1912 }
1913#ifdef FEAT_DIFF
1914 check_topfill(curwin, FALSE);
1915#endif
1916 curwin->w_valid &=
1917 ~(VALID_WROW|VALID_CROW|VALID_BOTLINE|VALID_BOTLINE_AP);
1918 redraw_later(VALID);
1919 row = 0;
1920 }
1921 else if (row >= curwin->w_height)
1922 {
1923 count = 0;
1924 for (first = TRUE; curwin->w_topline < curbuf->b_ml.ml_line_count; )
1925 {
1926#ifdef FEAT_DIFF
1927 if (curwin->w_topfill > 0)
1928 ++count;
1929 else
1930#endif
1931 count += plines(curwin->w_topline);
1932 if (!first && count > row - curwin->w_height + 1)
1933 break;
1934 first = FALSE;
1935#ifdef FEAT_FOLDING
1936 if (hasFolding(curwin->w_topline, NULL, &curwin->w_topline)
1937 && curwin->w_topline == curbuf->b_ml.ml_line_count)
1938 break;
1939#endif
1940#ifdef FEAT_DIFF
1941 if (curwin->w_topfill > 0)
1942 --curwin->w_topfill;
1943 else
1944#endif
1945 {
1946 ++curwin->w_topline;
1947#ifdef FEAT_DIFF
1948 curwin->w_topfill =
1949 diff_check_fill(curwin, curwin->w_topline);
1950#endif
1951 }
1952 }
1953#ifdef FEAT_DIFF
1954 check_topfill(curwin, FALSE);
1955#endif
1956 redraw_later(VALID);
1957 curwin->w_valid &=
1958 ~(VALID_WROW|VALID_CROW|VALID_BOTLINE|VALID_BOTLINE_AP);
1959 row = curwin->w_height - 1;
1960 }
1961 else if (row == 0)
1962 {
1963 // When dragging the mouse, while the text has been scrolled up as
1964 // far as it goes, moving the mouse in the top line should scroll
1965 // the text down (done later when recomputing w_topline).
1966 if (mouse_dragging > 0
1967 && curwin->w_cursor.lnum
1968 == curwin->w_buffer->b_ml.ml_line_count
1969 && curwin->w_cursor.lnum == curwin->w_topline)
1970 curwin->w_valid &= ~(VALID_TOPLINE);
1971 }
1972 }
1973
1974#ifdef FEAT_FOLDING
1975 // Check for position outside of the fold column.
1976 if (
1977# ifdef FEAT_RIGHTLEFT
1978 curwin->w_p_rl ? col < curwin->w_width - curwin->w_p_fdc :
1979# endif
1980 col >= curwin->w_p_fdc
1981# ifdef FEAT_CMDWIN
1982 + (cmdwin_type == 0 ? 0 : 1)
1983# endif
1984 )
1985 mouse_char = ' ';
1986#endif
1987
1988 // compute the position in the buffer line from the posn on the screen
1989 if (mouse_comp_pos(curwin, &row, &col, &curwin->w_cursor.lnum, NULL))
1990 mouse_past_bottom = TRUE;
1991
1992 // Start Visual mode before coladvance(), for when 'sel' != "old"
1993 if ((flags & MOUSE_MAY_VIS) && !VIsual_active)
1994 {
1995 check_visual_highlight();
1996 VIsual = old_cursor;
1997 VIsual_active = TRUE;
1998 VIsual_reselect = TRUE;
1999 // if 'selectmode' contains "mouse", start Select mode
2000 may_start_select('o');
2001 setmouse();
2002 if (p_smd && msg_silent == 0)
2003 redraw_cmdline = TRUE; // show visual mode later
2004 }
2005
2006 curwin->w_curswant = col;
2007 curwin->w_set_curswant = FALSE; // May still have been TRUE
2008 if (coladvance(col) == FAIL) // Mouse click beyond end of line
2009 {
2010 if (inclusive != NULL)
2011 *inclusive = TRUE;
2012 mouse_past_eol = TRUE;
2013 }
2014 else if (inclusive != NULL)
2015 *inclusive = FALSE;
2016
2017 count = IN_BUFFER;
2018 if (curwin != old_curwin || curwin->w_cursor.lnum != old_cursor.lnum
2019 || curwin->w_cursor.col != old_cursor.col)
2020 count |= CURSOR_MOVED; // Cursor has moved
2021
2022# ifdef FEAT_FOLDING
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01002023 if (mouse_char == fill_foldclosed)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002024 count |= MOUSE_FOLD_OPEN;
2025 else if (mouse_char != ' ')
2026 count |= MOUSE_FOLD_CLOSE;
2027# endif
2028
2029 return count;
2030}
2031
2032/*
LemonBoyc27747e2022-05-07 12:25:40 +01002033 * Mouse scroll wheel: Default action is to scroll mouse_vert_step lines (or
2034 * mouse_hor_step, depending on the scroll direction), or one page when Shift or
2035 * Ctrl is used.
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002036 * K_MOUSEUP (cap->arg == 1) or K_MOUSEDOWN (cap->arg == 0) or
2037 * K_MOUSELEFT (cap->arg == -1) or K_MOUSERIGHT (cap->arg == -2)
2038 */
2039 void
2040nv_mousescroll(cmdarg_T *cap)
2041{
2042 win_T *old_curwin = curwin, *wp;
2043
2044 if (mouse_row >= 0 && mouse_col >= 0)
2045 {
2046 int row, col;
2047
2048 row = mouse_row;
2049 col = mouse_col;
2050
2051 // find the window at the pointer coordinates
2052 wp = mouse_find_win(&row, &col, FIND_POPUP);
2053 if (wp == NULL)
2054 return;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002055#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002056 if (WIN_IS_POPUP(wp) && !wp->w_has_scrollbar)
2057 return;
2058#endif
2059 curwin = wp;
2060 curbuf = curwin->w_buffer;
2061 }
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002062 if (cap->arg == MSCR_UP || cap->arg == MSCR_DOWN)
2063 {
2064# ifdef FEAT_TERMINAL
2065 if (term_use_loop())
2066 // This window is a terminal window, send the mouse event there.
2067 // Set "typed" to FALSE to avoid an endless loop.
Bram Moolenaar1e814bc2019-11-03 21:19:41 +01002068 send_keys_to_term(curbuf->b_term, cap->cmdchar, mod_mask, FALSE);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002069 else
2070# endif
LemonBoyc27747e2022-05-07 12:25:40 +01002071 if (mouse_vert_step < 0 || mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002072 {
2073 (void)onepage(cap->arg ? FORWARD : BACKWARD, 1L);
2074 }
2075 else
2076 {
2077 // Don't scroll more than half the window height.
LemonBoyc27747e2022-05-07 12:25:40 +01002078 if (curwin->w_height < mouse_vert_step * 2)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002079 {
2080 cap->count1 = curwin->w_height / 2;
2081 if (cap->count1 == 0)
2082 cap->count1 = 1;
2083 }
2084 else
LemonBoyc27747e2022-05-07 12:25:40 +01002085 cap->count1 = mouse_vert_step;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002086 cap->count0 = cap->count1;
2087 nv_scroll_line(cap);
2088 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002089#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002090 if (WIN_IS_POPUP(curwin))
2091 popup_set_firstline(curwin);
2092#endif
2093 }
2094# ifdef FEAT_GUI
2095 else
2096 {
2097 // Horizontal scroll - only allowed when 'wrap' is disabled
2098 if (!curwin->w_p_wrap)
2099 {
LemonBoyc27747e2022-05-07 12:25:40 +01002100 int val, step;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002101
LemonBoyc27747e2022-05-07 12:25:40 +01002102 if (mouse_hor_step < 0
2103 || mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002104 step = curwin->w_width;
LemonBoyc27747e2022-05-07 12:25:40 +01002105 else
2106 step = mouse_hor_step;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002107 val = curwin->w_leftcol + (cap->arg == MSCR_RIGHT ? -step : +step);
2108 if (val < 0)
2109 val = 0;
2110
2111 gui_do_horiz_scroll(val, TRUE);
2112 }
2113 }
2114# endif
2115# ifdef FEAT_SYN_HL
2116 if (curwin != old_curwin && curwin->w_p_cul)
2117 redraw_for_cursorline(curwin);
2118# endif
LemonBoy66e13ae2022-04-21 22:52:11 +01002119 may_trigger_winscrolled();
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002120
2121 curwin->w_redr_status = TRUE;
2122
2123 curwin = old_curwin;
2124 curbuf = curwin->w_buffer;
2125}
2126
2127/*
2128 * Mouse clicks and drags.
2129 */
2130 void
2131nv_mouse(cmdarg_T *cap)
2132{
2133 (void)do_mouse(cap->oap, cap->cmdchar, BACKWARD, cap->count1, 0);
2134}
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002135
Bram Moolenaar85eee5b2021-06-03 20:34:57 +02002136static int held_button = MOUSE_RELEASE;
2137
2138 void
2139reset_held_button()
2140{
2141 held_button = MOUSE_RELEASE;
2142}
2143
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002144/*
2145 * Check if typebuf 'tp' contains a terminal mouse code and returns the
2146 * modifiers found in typebuf in 'modifiers'.
2147 */
2148 int
2149check_termcode_mouse(
2150 char_u *tp,
2151 int *slen,
2152 char_u *key_name,
2153 char_u *modifiers_start,
2154 int idx,
2155 int *modifiers)
2156{
2157 int j;
2158 char_u *p;
2159# if !defined(UNIX) || defined(FEAT_MOUSE_XTERM) || defined(FEAT_GUI) \
2160 || defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)
2161 char_u bytes[6];
2162 int num_bytes;
2163# endif
2164 int mouse_code = 0; // init for GCC
2165 int is_click, is_drag;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002166 int is_release, release_is_ambiguous;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002167 int wheel_code = 0;
2168 int current_button;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002169 static int orig_num_clicks = 1;
2170 static int orig_mouse_code = 0x0;
2171# ifdef CHECK_DOUBLE_CLICK
2172 static int orig_mouse_col = 0;
2173 static int orig_mouse_row = 0;
2174 static struct timeval orig_mouse_time = {0, 0};
2175 // time of previous mouse click
2176 struct timeval mouse_time; // time of current mouse click
2177 long timediff; // elapsed time in msec
2178# endif
2179
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002180 is_click = is_drag = is_release = release_is_ambiguous = FALSE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002181
2182# if !defined(UNIX) || defined(FEAT_MOUSE_XTERM) || defined(FEAT_GUI) \
2183 || defined(FEAT_MOUSE_GPM) || defined(FEAT_SYSMOUSE)
2184 if (key_name[0] == KS_MOUSE
2185# ifdef FEAT_MOUSE_GPM
2186 || key_name[0] == KS_GPM_MOUSE
2187# endif
2188 )
2189 {
2190 /*
Bram Moolenaar13c04632020-07-12 13:47:42 +02002191 * For xterm we get "<t_mouse>scr", where s == encoded button state:
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002192 * 0x20 = left button down
2193 * 0x21 = middle button down
2194 * 0x22 = right button down
2195 * 0x23 = any button release
2196 * 0x60 = button 4 down (scroll wheel down)
2197 * 0x61 = button 5 down (scroll wheel up)
2198 * add 0x04 for SHIFT
2199 * add 0x08 for ALT
2200 * add 0x10 for CTRL
2201 * add 0x20 for mouse drag (0x40 is drag with left button)
2202 * add 0x40 for mouse move (0x80 is move, 0x81 too)
2203 * 0x43 (drag + release) is also move
2204 * c == column + ' ' + 1 == column + 33
2205 * r == row + ' ' + 1 == row + 33
2206 *
Bram Moolenaar13c04632020-07-12 13:47:42 +02002207 * The coordinates are passed on through global variables. Ugly, but
2208 * this avoids trouble with mouse clicks at an unexpected moment and
2209 * allows for mapping them.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002210 */
2211 for (;;)
2212 {
2213# ifdef FEAT_GUI
2214 if (gui.in_use)
2215 {
2216 // GUI uses more bits for columns > 223
2217 num_bytes = get_bytes_from_buf(tp + *slen, bytes, 5);
2218 if (num_bytes == -1) // not enough coordinates
2219 return -1;
2220 mouse_code = bytes[0];
2221 mouse_col = 128 * (bytes[1] - ' ' - 1)
2222 + bytes[2] - ' ' - 1;
2223 mouse_row = 128 * (bytes[3] - ' ' - 1)
2224 + bytes[4] - ' ' - 1;
2225 }
2226 else
2227# endif
2228 {
2229 num_bytes = get_bytes_from_buf(tp + *slen, bytes, 3);
2230 if (num_bytes == -1) // not enough coordinates
2231 return -1;
2232 mouse_code = bytes[0];
2233 mouse_col = bytes[1] - ' ' - 1;
2234 mouse_row = bytes[2] - ' ' - 1;
2235 }
2236 *slen += num_bytes;
2237
Bram Moolenaar13c04632020-07-12 13:47:42 +02002238 // If the following bytes is also a mouse code and it has the same
2239 // code, dump this one and get the next. This makes dragging a
2240 // whole lot faster.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002241# ifdef FEAT_GUI
2242 if (gui.in_use)
2243 j = 3;
2244 else
2245# endif
2246 j = get_termcode_len(idx);
2247 if (STRNCMP(tp, tp + *slen, (size_t)j) == 0
2248 && tp[*slen + j] == mouse_code
2249 && tp[*slen + j + 1] != NUL
2250 && tp[*slen + j + 2] != NUL
2251# ifdef FEAT_GUI
2252 && (!gui.in_use
2253 || (tp[*slen + j + 3] != NUL
2254 && tp[*slen + j + 4] != NUL))
2255# endif
2256 )
2257 *slen += j;
2258 else
2259 break;
2260 }
2261 }
2262
2263 if (key_name[0] == KS_URXVT_MOUSE
2264 || key_name[0] == KS_SGR_MOUSE
2265 || key_name[0] == KS_SGR_MOUSE_RELEASE)
2266 {
2267 // URXVT 1015 mouse reporting mode:
Bram Moolenaar13c04632020-07-12 13:47:42 +02002268 // Almost identical to xterm mouse mode, except the values are decimal
2269 // instead of bytes.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002270 //
2271 // \033[%d;%d;%dM
2272 // ^-- row
2273 // ^----- column
2274 // ^-------- code
2275 //
2276 // SGR 1006 mouse reporting mode:
Bram Moolenaar13c04632020-07-12 13:47:42 +02002277 // Almost identical to xterm mouse mode, except the values are decimal
2278 // instead of bytes.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002279 //
2280 // \033[<%d;%d;%dM
2281 // ^-- row
2282 // ^----- column
2283 // ^-------- code
2284 //
2285 // \033[<%d;%d;%dm : mouse release event
2286 // ^-- row
2287 // ^----- column
2288 // ^-------- code
2289 p = modifiers_start;
2290 if (p == NULL)
2291 return -1;
2292
2293 mouse_code = getdigits(&p);
2294 if (*p++ != ';')
2295 return -1;
2296
2297 // when mouse reporting is SGR, add 32 to mouse code
2298 if (key_name[0] == KS_SGR_MOUSE
2299 || key_name[0] == KS_SGR_MOUSE_RELEASE)
2300 mouse_code += 32;
2301
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002302 mouse_col = getdigits(&p) - 1;
2303 if (*p++ != ';')
2304 return -1;
2305
2306 mouse_row = getdigits(&p) - 1;
2307
Bram Moolenaar13c04632020-07-12 13:47:42 +02002308 // The modifiers were the mouse coordinates, not the modifier keys
2309 // (alt/shift/ctrl/meta) state.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002310 *modifiers = 0;
2311 }
2312
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002313 if (key_name[0] == KS_SGR_MOUSE
2314 || key_name[0] == KS_SGR_MOUSE_RELEASE)
2315 {
2316 if (key_name[0] == KS_SGR_MOUSE_RELEASE)
Bram Moolenaar13c04632020-07-12 13:47:42 +02002317 {
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002318 is_release = TRUE;
Bram Moolenaar13c04632020-07-12 13:47:42 +02002319 // This is used below to set held_button.
2320 mouse_code |= MOUSE_RELEASE;
2321 }
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002322 }
2323 else
2324 {
2325 release_is_ambiguous = TRUE;
2326 if ((mouse_code & MOUSE_RELEASE) == MOUSE_RELEASE)
2327 is_release = TRUE;
2328 }
2329
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002330 if (key_name[0] == KS_MOUSE
2331# ifdef FEAT_MOUSE_GPM
2332 || key_name[0] == KS_GPM_MOUSE
2333# endif
2334# ifdef FEAT_MOUSE_URXVT
2335 || key_name[0] == KS_URXVT_MOUSE
2336# endif
2337 || key_name[0] == KS_SGR_MOUSE
2338 || key_name[0] == KS_SGR_MOUSE_RELEASE)
2339 {
2340# if !defined(MSWIN)
2341 /*
Bram Moolenaar13c04632020-07-12 13:47:42 +02002342 * Handle old style mouse events.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002343 * Recognize the xterm mouse wheel, but not in the GUI, the
2344 * Linux console with GPM and the MS-DOS or Win32 console
2345 * (multi-clicks use >= 0x60).
2346 */
2347 if (mouse_code >= MOUSEWHEEL_LOW
2348# ifdef FEAT_GUI
2349 && !gui.in_use
2350# endif
2351# ifdef FEAT_MOUSE_GPM
2352 && key_name[0] != KS_GPM_MOUSE
2353# endif
2354 )
2355 {
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002356# if defined(UNIX)
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002357 if (use_xterm_mouse() > 1 && mouse_code >= 0x80)
2358 // mouse-move event, using MOUSE_DRAG works
2359 mouse_code = MOUSE_DRAG;
2360 else
2361# endif
2362 // Keep the mouse_code before it's changed, so that we
2363 // remember that it was a mouse wheel click.
2364 wheel_code = mouse_code;
2365 }
2366# ifdef FEAT_MOUSE_XTERM
2367 else if (held_button == MOUSE_RELEASE
2368# ifdef FEAT_GUI
2369 && !gui.in_use
2370# endif
2371 && (mouse_code == 0x23 || mouse_code == 0x24
2372 || mouse_code == 0x40 || mouse_code == 0x41))
2373 {
2374 // Apparently 0x23 and 0x24 are used by rxvt scroll wheel.
2375 // And 0x40 and 0x41 are used by some xterm emulator.
2376 wheel_code = mouse_code - (mouse_code >= 0x40 ? 0x40 : 0x23)
2377 + MOUSEWHEEL_LOW;
2378 }
2379# endif
2380
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02002381# if defined(UNIX)
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002382 else if (use_xterm_mouse() > 1)
2383 {
2384 if (mouse_code & MOUSE_DRAG_XTERM)
2385 mouse_code |= MOUSE_DRAG;
2386 }
2387# endif
2388# ifdef FEAT_XCLIPBOARD
2389 else if (!(mouse_code & MOUSE_DRAG & ~MOUSE_CLICK_MASK))
2390 {
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002391 if (is_release)
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002392 stop_xterm_trace();
2393 else
2394 start_xterm_trace(mouse_code);
2395 }
2396# endif
2397# endif
2398 }
2399# endif // !UNIX || FEAT_MOUSE_XTERM
2400# ifdef FEAT_MOUSE_NET
2401 if (key_name[0] == KS_NETTERM_MOUSE)
2402 {
2403 int mc, mr;
2404
2405 // expect a rather limited sequence like: balancing {
2406 // \033}6,45\r
2407 // '6' is the row, 45 is the column
2408 p = tp + *slen;
2409 mr = getdigits(&p);
2410 if (*p++ != ',')
2411 return -1;
2412 mc = getdigits(&p);
2413 if (*p++ != '\r')
2414 return -1;
2415
2416 mouse_col = mc - 1;
2417 mouse_row = mr - 1;
2418 mouse_code = MOUSE_LEFT;
2419 *slen += (int)(p - (tp + *slen));
2420 }
2421# endif // FEAT_MOUSE_NET
2422# ifdef FEAT_MOUSE_JSB
2423 if (key_name[0] == KS_JSBTERM_MOUSE)
2424 {
2425 int mult, val, iter, button, status;
2426
2427 /*
2428 * JSBTERM Input Model
2429 * \033[0~zw uniq escape sequence
2430 * (L-x) Left button pressed - not pressed x not reporting
2431 * (M-x) Middle button pressed - not pressed x not reporting
2432 * (R-x) Right button pressed - not pressed x not reporting
Bram Moolenaar13c04632020-07-12 13:47:42 +02002433 * (SDmdu) Single , Double click, m: mouse move, d: button down,
2434 * u: button up
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002435 * ### X cursor position padded to 3 digits
2436 * ### Y cursor position padded to 3 digits
2437 * (s-x) SHIFT key pressed - not pressed x not reporting
2438 * (c-x) CTRL key pressed - not pressed x not reporting
2439 * \033\\ terminating sequence
2440 */
2441 p = tp + *slen;
2442 button = mouse_code = 0;
2443 switch (*p++)
2444 {
2445 case 'L': button = 1; break;
2446 case '-': break;
2447 case 'x': break; // ignore sequence
2448 default: return -1; // Unknown Result
2449 }
2450 switch (*p++)
2451 {
2452 case 'M': button |= 2; break;
2453 case '-': break;
2454 case 'x': break; // ignore sequence
2455 default: return -1; // Unknown Result
2456 }
2457 switch (*p++)
2458 {
2459 case 'R': button |= 4; break;
2460 case '-': break;
2461 case 'x': break; // ignore sequence
2462 default: return -1; // Unknown Result
2463 }
2464 status = *p++;
2465 for (val = 0, mult = 100, iter = 0; iter < 3; iter++,
2466 mult /= 10, p++)
2467 if (*p >= '0' && *p <= '9')
2468 val += (*p - '0') * mult;
2469 else
2470 return -1;
2471 mouse_col = val;
2472 for (val = 0, mult = 100, iter = 0; iter < 3; iter++,
2473 mult /= 10, p++)
2474 if (*p >= '0' && *p <= '9')
2475 val += (*p - '0') * mult;
2476 else
2477 return -1;
2478 mouse_row = val;
2479 switch (*p++)
2480 {
2481 case 's': button |= 8; break; // SHIFT key Pressed
2482 case '-': break; // Not Pressed
2483 case 'x': break; // Not Reporting
2484 default: return -1; // Unknown Result
2485 }
2486 switch (*p++)
2487 {
2488 case 'c': button |= 16; break; // CTRL key Pressed
2489 case '-': break; // Not Pressed
2490 case 'x': break; // Not Reporting
2491 default: return -1; // Unknown Result
2492 }
2493 if (*p++ != '\033')
2494 return -1;
2495 if (*p++ != '\\')
2496 return -1;
2497 switch (status)
2498 {
2499 case 'D': // Double Click
2500 case 'S': // Single Click
2501 if (button & 1) mouse_code |= MOUSE_LEFT;
2502 if (button & 2) mouse_code |= MOUSE_MIDDLE;
2503 if (button & 4) mouse_code |= MOUSE_RIGHT;
2504 if (button & 8) mouse_code |= MOUSE_SHIFT;
2505 if (button & 16) mouse_code |= MOUSE_CTRL;
2506 break;
2507 case 'm': // Mouse move
2508 if (button & 1) mouse_code |= MOUSE_LEFT;
2509 if (button & 2) mouse_code |= MOUSE_MIDDLE;
2510 if (button & 4) mouse_code |= MOUSE_RIGHT;
2511 if (button & 8) mouse_code |= MOUSE_SHIFT;
2512 if (button & 16) mouse_code |= MOUSE_CTRL;
2513 if ((button & 7) != 0)
2514 {
2515 held_button = mouse_code;
2516 mouse_code |= MOUSE_DRAG;
2517 }
2518 is_drag = TRUE;
2519 showmode();
2520 break;
2521 case 'd': // Button Down
2522 if (button & 1) mouse_code |= MOUSE_LEFT;
2523 if (button & 2) mouse_code |= MOUSE_MIDDLE;
2524 if (button & 4) mouse_code |= MOUSE_RIGHT;
2525 if (button & 8) mouse_code |= MOUSE_SHIFT;
2526 if (button & 16) mouse_code |= MOUSE_CTRL;
2527 break;
2528 case 'u': // Button Up
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002529 is_release = TRUE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002530 if (button & 1)
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002531 mouse_code |= MOUSE_LEFT;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002532 if (button & 2)
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002533 mouse_code |= MOUSE_MIDDLE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002534 if (button & 4)
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002535 mouse_code |= MOUSE_RIGHT;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002536 if (button & 8)
2537 mouse_code |= MOUSE_SHIFT;
2538 if (button & 16)
2539 mouse_code |= MOUSE_CTRL;
2540 break;
2541 default: return -1; // Unknown Result
2542 }
2543
2544 *slen += (p - (tp + *slen));
2545 }
2546# endif // FEAT_MOUSE_JSB
2547# ifdef FEAT_MOUSE_DEC
2548 if (key_name[0] == KS_DEC_MOUSE)
2549 {
2550 /*
2551 * The DEC Locator Input Model
2552 * Netterm delivers the code sequence:
2553 * \033[2;4;24;80&w (left button down)
2554 * \033[3;0;24;80&w (left button up)
2555 * \033[6;1;24;80&w (right button down)
2556 * \033[7;0;24;80&w (right button up)
2557 * CSI Pe ; Pb ; Pr ; Pc ; Pp & w
2558 * Pe is the event code
2559 * Pb is the button code
2560 * Pr is the row coordinate
2561 * Pc is the column coordinate
2562 * Pp is the third coordinate (page number)
2563 * Pe, the event code indicates what event caused this report
2564 * The following event codes are defined:
Bram Moolenaar13c04632020-07-12 13:47:42 +02002565 * 0 - request, the terminal received an explicit request for a
2566 * locator report, but the locator is unavailable
2567 * 1 - request, the terminal received an explicit request for a
2568 * locator report
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002569 * 2 - left button down
2570 * 3 - left button up
2571 * 4 - middle button down
2572 * 5 - middle button up
2573 * 6 - right button down
2574 * 7 - right button up
2575 * 8 - fourth button down
2576 * 9 - fourth button up
2577 * 10 - locator outside filter rectangle
Bram Moolenaar13c04632020-07-12 13:47:42 +02002578 * Pb, the button code, ASCII decimal 0-15 indicating which buttons are
2579 * down if any. The state of the four buttons on the locator
2580 * correspond to the low four bits of the decimal value, "1" means
2581 * button depressed
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002582 * 0 - no buttons down,
2583 * 1 - right,
2584 * 2 - middle,
2585 * 4 - left,
2586 * 8 - fourth
2587 * Pr is the row coordinate of the locator position in the page,
Bram Moolenaar13c04632020-07-12 13:47:42 +02002588 * encoded as an ASCII decimal value. If Pr is omitted, the locator
2589 * position is undefined (outside the terminal window for example).
2590 * Pc is the column coordinate of the locator position in the page,
2591 * encoded as an ASCII decimal value. If Pc is omitted, the locator
2592 * position is undefined (outside the terminal window for example).
2593 * Pp is the page coordinate of the locator position encoded as an
2594 * ASCII decimal value. The page coordinate may be omitted if the
2595 * locator is on page one (the default). We ignore it anyway.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002596 */
2597 int Pe, Pb, Pr, Pc;
2598
2599 p = tp + *slen;
2600
2601 // get event status
2602 Pe = getdigits(&p);
2603 if (*p++ != ';')
2604 return -1;
2605
2606 // get button status
2607 Pb = getdigits(&p);
2608 if (*p++ != ';')
2609 return -1;
2610
2611 // get row status
2612 Pr = getdigits(&p);
2613 if (*p++ != ';')
2614 return -1;
2615
2616 // get column status
2617 Pc = getdigits(&p);
2618
2619 // the page parameter is optional
2620 if (*p == ';')
2621 {
2622 p++;
2623 (void)getdigits(&p);
2624 }
2625 if (*p++ != '&')
2626 return -1;
2627 if (*p++ != 'w')
2628 return -1;
2629
2630 mouse_code = 0;
2631 switch (Pe)
2632 {
2633 case 0: return -1; // position request while unavailable
2634 case 1: // a response to a locator position request includes
2635 // the status of all buttons
2636 Pb &= 7; // mask off and ignore fourth button
2637 if (Pb & 4)
2638 mouse_code = MOUSE_LEFT;
2639 if (Pb & 2)
2640 mouse_code = MOUSE_MIDDLE;
2641 if (Pb & 1)
2642 mouse_code = MOUSE_RIGHT;
2643 if (Pb)
2644 {
2645 held_button = mouse_code;
2646 mouse_code |= MOUSE_DRAG;
2647 WantQueryMouse = TRUE;
2648 }
2649 is_drag = TRUE;
2650 showmode();
2651 break;
2652 case 2: mouse_code = MOUSE_LEFT;
2653 WantQueryMouse = TRUE;
2654 break;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002655 case 3: mouse_code = MOUSE_LEFT;
2656 is_release = TRUE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002657 break;
2658 case 4: mouse_code = MOUSE_MIDDLE;
2659 WantQueryMouse = TRUE;
2660 break;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002661 case 5: mouse_code = MOUSE_MIDDLE;
2662 is_release = TRUE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002663 break;
2664 case 6: mouse_code = MOUSE_RIGHT;
2665 WantQueryMouse = TRUE;
2666 break;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002667 case 7: mouse_code = MOUSE_RIGHT;
2668 is_release = TRUE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002669 break;
2670 case 8: return -1; // fourth button down
2671 case 9: return -1; // fourth button up
2672 case 10: return -1; // mouse outside of filter rectangle
2673 default: return -1; // should never occur
2674 }
2675
2676 mouse_col = Pc - 1;
2677 mouse_row = Pr - 1;
2678
2679 *slen += (int)(p - (tp + *slen));
2680 }
2681# endif // FEAT_MOUSE_DEC
2682# ifdef FEAT_MOUSE_PTERM
2683 if (key_name[0] == KS_PTERM_MOUSE)
2684 {
2685 int button, num_clicks, action;
2686
2687 p = tp + *slen;
2688
2689 action = getdigits(&p);
2690 if (*p++ != ';')
2691 return -1;
2692
2693 mouse_row = getdigits(&p);
2694 if (*p++ != ';')
2695 return -1;
2696 mouse_col = getdigits(&p);
2697 if (*p++ != ';')
2698 return -1;
2699
2700 button = getdigits(&p);
2701 mouse_code = 0;
2702
2703 switch (button)
2704 {
2705 case 4: mouse_code = MOUSE_LEFT; break;
2706 case 1: mouse_code = MOUSE_RIGHT; break;
2707 case 2: mouse_code = MOUSE_MIDDLE; break;
2708 default: return -1;
2709 }
2710
2711 switch (action)
2712 {
2713 case 31: // Initial press
2714 if (*p++ != ';')
2715 return -1;
2716
2717 num_clicks = getdigits(&p); // Not used
2718 break;
2719
2720 case 32: // Release
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002721 is_release = TRUE;
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002722 break;
2723
2724 case 33: // Drag
2725 held_button = mouse_code;
2726 mouse_code |= MOUSE_DRAG;
2727 break;
2728
2729 default:
2730 return -1;
2731 }
2732
2733 if (*p++ != 't')
2734 return -1;
2735
2736 *slen += (p - (tp + *slen));
2737 }
2738# endif // FEAT_MOUSE_PTERM
2739
2740 // Interpret the mouse code
2741 current_button = (mouse_code & MOUSE_CLICK_MASK);
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002742 if (is_release)
2743 current_button |= MOUSE_RELEASE;
2744
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002745 if (current_button == MOUSE_RELEASE
2746# ifdef FEAT_MOUSE_XTERM
2747 && wheel_code == 0
2748# endif
2749 )
2750 {
2751 /*
Bram Moolenaar13c04632020-07-12 13:47:42 +02002752 * If we get a mouse drag or release event when there is no mouse
2753 * button held down (held_button == MOUSE_RELEASE), produce a K_IGNORE
2754 * below.
2755 * (can happen when you hold down two buttons and then let them go, or
2756 * click in the menu bar, but not on a menu, and drag into the text).
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002757 */
2758 if ((mouse_code & MOUSE_DRAG) == MOUSE_DRAG)
2759 is_drag = TRUE;
2760 current_button = held_button;
2761 }
2762 else if (wheel_code == 0)
2763 {
2764# ifdef CHECK_DOUBLE_CLICK
2765# ifdef FEAT_MOUSE_GPM
2766 /*
Bram Moolenaar13c04632020-07-12 13:47:42 +02002767 * Only for Unix, when GUI not active, we handle multi-clicks here, but
2768 * not for GPM mouse events.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002769 */
2770# ifdef FEAT_GUI
2771 if (key_name[0] != KS_GPM_MOUSE && !gui.in_use)
2772# else
2773 if (key_name[0] != KS_GPM_MOUSE)
2774# endif
2775# else
2776# ifdef FEAT_GUI
2777 if (!gui.in_use)
2778# endif
2779# endif
2780 {
2781 /*
2782 * Compute the time elapsed since the previous mouse click.
2783 */
2784 gettimeofday(&mouse_time, NULL);
2785 if (orig_mouse_time.tv_sec == 0)
2786 {
2787 /*
2788 * Avoid computing the difference between mouse_time
2789 * and orig_mouse_time for the first click, as the
2790 * difference would be huge and would cause
2791 * multiplication overflow.
2792 */
2793 timediff = p_mouset;
2794 }
2795 else
Bram Moolenaar85c35022019-11-22 22:21:59 +01002796 timediff = time_diff_ms(&orig_mouse_time, &mouse_time);
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002797 orig_mouse_time = mouse_time;
2798 if (mouse_code == orig_mouse_code
2799 && timediff < p_mouset
2800 && orig_num_clicks != 4
2801 && orig_mouse_col == mouse_col
2802 && orig_mouse_row == mouse_row
2803 && (is_mouse_topline(curwin)
2804 // Double click in tab pages line also works
2805 // when window contents changes.
2806 || (mouse_row == 0 && firstwin->w_winrow > 0))
2807 )
2808 ++orig_num_clicks;
2809 else
2810 orig_num_clicks = 1;
2811 orig_mouse_col = mouse_col;
2812 orig_mouse_row = mouse_row;
2813 set_mouse_topline(curwin);
2814 }
2815# if defined(FEAT_GUI) || defined(FEAT_MOUSE_GPM)
2816 else
2817 orig_num_clicks = NUM_MOUSE_CLICKS(mouse_code);
2818# endif
2819# else
2820 orig_num_clicks = NUM_MOUSE_CLICKS(mouse_code);
2821# endif
2822 is_click = TRUE;
2823 orig_mouse_code = mouse_code;
2824 }
2825 if (!is_drag)
2826 held_button = mouse_code & MOUSE_CLICK_MASK;
2827
2828 /*
2829 * Translate the actual mouse event into a pseudo mouse event.
2830 * First work out what modifiers are to be used.
2831 */
2832 if (orig_mouse_code & MOUSE_SHIFT)
2833 *modifiers |= MOD_MASK_SHIFT;
2834 if (orig_mouse_code & MOUSE_CTRL)
2835 *modifiers |= MOD_MASK_CTRL;
2836 if (orig_mouse_code & MOUSE_ALT)
2837 *modifiers |= MOD_MASK_ALT;
2838 if (orig_num_clicks == 2)
2839 *modifiers |= MOD_MASK_2CLICK;
2840 else if (orig_num_clicks == 3)
2841 *modifiers |= MOD_MASK_3CLICK;
2842 else if (orig_num_clicks == 4)
2843 *modifiers |= MOD_MASK_4CLICK;
2844
Bram Moolenaar13c04632020-07-12 13:47:42 +02002845 // Work out our pseudo mouse event. Note that MOUSE_RELEASE gets added,
2846 // then it's not mouse up/down.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002847 key_name[0] = KS_EXTRA;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002848 if (wheel_code != 0 && (!is_release || release_is_ambiguous))
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002849 {
2850 if (wheel_code & MOUSE_CTRL)
2851 *modifiers |= MOD_MASK_CTRL;
2852 if (wheel_code & MOUSE_ALT)
2853 *modifiers |= MOD_MASK_ALT;
Bram Moolenaard58d4f92020-07-01 15:49:29 +02002854
2855 if (wheel_code & 1 && wheel_code & 2)
2856 key_name[1] = (int)KE_MOUSELEFT;
2857 else if (wheel_code & 2)
2858 key_name[1] = (int)KE_MOUSERIGHT;
2859 else if (wheel_code & 1)
2860 key_name[1] = (int)KE_MOUSEUP;
2861 else
2862 key_name[1] = (int)KE_MOUSEDOWN;
2863
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002864 held_button = MOUSE_RELEASE;
2865 }
2866 else
Bram Moolenaar13c04632020-07-12 13:47:42 +02002867 key_name[1] = get_pseudo_mouse_code(current_button, is_click, is_drag);
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002868
Bram Moolenaar13c04632020-07-12 13:47:42 +02002869
2870 // Make sure the mouse position is valid. Some terminals may return weird
2871 // values.
Bram Moolenaarb8ff5c22019-09-23 21:16:54 +02002872 if (mouse_col >= Columns)
2873 mouse_col = Columns - 1;
2874 if (mouse_row >= Rows)
2875 mouse_row = Rows - 1;
2876
2877 return 0;
2878}
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002879
2880// Functions also used for popup windows.
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002881
2882/*
2883 * Compute the buffer line position from the screen position "rowp" / "colp" in
2884 * window "win".
Bram Moolenaar452143c2020-07-15 17:38:21 +02002885 * "plines_cache" can be NULL (no cache) or an array with "Rows" entries that
2886 * caches the plines_win() result from a previous call. Entry is zero if not
2887 * computed yet. There must be no text or setting changes since the entry is
2888 * put in the cache.
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002889 * Returns TRUE if the position is below the last line.
2890 */
2891 int
2892mouse_comp_pos(
2893 win_T *win,
2894 int *rowp,
2895 int *colp,
2896 linenr_T *lnump,
2897 int *plines_cache)
2898{
2899 int col = *colp;
2900 int row = *rowp;
2901 linenr_T lnum;
2902 int retval = FALSE;
2903 int off;
2904 int count;
2905
2906#ifdef FEAT_RIGHTLEFT
2907 if (win->w_p_rl)
2908 col = win->w_width - 1 - col;
2909#endif
2910
2911 lnum = win->w_topline;
2912
2913 while (row > 0)
2914 {
2915 int cache_idx = lnum - win->w_topline;
2916
Bram Moolenaar452143c2020-07-15 17:38:21 +02002917 // Only "Rows" lines are cached, with folding we'll run out of entries
2918 // and use the slow way.
2919 if (plines_cache != NULL && cache_idx < Rows
2920 && plines_cache[cache_idx] > 0)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002921 count = plines_cache[cache_idx];
2922 else
2923 {
2924#ifdef FEAT_DIFF
2925 // Don't include filler lines in "count"
2926 if (win->w_p_diff
2927# ifdef FEAT_FOLDING
2928 && !hasFoldingWin(win, lnum, NULL, NULL, TRUE, NULL)
2929# endif
2930 )
2931 {
2932 if (lnum == win->w_topline)
2933 row -= win->w_topfill;
2934 else
2935 row -= diff_check_fill(win, lnum);
2936 count = plines_win_nofill(win, lnum, TRUE);
2937 }
2938 else
2939#endif
2940 count = plines_win(win, lnum, TRUE);
Bram Moolenaar452143c2020-07-15 17:38:21 +02002941 if (plines_cache != NULL && cache_idx < Rows)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002942 plines_cache[cache_idx] = count;
2943 }
2944 if (count > row)
2945 break; // Position is in this buffer line.
2946#ifdef FEAT_FOLDING
2947 (void)hasFoldingWin(win, lnum, NULL, &lnum, TRUE, NULL);
2948#endif
2949 if (lnum == win->w_buffer->b_ml.ml_line_count)
2950 {
2951 retval = TRUE;
2952 break; // past end of file
2953 }
2954 row -= count;
2955 ++lnum;
2956 }
2957
2958 if (!retval)
2959 {
2960 // Compute the column without wrapping.
2961 off = win_col_off(win) - win_col_off2(win);
2962 if (col < off)
2963 col = off;
2964 col += row * (win->w_width - off);
2965 // add skip column (for long wrapping line)
2966 col += win->w_skipcol;
2967 }
2968
2969 if (!win->w_p_wrap)
2970 col += win->w_leftcol;
2971
2972 // skip line number and fold column in front of the line
2973 col -= win_col_off(win);
Bram Moolenaardbfa7952020-11-02 20:04:22 +01002974 if (col <= 0)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002975 {
2976#ifdef FEAT_NETBEANS_INTG
Bram Moolenaardbfa7952020-11-02 20:04:22 +01002977 // if mouse is clicked on the gutter, then inform the netbeans server
2978 if (*colp < win_col_off(win))
2979 netbeans_gutter_click(lnum);
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02002980#endif
2981 col = 0;
2982 }
2983
2984 *colp = col;
2985 *rowp = row;
2986 *lnump = lnum;
2987 return retval;
2988}
2989
2990/*
2991 * Find the window at screen position "*rowp" and "*colp". The positions are
2992 * updated to become relative to the top-left of the window.
2993 * When "popup" is FAIL_POPUP and the position is in a popup window then NULL
2994 * is returned. When "popup" is IGNORE_POPUP then do not even check popup
2995 * windows.
2996 * Returns NULL when something is wrong.
2997 */
2998 win_T *
2999mouse_find_win(int *rowp, int *colp, mouse_find_T popup UNUSED)
3000{
3001 frame_T *fp;
3002 win_T *wp;
3003
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003004#ifdef FEAT_PROP_POPUP
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02003005 win_T *pwp = NULL;
3006
3007 if (popup != IGNORE_POPUP)
3008 {
Bram Moolenaarafe45b62019-11-13 22:35:19 +01003009 popup_reset_handled(POPUP_HANDLED_1);
3010 while ((wp = find_next_popup(TRUE, POPUP_HANDLED_1)) != NULL)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02003011 {
3012 if (*rowp >= wp->w_winrow && *rowp < wp->w_winrow + popup_height(wp)
3013 && *colp >= wp->w_wincol
3014 && *colp < wp->w_wincol + popup_width(wp))
3015 pwp = wp;
3016 }
3017 if (pwp != NULL)
3018 {
3019 if (popup == FAIL_POPUP)
3020 return NULL;
3021 *rowp -= pwp->w_winrow;
3022 *colp -= pwp->w_wincol;
3023 return pwp;
3024 }
3025 }
3026#endif
3027
3028 fp = topframe;
3029 *rowp -= firstwin->w_winrow;
3030 for (;;)
3031 {
3032 if (fp->fr_layout == FR_LEAF)
3033 break;
3034 if (fp->fr_layout == FR_ROW)
3035 {
3036 for (fp = fp->fr_child; fp->fr_next != NULL; fp = fp->fr_next)
3037 {
3038 if (*colp < fp->fr_width)
3039 break;
3040 *colp -= fp->fr_width;
3041 }
3042 }
3043 else // fr_layout == FR_COL
3044 {
3045 for (fp = fp->fr_child; fp->fr_next != NULL; fp = fp->fr_next)
3046 {
3047 if (*rowp < fp->fr_height)
3048 break;
3049 *rowp -= fp->fr_height;
3050 }
3051 }
3052 }
3053 // When using a timer that closes a window the window might not actually
3054 // exist.
3055 FOR_ALL_WINDOWS(wp)
3056 if (wp == fp->fr_win)
3057 {
3058#ifdef FEAT_MENU
3059 *rowp -= wp->w_winbar_height;
3060#endif
3061 return wp;
3062 }
3063 return NULL;
3064}
3065
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003066#if defined(NEED_VCOL2COL) || defined(FEAT_BEVAL) || defined(FEAT_PROP_POPUP) \
Bram Moolenaar424da7a2022-03-13 19:08:48 +00003067 || defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02003068/*
3069 * Convert a virtual (screen) column to a character column.
3070 * The first column is one.
3071 */
3072 int
3073vcol2col(win_T *wp, linenr_T lnum, int vcol)
3074{
3075 // try to advance to the specified column
3076 int count = 0;
3077 char_u *ptr;
3078 char_u *line;
3079
3080 line = ptr = ml_get_buf(wp->w_buffer, lnum, FALSE);
3081 while (count < vcol && *ptr != NUL)
3082 {
3083 count += win_lbr_chartabsize(wp, line, ptr, count, NULL);
3084 MB_PTR_ADV(ptr);
3085 }
3086 return (int)(ptr - line);
3087}
3088#endif
Bram Moolenaardb3a2052019-11-16 18:22:41 +01003089
3090#if defined(FEAT_EVAL) || defined(PROTO)
3091 void
3092f_getmousepos(typval_T *argvars UNUSED, typval_T *rettv)
3093{
3094 dict_T *d;
3095 win_T *wp;
3096 int row = mouse_row;
3097 int col = mouse_col;
3098 varnumber_T winid = 0;
3099 varnumber_T winrow = 0;
3100 varnumber_T wincol = 0;
Bram Moolenaar533870a2022-03-13 15:52:44 +00003101 linenr_T lnum = 0;
Bram Moolenaardb3a2052019-11-16 18:22:41 +01003102 varnumber_T column = 0;
3103
3104 if (rettv_dict_alloc(rettv) != OK)
3105 return;
3106 d = rettv->vval.v_dict;
3107
3108 dict_add_number(d, "screenrow", (varnumber_T)mouse_row + 1);
3109 dict_add_number(d, "screencol", (varnumber_T)mouse_col + 1);
3110
3111 wp = mouse_find_win(&row, &col, FIND_POPUP);
3112 if (wp != NULL)
3113 {
3114 int top_off = 0;
3115 int left_off = 0;
3116 int height = wp->w_height + wp->w_status_height;
3117
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003118#ifdef FEAT_PROP_POPUP
Bram Moolenaardb3a2052019-11-16 18:22:41 +01003119 if (WIN_IS_POPUP(wp))
3120 {
3121 top_off = popup_top_extra(wp);
3122 left_off = popup_left_extra(wp);
3123 height = popup_height(wp);
3124 }
3125#endif
3126 if (row < height)
3127 {
3128 winid = wp->w_id;
3129 winrow = row + 1;
3130 wincol = col + 1;
3131 row -= top_off;
3132 col -= left_off;
3133 if (row >= 0 && row < wp->w_height && col >= 0 && col < wp->w_width)
3134 {
Sean Dewar10792fe2022-03-15 09:46:54 +00003135 (void)mouse_comp_pos(wp, &row, &col, &lnum, NULL);
3136 col = vcol2col(wp, lnum, col);
Bram Moolenaardb3a2052019-11-16 18:22:41 +01003137 column = col + 1;
3138 }
3139 }
3140 }
3141 dict_add_number(d, "winid", winid);
3142 dict_add_number(d, "winrow", winrow);
3143 dict_add_number(d, "wincol", wincol);
Bram Moolenaar533870a2022-03-13 15:52:44 +00003144 dict_add_number(d, "line", (varnumber_T)lnum);
Bram Moolenaardb3a2052019-11-16 18:22:41 +01003145 dict_add_number(d, "column", column);
3146}
3147#endif