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