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