xref: /vim-8.2.3635/src/gui.c (revision daa2f365)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved		by Bram Moolenaar
4  *				GUI/Motif support by Robert Webb
5  *
6  * Do ":help uganda"  in Vim to read copying and usage conditions.
7  * Do ":help credits" in Vim to see a list of people who contributed.
8  * See README.txt for an overview of the Vim source code.
9  */
10 
11 #include "vim.h"
12 
13 // Structure containing all the GUI information
14 gui_T gui;
15 
16 #if !defined(FEAT_GUI_GTK)
17 static void set_guifontwide(char_u *font_name);
18 #endif
19 static void gui_check_pos(void);
20 static void gui_reset_scroll_region(void);
21 static void gui_outstr(char_u *, int);
22 static int gui_screenchar(int off, int flags, guicolor_T fg, guicolor_T bg, int back);
23 static int gui_outstr_nowrap(char_u *s, int len, int flags, guicolor_T fg, guicolor_T bg, int back);
24 static void gui_delete_lines(int row, int count);
25 static void gui_insert_lines(int row, int count);
26 static int gui_xy2colrow(int x, int y, int *colp);
27 #if defined(FEAT_GUI_TABLINE) || defined(PROTO)
28 static int gui_has_tabline(void);
29 #endif
30 static void gui_do_scrollbar(win_T *wp, int which, int enable);
31 static void gui_update_horiz_scrollbar(int);
32 static void gui_set_fg_color(char_u *name);
33 static void gui_set_bg_color(char_u *name);
34 static win_T *xy2win(int x, int y, mouse_find_T popup);
35 
36 #ifdef GUI_MAY_FORK
37 static void gui_do_fork(void);
38 
39 static int gui_read_child_pipe(int fd);
40 
41 // Return values for gui_read_child_pipe
42 enum {
43     GUI_CHILD_IO_ERROR,
44     GUI_CHILD_OK,
45     GUI_CHILD_FAILED
46 };
47 #endif
48 
49 static void gui_attempt_start(void);
50 
51 static int can_update_cursor = TRUE; // can display the cursor
52 static int disable_flush = 0;	// If > 0, gui_mch_flush() is disabled.
53 
54 /*
55  * The Athena scrollbars can move the thumb to after the end of the scrollbar,
56  * this makes the thumb indicate the part of the text that is shown.  Motif
57  * can't do this.
58  */
59 #if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_MAC)
60 # define SCROLL_PAST_END
61 #endif
62 
63 /*
64  * gui_start -- Called when user wants to start the GUI.
65  *
66  * Careful: This function can be called recursively when there is a ":gui"
67  * command in the .gvimrc file.  Only the first call should fork, not the
68  * recursive call.
69  */
70     void
71 gui_start(char_u *arg UNUSED)
72 {
73     char_u	*old_term;
74     static int	recursive = 0;
75 #if defined(GUI_MAY_SPAWN) && defined(EXPERIMENTAL_GUI_CMD)
76     char	*msg = NULL;
77 #endif
78 
79     old_term = vim_strsave(T_NAME);
80 
81     settmode(TMODE_COOK);		// stop RAW mode
82     if (full_screen)
83 	cursor_on();			// needed for ":gui" in .vimrc
84     full_screen = FALSE;
85 
86     ++recursive;
87 
88 #ifdef GUI_MAY_FORK
89     /*
90      * Quit the current process and continue in the child.
91      * Makes "gvim file" disconnect from the shell it was started in.
92      * Don't do this when Vim was started with "-f" or the 'f' flag is present
93      * in 'guioptions'.
94      * Don't do this when there is a running job, we can only get the status
95      * of a child from the parent.
96      */
97     if (gui.dofork && !vim_strchr(p_go, GO_FORG) && recursive <= 1
98 # ifdef FEAT_JOB_CHANNEL
99 	    && !job_any_running()
100 # endif
101 	    )
102     {
103 	gui_do_fork();
104     }
105     else
106 #endif
107 #ifdef GUI_MAY_SPAWN
108     if (gui.dospawn
109 # ifdef EXPERIMENTAL_GUI_CMD
110 	    && gui.dofork
111 # endif
112 	    && !vim_strchr(p_go, GO_FORG)
113 	    && !anyBufIsChanged()
114 # ifdef FEAT_JOB_CHANNEL
115 	    && !job_any_running()
116 # endif
117 	    )
118     {
119 # ifdef EXPERIMENTAL_GUI_CMD
120 	msg =
121 # endif
122 	    gui_mch_do_spawn(arg);
123     }
124     else
125 #endif
126     {
127 #ifdef FEAT_GUI_GTK
128 	// If there is 'f' in 'guioptions' and specify -g argument,
129 	// gui_mch_init_check() was not called yet.
130 	if (gui_mch_init_check() != OK)
131 	    getout_preserve_modified(1);
132 #endif
133 	gui_attempt_start();
134     }
135 
136     if (!gui.in_use)			// failed to start GUI
137     {
138 	// Back to old term settings
139 	//
140 	// FIXME: If we got here because a child process failed and flagged to
141 	// the parent to resume, and X11 is enabled with FEAT_TITLE, this will
142 	// hit an X11 I/O error and do a longjmp(), leaving recursive
143 	// permanently set to 1. This is probably not as big a problem as it
144 	// sounds, because gui_mch_init() in both gui_x11.c and gui_gtk_x11.c
145 	// return "OK" unconditionally, so it would be very difficult to
146 	// actually hit this case.
147 	termcapinit(old_term);
148 	settmode(TMODE_RAW);		// restart RAW mode
149 #ifdef FEAT_TITLE
150 	set_title_defaults();		// set 'title' and 'icon' again
151 #endif
152 #if defined(GUI_MAY_SPAWN) && defined(EXPERIMENTAL_GUI_CMD)
153 	if (msg)
154 	    emsg(msg);
155 #endif
156     }
157 
158     vim_free(old_term);
159 
160     // If the GUI started successfully, trigger the GUIEnter event, otherwise
161     // the GUIFailed event.
162     gui_mch_update();
163     apply_autocmds(gui.in_use ? EVENT_GUIENTER : EVENT_GUIFAILED,
164 						   NULL, NULL, FALSE, curbuf);
165     --recursive;
166 }
167 
168 /*
169  * Set_termname() will call gui_init() to start the GUI.
170  * Set the "starting" flag, to indicate that the GUI will start.
171  *
172  * We don't want to open the GUI shell until after we've read .gvimrc,
173  * otherwise we don't know what font we will use, and hence we don't know
174  * what size the shell should be.  So if there are errors in the .gvimrc
175  * file, they will have to go to the terminal: Set full_screen to FALSE.
176  * full_screen will be set to TRUE again by a successful termcapinit().
177  */
178     static void
179 gui_attempt_start(void)
180 {
181     static int recursive = 0;
182 
183     ++recursive;
184     gui.starting = TRUE;
185 
186 #ifdef FEAT_GUI_GTK
187     gui.event_time = GDK_CURRENT_TIME;
188 #endif
189 
190     termcapinit((char_u *)"builtin_gui");
191     gui.starting = recursive - 1;
192 
193 #if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11)
194     if (gui.in_use)
195     {
196 # ifdef FEAT_EVAL
197 	Window	x11_window;
198 	Display	*x11_display;
199 
200 	if (gui_get_x11_windis(&x11_window, &x11_display) == OK)
201 	    set_vim_var_nr(VV_WINDOWID, (long)x11_window);
202 # endif
203 
204 	// Display error messages in a dialog now.
205 	display_errors();
206     }
207 #endif
208     --recursive;
209 }
210 
211 #ifdef GUI_MAY_FORK
212 
213 // for waitpid()
214 # if defined(HAVE_SYS_WAIT_H) || defined(HAVE_UNION_WAIT)
215 #  include <sys/wait.h>
216 # endif
217 
218 /*
219  * Create a new process, by forking. In the child, start the GUI, and in
220  * the parent, exit.
221  *
222  * If something goes wrong, this will return with gui.in_use still set
223  * to FALSE, in which case the caller should continue execution without
224  * the GUI.
225  *
226  * If the child fails to start the GUI, then the child will exit and the
227  * parent will return. If the child succeeds, then the parent will exit
228  * and the child will return.
229  */
230     static void
231 gui_do_fork(void)
232 {
233     int		pipefd[2];	// pipe between parent and child
234     int		pipe_error;
235     int		status;
236     int		exit_status;
237     pid_t	pid = -1;
238 
239     // Setup a pipe between the child and the parent, so that the parent
240     // knows when the child has done the setsid() call and is allowed to
241     // exit.
242     pipe_error = (pipe(pipefd) < 0);
243     pid = fork();
244     if (pid < 0)	    // Fork error
245     {
246 	emsg(_("E851: Failed to create a new process for the GUI"));
247 	return;
248     }
249     else if (pid > 0)	    // Parent
250     {
251 	// Give the child some time to do the setsid(), otherwise the
252 	// exit() may kill the child too (when starting gvim from inside a
253 	// gvim).
254 	if (!pipe_error)
255 	{
256 	    // The read returns when the child closes the pipe (or when
257 	    // the child dies for some reason).
258 	    close(pipefd[1]);
259 	    status = gui_read_child_pipe(pipefd[0]);
260 	    if (status == GUI_CHILD_FAILED)
261 	    {
262 		// The child failed to start the GUI, so the caller must
263 		// continue. There may be more error information written
264 		// to stderr by the child.
265 # ifdef __NeXT__
266 		wait4(pid, &exit_status, 0, (struct rusage *)0);
267 # else
268 		waitpid(pid, &exit_status, 0);
269 # endif
270 		emsg(_("E852: The child process failed to start the GUI"));
271 		return;
272 	    }
273 	    else if (status == GUI_CHILD_IO_ERROR)
274 	    {
275 		pipe_error = TRUE;
276 	    }
277 	    // else GUI_CHILD_OK: parent exit
278 	}
279 
280 	if (pipe_error)
281 	    ui_delay(301L, TRUE);
282 
283 	// When swapping screens we may need to go to the next line, e.g.,
284 	// after a hit-enter prompt and using ":gui".
285 	if (newline_on_exit)
286 	    mch_errmsg("\r\n");
287 
288 	/*
289 	 * The parent must skip the normal exit() processing, the child
290 	 * will do it.  For example, GTK messes up signals when exiting.
291 	 */
292 	_exit(0);
293     }
294     // Child
295 
296 #ifdef FEAT_GUI_GTK
297     // Call gtk_init_check() here after fork(). See gui_init_check().
298     if (gui_mch_init_check() != OK)
299 	getout_preserve_modified(1);
300 #endif
301 
302 # if defined(HAVE_SETSID) || defined(HAVE_SETPGID)
303     /*
304      * Change our process group.  On some systems/shells a CTRL-C in the
305      * shell where Vim was started would otherwise kill gvim!
306      */
307 #  if defined(HAVE_SETSID)
308     (void)setsid();
309 #  else
310     (void)setpgid(0, 0);
311 #  endif
312 # endif
313     if (!pipe_error)
314 	close(pipefd[0]);
315 
316 # if defined(FEAT_GUI_GNOME) && defined(FEAT_SESSION)
317     // Tell the session manager our new PID
318     gui_mch_forked();
319 # endif
320 
321     // Try to start the GUI
322     gui_attempt_start();
323 
324     // Notify the parent
325     if (!pipe_error)
326     {
327 	if (gui.in_use)
328 	    write_eintr(pipefd[1], "ok", 3);
329 	else
330 	    write_eintr(pipefd[1], "fail", 5);
331 	close(pipefd[1]);
332     }
333 
334     // If we failed to start the GUI, exit now.
335     if (!gui.in_use)
336 	getout_preserve_modified(1);
337 }
338 
339 /*
340  * Read from a pipe assumed to be connected to the child process (this
341  * function is called from the parent).
342  * Return GUI_CHILD_OK if the child successfully started the GUI,
343  * GUY_CHILD_FAILED if the child failed, or GUI_CHILD_IO_ERROR if there was
344  * some other error.
345  *
346  * The file descriptor will be closed before the function returns.
347  */
348     static int
349 gui_read_child_pipe(int fd)
350 {
351     long	bytes_read;
352 #define READ_BUFFER_SIZE 10
353     char	buffer[READ_BUFFER_SIZE];
354 
355     bytes_read = read_eintr(fd, buffer, READ_BUFFER_SIZE - 1);
356 #undef READ_BUFFER_SIZE
357     close(fd);
358     if (bytes_read < 0)
359 	return GUI_CHILD_IO_ERROR;
360     buffer[bytes_read] = NUL;
361     if (strcmp(buffer, "ok") == 0)
362 	return GUI_CHILD_OK;
363     return GUI_CHILD_FAILED;
364 }
365 
366 #endif // GUI_MAY_FORK
367 
368 /*
369  * Call this when vim starts up, whether or not the GUI is started
370  */
371     void
372 gui_prepare(int *argc, char **argv)
373 {
374     gui.in_use = FALSE;		    // No GUI yet (maybe later)
375     gui.starting = FALSE;	    // No GUI yet (maybe later)
376     gui_mch_prepare(argc, argv);
377 }
378 
379 /*
380  * Try initializing the GUI and check if it can be started.
381  * Used from main() to check early if "vim -g" can start the GUI.
382  * Used from gui_init() to prepare for starting the GUI.
383  * Returns FAIL or OK.
384  */
385     int
386 gui_init_check(void)
387 {
388     static int result = MAYBE;
389 
390     if (result != MAYBE)
391     {
392 	if (result == FAIL)
393 	    emsg(_("E229: Cannot start the GUI"));
394 	return result;
395     }
396 
397     gui.shell_created = FALSE;
398     gui.dying = FALSE;
399     gui.in_focus = TRUE;		// so the guicursor setting works
400     gui.dragged_sb = SBAR_NONE;
401     gui.dragged_wp = NULL;
402     gui.pointer_hidden = FALSE;
403     gui.col = 0;
404     gui.row = 0;
405     gui.num_cols = Columns;
406     gui.num_rows = Rows;
407 
408     gui.cursor_is_valid = FALSE;
409     gui.scroll_region_top = 0;
410     gui.scroll_region_bot = Rows - 1;
411     gui.scroll_region_left = 0;
412     gui.scroll_region_right = Columns - 1;
413     gui.highlight_mask = HL_NORMAL;
414     gui.char_width = 1;
415     gui.char_height = 1;
416     gui.char_ascent = 0;
417     gui.border_width = 0;
418 
419     gui.norm_font = NOFONT;
420 #ifndef FEAT_GUI_GTK
421     gui.bold_font = NOFONT;
422     gui.ital_font = NOFONT;
423     gui.boldital_font = NOFONT;
424 # ifdef FEAT_XFONTSET
425     gui.fontset = NOFONTSET;
426 # endif
427 #endif
428     gui.wide_font = NOFONT;
429 #ifndef FEAT_GUI_GTK
430     gui.wide_bold_font = NOFONT;
431     gui.wide_ital_font = NOFONT;
432     gui.wide_boldital_font = NOFONT;
433 #endif
434 
435 #ifdef FEAT_MENU
436 # ifndef FEAT_GUI_GTK
437 #  ifdef FONTSET_ALWAYS
438     gui.menu_fontset = NOFONTSET;
439 #  else
440     gui.menu_font = NOFONT;
441 #  endif
442 # endif
443     gui.menu_is_active = TRUE;	    // default: include menu
444 # ifndef FEAT_GUI_GTK
445     gui.menu_height = MENU_DEFAULT_HEIGHT;
446     gui.menu_width = 0;
447 # endif
448 #endif
449 #if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA) \
450 	|| defined(FEAT_GUI_HAIKU))
451     gui.toolbar_height = 0;
452 #endif
453 #if defined(FEAT_FOOTER) && defined(FEAT_GUI_MOTIF)
454     gui.footer_height = 0;
455 #endif
456 #ifdef FEAT_BEVAL_TIP
457     gui.tooltip_fontset = NOFONTSET;
458 #endif
459 
460     gui.scrollbar_width = gui.scrollbar_height = SB_DEFAULT_WIDTH;
461     gui.prev_wrap = -1;
462 
463 #if defined(ALWAYS_USE_GUI) || defined(VIMDLL)
464     result = OK;
465 #else
466 # ifdef FEAT_GUI_GTK
467     /*
468      * Note: Don't call gtk_init_check() before fork, it will be called after
469      * the fork. When calling it before fork, it make vim hang for a while.
470      * See gui_do_fork().
471      * Use a simpler check if the GUI window can probably be opened.
472      */
473     result = gui.dofork ? gui_mch_early_init_check(TRUE) : gui_mch_init_check();
474 # else
475     result = gui_mch_init_check();
476 # endif
477 #endif
478     return result;
479 }
480 
481 /*
482  * This is the call which starts the GUI.
483  */
484     void
485 gui_init(void)
486 {
487     win_T	*wp;
488     static int	recursive = 0;
489 
490     /*
491      * It's possible to use ":gui" in a .gvimrc file.  The first halve of this
492      * function will then be executed at the first call, the rest by the
493      * recursive call.  This allow the shell to be opened halfway reading a
494      * gvimrc file.
495      */
496     if (!recursive)
497     {
498 	++recursive;
499 
500 	clip_init(TRUE);
501 
502 	// If can't initialize, don't try doing the rest
503 	if (gui_init_check() == FAIL)
504 	{
505 	    --recursive;
506 	    clip_init(FALSE);
507 	    return;
508 	}
509 
510 	/*
511 	 * Reset 'paste'.  It's useful in the terminal, but not in the GUI.  It
512 	 * breaks the Paste toolbar button.
513 	 */
514 	set_option_value((char_u *)"paste", 0L, NULL, 0);
515 
516 	// Set t_Co to the number of colors: RGB.
517 	set_color_count(256 * 256 * 256);
518 
519 	/*
520 	 * Set up system-wide default menus.
521 	 */
522 #if defined(SYS_MENU_FILE) && defined(FEAT_MENU)
523 	if (vim_strchr(p_go, GO_NOSYSMENU) == NULL)
524 	{
525 	    sys_menu = TRUE;
526 	    do_source((char_u *)SYS_MENU_FILE, FALSE, DOSO_NONE, NULL);
527 	    sys_menu = FALSE;
528 	}
529 #endif
530 
531 	/*
532 	 * Switch on the mouse by default, unless the user changed it already.
533 	 * This can then be changed in the .gvimrc.
534 	 */
535 	if (!option_was_set((char_u *)"mouse"))
536 	    set_string_option_direct((char_u *)"mouse", -1,
537 					   (char_u *)"a", OPT_FREE, SID_NONE);
538 
539 	/*
540 	 * If -U option given, use only the initializations from that file and
541 	 * nothing else.  Skip all initializations for "-U NONE" or "-u NORC".
542 	 */
543 	if (use_gvimrc != NULL)
544 	{
545 	    if (STRCMP(use_gvimrc, "NONE") != 0
546 		    && STRCMP(use_gvimrc, "NORC") != 0
547 		    && do_source(use_gvimrc, FALSE, DOSO_NONE, NULL) != OK)
548 		semsg(_("E230: Cannot read from \"%s\""), use_gvimrc);
549 	}
550 	else
551 	{
552 	    /*
553 	     * Get system wide defaults for gvim, only when file name defined.
554 	     */
555 #ifdef SYS_GVIMRC_FILE
556 	    do_source((char_u *)SYS_GVIMRC_FILE, FALSE, DOSO_NONE, NULL);
557 #endif
558 
559 	    /*
560 	     * Try to read GUI initialization commands from the following
561 	     * places:
562 	     * - environment variable GVIMINIT
563 	     * - the user gvimrc file (~/.gvimrc)
564 	     * - the second user gvimrc file ($VIM/.gvimrc for Dos)
565 	     * - the third user gvimrc file ($VIM/.gvimrc for Amiga)
566 	     * The first that exists is used, the rest is ignored.
567 	     */
568 	    if (process_env((char_u *)"GVIMINIT", FALSE) == FAIL
569 		 && do_source((char_u *)USR_GVIMRC_FILE, TRUE,
570 						     DOSO_GVIMRC, NULL) == FAIL
571 #ifdef USR_GVIMRC_FILE2
572 		 && do_source((char_u *)USR_GVIMRC_FILE2, TRUE,
573 						     DOSO_GVIMRC, NULL) == FAIL
574 #endif
575 #ifdef USR_GVIMRC_FILE3
576 		 && do_source((char_u *)USR_GVIMRC_FILE3, TRUE,
577 						     DOSO_GVIMRC, NULL) == FAIL
578 #endif
579 				)
580 	    {
581 #ifdef USR_GVIMRC_FILE4
582 		(void)do_source((char_u *)USR_GVIMRC_FILE4, TRUE,
583 							    DOSO_GVIMRC, NULL);
584 #endif
585 	    }
586 
587 	    /*
588 	     * Read initialization commands from ".gvimrc" in current
589 	     * directory.  This is only done if the 'exrc' option is set.
590 	     * Because of security reasons we disallow shell and write
591 	     * commands now, except for unix if the file is owned by the user
592 	     * or 'secure' option has been reset in environment of global
593 	     * ".gvimrc".
594 	     * Only do this if GVIMRC_FILE is not the same as USR_GVIMRC_FILE,
595 	     * USR_GVIMRC_FILE2, USR_GVIMRC_FILE3 or SYS_GVIMRC_FILE.
596 	     */
597 	    if (p_exrc)
598 	    {
599 #ifdef UNIX
600 		{
601 		    stat_T s;
602 
603 		    // if ".gvimrc" file is not owned by user, set 'secure'
604 		    // mode
605 		    if (mch_stat(GVIMRC_FILE, &s) || s.st_uid != getuid())
606 			secure = p_secure;
607 		}
608 #else
609 		secure = p_secure;
610 #endif
611 
612 		if (       fullpathcmp((char_u *)USR_GVIMRC_FILE,
613 				(char_u *)GVIMRC_FILE, FALSE, TRUE) != FPC_SAME
614 #ifdef SYS_GVIMRC_FILE
615 			&& fullpathcmp((char_u *)SYS_GVIMRC_FILE,
616 				(char_u *)GVIMRC_FILE, FALSE, TRUE) != FPC_SAME
617 #endif
618 #ifdef USR_GVIMRC_FILE2
619 			&& fullpathcmp((char_u *)USR_GVIMRC_FILE2,
620 				(char_u *)GVIMRC_FILE, FALSE, TRUE) != FPC_SAME
621 #endif
622 #ifdef USR_GVIMRC_FILE3
623 			&& fullpathcmp((char_u *)USR_GVIMRC_FILE3,
624 				(char_u *)GVIMRC_FILE, FALSE, TRUE) != FPC_SAME
625 #endif
626 #ifdef USR_GVIMRC_FILE4
627 			&& fullpathcmp((char_u *)USR_GVIMRC_FILE4,
628 				(char_u *)GVIMRC_FILE, FALSE, TRUE) != FPC_SAME
629 #endif
630 			)
631 		    do_source((char_u *)GVIMRC_FILE, TRUE, DOSO_GVIMRC, NULL);
632 
633 		if (secure == 2)
634 		    need_wait_return = TRUE;
635 		secure = 0;
636 	    }
637 	}
638 
639 	if (need_wait_return || msg_didany)
640 	    wait_return(TRUE);
641 
642 	--recursive;
643     }
644 
645     // If recursive call opened the shell, return here from the first call
646     if (gui.in_use)
647 	return;
648 
649     /*
650      * Create the GUI shell.
651      */
652     gui.in_use = TRUE;		// Must be set after menus have been set up
653     if (gui_mch_init() == FAIL)
654 	goto error;
655 
656     // Avoid a delay for an error message that was printed in the terminal
657     // where Vim was started.
658     emsg_on_display = FALSE;
659     msg_scrolled = 0;
660     clear_sb_text(TRUE);
661     need_wait_return = FALSE;
662     msg_didany = FALSE;
663 
664     /*
665      * Check validity of any generic resources that may have been loaded.
666      */
667     if (gui.border_width < 0)
668 	gui.border_width = 0;
669 
670     /*
671      * Set up the fonts.  First use a font specified with "-fn" or "-font".
672      */
673     if (font_argument != NULL)
674 	set_option_value((char_u *)"gfn", 0L, (char_u *)font_argument, 0);
675     if (
676 #ifdef FEAT_XFONTSET
677 	    (*p_guifontset == NUL
678 	     || gui_init_font(p_guifontset, TRUE) == FAIL) &&
679 #endif
680 	    gui_init_font(*p_guifont == NUL ? hl_get_font_name()
681 						  : p_guifont, FALSE) == FAIL)
682     {
683 	emsg(_("E665: Cannot start GUI, no valid font found"));
684 	goto error2;
685     }
686     if (gui_get_wide_font() == FAIL)
687 	emsg(_("E231: 'guifontwide' invalid"));
688 
689     gui.num_cols = Columns;
690     gui.num_rows = Rows;
691     gui_reset_scroll_region();
692 
693     // Create initial scrollbars
694     FOR_ALL_WINDOWS(wp)
695     {
696 	gui_create_scrollbar(&wp->w_scrollbars[SBAR_LEFT], SBAR_LEFT, wp);
697 	gui_create_scrollbar(&wp->w_scrollbars[SBAR_RIGHT], SBAR_RIGHT, wp);
698     }
699     gui_create_scrollbar(&gui.bottom_sbar, SBAR_BOTTOM, NULL);
700 
701 #ifdef FEAT_MENU
702     gui_create_initial_menus(root_menu);
703 #endif
704 #ifdef FEAT_SIGN_ICONS
705     sign_gui_started();
706 #endif
707 
708     // Configure the desired menu and scrollbars
709     gui_init_which_components(NULL);
710 
711     // All components of the GUI have been created now
712     gui.shell_created = TRUE;
713 
714 #ifdef FEAT_GUI_MSWIN
715     // Set the shell size, adjusted for the screen size.  For GTK this only
716     // works after the shell has been opened, thus it is further down.
717     // If the window is already maximized (e.g. when --windowid is passed in),
718     // we want to use the system-provided dimensions by passing FALSE to
719     // mustset. Otherwise, we want to initialize with the default rows/columns.
720     if (gui_mch_maximized())
721 	gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
722     else
723 	gui_set_shellsize(TRUE, TRUE, RESIZE_BOTH);
724 #else
725 # ifndef FEAT_GUI_GTK
726     gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
727 # endif
728 #endif
729 #if defined(FEAT_GUI_MOTIF) && defined(FEAT_MENU)
730     // Need to set the size of the menubar after all the menus have been
731     // created.
732     gui_mch_compute_menu_height((Widget)0);
733 #endif
734 
735     /*
736      * Actually open the GUI shell.
737      */
738     if (gui_mch_open() != FAIL)
739     {
740 #ifdef FEAT_TITLE
741 	maketitle();
742 	resettitle();
743 #endif
744 	init_gui_options();
745 #ifdef FEAT_ARABIC
746 	// Our GUI can't do bidi.
747 	p_tbidi = FALSE;
748 #endif
749 #if defined(FEAT_GUI_GTK)
750 	// Give GTK+ a chance to put all widget's into place.
751 	gui_mch_update();
752 
753 # ifdef FEAT_MENU
754 	// If there is no 'm' in 'guioptions' we need to remove the menu now.
755 	// It was still there to make F10 work.
756 	if (vim_strchr(p_go, GO_MENUS) == NULL)
757 	{
758 	    --gui.starting;
759 	    gui_mch_enable_menu(FALSE);
760 	    ++gui.starting;
761 	    gui_mch_update();
762 	}
763 # endif
764 
765 	// Now make sure the shell fits on the screen.
766 	if (gui_mch_maximized())
767 	    gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
768 	else
769 	    gui_set_shellsize(TRUE, TRUE, RESIZE_BOTH);
770 #endif
771 	// When 'lines' was set while starting up the topframe may have to be
772 	// resized.
773 	win_new_shellsize();
774 
775 #ifdef FEAT_BEVAL_GUI
776 	// Always create the Balloon Evaluation area, but disable it when
777 	// 'ballooneval' is off.
778 	if (balloonEval != NULL)
779 	{
780 # ifdef FEAT_VARTABS
781 	    vim_free(balloonEval->vts);
782 # endif
783 	    vim_free(balloonEval);
784 	}
785 	balloonEvalForTerm = FALSE;
786 # ifdef FEAT_GUI_GTK
787 	balloonEval = gui_mch_create_beval_area(gui.drawarea, NULL,
788 						     &general_beval_cb, NULL);
789 # else
790 #  if defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA)
791 	{
792 	    extern Widget	textArea;
793 	    balloonEval = gui_mch_create_beval_area(textArea, NULL,
794 						     &general_beval_cb, NULL);
795 	}
796 #  else
797 #   ifdef FEAT_GUI_MSWIN
798 	balloonEval = gui_mch_create_beval_area(NULL, NULL,
799 						     &general_beval_cb, NULL);
800 #   endif
801 #  endif
802 # endif
803 	if (!p_beval)
804 	    gui_mch_disable_beval_area(balloonEval);
805 #endif
806 
807 #ifndef FEAT_GUI_MSWIN
808 	// In the GUI modifiers are prepended to keys.
809 	// Don't do this for MS-Windows yet, it sends CTRL-K without the
810 	// modifier.
811 	seenModifyOtherKeys = TRUE;
812 #endif
813 
814 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
815 	if (!im_xim_isvalid_imactivate())
816 	    emsg(_("E599: Value of 'imactivatekey' is invalid"));
817 #endif
818 	// When 'cmdheight' was set during startup it may not have taken
819 	// effect yet.
820 	if (p_ch != 1L)
821 	    command_height();
822 
823 	return;
824     }
825 
826 error2:
827 #ifdef FEAT_GUI_X11
828     // undo gui_mch_init()
829     gui_mch_uninit();
830 #endif
831 
832 error:
833     gui.in_use = FALSE;
834     clip_init(FALSE);
835 }
836 
837 
838     void
839 gui_exit(int rc)
840 {
841     // don't free the fonts, it leads to a BUS error
842     // [email protected] Jul 99
843     free_highlight_fonts();
844     gui.in_use = FALSE;
845     gui_mch_exit(rc);
846 }
847 
848 #if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11) || defined(FEAT_GUI_MSWIN) \
849 	|| defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC) || defined(PROTO)
850 # define NEED_GUI_UPDATE_SCREEN 1
851 /*
852  * Called when the GUI shell is closed by the user.  If there are no changed
853  * files Vim exits, otherwise there will be a dialog to ask the user what to
854  * do.
855  * When this function returns, Vim should NOT exit!
856  */
857     void
858 gui_shell_closed(void)
859 {
860     cmdmod_T	    save_cmdmod;
861 
862     save_cmdmod = cmdmod;
863 
864     // Only exit when there are no changed files
865     exiting = TRUE;
866 # ifdef FEAT_BROWSE
867     cmdmod.browse = TRUE;
868 # endif
869 # if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
870     cmdmod.confirm = TRUE;
871 # endif
872     // If there are changed buffers, present the user with a dialog if
873     // possible, otherwise give an error message.
874     if (!check_changed_any(FALSE, FALSE))
875 	getout(0);
876 
877     exiting = FALSE;
878     cmdmod = save_cmdmod;
879     gui_update_screen();	// redraw, window may show changed buffer
880 }
881 #endif
882 
883 /*
884  * Set the font.  "font_list" is a comma separated list of font names.  The
885  * first font name that works is used.  If none is found, use the default
886  * font.
887  * If "fontset" is TRUE, the "font_list" is used as one name for the fontset.
888  * Return OK when able to set the font.  When it failed FAIL is returned and
889  * the fonts are unchanged.
890  */
891     int
892 gui_init_font(char_u *font_list, int fontset UNUSED)
893 {
894 #define FONTLEN 320
895     char_u	font_name[FONTLEN];
896     int		font_list_empty = FALSE;
897     int		ret = FAIL;
898 
899     if (!gui.in_use)
900 	return FAIL;
901 
902     font_name[0] = NUL;
903     if (*font_list == NUL)
904 	font_list_empty = TRUE;
905     else
906     {
907 #ifdef FEAT_XFONTSET
908 	// When using a fontset, the whole list of fonts is one name.
909 	if (fontset)
910 	    ret = gui_mch_init_font(font_list, TRUE);
911 	else
912 #endif
913 	    while (*font_list != NUL)
914 	    {
915 		// Isolate one comma separated font name.
916 		(void)copy_option_part(&font_list, font_name, FONTLEN, ",");
917 
918 		// Careful!!!  The Win32 version of gui_mch_init_font(), when
919 		// called with "*" will change p_guifont to the selected font
920 		// name, which frees the old value.  This makes font_list
921 		// invalid.  Thus when OK is returned here, font_list must no
922 		// longer be used!
923 		if (gui_mch_init_font(font_name, FALSE) == OK)
924 		{
925 #if !defined(FEAT_GUI_GTK)
926 		    // If it's a Unicode font, try setting 'guifontwide' to a
927 		    // similar double-width font.
928 		    if ((p_guifontwide == NULL || *p_guifontwide == NUL)
929 				&& strstr((char *)font_name, "10646") != NULL)
930 			set_guifontwide(font_name);
931 #endif
932 		    ret = OK;
933 		    break;
934 		}
935 	    }
936     }
937 
938     if (ret != OK
939 	    && STRCMP(font_list, "*") != 0
940 	    && (font_list_empty || gui.norm_font == NOFONT))
941     {
942 	/*
943 	 * Couldn't load any font in 'font_list', keep the current font if
944 	 * there is one.  If 'font_list' is empty, or if there is no current
945 	 * font, tell gui_mch_init_font() to try to find a font we can load.
946 	 */
947 	ret = gui_mch_init_font(NULL, FALSE);
948     }
949 
950     if (ret == OK)
951     {
952 #ifndef FEAT_GUI_GTK
953 	// Set normal font as current font
954 # ifdef FEAT_XFONTSET
955 	if (gui.fontset != NOFONTSET)
956 	    gui_mch_set_fontset(gui.fontset);
957 	else
958 # endif
959 	    gui_mch_set_font(gui.norm_font);
960 #endif
961 	gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
962     }
963 
964     return ret;
965 }
966 
967 #ifndef FEAT_GUI_GTK
968 /*
969  * Try setting 'guifontwide' to a font twice as wide as "name".
970  */
971     static void
972 set_guifontwide(char_u *name)
973 {
974     int		i = 0;
975     char_u	wide_name[FONTLEN + 10]; // room for 2 * width and '*'
976     char_u	*wp = NULL;
977     char_u	*p;
978     GuiFont	font;
979 
980     wp = wide_name;
981     for (p = name; *p != NUL; ++p)
982     {
983 	*wp++ = *p;
984 	if (*p == '-')
985 	{
986 	    ++i;
987 	    if (i == 6)		// font type: change "--" to "-*-"
988 	    {
989 		if (p[1] == '-')
990 		    *wp++ = '*';
991 	    }
992 	    else if (i == 12)	// found the width
993 	    {
994 		++p;
995 		i = getdigits(&p);
996 		if (i != 0)
997 		{
998 		    // Double the width specification.
999 		    sprintf((char *)wp, "%d%s", i * 2, p);
1000 		    font = gui_mch_get_font(wide_name, FALSE);
1001 		    if (font != NOFONT)
1002 		    {
1003 			gui_mch_free_font(gui.wide_font);
1004 			gui.wide_font = font;
1005 			set_string_option_direct((char_u *)"gfw", -1,
1006 						      wide_name, OPT_FREE, 0);
1007 		    }
1008 		}
1009 		break;
1010 	    }
1011 	}
1012     }
1013 }
1014 #endif // !FEAT_GUI_GTK
1015 
1016 /*
1017  * Get the font for 'guifontwide'.
1018  * Return FAIL for an invalid font name.
1019  */
1020     int
1021 gui_get_wide_font(void)
1022 {
1023     GuiFont	font = NOFONT;
1024     char_u	font_name[FONTLEN];
1025     char_u	*p;
1026 
1027     if (!gui.in_use)	    // Can't allocate font yet, assume it's OK.
1028 	return OK;	    // Will give an error message later.
1029 
1030     if (p_guifontwide != NULL && *p_guifontwide != NUL)
1031     {
1032 	for (p = p_guifontwide; *p != NUL; )
1033 	{
1034 	    // Isolate one comma separated font name.
1035 	    (void)copy_option_part(&p, font_name, FONTLEN, ",");
1036 	    font = gui_mch_get_font(font_name, FALSE);
1037 	    if (font != NOFONT)
1038 		break;
1039 	}
1040 	if (font == NOFONT)
1041 	    return FAIL;
1042     }
1043 
1044     gui_mch_free_font(gui.wide_font);
1045 #ifdef FEAT_GUI_GTK
1046     // Avoid unnecessary overhead if 'guifontwide' is equal to 'guifont'.
1047     if (font != NOFONT && gui.norm_font != NOFONT
1048 			 && pango_font_description_equal(font, gui.norm_font))
1049     {
1050 	gui.wide_font = NOFONT;
1051 	gui_mch_free_font(font);
1052     }
1053     else
1054 #endif
1055 	gui.wide_font = font;
1056 #ifdef FEAT_GUI_MSWIN
1057     gui_mch_wide_font_changed();
1058 #else
1059     /*
1060      * TODO: setup wide_bold_font, wide_ital_font and wide_boldital_font to
1061      * support those fonts for 'guifontwide'.
1062      */
1063 #endif
1064     return OK;
1065 }
1066 
1067     static void
1068 gui_set_cursor(int row, int col)
1069 {
1070     gui.row = row;
1071     gui.col = col;
1072 }
1073 
1074 /*
1075  * gui_check_pos - check if the cursor is on the screen.
1076  */
1077     static void
1078 gui_check_pos(void)
1079 {
1080     if (gui.row >= screen_Rows)
1081 	gui.row = screen_Rows - 1;
1082     if (gui.col >= screen_Columns)
1083 	gui.col = screen_Columns - 1;
1084     if (gui.cursor_row >= screen_Rows || gui.cursor_col >= screen_Columns)
1085 	gui.cursor_is_valid = FALSE;
1086 }
1087 
1088 /*
1089  * Redraw the cursor if necessary or when forced.
1090  * Careful: The contents of ScreenLines[] must match what is on the screen,
1091  * otherwise this goes wrong.  May need to call out_flush() first.
1092  */
1093     void
1094 gui_update_cursor(
1095     int		force,		 // when TRUE, update even when not moved
1096     int		clear_selection) // clear selection under cursor
1097 {
1098     int		cur_width = 0;
1099     int		cur_height = 0;
1100     int		old_hl_mask;
1101     cursorentry_T *shape;
1102     int		id;
1103 #ifdef FEAT_TERMINAL
1104     guicolor_T	shape_fg = INVALCOLOR;
1105     guicolor_T	shape_bg = INVALCOLOR;
1106 #endif
1107     guicolor_T	cfg, cbg, cc;	// cursor fore-/background color
1108     int		cattr;		// cursor attributes
1109     int		attr;
1110     attrentry_T *aep = NULL;
1111 
1112     // Don't update the cursor when halfway busy scrolling or the screen size
1113     // doesn't match 'columns' and 'lines.  ScreenLines[] isn't valid then.
1114     if (!can_update_cursor || screen_Columns != gui.num_cols
1115 					       || screen_Rows != gui.num_rows)
1116 	return;
1117 
1118     gui_check_pos();
1119     if (!gui.cursor_is_valid || force
1120 		    || gui.row != gui.cursor_row || gui.col != gui.cursor_col)
1121     {
1122 	gui_undraw_cursor();
1123 	if (gui.row < 0)
1124 	    return;
1125 #ifdef HAVE_INPUT_METHOD
1126 	if (gui.row != gui.cursor_row || gui.col != gui.cursor_col)
1127 	    im_set_position(gui.row, gui.col);
1128 #endif
1129 	gui.cursor_row = gui.row;
1130 	gui.cursor_col = gui.col;
1131 
1132 	// Only write to the screen after ScreenLines[] has been initialized
1133 	if (!screen_cleared || ScreenLines == NULL)
1134 	    return;
1135 
1136 	// Clear the selection if we are about to write over it
1137 	if (clear_selection)
1138 	    clip_may_clear_selection(gui.row, gui.row);
1139 	// Check that the cursor is inside the shell (resizing may have made
1140 	// it invalid)
1141 	if (gui.row >= screen_Rows || gui.col >= screen_Columns)
1142 	    return;
1143 
1144 	gui.cursor_is_valid = TRUE;
1145 
1146 	/*
1147 	 * How the cursor is drawn depends on the current mode.
1148 	 * When in a terminal window use the shape/color specified there.
1149 	 */
1150 #ifdef FEAT_TERMINAL
1151 	if (terminal_is_active())
1152 	    shape = term_get_cursor_shape(&shape_fg, &shape_bg);
1153 	else
1154 #endif
1155 	    shape = &shape_table[get_shape_idx(FALSE)];
1156 	if (State & LANGMAP)
1157 	    id = shape->id_lm;
1158 	else
1159 	    id = shape->id;
1160 
1161 	// get the colors and attributes for the cursor.  Default is inverted
1162 	cfg = INVALCOLOR;
1163 	cbg = INVALCOLOR;
1164 	cattr = HL_INVERSE;
1165 	gui_mch_set_blinking(shape->blinkwait,
1166 			     shape->blinkon,
1167 			     shape->blinkoff);
1168 	if (shape->blinkwait == 0 || shape->blinkon == 0
1169 						       || shape->blinkoff == 0)
1170 	    gui_mch_stop_blink(FALSE);
1171 #ifdef FEAT_TERMINAL
1172 	if (shape_bg != INVALCOLOR)
1173 	{
1174 	    cattr = 0;
1175 	    cfg = shape_fg;
1176 	    cbg = shape_bg;
1177 	}
1178 	else
1179 #endif
1180 	if (id > 0)
1181 	{
1182 	    cattr = syn_id2colors(id, &cfg, &cbg);
1183 #if defined(HAVE_INPUT_METHOD)
1184 	    {
1185 		static int iid;
1186 		guicolor_T fg, bg;
1187 
1188 		if (
1189 # if defined(FEAT_GUI_GTK) && defined(FEAT_XIM)
1190 			preedit_get_status()
1191 # else
1192 			im_get_status()
1193 # endif
1194 			)
1195 		{
1196 		    iid = syn_name2id((char_u *)"CursorIM");
1197 		    if (iid > 0)
1198 		    {
1199 			syn_id2colors(iid, &fg, &bg);
1200 			if (bg != INVALCOLOR)
1201 			    cbg = bg;
1202 			if (fg != INVALCOLOR)
1203 			    cfg = fg;
1204 		    }
1205 		}
1206 	    }
1207 #endif
1208 	}
1209 
1210 	/*
1211 	 * Get the attributes for the character under the cursor.
1212 	 * When no cursor color was given, use the character color.
1213 	 */
1214 	attr = ScreenAttrs[LineOffset[gui.row] + gui.col];
1215 	if (attr > HL_ALL)
1216 	    aep = syn_gui_attr2entry(attr);
1217 	if (aep != NULL)
1218 	{
1219 	    attr = aep->ae_attr;
1220 	    if (cfg == INVALCOLOR)
1221 		cfg = ((attr & HL_INVERSE)  ? aep->ae_u.gui.bg_color
1222 					    : aep->ae_u.gui.fg_color);
1223 	    if (cbg == INVALCOLOR)
1224 		cbg = ((attr & HL_INVERSE)  ? aep->ae_u.gui.fg_color
1225 					    : aep->ae_u.gui.bg_color);
1226 	}
1227 	if (cfg == INVALCOLOR)
1228 	    cfg = (attr & HL_INVERSE) ? gui.back_pixel : gui.norm_pixel;
1229 	if (cbg == INVALCOLOR)
1230 	    cbg = (attr & HL_INVERSE) ? gui.norm_pixel : gui.back_pixel;
1231 
1232 #ifdef FEAT_XIM
1233 	if (aep != NULL)
1234 	{
1235 	    xim_bg_color = ((attr & HL_INVERSE) ? aep->ae_u.gui.fg_color
1236 						: aep->ae_u.gui.bg_color);
1237 	    xim_fg_color = ((attr & HL_INVERSE) ? aep->ae_u.gui.bg_color
1238 						: aep->ae_u.gui.fg_color);
1239 	    if (xim_bg_color == INVALCOLOR)
1240 		xim_bg_color = (attr & HL_INVERSE) ? gui.norm_pixel
1241 						   : gui.back_pixel;
1242 	    if (xim_fg_color == INVALCOLOR)
1243 		xim_fg_color = (attr & HL_INVERSE) ? gui.back_pixel
1244 						   : gui.norm_pixel;
1245 	}
1246 	else
1247 	{
1248 	    xim_bg_color = (attr & HL_INVERSE) ? gui.norm_pixel
1249 					       : gui.back_pixel;
1250 	    xim_fg_color = (attr & HL_INVERSE) ? gui.back_pixel
1251 					       : gui.norm_pixel;
1252 	}
1253 #endif
1254 
1255 	attr &= ~HL_INVERSE;
1256 	if (cattr & HL_INVERSE)
1257 	{
1258 	    cc = cbg;
1259 	    cbg = cfg;
1260 	    cfg = cc;
1261 	}
1262 	cattr &= ~HL_INVERSE;
1263 
1264 	/*
1265 	 * When we don't have window focus, draw a hollow cursor.
1266 	 */
1267 	if (!gui.in_focus)
1268 	{
1269 	    gui_mch_draw_hollow_cursor(cbg);
1270 	    return;
1271 	}
1272 
1273 	old_hl_mask = gui.highlight_mask;
1274 	if (shape->shape == SHAPE_BLOCK)
1275 	{
1276 	    /*
1277 	     * Draw the text character with the cursor colors.	Use the
1278 	     * character attributes plus the cursor attributes.
1279 	     */
1280 	    gui.highlight_mask = (cattr | attr);
1281 	    (void)gui_screenchar(LineOffset[gui.row] + gui.col,
1282 			GUI_MON_IS_CURSOR | GUI_MON_NOCLEAR, cfg, cbg, 0);
1283 	}
1284 	else
1285 	{
1286 #if defined(FEAT_RIGHTLEFT)
1287 	    int	    col_off = FALSE;
1288 #endif
1289 	    /*
1290 	     * First draw the partial cursor, then overwrite with the text
1291 	     * character, using a transparent background.
1292 	     */
1293 	    if (shape->shape == SHAPE_VER)
1294 	    {
1295 		cur_height = gui.char_height;
1296 		cur_width = (gui.char_width * shape->percentage + 99) / 100;
1297 	    }
1298 	    else
1299 	    {
1300 		cur_height = (gui.char_height * shape->percentage + 99) / 100;
1301 		cur_width = gui.char_width;
1302 	    }
1303 	    if (has_mbyte && (*mb_off2cells)(LineOffset[gui.row] + gui.col,
1304 				    LineOffset[gui.row] + screen_Columns) > 1)
1305 	    {
1306 		// Double wide character.
1307 		if (shape->shape != SHAPE_VER)
1308 		    cur_width += gui.char_width;
1309 #ifdef FEAT_RIGHTLEFT
1310 		if (CURSOR_BAR_RIGHT)
1311 		{
1312 		    // gui.col points to the left halve of the character but
1313 		    // the vertical line needs to be on the right halve.
1314 		    // A double-wide horizontal line is also drawn from the
1315 		    // right halve in gui_mch_draw_part_cursor().
1316 		    col_off = TRUE;
1317 		    ++gui.col;
1318 		}
1319 #endif
1320 	    }
1321 	    gui_mch_draw_part_cursor(cur_width, cur_height, cbg);
1322 #if defined(FEAT_RIGHTLEFT)
1323 	    if (col_off)
1324 		--gui.col;
1325 #endif
1326 
1327 #ifndef FEAT_GUI_MSWIN	    // doesn't seem to work for MSWindows
1328 	    gui.highlight_mask = ScreenAttrs[LineOffset[gui.row] + gui.col];
1329 	    (void)gui_screenchar(LineOffset[gui.row] + gui.col,
1330 		    GUI_MON_TRS_CURSOR | GUI_MON_NOCLEAR,
1331 		    (guicolor_T)0, (guicolor_T)0, 0);
1332 #endif
1333 	}
1334 	gui.highlight_mask = old_hl_mask;
1335     }
1336 }
1337 
1338 #if defined(FEAT_MENU) || defined(PROTO)
1339     void
1340 gui_position_menu(void)
1341 {
1342 # if !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MOTIF)
1343     if (gui.menu_is_active && gui.in_use)
1344 	gui_mch_set_menu_pos(0, 0, gui.menu_width, gui.menu_height);
1345 # endif
1346 }
1347 #endif
1348 
1349 /*
1350  * Position the various GUI components (text area, menu).  The vertical
1351  * scrollbars are NOT handled here.  See gui_update_scrollbars().
1352  */
1353     static void
1354 gui_position_components(int total_width UNUSED)
1355 {
1356     int	    text_area_x;
1357     int	    text_area_y;
1358     int	    text_area_width;
1359     int	    text_area_height;
1360 
1361     // avoid that moving components around generates events
1362     ++hold_gui_events;
1363 
1364     text_area_x = 0;
1365     if (gui.which_scrollbars[SBAR_LEFT])
1366 	text_area_x += gui.scrollbar_width;
1367 
1368     text_area_y = 0;
1369 #if defined(FEAT_MENU) && !(defined(FEAT_GUI_GTK) || defined(FEAT_GUI_PHOTON))
1370     gui.menu_width = total_width;
1371     if (gui.menu_is_active)
1372 	text_area_y += gui.menu_height;
1373 #endif
1374 #if defined(FEAT_TOOLBAR) && defined(FEAT_GUI_MSWIN)
1375     if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
1376 	text_area_y = TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT;
1377 #endif
1378 
1379 # if defined(FEAT_GUI_TABLINE) && (defined(FEAT_GUI_MSWIN) \
1380 	|| defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_MAC))
1381     if (gui_has_tabline())
1382 	text_area_y += gui.tabline_height;
1383 #endif
1384 
1385 #if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA) \
1386 	|| defined(FEAT_GUI_HAIKU))
1387     if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
1388     {
1389 # if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_HAIKU)
1390 	gui_mch_set_toolbar_pos(0, text_area_y,
1391 				gui.menu_width, gui.toolbar_height);
1392 # endif
1393 	text_area_y += gui.toolbar_height;
1394     }
1395 #endif
1396 
1397 # if defined(FEAT_GUI_TABLINE) && defined(FEAT_GUI_HAIKU)
1398     gui_mch_set_tabline_pos(0, text_area_y,
1399     gui.menu_width, gui.tabline_height);
1400     if (gui_has_tabline())
1401 	text_area_y += gui.tabline_height;
1402 #endif
1403 
1404     text_area_width = gui.num_cols * gui.char_width + gui.border_offset * 2;
1405     text_area_height = gui.num_rows * gui.char_height + gui.border_offset * 2;
1406 
1407     gui_mch_set_text_area_pos(text_area_x,
1408 			      text_area_y,
1409 			      text_area_width,
1410 			      text_area_height
1411 #if defined(FEAT_XIM) && !defined(FEAT_GUI_GTK)
1412 				  + xim_get_status_area_height()
1413 #endif
1414 			      );
1415 #ifdef FEAT_MENU
1416     gui_position_menu();
1417 #endif
1418     if (gui.which_scrollbars[SBAR_BOTTOM])
1419 	gui_mch_set_scrollbar_pos(&gui.bottom_sbar,
1420 				  text_area_x,
1421 				  text_area_y + text_area_height
1422 					+ gui_mch_get_scrollbar_ypadding(),
1423 				  text_area_width,
1424 				  gui.scrollbar_height);
1425     gui.left_sbar_x = 0;
1426     gui.right_sbar_x = text_area_x + text_area_width
1427 					+ gui_mch_get_scrollbar_xpadding();
1428 
1429     --hold_gui_events;
1430 }
1431 
1432 /*
1433  * Get the width of the widgets and decorations to the side of the text area.
1434  */
1435     int
1436 gui_get_base_width(void)
1437 {
1438     int	    base_width;
1439 
1440     base_width = 2 * gui.border_offset;
1441     if (gui.which_scrollbars[SBAR_LEFT])
1442 	base_width += gui.scrollbar_width;
1443     if (gui.which_scrollbars[SBAR_RIGHT])
1444 	base_width += gui.scrollbar_width;
1445     return base_width;
1446 }
1447 
1448 /*
1449  * Get the height of the widgets and decorations above and below the text area.
1450  */
1451     int
1452 gui_get_base_height(void)
1453 {
1454     int	    base_height;
1455 
1456     base_height = 2 * gui.border_offset;
1457     if (gui.which_scrollbars[SBAR_BOTTOM])
1458 	base_height += gui.scrollbar_height;
1459 #ifdef FEAT_GUI_GTK
1460     // We can't take the sizes properly into account until anything is
1461     // realized.  Therefore we recalculate all the values here just before
1462     // setting the size. (--mdcki)
1463 #else
1464 # ifdef FEAT_MENU
1465     if (gui.menu_is_active)
1466 	base_height += gui.menu_height;
1467 # endif
1468 # ifdef FEAT_TOOLBAR
1469     if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
1470 #  if defined(FEAT_GUI_MSWIN) && defined(FEAT_TOOLBAR)
1471 	base_height += (TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT);
1472 #  else
1473 	base_height += gui.toolbar_height;
1474 #  endif
1475 # endif
1476 # if defined(FEAT_GUI_TABLINE) && (defined(FEAT_GUI_MSWIN) \
1477 	|| defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_HAIKU))
1478     if (gui_has_tabline())
1479 	base_height += gui.tabline_height;
1480 # endif
1481 # ifdef FEAT_FOOTER
1482     if (vim_strchr(p_go, GO_FOOTER) != NULL)
1483 	base_height += gui.footer_height;
1484 # endif
1485 # if defined(FEAT_GUI_MOTIF) && defined(FEAT_MENU)
1486     base_height += gui_mch_text_area_extra_height();
1487 # endif
1488 #endif
1489     return base_height;
1490 }
1491 
1492 /*
1493  * Should be called after the GUI shell has been resized.  Its arguments are
1494  * the new width and height of the shell in pixels.
1495  */
1496     void
1497 gui_resize_shell(int pixel_width, int pixel_height)
1498 {
1499     static int	busy = FALSE;
1500 
1501     if (!gui.shell_created)	    // ignore when still initializing
1502 	return;
1503 
1504     /*
1505      * Can't resize the screen while it is being redrawn.  Remember the new
1506      * size and handle it later.
1507      */
1508     if (updating_screen || busy)
1509     {
1510 	new_pixel_width = pixel_width;
1511 	new_pixel_height = pixel_height;
1512 	return;
1513     }
1514 
1515 again:
1516     new_pixel_width = 0;
1517     new_pixel_height = 0;
1518     busy = TRUE;
1519 
1520 #ifdef FEAT_GUI_HAIKU
1521     vim_lock_screen();
1522 #endif
1523 
1524     // Flush pending output before redrawing
1525     out_flush();
1526 
1527     gui.num_cols = (pixel_width - gui_get_base_width()) / gui.char_width;
1528     gui.num_rows = (pixel_height - gui_get_base_height()) / gui.char_height;
1529 
1530     gui_position_components(pixel_width);
1531     gui_reset_scroll_region();
1532 
1533     /*
1534      * At the "more" and ":confirm" prompt there is no redraw, put the cursor
1535      * at the last line here (why does it have to be one row too low?).
1536      */
1537     if (State == ASKMORE || State == CONFIRM)
1538 	gui.row = gui.num_rows;
1539 
1540     // Only comparing Rows and Columns may be sufficient, but let's stay on
1541     // the safe side.
1542     if (gui.num_rows != screen_Rows || gui.num_cols != screen_Columns
1543 	    || gui.num_rows != Rows || gui.num_cols != Columns)
1544 	shell_resized();
1545 
1546 #ifdef FEAT_GUI_HAIKU
1547     vim_unlock_screen();
1548 #endif
1549 
1550     gui_update_scrollbars(TRUE);
1551     gui_update_cursor(FALSE, TRUE);
1552 #if defined(FEAT_XIM) && !defined(FEAT_GUI_GTK)
1553     xim_set_status_area();
1554 #endif
1555 
1556     busy = FALSE;
1557 
1558     // We may have been called again while redrawing the screen.
1559     // Need to do it all again with the latest size then.  But only if the size
1560     // actually changed.
1561     if (new_pixel_height)
1562     {
1563 	if (pixel_width == new_pixel_width && pixel_height == new_pixel_height)
1564 	{
1565 	    new_pixel_width = 0;
1566 	    new_pixel_height = 0;
1567 	}
1568 	else
1569 	{
1570 	    pixel_width = new_pixel_width;
1571 	    pixel_height = new_pixel_height;
1572 	    goto again;
1573 	}
1574     }
1575 }
1576 
1577 /*
1578  * Check if gui_resize_shell() must be called.
1579  */
1580     void
1581 gui_may_resize_shell(void)
1582 {
1583     if (new_pixel_height)
1584 	// careful: gui_resize_shell() may postpone the resize again if we
1585 	// were called indirectly by it
1586 	gui_resize_shell(new_pixel_width, new_pixel_height);
1587 }
1588 
1589     int
1590 gui_get_shellsize(void)
1591 {
1592     Rows = gui.num_rows;
1593     Columns = gui.num_cols;
1594     return OK;
1595 }
1596 
1597 /*
1598  * Set the size of the Vim shell according to Rows and Columns.
1599  * If "fit_to_display" is TRUE then the size may be reduced to fit the window
1600  * on the screen.
1601  * When "mustset" is TRUE the size was set by the user. When FALSE a UI
1602  * component was added or removed (e.g., a scrollbar).
1603  */
1604     void
1605 gui_set_shellsize(
1606     int		mustset UNUSED,
1607     int		fit_to_display,
1608     int		direction)		// RESIZE_HOR, RESIZE_VER
1609 {
1610     int		base_width;
1611     int		base_height;
1612     int		width;
1613     int		height;
1614     int		min_width;
1615     int		min_height;
1616     int		screen_w;
1617     int		screen_h;
1618 #ifdef FEAT_GUI_GTK
1619     int		un_maximize = mustset;
1620     int		did_adjust = 0;
1621 #endif
1622     int		x = -1, y = -1;
1623 
1624     if (!gui.shell_created)
1625 	return;
1626 
1627 #if defined(MSWIN) || defined(FEAT_GUI_GTK)
1628     // If not setting to a user specified size and maximized, calculate the
1629     // number of characters that fit in the maximized window.
1630     if (!mustset && (vim_strchr(p_go, GO_KEEPWINSIZE) != NULL
1631 						       || gui_mch_maximized()))
1632     {
1633 	gui_mch_newfont();
1634 	return;
1635     }
1636 #endif
1637 
1638     base_width = gui_get_base_width();
1639     base_height = gui_get_base_height();
1640     if (fit_to_display)
1641 	// Remember the original window position.
1642 	(void)gui_mch_get_winpos(&x, &y);
1643 
1644     width = Columns * gui.char_width + base_width;
1645     height = Rows * gui.char_height + base_height;
1646 
1647     if (fit_to_display)
1648     {
1649 	gui_mch_get_screen_dimensions(&screen_w, &screen_h);
1650 	if ((direction & RESIZE_HOR) && width > screen_w)
1651 	{
1652 	    Columns = (screen_w - base_width) / gui.char_width;
1653 	    if (Columns < MIN_COLUMNS)
1654 		Columns = MIN_COLUMNS;
1655 	    width = Columns * gui.char_width + base_width;
1656 #ifdef FEAT_GUI_GTK
1657 	    ++did_adjust;
1658 #endif
1659 	}
1660 	if ((direction & RESIZE_VERT) && height > screen_h)
1661 	{
1662 	    Rows = (screen_h - base_height) / gui.char_height;
1663 	    check_shellsize();
1664 	    height = Rows * gui.char_height + base_height;
1665 #ifdef FEAT_GUI_GTK
1666 	    ++did_adjust;
1667 #endif
1668 	}
1669 #ifdef FEAT_GUI_GTK
1670 	if (did_adjust == 2 || (width + gui.char_width >= screen_w
1671 				     && height + gui.char_height >= screen_h))
1672 	    // don't unmaximize if at maximum size
1673 	    un_maximize = FALSE;
1674 #endif
1675     }
1676     limit_screen_size();
1677     gui.num_cols = Columns;
1678     gui.num_rows = Rows;
1679 
1680     min_width = base_width + MIN_COLUMNS * gui.char_width;
1681     min_height = base_height + MIN_LINES * gui.char_height;
1682     min_height += tabline_height() * gui.char_height;
1683 
1684 #ifdef FEAT_GUI_GTK
1685     if (un_maximize)
1686     {
1687 	// If the window size is smaller than the screen unmaximize the
1688 	// window, otherwise resizing won't work.
1689 	gui_mch_get_screen_dimensions(&screen_w, &screen_h);
1690 	if ((width + gui.char_width < screen_w
1691 				   || height + gui.char_height * 2 < screen_h)
1692 		&& gui_mch_maximized())
1693 	    gui_mch_unmaximize();
1694     }
1695 #endif
1696 
1697     gui_mch_set_shellsize(width, height, min_width, min_height,
1698 					  base_width, base_height, direction);
1699 
1700     if (fit_to_display && x >= 0 && y >= 0)
1701     {
1702 	// Some window managers put the Vim window left of/above the screen.
1703 	// Only change the position if it wasn't already negative before
1704 	// (happens on MS-Windows with a secondary monitor).
1705 	gui_mch_update();
1706 	if (gui_mch_get_winpos(&x, &y) == OK && (x < 0 || y < 0))
1707 	    gui_mch_set_winpos(x < 0 ? 0 : x, y < 0 ? 0 : y);
1708     }
1709 
1710     gui_position_components(width);
1711     gui_update_scrollbars(TRUE);
1712     gui_reset_scroll_region();
1713 }
1714 
1715 /*
1716  * Called when Rows and/or Columns has changed.
1717  */
1718     void
1719 gui_new_shellsize(void)
1720 {
1721     gui_reset_scroll_region();
1722 }
1723 
1724 /*
1725  * Make scroll region cover whole screen.
1726  */
1727     static void
1728 gui_reset_scroll_region(void)
1729 {
1730     gui.scroll_region_top = 0;
1731     gui.scroll_region_bot = gui.num_rows - 1;
1732     gui.scroll_region_left = 0;
1733     gui.scroll_region_right = gui.num_cols - 1;
1734 }
1735 
1736     static void
1737 gui_start_highlight(int mask)
1738 {
1739     if (mask > HL_ALL)		    // highlight code
1740 	gui.highlight_mask = mask;
1741     else			    // mask
1742 	gui.highlight_mask |= mask;
1743 }
1744 
1745     void
1746 gui_stop_highlight(int mask)
1747 {
1748     if (mask > HL_ALL)		    // highlight code
1749 	gui.highlight_mask = HL_NORMAL;
1750     else			    // mask
1751 	gui.highlight_mask &= ~mask;
1752 }
1753 
1754 /*
1755  * Clear a rectangular region of the screen from text pos (row1, col1) to
1756  * (row2, col2) inclusive.
1757  */
1758     void
1759 gui_clear_block(
1760     int	    row1,
1761     int	    col1,
1762     int	    row2,
1763     int	    col2)
1764 {
1765     // Clear the selection if we are about to write over it
1766     clip_may_clear_selection(row1, row2);
1767 
1768     gui_mch_clear_block(row1, col1, row2, col2);
1769 
1770     // Invalidate cursor if it was in this block
1771     if (       gui.cursor_row >= row1 && gui.cursor_row <= row2
1772 	    && gui.cursor_col >= col1 && gui.cursor_col <= col2)
1773 	gui.cursor_is_valid = FALSE;
1774 }
1775 
1776 /*
1777  * Write code to update the cursor later.  This avoids the need to flush the
1778  * output buffer before calling gui_update_cursor().
1779  */
1780     void
1781 gui_update_cursor_later(void)
1782 {
1783     OUT_STR(IF_EB("\033|s", ESC_STR "|s"));
1784 }
1785 
1786     void
1787 gui_write(
1788     char_u	*s,
1789     int		len)
1790 {
1791     char_u	*p;
1792     int		arg1 = 0, arg2 = 0;
1793     int		force_cursor = FALSE;	// force cursor update
1794     int		force_scrollbar = FALSE;
1795     static win_T	*old_curwin = NULL;
1796 
1797 // #define DEBUG_GUI_WRITE
1798 #ifdef DEBUG_GUI_WRITE
1799     {
1800 	int i;
1801 	char_u *str;
1802 
1803 	printf("gui_write(%d):\n    ", len);
1804 	for (i = 0; i < len; i++)
1805 	    if (s[i] == ESC)
1806 	    {
1807 		if (i != 0)
1808 		    printf("\n    ");
1809 		printf("<ESC>");
1810 	    }
1811 	    else
1812 	    {
1813 		str = transchar_byte(s[i]);
1814 		if (str[0] && str[1])
1815 		    printf("<%s>", (char *)str);
1816 		else
1817 		    printf("%s", (char *)str);
1818 	    }
1819 	printf("\n");
1820     }
1821 #endif
1822     while (len)
1823     {
1824 	if (s[0] == ESC && s[1] == '|')
1825 	{
1826 	    p = s + 2;
1827 	    if (VIM_ISDIGIT(*p) || (*p == '-' && VIM_ISDIGIT(*(p + 1))))
1828 	    {
1829 		arg1 = getdigits(&p);
1830 		if (p > s + len)
1831 		    break;
1832 		if (*p == ';')
1833 		{
1834 		    ++p;
1835 		    arg2 = getdigits(&p);
1836 		    if (p > s + len)
1837 			break;
1838 		}
1839 	    }
1840 	    switch (*p)
1841 	    {
1842 		case 'C':	// Clear screen
1843 		    clip_scroll_selection(9999);
1844 		    gui_mch_clear_all();
1845 		    gui.cursor_is_valid = FALSE;
1846 		    force_scrollbar = TRUE;
1847 		    break;
1848 		case 'M':	// Move cursor
1849 		    gui_set_cursor(arg1, arg2);
1850 		    break;
1851 		case 's':	// force cursor (shape) update
1852 		    force_cursor = TRUE;
1853 		    break;
1854 		case 'R':	// Set scroll region
1855 		    if (arg1 < arg2)
1856 		    {
1857 			gui.scroll_region_top = arg1;
1858 			gui.scroll_region_bot = arg2;
1859 		    }
1860 		    else
1861 		    {
1862 			gui.scroll_region_top = arg2;
1863 			gui.scroll_region_bot = arg1;
1864 		    }
1865 		    break;
1866 		case 'V':	// Set vertical scroll region
1867 		    if (arg1 < arg2)
1868 		    {
1869 			gui.scroll_region_left = arg1;
1870 			gui.scroll_region_right = arg2;
1871 		    }
1872 		    else
1873 		    {
1874 			gui.scroll_region_left = arg2;
1875 			gui.scroll_region_right = arg1;
1876 		    }
1877 		    break;
1878 		case 'd':	// Delete line
1879 		    gui_delete_lines(gui.row, 1);
1880 		    break;
1881 		case 'D':	// Delete lines
1882 		    gui_delete_lines(gui.row, arg1);
1883 		    break;
1884 		case 'i':	// Insert line
1885 		    gui_insert_lines(gui.row, 1);
1886 		    break;
1887 		case 'I':	// Insert lines
1888 		    gui_insert_lines(gui.row, arg1);
1889 		    break;
1890 		case '$':	// Clear to end-of-line
1891 		    gui_clear_block(gui.row, gui.col, gui.row,
1892 							    (int)Columns - 1);
1893 		    break;
1894 		case 'h':	// Turn on highlighting
1895 		    gui_start_highlight(arg1);
1896 		    break;
1897 		case 'H':	// Turn off highlighting
1898 		    gui_stop_highlight(arg1);
1899 		    break;
1900 		case 'f':	// flash the window (visual bell)
1901 		    gui_mch_flash(arg1 == 0 ? 20 : arg1);
1902 		    break;
1903 		default:
1904 		    p = s + 1;	// Skip the ESC
1905 		    break;
1906 	    }
1907 	    len -= (int)(++p - s);
1908 	    s = p;
1909 	}
1910 	else if (
1911 #ifdef EBCDIC
1912 		CtrlChar(s[0]) != 0	// Ctrl character
1913 #else
1914 		s[0] < 0x20		// Ctrl character
1915 #endif
1916 #ifdef FEAT_SIGN_ICONS
1917 		&& s[0] != SIGN_BYTE
1918 # ifdef FEAT_NETBEANS_INTG
1919 		&& s[0] != MULTISIGN_BYTE
1920 # endif
1921 #endif
1922 		)
1923 	{
1924 	    if (s[0] == '\n')		// NL
1925 	    {
1926 		gui.col = 0;
1927 		if (gui.row < gui.scroll_region_bot)
1928 		    gui.row++;
1929 		else
1930 		    gui_delete_lines(gui.scroll_region_top, 1);
1931 	    }
1932 	    else if (s[0] == '\r')	// CR
1933 	    {
1934 		gui.col = 0;
1935 	    }
1936 	    else if (s[0] == '\b')	// Backspace
1937 	    {
1938 		if (gui.col)
1939 		    --gui.col;
1940 	    }
1941 	    else if (s[0] == Ctrl_L)	// cursor-right
1942 	    {
1943 		++gui.col;
1944 	    }
1945 	    else if (s[0] == Ctrl_G)	// Beep
1946 	    {
1947 		gui_mch_beep();
1948 	    }
1949 	    // Other Ctrl character: shouldn't happen!
1950 
1951 	    --len;	// Skip this char
1952 	    ++s;
1953 	}
1954 	else
1955 	{
1956 	    p = s;
1957 	    while (len > 0 && (
1958 #ifdef EBCDIC
1959 			CtrlChar(*p) == 0
1960 #else
1961 			*p >= 0x20
1962 #endif
1963 #ifdef FEAT_SIGN_ICONS
1964 			|| *p == SIGN_BYTE
1965 # ifdef FEAT_NETBEANS_INTG
1966 			|| *p == MULTISIGN_BYTE
1967 # endif
1968 #endif
1969 			))
1970 	    {
1971 		len--;
1972 		p++;
1973 	    }
1974 	    gui_outstr(s, (int)(p - s));
1975 	    s = p;
1976 	}
1977     }
1978 
1979     // Postponed update of the cursor (won't work if "can_update_cursor" isn't
1980     // set).
1981     if (force_cursor)
1982 	gui_update_cursor(TRUE, TRUE);
1983 
1984     // When switching to another window the dragging must have stopped.
1985     // Required for GTK, dragged_sb isn't reset.
1986     if (old_curwin != curwin)
1987 	gui.dragged_sb = SBAR_NONE;
1988 
1989     // Update the scrollbars after clearing the screen or when switched
1990     // to another window.
1991     // Update the horizontal scrollbar always, it's difficult to check all
1992     // situations where it might change.
1993     if (force_scrollbar || old_curwin != curwin)
1994 	gui_update_scrollbars(force_scrollbar);
1995     else
1996 	gui_update_horiz_scrollbar(FALSE);
1997     old_curwin = curwin;
1998 
1999     /*
2000      * We need to make sure this is cleared since Athena doesn't tell us when
2001      * he is done dragging.  Do the same for GTK.
2002      */
2003 #if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_GTK)
2004     gui.dragged_sb = SBAR_NONE;
2005 #endif
2006 
2007     gui_may_flush();		    // In case vim decides to take a nap
2008 }
2009 
2010 /*
2011  * When ScreenLines[] is invalid, updating the cursor should not be done, it
2012  * produces wrong results.  Call gui_dont_update_cursor() before that code and
2013  * gui_can_update_cursor() afterwards.
2014  */
2015     void
2016 gui_dont_update_cursor(int undraw)
2017 {
2018     if (gui.in_use)
2019     {
2020 	// Undraw the cursor now, we probably can't do it after the change.
2021 	if (undraw)
2022 	    gui_undraw_cursor();
2023 	can_update_cursor = FALSE;
2024     }
2025 }
2026 
2027     void
2028 gui_can_update_cursor(void)
2029 {
2030     can_update_cursor = TRUE;
2031     // No need to update the cursor right now, there is always more output
2032     // after scrolling.
2033 }
2034 
2035 /*
2036  * Disable issuing gui_mch_flush().
2037  */
2038     void
2039 gui_disable_flush(void)
2040 {
2041     ++disable_flush;
2042 }
2043 
2044 /*
2045  * Enable issuing gui_mch_flush().
2046  */
2047     void
2048 gui_enable_flush(void)
2049 {
2050     --disable_flush;
2051 }
2052 
2053 /*
2054  * Issue gui_mch_flush() if it is not disabled.
2055  */
2056     void
2057 gui_may_flush(void)
2058 {
2059     if (disable_flush == 0)
2060 	gui_mch_flush();
2061 }
2062 
2063     static void
2064 gui_outstr(char_u *s, int len)
2065 {
2066     int	    this_len;
2067     int	    cells;
2068 
2069     if (len == 0)
2070 	return;
2071 
2072     if (len < 0)
2073 	len = (int)STRLEN(s);
2074 
2075     while (len > 0)
2076     {
2077 	if (has_mbyte)
2078 	{
2079 	    // Find out how many chars fit in the current line.
2080 	    cells = 0;
2081 	    for (this_len = 0; this_len < len; )
2082 	    {
2083 		cells += (*mb_ptr2cells)(s + this_len);
2084 		if (gui.col + cells > Columns)
2085 		    break;
2086 		this_len += (*mb_ptr2len)(s + this_len);
2087 	    }
2088 	    if (this_len > len)
2089 		this_len = len;	    // don't include following composing char
2090 	}
2091 	else
2092 	    if (gui.col + len > Columns)
2093 	    this_len = Columns - gui.col;
2094 	else
2095 	    this_len = len;
2096 
2097 	(void)gui_outstr_nowrap(s, this_len,
2098 					  0, (guicolor_T)0, (guicolor_T)0, 0);
2099 	s += this_len;
2100 	len -= this_len;
2101 	// fill up for a double-width char that doesn't fit.
2102 	if (len > 0 && gui.col < Columns)
2103 	    (void)gui_outstr_nowrap((char_u *)" ", 1,
2104 					  0, (guicolor_T)0, (guicolor_T)0, 0);
2105 	// The cursor may wrap to the next line.
2106 	if (gui.col >= Columns)
2107 	{
2108 	    gui.col = 0;
2109 	    gui.row++;
2110 	}
2111     }
2112 }
2113 
2114 /*
2115  * Output one character (may be one or two display cells).
2116  * Caller must check for valid "off".
2117  * Returns FAIL or OK, just like gui_outstr_nowrap().
2118  */
2119     static int
2120 gui_screenchar(
2121     int		off,	    // Offset from start of screen
2122     int		flags,
2123     guicolor_T	fg,	    // colors for cursor
2124     guicolor_T	bg,	    // colors for cursor
2125     int		back)	    // backup this many chars when using bold trick
2126 {
2127     char_u	buf[MB_MAXBYTES + 1];
2128 
2129     // Don't draw right halve of a double-width UTF-8 char. "cannot happen"
2130     if (enc_utf8 && ScreenLines[off] == 0)
2131 	return OK;
2132 
2133     if (enc_utf8 && ScreenLinesUC[off] != 0)
2134 	// Draw UTF-8 multi-byte character.
2135 	return gui_outstr_nowrap(buf, utfc_char2bytes(off, buf),
2136 							 flags, fg, bg, back);
2137 
2138     if (enc_dbcs == DBCS_JPNU && ScreenLines[off] == 0x8e)
2139     {
2140 	buf[0] = ScreenLines[off];
2141 	buf[1] = ScreenLines2[off];
2142 	return gui_outstr_nowrap(buf, 2, flags, fg, bg, back);
2143     }
2144 
2145     // Draw non-multi-byte character or DBCS character.
2146     return gui_outstr_nowrap(ScreenLines + off,
2147 	    enc_dbcs ? (*mb_ptr2len)(ScreenLines + off) : 1,
2148 							 flags, fg, bg, back);
2149 }
2150 
2151 #ifdef FEAT_GUI_GTK
2152 /*
2153  * Output the string at the given screen position.  This is used in place
2154  * of gui_screenchar() where possible because Pango needs as much context
2155  * as possible to work nicely.  It's a lot faster as well.
2156  */
2157     static int
2158 gui_screenstr(
2159     int		off,	    // Offset from start of screen
2160     int		len,	    // string length in screen cells
2161     int		flags,
2162     guicolor_T	fg,	    // colors for cursor
2163     guicolor_T	bg,	    // colors for cursor
2164     int		back)	    // backup this many chars when using bold trick
2165 {
2166     char_u  *buf;
2167     int	    outlen = 0;
2168     int	    i;
2169     int	    retval;
2170 
2171     if (len <= 0) // "cannot happen"?
2172 	return OK;
2173 
2174     if (enc_utf8)
2175     {
2176 	buf = alloc(len * MB_MAXBYTES + 1);
2177 	if (buf == NULL)
2178 	    return OK; // not much we could do here...
2179 
2180 	for (i = off; i < off + len; ++i)
2181 	{
2182 	    if (ScreenLines[i] == 0)
2183 		continue; // skip second half of double-width char
2184 
2185 	    if (ScreenLinesUC[i] == 0)
2186 		buf[outlen++] = ScreenLines[i];
2187 	    else
2188 		outlen += utfc_char2bytes(i, buf + outlen);
2189 	}
2190 
2191 	buf[outlen] = NUL; // only to aid debugging
2192 	retval = gui_outstr_nowrap(buf, outlen, flags, fg, bg, back);
2193 	vim_free(buf);
2194 
2195 	return retval;
2196     }
2197     else if (enc_dbcs == DBCS_JPNU)
2198     {
2199 	buf = alloc(len * 2 + 1);
2200 	if (buf == NULL)
2201 	    return OK; // not much we could do here...
2202 
2203 	for (i = off; i < off + len; ++i)
2204 	{
2205 	    buf[outlen++] = ScreenLines[i];
2206 
2207 	    // handle double-byte single-width char
2208 	    if (ScreenLines[i] == 0x8e)
2209 		buf[outlen++] = ScreenLines2[i];
2210 	    else if (MB_BYTE2LEN(ScreenLines[i]) == 2)
2211 		buf[outlen++] = ScreenLines[++i];
2212 	}
2213 
2214 	buf[outlen] = NUL; // only to aid debugging
2215 	retval = gui_outstr_nowrap(buf, outlen, flags, fg, bg, back);
2216 	vim_free(buf);
2217 
2218 	return retval;
2219     }
2220     else
2221     {
2222 	return gui_outstr_nowrap(&ScreenLines[off], len,
2223 				 flags, fg, bg, back);
2224     }
2225 }
2226 #endif // FEAT_GUI_GTK
2227 
2228 /*
2229  * Output the given string at the current cursor position.  If the string is
2230  * too long to fit on the line, then it is truncated.
2231  * "flags":
2232  * GUI_MON_IS_CURSOR should only be used when this function is being called to
2233  * actually draw (an inverted) cursor.
2234  * GUI_MON_TRS_CURSOR is used to draw the cursor text with a transparent
2235  * background.
2236  * GUI_MON_NOCLEAR is used to avoid clearing the selection when drawing over
2237  * it.
2238  * Returns OK, unless "back" is non-zero and using the bold trick, then return
2239  * FAIL (the caller should start drawing "back" chars back).
2240  */
2241     static int
2242 gui_outstr_nowrap(
2243     char_u	*s,
2244     int		len,
2245     int		flags,
2246     guicolor_T	fg,	    // colors for cursor
2247     guicolor_T	bg,	    // colors for cursor
2248     int		back)	    // backup this many chars when using bold trick
2249 {
2250     long_u	highlight_mask;
2251     long_u	hl_mask_todo;
2252     guicolor_T	fg_color;
2253     guicolor_T	bg_color;
2254     guicolor_T	sp_color;
2255 #if !defined(FEAT_GUI_GTK)
2256     GuiFont	font = NOFONT;
2257     GuiFont	wide_font = NOFONT;
2258 # ifdef FEAT_XFONTSET
2259     GuiFontset	fontset = NOFONTSET;
2260 # endif
2261 #endif
2262     attrentry_T	*aep = NULL;
2263     int		draw_flags;
2264     int		col = gui.col;
2265 #ifdef FEAT_SIGN_ICONS
2266     int		draw_sign = FALSE;
2267     int		signcol = 0;
2268     char_u	extra[18];
2269 # ifdef FEAT_NETBEANS_INTG
2270     int		multi_sign = FALSE;
2271 # endif
2272 #endif
2273 
2274     if (len < 0)
2275 	len = (int)STRLEN(s);
2276     if (len == 0)
2277 	return OK;
2278 
2279 #ifdef FEAT_SIGN_ICONS
2280     if (*s == SIGN_BYTE
2281 # ifdef FEAT_NETBEANS_INTG
2282 	  || *s == MULTISIGN_BYTE
2283 # endif
2284        )
2285     {
2286 # ifdef FEAT_NETBEANS_INTG
2287 	if (*s == MULTISIGN_BYTE)
2288 	    multi_sign = TRUE;
2289 # endif
2290 	// draw spaces instead
2291 	if (*curwin->w_p_scl == 'n' && *(curwin->w_p_scl + 1) == 'u' &&
2292 		(curwin->w_p_nu || curwin->w_p_rnu))
2293 	{
2294 	    sprintf((char *)extra, "%*c ", number_width(curwin), ' ');
2295 	    s = extra;
2296 	}
2297 	else
2298 	    s = (char_u *)"  ";
2299 	if (len == 1 && col > 0)
2300 	    --col;
2301 	len = (int)STRLEN(s);
2302 	if (len > 2)
2303 	    // right align sign icon in the number column
2304 	    signcol = col + len - 3;
2305 	else
2306 	    signcol = col;
2307 	draw_sign = TRUE;
2308 	highlight_mask = 0;
2309     }
2310     else
2311 #endif
2312     if (gui.highlight_mask > HL_ALL)
2313     {
2314 	aep = syn_gui_attr2entry(gui.highlight_mask);
2315 	if (aep == NULL)	    // highlighting not set
2316 	    highlight_mask = 0;
2317 	else
2318 	    highlight_mask = aep->ae_attr;
2319     }
2320     else
2321 	highlight_mask = gui.highlight_mask;
2322     hl_mask_todo = highlight_mask;
2323 
2324 #if !defined(FEAT_GUI_GTK)
2325     // Set the font
2326     if (aep != NULL && aep->ae_u.gui.font != NOFONT)
2327 	font = aep->ae_u.gui.font;
2328 # ifdef FEAT_XFONTSET
2329     else if (aep != NULL && aep->ae_u.gui.fontset != NOFONTSET)
2330 	fontset = aep->ae_u.gui.fontset;
2331 # endif
2332     else
2333     {
2334 # ifdef FEAT_XFONTSET
2335 	if (gui.fontset != NOFONTSET)
2336 	    fontset = gui.fontset;
2337 	else
2338 # endif
2339 	    if (hl_mask_todo & (HL_BOLD | HL_STANDOUT))
2340 	{
2341 	    if ((hl_mask_todo & HL_ITALIC) && gui.boldital_font != NOFONT)
2342 	    {
2343 		font = gui.boldital_font;
2344 		hl_mask_todo &= ~(HL_BOLD | HL_STANDOUT | HL_ITALIC);
2345 	    }
2346 	    else if (gui.bold_font != NOFONT)
2347 	    {
2348 		font = gui.bold_font;
2349 		hl_mask_todo &= ~(HL_BOLD | HL_STANDOUT);
2350 	    }
2351 	    else
2352 		font = gui.norm_font;
2353 	}
2354 	else if ((hl_mask_todo & HL_ITALIC) && gui.ital_font != NOFONT)
2355 	{
2356 	    font = gui.ital_font;
2357 	    hl_mask_todo &= ~HL_ITALIC;
2358 	}
2359 	else
2360 	    font = gui.norm_font;
2361 
2362 	/*
2363 	 * Choose correct wide_font by font.  wide_font should be set with font
2364 	 * at same time in above block.  But it will make many "ifdef" nasty
2365 	 * blocks.  So we do it here.
2366 	 */
2367 	if (font == gui.boldital_font && gui.wide_boldital_font)
2368 	    wide_font = gui.wide_boldital_font;
2369 	else if (font == gui.bold_font && gui.wide_bold_font)
2370 	    wide_font = gui.wide_bold_font;
2371 	else if (font == gui.ital_font && gui.wide_ital_font)
2372 	    wide_font = gui.wide_ital_font;
2373 	else if (font == gui.norm_font && gui.wide_font)
2374 	    wide_font = gui.wide_font;
2375     }
2376 # ifdef FEAT_XFONTSET
2377     if (fontset != NOFONTSET)
2378 	gui_mch_set_fontset(fontset);
2379     else
2380 # endif
2381 	gui_mch_set_font(font);
2382 #endif
2383 
2384     draw_flags = 0;
2385 
2386     // Set the color
2387     bg_color = gui.back_pixel;
2388     if ((flags & GUI_MON_IS_CURSOR) && gui.in_focus)
2389     {
2390 	draw_flags |= DRAW_CURSOR;
2391 	fg_color = fg;
2392 	bg_color = bg;
2393 	sp_color = fg;
2394     }
2395     else if (aep != NULL)
2396     {
2397 	fg_color = aep->ae_u.gui.fg_color;
2398 	if (fg_color == INVALCOLOR)
2399 	    fg_color = gui.norm_pixel;
2400 	bg_color = aep->ae_u.gui.bg_color;
2401 	if (bg_color == INVALCOLOR)
2402 	    bg_color = gui.back_pixel;
2403 	sp_color = aep->ae_u.gui.sp_color;
2404 	if (sp_color == INVALCOLOR)
2405 	    sp_color = fg_color;
2406     }
2407     else
2408     {
2409 	fg_color = gui.norm_pixel;
2410 	sp_color = fg_color;
2411     }
2412 
2413     if (highlight_mask & (HL_INVERSE | HL_STANDOUT))
2414     {
2415 #if defined(AMIGA)
2416 	gui_mch_set_colors(bg_color, fg_color);
2417 #else
2418 	gui_mch_set_fg_color(bg_color);
2419 	gui_mch_set_bg_color(fg_color);
2420 #endif
2421     }
2422     else
2423     {
2424 #if defined(AMIGA)
2425 	gui_mch_set_colors(fg_color, bg_color);
2426 #else
2427 	gui_mch_set_fg_color(fg_color);
2428 	gui_mch_set_bg_color(bg_color);
2429 #endif
2430     }
2431     gui_mch_set_sp_color(sp_color);
2432 
2433     // Clear the selection if we are about to write over it
2434     if (!(flags & GUI_MON_NOCLEAR))
2435 	clip_may_clear_selection(gui.row, gui.row);
2436 
2437 
2438     // If there's no bold font, then fake it
2439     if (hl_mask_todo & (HL_BOLD | HL_STANDOUT))
2440 	draw_flags |= DRAW_BOLD;
2441 
2442     /*
2443      * When drawing bold or italic characters the spill-over from the left
2444      * neighbor may be destroyed.  Let the caller backup to start redrawing
2445      * just after a blank.
2446      */
2447     if (back != 0 && ((draw_flags & DRAW_BOLD) || (highlight_mask & HL_ITALIC)))
2448 	return FAIL;
2449 
2450 #if defined(FEAT_GUI_GTK)
2451     // If there's no italic font, then fake it.
2452     // For GTK2, we don't need a different font for italic style.
2453     if (hl_mask_todo & HL_ITALIC)
2454 	draw_flags |= DRAW_ITALIC;
2455 
2456     // Do we underline the text?
2457     if (hl_mask_todo & HL_UNDERLINE)
2458 	draw_flags |= DRAW_UNDERL;
2459 
2460 #else
2461     // Do we underline the text?
2462     if ((hl_mask_todo & HL_UNDERLINE) || (hl_mask_todo & HL_ITALIC))
2463 	draw_flags |= DRAW_UNDERL;
2464 #endif
2465     // Do we undercurl the text?
2466     if (hl_mask_todo & HL_UNDERCURL)
2467 	draw_flags |= DRAW_UNDERC;
2468 
2469     // Do we strikethrough the text?
2470     if (hl_mask_todo & HL_STRIKETHROUGH)
2471 	draw_flags |= DRAW_STRIKE;
2472 
2473     // Do we draw transparently?
2474     if (flags & GUI_MON_TRS_CURSOR)
2475 	draw_flags |= DRAW_TRANSP;
2476 
2477     /*
2478      * Draw the text.
2479      */
2480 #ifdef FEAT_GUI_GTK
2481     // The value returned is the length in display cells
2482     len = gui_gtk2_draw_string(gui.row, col, s, len, draw_flags);
2483 #else
2484     if (enc_utf8)
2485     {
2486 	int	start;		// index of bytes to be drawn
2487 	int	cells;		// cellwidth of bytes to be drawn
2488 	int	thislen;	// length of bytes to be drawn
2489 	int	cn;		// cellwidth of current char
2490 	int	i;		// index of current char
2491 	int	c;		// current char value
2492 	int	cl;		// byte length of current char
2493 	int	comping;	// current char is composing
2494 	int	scol = col;	// screen column
2495 	int	curr_wide = FALSE;  // use 'guifontwide'
2496 	int	prev_wide = FALSE;
2497 	int	wide_changed;
2498 # ifdef MSWIN
2499 	int	sep_comp = FALSE;   // Don't separate composing chars.
2500 # else
2501 	int	sep_comp = TRUE;    // Separate composing chars.
2502 # endif
2503 
2504 	// Break the string at a composing character, it has to be drawn on
2505 	// top of the previous character.
2506 	start = 0;
2507 	cells = 0;
2508 	for (i = 0; i < len; i += cl)
2509 	{
2510 	    c = utf_ptr2char(s + i);
2511 	    cn = utf_char2cells(c);
2512 	    comping = utf_iscomposing(c);
2513 	    if (!comping)	// count cells from non-composing chars
2514 		cells += cn;
2515 	    if (!comping || sep_comp)
2516 	    {
2517 		if (cn > 1
2518 # ifdef FEAT_XFONTSET
2519 			&& fontset == NOFONTSET
2520 # endif
2521 			&& wide_font != NOFONT)
2522 		    curr_wide = TRUE;
2523 		else
2524 		    curr_wide = FALSE;
2525 	    }
2526 	    cl = utf_ptr2len(s + i);
2527 	    if (cl == 0)	// hit end of string
2528 		len = i + cl;	// len must be wrong "cannot happen"
2529 
2530 	    wide_changed = curr_wide != prev_wide;
2531 
2532 	    // Print the string so far if it's the last character or there is
2533 	    // a composing character.
2534 	    if (i + cl >= len || (comping && sep_comp && i > start)
2535 		    || wide_changed
2536 # if defined(FEAT_GUI_X11)
2537 		    || (cn > 1
2538 #  ifdef FEAT_XFONTSET
2539 			// No fontset: At least draw char after wide char at
2540 			// right position.
2541 			&& fontset == NOFONTSET
2542 #  endif
2543 		       )
2544 # endif
2545 	       )
2546 	    {
2547 		if ((comping && sep_comp) || wide_changed)
2548 		    thislen = i - start;
2549 		else
2550 		    thislen = i - start + cl;
2551 		if (thislen > 0)
2552 		{
2553 		    if (prev_wide)
2554 			gui_mch_set_font(wide_font);
2555 		    gui_mch_draw_string(gui.row, scol, s + start, thislen,
2556 								  draw_flags);
2557 		    if (prev_wide)
2558 			gui_mch_set_font(font);
2559 		    start += thislen;
2560 		}
2561 		scol += cells;
2562 		cells = 0;
2563 		// Adjust to not draw a character which width is changed
2564 		// against with last one.
2565 		if (wide_changed && !(comping && sep_comp))
2566 		{
2567 		    scol -= cn;
2568 		    cl = 0;
2569 		}
2570 
2571 # if defined(FEAT_GUI_X11)
2572 		// No fontset: draw a space to fill the gap after a wide char
2573 		//
2574 		if (cn > 1 && (draw_flags & DRAW_TRANSP) == 0
2575 #  ifdef FEAT_XFONTSET
2576 			&& fontset == NOFONTSET
2577 #  endif
2578 			&& !wide_changed)
2579 		    gui_mch_draw_string(gui.row, scol - 1, (char_u *)" ",
2580 							       1, draw_flags);
2581 # endif
2582 	    }
2583 	    // Draw a composing char on top of the previous char.
2584 	    if (comping && sep_comp)
2585 	    {
2586 # if defined(__APPLE_CC__) && TARGET_API_MAC_CARBON
2587 		// Carbon ATSUI autodraws composing char over previous char
2588 		gui_mch_draw_string(gui.row, scol, s + i, cl,
2589 						    draw_flags | DRAW_TRANSP);
2590 # else
2591 		gui_mch_draw_string(gui.row, scol - cn, s + i, cl,
2592 						    draw_flags | DRAW_TRANSP);
2593 # endif
2594 		start = i + cl;
2595 	    }
2596 	    prev_wide = curr_wide;
2597 	}
2598 	// The stuff below assumes "len" is the length in screen columns.
2599 	len = scol - col;
2600     }
2601     else
2602     {
2603 	gui_mch_draw_string(gui.row, col, s, len, draw_flags);
2604 	if (enc_dbcs == DBCS_JPNU)
2605 	{
2606 	    // Get the length in display cells, this can be different from the
2607 	    // number of bytes for "euc-jp".
2608 	    len = mb_string2cells(s, len);
2609 	}
2610     }
2611 #endif // !FEAT_GUI_GTK
2612 
2613     if (!(flags & (GUI_MON_IS_CURSOR | GUI_MON_TRS_CURSOR)))
2614 	gui.col = col + len;
2615 
2616     // May need to invert it when it's part of the selection.
2617     if (flags & GUI_MON_NOCLEAR)
2618 	clip_may_redraw_selection(gui.row, col, len);
2619 
2620     if (!(flags & (GUI_MON_IS_CURSOR | GUI_MON_TRS_CURSOR)))
2621     {
2622 	// Invalidate the old physical cursor position if we wrote over it
2623 	if (gui.cursor_row == gui.row
2624 		&& gui.cursor_col >= col
2625 		&& gui.cursor_col < col + len)
2626 	    gui.cursor_is_valid = FALSE;
2627     }
2628 
2629 #ifdef FEAT_SIGN_ICONS
2630     if (draw_sign)
2631 	// Draw the sign on top of the spaces.
2632 	gui_mch_drawsign(gui.row, signcol, gui.highlight_mask);
2633 # if defined(FEAT_NETBEANS_INTG) && (defined(FEAT_GUI_X11) \
2634 	|| defined(FEAT_GUI_GTK) || defined(FEAT_GUI_MSWIN))
2635     if (multi_sign)
2636 	netbeans_draw_multisign_indicator(gui.row);
2637 # endif
2638 #endif
2639 
2640     return OK;
2641 }
2642 
2643 /*
2644  * Un-draw the cursor.	Actually this just redraws the character at the given
2645  * position.
2646  */
2647     void
2648 gui_undraw_cursor(void)
2649 {
2650     if (gui.cursor_is_valid)
2651     {
2652 	// Redraw the character just before too, if there is one, because with
2653 	// some fonts and characters there can be a one pixel overlap.
2654 	gui_redraw_block(gui.cursor_row,
2655 		      gui.cursor_col > 0 ? gui.cursor_col - 1 : gui.cursor_col,
2656 		      gui.cursor_row, gui.cursor_col, GUI_MON_NOCLEAR);
2657 
2658 	// Cursor_is_valid is reset when the cursor is undrawn, also reset it
2659 	// here in case it wasn't needed to undraw it.
2660 	gui.cursor_is_valid = FALSE;
2661     }
2662 }
2663 
2664     void
2665 gui_redraw(
2666     int		x,
2667     int		y,
2668     int		w,
2669     int		h)
2670 {
2671     int		row1, col1, row2, col2;
2672 
2673     row1 = Y_2_ROW(y);
2674     col1 = X_2_COL(x);
2675     row2 = Y_2_ROW(y + h - 1);
2676     col2 = X_2_COL(x + w - 1);
2677 
2678     gui_redraw_block(row1, col1, row2, col2, GUI_MON_NOCLEAR);
2679 
2680     /*
2681      * We may need to redraw the cursor, but don't take it upon us to change
2682      * its location after a scroll.
2683      * (maybe be more strict even and test col too?)
2684      * These things may be outside the update/clipping region and reality may
2685      * not reflect Vims internal ideas if these operations are clipped away.
2686      */
2687     if (gui.row == gui.cursor_row)
2688 	gui_update_cursor(TRUE, TRUE);
2689 }
2690 
2691 /*
2692  * Draw a rectangular block of characters, from row1 to row2 (inclusive) and
2693  * from col1 to col2 (inclusive).
2694  */
2695     void
2696 gui_redraw_block(
2697     int		row1,
2698     int		col1,
2699     int		row2,
2700     int		col2,
2701     int		flags)	// flags for gui_outstr_nowrap()
2702 {
2703     int		old_row, old_col;
2704     long_u	old_hl_mask;
2705     int		off;
2706     sattr_T	first_attr;
2707     int		idx, len;
2708     int		back, nback;
2709     int		orig_col1, orig_col2;
2710 
2711     // Don't try to update when ScreenLines is not valid
2712     if (!screen_cleared || ScreenLines == NULL)
2713 	return;
2714 
2715     // Don't try to draw outside the shell!
2716     // Check everything, strange values may be caused by a big border width
2717     col1 = check_col(col1);
2718     col2 = check_col(col2);
2719     row1 = check_row(row1);
2720     row2 = check_row(row2);
2721 
2722     // Remember where our cursor was
2723     old_row = gui.row;
2724     old_col = gui.col;
2725     old_hl_mask = gui.highlight_mask;
2726     orig_col1 = col1;
2727     orig_col2 = col2;
2728 
2729     for (gui.row = row1; gui.row <= row2; gui.row++)
2730     {
2731 	// When only half of a double-wide character is in the block, include
2732 	// the other half.
2733 	col1 = orig_col1;
2734 	col2 = orig_col2;
2735 	off = LineOffset[gui.row];
2736 	if (enc_dbcs != 0)
2737 	{
2738 	    if (col1 > 0)
2739 		col1 -= dbcs_screen_head_off(ScreenLines + off,
2740 						    ScreenLines + off + col1);
2741 	    col2 += dbcs_screen_tail_off(ScreenLines + off,
2742 						    ScreenLines + off + col2);
2743 	}
2744 	else if (enc_utf8)
2745 	{
2746 	    if (ScreenLines[off + col1] == 0)
2747 	    {
2748 		if (col1 > 0)
2749 		    --col1;
2750 		else
2751 		{
2752 		    // FIXME: how can the first character ever be zero?
2753 		    // Make this IEMSGN when it no longer breaks Travis CI.
2754 		    vim_snprintf((char *)IObuff, IOSIZE,
2755 			    "INTERNAL ERROR: NUL in ScreenLines in row %ld",
2756 			    (long)gui.row);
2757 		    msg((char *)IObuff);
2758 		}
2759 	    }
2760 #ifdef FEAT_GUI_GTK
2761 	    if (col2 + 1 < Columns && ScreenLines[off + col2 + 1] == 0)
2762 		++col2;
2763 #endif
2764 	}
2765 	gui.col = col1;
2766 	off = LineOffset[gui.row] + gui.col;
2767 	len = col2 - col1 + 1;
2768 
2769 	// Find how many chars back this highlighting starts, or where a space
2770 	// is.  Needed for when the bold trick is used
2771 	for (back = 0; back < col1; ++back)
2772 	    if (ScreenAttrs[off - 1 - back] != ScreenAttrs[off]
2773 		    || ScreenLines[off - 1 - back] == ' ')
2774 		break;
2775 
2776 	// Break it up in strings of characters with the same attributes.
2777 	// Print UTF-8 characters individually.
2778 	while (len > 0)
2779 	{
2780 	    first_attr = ScreenAttrs[off];
2781 	    gui.highlight_mask = first_attr;
2782 #if !defined(FEAT_GUI_GTK)
2783 	    if (enc_utf8 && ScreenLinesUC[off] != 0)
2784 	    {
2785 		// output multi-byte character separately
2786 		nback = gui_screenchar(off, flags,
2787 					  (guicolor_T)0, (guicolor_T)0, back);
2788 		if (gui.col < Columns && ScreenLines[off + 1] == 0)
2789 		    idx = 2;
2790 		else
2791 		    idx = 1;
2792 	    }
2793 	    else if (enc_dbcs == DBCS_JPNU && ScreenLines[off] == 0x8e)
2794 	    {
2795 		// output double-byte, single-width character separately
2796 		nback = gui_screenchar(off, flags,
2797 					  (guicolor_T)0, (guicolor_T)0, back);
2798 		idx = 1;
2799 	    }
2800 	    else
2801 #endif
2802 	    {
2803 #ifdef FEAT_GUI_GTK
2804 		for (idx = 0; idx < len; ++idx)
2805 		{
2806 		    if (enc_utf8 && ScreenLines[off + idx] == 0)
2807 			continue; // skip second half of double-width char
2808 		    if (ScreenAttrs[off + idx] != first_attr)
2809 			break;
2810 		}
2811 		// gui_screenstr() takes care of multibyte chars
2812 		nback = gui_screenstr(off, idx, flags,
2813 				      (guicolor_T)0, (guicolor_T)0, back);
2814 #else
2815 		for (idx = 0; idx < len && ScreenAttrs[off + idx] == first_attr;
2816 									idx++)
2817 		{
2818 		    // Stop at a multi-byte Unicode character.
2819 		    if (enc_utf8 && ScreenLinesUC[off + idx] != 0)
2820 			break;
2821 		    if (enc_dbcs == DBCS_JPNU)
2822 		    {
2823 			// Stop at a double-byte single-width char.
2824 			if (ScreenLines[off + idx] == 0x8e)
2825 			    break;
2826 			if (len > 1 && (*mb_ptr2len)(ScreenLines
2827 							    + off + idx) == 2)
2828 			    ++idx;  // skip second byte of double-byte char
2829 		    }
2830 		}
2831 		nback = gui_outstr_nowrap(ScreenLines + off, idx, flags,
2832 					  (guicolor_T)0, (guicolor_T)0, back);
2833 #endif
2834 	    }
2835 	    if (nback == FAIL)
2836 	    {
2837 		// Must back up to start drawing where a bold or italic word
2838 		// starts.
2839 		off -= back;
2840 		len += back;
2841 		gui.col -= back;
2842 	    }
2843 	    else
2844 	    {
2845 		off += idx;
2846 		len -= idx;
2847 	    }
2848 	    back = 0;
2849 	}
2850     }
2851 
2852     // Put the cursor back where it was
2853     gui.row = old_row;
2854     gui.col = old_col;
2855     gui.highlight_mask = (int)old_hl_mask;
2856 }
2857 
2858     static void
2859 gui_delete_lines(int row, int count)
2860 {
2861     if (count <= 0)
2862 	return;
2863 
2864     if (row + count > gui.scroll_region_bot)
2865 	// Scrolled out of region, just blank the lines out
2866 	gui_clear_block(row, gui.scroll_region_left,
2867 			      gui.scroll_region_bot, gui.scroll_region_right);
2868     else
2869     {
2870 	gui_mch_delete_lines(row, count);
2871 
2872 	// If the cursor was in the deleted lines it's now gone.  If the
2873 	// cursor was in the scrolled lines adjust its position.
2874 	if (gui.cursor_row >= row
2875 		&& gui.cursor_col >= gui.scroll_region_left
2876 		&& gui.cursor_col <= gui.scroll_region_right)
2877 	{
2878 	    if (gui.cursor_row < row + count)
2879 		gui.cursor_is_valid = FALSE;
2880 	    else if (gui.cursor_row <= gui.scroll_region_bot)
2881 		gui.cursor_row -= count;
2882 	}
2883     }
2884 }
2885 
2886     static void
2887 gui_insert_lines(int row, int count)
2888 {
2889     if (count <= 0)
2890 	return;
2891 
2892     if (row + count > gui.scroll_region_bot)
2893 	// Scrolled out of region, just blank the lines out
2894 	gui_clear_block(row, gui.scroll_region_left,
2895 			      gui.scroll_region_bot, gui.scroll_region_right);
2896     else
2897     {
2898 	gui_mch_insert_lines(row, count);
2899 
2900 	if (gui.cursor_row >= gui.row
2901 		&& gui.cursor_col >= gui.scroll_region_left
2902 		&& gui.cursor_col <= gui.scroll_region_right)
2903 	{
2904 	    if (gui.cursor_row <= gui.scroll_region_bot - count)
2905 		gui.cursor_row += count;
2906 	    else if (gui.cursor_row <= gui.scroll_region_bot)
2907 		gui.cursor_is_valid = FALSE;
2908 	}
2909     }
2910 }
2911 
2912 #ifdef FEAT_TIMERS
2913 /*
2914  * Passed to ui_wait_for_chars_or_timer(), ignoring extra arguments.
2915  */
2916     static int
2917 gui_wait_for_chars_3(
2918     long wtime,
2919     int *interrupted UNUSED,
2920     int ignore_input UNUSED)
2921 {
2922     return gui_mch_wait_for_chars(wtime);
2923 }
2924 #endif
2925 
2926 /*
2927  * Returns OK if a character was found to be available within the given time,
2928  * or FAIL otherwise.
2929  */
2930     static int
2931 gui_wait_for_chars_or_timer(
2932 	long wtime,
2933 	int *interrupted UNUSED,
2934 	int ignore_input UNUSED)
2935 {
2936 #ifdef FEAT_TIMERS
2937     return ui_wait_for_chars_or_timer(wtime, gui_wait_for_chars_3,
2938 						    interrupted, ignore_input);
2939 #else
2940     return gui_mch_wait_for_chars(wtime);
2941 #endif
2942 }
2943 
2944 /*
2945  * The main GUI input routine.	Waits for a character from the keyboard.
2946  * "wtime" == -1    Wait forever.
2947  * "wtime" == 0	    Don't wait.
2948  * "wtime" > 0	    Wait wtime milliseconds for a character.
2949  *
2950  * Returns the number of characters read or zero when timed out or interrupted.
2951  * "buf" may be NULL, in which case a non-zero number is returned if characters
2952  * are available.
2953  */
2954     static int
2955 gui_wait_for_chars_buf(
2956     char_u	*buf,
2957     int		maxlen,
2958     long	wtime,	    // don't use "time", MIPS cannot handle it
2959     int		tb_change_cnt)
2960 {
2961     int	    retval;
2962 
2963 #ifdef FEAT_MENU
2964     // If we're going to wait a bit, update the menus and mouse shape for the
2965     // current State.
2966     if (wtime != 0)
2967 	gui_update_menus(0);
2968 #endif
2969 
2970     gui_mch_update();
2971     if (input_available())	// Got char, return immediately
2972     {
2973 	if (buf != NULL && !typebuf_changed(tb_change_cnt))
2974 	    return read_from_input_buf(buf, (long)maxlen);
2975 	return 0;
2976     }
2977     if (wtime == 0)		// Don't wait for char
2978 	return FAIL;
2979 
2980     // Before waiting, flush any output to the screen.
2981     gui_mch_flush();
2982 
2983     // Blink while waiting for a character.
2984     gui_mch_start_blink();
2985 
2986     // Common function to loop until "wtime" is met, while handling timers and
2987     // other callbacks.
2988     retval = inchar_loop(buf, maxlen, wtime, tb_change_cnt,
2989 			 gui_wait_for_chars_or_timer, NULL);
2990 
2991     gui_mch_stop_blink(TRUE);
2992 
2993     return retval;
2994 }
2995 
2996 /*
2997  * Wait for a character from the keyboard without actually reading it.
2998  * Also deals with timers.
2999  * wtime == -1	    Wait forever.
3000  * wtime == 0	    Don't wait.
3001  * wtime > 0	    Wait wtime milliseconds for a character.
3002  * Returns OK if a character was found to be available within the given time,
3003  * or FAIL otherwise.
3004  */
3005     int
3006 gui_wait_for_chars(long wtime, int tb_change_cnt)
3007 {
3008     return gui_wait_for_chars_buf(NULL, 0, wtime, tb_change_cnt);
3009 }
3010 
3011 /*
3012  * Equivalent of mch_inchar() for the GUI.
3013  */
3014     int
3015 gui_inchar(
3016     char_u  *buf,
3017     int	    maxlen,
3018     long    wtime,		// milli seconds
3019     int	    tb_change_cnt)
3020 {
3021     return gui_wait_for_chars_buf(buf, maxlen, wtime, tb_change_cnt);
3022 }
3023 
3024 /*
3025  * Fill p[4] with mouse coordinates encoded for check_termcode().
3026  */
3027     static void
3028 fill_mouse_coord(char_u *p, int col, int row)
3029 {
3030     p[0] = (char_u)(col / 128 + ' ' + 1);
3031     p[1] = (char_u)(col % 128 + ' ' + 1);
3032     p[2] = (char_u)(row / 128 + ' ' + 1);
3033     p[3] = (char_u)(row % 128 + ' ' + 1);
3034 }
3035 
3036 /*
3037  * Generic mouse support function.  Add a mouse event to the input buffer with
3038  * the given properties.
3039  *  button	    --- may be any of MOUSE_LEFT, MOUSE_MIDDLE, MOUSE_RIGHT,
3040  *			MOUSE_X1, MOUSE_X2
3041  *			MOUSE_DRAG, or MOUSE_RELEASE.
3042  *			MOUSE_4 and MOUSE_5 are used for vertical scroll wheel,
3043  *			MOUSE_6 and MOUSE_7 for horizontal scroll wheel.
3044  *  x, y	    --- Coordinates of mouse in pixels.
3045  *  repeated_click  --- TRUE if this click comes only a short time after a
3046  *			previous click.
3047  *  modifiers	    --- Bit field which may be any of the following modifiers
3048  *			or'ed together: MOUSE_SHIFT | MOUSE_CTRL | MOUSE_ALT.
3049  * This function will ignore drag events where the mouse has not moved to a new
3050  * character.
3051  */
3052     void
3053 gui_send_mouse_event(
3054     int	    button,
3055     int	    x,
3056     int	    y,
3057     int	    repeated_click,
3058     int_u   modifiers)
3059 {
3060     static int	    prev_row = 0, prev_col = 0;
3061     static int	    prev_button = -1;
3062     static int	    num_clicks = 1;
3063     char_u	    string[10];
3064     enum key_extra  button_char;
3065     int		    row, col;
3066 #ifdef FEAT_CLIPBOARD
3067     int		    checkfor;
3068     int		    did_clip = FALSE;
3069 #endif
3070 
3071     /*
3072      * Scrolling may happen at any time, also while a selection is present.
3073      */
3074     switch (button)
3075     {
3076 	case MOUSE_X1:
3077 	    button_char = KE_X1MOUSE;
3078 	    goto button_set;
3079 	case MOUSE_X2:
3080 	    button_char = KE_X2MOUSE;
3081 	    goto button_set;
3082 	case MOUSE_4:
3083 	    button_char = KE_MOUSEDOWN;
3084 	    goto button_set;
3085 	case MOUSE_5:
3086 	    button_char = KE_MOUSEUP;
3087 	    goto button_set;
3088 	case MOUSE_6:
3089 	    button_char = KE_MOUSELEFT;
3090 	    goto button_set;
3091 	case MOUSE_7:
3092 	    button_char = KE_MOUSERIGHT;
3093 button_set:
3094 	    {
3095 		// Don't put events in the input queue now.
3096 		if (hold_gui_events)
3097 		    return;
3098 
3099 		string[3] = CSI;
3100 		string[4] = KS_EXTRA;
3101 		string[5] = (int)button_char;
3102 
3103 		// Pass the pointer coordinates of the scroll event so that we
3104 		// know which window to scroll.
3105 		row = gui_xy2colrow(x, y, &col);
3106 		string[6] = (char_u)(col / 128 + ' ' + 1);
3107 		string[7] = (char_u)(col % 128 + ' ' + 1);
3108 		string[8] = (char_u)(row / 128 + ' ' + 1);
3109 		string[9] = (char_u)(row % 128 + ' ' + 1);
3110 
3111 		if (modifiers == 0)
3112 		    add_to_input_buf(string + 3, 7);
3113 		else
3114 		{
3115 		    string[0] = CSI;
3116 		    string[1] = KS_MODIFIER;
3117 		    string[2] = 0;
3118 		    if (modifiers & MOUSE_SHIFT)
3119 			string[2] |= MOD_MASK_SHIFT;
3120 		    if (modifiers & MOUSE_CTRL)
3121 			string[2] |= MOD_MASK_CTRL;
3122 		    if (modifiers & MOUSE_ALT)
3123 			string[2] |= MOD_MASK_ALT;
3124 		    add_to_input_buf(string, 10);
3125 		}
3126 		return;
3127 	    }
3128     }
3129 
3130 #ifdef FEAT_CLIPBOARD
3131     // If a clipboard selection is in progress, handle it
3132     if (clip_star.state == SELECT_IN_PROGRESS)
3133     {
3134 	clip_process_selection(button, X_2_COL(x), Y_2_ROW(y), repeated_click);
3135 
3136 	// A release event may still need to be sent if the position is equal.
3137 	row = gui_xy2colrow(x, y, &col);
3138 	if (button != MOUSE_RELEASE || row != prev_row || col != prev_col)
3139 	    return;
3140     }
3141 
3142     // Determine which mouse settings to look for based on the current mode
3143     switch (get_real_state())
3144     {
3145 	case NORMAL_BUSY:
3146 	case OP_PENDING:
3147 # ifdef FEAT_TERMINAL
3148 	case TERMINAL:
3149 # endif
3150 	case NORMAL:		checkfor = MOUSE_NORMAL;	break;
3151 	case VISUAL:		checkfor = MOUSE_VISUAL;	break;
3152 	case SELECTMODE:	checkfor = MOUSE_VISUAL;	break;
3153 	case REPLACE:
3154 	case REPLACE+LANGMAP:
3155 	case VREPLACE:
3156 	case VREPLACE+LANGMAP:
3157 	case INSERT:
3158 	case INSERT+LANGMAP:	checkfor = MOUSE_INSERT;	break;
3159 	case ASKMORE:
3160 	case HITRETURN:		// At the more- and hit-enter prompt pass the
3161 				// mouse event for a click on or below the
3162 				// message line.
3163 				if (Y_2_ROW(y) >= msg_row)
3164 				    checkfor = MOUSE_NORMAL;
3165 				else
3166 				    checkfor = MOUSE_RETURN;
3167 				break;
3168 
3169 	    /*
3170 	     * On the command line, use the clipboard selection on all lines
3171 	     * but the command line.  But not when pasting.
3172 	     */
3173 	case CMDLINE:
3174 	case CMDLINE+LANGMAP:
3175 	    if (Y_2_ROW(y) < cmdline_row && button != MOUSE_MIDDLE)
3176 		checkfor = MOUSE_NONE;
3177 	    else
3178 		checkfor = MOUSE_COMMAND;
3179 	    break;
3180 
3181 	default:
3182 	    checkfor = MOUSE_NONE;
3183 	    break;
3184     };
3185 
3186     /*
3187      * Allow clipboard selection of text on the command line in "normal"
3188      * modes.  Don't do this when dragging the status line, or extending a
3189      * Visual selection.
3190      */
3191     if ((State == NORMAL || State == NORMAL_BUSY || (State & INSERT))
3192 	    && Y_2_ROW(y) >= topframe->fr_height + firstwin->w_winrow
3193 	    && button != MOUSE_DRAG
3194 # ifdef FEAT_MOUSESHAPE
3195 	    && !drag_status_line
3196 	    && !drag_sep_line
3197 # endif
3198 	    )
3199 	checkfor = MOUSE_NONE;
3200 
3201     /*
3202      * Use modeless selection when holding CTRL and SHIFT pressed.
3203      */
3204     if ((modifiers & MOUSE_CTRL) && (modifiers & MOUSE_SHIFT))
3205 	checkfor = MOUSE_NONEF;
3206 
3207     /*
3208      * In Ex mode, always use modeless selection.
3209      */
3210     if (exmode_active)
3211 	checkfor = MOUSE_NONE;
3212 
3213     /*
3214      * If the mouse settings say to not use the mouse, use the modeless
3215      * selection.  But if Visual is active, assume that only the Visual area
3216      * will be selected.
3217      * Exception: On the command line, both the selection is used and a mouse
3218      * key is send.
3219      */
3220     if (!mouse_has(checkfor) || checkfor == MOUSE_COMMAND)
3221     {
3222 	// Don't do modeless selection in Visual mode.
3223 	if (checkfor != MOUSE_NONEF && VIsual_active && (State & NORMAL))
3224 	    return;
3225 
3226 	/*
3227 	 * When 'mousemodel' is "popup", shift-left is translated to right.
3228 	 * But not when also using Ctrl.
3229 	 */
3230 	if (mouse_model_popup() && button == MOUSE_LEFT
3231 		&& (modifiers & MOUSE_SHIFT) && !(modifiers & MOUSE_CTRL))
3232 	{
3233 	    button = MOUSE_RIGHT;
3234 	    modifiers &= ~ MOUSE_SHIFT;
3235 	}
3236 
3237 	// If the selection is done, allow the right button to extend it.
3238 	// If the selection is cleared, allow the right button to start it
3239 	// from the cursor position.
3240 	if (button == MOUSE_RIGHT)
3241 	{
3242 	    if (clip_star.state == SELECT_CLEARED)
3243 	    {
3244 		if (State & CMDLINE)
3245 		{
3246 		    col = msg_col;
3247 		    row = msg_row;
3248 		}
3249 		else
3250 		{
3251 		    col = curwin->w_wcol;
3252 		    row = curwin->w_wrow + W_WINROW(curwin);
3253 		}
3254 		clip_start_selection(col, row, FALSE);
3255 	    }
3256 	    clip_process_selection(button, X_2_COL(x), Y_2_ROW(y),
3257 							      repeated_click);
3258 	    did_clip = TRUE;
3259 	}
3260 	// Allow the left button to start the selection
3261 	else if (button == MOUSE_LEFT)
3262 	{
3263 	    clip_start_selection(X_2_COL(x), Y_2_ROW(y), repeated_click);
3264 	    did_clip = TRUE;
3265 	}
3266 
3267 	// Always allow pasting
3268 	if (button != MOUSE_MIDDLE)
3269 	{
3270 	    if (!mouse_has(checkfor) || button == MOUSE_RELEASE)
3271 		return;
3272 	    if (checkfor != MOUSE_COMMAND)
3273 		button = MOUSE_LEFT;
3274 	}
3275 	repeated_click = FALSE;
3276     }
3277 
3278     if (clip_star.state != SELECT_CLEARED && !did_clip)
3279 	clip_clear_selection(&clip_star);
3280 #endif
3281 
3282     // Don't put events in the input queue now.
3283     if (hold_gui_events)
3284 	return;
3285 
3286     row = gui_xy2colrow(x, y, &col);
3287 
3288     /*
3289      * If we are dragging and the mouse hasn't moved far enough to be on a
3290      * different character, then don't send an event to vim.
3291      */
3292     if (button == MOUSE_DRAG)
3293     {
3294 	if (row == prev_row && col == prev_col)
3295 	    return;
3296 	// Dragging above the window, set "row" to -1 to cause a scroll.
3297 	if (y < 0)
3298 	    row = -1;
3299     }
3300 
3301     /*
3302      * If topline has changed (window scrolled) since the last click, reset
3303      * repeated_click, because we don't want starting Visual mode when
3304      * clicking on a different character in the text.
3305      */
3306     if (curwin->w_topline != gui_prev_topline
3307 #ifdef FEAT_DIFF
3308 	    || curwin->w_topfill != gui_prev_topfill
3309 #endif
3310 	    )
3311 	repeated_click = FALSE;
3312 
3313     string[0] = CSI;	// this sequence is recognized by check_termcode()
3314     string[1] = KS_MOUSE;
3315     string[2] = KE_FILLER;
3316     if (button != MOUSE_DRAG && button != MOUSE_RELEASE)
3317     {
3318 	if (repeated_click)
3319 	{
3320 	    /*
3321 	     * Handle multiple clicks.	They only count if the mouse is still
3322 	     * pointing at the same character.
3323 	     */
3324 	    if (button != prev_button || row != prev_row || col != prev_col)
3325 		num_clicks = 1;
3326 	    else if (++num_clicks > 4)
3327 		num_clicks = 1;
3328 	}
3329 	else
3330 	    num_clicks = 1;
3331 	prev_button = button;
3332 	gui_prev_topline = curwin->w_topline;
3333 #ifdef FEAT_DIFF
3334 	gui_prev_topfill = curwin->w_topfill;
3335 #endif
3336 
3337 	string[3] = (char_u)(button | 0x20);
3338 	SET_NUM_MOUSE_CLICKS(string[3], num_clicks);
3339     }
3340     else
3341 	string[3] = (char_u)button;
3342 
3343     string[3] |= modifiers;
3344     fill_mouse_coord(string + 4, col, row);
3345     add_to_input_buf(string, 8);
3346 
3347     if (row < 0)
3348 	prev_row = 0;
3349     else
3350 	prev_row = row;
3351     prev_col = col;
3352 
3353     /*
3354      * We need to make sure this is cleared since Athena doesn't tell us when
3355      * he is done dragging.  Neither does GTK+ 2 -- at least for now.
3356      */
3357 #if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_GTK)
3358     gui.dragged_sb = SBAR_NONE;
3359 #endif
3360 }
3361 
3362 /*
3363  * Convert x and y coordinate to column and row in text window.
3364  * Corrects for multi-byte character.
3365  * returns column in "*colp" and row as return value;
3366  */
3367     static int
3368 gui_xy2colrow(int x, int y, int *colp)
3369 {
3370     int		col = check_col(X_2_COL(x));
3371     int		row = check_row(Y_2_ROW(y));
3372 
3373     *colp = mb_fix_col(col, row);
3374     return row;
3375 }
3376 
3377 #if defined(FEAT_MENU) || defined(PROTO)
3378 /*
3379  * Callback function for when a menu entry has been selected.
3380  */
3381     void
3382 gui_menu_cb(vimmenu_T *menu)
3383 {
3384     char_u  bytes[sizeof(long_u)];
3385 
3386     // Don't put events in the input queue now.
3387     if (hold_gui_events)
3388 	return;
3389 
3390     bytes[0] = CSI;
3391     bytes[1] = KS_MENU;
3392     bytes[2] = KE_FILLER;
3393     add_to_input_buf(bytes, 3);
3394     add_long_to_buf((long_u)menu, bytes);
3395     add_to_input_buf_csi(bytes, sizeof(long_u));
3396 }
3397 #endif
3398 
3399 static int	prev_which_scrollbars[3];
3400 
3401 /*
3402  * Set which components are present.
3403  * If "oldval" is not NULL, "oldval" is the previous value, the new value is
3404  * in p_go.
3405  */
3406     void
3407 gui_init_which_components(char_u *oldval UNUSED)
3408 {
3409 #ifdef FEAT_GUI_DARKTHEME
3410     static int	prev_dark_theme = -1;
3411     int		using_dark_theme = FALSE;
3412 #endif
3413 #ifdef FEAT_MENU
3414     static int	prev_menu_is_active = -1;
3415 #endif
3416 #ifdef FEAT_TOOLBAR
3417     static int	prev_toolbar = -1;
3418     int		using_toolbar = FALSE;
3419 #endif
3420 #ifdef FEAT_GUI_TABLINE
3421     int		using_tabline;
3422 #endif
3423 #ifdef FEAT_FOOTER
3424     static int	prev_footer = -1;
3425     int		using_footer = FALSE;
3426 #endif
3427 #if defined(FEAT_MENU)
3428     static int	prev_tearoff = -1;
3429     int		using_tearoff = FALSE;
3430 #endif
3431 
3432     char_u	*p;
3433     int		i;
3434 #ifdef FEAT_MENU
3435     int		grey_old, grey_new;
3436     char_u	*temp;
3437 #endif
3438     win_T	*wp;
3439     int		need_set_size;
3440     int		fix_size;
3441 
3442 #ifdef FEAT_MENU
3443     if (oldval != NULL && gui.in_use)
3444     {
3445 	/*
3446 	 * Check if the menus go from grey to non-grey or vice versa.
3447 	 */
3448 	grey_old = (vim_strchr(oldval, GO_GREY) != NULL);
3449 	grey_new = (vim_strchr(p_go, GO_GREY) != NULL);
3450 	if (grey_old != grey_new)
3451 	{
3452 	    temp = p_go;
3453 	    p_go = oldval;
3454 	    gui_update_menus(MENU_ALL_MODES);
3455 	    p_go = temp;
3456 	}
3457     }
3458     gui.menu_is_active = FALSE;
3459 #endif
3460 
3461     for (i = 0; i < 3; i++)
3462 	gui.which_scrollbars[i] = FALSE;
3463     for (p = p_go; *p; p++)
3464 	switch (*p)
3465 	{
3466 	    case GO_LEFT:
3467 		gui.which_scrollbars[SBAR_LEFT] = TRUE;
3468 		break;
3469 	    case GO_RIGHT:
3470 		gui.which_scrollbars[SBAR_RIGHT] = TRUE;
3471 		break;
3472 	    case GO_VLEFT:
3473 		if (win_hasvertsplit())
3474 		    gui.which_scrollbars[SBAR_LEFT] = TRUE;
3475 		break;
3476 	    case GO_VRIGHT:
3477 		if (win_hasvertsplit())
3478 		    gui.which_scrollbars[SBAR_RIGHT] = TRUE;
3479 		break;
3480 	    case GO_BOT:
3481 		gui.which_scrollbars[SBAR_BOTTOM] = TRUE;
3482 		break;
3483 #ifdef FEAT_GUI_DARKTHEME
3484 	    case GO_DARKTHEME:
3485 		using_dark_theme = TRUE;
3486 		break;
3487 #endif
3488 #ifdef FEAT_MENU
3489 	    case GO_MENUS:
3490 		gui.menu_is_active = TRUE;
3491 		break;
3492 #endif
3493 	    case GO_GREY:
3494 		// make menu's have grey items, ignored here
3495 		break;
3496 #ifdef FEAT_TOOLBAR
3497 	    case GO_TOOLBAR:
3498 		using_toolbar = TRUE;
3499 		break;
3500 #endif
3501 #ifdef FEAT_FOOTER
3502 	    case GO_FOOTER:
3503 		using_footer = TRUE;
3504 		break;
3505 #endif
3506 	    case GO_TEAROFF:
3507 #if defined(FEAT_MENU)
3508 		using_tearoff = TRUE;
3509 #endif
3510 		break;
3511 	    default:
3512 		// Ignore options that are not supported
3513 		break;
3514 	}
3515 
3516     if (gui.in_use)
3517     {
3518 	need_set_size = 0;
3519 	fix_size = FALSE;
3520 
3521 #ifdef FEAT_GUI_DARKTHEME
3522 	if (using_dark_theme != prev_dark_theme)
3523 	{
3524 	    gui_mch_set_dark_theme(using_dark_theme);
3525 	    prev_dark_theme = using_dark_theme;
3526 	}
3527 #endif
3528 
3529 #ifdef FEAT_GUI_TABLINE
3530 	// Update the GUI tab line, it may appear or disappear.  This may
3531 	// cause the non-GUI tab line to disappear or appear.
3532 	using_tabline = gui_has_tabline();
3533 	if (!gui_mch_showing_tabline() != !using_tabline)
3534 	{
3535 	    // We don't want a resize event change "Rows" here, save and
3536 	    // restore it.  Resizing is handled below.
3537 	    i = Rows;
3538 	    gui_update_tabline();
3539 	    Rows = i;
3540 	    need_set_size |= RESIZE_VERT;
3541 	    if (using_tabline)
3542 		fix_size = TRUE;
3543 	    if (!gui_use_tabline())
3544 		redraw_tabline = TRUE;    // may draw non-GUI tab line
3545 	}
3546 #endif
3547 
3548 	for (i = 0; i < 3; i++)
3549 	{
3550 	    // The scrollbar needs to be updated when it is shown/unshown and
3551 	    // when switching tab pages.  But the size only changes when it's
3552 	    // shown/unshown.  Thus we need two places to remember whether a
3553 	    // scrollbar is there or not.
3554 	    if (gui.which_scrollbars[i] != prev_which_scrollbars[i]
3555 		    || gui.which_scrollbars[i]
3556 					!= curtab->tp_prev_which_scrollbars[i])
3557 	    {
3558 		if (i == SBAR_BOTTOM)
3559 		    gui_mch_enable_scrollbar(&gui.bottom_sbar,
3560 						     gui.which_scrollbars[i]);
3561 		else
3562 		{
3563 		    FOR_ALL_WINDOWS(wp)
3564 			gui_do_scrollbar(wp, i, gui.which_scrollbars[i]);
3565 		}
3566 		if (gui.which_scrollbars[i] != prev_which_scrollbars[i])
3567 		{
3568 		    if (i == SBAR_BOTTOM)
3569 			need_set_size |= RESIZE_VERT;
3570 		    else
3571 			need_set_size |= RESIZE_HOR;
3572 		    if (gui.which_scrollbars[i])
3573 			fix_size = TRUE;
3574 		}
3575 	    }
3576 	    curtab->tp_prev_which_scrollbars[i] = gui.which_scrollbars[i];
3577 	    prev_which_scrollbars[i] = gui.which_scrollbars[i];
3578 	}
3579 
3580 #ifdef FEAT_MENU
3581 	if (gui.menu_is_active != prev_menu_is_active)
3582 	{
3583 	    // We don't want a resize event change "Rows" here, save and
3584 	    // restore it.  Resizing is handled below.
3585 	    i = Rows;
3586 	    gui_mch_enable_menu(gui.menu_is_active);
3587 	    Rows = i;
3588 	    prev_menu_is_active = gui.menu_is_active;
3589 	    need_set_size |= RESIZE_VERT;
3590 	    if (gui.menu_is_active)
3591 		fix_size = TRUE;
3592 	}
3593 #endif
3594 
3595 #ifdef FEAT_TOOLBAR
3596 	if (using_toolbar != prev_toolbar)
3597 	{
3598 	    gui_mch_show_toolbar(using_toolbar);
3599 	    prev_toolbar = using_toolbar;
3600 	    need_set_size |= RESIZE_VERT;
3601 	    if (using_toolbar)
3602 		fix_size = TRUE;
3603 	}
3604 #endif
3605 #ifdef FEAT_FOOTER
3606 	if (using_footer != prev_footer)
3607 	{
3608 	    gui_mch_enable_footer(using_footer);
3609 	    prev_footer = using_footer;
3610 	    need_set_size |= RESIZE_VERT;
3611 	    if (using_footer)
3612 		fix_size = TRUE;
3613 	}
3614 #endif
3615 #if defined(FEAT_MENU) && !(defined(MSWIN) && !defined(FEAT_TEAROFF))
3616 	if (using_tearoff != prev_tearoff)
3617 	{
3618 	    gui_mch_toggle_tearoffs(using_tearoff);
3619 	    prev_tearoff = using_tearoff;
3620 	}
3621 #endif
3622 	if (need_set_size != 0)
3623 	{
3624 #ifdef FEAT_GUI_GTK
3625 	    long    prev_Columns = Columns;
3626 	    long    prev_Rows = Rows;
3627 #endif
3628 	    // Adjust the size of the window to make the text area keep the
3629 	    // same size and to avoid that part of our window is off-screen
3630 	    // and a scrollbar can't be used, for example.
3631 	    gui_set_shellsize(FALSE, fix_size, need_set_size);
3632 
3633 #ifdef FEAT_GUI_GTK
3634 	    // GTK has the annoying habit of sending us resize events when
3635 	    // changing the window size ourselves.  This mostly happens when
3636 	    // waiting for a character to arrive, quite unpredictably, and may
3637 	    // change Columns and Rows when we don't want it.  Wait for a
3638 	    // character here to avoid this effect.
3639 	    // If you remove this, please test this command for resizing
3640 	    // effects (with optional left scrollbar): ":vsp|q|vsp|q|vsp|q".
3641 	    // Don't do this while starting up though.
3642 	    // Don't change Rows when adding menu/toolbar/tabline.
3643 	    // Don't change Columns when adding vertical toolbar.
3644 	    if (!gui.starting && need_set_size != (RESIZE_VERT | RESIZE_HOR))
3645 		(void)char_avail();
3646 	    if ((need_set_size & RESIZE_VERT) == 0)
3647 		Rows = prev_Rows;
3648 	    if ((need_set_size & RESIZE_HOR) == 0)
3649 		Columns = prev_Columns;
3650 #endif
3651 	}
3652 	// When the console tabline appears or disappears the window positions
3653 	// change.
3654 	if (firstwin->w_winrow != tabline_height())
3655 	    shell_new_rows();	// recompute window positions and heights
3656     }
3657 }
3658 
3659 #if defined(FEAT_GUI_TABLINE) || defined(PROTO)
3660 /*
3661  * Return TRUE if the GUI is taking care of the tabline.
3662  * It may still be hidden if 'showtabline' is zero.
3663  */
3664     int
3665 gui_use_tabline(void)
3666 {
3667     return gui.in_use && vim_strchr(p_go, GO_TABLINE) != NULL;
3668 }
3669 
3670 /*
3671  * Return TRUE if the GUI is showing the tabline.
3672  * This uses 'showtabline'.
3673  */
3674     static int
3675 gui_has_tabline(void)
3676 {
3677     if (!gui_use_tabline()
3678 	    || p_stal == 0
3679 	    || (p_stal == 1 && first_tabpage->tp_next == NULL))
3680 	return FALSE;
3681     return TRUE;
3682 }
3683 
3684 /*
3685  * Update the tabline.
3686  * This may display/undisplay the tabline and update the labels.
3687  */
3688     void
3689 gui_update_tabline(void)
3690 {
3691     int	    showit = gui_has_tabline();
3692     int	    shown = gui_mch_showing_tabline();
3693 
3694     if (!gui.starting && starting == 0)
3695     {
3696 	// Updating the tabline uses direct GUI commands, flush
3697 	// outstanding instructions first. (esp. clear screen)
3698 	out_flush();
3699 
3700 	if (!showit != !shown)
3701 	    gui_mch_show_tabline(showit);
3702 	if (showit != 0)
3703 	    gui_mch_update_tabline();
3704 
3705 	// When the tabs change from hidden to shown or from shown to
3706 	// hidden the size of the text area should remain the same.
3707 	if (!showit != !shown)
3708 	    gui_set_shellsize(FALSE, showit, RESIZE_VERT);
3709     }
3710 }
3711 
3712 /*
3713  * Get the label or tooltip for tab page "tp" into NameBuff[].
3714  */
3715     void
3716 get_tabline_label(
3717     tabpage_T	*tp,
3718     int		tooltip)	// TRUE: get tooltip
3719 {
3720     int		modified = FALSE;
3721     char_u	buf[40];
3722     int		wincount;
3723     win_T	*wp;
3724     char_u	**opt;
3725 
3726     // Use 'guitablabel' or 'guitabtooltip' if it's set.
3727     opt = (tooltip ? &p_gtt : &p_gtl);
3728     if (**opt != NUL)
3729     {
3730 	int	use_sandbox = FALSE;
3731 	int	called_emsg_before = called_emsg;
3732 	char_u	res[MAXPATHL];
3733 	tabpage_T *save_curtab;
3734 	char_u	*opt_name = (char_u *)(tooltip ? "guitabtooltip"
3735 							     : "guitablabel");
3736 
3737 	printer_page_num = tabpage_index(tp);
3738 # ifdef FEAT_EVAL
3739 	set_vim_var_nr(VV_LNUM, printer_page_num);
3740 	use_sandbox = was_set_insecurely(opt_name, 0);
3741 # endif
3742 	// It's almost as going to the tabpage, but without autocommands.
3743 	curtab->tp_firstwin = firstwin;
3744 	curtab->tp_lastwin = lastwin;
3745 	curtab->tp_curwin = curwin;
3746 	save_curtab = curtab;
3747 	curtab = tp;
3748 	topframe = curtab->tp_topframe;
3749 	firstwin = curtab->tp_firstwin;
3750 	lastwin = curtab->tp_lastwin;
3751 	curwin = curtab->tp_curwin;
3752 	curbuf = curwin->w_buffer;
3753 
3754 	// Can't use NameBuff directly, build_stl_str_hl() uses it.
3755 	build_stl_str_hl(curwin, res, MAXPATHL, *opt, use_sandbox,
3756 						 0, (int)Columns, NULL, NULL);
3757 	STRCPY(NameBuff, res);
3758 
3759 	// Back to the original curtab.
3760 	curtab = save_curtab;
3761 	topframe = curtab->tp_topframe;
3762 	firstwin = curtab->tp_firstwin;
3763 	lastwin = curtab->tp_lastwin;
3764 	curwin = curtab->tp_curwin;
3765 	curbuf = curwin->w_buffer;
3766 
3767 	if (called_emsg > called_emsg_before)
3768 	    set_string_option_direct(opt_name, -1,
3769 					   (char_u *)"", OPT_FREE, SID_ERROR);
3770     }
3771 
3772     // If 'guitablabel'/'guitabtooltip' is not set or the result is empty then
3773     // use a default label.
3774     if (**opt == NUL || *NameBuff == NUL)
3775     {
3776 	// Get the buffer name into NameBuff[] and shorten it.
3777 	get_trans_bufname(tp == curtab ? curbuf : tp->tp_curwin->w_buffer);
3778 	if (!tooltip)
3779 	    shorten_dir(NameBuff);
3780 
3781 	wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
3782 	for (wincount = 0; wp != NULL; wp = wp->w_next, ++wincount)
3783 	    if (bufIsChanged(wp->w_buffer))
3784 		modified = TRUE;
3785 	if (modified || wincount > 1)
3786 	{
3787 	    if (wincount > 1)
3788 		vim_snprintf((char *)buf, sizeof(buf), "%d", wincount);
3789 	    else
3790 		buf[0] = NUL;
3791 	    if (modified)
3792 		STRCAT(buf, "+");
3793 	    STRCAT(buf, " ");
3794 	    STRMOVE(NameBuff + STRLEN(buf), NameBuff);
3795 	    mch_memmove(NameBuff, buf, STRLEN(buf));
3796 	}
3797     }
3798 }
3799 
3800 /*
3801  * Send the event for clicking to select tab page "nr".
3802  * Returns TRUE if it was done, FALSE when skipped because we are already at
3803  * that tab page or the cmdline window is open.
3804  */
3805     int
3806 send_tabline_event(int nr)
3807 {
3808     char_u string[3];
3809 
3810     if (nr == tabpage_index(curtab))
3811 	return FALSE;
3812 
3813     // Don't put events in the input queue now.
3814     if (hold_gui_events
3815 # ifdef FEAT_CMDWIN
3816 	    || cmdwin_type != 0
3817 # endif
3818 	    )
3819     {
3820 	// Set it back to the current tab page.
3821 	gui_mch_set_curtab(tabpage_index(curtab));
3822 	return FALSE;
3823     }
3824 
3825     string[0] = CSI;
3826     string[1] = KS_TABLINE;
3827     string[2] = KE_FILLER;
3828     add_to_input_buf(string, 3);
3829     string[0] = nr;
3830     add_to_input_buf_csi(string, 1);
3831     return TRUE;
3832 }
3833 
3834 /*
3835  * Send a tabline menu event
3836  */
3837     void
3838 send_tabline_menu_event(int tabidx, int event)
3839 {
3840     char_u	    string[3];
3841 
3842     // Don't put events in the input queue now.
3843     if (hold_gui_events)
3844 	return;
3845 
3846     // Cannot close the last tabpage.
3847     if (event == TABLINE_MENU_CLOSE && first_tabpage->tp_next == NULL)
3848 	return;
3849 
3850     string[0] = CSI;
3851     string[1] = KS_TABMENU;
3852     string[2] = KE_FILLER;
3853     add_to_input_buf(string, 3);
3854     string[0] = tabidx;
3855     string[1] = (char_u)(long)event;
3856     add_to_input_buf_csi(string, 2);
3857 }
3858 
3859 #endif
3860 
3861 /*
3862  * Scrollbar stuff:
3863  */
3864 
3865 /*
3866  * Remove all scrollbars.  Used before switching to another tab page.
3867  */
3868     void
3869 gui_remove_scrollbars(void)
3870 {
3871     int	    i;
3872     win_T   *wp;
3873 
3874     for (i = 0; i < 3; i++)
3875     {
3876 	if (i == SBAR_BOTTOM)
3877 	    gui_mch_enable_scrollbar(&gui.bottom_sbar, FALSE);
3878 	else
3879 	{
3880 	    FOR_ALL_WINDOWS(wp)
3881 		gui_do_scrollbar(wp, i, FALSE);
3882 	}
3883 	curtab->tp_prev_which_scrollbars[i] = -1;
3884     }
3885 }
3886 
3887     void
3888 gui_create_scrollbar(scrollbar_T *sb, int type, win_T *wp)
3889 {
3890     static int	sbar_ident = 0;
3891 
3892     sb->ident = sbar_ident++;	// No check for too big, but would it happen?
3893     sb->wp = wp;
3894     sb->type = type;
3895     sb->value = 0;
3896 #ifdef FEAT_GUI_ATHENA
3897     sb->pixval = 0;
3898 #endif
3899     sb->size = 1;
3900     sb->max = 1;
3901     sb->top = 0;
3902     sb->height = 0;
3903     sb->width = 0;
3904     sb->status_height = 0;
3905     gui_mch_create_scrollbar(sb, (wp == NULL) ? SBAR_HORIZ : SBAR_VERT);
3906 }
3907 
3908 /*
3909  * Find the scrollbar with the given index.
3910  */
3911     scrollbar_T *
3912 gui_find_scrollbar(long ident)
3913 {
3914     win_T	*wp;
3915 
3916     if (gui.bottom_sbar.ident == ident)
3917 	return &gui.bottom_sbar;
3918     FOR_ALL_WINDOWS(wp)
3919     {
3920 	if (wp->w_scrollbars[SBAR_LEFT].ident == ident)
3921 	    return &wp->w_scrollbars[SBAR_LEFT];
3922 	if (wp->w_scrollbars[SBAR_RIGHT].ident == ident)
3923 	    return &wp->w_scrollbars[SBAR_RIGHT];
3924     }
3925     return NULL;
3926 }
3927 
3928 /*
3929  * For most systems: Put a code in the input buffer for a dragged scrollbar.
3930  *
3931  * For Win32, Macintosh and GTK+ 2:
3932  * Scrollbars seem to grab focus and vim doesn't read the input queue until
3933  * you stop dragging the scrollbar.  We get here each time the scrollbar is
3934  * dragged another pixel, but as far as the rest of vim goes, it thinks
3935  * we're just hanging in the call to DispatchMessage() in
3936  * process_message().  The DispatchMessage() call that hangs was passed a
3937  * mouse button click event in the scrollbar window. -- webb.
3938  *
3939  * Solution: Do the scrolling right here.  But only when allowed.
3940  * Ignore the scrollbars while executing an external command or when there
3941  * are still characters to be processed.
3942  */
3943     void
3944 gui_drag_scrollbar(scrollbar_T *sb, long value, int still_dragging)
3945 {
3946     win_T	*wp;
3947     int		sb_num;
3948 #ifdef USE_ON_FLY_SCROLL
3949     colnr_T	old_leftcol = curwin->w_leftcol;
3950     linenr_T	old_topline = curwin->w_topline;
3951 # ifdef FEAT_DIFF
3952     int		old_topfill = curwin->w_topfill;
3953 # endif
3954 #else
3955     char_u	bytes[sizeof(long_u)];
3956     int		byte_count;
3957 #endif
3958 
3959     if (sb == NULL)
3960 	return;
3961 
3962     // Don't put events in the input queue now.
3963     if (hold_gui_events)
3964 	return;
3965 
3966 #ifdef FEAT_CMDWIN
3967     if (cmdwin_type != 0 && sb->wp != curwin)
3968 	return;
3969 #endif
3970 
3971     if (still_dragging)
3972     {
3973 	if (sb->wp == NULL)
3974 	    gui.dragged_sb = SBAR_BOTTOM;
3975 	else if (sb == &sb->wp->w_scrollbars[SBAR_LEFT])
3976 	    gui.dragged_sb = SBAR_LEFT;
3977 	else
3978 	    gui.dragged_sb = SBAR_RIGHT;
3979 	gui.dragged_wp = sb->wp;
3980     }
3981     else
3982     {
3983 	gui.dragged_sb = SBAR_NONE;
3984 #ifdef FEAT_GUI_GTK
3985 	// Keep the "dragged_wp" value until after the scrolling, for when the
3986 	// mouse button is released.  GTK2 doesn't send the button-up event.
3987 	gui.dragged_wp = NULL;
3988 #endif
3989     }
3990 
3991     // Vertical sbar info is kept in the first sbar (the left one)
3992     if (sb->wp != NULL)
3993 	sb = &sb->wp->w_scrollbars[0];
3994 
3995     /*
3996      * Check validity of value
3997      */
3998     if (value < 0)
3999 	value = 0;
4000 #ifdef SCROLL_PAST_END
4001     else if (value > sb->max)
4002 	value = sb->max;
4003 #else
4004     if (value > sb->max - sb->size + 1)
4005 	value = sb->max - sb->size + 1;
4006 #endif
4007 
4008     sb->value = value;
4009 
4010 #ifdef USE_ON_FLY_SCROLL
4011     // When not allowed to do the scrolling right now, return.
4012     // This also checked input_available(), but that causes the first click in
4013     // a scrollbar to be ignored when Vim doesn't have focus.
4014     if (dont_scroll)
4015 	return;
4016 #endif
4017     // Disallow scrolling the current window when the completion popup menu is
4018     // visible.
4019     if ((sb->wp == NULL || sb->wp == curwin) && pum_visible())
4020 	return;
4021 
4022 #ifdef FEAT_RIGHTLEFT
4023     if (sb->wp == NULL && curwin->w_p_rl)
4024     {
4025 	value = sb->max + 1 - sb->size - value;
4026 	if (value < 0)
4027 	    value = 0;
4028     }
4029 #endif
4030 
4031     if (sb->wp != NULL)		// vertical scrollbar
4032     {
4033 	sb_num = 0;
4034 	for (wp = firstwin; wp != sb->wp && wp != NULL; wp = wp->w_next)
4035 	    sb_num++;
4036 	if (wp == NULL)
4037 	    return;
4038 
4039 #ifdef USE_ON_FLY_SCROLL
4040 	current_scrollbar = sb_num;
4041 	scrollbar_value = value;
4042 	if (State & NORMAL)
4043 	{
4044 	    gui_do_scroll();
4045 	    setcursor();
4046 	}
4047 	else if (State & INSERT)
4048 	{
4049 	    ins_scroll();
4050 	    setcursor();
4051 	}
4052 	else if (State & CMDLINE)
4053 	{
4054 	    if (msg_scrolled == 0)
4055 	    {
4056 		gui_do_scroll();
4057 		redrawcmdline();
4058 	    }
4059 	}
4060 # ifdef FEAT_FOLDING
4061 	// Value may have been changed for closed fold.
4062 	sb->value = sb->wp->w_topline - 1;
4063 # endif
4064 
4065 	// When dragging one scrollbar and there is another one at the other
4066 	// side move the thumb of that one too.
4067 	if (gui.which_scrollbars[SBAR_RIGHT] && gui.which_scrollbars[SBAR_LEFT])
4068 	    gui_mch_set_scrollbar_thumb(
4069 		    &sb->wp->w_scrollbars[
4070 			    sb == &sb->wp->w_scrollbars[SBAR_RIGHT]
4071 						    ? SBAR_LEFT : SBAR_RIGHT],
4072 		    sb->value, sb->size, sb->max);
4073 
4074 #else
4075 	bytes[0] = CSI;
4076 	bytes[1] = KS_VER_SCROLLBAR;
4077 	bytes[2] = KE_FILLER;
4078 	bytes[3] = (char_u)sb_num;
4079 	byte_count = 4;
4080 #endif
4081     }
4082     else
4083     {
4084 #ifdef USE_ON_FLY_SCROLL
4085 	scrollbar_value = value;
4086 
4087 	if (State & NORMAL)
4088 	    gui_do_horiz_scroll(scrollbar_value, FALSE);
4089 	else if (State & INSERT)
4090 	    ins_horscroll();
4091 	else if (State & CMDLINE)
4092 	{
4093 	    if (msg_scrolled == 0)
4094 	    {
4095 		gui_do_horiz_scroll(scrollbar_value, FALSE);
4096 		redrawcmdline();
4097 	    }
4098 	}
4099 	if (old_leftcol != curwin->w_leftcol)
4100 	{
4101 	    updateWindow(curwin);   // update window, status and cmdline
4102 	    setcursor();
4103 	}
4104 #else
4105 	bytes[0] = CSI;
4106 	bytes[1] = KS_HOR_SCROLLBAR;
4107 	bytes[2] = KE_FILLER;
4108 	byte_count = 3;
4109 #endif
4110     }
4111 
4112 #ifdef USE_ON_FLY_SCROLL
4113     /*
4114      * synchronize other windows, as necessary according to 'scrollbind'
4115      */
4116     if (curwin->w_p_scb
4117 	    && ((sb->wp == NULL && curwin->w_leftcol != old_leftcol)
4118 		|| (sb->wp == curwin && (curwin->w_topline != old_topline
4119 # ifdef FEAT_DIFF
4120 					   || curwin->w_topfill != old_topfill
4121 # endif
4122 			))))
4123     {
4124 	do_check_scrollbind(TRUE);
4125 	// need to update the window right here
4126 	FOR_ALL_WINDOWS(wp)
4127 	    if (wp->w_redr_type > 0)
4128 		updateWindow(wp);
4129 	setcursor();
4130     }
4131     out_flush_cursor(FALSE, TRUE);
4132 #else
4133     add_to_input_buf(bytes, byte_count);
4134     add_long_to_buf((long_u)value, bytes);
4135     add_to_input_buf_csi(bytes, sizeof(long_u));
4136 #endif
4137 }
4138 
4139 /*
4140  * Scrollbar stuff:
4141  */
4142 
4143 /*
4144  * Called when something in the window layout has changed.
4145  */
4146     void
4147 gui_may_update_scrollbars(void)
4148 {
4149     if (gui.in_use && starting == 0)
4150     {
4151 	out_flush();
4152 	gui_init_which_components(NULL);
4153 	gui_update_scrollbars(TRUE);
4154     }
4155     need_mouse_correct = TRUE;
4156 }
4157 
4158     void
4159 gui_update_scrollbars(
4160     int		force)	    // Force all scrollbars to get updated
4161 {
4162     win_T	*wp;
4163     scrollbar_T	*sb;
4164     long	val, size, max;		// need 32 bits here
4165     int		which_sb;
4166     int		h, y;
4167     static win_T *prev_curwin = NULL;
4168 
4169     // Update the horizontal scrollbar
4170     gui_update_horiz_scrollbar(force);
4171 
4172 #ifndef MSWIN
4173     // Return straight away if there is neither a left nor right scrollbar.
4174     // On MS-Windows this is required anyway for scrollwheel messages.
4175     if (!gui.which_scrollbars[SBAR_LEFT] && !gui.which_scrollbars[SBAR_RIGHT])
4176 	return;
4177 #endif
4178 
4179     /*
4180      * Don't want to update a scrollbar while we're dragging it.  But if we
4181      * have both a left and right scrollbar, and we drag one of them, we still
4182      * need to update the other one.
4183      */
4184     if (!force && (gui.dragged_sb == SBAR_LEFT || gui.dragged_sb == SBAR_RIGHT)
4185 	    && gui.which_scrollbars[SBAR_LEFT]
4186 	    && gui.which_scrollbars[SBAR_RIGHT])
4187     {
4188 	/*
4189 	 * If we have two scrollbars and one of them is being dragged, just
4190 	 * copy the scrollbar position from the dragged one to the other one.
4191 	 */
4192 	which_sb = SBAR_LEFT + SBAR_RIGHT - gui.dragged_sb;
4193 	if (gui.dragged_wp != NULL)
4194 	    gui_mch_set_scrollbar_thumb(
4195 		    &gui.dragged_wp->w_scrollbars[which_sb],
4196 		    gui.dragged_wp->w_scrollbars[0].value,
4197 		    gui.dragged_wp->w_scrollbars[0].size,
4198 		    gui.dragged_wp->w_scrollbars[0].max);
4199     }
4200 
4201     // avoid that moving components around generates events
4202     ++hold_gui_events;
4203 
4204     FOR_ALL_WINDOWS(wp)
4205     {
4206 	if (wp->w_buffer == NULL)	// just in case
4207 	    continue;
4208 	// Skip a scrollbar that is being dragged.
4209 	if (!force && (gui.dragged_sb == SBAR_LEFT
4210 					     || gui.dragged_sb == SBAR_RIGHT)
4211 		&& gui.dragged_wp == wp)
4212 	    continue;
4213 
4214 #ifdef SCROLL_PAST_END
4215 	max = wp->w_buffer->b_ml.ml_line_count - 1;
4216 #else
4217 	max = wp->w_buffer->b_ml.ml_line_count + wp->w_height - 2;
4218 #endif
4219 	if (max < 0)			// empty buffer
4220 	    max = 0;
4221 	val = wp->w_topline - 1;
4222 	size = wp->w_height;
4223 #ifdef SCROLL_PAST_END
4224 	if (val > max)			// just in case
4225 	    val = max;
4226 #else
4227 	if (size > max + 1)		// just in case
4228 	    size = max + 1;
4229 	if (val > max - size + 1)
4230 	    val = max - size + 1;
4231 #endif
4232 	if (val < 0)			// minimal value is 0
4233 	    val = 0;
4234 
4235 	/*
4236 	 * Scrollbar at index 0 (the left one) contains all the information.
4237 	 * It would be the same info for left and right so we just store it for
4238 	 * one of them.
4239 	 */
4240 	sb = &wp->w_scrollbars[0];
4241 
4242 	/*
4243 	 * Note: no check for valid w_botline.	If it's not valid the
4244 	 * scrollbars will be updated later anyway.
4245 	 */
4246 	if (size < 1 || wp->w_botline - 2 > max)
4247 	{
4248 	    /*
4249 	     * This can happen during changing files.  Just don't update the
4250 	     * scrollbar for now.
4251 	     */
4252 	    sb->height = 0;	    // Force update next time
4253 	    if (gui.which_scrollbars[SBAR_LEFT])
4254 		gui_do_scrollbar(wp, SBAR_LEFT, FALSE);
4255 	    if (gui.which_scrollbars[SBAR_RIGHT])
4256 		gui_do_scrollbar(wp, SBAR_RIGHT, FALSE);
4257 	    continue;
4258 	}
4259 	if (force || sb->height != wp->w_height
4260 	    || sb->top != wp->w_winrow
4261 	    || sb->status_height != wp->w_status_height
4262 	    || sb->width != wp->w_width
4263 	    || prev_curwin != curwin)
4264 	{
4265 	    // Height, width or position of scrollbar has changed.  For
4266 	    // vertical split: curwin changed.
4267 	    sb->height = wp->w_height;
4268 	    sb->top = wp->w_winrow;
4269 	    sb->status_height = wp->w_status_height;
4270 	    sb->width = wp->w_width;
4271 
4272 	    // Calculate height and position in pixels
4273 	    h = (sb->height + sb->status_height) * gui.char_height;
4274 	    y = sb->top * gui.char_height + gui.border_offset;
4275 #if defined(FEAT_MENU) && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MOTIF) && !defined(FEAT_GUI_PHOTON)
4276 	    if (gui.menu_is_active)
4277 		y += gui.menu_height;
4278 #endif
4279 
4280 #if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_ATHENA) \
4281 	|| defined(FEAT_GUI_HAIKU))
4282 	    if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
4283 # if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_HAIKU)
4284 		y += gui.toolbar_height;
4285 # else
4286 #  ifdef FEAT_GUI_MSWIN
4287 		y += TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT;
4288 #  endif
4289 # endif
4290 #endif
4291 
4292 #if defined(FEAT_GUI_TABLINE) && defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_HAIKU)
4293 	    if (gui_has_tabline())
4294 		y += gui.tabline_height;
4295 #endif
4296 
4297 	    if (wp->w_winrow == 0)
4298 	    {
4299 		// Height of top scrollbar includes width of top border
4300 		h += gui.border_offset;
4301 		y -= gui.border_offset;
4302 	    }
4303 	    if (gui.which_scrollbars[SBAR_LEFT])
4304 	    {
4305 		gui_mch_set_scrollbar_pos(&wp->w_scrollbars[SBAR_LEFT],
4306 					  gui.left_sbar_x, y,
4307 					  gui.scrollbar_width, h);
4308 		gui_do_scrollbar(wp, SBAR_LEFT, TRUE);
4309 	    }
4310 	    if (gui.which_scrollbars[SBAR_RIGHT])
4311 	    {
4312 		gui_mch_set_scrollbar_pos(&wp->w_scrollbars[SBAR_RIGHT],
4313 					  gui.right_sbar_x, y,
4314 					  gui.scrollbar_width, h);
4315 		gui_do_scrollbar(wp, SBAR_RIGHT, TRUE);
4316 	    }
4317 	}
4318 
4319 	// Reduce the number of calls to gui_mch_set_scrollbar_thumb() by
4320 	// checking if the thumb moved at least a pixel.  Only do this for
4321 	// Athena, most other GUIs require the update anyway to make the
4322 	// arrows work.
4323 #ifdef FEAT_GUI_ATHENA
4324 	if (max == 0)
4325 	    y = 0;
4326 	else
4327 	    y = (val * (sb->height + 2) * gui.char_height + max / 2) / max;
4328 	if (force || sb->pixval != y || sb->size != size || sb->max != max)
4329 #else
4330 	if (force || sb->value != val || sb->size != size || sb->max != max)
4331 #endif
4332 	{
4333 	    // Thumb of scrollbar has moved
4334 	    sb->value = val;
4335 #ifdef FEAT_GUI_ATHENA
4336 	    sb->pixval = y;
4337 #endif
4338 	    sb->size = size;
4339 	    sb->max = max;
4340 	    if (gui.which_scrollbars[SBAR_LEFT]
4341 		    && (gui.dragged_sb != SBAR_LEFT || gui.dragged_wp != wp))
4342 		gui_mch_set_scrollbar_thumb(&wp->w_scrollbars[SBAR_LEFT],
4343 					    val, size, max);
4344 	    if (gui.which_scrollbars[SBAR_RIGHT]
4345 		    && (gui.dragged_sb != SBAR_RIGHT || gui.dragged_wp != wp))
4346 		gui_mch_set_scrollbar_thumb(&wp->w_scrollbars[SBAR_RIGHT],
4347 					    val, size, max);
4348 	}
4349     }
4350     prev_curwin = curwin;
4351     --hold_gui_events;
4352 }
4353 
4354 /*
4355  * Enable or disable a scrollbar.
4356  * Check for scrollbars for vertically split windows which are not enabled
4357  * sometimes.
4358  */
4359     static void
4360 gui_do_scrollbar(
4361     win_T	*wp,
4362     int		which,	    // SBAR_LEFT or SBAR_RIGHT
4363     int		enable)	    // TRUE to enable scrollbar
4364 {
4365     int		midcol = curwin->w_wincol + curwin->w_width / 2;
4366     int		has_midcol = (wp->w_wincol <= midcol
4367 				     && wp->w_wincol + wp->w_width >= midcol);
4368 
4369     // Only enable scrollbars that contain the middle column of the current
4370     // window.
4371     if (gui.which_scrollbars[SBAR_RIGHT] != gui.which_scrollbars[SBAR_LEFT])
4372     {
4373 	// Scrollbars only on one side.  Don't enable scrollbars that don't
4374 	// contain the middle column of the current window.
4375 	if (!has_midcol)
4376 	    enable = FALSE;
4377     }
4378     else
4379     {
4380 	// Scrollbars on both sides.  Don't enable scrollbars that neither
4381 	// contain the middle column of the current window nor are on the far
4382 	// side.
4383 	if (midcol > Columns / 2)
4384 	{
4385 	    if (which == SBAR_LEFT ? wp->w_wincol != 0 : !has_midcol)
4386 		enable = FALSE;
4387 	}
4388 	else
4389 	{
4390 	    if (which == SBAR_RIGHT ? wp->w_wincol + wp->w_width != Columns
4391 								: !has_midcol)
4392 		enable = FALSE;
4393 	}
4394     }
4395     gui_mch_enable_scrollbar(&wp->w_scrollbars[which], enable);
4396 }
4397 
4398 /*
4399  * Scroll a window according to the values set in the globals current_scrollbar
4400  * and scrollbar_value.  Return TRUE if the cursor in the current window moved
4401  * or FALSE otherwise.
4402  */
4403     int
4404 gui_do_scroll(void)
4405 {
4406     win_T	*wp, *save_wp;
4407     int		i;
4408     long	nlines;
4409     pos_T	old_cursor;
4410     linenr_T	old_topline;
4411 #ifdef FEAT_DIFF
4412     int		old_topfill;
4413 #endif
4414 
4415     for (wp = firstwin, i = 0; i < current_scrollbar; wp = W_NEXT(wp), i++)
4416 	if (wp == NULL)
4417 	    break;
4418     if (wp == NULL)
4419 	// Couldn't find window
4420 	return FALSE;
4421 
4422     /*
4423      * Compute number of lines to scroll.  If zero, nothing to do.
4424      */
4425     nlines = (long)scrollbar_value + 1 - (long)wp->w_topline;
4426     if (nlines == 0)
4427 	return FALSE;
4428 
4429     save_wp = curwin;
4430     old_topline = wp->w_topline;
4431 #ifdef FEAT_DIFF
4432     old_topfill = wp->w_topfill;
4433 #endif
4434     old_cursor = wp->w_cursor;
4435     curwin = wp;
4436     curbuf = wp->w_buffer;
4437     if (nlines < 0)
4438 	scrolldown(-nlines, gui.dragged_wp == NULL);
4439     else
4440 	scrollup(nlines, gui.dragged_wp == NULL);
4441     // Reset dragged_wp after using it.  "dragged_sb" will have been reset for
4442     // the mouse-up event already, but we still want it to behave like when
4443     // dragging.  But not the next click in an arrow.
4444     if (gui.dragged_sb == SBAR_NONE)
4445 	gui.dragged_wp = NULL;
4446 
4447     if (old_topline != wp->w_topline
4448 #ifdef FEAT_DIFF
4449 	    || old_topfill != wp->w_topfill
4450 #endif
4451 	    )
4452     {
4453 	if (get_scrolloff_value() != 0)
4454 	{
4455 	    cursor_correct();		// fix window for 'so'
4456 	    update_topline();		// avoid up/down jump
4457 	}
4458 	if (old_cursor.lnum != wp->w_cursor.lnum)
4459 	    coladvance(wp->w_curswant);
4460 	wp->w_scbind_pos = wp->w_topline;
4461     }
4462 
4463     // Make sure wp->w_leftcol and wp->w_skipcol are correct.
4464     validate_cursor();
4465 
4466     curwin = save_wp;
4467     curbuf = save_wp->w_buffer;
4468 
4469     /*
4470      * Don't call updateWindow() when nothing has changed (it will overwrite
4471      * the status line!).
4472      */
4473     if (old_topline != wp->w_topline
4474 	    || wp->w_redr_type != 0
4475 #ifdef FEAT_DIFF
4476 	    || old_topfill != wp->w_topfill
4477 #endif
4478 	    )
4479     {
4480 	int type = VALID;
4481 
4482 	if (pum_visible())
4483 	{
4484 	    type = NOT_VALID;
4485 	    wp->w_lines_valid = 0;
4486 	}
4487 
4488 	// Don't set must_redraw here, it may cause the popup menu to
4489 	// disappear when losing focus after a scrollbar drag.
4490 	if (wp->w_redr_type < type)
4491 	    wp->w_redr_type = type;
4492 	mch_disable_flush();
4493 	updateWindow(wp);   // update window, status line, and cmdline
4494 	mch_enable_flush();
4495     }
4496 
4497     // May need to redraw the popup menu.
4498     if (pum_visible())
4499 	pum_redraw();
4500 
4501     return (wp == curwin && !EQUAL_POS(curwin->w_cursor, old_cursor));
4502 }
4503 
4504 
4505 /*
4506  * Horizontal scrollbar stuff:
4507  */
4508 
4509 /*
4510  * Return length of line "lnum" for horizontal scrolling.
4511  */
4512     static colnr_T
4513 scroll_line_len(linenr_T lnum)
4514 {
4515     char_u	*p;
4516     colnr_T	col;
4517     int		w;
4518 
4519     p = ml_get(lnum);
4520     col = 0;
4521     if (*p != NUL)
4522 	for (;;)
4523 	{
4524 	    w = chartabsize(p, col);
4525 	    MB_PTR_ADV(p);
4526 	    if (*p == NUL)		// don't count the last character
4527 		break;
4528 	    col += w;
4529 	}
4530     return col;
4531 }
4532 
4533 // Remember which line is currently the longest, so that we don't have to
4534 // search for it when scrolling horizontally.
4535 static linenr_T longest_lnum = 0;
4536 
4537 /*
4538  * Find longest visible line number.  If this is not possible (or not desired,
4539  * by setting 'h' in "guioptions") then the current line number is returned.
4540  */
4541     static linenr_T
4542 gui_find_longest_lnum(void)
4543 {
4544     linenr_T ret = 0;
4545 
4546     // Calculate maximum for horizontal scrollbar.  Check for reasonable
4547     // line numbers, topline and botline can be invalid when displaying is
4548     // postponed.
4549     if (vim_strchr(p_go, GO_HORSCROLL) == NULL
4550 	    && curwin->w_topline <= curwin->w_cursor.lnum
4551 	    && curwin->w_botline > curwin->w_cursor.lnum
4552 	    && curwin->w_botline <= curbuf->b_ml.ml_line_count + 1)
4553     {
4554 	linenr_T    lnum;
4555 	colnr_T	    n;
4556 	long	    max = 0;
4557 
4558 	// Use maximum of all visible lines.  Remember the lnum of the
4559 	// longest line, closest to the cursor line.  Used when scrolling
4560 	// below.
4561 	for (lnum = curwin->w_topline; lnum < curwin->w_botline; ++lnum)
4562 	{
4563 	    n = scroll_line_len(lnum);
4564 	    if (n > (colnr_T)max)
4565 	    {
4566 		max = n;
4567 		ret = lnum;
4568 	    }
4569 	    else if (n == (colnr_T)max
4570 		    && abs((int)(lnum - curwin->w_cursor.lnum))
4571 		       < abs((int)(ret - curwin->w_cursor.lnum)))
4572 		ret = lnum;
4573 	}
4574     }
4575     else
4576 	// Use cursor line only.
4577 	ret = curwin->w_cursor.lnum;
4578 
4579     return ret;
4580 }
4581 
4582     static void
4583 gui_update_horiz_scrollbar(int force)
4584 {
4585     long	value, size, max;	// need 32 bit ints here
4586 
4587     if (!gui.which_scrollbars[SBAR_BOTTOM])
4588 	return;
4589 
4590     if (!force && gui.dragged_sb == SBAR_BOTTOM)
4591 	return;
4592 
4593     if (!force && curwin->w_p_wrap && gui.prev_wrap)
4594 	return;
4595 
4596     /*
4597      * It is possible for the cursor to be invalid if we're in the middle of
4598      * something (like changing files).  If so, don't do anything for now.
4599      */
4600     if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
4601     {
4602 	gui.bottom_sbar.value = -1;
4603 	return;
4604     }
4605 
4606     size = curwin->w_width;
4607     if (curwin->w_p_wrap)
4608     {
4609 	value = 0;
4610 #ifdef SCROLL_PAST_END
4611 	max = 0;
4612 #else
4613 	max = curwin->w_width - 1;
4614 #endif
4615     }
4616     else
4617     {
4618 	value = curwin->w_leftcol;
4619 
4620 	longest_lnum = gui_find_longest_lnum();
4621 	max = scroll_line_len(longest_lnum);
4622 
4623 	if (virtual_active())
4624 	{
4625 	    // May move the cursor even further to the right.
4626 	    if (curwin->w_virtcol >= (colnr_T)max)
4627 		max = curwin->w_virtcol;
4628 	}
4629 
4630 #ifndef SCROLL_PAST_END
4631 	max += curwin->w_width - 1;
4632 #endif
4633 	// The line number isn't scrolled, thus there is less space when
4634 	// 'number' or 'relativenumber' is set (also for 'foldcolumn').
4635 	size -= curwin_col_off();
4636 #ifndef SCROLL_PAST_END
4637 	max -= curwin_col_off();
4638 #endif
4639     }
4640 
4641 #ifndef SCROLL_PAST_END
4642     if (value > max - size + 1)
4643 	value = max - size + 1;	    // limit the value to allowable range
4644 #endif
4645 
4646 #ifdef FEAT_RIGHTLEFT
4647     if (curwin->w_p_rl)
4648     {
4649 	value = max + 1 - size - value;
4650 	if (value < 0)
4651 	{
4652 	    size += value;
4653 	    value = 0;
4654 	}
4655     }
4656 #endif
4657     if (!force && value == gui.bottom_sbar.value && size == gui.bottom_sbar.size
4658 						&& max == gui.bottom_sbar.max)
4659 	return;
4660 
4661     gui.bottom_sbar.value = value;
4662     gui.bottom_sbar.size = size;
4663     gui.bottom_sbar.max = max;
4664     gui.prev_wrap = curwin->w_p_wrap;
4665 
4666     gui_mch_set_scrollbar_thumb(&gui.bottom_sbar, value, size, max);
4667 }
4668 
4669 /*
4670  * Do a horizontal scroll.  Return TRUE if the cursor moved, FALSE otherwise.
4671  */
4672     int
4673 gui_do_horiz_scroll(long_u leftcol, int compute_longest_lnum)
4674 {
4675     // no wrapping, no scrolling
4676     if (curwin->w_p_wrap)
4677 	return FALSE;
4678 
4679     if (curwin->w_leftcol == (colnr_T)leftcol)
4680 	return FALSE;
4681 
4682     curwin->w_leftcol = (colnr_T)leftcol;
4683 
4684     // When the line of the cursor is too short, move the cursor to the
4685     // longest visible line.
4686     if (vim_strchr(p_go, GO_HORSCROLL) == NULL
4687 	    && !virtual_active()
4688 	    && (colnr_T)leftcol > scroll_line_len(curwin->w_cursor.lnum))
4689     {
4690 	if (compute_longest_lnum)
4691 	{
4692 	    curwin->w_cursor.lnum = gui_find_longest_lnum();
4693 	    curwin->w_cursor.col = 0;
4694 	}
4695 	// Do a sanity check on "longest_lnum", just in case.
4696 	else if (longest_lnum >= curwin->w_topline
4697 		&& longest_lnum < curwin->w_botline)
4698 	{
4699 	    curwin->w_cursor.lnum = longest_lnum;
4700 	    curwin->w_cursor.col = 0;
4701 	}
4702     }
4703 
4704     return leftcol_changed();
4705 }
4706 
4707 /*
4708  * Check that none of the colors are the same as the background color
4709  */
4710     void
4711 gui_check_colors(void)
4712 {
4713     if (gui.norm_pixel == gui.back_pixel || gui.norm_pixel == INVALCOLOR)
4714     {
4715 	gui_set_bg_color((char_u *)"White");
4716 	if (gui.norm_pixel == gui.back_pixel || gui.norm_pixel == INVALCOLOR)
4717 	    gui_set_fg_color((char_u *)"Black");
4718     }
4719 }
4720 
4721     static void
4722 gui_set_fg_color(char_u *name)
4723 {
4724     gui.norm_pixel = gui_get_color(name);
4725     hl_set_fg_color_name(vim_strsave(name));
4726 }
4727 
4728     static void
4729 gui_set_bg_color(char_u *name)
4730 {
4731     gui.back_pixel = gui_get_color(name);
4732     hl_set_bg_color_name(vim_strsave(name));
4733 }
4734 
4735 /*
4736  * Allocate a color by name.
4737  * Returns INVALCOLOR and gives an error message when failed.
4738  */
4739     guicolor_T
4740 gui_get_color(char_u *name)
4741 {
4742     guicolor_T	t;
4743 
4744     if (*name == NUL)
4745 	return INVALCOLOR;
4746     t = gui_mch_get_color(name);
4747 
4748     if (t == INVALCOLOR
4749 #if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
4750 	    && gui.in_use
4751 #endif
4752 	    )
4753 	semsg(_(e_alloc_color), name);
4754     return t;
4755 }
4756 
4757 /*
4758  * Return the grey value of a color (range 0-255).
4759  */
4760     int
4761 gui_get_lightness(guicolor_T pixel)
4762 {
4763     long_u	rgb = (long_u)gui_mch_get_rgb(pixel);
4764 
4765     return  (int)(  (((rgb >> 16) & 0xff) * 299)
4766 		   + (((rgb >> 8) & 0xff) * 587)
4767 		   +  ((rgb	  & 0xff) * 114)) / 1000;
4768 }
4769 
4770     char_u *
4771 gui_bg_default(void)
4772 {
4773     if (gui_get_lightness(gui.back_pixel) < 127)
4774 	return (char_u *)"dark";
4775     return (char_u *)"light";
4776 }
4777 
4778 /*
4779  * Option initializations that can only be done after opening the GUI window.
4780  */
4781     void
4782 init_gui_options(void)
4783 {
4784     // Set the 'background' option according to the lightness of the
4785     // background color, unless the user has set it already.
4786     if (!option_was_set((char_u *)"bg") && STRCMP(p_bg, gui_bg_default()) != 0)
4787     {
4788 	set_option_value((char_u *)"bg", 0L, gui_bg_default(), 0);
4789 	highlight_changed();
4790     }
4791 }
4792 
4793 #if defined(FEAT_GUI_X11) || defined(PROTO)
4794     void
4795 gui_new_scrollbar_colors(void)
4796 {
4797     win_T	*wp;
4798 
4799     // Nothing to do if GUI hasn't started yet.
4800     if (!gui.in_use)
4801 	return;
4802 
4803     FOR_ALL_WINDOWS(wp)
4804     {
4805 	gui_mch_set_scrollbar_colors(&(wp->w_scrollbars[SBAR_LEFT]));
4806 	gui_mch_set_scrollbar_colors(&(wp->w_scrollbars[SBAR_RIGHT]));
4807     }
4808     gui_mch_set_scrollbar_colors(&gui.bottom_sbar);
4809 }
4810 #endif
4811 
4812 /*
4813  * Call this when focus has changed.
4814  */
4815     void
4816 gui_focus_change(int in_focus)
4817 {
4818 /*
4819  * Skip this code to avoid drawing the cursor when debugging and switching
4820  * between the debugger window and gvim.
4821  */
4822 #if 1
4823     gui.in_focus = in_focus;
4824     out_flush_cursor(TRUE, FALSE);
4825 
4826 # ifdef FEAT_XIM
4827     xim_set_focus(in_focus);
4828 # endif
4829 
4830     // Put events in the input queue only when allowed.
4831     // ui_focus_change() isn't called directly, because it invokes
4832     // autocommands and that must not happen asynchronously.
4833     if (!hold_gui_events)
4834     {
4835 	char_u  bytes[3];
4836 
4837 	bytes[0] = CSI;
4838 	bytes[1] = KS_EXTRA;
4839 	bytes[2] = in_focus ? (int)KE_FOCUSGAINED : (int)KE_FOCUSLOST;
4840 	add_to_input_buf(bytes, 3);
4841     }
4842 #endif
4843 }
4844 
4845 /*
4846  * When mouse moved: apply 'mousefocus'.
4847  * Also updates the mouse pointer shape.
4848  */
4849     static void
4850 gui_mouse_focus(int x, int y)
4851 {
4852     win_T	*wp;
4853     char_u	st[8];
4854 
4855 #ifdef FEAT_MOUSESHAPE
4856     // Get window pointer, and update mouse shape as well.
4857     wp = xy2win(x, y, IGNORE_POPUP);
4858 #endif
4859 
4860     // Only handle this when 'mousefocus' set and ...
4861     if (p_mousef
4862 	    && !hold_gui_events		// not holding events
4863 	    && (State & (NORMAL|INSERT))// Normal/Visual/Insert mode
4864 	    && State != HITRETURN	// but not hit-return prompt
4865 	    && msg_scrolled == 0	// no scrolled message
4866 	    && !need_mouse_correct	// not moving the pointer
4867 	    && gui.in_focus)		// gvim in focus
4868     {
4869 	// Don't move the mouse when it's left or right of the Vim window
4870 	if (x < 0 || x > Columns * gui.char_width)
4871 	    return;
4872 #ifndef FEAT_MOUSESHAPE
4873 	wp = xy2win(x, y, IGNORE_POPUP);
4874 #endif
4875 	if (wp == curwin || wp == NULL)
4876 	    return;	// still in the same old window, or none at all
4877 
4878 	// Ignore position in the tab pages line.
4879 	if (Y_2_ROW(y) < tabline_height())
4880 	    return;
4881 
4882 	/*
4883 	 * format a mouse click on status line input
4884 	 * ala gui_send_mouse_event(0, x, y, 0, 0);
4885 	 * Trick: Use a column number -1, so that get_pseudo_mouse_code() will
4886 	 * generate a K_LEFTMOUSE_NM key code.
4887 	 */
4888 	if (finish_op)
4889 	{
4890 	    // abort the current operator first
4891 	    st[0] = ESC;
4892 	    add_to_input_buf(st, 1);
4893 	}
4894 	st[0] = CSI;
4895 	st[1] = KS_MOUSE;
4896 	st[2] = KE_FILLER;
4897 	st[3] = (char_u)MOUSE_LEFT;
4898 	fill_mouse_coord(st + 4,
4899 		wp->w_wincol == 0 ? -1 : wp->w_wincol + MOUSE_COLOFF,
4900 		wp->w_height + W_WINROW(wp));
4901 
4902 	add_to_input_buf(st, 8);
4903 	st[3] = (char_u)MOUSE_RELEASE;
4904 	add_to_input_buf(st, 8);
4905 #ifdef FEAT_GUI_GTK
4906 	// Need to wake up the main loop
4907 	if (gtk_main_level() > 0)
4908 	    gtk_main_quit();
4909 #endif
4910     }
4911 }
4912 
4913 /*
4914  * Called when the mouse moved (but not when dragging).
4915  */
4916     void
4917 gui_mouse_moved(int x, int y)
4918 {
4919     // Ignore this while still starting up.
4920     if (!gui.in_use || gui.starting)
4921 	return;
4922 
4923     // apply 'mousefocus' and pointer shape
4924     gui_mouse_focus(x, y);
4925 
4926 #ifdef FEAT_PROP_POPUP
4927     if (popup_visible)
4928 	// Generate a mouse-moved event, so that the popup can perhaps be
4929 	// closed, just like in the terminal.
4930 	gui_send_mouse_event(MOUSE_DRAG, x, y, FALSE, 0);
4931 #endif
4932 }
4933 
4934 /*
4935  * Get the window where the mouse pointer is on.
4936  * Returns NULL if not found.
4937  */
4938     win_T *
4939 gui_mouse_window(mouse_find_T popup)
4940 {
4941     int		x, y;
4942 
4943     if (!(gui.in_use && (p_mousef || popup == FIND_POPUP)))
4944 	return NULL;
4945     gui_mch_getmouse(&x, &y);
4946 
4947     // Only use the mouse when it's on the Vim window
4948     if (x >= 0 && x <= Columns * gui.char_width
4949 	    && y >= 0 && Y_2_ROW(y) >= tabline_height())
4950 	return xy2win(x, y, popup);
4951     return NULL;
4952 }
4953 
4954 /*
4955  * Called when mouse should be moved to window with focus.
4956  */
4957     void
4958 gui_mouse_correct(void)
4959 {
4960     win_T	*wp = NULL;
4961 
4962     need_mouse_correct = FALSE;
4963 
4964     wp = gui_mouse_window(IGNORE_POPUP);
4965     if (wp != curwin && wp != NULL)	// If in other than current window
4966     {
4967 	validate_cline_row();
4968 	gui_mch_setmouse((int)W_ENDCOL(curwin) * gui.char_width - 3,
4969 		(W_WINROW(curwin) + curwin->w_wrow) * gui.char_height
4970 						     + (gui.char_height) / 2);
4971     }
4972 }
4973 
4974 /*
4975  * Find window where the mouse pointer "x" / "y" coordinate is in.
4976  * As a side effect update the shape of the mouse pointer.
4977  */
4978     static win_T *
4979 xy2win(int x, int y, mouse_find_T popup)
4980 {
4981     int		row;
4982     int		col;
4983     win_T	*wp;
4984 
4985     row = Y_2_ROW(y);
4986     col = X_2_COL(x);
4987     if (row < 0 || col < 0)		// before first window
4988 	return NULL;
4989     wp = mouse_find_win(&row, &col, popup);
4990     if (wp == NULL)
4991 	return NULL;
4992 #ifdef FEAT_MOUSESHAPE
4993     if (State == HITRETURN || State == ASKMORE)
4994     {
4995 	if (Y_2_ROW(y) >= msg_row)
4996 	    update_mouseshape(SHAPE_IDX_MOREL);
4997 	else
4998 	    update_mouseshape(SHAPE_IDX_MORE);
4999     }
5000     else if (row > wp->w_height)	// below status line
5001 	update_mouseshape(SHAPE_IDX_CLINE);
5002     else if (!(State & CMDLINE) && wp->w_vsep_width > 0 && col == wp->w_width
5003 	    && (row != wp->w_height || !stl_connected(wp)) && msg_scrolled == 0)
5004 	update_mouseshape(SHAPE_IDX_VSEP);
5005     else if (!(State & CMDLINE) && wp->w_status_height > 0
5006 				  && row == wp->w_height && msg_scrolled == 0)
5007 	update_mouseshape(SHAPE_IDX_STATUS);
5008     else
5009 	update_mouseshape(-2);
5010 #endif
5011     return wp;
5012 }
5013 
5014 /*
5015  * ":gui" and ":gvim": Change from the terminal version to the GUI version.
5016  * File names may be given to redefine the args list.
5017  */
5018     void
5019 ex_gui(exarg_T *eap)
5020 {
5021     char_u	*arg = eap->arg;
5022 
5023     /*
5024      * Check for "-f" argument: foreground, don't fork.
5025      * Also don't fork when started with "gvim -f".
5026      * Do fork when using "gui -b".
5027      */
5028     if (arg[0] == '-'
5029 	    && (arg[1] == 'f' || arg[1] == 'b')
5030 	    && (arg[2] == NUL || VIM_ISWHITE(arg[2])))
5031     {
5032 	gui.dofork = (arg[1] == 'b');
5033 	eap->arg = skipwhite(eap->arg + 2);
5034     }
5035     if (!gui.in_use)
5036     {
5037 #if defined(VIMDLL) && !defined(EXPERIMENTAL_GUI_CMD)
5038 	if (!gui.starting)
5039 	{
5040 	    emsg(_(e_nogvim));
5041 	    return;
5042 	}
5043 #endif
5044 	// Clear the command.  Needed for when forking+exiting, to avoid part
5045 	// of the argument ending up after the shell prompt.
5046 	msg_clr_eos_force();
5047 #ifdef GUI_MAY_SPAWN
5048 	if (!ends_excmd2(eap->cmd, eap->arg))
5049 	    gui_start(eap->arg);
5050 	else
5051 #endif
5052 	    gui_start(NULL);
5053 #ifdef FEAT_JOB_CHANNEL
5054 	channel_gui_register_all();
5055 #endif
5056     }
5057     if (!ends_excmd2(eap->cmd, eap->arg))
5058 	ex_next(eap);
5059 }
5060 
5061 #if ((defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK) \
5062 	    || defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_PHOTON) \
5063 	    || defined(FEAT_GUI_HAIKU)) \
5064 	    && defined(FEAT_TOOLBAR)) || defined(PROTO)
5065 /*
5066  * This is shared between Athena, Haiku, Motif, and GTK.
5067  */
5068 
5069 /*
5070  * Callback function for do_in_runtimepath().
5071  */
5072     static void
5073 gfp_setname(char_u *fname, void *cookie)
5074 {
5075     char_u	*gfp_buffer = cookie;
5076 
5077     if (STRLEN(fname) >= MAXPATHL)
5078 	*gfp_buffer = NUL;
5079     else
5080 	STRCPY(gfp_buffer, fname);
5081 }
5082 
5083 /*
5084  * Find the path of bitmap "name" with extension "ext" in 'runtimepath'.
5085  * Return FAIL for failure and OK if buffer[MAXPATHL] contains the result.
5086  */
5087     int
5088 gui_find_bitmap(char_u *name, char_u *buffer, char *ext)
5089 {
5090     if (STRLEN(name) > MAXPATHL - 14)
5091 	return FAIL;
5092     vim_snprintf((char *)buffer, MAXPATHL, "bitmaps/%s.%s", name, ext);
5093     if (do_in_runtimepath(buffer, 0, gfp_setname, buffer) == FAIL
5094 							    || *buffer == NUL)
5095 	return FAIL;
5096     return OK;
5097 }
5098 
5099 # if !defined(FEAT_GUI_GTK) || defined(PROTO)
5100 /*
5101  * Given the name of the "icon=" argument, try finding the bitmap file for the
5102  * icon.  If it is an absolute path name, use it as it is.  Otherwise append
5103  * "ext" and search for it in 'runtimepath'.
5104  * The result is put in "buffer[MAXPATHL]".  If something fails "buffer"
5105  * contains "name".
5106  */
5107     void
5108 gui_find_iconfile(char_u *name, char_u *buffer, char *ext)
5109 {
5110     char_u	buf[MAXPATHL + 1];
5111 
5112     expand_env(name, buffer, MAXPATHL);
5113     if (!mch_isFullName(buffer) && gui_find_bitmap(buffer, buf, ext) == OK)
5114 	STRCPY(buffer, buf);
5115 }
5116 # endif
5117 #endif
5118 
5119 #if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11)|| defined(FEAT_GUI_HAIKU) \
5120 	|| defined(PROTO)
5121     void
5122 display_errors(void)
5123 {
5124     char_u	*p;
5125 
5126     if (isatty(2))
5127 	fflush(stderr);
5128     else if (error_ga.ga_data != NULL)
5129     {
5130 	// avoid putting up a message box with blanks only
5131 	for (p = (char_u *)error_ga.ga_data; *p != NUL; ++p)
5132 	    if (!isspace(*p))
5133 	    {
5134 		// Truncate a very long message, it will go off-screen.
5135 		if (STRLEN(p) > 2000)
5136 		    STRCPY(p + 2000 - 14, "...(truncated)");
5137 		(void)do_dialog(VIM_ERROR, (char_u *)_("Error"),
5138 				       p, (char_u *)_("&Ok"), 1, NULL, FALSE);
5139 		break;
5140 	    }
5141 	ga_clear(&error_ga);
5142     }
5143 }
5144 #endif
5145 
5146 #if defined(NO_CONSOLE_INPUT) || defined(PROTO)
5147 /*
5148  * Return TRUE if still starting up and there is no place to enter text.
5149  * For GTK and X11 we check if stderr is not a tty, which means we were
5150  * (probably) started from the desktop.  Also check stdin, "vim >& file" does
5151  * allow typing on stdin.
5152  */
5153     int
5154 no_console_input(void)
5155 {
5156     return ((!gui.in_use || gui.starting)
5157 # ifndef NO_CONSOLE
5158 	    && !isatty(0) && !isatty(2)
5159 # endif
5160 	    );
5161 }
5162 #endif
5163 
5164 #if defined(FIND_REPLACE_DIALOG) \
5165 	|| defined(NEED_GUI_UPDATE_SCREEN) \
5166 	|| defined(PROTO)
5167 /*
5168  * Update the current window and the screen.
5169  */
5170     void
5171 gui_update_screen(void)
5172 {
5173 # ifdef FEAT_CONCEAL
5174     linenr_T	conceal_old_cursor_line = 0;
5175     linenr_T	conceal_new_cursor_line = 0;
5176     int		conceal_update_lines = FALSE;
5177 # endif
5178 
5179     update_topline();
5180     validate_cursor();
5181 
5182     // Trigger CursorMoved if the cursor moved.
5183     if (!finish_op && (has_cursormoved()
5184 # ifdef FEAT_PROP_POPUP
5185 		|| popup_visible
5186 # endif
5187 # ifdef FEAT_CONCEAL
5188 		|| curwin->w_p_cole > 0
5189 # endif
5190 		) && !EQUAL_POS(last_cursormoved, curwin->w_cursor))
5191     {
5192 	if (has_cursormoved())
5193 	    apply_autocmds(EVENT_CURSORMOVED, NULL, NULL, FALSE, curbuf);
5194 #ifdef FEAT_PROP_POPUP
5195 	if (popup_visible)
5196 	    popup_check_cursor_pos();
5197 #endif
5198 # ifdef FEAT_CONCEAL
5199 	if (curwin->w_p_cole > 0)
5200 	{
5201 	    conceal_old_cursor_line = last_cursormoved.lnum;
5202 	    conceal_new_cursor_line = curwin->w_cursor.lnum;
5203 	    conceal_update_lines = TRUE;
5204 	}
5205 # endif
5206 	last_cursormoved = curwin->w_cursor;
5207     }
5208 
5209 # ifdef FEAT_CONCEAL
5210     if (conceal_update_lines
5211 	    && (conceal_old_cursor_line != conceal_new_cursor_line
5212 		|| conceal_cursor_line(curwin)
5213 		|| need_cursor_line_redraw))
5214     {
5215 	if (conceal_old_cursor_line != conceal_new_cursor_line)
5216 	    redrawWinline(curwin, conceal_old_cursor_line);
5217 	redrawWinline(curwin, conceal_new_cursor_line);
5218 	curwin->w_valid &= ~VALID_CROW;
5219 	need_cursor_line_redraw = FALSE;
5220     }
5221 # endif
5222     update_screen(0);	// may need to update the screen
5223     setcursor();
5224     out_flush_cursor(TRUE, FALSE);
5225 }
5226 #endif
5227 
5228 #if defined(FIND_REPLACE_DIALOG) || defined(PROTO)
5229 /*
5230  * Get the text to use in a find/replace dialog.  Uses the last search pattern
5231  * if the argument is empty.
5232  * Returns an allocated string.
5233  */
5234     char_u *
5235 get_find_dialog_text(
5236     char_u	*arg,
5237     int		*wwordp,	// return: TRUE if \< \> found
5238     int		*mcasep)	// return: TRUE if \C found
5239 {
5240     char_u	*text;
5241 
5242     if (*arg == NUL)
5243 	text = last_search_pat();
5244     else
5245 	text = arg;
5246     if (text != NULL)
5247     {
5248 	text = vim_strsave(text);
5249 	if (text != NULL)
5250 	{
5251 	    int len = (int)STRLEN(text);
5252 	    int i;
5253 
5254 	    // Remove "\V"
5255 	    if (len >= 2 && STRNCMP(text, "\\V", 2) == 0)
5256 	    {
5257 		mch_memmove(text, text + 2, (size_t)(len - 1));
5258 		len -= 2;
5259 	    }
5260 
5261 	    // Recognize "\c" and "\C" and remove.
5262 	    if (len >= 2 && *text == '\\' && (text[1] == 'c' || text[1] == 'C'))
5263 	    {
5264 		*mcasep = (text[1] == 'C');
5265 		mch_memmove(text, text + 2, (size_t)(len - 1));
5266 		len -= 2;
5267 	    }
5268 
5269 	    // Recognize "\<text\>" and remove.
5270 	    if (len >= 4
5271 		    && STRNCMP(text, "\\<", 2) == 0
5272 		    && STRNCMP(text + len - 2, "\\>", 2) == 0)
5273 	    {
5274 		*wwordp = TRUE;
5275 		mch_memmove(text, text + 2, (size_t)(len - 4));
5276 		text[len - 4] = NUL;
5277 	    }
5278 
5279 	    // Recognize "\/" or "\?" and remove.
5280 	    for (i = 0; i + 1 < len; ++i)
5281 		if (text[i] == '\\' && (text[i + 1] == '/'
5282 						       || text[i + 1] == '?'))
5283 		{
5284 		    mch_memmove(text + i, text + i + 1, (size_t)(len - i));
5285 		    --len;
5286 		}
5287 	}
5288     }
5289     return text;
5290 }
5291 
5292 /*
5293  * Handle the press of a button in the find-replace dialog.
5294  * Return TRUE when something was added to the input buffer.
5295  */
5296     int
5297 gui_do_findrepl(
5298     int		flags,		// one of FRD_REPLACE, FRD_FINDNEXT, etc.
5299     char_u	*find_text,
5300     char_u	*repl_text,
5301     int		down)		// Search downwards.
5302 {
5303     garray_T	ga;
5304     int		i;
5305     int		type = (flags & FRD_TYPE_MASK);
5306     char_u	*p;
5307     regmatch_T	regmatch;
5308     int		save_did_emsg = did_emsg;
5309     static int  busy = FALSE;
5310 
5311     // When the screen is being updated we should not change buffers and
5312     // windows structures, it may cause freed memory to be used.  Also don't
5313     // do this recursively (pressing "Find" quickly several times.
5314     if (updating_screen || busy)
5315 	return FALSE;
5316 
5317     // refuse replace when text cannot be changed
5318     if ((type == FRD_REPLACE || type == FRD_REPLACEALL) && text_locked())
5319 	return FALSE;
5320 
5321     busy = TRUE;
5322 
5323     ga_init2(&ga, 1, 100);
5324     if (type == FRD_REPLACEALL)
5325 	ga_concat(&ga, (char_u *)"%s/");
5326 
5327     ga_concat(&ga, (char_u *)"\\V");
5328     if (flags & FRD_MATCH_CASE)
5329 	ga_concat(&ga, (char_u *)"\\C");
5330     else
5331 	ga_concat(&ga, (char_u *)"\\c");
5332     if (flags & FRD_WHOLE_WORD)
5333 	ga_concat(&ga, (char_u *)"\\<");
5334     // escape slash and backslash
5335     p = vim_strsave_escaped(find_text, (char_u *)"/\\");
5336     if (p != NULL)
5337         ga_concat(&ga, p);
5338     vim_free(p);
5339     if (flags & FRD_WHOLE_WORD)
5340 	ga_concat(&ga, (char_u *)"\\>");
5341 
5342     if (type == FRD_REPLACEALL)
5343     {
5344 	ga_concat(&ga, (char_u *)"/");
5345 	// escape slash and backslash
5346 	p = vim_strsave_escaped(repl_text, (char_u *)"/\\");
5347 	if (p != NULL)
5348 	    ga_concat(&ga, p);
5349 	vim_free(p);
5350 	ga_concat(&ga, (char_u *)"/g");
5351     }
5352     ga_append(&ga, NUL);
5353 
5354     if (type == FRD_REPLACE)
5355     {
5356 	// Do the replacement when the text at the cursor matches.  Thus no
5357 	// replacement is done if the cursor was moved!
5358 	regmatch.regprog = vim_regcomp(ga.ga_data, RE_MAGIC + RE_STRING);
5359 	regmatch.rm_ic = 0;
5360 	if (regmatch.regprog != NULL)
5361 	{
5362 	    p = ml_get_cursor();
5363 	    if (vim_regexec_nl(&regmatch, p, (colnr_T)0)
5364 						   && regmatch.startp[0] == p)
5365 	    {
5366 		// Clear the command line to remove any old "No match"
5367 		// error.
5368 		msg_end_prompt();
5369 
5370 		if (u_save_cursor() == OK)
5371 		{
5372 		    // A button was pressed thus undo should be synced.
5373 		    u_sync(FALSE);
5374 
5375 		    del_bytes((long)(regmatch.endp[0] - regmatch.startp[0]),
5376 								FALSE, FALSE);
5377 		    ins_str(repl_text);
5378 		}
5379 	    }
5380 	    else
5381 		msg(_("No match at cursor, finding next"));
5382 	    vim_regfree(regmatch.regprog);
5383 	}
5384     }
5385 
5386     if (type == FRD_REPLACEALL)
5387     {
5388 	// A button was pressed, thus undo should be synced.
5389 	u_sync(FALSE);
5390 	do_cmdline_cmd(ga.ga_data);
5391     }
5392     else
5393     {
5394 	int searchflags = SEARCH_MSG + SEARCH_MARK;
5395 
5396 	// Search for the next match.
5397 	// Don't skip text under cursor for single replace.
5398 	if (type == FRD_REPLACE)
5399 	    searchflags += SEARCH_START;
5400 	i = msg_scroll;
5401 	if (down)
5402 	{
5403 	    (void)do_search(NULL, '/', '/', ga.ga_data, 1L, searchflags, NULL);
5404 	}
5405 	else
5406 	{
5407 	    // We need to escape '?' if and only if we are searching in the up
5408 	    // direction
5409 	    p = vim_strsave_escaped(ga.ga_data, (char_u *)"?");
5410 	    if (p != NULL)
5411 	        (void)do_search(NULL, '?', '?', p, 1L, searchflags, NULL);
5412 	    vim_free(p);
5413 	}
5414 
5415 	msg_scroll = i;	    // don't let an error message set msg_scroll
5416     }
5417 
5418     // Don't want to pass did_emsg to other code, it may cause disabling
5419     // syntax HL if we were busy redrawing.
5420     did_emsg = save_did_emsg;
5421 
5422     if (State & (NORMAL | INSERT))
5423     {
5424 	gui_update_screen();		// update the screen
5425 	msg_didout = 0;			// overwrite any message
5426 	need_wait_return = FALSE;	// don't wait for return
5427     }
5428 
5429     vim_free(ga.ga_data);
5430     busy = FALSE;
5431     return (ga.ga_len > 0);
5432 }
5433 
5434 #endif
5435 
5436 #if defined(HAVE_DROP_FILE) || defined(PROTO)
5437 /*
5438  * Jump to the window at specified point (x, y).
5439  */
5440     static void
5441 gui_wingoto_xy(int x, int y)
5442 {
5443     int		row = Y_2_ROW(y);
5444     int		col = X_2_COL(x);
5445     win_T	*wp;
5446 
5447     if (row >= 0 && col >= 0)
5448     {
5449 	wp = mouse_find_win(&row, &col, FAIL_POPUP);
5450 	if (wp != NULL && wp != curwin)
5451 	    win_goto(wp);
5452     }
5453 }
5454 
5455 /*
5456  * Function passed to handle_drop() for the actions to be done after the
5457  * argument list has been updated.
5458  */
5459     static void
5460 drop_callback(void *cookie)
5461 {
5462     char_u	*p = cookie;
5463 
5464     // If Shift held down, change to first file's directory.  If the first
5465     // item is a directory, change to that directory (and let the explorer
5466     // plugin show the contents).
5467     if (p != NULL)
5468     {
5469 	if (mch_isdir(p))
5470 	{
5471 	    if (mch_chdir((char *)p) == 0)
5472 		shorten_fnames(TRUE);
5473 	}
5474 	else if (vim_chdirfile(p, "drop") == OK)
5475 	    shorten_fnames(TRUE);
5476 	vim_free(p);
5477     }
5478 
5479     // Update the screen display
5480     update_screen(NOT_VALID);
5481 # ifdef FEAT_MENU
5482     gui_update_menus(0);
5483 # endif
5484 #ifdef FEAT_TITLE
5485     maketitle();
5486 #endif
5487     setcursor();
5488     out_flush_cursor(FALSE, FALSE);
5489 }
5490 
5491 /*
5492  * Process file drop.  Mouse cursor position, key modifiers, name of files
5493  * and count of files are given.  Argument "fnames[count]" has full pathnames
5494  * of dropped files, they will be freed in this function, and caller can't use
5495  * fnames after call this function.
5496  */
5497     void
5498 gui_handle_drop(
5499     int		x UNUSED,
5500     int		y UNUSED,
5501     int_u	modifiers,
5502     char_u	**fnames,
5503     int		count)
5504 {
5505     int		i;
5506     char_u	*p;
5507     static int	entered = FALSE;
5508 
5509     /*
5510      * This function is called by event handlers.  Just in case we get a
5511      * second event before the first one is handled, ignore the second one.
5512      * Not sure if this can ever happen, just in case.
5513      */
5514     if (entered)
5515 	return;
5516     entered = TRUE;
5517 
5518     /*
5519      * When the cursor is at the command line, add the file names to the
5520      * command line, don't edit the files.
5521      */
5522     if (State & CMDLINE)
5523     {
5524 	shorten_filenames(fnames, count);
5525 	for (i = 0; i < count; ++i)
5526 	{
5527 	    if (fnames[i] != NULL)
5528 	    {
5529 		if (i > 0)
5530 		    add_to_input_buf((char_u*)" ", 1);
5531 
5532 		// We don't know what command is used thus we can't be sure
5533 		// about which characters need to be escaped.  Only escape the
5534 		// most common ones.
5535 # ifdef BACKSLASH_IN_FILENAME
5536 		p = vim_strsave_escaped(fnames[i], (char_u *)" \t\"|");
5537 # else
5538 		p = vim_strsave_escaped(fnames[i], (char_u *)"\\ \t\"|");
5539 # endif
5540 		if (p != NULL)
5541 		    add_to_input_buf_csi(p, (int)STRLEN(p));
5542 		vim_free(p);
5543 		vim_free(fnames[i]);
5544 	    }
5545 	}
5546 	vim_free(fnames);
5547     }
5548     else
5549     {
5550 	// Go to the window under mouse cursor, then shorten given "fnames" by
5551 	// current window, because a window can have local current dir.
5552 	gui_wingoto_xy(x, y);
5553 	shorten_filenames(fnames, count);
5554 
5555 	// If Shift held down, remember the first item.
5556 	if ((modifiers & MOUSE_SHIFT) != 0)
5557 	    p = vim_strsave(fnames[0]);
5558 	else
5559 	    p = NULL;
5560 
5561 	// Handle the drop, :edit or :split to get to the file.  This also
5562 	// frees fnames[].  Skip this if there is only one item, it's a
5563 	// directory and Shift is held down.
5564 	if (count == 1 && (modifiers & MOUSE_SHIFT) != 0
5565 						     && mch_isdir(fnames[0]))
5566 	{
5567 	    vim_free(fnames[0]);
5568 	    vim_free(fnames);
5569 	}
5570 	else
5571 	    handle_drop(count, fnames, (modifiers & MOUSE_CTRL) != 0,
5572 		    drop_callback, (void *)p);
5573     }
5574 
5575     entered = FALSE;
5576 }
5577 #endif
5578 
5579 /*
5580  * Check if "key" is to interrupt us.  Handles a key that has not had modifiers
5581  * applied yet.
5582  * Return the key with modifiers applied if so, NUL if not.
5583  */
5584     int
5585 check_for_interrupt(int key, int modifiers_arg)
5586 {
5587     int modifiers = modifiers_arg;
5588     int c = merge_modifyOtherKeys(key, &modifiers);
5589 
5590     if ((c == Ctrl_C && ctrl_c_interrupts)
5591 #ifdef UNIX
5592 	    || (intr_char != Ctrl_C && c == intr_char)
5593 #endif
5594 	    )
5595     {
5596 	got_int = TRUE;
5597 	return c;
5598     }
5599     return NUL;
5600 }
5601 
5602