Merged from the latest developing branch.

[MacVim/KaoriYa.git] / src / gui.c

/* vi:set ts=8 sts=4 sw=4:
 *
 * VIM - Vi IMproved            by Bram Moolenaar
 *                              GUI/Motif support by Robert Webb
 *
 * Do ":help uganda"  in Vim to read copying and usage conditions.
 * Do ":help credits" in Vim to see a list of people who contributed.
 * See README.txt for an overview of the Vim source code.
 */

#include "vim.h"

/* Structure containing all the GUI information */
gui_T gui;

#if defined(FEAT_MBYTE) && !defined(HAVE_GTK2)
static void set_guifontwide __ARGS((char_u *font_name));
#endif
static void gui_check_pos __ARGS((void));
static void gui_position_components __ARGS((int));
static void gui_outstr __ARGS((char_u *, int));
static int gui_screenchar __ARGS((int off, int flags, guicolor_T fg, guicolor_T bg, int back));
#ifdef HAVE_GTK2
static int gui_screenstr __ARGS((int off, int len, int flags, guicolor_T fg, guicolor_T bg, int back));
#endif
static void gui_delete_lines __ARGS((int row, int count));
static void gui_insert_lines __ARGS((int row, int count));
static void fill_mouse_coord __ARGS((char_u *p, int col, int row));
#if defined(FEAT_GUI_TABLINE) || defined(PROTO)
static int gui_has_tabline __ARGS((void));
#endif
static void gui_do_scrollbar __ARGS((win_T *wp, int which, int enable));
static colnr_T scroll_line_len __ARGS((linenr_T lnum));
static void gui_update_horiz_scrollbar __ARGS((int));
static void gui_set_fg_color __ARGS((char_u *name));
static void gui_set_bg_color __ARGS((char_u *name));
static win_T *xy2win __ARGS((int x, int y));

static int can_update_cursor = TRUE; /* can display the cursor */

/*
 * The Athena scrollbars can move the thumb to after the end of the scrollbar,
 * this makes the thumb indicate the part of the text that is shown.  Motif
 * can't do this.
 */
#if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_MAC)
# define SCROLL_PAST_END
#endif

/*
 * gui_start -- Called when user wants to start the GUI.
 *
 * Careful: This function can be called recursively when there is a ":gui"
 * command in the .gvimrc file.  Only the first call should fork, not the
 * recursive call.
 */
    void
gui_start()
{
    char_u      *old_term;
#if defined(UNIX) && !defined(__BEOS__) && !defined(MACOS_X)
# define MAY_FORK
    int         dofork = TRUE;
#endif
    static int  recursive = 0;

    old_term = vim_strsave(T_NAME);

    /*
     * Set_termname() will call gui_init() to start the GUI.
     * Set the "starting" flag, to indicate that the GUI will start.
     *
     * We don't want to open the GUI shell until after we've read .gvimrc,
     * otherwise we don't know what font we will use, and hence we don't know
     * what size the shell should be.  So if there are errors in the .gvimrc
     * file, they will have to go to the terminal: Set full_screen to FALSE.
     * full_screen will be set to TRUE again by a successful termcapinit().
     */
    settmode(TMODE_COOK);               /* stop RAW mode */
    if (full_screen)
        cursor_on();                    /* needed for ":gui" in .vimrc */
    gui.starting = TRUE;
    full_screen = FALSE;

#ifdef MAY_FORK
    if (!gui.dofork || vim_strchr(p_go, GO_FORG) || recursive)
        dofork = FALSE;
#endif
    ++recursive;

    termcapinit((char_u *)"builtin_gui");
    gui.starting = recursive - 1;

    if (!gui.in_use)                    /* failed to start GUI */
    {
        termcapinit(old_term);          /* back to old term settings */
        settmode(TMODE_RAW);            /* restart RAW mode */
#ifdef FEAT_TITLE
        set_title_defaults();           /* set 'title' and 'icon' again */
#endif
    }

    vim_free(old_term);

#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11)
    if (gui.in_use)
        /* Display error messages in a dialog now. */
        display_errors();
#endif

#if defined(MAY_FORK) && !defined(__QNXNTO__)
    /*
     * Quit the current process and continue in the child.
     * Makes "gvim file" disconnect from the shell it was started in.
     * Don't do this when Vim was started with "-f" or the 'f' flag is present
     * in 'guioptions'.
     */
    if (gui.in_use && dofork)
    {
        int     pipefd[2];      /* pipe between parent and child */
        int     pipe_error;
        char    dummy;
        pid_t   pid = -1;

        /* Setup a pipe between the child and the parent, so that the parent
         * knows when the child has done the setsid() call and is allowed to
         * exit. */
        pipe_error = (pipe(pipefd) < 0);
        pid = fork();
        if (pid > 0)        /* Parent */
        {
            /* Give the child some time to do the setsid(), otherwise the
             * exit() may kill the child too (when starting gvim from inside a
             * gvim). */
            if (pipe_error)
                ui_delay(300L, TRUE);
            else
            {
                /* The read returns when the child closes the pipe (or when
                 * the child dies for some reason). */
                close(pipefd[1]);
                ignored = (int)read(pipefd[0], &dummy, (size_t)1);
                close(pipefd[0]);
            }

            /* When swapping screens we may need to go to the next line, e.g.,
             * after a hit-enter prompt and using ":gui". */
            if (newline_on_exit)
                mch_errmsg("\r\n");

            /*
             * The parent must skip the normal exit() processing, the child
             * will do it.  For example, GTK messes up signals when exiting.
             */
            _exit(0);
        }

# if defined(HAVE_SETSID) || defined(HAVE_SETPGID)
        /*
         * Change our process group.  On some systems/shells a CTRL-C in the
         * shell where Vim was started would otherwise kill gvim!
         */
        if (pid == 0)       /* child */
#  if defined(HAVE_SETSID)
            (void)setsid();
#  else
            (void)setpgid(0, 0);
#  endif
# endif
        if (!pipe_error)
        {
            close(pipefd[0]);
            close(pipefd[1]);
        }

# if defined(FEAT_GUI_GNOME) && defined(FEAT_SESSION)
        /* Tell the session manager our new PID */
        gui_mch_forked();
# endif
    }
#else
# if defined(__QNXNTO__)
    if (gui.in_use && dofork)
        procmgr_daemon(0, PROCMGR_DAEMON_KEEPUMASK | PROCMGR_DAEMON_NOCHDIR |
                PROCMGR_DAEMON_NOCLOSE | PROCMGR_DAEMON_NODEVNULL);
# endif
#endif

#ifdef FEAT_AUTOCMD
    /* If the GUI started successfully, trigger the GUIEnter event, otherwise
     * the GUIFailed event. */
    apply_autocmds(gui.in_use ? EVENT_GUIENTER : EVENT_GUIFAILED,
                                                   NULL, NULL, FALSE, curbuf);
#endif

    --recursive;
}

/*
 * Call this when vim starts up, whether or not the GUI is started
 */
    void
gui_prepare(argc, argv)
    int     *argc;
    char    **argv;
{
    gui.in_use = FALSE;             /* No GUI yet (maybe later) */
    gui.starting = FALSE;           /* No GUI yet (maybe later) */
    gui_mch_prepare(argc, argv);
}

/*
 * Try initializing the GUI and check if it can be started.
 * Used from main() to check early if "vim -g" can start the GUI.
 * Used from gui_init() to prepare for starting the GUI.
 * Returns FAIL or OK.
 */
    int
gui_init_check()
{
    static int result = MAYBE;

    if (result != MAYBE)
    {
        if (result == FAIL)
            EMSG(_("E229: Cannot start the GUI"));
        return result;
    }

    gui.shell_created = FALSE;
    gui.dying = FALSE;
    gui.in_focus = TRUE;                /* so the guicursor setting works */
    gui.dragged_sb = SBAR_NONE;
    gui.dragged_wp = NULL;
    gui.pointer_hidden = FALSE;
    gui.col = 0;
    gui.row = 0;
    gui.num_cols = Columns;
    gui.num_rows = Rows;

    gui.cursor_is_valid = FALSE;
    gui.scroll_region_top = 0;
    gui.scroll_region_bot = Rows - 1;
    gui.scroll_region_left = 0;
    gui.scroll_region_right = Columns - 1;
    gui.highlight_mask = HL_NORMAL;
    gui.char_width = 1;
    gui.char_height = 1;
    gui.char_ascent = 0;
    gui.border_width = 0;

    gui.norm_font = NOFONT;
#ifndef HAVE_GTK2
    gui.bold_font = NOFONT;
    gui.ital_font = NOFONT;
    gui.boldital_font = NOFONT;
# ifdef FEAT_XFONTSET
    gui.fontset = NOFONTSET;
# endif
#endif

#ifdef FEAT_MENU
# ifndef HAVE_GTK2
#  ifdef FONTSET_ALWAYS
    gui.menu_fontset = NOFONTSET;
#  else
    gui.menu_font = NOFONT;
#  endif
# endif
    gui.menu_is_active = TRUE;      /* default: include menu */
# ifndef FEAT_GUI_GTK
    gui.menu_height = MENU_DEFAULT_HEIGHT;
    gui.menu_width = 0;
# endif
#endif
#if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA))
    gui.toolbar_height = 0;
#endif
#if defined(FEAT_FOOTER) && defined(FEAT_GUI_MOTIF)
    gui.footer_height = 0;
#endif
#ifdef FEAT_BEVAL_TIP
    gui.tooltip_fontset = NOFONTSET;
#endif

    gui.scrollbar_width = gui.scrollbar_height = SB_DEFAULT_WIDTH;
    gui.prev_wrap = -1;

#ifdef ALWAYS_USE_GUI
    result = OK;
#else
    result = gui_mch_init_check();
#endif
    return result;
}

/*
 * This is the call which starts the GUI.
 */
    void
gui_init()
{
    win_T       *wp;
    static int  recursive = 0;

    /*
     * It's possible to use ":gui" in a .gvimrc file.  The first halve of this
     * function will then be executed at the first call, the rest by the
     * recursive call.  This allow the shell to be opened halfway reading a
     * gvimrc file.
     */
    if (!recursive)
    {
        ++recursive;

        clip_init(TRUE);

        /* If can't initialize, don't try doing the rest */
        if (gui_init_check() == FAIL)
        {
            --recursive;
            clip_init(FALSE);
            return;
        }

        /*
         * Reset 'paste'.  It's useful in the terminal, but not in the GUI.  It
         * breaks the Paste toolbar button.
         */
        set_option_value((char_u *)"paste", 0L, NULL, 0);

        /*
         * Set up system-wide default menus.
         */
#if defined(SYS_MENU_FILE) && defined(FEAT_MENU)
        if (vim_strchr(p_go, GO_NOSYSMENU) == NULL)
        {
            sys_menu = TRUE;
            do_source((char_u *)SYS_MENU_FILE, FALSE, DOSO_NONE);
            sys_menu = FALSE;
        }
#endif

        /*
         * Switch on the mouse by default, unless the user changed it already.
         * This can then be changed in the .gvimrc.
         */
        if (!option_was_set((char_u *)"mouse"))
            set_string_option_direct((char_u *)"mouse", -1,
                                           (char_u *)"a", OPT_FREE, SID_NONE);

        /*
         * If -U option given, use only the initializations from that file and
         * nothing else.  Skip all initializations for "-U NONE" or "-u NORC".
         */
        if (use_gvimrc != NULL)
        {
            if (STRCMP(use_gvimrc, "NONE") != 0
                    && STRCMP(use_gvimrc, "NORC") != 0
                    && do_source(use_gvimrc, FALSE, DOSO_NONE) != OK)
                EMSG2(_("E230: Cannot read from \"%s\""), use_gvimrc);
        }
        else
        {
            /*
             * Get system wide defaults for gvim, only when file name defined.
             */
#ifdef SYS_GVIMRC_FILE
            do_source((char_u *)SYS_GVIMRC_FILE, FALSE, DOSO_NONE);
#endif

            /*
             * Try to read GUI initialization commands from the following
             * places:
             * - environment variable GVIMINIT
             * - the user gvimrc file (~/.gvimrc)
             * - the second user gvimrc file ($VIM/.gvimrc for Dos)
             * - the third user gvimrc file ($VIM/.gvimrc for Amiga)
             * The first that exists is used, the rest is ignored.
             */
            if (process_env((char_u *)"GVIMINIT", FALSE) == FAIL
                 && do_source((char_u *)USR_GVIMRC_FILE, TRUE,
                                                          DOSO_GVIMRC) == FAIL
#ifdef USR_GVIMRC_FILE2
                 && do_source((char_u *)USR_GVIMRC_FILE2, TRUE,
                                                          DOSO_GVIMRC) == FAIL
#endif
                                )
            {
#ifdef USR_GVIMRC_FILE3
                (void)do_source((char_u *)USR_GVIMRC_FILE3, TRUE, DOSO_GVIMRC);
#endif
            }

            /*
             * Read initialization commands from ".gvimrc" in current
             * directory.  This is only done if the 'exrc' option is set.
             * Because of security reasons we disallow shell and write
             * commands now, except for unix if the file is owned by the user
             * or 'secure' option has been reset in environment of global
             * ".gvimrc".
             * Only do this if GVIMRC_FILE is not the same as USR_GVIMRC_FILE,
             * USR_GVIMRC_FILE2, USR_GVIMRC_FILE3 or SYS_GVIMRC_FILE.
             */
            if (p_exrc)
            {
#ifdef UNIX
                {
                    struct stat s;

                    /* if ".gvimrc" file is not owned by user, set 'secure'
                     * mode */
                    if (mch_stat(GVIMRC_FILE, &s) || s.st_uid != getuid())
                        secure = p_secure;
                }
#else
                secure = p_secure;
#endif

                if (       fullpathcmp((char_u *)USR_GVIMRC_FILE,
                                     (char_u *)GVIMRC_FILE, FALSE) != FPC_SAME
#ifdef SYS_GVIMRC_FILE
                        && fullpathcmp((char_u *)SYS_GVIMRC_FILE,
                                     (char_u *)GVIMRC_FILE, FALSE) != FPC_SAME
#endif
#ifdef USR_GVIMRC_FILE2
                        && fullpathcmp((char_u *)USR_GVIMRC_FILE2,
                                     (char_u *)GVIMRC_FILE, FALSE) != FPC_SAME
#endif
#ifdef USR_GVIMRC_FILE3
                        && fullpathcmp((char_u *)USR_GVIMRC_FILE3,
                                     (char_u *)GVIMRC_FILE, FALSE) != FPC_SAME
#endif
                        )
                    do_source((char_u *)GVIMRC_FILE, TRUE, DOSO_GVIMRC);

                if (secure == 2)
                    need_wait_return = TRUE;
                secure = 0;
            }
        }

        if (need_wait_return || msg_didany)
            wait_return(TRUE);

        --recursive;
    }

    /* If recursive call opened the shell, return here from the first call */
    if (gui.in_use)
        return;

    /*
     * Create the GUI shell.
     */
    gui.in_use = TRUE;          /* Must be set after menus have been set up */
    if (gui_mch_init() == FAIL)
        goto error;

    /* Avoid a delay for an error message that was printed in the terminal
     * where Vim was started. */
    emsg_on_display = FALSE;
    msg_scrolled = 0;
    clear_sb_text();
    need_wait_return = FALSE;
    msg_didany = FALSE;

    /*
     * Check validity of any generic resources that may have been loaded.
     */
    if (gui.border_width < 0)
        gui.border_width = 0;

    /*
     * Set up the fonts.  First use a font specified with "-fn" or "-font".
     */
    if (font_argument != NULL)
        set_option_value((char_u *)"gfn", 0L, (char_u *)font_argument, 0);
    if (
#ifdef FEAT_XFONTSET
            (*p_guifontset == NUL
             || gui_init_font(p_guifontset, TRUE) == FAIL) &&
#endif
            gui_init_font(*p_guifont == NUL ? hl_get_font_name()
                                                  : p_guifont, FALSE) == FAIL)
    {
        EMSG(_("E665: Cannot start GUI, no valid font found"));
        goto error2;
    }
#ifdef FEAT_MBYTE
    if (gui_get_wide_font() == FAIL)
        EMSG(_("E231: 'guifontwide' invalid"));
#endif

    gui.num_cols = Columns;
    gui.num_rows = Rows;
    gui_reset_scroll_region();

    /* Create initial scrollbars */
    FOR_ALL_WINDOWS(wp)
    {
        gui_create_scrollbar(&wp->w_scrollbars[SBAR_LEFT], SBAR_LEFT, wp);
        gui_create_scrollbar(&wp->w_scrollbars[SBAR_RIGHT], SBAR_RIGHT, wp);
    }
    gui_create_scrollbar(&gui.bottom_sbar, SBAR_BOTTOM, NULL);

#ifdef FEAT_MENU
    gui_create_initial_menus(root_menu);
#endif
#ifdef FEAT_SUN_WORKSHOP
    if (usingSunWorkShop)
        workshop_init();
#endif
#ifdef FEAT_SIGN_ICONS
    sign_gui_started();
#endif

    /* Configure the desired menu and scrollbars */
    gui_init_which_components(NULL);

    /* All components of the GUI have been created now */
    gui.shell_created = TRUE;

#ifndef FEAT_GUI_GTK
    /* Set the shell size, adjusted for the screen size.  For GTK this only
     * works after the shell has been opened, thus it is further down. */
    gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
#endif
#if defined(FEAT_GUI_MOTIF) && defined(FEAT_MENU)
    /* Need to set the size of the menubar after all the menus have been
     * created. */
    gui_mch_compute_menu_height((Widget)0);
#endif

    /*
     * Actually open the GUI shell.
     */
    if (gui_mch_open() != FAIL)
    {
#ifdef FEAT_TITLE
        maketitle();
        resettitle();
#endif
        init_gui_options();
#ifdef FEAT_ARABIC
        /* Our GUI can't do bidi. */
        p_tbidi = FALSE;
#endif
#if defined(FEAT_GUI_GTK)
        /* Give GTK+ a chance to put all widget's into place. */
        gui_mch_update();

# ifdef FEAT_MENU
        /* If there is no 'm' in 'guioptions' we need to remove the menu now.
         * It was still there to make F10 work. */
        if (vim_strchr(p_go, GO_MENUS) == NULL)
        {
            --gui.starting;
            gui_mch_enable_menu(FALSE);
            ++gui.starting;
            gui_mch_update();
        }
# endif

        /* Now make sure the shell fits on the screen. */
        gui_set_shellsize(FALSE, TRUE, RESIZE_BOTH);
#endif
        /* When 'lines' was set while starting up the topframe may have to be
         * resized. */
        win_new_shellsize();

#ifdef FEAT_BEVAL
        /* Always create the Balloon Evaluation area, but disable it when
         * 'ballooneval' is off */
# ifdef FEAT_GUI_GTK
        balloonEval = gui_mch_create_beval_area(gui.drawarea, NULL,
                                                     &general_beval_cb, NULL);
# else
#  if defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA)
        {
            extern Widget       textArea;
            balloonEval = gui_mch_create_beval_area(textArea, NULL,
                                                     &general_beval_cb, NULL);
        }
#  else
#   ifdef FEAT_GUI_W32
        balloonEval = gui_mch_create_beval_area(NULL, NULL,
                                                     &general_beval_cb, NULL);
#   endif
#  endif
# endif
        if (!p_beval)
            gui_mch_disable_beval_area(balloonEval);
#endif

#ifdef FEAT_NETBEANS_INTG
        if (starting == 0 && usingNetbeans)
            /* Tell the client that it can start sending commands. */
            netbeans_startup_done();
#endif
#if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
        if (!im_xim_isvalid_imactivate())
            EMSG(_("E599: Value of 'imactivatekey' is invalid"));
#endif
        /* When 'cmdheight' was set during startup it may not have taken
         * effect yet. */
        if (p_ch != 1L)
            command_height();

        return;
    }

error2:
#ifdef FEAT_GUI_X11
    /* undo gui_mch_init() */
    gui_mch_uninit();
#endif

error:
    gui.in_use = FALSE;
    clip_init(FALSE);
}


    void
gui_exit(rc)
    int         rc;
{
#ifndef __BEOS__
    /* don't free the fonts, it leads to a BUS error
     * richard@whitequeen.com Jul 99 */
    free_highlight_fonts();
#endif
    gui.in_use = FALSE;
    gui_mch_exit(rc);
}

#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11) || defined(FEAT_GUI_MSWIN) \
        || defined(FEAT_GUI_PHOTON) || defined(FEAT_GUI_MAC) || defined(PROTO)
# define NEED_GUI_UPDATE_SCREEN 1
/*
 * Called when the GUI shell is closed by the user.  If there are no changed
 * files Vim exits, otherwise there will be a dialog to ask the user what to
 * do.
 * When this function returns, Vim should NOT exit!
 */
    void
gui_shell_closed()
{
    cmdmod_T        save_cmdmod;

    save_cmdmod = cmdmod;

    /* Only exit when there are no changed files */
    exiting = TRUE;
# ifdef FEAT_BROWSE
    cmdmod.browse = TRUE;
# endif
# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
    cmdmod.confirm = TRUE;
# endif
    /* If there are changed buffers, present the user with a dialog if
     * possible, otherwise give an error message. */
    if (!check_changed_any(FALSE))
        getout(0);

    exiting = FALSE;
    cmdmod = save_cmdmod;
    gui_update_screen();        /* redraw, window may show changed buffer */
}
#endif

/*
 * Set the font.  "font_list" is a a comma separated list of font names.  The
 * first font name that works is used.  If none is found, use the default
 * font.
 * If "fontset" is TRUE, the "font_list" is used as one name for the fontset.
 * Return OK when able to set the font.  When it failed FAIL is returned and
 * the fonts are unchanged.
 */
    int
gui_init_font(font_list, fontset)
    char_u      *font_list;
    int         fontset UNUSED;
{
#define FONTLEN 320
    char_u      font_name[FONTLEN];
    int         font_list_empty = FALSE;
    int         ret = FAIL;

    if (!gui.in_use)
        return FAIL;

    font_name[0] = NUL;
    if (*font_list == NUL)
        font_list_empty = TRUE;
    else
    {
#ifdef FEAT_XFONTSET
        /* When using a fontset, the whole list of fonts is one name. */
        if (fontset)
            ret = gui_mch_init_font(font_list, TRUE);
        else
#endif
            while (*font_list != NUL)
            {
                /* Isolate one comma separated font name. */
                (void)copy_option_part(&font_list, font_name, FONTLEN, ",");

                /* Careful!!!  The Win32 version of gui_mch_init_font(), when
                 * called with "*" will change p_guifont to the selected font
                 * name, which frees the old value.  This makes font_list
                 * invalid.  Thus when OK is returned here, font_list must no
                 * longer be used! */
                if (gui_mch_init_font(font_name, FALSE) == OK)
                {
#if defined(FEAT_MBYTE) && !defined(HAVE_GTK2)
                    /* If it's a Unicode font, try setting 'guifontwide' to a
                     * similar double-width font. */
                    if ((p_guifontwide == NULL || *p_guifontwide == NUL)
                                && strstr((char *)font_name, "10646") != NULL)
                        set_guifontwide(font_name);
#endif
                    ret = OK;
                    break;
                }
            }
    }

    if (ret != OK
            && STRCMP(font_list, "*") != 0
            && (font_list_empty || gui.norm_font == NOFONT))
    {
        /*
         * Couldn't load any font in 'font_list', keep the current font if
         * there is one.  If 'font_list' is empty, or if there is no current
         * font, tell gui_mch_init_font() to try to find a font we can load.
         */
        ret = gui_mch_init_font(NULL, FALSE);
    }

    if (ret == OK)
    {
#ifndef HAVE_GTK2
        /* Set normal font as current font */
# ifdef FEAT_XFONTSET
        if (gui.fontset != NOFONTSET)
            gui_mch_set_fontset(gui.fontset);
        else
# endif
            gui_mch_set_font(gui.norm_font);
#endif
        gui_set_shellsize(FALSE,
#ifdef MSWIN
                TRUE
#else
                FALSE
#endif
                , RESIZE_BOTH);
    }

    return ret;
}

#if defined(FEAT_MBYTE) || defined(PROTO)
# ifndef HAVE_GTK2
/*
 * Try setting 'guifontwide' to a font twice as wide as "name".
 */
    static void
set_guifontwide(name)
    char_u      *name;
{
    int         i = 0;
    char_u      wide_name[FONTLEN + 10]; /* room for 2 * width and '*' */
    char_u      *wp = NULL;
    char_u      *p;
    GuiFont     font;

    wp = wide_name;
    for (p = name; *p != NUL; ++p)
    {
        *wp++ = *p;
        if (*p == '-')
        {
            ++i;
            if (i == 6)         /* font type: change "--" to "-*-" */
            {
                if (p[1] == '-')
                    *wp++ = '*';
            }
            else if (i == 12)   /* found the width */
            {
                ++p;
                i = getdigits(&p);
                if (i != 0)
                {
                    /* Double the width specification. */
                    sprintf((char *)wp, "%d%s", i * 2, p);
                    font = gui_mch_get_font(wide_name, FALSE);
                    if (font != NOFONT)
                    {
                        gui_mch_free_font(gui.wide_font);
                        gui.wide_font = font;
                        set_string_option_direct((char_u *)"gfw", -1,
                                                      wide_name, OPT_FREE, 0);
                    }
                }
                break;
            }
        }
    }
}
# endif /* !HAVE_GTK2 */

/*
 * Get the font for 'guifontwide'.
 * Return FAIL for an invalid font name.
 */
    int
gui_get_wide_font()
{
    GuiFont     font = NOFONT;
    char_u      font_name[FONTLEN];
    char_u      *p;

    if (!gui.in_use)        /* Can't allocate font yet, assume it's OK. */
        return OK;          /* Will give an error message later. */

    if (p_guifontwide != NULL && *p_guifontwide != NUL)
    {
        for (p = p_guifontwide; *p != NUL; )
        {
            /* Isolate one comma separated font name. */
            (void)copy_option_part(&p, font_name, FONTLEN, ",");
            font = gui_mch_get_font(font_name, FALSE);
            if (font != NOFONT)
                break;
        }
        if (font == NOFONT)
            return FAIL;
    }

    gui_mch_free_font(gui.wide_font);
#ifdef HAVE_GTK2
    /* Avoid unnecessary overhead if 'guifontwide' is equal to 'guifont'. */
    if (font != NOFONT && gui.norm_font != NOFONT
                         && pango_font_description_equal(font, gui.norm_font))
    {
        gui.wide_font = NOFONT;
        gui_mch_free_font(font);
    }
    else
#endif
        gui.wide_font = font;
    return OK;
}
#endif

    void
gui_set_cursor(row, col)
    int     row;
    int     col;
{
    gui.row = row;
    gui.col = col;
}

/*
 * gui_check_pos - check if the cursor is on the screen.
 */
    static void
gui_check_pos()
{
    if (gui.row >= screen_Rows)
        gui.row = screen_Rows - 1;
    if (gui.col >= screen_Columns)
        gui.col = screen_Columns - 1;
    if (gui.cursor_row >= screen_Rows || gui.cursor_col >= screen_Columns)
        gui.cursor_is_valid = FALSE;
}

/*
 * Redraw the cursor if necessary or when forced.
 * Careful: The contents of ScreenLines[] must match what is on the screen,
 * otherwise this goes wrong.  May need to call out_flush() first.
 */
    void
gui_update_cursor(force, clear_selection)
    int         force;          /* when TRUE, update even when not moved */
    int         clear_selection;/* clear selection under cursor */
{
    int         cur_width = 0;
    int         cur_height = 0;
    int         old_hl_mask;
    int         idx;
    int         id;
    guicolor_T  cfg, cbg, cc;   /* cursor fore-/background color */
    int         cattr;          /* cursor attributes */
    int         attr;
    attrentry_T *aep = NULL;

    /* Don't update the cursor when halfway busy scrolling or the screen size
     * doesn't match 'columns' and 'lines.  ScreenLines[] isn't valid then. */
    if (!can_update_cursor || screen_Columns != gui.num_cols
                                               || screen_Rows != gui.num_rows)
        return;

    gui_check_pos();
    if (!gui.cursor_is_valid || force
                    || gui.row != gui.cursor_row || gui.col != gui.cursor_col)
    {
        gui_undraw_cursor();
        if (gui.row < 0)
            return;
#ifdef USE_IM_CONTROL
        if (gui.row != gui.cursor_row || gui.col != gui.cursor_col)
            im_set_position(gui.row, gui.col);
#endif
        gui.cursor_row = gui.row;
        gui.cursor_col = gui.col;

        /* Only write to the screen after ScreenLines[] has been initialized */
        if (!screen_cleared || ScreenLines == NULL)
            return;

        /* Clear the selection if we are about to write over it */
        if (clear_selection)
            clip_may_clear_selection(gui.row, gui.row);
        /* Check that the cursor is inside the shell (resizing may have made
         * it invalid) */
        if (gui.row >= screen_Rows || gui.col >= screen_Columns)
            return;

        gui.cursor_is_valid = TRUE;

        /*
         * How the cursor is drawn depends on the current mode.
         */
        idx = get_shape_idx(FALSE);
        if (State & LANGMAP)
            id = shape_table[idx].id_lm;
        else
            id = shape_table[idx].id;

        /* get the colors and attributes for the cursor.  Default is inverted */
        cfg = INVALCOLOR;
        cbg = INVALCOLOR;
        cattr = HL_INVERSE;
        gui_mch_set_blinking(shape_table[idx].blinkwait,
                             shape_table[idx].blinkon,
                             shape_table[idx].blinkoff);
        if (id > 0)
        {
            cattr = syn_id2colors(id, &cfg, &cbg);
#if defined(USE_IM_CONTROL) || defined(FEAT_HANGULIN)
            {
                static int iid;
                guicolor_T fg, bg;

                if (
# ifdef HAVE_GTK2
                        preedit_get_status()
# else
                        im_get_status()
# endif
                        )
                {
                    iid = syn_name2id((char_u *)"CursorIM");
                    if (iid > 0)
                    {
                        syn_id2colors(iid, &fg, &bg);
                        if (bg != INVALCOLOR)
                            cbg = bg;
                        if (fg != INVALCOLOR)
                            cfg = fg;
                    }
                }
            }
#endif
        }

        /*
         * Get the attributes for the character under the cursor.
         * When no cursor color was given, use the character color.
         */
        attr = ScreenAttrs[LineOffset[gui.row] + gui.col];
        if (attr > HL_ALL)
            aep = syn_gui_attr2entry(attr);
        if (aep != NULL)
        {
            attr = aep->ae_attr;
            if (cfg == INVALCOLOR)
                cfg = ((attr & HL_INVERSE)  ? aep->ae_u.gui.bg_color
                                            : aep->ae_u.gui.fg_color);
            if (cbg == INVALCOLOR)
                cbg = ((attr & HL_INVERSE)  ? aep->ae_u.gui.fg_color
                                            : aep->ae_u.gui.bg_color);
        }
        if (cfg == INVALCOLOR)
            cfg = (attr & HL_INVERSE) ? gui.back_pixel : gui.norm_pixel;
        if (cbg == INVALCOLOR)
            cbg = (attr & HL_INVERSE) ? gui.norm_pixel : gui.back_pixel;

#ifdef FEAT_XIM
        if (aep != NULL)
        {
            xim_bg_color = ((attr & HL_INVERSE) ? aep->ae_u.gui.fg_color
                                                : aep->ae_u.gui.bg_color);
            xim_fg_color = ((attr & HL_INVERSE) ? aep->ae_u.gui.bg_color
                                                : aep->ae_u.gui.fg_color);
            if (xim_bg_color == INVALCOLOR)
                xim_bg_color = (attr & HL_INVERSE) ? gui.norm_pixel
                                                   : gui.back_pixel;
            if (xim_fg_color == INVALCOLOR)
                xim_fg_color = (attr & HL_INVERSE) ? gui.back_pixel
                                                   : gui.norm_pixel;
        }
        else
        {
            xim_bg_color = (attr & HL_INVERSE) ? gui.norm_pixel
                                               : gui.back_pixel;
            xim_fg_color = (attr & HL_INVERSE) ? gui.back_pixel
                                               : gui.norm_pixel;
        }
#endif

        attr &= ~HL_INVERSE;
        if (cattr & HL_INVERSE)
        {
            cc = cbg;
            cbg = cfg;
            cfg = cc;
        }
        cattr &= ~HL_INVERSE;

        /*
         * When we don't have window focus, draw a hollow cursor.
         */
        if (!gui.in_focus)
        {
            gui_mch_draw_hollow_cursor(cbg);
            return;
        }

        old_hl_mask = gui.highlight_mask;
        if (shape_table[idx].shape == SHAPE_BLOCK
#ifdef FEAT_HANGULIN
                || composing_hangul
#endif
           )
        {
            /*
             * Draw the text character with the cursor colors.  Use the
             * character attributes plus the cursor attributes.
             */
            gui.highlight_mask = (cattr | attr);
#ifdef FEAT_HANGULIN
            if (composing_hangul)
                (void)gui_outstr_nowrap(composing_hangul_buffer, 2,
                        GUI_MON_IS_CURSOR | GUI_MON_NOCLEAR, cfg, cbg, 0);
            else
#endif
                (void)gui_screenchar(LineOffset[gui.row] + gui.col,
                        GUI_MON_IS_CURSOR | GUI_MON_NOCLEAR, cfg, cbg, 0);
        }
        else
        {
#if defined(FEAT_MBYTE) && defined(FEAT_RIGHTLEFT)
            int     col_off = FALSE;
#endif
            /*
             * First draw the partial cursor, then overwrite with the text
             * character, using a transparent background.
             */
            if (shape_table[idx].shape == SHAPE_VER)
            {
                cur_height = gui.char_height;
                cur_width = (gui.char_width * shape_table[idx].percentage
                                                                  + 99) / 100;
            }
            else
            {
                cur_height = (gui.char_height * shape_table[idx].percentage
                                                                  + 99) / 100;
                cur_width = gui.char_width;
            }
#ifdef FEAT_MBYTE
            if (has_mbyte && (*mb_off2cells)(LineOffset[gui.row] + gui.col,
                                    LineOffset[gui.row] + screen_Columns) > 1)
            {
                /* Double wide character. */
                if (shape_table[idx].shape != SHAPE_VER)
                    cur_width += gui.char_width;
# ifdef FEAT_RIGHTLEFT
                if (CURSOR_BAR_RIGHT)
                {
                    /* gui.col points to the left halve of the character but
                     * the vertical line needs to be on the right halve.
                     * A double-wide horizontal line is also drawn from the
                     * right halve in gui_mch_draw_part_cursor(). */
                    col_off = TRUE;
                    ++gui.col;
                }
# endif
            }
#endif
            gui_mch_draw_part_cursor(cur_width, cur_height, cbg);
#if defined(FEAT_MBYTE) && defined(FEAT_RIGHTLEFT)
            if (col_off)
                --gui.col;
#endif

#ifndef FEAT_GUI_MSWIN      /* doesn't seem to work for MSWindows */
            gui.highlight_mask = ScreenAttrs[LineOffset[gui.row] + gui.col];
            (void)gui_screenchar(LineOffset[gui.row] + gui.col,
                    GUI_MON_TRS_CURSOR | GUI_MON_NOCLEAR,
                    (guicolor_T)0, (guicolor_T)0, 0);
#endif
        }
        gui.highlight_mask = old_hl_mask;
    }
}

#if defined(FEAT_MENU) || defined(PROTO)
    void
gui_position_menu()
{
# if !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MOTIF)
    if (gui.menu_is_active && gui.in_use)
        gui_mch_set_menu_pos(0, 0, gui.menu_width, gui.menu_height);
# endif
}
#endif

/*
 * Position the various GUI components (text area, menu).  The vertical
 * scrollbars are NOT handled here.  See gui_update_scrollbars().
 */
    static void
gui_position_components(total_width)
    int     total_width UNUSED;
{
    int     text_area_x;
    int     text_area_y;
    int     text_area_width;
    int     text_area_height;

    /* avoid that moving components around generates events */
    ++hold_gui_events;

    text_area_x = 0;
    if (gui.which_scrollbars[SBAR_LEFT])
        text_area_x += gui.scrollbar_width;

    text_area_y = 0;
#if defined(FEAT_MENU) && !(defined(FEAT_GUI_GTK) || defined(FEAT_GUI_PHOTON))
    gui.menu_width = total_width;
    if (gui.menu_is_active)
        text_area_y += gui.menu_height;
#endif
#if defined(FEAT_TOOLBAR) && defined(FEAT_GUI_MSWIN)
    if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
        text_area_y = TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT;
#endif

# if defined(FEAT_GUI_TABLINE) && (defined(FEAT_GUI_MSWIN) \
        || defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_MAC))
    if (gui_has_tabline())
        text_area_y += gui.tabline_height;
#endif

#if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MOTIF) || defined(FEAT_GUI_ATHENA))
    if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
    {
# ifdef FEAT_GUI_ATHENA
        gui_mch_set_toolbar_pos(0, text_area_y,
                                gui.menu_width, gui.toolbar_height);
# endif
        text_area_y += gui.toolbar_height;
    }
#endif

    text_area_width = gui.num_cols * gui.char_width + gui.border_offset * 2;
    text_area_height = gui.num_rows * gui.char_height + gui.border_offset * 2;

    gui_mch_set_text_area_pos(text_area_x,
                              text_area_y,
                              text_area_width,
                              text_area_height
#if defined(FEAT_XIM) && !defined(HAVE_GTK2)
                                  + xim_get_status_area_height()
#endif
                              );
#ifdef FEAT_MENU
    gui_position_menu();
#endif
    if (gui.which_scrollbars[SBAR_BOTTOM])
        gui_mch_set_scrollbar_pos(&gui.bottom_sbar,
                                  text_area_x,
                                  text_area_y + text_area_height,
                                  text_area_width,
                                  gui.scrollbar_height);
    gui.left_sbar_x = 0;
    gui.right_sbar_x = text_area_x + text_area_width;

    --hold_gui_events;
}

/*
 * Get the width of the widgets and decorations to the side of the text area.
 */
    int
gui_get_base_width()
{
    int     base_width;

    base_width = 2 * gui.border_offset;
    if (gui.which_scrollbars[SBAR_LEFT])
        base_width += gui.scrollbar_width;
    if (gui.which_scrollbars[SBAR_RIGHT])
        base_width += gui.scrollbar_width;
    return base_width;
}

/*
 * Get the height of the widgets and decorations above and below the text area.
 */
    int
gui_get_base_height()
{
    int     base_height;

    base_height = 2 * gui.border_offset;
    if (gui.which_scrollbars[SBAR_BOTTOM])
        base_height += gui.scrollbar_height;
#ifdef FEAT_GUI_GTK
    /* We can't take the sizes properly into account until anything is
     * realized.  Therefore we recalculate all the values here just before
     * setting the size. (--mdcki) */
#else
# ifdef FEAT_MENU
    if (gui.menu_is_active)
        base_height += gui.menu_height;
# endif
# ifdef FEAT_TOOLBAR
    if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
#  if defined(FEAT_GUI_MSWIN) && defined(FEAT_TOOLBAR)
        base_height += (TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT);
#  else
        base_height += gui.toolbar_height;
#  endif
# endif
# if defined(FEAT_GUI_TABLINE) && (defined(FEAT_GUI_MSWIN) \
        || defined(FEAT_GUI_MOTIF))
    if (gui_has_tabline())
        base_height += gui.tabline_height;
# endif
# ifdef FEAT_FOOTER
    if (vim_strchr(p_go, GO_FOOTER) != NULL)
        base_height += gui.footer_height;
# endif
# if defined(FEAT_GUI_MOTIF) && defined(FEAT_MENU)
    base_height += gui_mch_text_area_extra_height();
# endif
#endif
    return base_height;
}

/*
 * Should be called after the GUI shell has been resized.  Its arguments are
 * the new width and height of the shell in pixels.
 */
    void
gui_resize_shell(pixel_width, pixel_height)
    int         pixel_width;
    int         pixel_height;
{
    static int  busy = FALSE;

    if (!gui.shell_created)         /* ignore when still initializing */
        return;

    /*
     * Can't resize the screen while it is being redrawn.  Remember the new
     * size and handle it later.
     */
    if (updating_screen || busy)
    {
        new_pixel_width = pixel_width;
        new_pixel_height = pixel_height;
        return;
    }

again:
    busy = TRUE;

    /* Flush pending output before redrawing */
    out_flush();

    gui.num_cols = (pixel_width - gui_get_base_width()) / gui.char_width;
    gui.num_rows = (pixel_height - gui_get_base_height()) / gui.char_height;

    gui_position_components(pixel_width);

    gui_reset_scroll_region();
    /*
     * At the "more" and ":confirm" prompt there is no redraw, put the cursor
     * at the last line here (why does it have to be one row too low?).
     */
    if (State == ASKMORE || State == CONFIRM)
        gui.row = gui.num_rows;

    /* Only comparing Rows and Columns may be sufficient, but let's stay on
     * the safe side. */
    if (gui.num_rows != screen_Rows || gui.num_cols != screen_Columns
            || gui.num_rows != Rows || gui.num_cols != Columns)
        shell_resized();

    gui_update_scrollbars(TRUE);
    gui_update_cursor(FALSE, TRUE);
#if defined(FEAT_XIM) && !defined(HAVE_GTK2)
    xim_set_status_area();
#endif

    busy = FALSE;

    /*
     * We could have been called again while redrawing the screen.
     * Need to do it all again with the latest size then.
     */
    if (new_pixel_height)
    {
        pixel_width = new_pixel_width;
        pixel_height = new_pixel_height;
        new_pixel_width = 0;
        new_pixel_height = 0;
        goto again;
    }
}

/*
 * Check if gui_resize_shell() must be called.
 */
    void
gui_may_resize_shell()
{
    int         h, w;

    if (new_pixel_height)
    {
        /* careful: gui_resize_shell() may postpone the resize again if we
         * were called indirectly by it */
        w = new_pixel_width;
        h = new_pixel_height;
        new_pixel_width = 0;
        new_pixel_height = 0;
        gui_resize_shell(w, h);
    }
}

    int
gui_get_shellsize()
{
    Rows = gui.num_rows;
    Columns = gui.num_cols;
    return OK;
}

/*
 * Set the size of the Vim shell according to Rows and Columns.
 * If "fit_to_display" is TRUE then the size may be reduced to fit the window
 * on the screen.
 */
    void
gui_set_shellsize(mustset, fit_to_display, direction)
    int         mustset UNUSED;         /* set by the user */
    int         fit_to_display;
    int         direction;              /* RESIZE_HOR, RESIZE_VER */
{
    int         base_width;
    int         base_height;
    int         width;
    int         height;
    int         min_width;
    int         min_height;
    int         screen_w;
    int         screen_h;

    if (!gui.shell_created)
        return;

#ifdef MSWIN
    /* If not setting to a user specified size and maximized, calculate the
     * number of characters that fit in the maximized window. */
    if (!mustset && gui_mch_maximized())
    {
        gui_mch_newfont();
        return;
    }
#endif

    base_width = gui_get_base_width();
    base_height = gui_get_base_height();
#ifdef USE_SUN_WORKSHOP
    if (!mustset && usingSunWorkShop
                                && workshop_get_width_height(&width, &height))
    {
        Columns = (width - base_width + gui.char_width - 1) / gui.char_width;
        Rows = (height - base_height + gui.char_height - 1) / gui.char_height;
    }
    else
#endif
    {
        width = Columns * gui.char_width + base_width;
        height = Rows * gui.char_height + base_height;
    }

    if (fit_to_display)
    {
        gui_mch_get_screen_dimensions(&screen_w, &screen_h);
        if ((direction & RESIZE_HOR) && width > screen_w)
        {
            Columns = (screen_w - base_width) / gui.char_width;
            if (Columns < MIN_COLUMNS)
                Columns = MIN_COLUMNS;
            width = Columns * gui.char_width + base_width;
        }
        if ((direction & RESIZE_VERT) && height > screen_h)
        {
            Rows = (screen_h - base_height) / gui.char_height;
            check_shellsize();
            height = Rows * gui.char_height + base_height;
        }
    }
    gui.num_cols = Columns;
    gui.num_rows = Rows;

    min_width = base_width + MIN_COLUMNS * gui.char_width;
    min_height = base_height + MIN_LINES * gui.char_height;
# ifdef FEAT_WINDOWS
    min_height += tabline_height() * gui.char_height;
# endif

    gui_mch_set_shellsize(width, height, min_width, min_height,
                                          base_width, base_height, direction);
    if (fit_to_display)
    {
        int         x, y;

        /* Some window managers put the Vim window left of/above the screen. */
        gui_mch_update();
        if (gui_mch_get_winpos(&x, &y) == OK && (x < 0 || y < 0))
            gui_mch_set_winpos(x < 0 ? 0 : x, y < 0 ? 0 : y);
    }

    gui_position_components(width);
    gui_update_scrollbars(TRUE);
    gui_reset_scroll_region();
}

/*
 * Called when Rows and/or Columns has changed.
 */
    void
gui_new_shellsize()
{
    gui_reset_scroll_region();
}

/*
 * Make scroll region cover whole screen.
 */
    void
gui_reset_scroll_region()
{
    gui.scroll_region_top = 0;
    gui.scroll_region_bot = gui.num_rows - 1;
    gui.scroll_region_left = 0;
    gui.scroll_region_right = gui.num_cols - 1;
}

    void
gui_start_highlight(mask)
    int     mask;
{
    if (mask > HL_ALL)              /* highlight code */
        gui.highlight_mask = mask;
    else                            /* mask */
        gui.highlight_mask |= mask;
}

    void
gui_stop_highlight(mask)
    int     mask;
{
    if (mask > HL_ALL)              /* highlight code */
        gui.highlight_mask = HL_NORMAL;
    else                            /* mask */
        gui.highlight_mask &= ~mask;
}

/*
 * Clear a rectangular region of the screen from text pos (row1, col1) to
 * (row2, col2) inclusive.
 */
    void
gui_clear_block(row1, col1, row2, col2)
    int     row1;
    int     col1;
    int     row2;
    int     col2;
{
    /* Clear the selection if we are about to write over it */
    clip_may_clear_selection(row1, row2);

    gui_mch_clear_block(row1, col1, row2, col2);

    /* Invalidate cursor if it was in this block */
    if (       gui.cursor_row >= row1 && gui.cursor_row <= row2
            && gui.cursor_col >= col1 && gui.cursor_col <= col2)
        gui.cursor_is_valid = FALSE;
}

/*
 * Write code to update the cursor later.  This avoids the need to flush the
 * output buffer before calling gui_update_cursor().
 */
    void
gui_update_cursor_later()
{
    OUT_STR(IF_EB("\033|s", ESC_STR "|s"));
}

    void
gui_write(s, len)
    char_u      *s;
    int         len;
{
    char_u      *p;
    int         arg1 = 0, arg2 = 0;
    /* this doesn't make sense, disabled until someone can explain why it
     * would be needed */
#if 0 && (defined(RISCOS) || defined(WIN16))
    int         force_cursor = TRUE;    /* JK230798, stop Vim being smart or
                                           our redraw speed will suffer */
#else
    int         force_cursor = FALSE;   /* force cursor update */
#endif
    int         force_scrollbar = FALSE;
    static win_T        *old_curwin = NULL;

/* #define DEBUG_GUI_WRITE */
#ifdef DEBUG_GUI_WRITE
    {
        int i;
        char_u *str;

        printf("gui_write(%d):\n    ", len);
        for (i = 0; i < len; i++)
            if (s[i] == ESC)
            {
                if (i != 0)
                    printf("\n    ");
                printf("<ESC>");
            }
            else
            {
                str = transchar_byte(s[i]);
                if (str[0] && str[1])
                    printf("<%s>", (char *)str);
                else
                    printf("%s", (char *)str);
            }
        printf("\n");
    }
#endif
    while (len)
    {
        if (s[0] == ESC && s[1] == '|')
        {
            p = s + 2;
            if (VIM_ISDIGIT(*p))
            {
                arg1 = getdigits(&p);
                if (p > s + len)
                    break;
                if (*p == ';')
                {
                    ++p;
                    arg2 = getdigits(&p);
                    if (p > s + len)
                        break;
                }
            }
            switch (*p)
            {
                case 'C':       /* Clear screen */
                    clip_scroll_selection(9999);
                    gui_mch_clear_all();
                    gui.cursor_is_valid = FALSE;
                    force_scrollbar = TRUE;
                    break;
                case 'M':       /* Move cursor */
                    gui_set_cursor(arg1, arg2);
                    break;
                case 's':       /* force cursor (shape) update */
                    force_cursor = TRUE;
                    break;
                case 'R':       /* Set scroll region */
                    if (arg1 < arg2)
                    {
                        gui.scroll_region_top = arg1;
                        gui.scroll_region_bot = arg2;
                    }
                    else
                    {
                        gui.scroll_region_top = arg2;
                        gui.scroll_region_bot = arg1;
                    }
                    break;
#ifdef FEAT_VERTSPLIT
                case 'V':       /* Set vertical scroll region */
                    if (arg1 < arg2)
                    {
                        gui.scroll_region_left = arg1;
                        gui.scroll_region_right = arg2;
                    }
                    else
                    {
                        gui.scroll_region_left = arg2;
                        gui.scroll_region_right = arg1;
                    }
                    break;
#endif
                case 'd':       /* Delete line */
                    gui_delete_lines(gui.row, 1);
                    break;
                case 'D':       /* Delete lines */
                    gui_delete_lines(gui.row, arg1);
                    break;
                case 'i':       /* Insert line */
                    gui_insert_lines(gui.row, 1);
                    break;
                case 'I':       /* Insert lines */
                    gui_insert_lines(gui.row, arg1);
                    break;
                case '$':       /* Clear to end-of-line */
                    gui_clear_block(gui.row, gui.col, gui.row,
                                                            (int)Columns - 1);
                    break;
                case 'h':       /* Turn on highlighting */
                    gui_start_highlight(arg1);
                    break;
                case 'H':       /* Turn off highlighting */
                    gui_stop_highlight(arg1);
                    break;
                case 'f':       /* flash the window (visual bell) */
                    gui_mch_flash(arg1 == 0 ? 20 : arg1);
                    break;
                default:
                    p = s + 1;  /* Skip the ESC */
                    break;
            }
            len -= (int)(++p - s);
            s = p;
        }
        else if (
#ifdef EBCDIC
                CtrlChar(s[0]) != 0     /* Ctrl character */
#else
                s[0] < 0x20             /* Ctrl character */
#endif
#ifdef FEAT_SIGN_ICONS
                && s[0] != SIGN_BYTE
# ifdef FEAT_NETBEANS_INTG
                && s[0] != MULTISIGN_BYTE
# endif
#endif
                )
        {
            if (s[0] == '\n')           /* NL */
            {
                gui.col = 0;
                if (gui.row < gui.scroll_region_bot)
                    gui.row++;
                else
                    gui_delete_lines(gui.scroll_region_top, 1);
            }
            else if (s[0] == '\r')      /* CR */
            {
                gui.col = 0;
            }
            else if (s[0] == '\b')      /* Backspace */
            {
                if (gui.col)
                    --gui.col;
            }
            else if (s[0] == Ctrl_L)    /* cursor-right */
            {
                ++gui.col;
            }
            else if (s[0] == Ctrl_G)    /* Beep */
            {
                gui_mch_beep();
            }
            /* Other Ctrl character: shouldn't happen! */

            --len;      /* Skip this char */
            ++s;
        }
        else
        {
            p = s;
            while (len > 0 && (
#ifdef EBCDIC
                        CtrlChar(*p) == 0
#else
                        *p >= 0x20
#endif
#ifdef FEAT_SIGN_ICONS
                        || *p == SIGN_BYTE
# ifdef FEAT_NETBEANS_INTG
                        || *p == MULTISIGN_BYTE
# endif
#endif
                        ))
            {
                len--;
                p++;
            }
            gui_outstr(s, (int)(p - s));
            s = p;
        }
    }

    /* Postponed update of the cursor (won't work if "can_update_cursor" isn't
     * set). */
    if (force_cursor)
        gui_update_cursor(TRUE, TRUE);

    /* When switching to another window the dragging must have stopped.
     * Required for GTK, dragged_sb isn't reset. */
    if (old_curwin != curwin)
        gui.dragged_sb = SBAR_NONE;

    /* Update the scrollbars after clearing the screen or when switched
     * to another window.
     * Update the horizontal scrollbar always, it's difficult to check all
     * situations where it might change. */
    if (force_scrollbar || old_curwin != curwin)
        gui_update_scrollbars(force_scrollbar);
    else
        gui_update_horiz_scrollbar(FALSE);
    old_curwin = curwin;

    /*
     * We need to make sure this is cleared since Athena doesn't tell us when
     * he is done dragging.  Do the same for GTK.
     */
#if defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_GTK)
    gui.dragged_sb = SBAR_NONE;
#endif

    gui_mch_flush();                /* In case vim decides to take a nap */
}

/*
 * When ScreenLines[] is invalid, updating the cursor should not be done, it
 * produces wrong results.  Call gui_dont_update_cursor() before that code and
 * gui_can_update_cursor() afterwards.
 */
    void
gui_dont_update_cursor()
{
    if (gui.in_use)
    {
        /* Undraw the cursor now, we probably can't do it after the change. */
        gui_undraw_cursor();
        can_update_cursor = FALSE;
    }
}

    void
gui_can_update_cursor()
{
    can_update_cursor = TRUE;
    /* No need to update the cursor right now, there is always more output
     * after scrolling. */
}

    static void
gui_outstr(s, len)
    char_u  *s;
    int     len;
{
    int     this_len;
#ifdef FEAT_MBYTE
    int     cells;
#endif

    if (len == 0)
        return;

    if (len < 0)
        len = (int)STRLEN(s);

    while (len > 0)
    {
#ifdef FEAT_MBYTE
        if (has_mbyte)
        {
            /* Find out how many chars fit in the current line. */
            cells = 0;
            for (this_len = 0; this_len < len; )
            {
                cells += (*mb_ptr2cells)(s + this_len);
                if (gui.col + cells > Columns)
                    break;
                this_len += (*mb_ptr2len)(s + this_len);
            }
            if (this_len > len)
                this_len = len;     /* don't include following composing char */
        }
        else
#endif
            if (gui.col + len > Columns)
            this_len = Columns - gui.col;
        else
            this_len = len;

        (void)gui_outstr_nowrap(s, this_len,
                                          0, (guicolor_T)0, (guicolor_T)0, 0);
        s += this_len;
        len -= this_len;
#ifdef FEAT_MBYTE
        /* fill up for a double-width char that doesn't fit. */
        if (len > 0 && gui.col < Columns)
            (void)gui_outstr_nowrap((char_u *)" ", 1,
                                          0, (guicolor_T)0, (guicolor_T)0, 0);
#endif
        /* The cursor may wrap to the next line. */
        if (gui.col >= Columns)
        {
            gui.col = 0;
            gui.row++;
        }
    }
}

/*
 * Output one character (may be one or two display cells).
 * Caller must check for valid "off".
 * Returns FAIL or OK, just like gui_outstr_nowrap().
 */
    static int
gui_screenchar(off, flags, fg, bg, back)
    int         off;        /* Offset from start of screen */
    int         flags;
    guicolor_T  fg, bg;     /* colors for cursor */
    int         back;       /* backup this many chars when using bold trick */
{
#ifdef FEAT_MBYTE
    char_u      buf[MB_MAXBYTES + 1];

    /* Don't draw right halve of a double-width UTF-8 char. "cannot happen" */
    if (enc_utf8 && ScreenLines[off] == 0)
        return OK;

    if (enc_utf8 && ScreenLinesUC[off] != 0)
        /* Draw UTF-8 multi-byte character. */
        return gui_outstr_nowrap(buf, utfc_char2bytes(off, buf),
                                                         flags, fg, bg, back);

    if (enc_dbcs == DBCS_JPNU && ScreenLines[off] == 0x8e)
    {
        buf[0] = ScreenLines[off];
        buf[1] = ScreenLines2[off];
        return gui_outstr_nowrap(buf, 2, flags, fg, bg, back);
    }

    /* Draw non-multi-byte character or DBCS character. */
    return gui_outstr_nowrap(ScreenLines + off,
            enc_dbcs ? (*mb_ptr2len)(ScreenLines + off) : 1,
                                                         flags, fg, bg, back);
#else
    return gui_outstr_nowrap(ScreenLines + off, 1, flags, fg, bg, back);
#endif
}

#ifdef HAVE_GTK2
/*
 * Output the string at the given screen position.  This is used in place
 * of gui_screenchar() where possible because Pango needs as much context
 * as possible to work nicely.  It's a lot faster as well.
 */
    static int
gui_screenstr(off, len, flags, fg, bg, back)
    int         off;        /* Offset from start of screen */
    int         len;        /* string length in screen cells */
    int         flags;
    guicolor_T  fg, bg;     /* colors for cursor */
    int         back;       /* backup this many chars when using bold trick */
{
    char_u  *buf;
    int     outlen = 0;
    int     i;
    int     retval;

    if (len <= 0) /* "cannot happen"? */
        return OK;

    if (enc_utf8)
    {
        buf = alloc((unsigned)(len * MB_MAXBYTES + 1));
        if (buf == NULL)
            return OK; /* not much we could do here... */

        for (i = off; i < off + len; ++i)
        {
            if (ScreenLines[i] == 0)
                continue; /* skip second half of double-width char */

            if (ScreenLinesUC[i] == 0)
                buf[outlen++] = ScreenLines[i];
            else
                outlen += utfc_char2bytes(i, buf + outlen);
        }

        buf[outlen] = NUL; /* only to aid debugging */
        retval = gui_outstr_nowrap(buf, outlen, flags, fg, bg, back);
        vim_free(buf);

        return retval;
    }
    else if (enc_dbcs == DBCS_JPNU)
    {
        buf = alloc((unsigned)(len * 2 + 1));
        if (buf == NULL)
            return OK; /* not much we could do here... */

        for (i = off; i < off + len; ++i)
        {
            buf[outlen++] = ScreenLines[i];

            /* handle double-byte single-width char */
            if (ScreenLines[i] == 0x8e)
                buf[outlen++] = ScreenLines2[i];
            else if (MB_BYTE2LEN(ScreenLines[i]) == 2)
                buf[outlen++] = ScreenLines[++i];
        }

        buf[outlen] = NUL; /* only to aid debugging */
        retval = gui_outstr_nowrap(buf, outlen, flags, fg, bg, back);
        vim_free(buf);

        return retval;
    }
    else
    {
        return gui_outstr_nowrap(&ScreenLines[off], len,
                                 flags, fg, bg, back);
    }
}
#endif /* HAVE_GTK2 */

/*
 * Output the given string at the current cursor position.  If the string is
 * too long to fit on the line, then it is truncated.
 * "flags":
 * GUI_MON_IS_CURSOR should only be used when this function is being called to
 * actually draw (an inverted) cursor.
 * GUI_MON_TRS_CURSOR is used to draw the cursor text with a transparent
 * background.
 * GUI_MON_NOCLEAR is used to avoid clearing the selection when drawing over
 * it.
 * Returns OK, unless "back" is non-zero and using the bold trick, then return
 * FAIL (the caller should start drawing "back" chars back).
 */
    int
gui_outstr_nowrap(s, len, flags, fg, bg, back)
    char_u      *s;
    int         len;
    int         flags;
    guicolor_T  fg, bg;     /* colors for cursor */
    int         back;       /* backup this many chars when using bold trick */
{
    long_u      highlight_mask;
    long_u      hl_mask_todo;
    guicolor_T  fg_color;
    guicolor_T  bg_color;
    guicolor_T  sp_color;
#if !defined(MSWIN16_FASTTEXT) && !defined(HAVE_GTK2)
    GuiFont     font = NOFONT;
# ifdef FEAT_XFONTSET
    GuiFontset  fontset = NOFONTSET;
# endif
#endif
    attrentry_T *aep = NULL;
    int         draw_flags;
    int         col = gui.col;
#ifdef FEAT_SIGN_ICONS
    int         draw_sign = FALSE;
# ifdef FEAT_NETBEANS_INTG
    int         multi_sign = FALSE;
# endif
#endif

    if (len < 0)
        len = (int)STRLEN(s);
    if (len == 0)
        return OK;

#ifdef FEAT_SIGN_ICONS
    if (*s == SIGN_BYTE
# ifdef FEAT_NETBEANS_INTG
          || *s == MULTISIGN_BYTE
# endif
    )
    {
# ifdef FEAT_NETBEANS_INTG
        if (*s == MULTISIGN_BYTE)
            multi_sign = TRUE;
# endif
        /* draw spaces instead */
        s = (char_u *)"  ";
        if (len == 1 && col > 0)
            --col;
        len = 2;
        draw_sign = TRUE;
        highlight_mask = 0;
    }
    else
#endif
    if (gui.highlight_mask > HL_ALL)
    {
        aep = syn_gui_attr2entry(gui.highlight_mask);
        if (aep == NULL)            /* highlighting not set */
            highlight_mask = 0;
        else
            highlight_mask = aep->ae_attr;
    }
    else
        highlight_mask = gui.highlight_mask;
    hl_mask_todo = highlight_mask;

#if !defined(MSWIN16_FASTTEXT) && !defined(HAVE_GTK2)
    /* Set the font */
    if (aep != NULL && aep->ae_u.gui.font != NOFONT)
        font = aep->ae_u.gui.font;
# ifdef FEAT_XFONTSET
    else if (aep != NULL && aep->ae_u.gui.fontset != NOFONTSET)
        fontset = aep->ae_u.gui.fontset;
# endif
    else
    {
# ifdef FEAT_XFONTSET
        if (gui.fontset != NOFONTSET)
            fontset = gui.fontset;
        else
# endif
            if (hl_mask_todo & (HL_BOLD | HL_STANDOUT))
        {
            if ((hl_mask_todo & HL_ITALIC) && gui.boldital_font != NOFONT)
            {
                font = gui.boldital_font;
                hl_mask_todo &= ~(HL_BOLD | HL_STANDOUT | HL_ITALIC);
            }
            else if (gui.bold_font != NOFONT)
            {
                font = gui.bold_font;
                hl_mask_todo &= ~(HL_BOLD | HL_STANDOUT);
            }
            else
                font = gui.norm_font;
        }
        else if ((hl_mask_todo & HL_ITALIC) && gui.ital_font != NOFONT)
        {
            font = gui.ital_font;
            hl_mask_todo &= ~HL_ITALIC;
        }
        else
            font = gui.norm_font;
    }
# ifdef FEAT_XFONTSET
    if (fontset != NOFONTSET)
        gui_mch_set_fontset(fontset);
    else
# endif
        gui_mch_set_font(font);
#endif

    draw_flags = 0;

    /* Set the color */
    bg_color = gui.back_pixel;
    if ((flags & GUI_MON_IS_CURSOR) && gui.in_focus)
    {
        draw_flags |= DRAW_CURSOR;
        fg_color = fg;
        bg_color = bg;
        sp_color = fg;
    }
    else if (aep != NULL)
    {
        fg_color = aep->ae_u.gui.fg_color;
        if (fg_color == INVALCOLOR)
            fg_color = gui.norm_pixel;
        bg_color = aep->ae_u.gui.bg_color;
        if (bg_color == INVALCOLOR)
            bg_color = gui.back_pixel;
        sp_color = aep->ae_u.gui.sp_color;
        if (sp_color == INVALCOLOR)
            sp_color = fg_color;
    }
    else
    {
        fg_color = gui.norm_pixel;
        sp_color = fg_color;
    }

    if (highlight_mask & (HL_INVERSE | HL_STANDOUT))
    {
#if defined(AMIGA) || defined(RISCOS)
        gui_mch_set_colors(bg_color, fg_color);
#else
        gui_mch_set_fg_color(bg_color);
        gui_mch_set_bg_color(fg_color);
#endif
    }
    else
    {
#if defined(AMIGA) || defined(RISCOS)
        gui_mch_set_colors(fg_color, bg_color);
#else
        gui_mch_set_fg_color(fg_color);
        gui_mch_set_bg_color(bg_color);
#endif
    }
    gui_mch_set_sp_color(sp_color);

    /* Clear the selection if we are about to write over it */
    if (!(flags & GUI_MON_NOCLEAR))
        clip_may_clear_selection(gui.row, gui.row);


#ifndef MSWIN16_FASTTEXT
    /* If there's no bold font, then fake it */
    if (hl_mask_todo & (HL_BOLD | HL_STANDOUT))
        draw_flags |= DRAW_BOLD;
#endif

    /*
     * When drawing bold or italic characters the spill-over from the left
     * neighbor may be destroyed.  Let the caller backup to start redrawing
     * just after a blank.
     */
    if (back != 0 && ((draw_flags & DRAW_BOLD) || (highlight_mask & HL_ITALIC)))
        return FAIL;

#if defined(RISCOS) || defined(HAVE_GTK2)
    /* If there's no italic font, then fake it.
     * For GTK2, we don't need a different font for italic style. */
    if (hl_mask_todo & HL_ITALIC)
        draw_flags |= DRAW_ITALIC;

    /* Do we underline the text? */
    if (hl_mask_todo & HL_UNDERLINE)
        draw_flags |= DRAW_UNDERL;
#else
    /* Do we underline the text? */
    if ((hl_mask_todo & HL_UNDERLINE)
# ifndef MSWIN16_FASTTEXT
            || (hl_mask_todo & HL_ITALIC)
# endif
       )
        draw_flags |= DRAW_UNDERL;
#endif
    /* Do we undercurl the text? */
    if (hl_mask_todo & HL_UNDERCURL)
        draw_flags |= DRAW_UNDERC;

    /* Do we draw transparently? */
    if (flags & GUI_MON_TRS_CURSOR)
        draw_flags |= DRAW_TRANSP;

    /*
     * Draw the text.
     */
#ifdef HAVE_GTK2
    /* The value returned is the length in display cells */
    len = gui_gtk2_draw_string(gui.row, col, s, len, draw_flags);
#else
# ifdef FEAT_MBYTE
    if (enc_utf8)
    {
        int     start;          /* index of bytes to be drawn */
        int     cells;          /* cellwidth of bytes to be drawn */
        int     thislen;        /* length of bytes to be drawin */
        int     cn;             /* cellwidth of current char */
        int     i;              /* index of current char */
        int     c;              /* current char value */
        int     cl;             /* byte length of current char */
        int     comping;        /* current char is composing */
        int     scol = col;     /* screen column */
        int     dowide;         /* use 'guifontwide' */

        /* Break the string at a composing character, it has to be drawn on
         * top of the previous character. */
        start = 0;
        cells = 0;
        for (i = 0; i < len; i += cl)
        {
            c = utf_ptr2char(s + i);
            cn = utf_char2cells(c);
            if (cn > 1
#  ifdef FEAT_XFONTSET
                    && fontset == NOFONTSET
#  endif
                    && gui.wide_font != NOFONT)
                dowide = TRUE;
            else
                dowide = FALSE;
            comping = utf_iscomposing(c);
            if (!comping)       /* count cells from non-composing chars */
                cells += cn;
            cl = utf_ptr2len(s + i);
            if (cl == 0)        /* hit end of string */
                len = i + cl;   /* len must be wrong "cannot happen" */

            /* print the string so far if it's the last character or there is
             * a composing character. */
            if (i + cl >= len || (comping && i > start) || dowide
#  if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
                    || (cn > 1
#   ifdef FEAT_XFONTSET
                        /* No fontset: At least draw char after wide char at
                         * right position. */
                        && fontset == NOFONTSET
#   endif
                       )
#  endif
               )
            {
                if (comping || dowide)
                    thislen = i - start;
                else
                    thislen = i - start + cl;
                if (thislen > 0)
                {
                    gui_mch_draw_string(gui.row, scol, s + start, thislen,
                                                                  draw_flags);
                    start += thislen;
                }
                scol += cells;
                cells = 0;
                if (dowide)
                {
                    gui_mch_set_font(gui.wide_font);
                    gui_mch_draw_string(gui.row, scol - cn,
                                                   s + start, cl, draw_flags);
                    gui_mch_set_font(font);
                    start += cl;
                }

#  if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
                /* No fontset: draw a space to fill the gap after a wide char
                 * */
                if (cn > 1 && (draw_flags & DRAW_TRANSP) == 0
#   ifdef FEAT_XFONTSET
                        && fontset == NOFONTSET
#   endif
                        && !dowide)
                    gui_mch_draw_string(gui.row, scol - 1, (char_u *)" ",
                                                               1, draw_flags);
#  endif
            }
            /* Draw a composing char on top of the previous char. */
            if (comping)
            {
#  if (defined(__APPLE_CC__) || defined(__MRC__)) && TARGET_API_MAC_CARBON
                /* Carbon ATSUI autodraws composing char over previous char */
                gui_mch_draw_string(gui.row, scol, s + i, cl,
                                                    draw_flags | DRAW_TRANSP);
#  else
                gui_mch_draw_string(gui.row, scol - cn, s + i, cl,
                                                    draw_flags | DRAW_TRANSP);
#  endif
                start = i + cl;
            }
        }
        /* The stuff below assumes "len" is the length in screen columns. */
        len = scol - col;
    }
    else
# endif
    {
        gui_mch_draw_string(gui.row, col, s, len, draw_flags);
# ifdef FEAT_MBYTE
        if (enc_dbcs == DBCS_JPNU)
        {
            int         clen = 0;
            int         i;

            /* Get the length in display cells, this can be different from the
             * number of bytes for "euc-jp". */
            for (i = 0; i < len; i += (*mb_ptr2len)(s + i))
                clen += (*mb_ptr2cells)(s + i);
            len = clen;
        }
# endif
    }
#endif /* !HAVE_GTK2 */

    if (!(flags & (GUI_MON_IS_CURSOR | GUI_MON_TRS_CURSOR)))
        gui.col = col + len;

    /* May need to invert it when it's part of the selection. */
    if (flags & GUI_MON_NOCLEAR)
        clip_may_redraw_selection(gui.row, col, len);

    if (!(flags & (GUI_MON_IS_CURSOR | GUI_MON_TRS_CURSOR)))
    {
        /* Invalidate the old physical cursor position if we wrote over it */
        if (gui.cursor_row == gui.row
                && gui.cursor_col >= col
                && gui.cursor_col < col + len)
            gui.cursor_is_valid = FALSE;
    }

#ifdef FEAT_SIGN_ICONS
    if (draw_sign)
        /* Draw the sign on top of the spaces. */
        gui_mch_drawsign(gui.row, col, gui.highlight_mask);
# ifdef FEAT_NETBEANS_INTG
    if (multi_sign)
        netbeans_draw_multisign_indicator(gui.row);
# endif
#endif

    return OK;
}

/*
 * Un-draw the cursor.  Actually this just redraws the character at the given
 * position.  The character just before it too, for when it was in bold.
 */
    void
gui_undraw_cursor()
{
    if (gui.cursor_is_valid)
    {
#ifdef FEAT_HANGULIN
        if (composing_hangul
                    && gui.col == gui.cursor_col && gui.row == gui.cursor_row)
            (void)gui_outstr_nowrap(composing_hangul_buffer, 2,
                    GUI_MON_IS_CURSOR | GUI_MON_NOCLEAR,
                    gui.norm_pixel, gui.back_pixel, 0);
        else
        {
#endif
        if (gui_redraw_block(gui.cursor_row, gui.cursor_col,
                              gui.cursor_row, gui.cursor_col, GUI_MON_NOCLEAR)
                && gui.cursor_col > 0)
            (void)gui_redraw_block(gui.cursor_row, gui.cursor_col - 1,
                         gui.cursor_row, gui.cursor_col - 1, GUI_MON_NOCLEAR);
#ifdef FEAT_HANGULIN
            if (composing_hangul)
                (void)gui_redraw_block(gui.cursor_row, gui.cursor_col + 1,
                        gui.cursor_row, gui.cursor_col + 1, GUI_MON_NOCLEAR);
        }
#endif
        /* Cursor_is_valid is reset when the cursor is undrawn, also reset it
         * here in case it wasn't needed to undraw it. */
        gui.cursor_is_valid = FALSE;
    }
}

    void
gui_redraw(x, y, w, h)
    int         x;
    int         y;
    int         w;
    int         h;
{
    int         row1, col1, row2, col2;

    row1 = Y_2_ROW(y);
    col1 = X_2_COL(x);
    row2 = Y_2_ROW(y + h - 1);
    col2 = X_2_COL(x + w - 1);

    (void)gui_redraw_block(row1, col1, row2, col2, GUI_MON_NOCLEAR);

    /*
     * We may need to redraw the cursor, but don't take it upon us to change
     * its location after a scroll.
     * (maybe be more strict even and test col too?)
     * These things may be outside the update/clipping region and reality may
     * not reflect Vims internal ideas if these operations are clipped away.
     */
    if (gui.row == gui.cursor_row)
        gui_update_cursor(TRUE, TRUE);
}

/*
 * Draw a rectangular block of characters, from row1 to row2 (inclusive) and
 * from col1 to col2 (inclusive).
 * Return TRUE when the character before the first drawn character has
 * different attributes (may have to be redrawn too).
 */
    int
gui_redraw_block(row1, col1, row2, col2, flags)
    int         row1;
    int         col1;
    int         row2;
    int         col2;
    int         flags;  /* flags for gui_outstr_nowrap() */
{
    int         old_row, old_col;
    long_u      old_hl_mask;
    int         off;
    sattr_T     first_attr;
    int         idx, len;
    int         back, nback;
    int         retval = FALSE;
#ifdef FEAT_MBYTE
    int         orig_col1, orig_col2;
#endif

    /* Don't try to update when ScreenLines is not valid */
    if (!screen_cleared || ScreenLines == NULL)
        return retval;

    /* Don't try to draw outside the shell! */
    /* Check everything, strange values may be caused by a big border width */
    col1 = check_col(col1);
    col2 = check_col(col2);
    row1 = check_row(row1);
    row2 = check_row(row2);

    /* Remember where our cursor was */
    old_row = gui.row;
    old_col = gui.col;
    old_hl_mask = gui.highlight_mask;
#ifdef FEAT_MBYTE
    orig_col1 = col1;
    orig_col2 = col2;
#endif

    for (gui.row = row1; gui.row <= row2; gui.row++)
    {
#ifdef FEAT_MBYTE
        /* When only half of a double-wide character is in the block, include
         * the other half. */
        col1 = orig_col1;
        col2 = orig_col2;
        off = LineOffset[gui.row];
        if (enc_dbcs != 0)
        {
            if (col1 > 0)
                col1 -= dbcs_screen_head_off(ScreenLines + off,
                                                    ScreenLines + off + col1);
            col2 += dbcs_screen_tail_off(ScreenLines + off,
                                                    ScreenLines + off + col2);
        }
        else if (enc_utf8)
        {
            if (ScreenLines[off + col1] == 0)
                --col1;
# ifdef HAVE_GTK2
            if (col2 + 1 < Columns && ScreenLines[off + col2 + 1] == 0)
                ++col2;
# endif
        }
#endif
        gui.col = col1;
        off = LineOffset[gui.row] + gui.col;
        len = col2 - col1 + 1;

        /* Find how many chars back this highlighting starts, or where a space
         * is.  Needed for when the bold trick is used */
        for (back = 0; back < col1; ++back)
            if (ScreenAttrs[off - 1 - back] != ScreenAttrs[off]
                    || ScreenLines[off - 1 - back] == ' ')
                break;
        retval = (col1 > 0 && ScreenAttrs[off - 1] != 0 && back == 0
                                              && ScreenLines[off - 1] != ' ');

        /* Break it up in strings of characters with the same attributes. */
        /* Print UTF-8 characters individually. */
        while (len > 0)
        {
            first_attr = ScreenAttrs[off];
            gui.highlight_mask = first_attr;
#if defined(FEAT_MBYTE) && !defined(HAVE_GTK2)
            if (enc_utf8 && ScreenLinesUC[off] != 0)
            {
                /* output multi-byte character separately */
                nback = gui_screenchar(off, flags,
                                          (guicolor_T)0, (guicolor_T)0, back);
                if (gui.col < Columns && ScreenLines[off + 1] == 0)
                    idx = 2;
                else
                    idx = 1;
            }
            else if (enc_dbcs == DBCS_JPNU && ScreenLines[off] == 0x8e)
            {
                /* output double-byte, single-width character separately */
                nback = gui_screenchar(off, flags,
                                          (guicolor_T)0, (guicolor_T)0, back);
                idx = 1;
            }
            else
#endif
            {
#ifdef HAVE_GTK2
                for (idx = 0; idx < len; ++idx)
                {
                    if (enc_utf8 && ScreenLines[off + idx] == 0)
                        continue; /* skip second half of double-width char */
                    if (ScreenAttrs[off + idx] != first_attr)
                        break;
                }
                /* gui_screenstr() takes care of multibyte chars */
                nback = gui_screenstr(off, idx, flags,
                                      (guicolor_T)0, (guicolor_T)0, back);
#else
                for (idx = 0; idx < len && ScreenAttrs[off + idx] == first_attr;
                                                                        idx++)
                {
# ifdef FEAT_MBYTE
                    /* Stop at a multi-byte Unicode character. */
                    if (enc_utf8 && ScreenLinesUC[off + idx] != 0)
                        break;
                    if (enc_dbcs == DBCS_JPNU)
                    {
                        /* Stop at a double-byte single-width char. */
                        if (ScreenLines[off + idx] == 0x8e)
                            break;
                        if (len > 1 && (*mb_ptr2len)(ScreenLines
                                                            + off + idx) == 2)
                            ++idx;  /* skip second byte of double-byte char */
                    }
# endif
                }
                nback = gui_outstr_nowrap(ScreenLines + off, idx, flags,
                                          (guicolor_T)0, (guicolor_T)0, back);
#endif
            }
            if (nback == FAIL)
            {
                /* Must back up to start drawing where a bold or italic word
                 * starts. */
                off -= back;
                len += back;
                gui.col -= back;
            }
            else
            {
                off += idx;
                len -= idx;
            }
            back = 0;
        }
    }

    /* Put the cursor back where it was */
    gui.row = old_row;
    gui.col = old_col;
    gui.highlight_mask = (int)old_hl_mask;

    return retval;
}

    static void
gui_delete_lines(row, count)
    int     row;
    int     count;
{
    if (count <= 0)
        return;

    if (row + count > gui.scroll_region_bot)
        /* Scrolled out of region, just blank the lines out */
        gui_clear_block(row, gui.scroll_region_left,
                              gui.scroll_region_bot, gui.scroll_region_right);
    else
    {
        gui_mch_delete_lines(row, count);

        /* If the cursor was in the deleted lines it's now gone.  If the
         * cursor was in the scrolled lines adjust its position. */
        if (gui.cursor_row >= row
                && gui.cursor_col >= gui.scroll_region_left
                && gui.cursor_col <= gui.scroll_region_right)
        {
            if (gui.cursor_row < row + count)
                gui.cursor_is_valid = FALSE;
            else if (gui.cursor_row <= gui.scroll_region_bot)
                gui.cursor_row -= count;
        }
    }
}

    static void
gui_insert_lines(row, count)
    int     row;
    int     count;
{
    if (count <= 0)
        return;

    if (row + count > gui.scroll_region_bot)
        /* Scrolled out of region, just blank the lines out */
        gui_clear_block(row, gui.scroll_region_left,
                              gui.scroll_region_bot, gui.scroll_region_right);
    else
    {
        gui_mch_insert_lines(row, count);

        if (gui.cursor_row >= gui.row
                && gui.cursor_col >= gui.scroll_region_left
                && gui.cursor_col <= gui.scroll_region_right)
        {
            if (gui.cursor_row <= gui.scroll_region_bot - count)
                gui.cursor_row += count;
            else if (gui.cursor_row <= gui.scroll_region_bot)
                gui.cursor_is_valid = FALSE;
        }
    }
}

/*
 * The main GUI input routine.  Waits for a character from the keyboard.
 * wtime == -1      Wait forever.
 * wtime == 0       Don't wait.
 * wtime > 0        Wait wtime milliseconds for a character.
 * Returns OK if a character was found to be available within the given time,
 * or FAIL otherwise.
 */
    int
gui_wait_for_chars(wtime)
    long    wtime;
{
    int     retval;

    /*
     * If we're going to wait a bit, update the menus and mouse shape for the
     * current State.
     */
    if (wtime != 0)
    {
#ifdef FEAT_MENU
        gui_update_menus(0);
#endif
    }

    gui_mch_update();
    if (input_available())      /* Got char, return immediately */
        return OK;
    if (wtime == 0)     /* Don't wait for char */
        return FAIL;

    /* Before waiting, flush any output to the screen. */
    gui_mch_flush();

    if (wtime > 0)
    {
        /* Blink when waiting for a character.  Probably only does something
         * for showmatch() */
        gui_mch_start_blink();
        retval = gui_mch_wait_for_chars(wtime);
        gui_mch_stop_blink();
        return retval;
    }

    /*
     * While we are waiting indefinitely for a character, blink the cursor.
     */
    gui_mch_start_blink();

    retval = FAIL;
    /*
     * We may want to trigger the CursorHold event.  First wait for
     * 'updatetime' and if nothing is typed within that time put the
     * K_CURSORHOLD key in the input buffer.
     */
    if (gui_mch_wait_for_chars(p_ut) == OK)
        retval = OK;
#ifdef FEAT_AUTOCMD
    else if (trigger_cursorhold())
    {
        char_u  buf[3];

        /* Put K_CURSORHOLD in the input buffer. */
        buf[0] = CSI;
        buf[1] = KS_EXTRA;
        buf[2] = (int)KE_CURSORHOLD;
        add_to_input_buf(buf, 3);

        retval = OK;
    }
#endif

    if (retval == FAIL)
    {
        /* Blocking wait. */
        before_blocking();
        retval = gui_mch_wait_for_chars(-1L);
    }

    gui_mch_stop_blink();
    return retval;
}

/*
 * Fill p[4] with mouse coordinates encoded for check_termcode().
 */
    static void
fill_mouse_coord(p, col, row)
    char_u      *p;
    int         col;
    int         row;
{
    p[0] = (char_u)(col / 128 + ' ' + 1);
    p[1] = (char_u)(col % 128 + ' ' + 1);
    p[2] = (char_u)(row / 128 + ' ' + 1);
    p[3] = (char_u)(row % 128 + ' ' + 1);
}

/*
 * Generic mouse support function.  Add a mouse event to the input buffer with
 * the given properties.
 *  button          --- may be any of MOUSE_LEFT, MOUSE_MIDDLE, MOUSE_RIGHT,
 *                      MOUSE_X1, MOUSE_X2
 *                      MOUSE_DRAG, or MOUSE_RELEASE.
 *                      MOUSE_4 and MOUSE_5 are used for a scroll wheel.
 *  x, y            --- Coordinates of mouse in pixels.
 *  repeated_click  --- TRUE if this click comes only a short time after a
 *                      previous click.
 *  modifiers       --- Bit field which may be any of the following modifiers
 *                      or'ed together: MOUSE_SHIFT | MOUSE_CTRL | MOUSE_ALT.
 * This function will ignore drag events where the mouse has not moved to a new
 * character.
 */
    void
gui_send_mouse_event(button, x, y, repeated_click, modifiers)
    int     button;
    int     x;
    int     y;
    int     repeated_click;
    int_u   modifiers;
{
    static int      prev_row = 0, prev_col = 0;
    static int      prev_button = -1;
    static int      num_clicks = 1;
    char_u          string[10];
    enum key_extra  button_char;
    int             row, col;
#ifdef FEAT_CLIPBOARD
    int             checkfor;
    int             did_clip = FALSE;
#endif

    /*
     * Scrolling may happen at any time, also while a selection is present.
     */
    switch (button)
    {
        case MOUSE_X1:
            button_char = KE_X1MOUSE;
            goto button_set;
        case MOUSE_X2:
            button_char = KE_X2MOUSE;
            goto button_set;
        case MOUSE_4:
            button_char = KE_MOUSEDOWN;
            goto button_set;
        case MOUSE_5:
            button_char = KE_MOUSEUP;
button_set:
            {
                /* Don't put events in the input queue now. */
                if (hold_gui_events)
                    return;

                string[3] = CSI;
                string[4] = KS_EXTRA;
                string[5] = (int)button_char;

                /* Pass the pointer coordinates of the scroll event so that we
                 * know which window to scroll. */
                row = gui_xy2colrow(x, y, &col);
                string[6] = (char_u)(col / 128 + ' ' + 1);
                string[7] = (char_u)(col % 128 + ' ' + 1);
                string[8] = (char_u)(row / 128 + ' ' + 1);
                string[9] = (char_u)(row % 128 + ' ' + 1);

                if (modifiers == 0)
                    add_to_input_buf(string + 3, 7);
                else
                {
                    string[0] = CSI;
                    string[1] = KS_MODIFIER;
                    string[2] = 0;
                    if (modifiers & MOUSE_SHIFT)
                        string[2] |= MOD_MASK_SHIFT;
                    if (modifiers & MOUSE_CTRL)
                        string[2] |= MOD_MASK_CTRL;
                    if (modifiers & MOUSE_ALT)
                        string[2] |= MOD_MASK_ALT;
                    add_to_input_buf(string, 10);
                }
                return;
            }
    }

#ifdef FEAT_CLIPBOARD
    /* If a clipboard selection is in progress, handle it */
    if (clip_star.state == SELECT_IN_PROGRESS)
    {
        clip_process_selection(button, X_2_COL(x), Y_2_ROW(y), repeated_click);
        return;
    }

    /* Determine which mouse settings to look for based on the current mode */
    switch (get_real_state())
    {
        case NORMAL_BUSY:
        case OP_PENDING:
        case NORMAL:            checkfor = MOUSE_NORMAL;        break;
        case VISUAL:            checkfor = MOUSE_VISUAL;        break;
        case SELECTMODE:        checkfor = MOUSE_VISUAL;        break;
        case REPLACE:
        case REPLACE+LANGMAP:
#ifdef FEAT_VREPLACE
        case VREPLACE:
        case VREPLACE+LANGMAP:
#endif
        case INSERT:
        case INSERT+LANGMAP:    checkfor = MOUSE_INSERT;        break;
        case ASKMORE:
        case HITRETURN:         /* At the more- and hit-enter prompt pass the
                                   mouse event for a click on or below the
                                   message line. */
                                if (Y_2_ROW(y) >= msg_row)
                                    checkfor = MOUSE_NORMAL;
                                else
                                    checkfor = MOUSE_RETURN;
                                break;

            /*
             * On the command line, use the clipboard selection on all lines
             * but the command line.  But not when pasting.
             */
        case CMDLINE:
        case CMDLINE+LANGMAP:
            if (Y_2_ROW(y) < cmdline_row && button != MOUSE_MIDDLE)
                checkfor = MOUSE_NONE;
            else
                checkfor = MOUSE_COMMAND;
            break;

        default:
            checkfor = MOUSE_NONE;
            break;
    };

    /*
     * Allow clipboard selection of text on the command line in "normal"
     * modes.  Don't do this when dragging the status line, or extending a
     * Visual selection.
     */
    if ((State == NORMAL || State == NORMAL_BUSY || (State & INSERT))
            && Y_2_ROW(y) >= topframe->fr_height
# ifdef FEAT_WINDOWS
                                                + firstwin->w_winrow
# endif
            && button != MOUSE_DRAG
# ifdef FEAT_MOUSESHAPE
            && !drag_status_line
#  ifdef FEAT_VERTSPLIT
            && !drag_sep_line
#  endif
# endif
            )
        checkfor = MOUSE_NONE;

    /*
     * Use modeless selection when holding CTRL and SHIFT pressed.
     */
    if ((modifiers & MOUSE_CTRL) && (modifiers & MOUSE_SHIFT))
        checkfor = MOUSE_NONEF;

    /*
     * In Ex mode, always use modeless selection.
     */
    if (exmode_active)
        checkfor = MOUSE_NONE;

    /*
     * If the mouse settings say to not use the mouse, use the modeless
     * selection.  But if Visual is active, assume that only the Visual area
     * will be selected.
     * Exception: On the command line, both the selection is used and a mouse
     * key is send.
     */
    if (!mouse_has(checkfor) || checkfor == MOUSE_COMMAND)
    {
#ifdef FEAT_VISUAL
        /* Don't do modeless selection in Visual mode. */
        if (checkfor != MOUSE_NONEF && VIsual_active && (State & NORMAL))
            return;
#endif

        /*
         * When 'mousemodel' is "popup", shift-left is translated to right.
         * But not when also using Ctrl.
         */
        if (mouse_model_popup() && button == MOUSE_LEFT
                && (modifiers & MOUSE_SHIFT) && !(modifiers & MOUSE_CTRL))
        {
            button = MOUSE_RIGHT;
            modifiers &= ~ MOUSE_SHIFT;
        }

        /* If the selection is done, allow the right button to extend it.
         * If the selection is cleared, allow the right button to start it
         * from the cursor position. */
        if (button == MOUSE_RIGHT)
        {
            if (clip_star.state == SELECT_CLEARED)
            {
                if (State & CMDLINE)
                {
                    col = msg_col;
                    row = msg_row;
                }
                else
                {
                    col = curwin->w_wcol;
                    row = curwin->w_wrow + W_WINROW(curwin);
                }
                clip_start_selection(col, row, FALSE);
            }
            clip_process_selection(button, X_2_COL(x), Y_2_ROW(y),
                                                              repeated_click);
            did_clip = TRUE;
        }
        /* Allow the left button to start the selection */
        else if (button ==
# ifdef RISCOS
                /* Only start a drag on a drag event. Otherwise
                 * we don't get a release event. */
                    MOUSE_DRAG
# else
                    MOUSE_LEFT
# endif
                                )
        {
            clip_start_selection(X_2_COL(x), Y_2_ROW(y), repeated_click);
            did_clip = TRUE;
        }
# ifdef RISCOS
        else if (button == MOUSE_LEFT)
        {
            clip_clear_selection();
            did_clip = TRUE;
        }
# endif

        /* Always allow pasting */
        if (button != MOUSE_MIDDLE)
        {
            if (!mouse_has(checkfor) || button == MOUSE_RELEASE)
                return;
            if (checkfor != MOUSE_COMMAND)
                button = MOUSE_LEFT;
        }
        repeated_click = FALSE;
    }

    if (clip_star.state != SELECT_CLEARED && !did_clip)
        clip_clear_selection();
#endif

    /* Don't put events in the input queue now. */
    if (hold_gui_events)
        return;

    row = gui_xy2colrow(x, y, &col);

    /*
     * If we are dragging and the mouse hasn't moved far enough to be on a
     * different character, then don't send an event to vim.
     */
    if (button == MOUSE_DRAG)
    {
        if (row == prev_row && col == prev_col)
            return;
        /* Dragging above the window, set "row" to -1 to cause a scroll. */
        if (y < 0)
            row = -1;
    }

    /*
     * If topline has changed (window scrolled) since the last click, reset
     * repeated_click, because we don't want starting Visual mode when
     * clicking on a different character in the text.
     */
    if (curwin->w_topline != gui_prev_topline
#ifdef FEAT_DIFF
            || curwin->w_topfill != gui_prev_topfill
#endif
            )
        repeated_click = FALSE;

    string[0] = CSI;    /* this sequence is recognized by check_termcode() */
    string[1] = KS_MOUSE;
    string[2] = KE_FILLER;
    if (button != MOUSE_DRAG && button != MOUSE_RELEASE)
    {
        if (repeated_click)
        {
            /*
             * Handle multiple clicks.  They only count if the mouse is still
             * pointing at the same character.
             */
            if (button != prev_button || row != prev_row || col != prev_col)
                num_clicks = 1;
            else if (++num_clicks > 4)
                num_clicks = 1;
        }
        else
            num_clicks = 1;
        prev_button = button;
        gui_prev_topline = curwin->w_topline;
#ifdef FEAT_DIFF
        gui_prev_topfill = curwin->w_topfill;
#endif

        string[3] = (char_u)(button | 0x20);
        SET_NUM_MOUSE_CLICKS(string[3], num_clicks);
    }
    else
        string[3] = (char_u)button;

    string[3] |= modifiers;
    fill_mouse_coord(string + 4, col, row);
    add_to_input_buf(string, 8);

    if (row < 0)
        prev_row = 0;
    else
        prev_row = row;
    prev_col = col;

    /*
     * We need to make sure this is cleared since Athena doesn't tell us when
     * he is done dragging.  Neither does GTK+ 2 -- at least for now.
     */
#if defined(FEAT_GUI_ATHENA) || defined(HAVE_GTK2)
    gui.dragged_sb = SBAR_NONE;
#endif
}

/*
 * Convert x and y coordinate to column and row in text window.
 * Corrects for multi-byte character.
 * returns column in "*colp" and row as return value;
 */
    int
gui_xy2colrow(x, y, colp)
    int         x;
    int         y;
    int         *colp;
{
    int         col = check_col(X_2_COL(x));
    int         row = check_row(Y_2_ROW(y));

#ifdef FEAT_MBYTE
    *colp = mb_fix_col(col, row);
#else
    *colp = col;
#endif
    return row;
}

#if defined(FEAT_MENU) || defined(PROTO)
/*
 * Callback function for when a menu entry has been selected.
 */
    void
gui_menu_cb(menu)
    vimmenu_T *menu;
{
    char_u  bytes[sizeof(long_u)];

    /* Don't put events in the input queue now. */
    if (hold_gui_events)
        return;

    bytes[0] = CSI;
    bytes[1] = KS_MENU;
    bytes[2] = KE_FILLER;
    add_to_input_buf(bytes, 3);
    add_long_to_buf((long_u)menu, bytes);
    add_to_input_buf_csi(bytes, sizeof(long_u));
}
#endif

static int      prev_which_scrollbars[3];

/*
 * Set which components are present.
 * If "oldval" is not NULL, "oldval" is the previous value, the new value is
 * in p_go.
 */
    void
gui_init_which_components(oldval)
    char_u      *oldval;
{
#ifdef FEAT_MENU
    static int  prev_menu_is_active = -1;
#endif
#ifdef FEAT_TOOLBAR
    static int  prev_toolbar = -1;
    int         using_toolbar = FALSE;
#endif
#ifdef FEAT_GUI_TABLINE
    int         using_tabline;
#endif
#ifdef FEAT_FOOTER
    static int  prev_footer = -1;
    int         using_footer = FALSE;
#endif
#if defined(FEAT_MENU) && !defined(WIN16)
    static int  prev_tearoff = -1;
    int         using_tearoff = FALSE;
#endif

    char_u      *p;
    int         i;
#ifdef FEAT_MENU
    int         grey_old, grey_new;
    char_u      *temp;
#endif
    win_T       *wp;
    int         need_set_size;
    int         fix_size;

#ifdef FEAT_MENU
    if (oldval != NULL && gui.in_use)
    {
        /*
         * Check if the menu's go from grey to non-grey or vise versa.
         */
        grey_old = (vim_strchr(oldval, GO_GREY) != NULL);
        grey_new = (vim_strchr(p_go, GO_GREY) != NULL);
        if (grey_old != grey_new)
        {
            temp = p_go;
            p_go = oldval;
            gui_update_menus(MENU_ALL_MODES);
            p_go = temp;
        }
    }
    gui.menu_is_active = FALSE;
#endif

    for (i = 0; i < 3; i++)
        gui.which_scrollbars[i] = FALSE;
    for (p = p_go; *p; p++)
        switch (*p)
        {
            case GO_LEFT:
                gui.which_scrollbars[SBAR_LEFT] = TRUE;
                break;
            case GO_RIGHT:
                gui.which_scrollbars[SBAR_RIGHT] = TRUE;
                break;
#ifdef FEAT_VERTSPLIT
            case GO_VLEFT:
                if (win_hasvertsplit())
                    gui.which_scrollbars[SBAR_LEFT] = TRUE;
                break;
            case GO_VRIGHT:
                if (win_hasvertsplit())
                    gui.which_scrollbars[SBAR_RIGHT] = TRUE;
                break;
#endif
            case GO_BOT:
                gui.which_scrollbars[SBAR_BOTTOM] = TRUE;
                break;
#ifdef FEAT_MENU
            case GO_MENUS:
                gui.menu_is_active = TRUE;
                break;
#endif
            case GO_GREY:
                /* make menu's have grey items, ignored here */
                break;
#ifdef FEAT_TOOLBAR
            case GO_TOOLBAR:
                using_toolbar = TRUE;
                break;
#endif
#ifdef FEAT_FOOTER
            case GO_FOOTER:
                using_footer = TRUE;
                break;
#endif
            case GO_TEAROFF:
#if defined(FEAT_MENU) && !defined(WIN16)
                using_tearoff = TRUE;
#endif
                break;
            default:
                /* Ignore options that are not supported */
                break;
        }

    if (gui.in_use)
    {
        need_set_size = 0;
        fix_size = FALSE;

#ifdef FEAT_GUI_TABLINE
        /* Update the GUI tab line, it may appear or disappear.  This may
         * cause the non-GUI tab line to disappear or appear. */
        using_tabline = gui_has_tabline();
        if (!gui_mch_showing_tabline() != !using_tabline)
        {
            /* We don't want a resize event change "Rows" here, save and
             * restore it.  Resizing is handled below. */
            i = Rows;
            gui_update_tabline();
            Rows = i;
            need_set_size |= RESIZE_VERT;
            if (using_tabline)
                fix_size = TRUE;
            if (!gui_use_tabline())
                redraw_tabline = TRUE;    /* may draw non-GUI tab line */
        }
#endif

        for (i = 0; i < 3; i++)
        {
            /* The scrollbar needs to be updated when it is shown/unshown and
             * when switching tab pages.  But the size only changes when it's
             * shown/unshown.  Thus we need two places to remember whether a
             * scrollbar is there or not. */
            if (gui.which_scrollbars[i] != prev_which_scrollbars[i]
#ifdef FEAT_WINDOWS
                    || gui.which_scrollbars[i]
                                        != curtab->tp_prev_which_scrollbars[i]
#endif
                    )
            {
                if (i == SBAR_BOTTOM)
                    gui_mch_enable_scrollbar(&gui.bottom_sbar,
                                                     gui.which_scrollbars[i]);
                else
                {
                    FOR_ALL_WINDOWS(wp)
                    {
                        gui_do_scrollbar(wp, i, gui.which_scrollbars[i]);
                    }
                }
                if (gui.which_scrollbars[i] != prev_which_scrollbars[i])
                {
                    if (i == SBAR_BOTTOM)
                        need_set_size |= RESIZE_VERT;
                    else
                        need_set_size |= RESIZE_HOR;
                    if (gui.which_scrollbars[i])
                        fix_size = TRUE;
                }
            }
#ifdef FEAT_WINDOWS
            curtab->tp_prev_which_scrollbars[i] = gui.which_scrollbars[i];
#endif
            prev_which_scrollbars[i] = gui.which_scrollbars[i];
        }

#ifdef FEAT_MENU
        if (gui.menu_is_active != prev_menu_is_active)
        {
            /* We don't want a resize event change "Rows" here, save and
             * restore it.  Resizing is handled below. */
            i = Rows;
            gui_mch_enable_menu(gui.menu_is_active);
            Rows = i;
            prev_menu_is_active = gui.menu_is_active;
            need_set_size |= RESIZE_VERT;
            if (gui.menu_is_active)
                fix_size = TRUE;
        }
#endif

#ifdef FEAT_TOOLBAR
        if (using_toolbar != prev_toolbar)
        {
            gui_mch_show_toolbar(using_toolbar);
            prev_toolbar = using_toolbar;
            need_set_size |= RESIZE_VERT;
            if (using_toolbar)
                fix_size = TRUE;
        }
#endif
#ifdef FEAT_FOOTER
        if (using_footer != prev_footer)
        {
            gui_mch_enable_footer(using_footer);
            prev_footer = using_footer;
            need_set_size |= RESIZE_VERT;
            if (using_footer)
                fix_size = TRUE;
        }
#endif
#if defined(FEAT_MENU) && !defined(WIN16) && !(defined(WIN3264) && !defined(FEAT_TEAROFF))
        if (using_tearoff != prev_tearoff)
        {
            gui_mch_toggle_tearoffs(using_tearoff);
            prev_tearoff = using_tearoff;
        }
#endif
        if (need_set_size != 0)
        {
#ifdef FEAT_GUI_GTK
            long    prev_Columns = Columns;
            long    prev_Rows = Rows;
#endif
            /* Adjust the size of the window to make the text area keep the
             * same size and to avoid that part of our window is off-screen
             * and a scrollbar can't be used, for example. */
            gui_set_shellsize(FALSE, fix_size, need_set_size);

#ifdef FEAT_GUI_GTK
            /* GTK has the annoying habit of sending us resize events when
             * changing the window size ourselves.  This mostly happens when
             * waiting for a character to arrive, quite unpredictably, and may
             * change Columns and Rows when we don't want it.  Wait for a
             * character here to avoid this effect.
             * If you remove this, please test this command for resizing
             * effects (with optional left scrollbar): ":vsp|q|vsp|q|vsp|q".
             * Don't do this while starting up though.
             * Don't change Rows when adding menu/toolbar/tabline.
             * Don't change Columns when adding vertical toolbar. */
            if (!gui.starting && need_set_size != (RESIZE_VERT | RESIZE_HOR))
                (void)char_avail();
            if ((need_set_size & RESIZE_VERT) == 0)
                Rows = prev_Rows;
            if ((need_set_size & RESIZE_HOR) == 0)
                Columns = prev_Columns;
#endif
        }
#ifdef FEAT_WINDOWS
        /* When the console tabline appears or disappears the window positions
         * change. */
        if (firstwin->w_winrow != tabline_height())
            shell_new_rows();   /* recompute window positions and heights */
#endif
    }
}

#if defined(FEAT_GUI_TABLINE) || defined(PROTO)
/*
 * Return TRUE if the GUI is taking care of the tabline.
 * It may still be hidden if 'showtabline' is zero.
 */
    int
gui_use_tabline()
{
    return gui.in_use && vim_strchr(p_go, GO_TABLINE) != NULL;
}

/*
 * Return TRUE if the GUI is showing the tabline.
 * This uses 'showtabline'.
 */
    static int
gui_has_tabline()
{
    if (!gui_use_tabline()
            || p_stal == 0
            || (p_stal == 1 && first_tabpage->tp_next == NULL))
        return FALSE;
    return TRUE;
}

/*
 * Update the tabline.
 * This may display/undisplay the tabline and update the labels.
 */
    void
gui_update_tabline()
{
    int     showit = gui_has_tabline();
    int     shown = gui_mch_showing_tabline();

    if (!gui.starting && starting == 0)
    {
        /* Updating the tabline uses direct GUI commands, flush
         * outstanding instructions first. (esp. clear screen) */
        out_flush();
        gui_mch_flush();

        if (!showit != !shown)
            gui_mch_show_tabline(showit);
        if (showit != 0)
            gui_mch_update_tabline();

        /* When the tabs change from hidden to shown or from shown to
         * hidden the size of the text area should remain the same. */
        if (!showit != !shown)
            gui_set_shellsize(FALSE, showit, RESIZE_VERT);
    }
}

/*
 * Get the label or tooltip for tab page "tp" into NameBuff[].
 */
    void
get_tabline_label(tp, tooltip)
    tabpage_T   *tp;
    int         tooltip;        /* TRUE: get tooltip */
{
    int         modified = FALSE;
    char_u      buf[40];
    int         wincount;
    win_T       *wp;
    char_u      **opt;

    /* Use 'guitablabel' or 'guitabtooltip' if it's set. */
    opt = (tooltip ? &p_gtt : &p_gtl);
    if (**opt != NUL)
    {
        int     use_sandbox = FALSE;
        int     save_called_emsg = called_emsg;
        char_u  res[MAXPATHL];
        tabpage_T *save_curtab;
        char_u  *opt_name = (char_u *)(tooltip ? "guitabtooltip"
                                                             : "guitablabel");

        called_emsg = FALSE;

        printer_page_num = tabpage_index(tp);
# ifdef FEAT_EVAL
        set_vim_var_nr(VV_LNUM, printer_page_num);
        use_sandbox = was_set_insecurely(opt_name, 0);
# endif
        /* It's almost as going to the tabpage, but without autocommands. */
        curtab->tp_firstwin = firstwin;
        curtab->tp_lastwin = lastwin;
        curtab->tp_curwin = curwin;
        save_curtab = curtab;
        curtab = tp;
        topframe = curtab->tp_topframe;
        firstwin = curtab->tp_firstwin;
        lastwin = curtab->tp_lastwin;
        curwin = curtab->tp_curwin;
        curbuf = curwin->w_buffer;

        /* Can't use NameBuff directly, build_stl_str_hl() uses it. */
        build_stl_str_hl(curwin, res, MAXPATHL, *opt, use_sandbox,
                                                 0, (int)Columns, NULL, NULL);
        STRCPY(NameBuff, res);

        /* Back to the original curtab. */
        curtab = save_curtab;
        topframe = curtab->tp_topframe;
        firstwin = curtab->tp_firstwin;
        lastwin = curtab->tp_lastwin;
        curwin = curtab->tp_curwin;
        curbuf = curwin->w_buffer;

        if (called_emsg)
            set_string_option_direct(opt_name, -1,
                                           (char_u *)"", OPT_FREE, SID_ERROR);
        called_emsg |= save_called_emsg;
    }

    /* If 'guitablabel'/'guitabtooltip' is not set or the result is empty then
     * use a default label. */
    if (**opt == NUL || *NameBuff == NUL)
    {
        /* Get the buffer name into NameBuff[] and shorten it. */
        get_trans_bufname(tp == curtab ? curbuf : tp->tp_curwin->w_buffer);
        if (!tooltip)
            shorten_dir(NameBuff);

        wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
        for (wincount = 0; wp != NULL; wp = wp->w_next, ++wincount)
            if (bufIsChanged(wp->w_buffer))
                modified = TRUE;
        if (modified || wincount > 1)
        {
            if (wincount > 1)
                vim_snprintf((char *)buf, sizeof(buf), "%d", wincount);
            else
                buf[0] = NUL;
            if (modified)
                STRCAT(buf, "+");
            STRCAT(buf, " ");
            STRMOVE(NameBuff + STRLEN(buf), NameBuff);
            mch_memmove(NameBuff, buf, STRLEN(buf));
        }
    }
}

/*
 * Send the event for clicking to select tab page "nr".
 * Returns TRUE if it was done, FALSE when skipped because we are already at
 * that tab page or the cmdline window is open.
 */
    int
send_tabline_event(nr)
    int     nr;
{
    char_u string[3];

    if (nr == tabpage_index(curtab))
        return FALSE;

    /* Don't put events in the input queue now. */
    if (hold_gui_events
# ifdef FEAT_CMDWIN
            || cmdwin_type != 0
# endif
            )
    {
        /* Set it back to the current tab page. */
        gui_mch_set_curtab(tabpage_index(curtab));
        return FALSE;
    }

    string[0] = CSI;
    string[1] = KS_TABLINE;
    string[2] = KE_FILLER;
    add_to_input_buf(string, 3);
    string[0] = nr;
    add_to_input_buf_csi(string, 1);
    return TRUE;
}

/*
 * Send a tabline menu event
 */
    void
send_tabline_menu_event(tabidx, event)
    int     tabidx;
    int     event;
{
    char_u          string[3];

    /* Don't put events in the input queue now. */
    if (hold_gui_events)
        return;

    string[0] = CSI;
    string[1] = KS_TABMENU;
    string[2] = KE_FILLER;
    add_to_input_buf(string, 3);
    string[0] = tabidx;
    string[1] = (char_u)(long)event;
    add_to_input_buf_csi(string, 2);
}

#endif

/*
 * Scrollbar stuff:
 */

#if defined(FEAT_WINDOWS) || defined(PROTO)
/*
 * Remove all scrollbars.  Used before switching to another tab page.
 */
    void
gui_remove_scrollbars()
{
    int     i;
    win_T   *wp;

    for (i = 0; i < 3; i++)
    {
        if (i == SBAR_BOTTOM)
            gui_mch_enable_scrollbar(&gui.bottom_sbar, FALSE);
        else
        {
            FOR_ALL_WINDOWS(wp)
            {
                gui_do_scrollbar(wp, i, FALSE);
            }
        }
        curtab->tp_prev_which_scrollbars[i] = -1;
    }
}
#endif

    void
gui_create_scrollbar(sb, type, wp)
    scrollbar_T *sb;
    int         type;
    win_T       *wp;
{
    static int  sbar_ident = 0;

    sb->ident = sbar_ident++;   /* No check for too big, but would it happen? */
    sb->wp = wp;
    sb->type = type;
    sb->value = 0;
#ifdef FEAT_GUI_ATHENA
    sb->pixval = 0;
#endif
    sb->size = 1;
    sb->max = 1;
    sb->top = 0;
    sb->height = 0;
#ifdef FEAT_VERTSPLIT
    sb->width = 0;
#endif
    sb->status_height = 0;
    gui_mch_create_scrollbar(sb, (wp == NULL) ? SBAR_HORIZ : SBAR_VERT);
}

/*
 * Find the scrollbar with the given index.
 */
    scrollbar_T *
gui_find_scrollbar(ident)
    long        ident;
{
    win_T       *wp;

    if (gui.bottom_sbar.ident == ident)
        return &gui.bottom_sbar;
    FOR_ALL_WINDOWS(wp)
    {
        if (wp->w_scrollbars[SBAR_LEFT].ident == ident)
            return &wp->w_scrollbars[SBAR_LEFT];
        if (wp->w_scrollbars[SBAR_RIGHT].ident == ident)
            return &wp->w_scrollbars[SBAR_RIGHT];
    }
    return NULL;
}

/*
 * For most systems: Put a code in the input buffer for a dragged scrollbar.
 *
 * For Win32, Macintosh and GTK+ 2:
 * Scrollbars seem to grab focus and vim doesn't read the input queue until
 * you stop dragging the scrollbar.  We get here each time the scrollbar is
 * dragged another pixel, but as far as the rest of vim goes, it thinks
 * we're just hanging in the call to DispatchMessage() in
 * process_message().  The DispatchMessage() call that hangs was passed a
 * mouse button click event in the scrollbar window. -- webb.
 *
 * Solution: Do the scrolling right here.  But only when allowed.
 * Ignore the scrollbars while executing an external command or when there
 * are still characters to be processed.
 */
    void
gui_drag_scrollbar(sb, value, still_dragging)
    scrollbar_T *sb;
    long        value;
    int         still_dragging;
{
#ifdef FEAT_WINDOWS
    win_T       *wp;
#endif
    int         sb_num;
#ifdef USE_ON_FLY_SCROLL
    colnr_T     old_leftcol = curwin->w_leftcol;
# ifdef FEAT_SCROLLBIND
    linenr_T    old_topline = curwin->w_topline;
# endif
# ifdef FEAT_DIFF
    int         old_topfill = curwin->w_topfill;
# endif
#else
    char_u      bytes[sizeof(long_u)];
    int         byte_count;
#endif

    if (sb == NULL)
        return;

    /* Don't put events in the input queue now. */
    if (hold_gui_events)
        return;

#ifdef FEAT_CMDWIN
    if (cmdwin_type != 0 && sb->wp != curwin)
        return;
#endif

    if (still_dragging)
    {
        if (sb->wp == NULL)
            gui.dragged_sb = SBAR_BOTTOM;
        else if (sb == &sb->wp->w_scrollbars[SBAR_LEFT])
            gui.dragged_sb = SBAR_LEFT;
        else
            gui.dragged_sb = SBAR_RIGHT;
        gui.dragged_wp = sb->wp;
    }
    else
    {
        gui.dragged_sb = SBAR_NONE;
#ifdef HAVE_GTK2
        /* Keep the "dragged_wp" value until after the scrolling, for when the
         * moust button is released.  GTK2 doesn't send the button-up event. */
        gui.dragged_wp = NULL;
#endif
    }

    /* Vertical sbar info is kept in the first sbar (the left one) */
    if (sb->wp != NULL)
        sb = &sb->wp->w_scrollbars[0];

    /*
     * Check validity of value
     */
    if (value < 0)
        value = 0;
#ifdef SCROLL_PAST_END
    else if (value > sb->max)
        value = sb->max;
#else
    if (value > sb->max - sb->size + 1)
        value = sb->max - sb->size + 1;
#endif

    sb->value = value;

#ifdef USE_ON_FLY_SCROLL
    /* When not allowed to do the scrolling right now, return.
     * This also checked input_available(), but that causes the first click in
     * a scrollbar to be ignored when Vim doesn't have focus. */
    if (dont_scroll)
        return;
#endif
#ifdef FEAT_INS_EXPAND
    /* Disallow scrolling the current window when the completion popup menu is
     * visible. */
    if ((sb->wp == NULL || sb->wp == curwin) && pum_visible())
        return;
#endif

#ifdef FEAT_RIGHTLEFT
    if (sb->wp == NULL && curwin->w_p_rl)
    {
        value = sb->max + 1 - sb->size - value;
        if (value < 0)
            value = 0;
    }
#endif

    if (sb->wp != NULL)         /* vertical scrollbar */
    {
        sb_num = 0;
#ifdef FEAT_WINDOWS
        for (wp = firstwin; wp != sb->wp && wp != NULL; wp = wp->w_next)
            sb_num++;
        if (wp == NULL)
            return;
#else
        if (sb->wp != curwin)
            return;
#endif

#ifdef USE_ON_FLY_SCROLL
        current_scrollbar = sb_num;
        scrollbar_value = value;
        if (State & NORMAL)
        {
            gui_do_scroll();
            setcursor();
        }
        else if (State & INSERT)
        {
            ins_scroll();
            setcursor();
        }
        else if (State & CMDLINE)
        {
            if (msg_scrolled == 0)
            {
                gui_do_scroll();
                redrawcmdline();
            }
        }
# ifdef FEAT_FOLDING
        /* Value may have been changed for closed fold. */
        sb->value = sb->wp->w_topline - 1;
# endif

        /* When dragging one scrollbar and there is another one at the other
         * side move the thumb of that one too. */
        if (gui.which_scrollbars[SBAR_RIGHT] && gui.which_scrollbars[SBAR_LEFT])
            gui_mch_set_scrollbar_thumb(
                    &sb->wp->w_scrollbars[
                            sb == &sb->wp->w_scrollbars[SBAR_RIGHT]
                                                    ? SBAR_LEFT : SBAR_RIGHT],
                    sb->value, sb->size, sb->max);

#else
        bytes[0] = CSI;
        bytes[1] = KS_VER_SCROLLBAR;
        bytes[2] = KE_FILLER;
        bytes[3] = (char_u)sb_num;
        byte_count = 4;
#endif
    }
    else
    {
#ifdef USE_ON_FLY_SCROLL
        scrollbar_value = value;

        if (State & NORMAL)
            gui_do_horiz_scroll();
        else if (State & INSERT)
            ins_horscroll();
        else if (State & CMDLINE)
        {
            if (msg_scrolled == 0)
            {
                gui_do_horiz_scroll();
                redrawcmdline();
            }
        }
        if (old_leftcol != curwin->w_leftcol)
        {
            updateWindow(curwin);   /* update window, status and cmdline */
            setcursor();
        }
#else
        bytes[0] = CSI;
        bytes[1] = KS_HOR_SCROLLBAR;
        bytes[2] = KE_FILLER;
        byte_count = 3;
#endif
    }

#ifdef USE_ON_FLY_SCROLL
# ifdef FEAT_SCROLLBIND
    /*
     * synchronize other windows, as necessary according to 'scrollbind'
     */
    if (curwin->w_p_scb
            && ((sb->wp == NULL && curwin->w_leftcol != old_leftcol)
                || (sb->wp == curwin && (curwin->w_topline != old_topline
#  ifdef FEAT_DIFF
                                           || curwin->w_topfill != old_topfill
#  endif
                        ))))
    {
        do_check_scrollbind(TRUE);
        /* need to update the window right here */
        for (wp = firstwin; wp != NULL; wp = wp->w_next)
            if (wp->w_redr_type > 0)
                updateWindow(wp);
        setcursor();
    }
# endif
    out_flush();
    gui_update_cursor(FALSE, TRUE);
#else
    add_to_input_buf(bytes, byte_count);
    add_long_to_buf((long_u)value, bytes);
    add_to_input_buf_csi(bytes, sizeof(long_u));
#endif
}

/*
 * Scrollbar stuff:
 */

    void
gui_update_scrollbars(force)
    int         force;      /* Force all scrollbars to get updated */
{
    win_T       *wp;
    scrollbar_T *sb;
    long        val, size, max;         /* need 32 bits here */
    int         which_sb;
    int         h, y;
#ifdef FEAT_VERTSPLIT
    static win_T *prev_curwin = NULL;
#endif

    /* Update the horizontal scrollbar */
    gui_update_horiz_scrollbar(force);

#ifndef WIN3264
    /* Return straight away if there is neither a left nor right scrollbar.
     * On MS-Windows this is required anyway for scrollwheel messages. */
    if (!gui.which_scrollbars[SBAR_LEFT] && !gui.which_scrollbars[SBAR_RIGHT])
        return;
#endif

    /*
     * Don't want to update a scrollbar while we're dragging it.  But if we
     * have both a left and right scrollbar, and we drag one of them, we still
     * need to update the other one.
     */
    if (!force && (gui.dragged_sb == SBAR_LEFT || gui.dragged_sb == SBAR_RIGHT)
            && gui.which_scrollbars[SBAR_LEFT]
            && gui.which_scrollbars[SBAR_RIGHT])
    {
        /*
         * If we have two scrollbars and one of them is being dragged, just
         * copy the scrollbar position from the dragged one to the other one.
         */
        which_sb = SBAR_LEFT + SBAR_RIGHT - gui.dragged_sb;
        if (gui.dragged_wp != NULL)
            gui_mch_set_scrollbar_thumb(
                    &gui.dragged_wp->w_scrollbars[which_sb],
                    gui.dragged_wp->w_scrollbars[0].value,
                    gui.dragged_wp->w_scrollbars[0].size,
                    gui.dragged_wp->w_scrollbars[0].max);
    }

    /* avoid that moving components around generates events */
    ++hold_gui_events;

    for (wp = firstwin; wp != NULL; wp = W_NEXT(wp))
    {
        if (wp->w_buffer == NULL)       /* just in case */
            continue;
        /* Skip a scrollbar that is being dragged. */
        if (!force && (gui.dragged_sb == SBAR_LEFT
                                             || gui.dragged_sb == SBAR_RIGHT)
                && gui.dragged_wp == wp)
            continue;

#ifdef SCROLL_PAST_END
        max = wp->w_buffer->b_ml.ml_line_count - 1;
#else
        max = wp->w_buffer->b_ml.ml_line_count + wp->w_height - 2;
#endif
        if (max < 0)                    /* empty buffer */
            max = 0;
        val = wp->w_topline - 1;
        size = wp->w_height;
#ifdef SCROLL_PAST_END
        if (val > max)                  /* just in case */
            val = max;
#else
        if (size > max + 1)             /* just in case */
            size = max + 1;
        if (val > max - size + 1)
            val = max - size + 1;
#endif
        if (val < 0)                    /* minimal value is 0 */
            val = 0;

        /*
         * Scrollbar at index 0 (the left one) contains all the information.
         * It would be the same info for left and right so we just store it for
         * one of them.
         */
        sb = &wp->w_scrollbars[0];

        /*
         * Note: no check for valid w_botline.  If it's not valid the
         * scrollbars will be updated later anyway.
         */
        if (size < 1 || wp->w_botline - 2 > max)
        {
            /*
             * This can happen during changing files.  Just don't update the
             * scrollbar for now.
             */
            sb->height = 0;         /* Force update next time */
            if (gui.which_scrollbars[SBAR_LEFT])
                gui_do_scrollbar(wp, SBAR_LEFT, FALSE);
            if (gui.which_scrollbars[SBAR_RIGHT])
                gui_do_scrollbar(wp, SBAR_RIGHT, FALSE);
            continue;
        }
        if (force || sb->height != wp->w_height
#ifdef FEAT_WINDOWS
            || sb->top != wp->w_winrow
            || sb->status_height != wp->w_status_height
# ifdef FEAT_VERTSPLIT
            || sb->width != wp->w_width
            || prev_curwin != curwin
# endif
#endif
            )
        {
            /* Height, width or position of scrollbar has changed.  For
             * vertical split: curwin changed. */
            sb->height = wp->w_height;
#ifdef FEAT_WINDOWS
            sb->top = wp->w_winrow;
            sb->status_height = wp->w_status_height;
# ifdef FEAT_VERTSPLIT
            sb->width = wp->w_width;
# endif
#endif

            /* Calculate height and position in pixels */
            h = (sb->height + sb->status_height) * gui.char_height;
            y = sb->top * gui.char_height + gui.border_offset;
#if defined(FEAT_MENU) && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MOTIF) && !defined(FEAT_GUI_PHOTON)
            if (gui.menu_is_active)
                y += gui.menu_height;
#endif

#if defined(FEAT_TOOLBAR) && (defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_ATHENA))
            if (vim_strchr(p_go, GO_TOOLBAR) != NULL)
# ifdef FEAT_GUI_ATHENA
                y += gui.toolbar_height;
# else
#  ifdef FEAT_GUI_MSWIN
                y += TOOLBAR_BUTTON_HEIGHT + TOOLBAR_BORDER_HEIGHT;
#  endif
# endif
#endif

#if defined(FEAT_GUI_TABLINE) && defined(FEAT_GUI_MSWIN)
            if (gui_has_tabline())
                y += gui.tabline_height;
#endif

#ifdef FEAT_WINDOWS
            if (wp->w_winrow == 0)
#endif
            {
                /* Height of top scrollbar includes width of top border */
                h += gui.border_offset;
                y -= gui.border_offset;
            }
            if (gui.which_scrollbars[SBAR_LEFT])
            {
                gui_mch_set_scrollbar_pos(&wp->w_scrollbars[SBAR_LEFT],
                                          gui.left_sbar_x, y,
                                          gui.scrollbar_width, h);
                gui_do_scrollbar(wp, SBAR_LEFT, TRUE);
            }
            if (gui.which_scrollbars[SBAR_RIGHT])
            {
                gui_mch_set_scrollbar_pos(&wp->w_scrollbars[SBAR_RIGHT],
                                          gui.right_sbar_x, y,
                                          gui.scrollbar_width, h);
                gui_do_scrollbar(wp, SBAR_RIGHT, TRUE);
            }
        }

        /* Reduce the number of calls to gui_mch_set_scrollbar_thumb() by
         * checking if the thumb moved at least a pixel.  Only do this for
         * Athena, most other GUIs require the update anyway to make the
         * arrows work. */
#ifdef FEAT_GUI_ATHENA
        if (max == 0)
            y = 0;
        else
            y = (val * (sb->height + 2) * gui.char_height + max / 2) / max;
        if (force || sb->pixval != y || sb->size != size || sb->max != max)
#else
        if (force || sb->value != val || sb->size != size || sb->max != max)
#endif
        {
            /* Thumb of scrollbar has moved */
            sb->value = val;
#ifdef FEAT_GUI_ATHENA
            sb->pixval = y;
#endif
            sb->size = size;
            sb->max = max;
            if (gui.which_scrollbars[SBAR_LEFT]
                    && (gui.dragged_sb != SBAR_LEFT || gui.dragged_wp != wp))
                gui_mch_set_scrollbar_thumb(&wp->w_scrollbars[SBAR_LEFT],
                                            val, size, max);
            if (gui.which_scrollbars[SBAR_RIGHT]
                    && (gui.dragged_sb != SBAR_RIGHT || gui.dragged_wp != wp))
                gui_mch_set_scrollbar_thumb(&wp->w_scrollbars[SBAR_RIGHT],
                                            val, size, max);
        }
    }
#ifdef FEAT_VERTSPLIT
    prev_curwin = curwin;
#endif
    --hold_gui_events;
}

/*
 * Enable or disable a scrollbar.
 * Check for scrollbars for vertically split windows which are not enabled
 * sometimes.
 */
    static void
gui_do_scrollbar(wp, which, enable)
    win_T       *wp;
    int         which;      /* SBAR_LEFT or SBAR_RIGHT */
    int         enable;     /* TRUE to enable scrollbar */
{
#ifdef FEAT_VERTSPLIT
    int         midcol = curwin->w_wincol + curwin->w_width / 2;
    int         has_midcol = (wp->w_wincol <= midcol
                                     && wp->w_wincol + wp->w_width >= midcol);

    /* Only enable scrollbars that contain the middle column of the current
     * window. */
    if (gui.which_scrollbars[SBAR_RIGHT] != gui.which_scrollbars[SBAR_LEFT])
    {
        /* Scrollbars only on one side.  Don't enable scrollbars that don't
         * contain the middle column of the current window. */
        if (!has_midcol)
            enable = FALSE;
    }
    else
    {
        /* Scrollbars on both sides.  Don't enable scrollbars that neither
         * contain the middle column of the current window nor are on the far
         * side. */
        if (midcol > Columns / 2)
        {
            if (which == SBAR_LEFT ? wp->w_wincol != 0 : !has_midcol)
                enable = FALSE;
        }
        else
        {
            if (which == SBAR_RIGHT ? wp->w_wincol + wp->w_width != Columns
                                                                : !has_midcol)
                enable = FALSE;
        }
    }
#endif
    gui_mch_enable_scrollbar(&wp->w_scrollbars[which], enable);
}

/*
 * Scroll a window according to the values set in the globals current_scrollbar
 * and scrollbar_value.  Return TRUE if the cursor in the current window moved
 * or FALSE otherwise.
 */
    int
gui_do_scroll()
{
    win_T       *wp, *save_wp;
    int         i;
    long        nlines;
    pos_T       old_cursor;
    linenr_T    old_topline;
#ifdef FEAT_DIFF
    int         old_topfill;
#endif

    for (wp = firstwin, i = 0; i < current_scrollbar; wp = W_NEXT(wp), i++)
        if (wp == NULL)
            break;
    if (wp == NULL)
        /* Couldn't find window */
        return FALSE;

    /*
     * Compute number of lines to scroll.  If zero, nothing to do.
     */
    nlines = (long)scrollbar_value + 1 - (long)wp->w_topline;
    if (nlines == 0)
        return FALSE;

    save_wp = curwin;
    old_topline = wp->w_topline;
#ifdef FEAT_DIFF
    old_topfill = wp->w_topfill;
#endif
    old_cursor = wp->w_cursor;
    curwin = wp;
    curbuf = wp->w_buffer;
    if (nlines < 0)
        scrolldown(-nlines, gui.dragged_wp == NULL);
    else
        scrollup(nlines, gui.dragged_wp == NULL);
    /* Reset dragged_wp after using it.  "dragged_sb" will have been reset for
     * the mouse-up event already, but we still want it to behave like when
     * dragging.  But not the next click in an arrow. */
    if (gui.dragged_sb == SBAR_NONE)
        gui.dragged_wp = NULL;

    if (old_topline != wp->w_topline
#ifdef FEAT_DIFF
            || old_topfill != wp->w_topfill
#endif
            )
    {
        if (p_so != 0)
        {
            cursor_correct();           /* fix window for 'so' */
            update_topline();           /* avoid up/down jump */
        }
        if (old_cursor.lnum != wp->w_cursor.lnum)
            coladvance(wp->w_curswant);
#ifdef FEAT_SCROLLBIND
        wp->w_scbind_pos = wp->w_topline;
#endif
    }

    /* Make sure wp->w_leftcol and wp->w_skipcol are correct. */
    validate_cursor();

    curwin = save_wp;
    curbuf = save_wp->w_buffer;

    /*
     * Don't call updateWindow() when nothing has changed (it will overwrite
     * the status line!).
     */
    if (old_topline != wp->w_topline
            || wp->w_redr_type != 0
#ifdef FEAT_DIFF
            || old_topfill != wp->w_topfill
#endif
            )
    {
        int type = VALID;

#ifdef FEAT_INS_EXPAND
        if (pum_visible())
        {
            type = NOT_VALID;
            wp->w_lines_valid = 0;
        }
#endif
        /* Don't set must_redraw here, it may cause the popup menu to
         * disappear when losing focus after a scrollbar drag. */
        if (wp->w_redr_type < type)
            wp->w_redr_type = type;
        updateWindow(wp);   /* update window, status line, and cmdline */
    }

#ifdef FEAT_INS_EXPAND
    /* May need to redraw the popup menu. */
    if (pum_visible())
        pum_redraw();
#endif

    return (wp == curwin && !equalpos(curwin->w_cursor, old_cursor));
}


/*
 * Horizontal scrollbar stuff:
 */

/*
 * Return length of line "lnum" for horizontal scrolling.
 */
    static colnr_T
scroll_line_len(lnum)
    linenr_T    lnum;
{
    char_u      *p;
    colnr_T     col;
    int         w;

    p = ml_get(lnum);
    col = 0;
    if (*p != NUL)
        for (;;)
        {
            w = chartabsize(p, col);
            mb_ptr_adv(p);
            if (*p == NUL)              /* don't count the last character */
                break;
            col += w;
        }
    return col;
}

/* Remember which line is currently the longest, so that we don't have to
 * search for it when scrolling horizontally. */
static linenr_T longest_lnum = 0;

    static void
gui_update_horiz_scrollbar(force)
    int         force;
{
    long        value, size, max;       /* need 32 bit ints here */

    if (!gui.which_scrollbars[SBAR_BOTTOM])
        return;

    if (!force && gui.dragged_sb == SBAR_BOTTOM)
        return;

    if (!force && curwin->w_p_wrap && gui.prev_wrap)
        return;

    /*
     * It is possible for the cursor to be invalid if we're in the middle of
     * something (like changing files).  If so, don't do anything for now.
     */
    if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
    {
        gui.bottom_sbar.value = -1;
        return;
    }

    size = W_WIDTH(curwin);
    if (curwin->w_p_wrap)
    {
        value = 0;
#ifdef SCROLL_PAST_END
        max = 0;
#else
        max = W_WIDTH(curwin) - 1;
#endif
    }
    else
    {
        value = curwin->w_leftcol;

        /* Calculate maximum for horizontal scrollbar.  Check for reasonable
         * line numbers, topline and botline can be invalid when displaying is
         * postponed. */
        if (vim_strchr(p_go, GO_HORSCROLL) == NULL
                && curwin->w_topline <= curwin->w_cursor.lnum
                && curwin->w_botline > curwin->w_cursor.lnum
                && curwin->w_botline <= curbuf->b_ml.ml_line_count + 1)
        {
            linenr_T    lnum;
            colnr_T     n;

            /* Use maximum of all visible lines.  Remember the lnum of the
             * longest line, clostest to the cursor line.  Used when scrolling
             * below. */
            max = 0;
            for (lnum = curwin->w_topline; lnum < curwin->w_botline; ++lnum)
            {
                n = scroll_line_len(lnum);
                if (n > (colnr_T)max)
                {
                    max = n;
                    longest_lnum = lnum;
                }
                else if (n == (colnr_T)max
                        && abs((int)(lnum - curwin->w_cursor.lnum))
                           < abs((int)(longest_lnum - curwin->w_cursor.lnum)))
                    longest_lnum = lnum;
            }
        }
        else
            /* Use cursor line only. */
            max = scroll_line_len(curwin->w_cursor.lnum);
#ifdef FEAT_VIRTUALEDIT
        if (virtual_active())
        {
            /* May move the cursor even further to the right. */
            if (curwin->w_virtcol >= (colnr_T)max)
                max = curwin->w_virtcol;
        }
#endif

#ifndef SCROLL_PAST_END
        max += W_WIDTH(curwin) - 1;
#endif
        /* The line number isn't scrolled, thus there is less space when
         * 'number' is set (also for 'foldcolumn'). */
        size -= curwin_col_off();
#ifndef SCROLL_PAST_END
        max -= curwin_col_off();
#endif
    }

#ifndef SCROLL_PAST_END
    if (value > max - size + 1)
        value = max - size + 1;     /* limit the value to allowable range */
#endif

#ifdef FEAT_RIGHTLEFT
    if (curwin->w_p_rl)
    {
        value = max + 1 - size - value;
        if (value < 0)
        {
            size += value;
            value = 0;
        }
    }
#endif
    if (!force && value == gui.bottom_sbar.value && size == gui.bottom_sbar.size
                                                && max == gui.bottom_sbar.max)
        return;

    gui.bottom_sbar.value = value;
    gui.bottom_sbar.size = size;
    gui.bottom_sbar.max = max;
    gui.prev_wrap = curwin->w_p_wrap;

    gui_mch_set_scrollbar_thumb(&gui.bottom_sbar, value, size, max);
}

/*
 * Do a horizontal scroll.  Return TRUE if the cursor moved, FALSE otherwise.
 */
    int
gui_do_horiz_scroll()
{
    /* no wrapping, no scrolling */
    if (curwin->w_p_wrap)
        return FALSE;

    if ((long_u)curwin->w_leftcol == scrollbar_value)
        return FALSE;

    curwin->w_leftcol = (colnr_T)scrollbar_value;

    /* When the line of the cursor is too short, move the cursor to the
     * longest visible line.  Do a sanity check on "longest_lnum", just in
     * case. */
    if (vim_strchr(p_go, GO_HORSCROLL) == NULL
            && longest_lnum >= curwin->w_topline
            && longest_lnum < curwin->w_botline
            && !virtual_active())
    {
        if (scrollbar_value > (long_u)scroll_line_len(curwin->w_cursor.lnum))
        {
            curwin->w_cursor.lnum = longest_lnum;
            curwin->w_cursor.col = 0;
        }
    }

    return leftcol_changed();
}

/*
 * Check that none of the colors are the same as the background color
 */
    void
gui_check_colors()
{
    if (gui.norm_pixel == gui.back_pixel || gui.norm_pixel == INVALCOLOR)
    {
        gui_set_bg_color((char_u *)"White");
        if (gui.norm_pixel == gui.back_pixel || gui.norm_pixel == INVALCOLOR)
            gui_set_fg_color((char_u *)"Black");
    }
}

    static void
gui_set_fg_color(name)
    char_u      *name;
{
    gui.norm_pixel = gui_get_color(name);
    hl_set_fg_color_name(vim_strsave(name));
}

    static void
gui_set_bg_color(name)
    char_u      *name;
{
    gui.back_pixel = gui_get_color(name);
    hl_set_bg_color_name(vim_strsave(name));
}

/*
 * Allocate a color by name.
 * Returns INVALCOLOR and gives an error message when failed.
 */
    guicolor_T
gui_get_color(name)
    char_u      *name;
{
    guicolor_T  t;

    if (*name == NUL)
        return INVALCOLOR;
    t = gui_mch_get_color(name);

    if (t == INVALCOLOR
#if defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK)
            && gui.in_use
#endif
            )
        EMSG2(_("E254: Cannot allocate color %s"), name);
    return t;
}

/*
 * Return the grey value of a color (range 0-255).
 */
    int
gui_get_lightness(pixel)
    guicolor_T  pixel;
{
    long_u      rgb = gui_mch_get_rgb(pixel);

    return  (int)(  (((rgb >> 16) & 0xff) * 299)
                   + (((rgb >> 8) & 0xff) * 587)
                   +  ((rgb       & 0xff) * 114)) / 1000;
}

#if defined(FEAT_GUI_X11) || defined(PROTO)
    void
gui_new_scrollbar_colors()
{
    win_T       *wp;

    /* Nothing to do if GUI hasn't started yet. */
    if (!gui.in_use)
        return;

    FOR_ALL_WINDOWS(wp)
    {
        gui_mch_set_scrollbar_colors(&(wp->w_scrollbars[SBAR_LEFT]));
        gui_mch_set_scrollbar_colors(&(wp->w_scrollbars[SBAR_RIGHT]));
    }
    gui_mch_set_scrollbar_colors(&gui.bottom_sbar);
}
#endif

/*
 * Call this when focus has changed.
 */
    void
gui_focus_change(in_focus)
    int         in_focus;
{
/*
 * Skip this code to avoid drawing the cursor when debugging and switching
 * between the debugger window and gvim.
 */
#if 1
    gui.in_focus = in_focus;
    out_flush();                /* make sure output has been written */
    gui_update_cursor(TRUE, FALSE);

# ifdef FEAT_XIM
    xim_set_focus(in_focus);
# endif

    /* Put events in the input queue only when allowed.
     * ui_focus_change() isn't called directly, because it invokes
     * autocommands and that must not happen asynchronously. */
    if (!hold_gui_events)
    {
        char_u  bytes[3];

        bytes[0] = CSI;
        bytes[1] = KS_EXTRA;
        bytes[2] = in_focus ? (int)KE_FOCUSGAINED : (int)KE_FOCUSLOST;
        add_to_input_buf(bytes, 3);
    }
#endif
}

/*
 * Called when the mouse moved (but not when dragging).
 */
    void
gui_mouse_moved(x, y)
    int         x;
    int         y;
{
    win_T       *wp;
    char_u      st[8];

    /* Ignore this while still starting up. */
    if (!gui.in_use || gui.starting)
        return;

#ifdef FEAT_MOUSESHAPE
    /* Get window pointer, and update mouse shape as well. */
    wp = xy2win(x, y);
#endif

    /* Only handle this when 'mousefocus' set and ... */
    if (p_mousef
            && !hold_gui_events         /* not holding events */
            && (State & (NORMAL|INSERT))/* Normal/Visual/Insert mode */
            && State != HITRETURN       /* but not hit-return prompt */
            && msg_scrolled == 0        /* no scrolled message */
            && !need_mouse_correct      /* not moving the pointer */
            && gui.in_focus)            /* gvim in focus */
    {
        /* Don't move the mouse when it's left or right of the Vim window */
        if (x < 0 || x > Columns * gui.char_width)
            return;
#ifndef FEAT_MOUSESHAPE
        wp = xy2win(x, y);
#endif
        if (wp == curwin || wp == NULL)
            return;     /* still in the same old window, or none at all */

#ifdef FEAT_WINDOWS
        /* Ignore position in the tab pages line. */
        if (Y_2_ROW(y) < tabline_height())
            return;
#endif

        /*
         * format a mouse click on status line input
         * ala gui_send_mouse_event(0, x, y, 0, 0);
         * Trick: Use a column number -1, so that get_pseudo_mouse_code() will
         * generate a K_LEFTMOUSE_NM key code.
         */
        if (finish_op)
        {
            /* abort the current operator first */
            st[0] = ESC;
            add_to_input_buf(st, 1);
        }
        st[0] = CSI;
        st[1] = KS_MOUSE;
        st[2] = KE_FILLER;
        st[3] = (char_u)MOUSE_LEFT;
        fill_mouse_coord(st + 4,
#ifdef FEAT_VERTSPLIT
                wp->w_wincol == 0 ? -1 : wp->w_wincol + MOUSE_COLOFF,
#else
                -1,
#endif
                wp->w_height + W_WINROW(wp));

        add_to_input_buf(st, 8);
        st[3] = (char_u)MOUSE_RELEASE;
        add_to_input_buf(st, 8);
#ifdef FEAT_GUI_GTK
        /* Need to wake up the main loop */
        if (gtk_main_level() > 0)
            gtk_main_quit();
#endif
    }
}

/*
 * Called when mouse should be moved to window with focus.
 */
    void
gui_mouse_correct()
{
    int         x, y;
    win_T       *wp = NULL;

    need_mouse_correct = FALSE;

    if (!(gui.in_use && p_mousef))
        return;

    gui_mch_getmouse(&x, &y);
    /* Don't move the mouse when it's left or right of the Vim window */
    if (x < 0 || x > Columns * gui.char_width)
        return;
    if (y >= 0
# ifdef FEAT_WINDOWS
            && Y_2_ROW(y) >= tabline_height()
# endif
       )
        wp = xy2win(x, y);
    if (wp != curwin && wp != NULL)     /* If in other than current window */
    {
        validate_cline_row();
        gui_mch_setmouse((int)W_ENDCOL(curwin) * gui.char_width - 3,
                (W_WINROW(curwin) + curwin->w_wrow) * gui.char_height
                                                     + (gui.char_height) / 2);
    }
}

/*
 * Find window where the mouse pointer "y" coordinate is in.
 */
    static win_T *
xy2win(x, y)
    int         x;
    int         y;
{
#ifdef FEAT_WINDOWS
    int         row;
    int         col;
    win_T       *wp;

    row = Y_2_ROW(y);
    col = X_2_COL(x);
    if (row < 0 || col < 0)             /* before first window */
        return NULL;
    wp = mouse_find_win(&row, &col);
# ifdef FEAT_MOUSESHAPE
    if (State == HITRETURN || State == ASKMORE)
    {
        if (Y_2_ROW(y) >= msg_row)
            update_mouseshape(SHAPE_IDX_MOREL);
        else
            update_mouseshape(SHAPE_IDX_MORE);
    }
    else if (row > wp->w_height)        /* below status line */
        update_mouseshape(SHAPE_IDX_CLINE);
#  ifdef FEAT_VERTSPLIT
    else if (!(State & CMDLINE) && W_VSEP_WIDTH(wp) > 0 && col == wp->w_width
            && (row != wp->w_height || !stl_connected(wp)) && msg_scrolled == 0)
        update_mouseshape(SHAPE_IDX_VSEP);
#  endif
    else if (!(State & CMDLINE) && W_STATUS_HEIGHT(wp) > 0
                                  && row == wp->w_height && msg_scrolled == 0)
        update_mouseshape(SHAPE_IDX_STATUS);
    else
        update_mouseshape(-2);
# endif
    return wp;
#else
    return firstwin;
#endif
}

/*
 * ":gui" and ":gvim": Change from the terminal version to the GUI version.
 * File names may be given to redefine the args list.
 */
    void
ex_gui(eap)
    exarg_T     *eap;
{
    char_u      *arg = eap->arg;

    /*
     * Check for "-f" argument: foreground, don't fork.
     * Also don't fork when started with "gvim -f".
     * Do fork when using "gui -b".
     */
    if (arg[0] == '-'
            && (arg[1] == 'f' || arg[1] == 'b')
            && (arg[2] == NUL || vim_iswhite(arg[2])))
    {
        gui.dofork = (arg[1] == 'b');
        eap->arg = skipwhite(eap->arg + 2);
    }
    if (!gui.in_use)
    {
        /* Clear the command.  Needed for when forking+exiting, to avoid part
         * of the argument ending up after the shell prompt. */
        msg_clr_eos_force();
        gui_start();
    }
    if (!ends_excmd(*eap->arg))
        ex_next(eap);
}

#if ((defined(FEAT_GUI_X11) || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_W32) \
        || defined(FEAT_GUI_PHOTON)) && defined(FEAT_TOOLBAR)) || defined(PROTO)
/*
 * This is shared between Athena, Motif and GTK.
 */
static void gfp_setname __ARGS((char_u *fname, void *cookie));

/*
 * Callback function for do_in_runtimepath().
 */
    static void
gfp_setname(fname, cookie)
    char_u      *fname;
    void        *cookie;
{
    char_u      *gfp_buffer = cookie;

    if (STRLEN(fname) >= MAXPATHL)
        *gfp_buffer = NUL;
    else
        STRCPY(gfp_buffer, fname);
}

/*
 * Find the path of bitmap "name" with extension "ext" in 'runtimepath'.
 * Return FAIL for failure and OK if buffer[MAXPATHL] contains the result.
 */
    int
gui_find_bitmap(name, buffer, ext)
    char_u      *name;
    char_u      *buffer;
    char        *ext;
{
    if (STRLEN(name) > MAXPATHL - 14)
        return FAIL;
    vim_snprintf((char *)buffer, MAXPATHL, "bitmaps/%s.%s", name, ext);
    if (do_in_runtimepath(buffer, FALSE, gfp_setname, buffer) == FAIL
                                                            || *buffer == NUL)
        return FAIL;
    return OK;
}

# if !defined(HAVE_GTK2) || defined(PROTO)
/*
 * Given the name of the "icon=" argument, try finding the bitmap file for the
 * icon.  If it is an absolute path name, use it as it is.  Otherwise append
 * "ext" and search for it in 'runtimepath'.
 * The result is put in "buffer[MAXPATHL]".  If something fails "buffer"
 * contains "name".
 */
    void
gui_find_iconfile(name, buffer, ext)
    char_u      *name;
    char_u      *buffer;
    char        *ext;
{
    char_u      buf[MAXPATHL + 1];

    expand_env(name, buffer, MAXPATHL);
    if (!mch_isFullName(buffer) && gui_find_bitmap(buffer, buf, ext) == OK)
        STRCPY(buffer, buf);
}
# endif
#endif

#if defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11) || defined(PROTO)
    void
display_errors()
{
    char_u      *p;

    if (isatty(2))
        fflush(stderr);
    else if (error_ga.ga_data != NULL)
    {
        /* avoid putting up a message box with blanks only */
        for (p = (char_u *)error_ga.ga_data; *p != NUL; ++p)
            if (!isspace(*p))
            {
                /* Truncate a very long message, it will go off-screen. */
                if (STRLEN(p) > 2000)
                    STRCPY(p + 2000 - 14, "...(truncated)");
                (void)do_dialog(VIM_ERROR, (char_u *)_("Error"),
                                              p, (char_u *)_("&Ok"), 1, NULL);
                break;
            }
        ga_clear(&error_ga);
    }
}
#endif

#if defined(NO_CONSOLE_INPUT) || defined(PROTO)
/*
 * Return TRUE if still starting up and there is no place to enter text.
 * For GTK and X11 we check if stderr is not a tty, which means we were
 * (probably) started from the desktop.  Also check stdin, "vim >& file" does
 * allow typing on stdin.
 */
    int
no_console_input()
{
    return ((!gui.in_use || gui.starting)
# ifndef NO_CONSOLE
            && !isatty(0) && !isatty(2)
# endif
            );
}
#endif

#if defined(FIND_REPLACE_DIALOG) || defined(FEAT_SUN_WORKSHOP) \
        || defined(NEED_GUI_UPDATE_SCREEN) \
        || defined(PROTO)
/*
 * Update the current window and the screen.
 */
    void
gui_update_screen()
{
    update_topline();
    validate_cursor();
#ifdef FEAT_AUTOCMD
    /* Trigger CursorMoved if the cursor moved. */
    if (!finish_op && has_cursormoved()
            && !equalpos(last_cursormoved, curwin->w_cursor))
    {
        apply_autocmds(EVENT_CURSORMOVED, NULL, NULL, FALSE, curbuf);
        last_cursormoved = curwin->w_cursor;
    }
#endif
    update_screen(0);   /* may need to update the screen */
    setcursor();
    out_flush();                /* make sure output has been written */
    gui_update_cursor(TRUE, FALSE);
    gui_mch_flush();
}
#endif

#if defined(FIND_REPLACE_DIALOG) || defined(PROTO)
static void concat_esc __ARGS((garray_T *gap, char_u *text, int what));

/*
 * Get the text to use in a find/replace dialog.  Uses the last search pattern
 * if the argument is empty.
 * Returns an allocated string.
 */
    char_u *
get_find_dialog_text(arg, wwordp, mcasep)
    char_u      *arg;
    int         *wwordp;        /* return: TRUE if \< \> found */
    int         *mcasep;        /* return: TRUE if \C found */
{
    char_u      *text;

    if (*arg == NUL)
        text = last_search_pat();
    else
        text = arg;
    if (text != NULL)
    {
        text = vim_strsave(text);
        if (text != NULL)
        {
            int len = (int)STRLEN(text);
            int i;

            /* Remove "\V" */
            if (len >= 2 && STRNCMP(text, "\\V", 2) == 0)
            {
                mch_memmove(text, text + 2, (size_t)(len - 1));
                len -= 2;
            }

            /* Recognize "\c" and "\C" and remove. */
            if (len >= 2 && *text == '\\' && (text[1] == 'c' || text[1] == 'C'))
            {
                *mcasep = (text[1] == 'C');
                mch_memmove(text, text + 2, (size_t)(len - 1));
                len -= 2;
            }

            /* Recognize "\<text\>" and remove. */
            if (len >= 4
                    && STRNCMP(text, "\\<", 2) == 0
                    && STRNCMP(text + len - 2, "\\>", 2) == 0)
            {
                *wwordp = TRUE;
                mch_memmove(text, text + 2, (size_t)(len - 4));
                text[len - 4] = NUL;
            }

            /* Recognize "\/" or "\?" and remove. */
            for (i = 0; i + 1 < len; ++i)
                if (text[i] == '\\' && (text[i + 1] == '/'
                                                       || text[i + 1] == '?'))
                {
                    mch_memmove(text + i, text + i + 1, (size_t)(len - i));
                    --len;
                }
        }
    }
    return text;
}

/*
 * Concatenate "text" to grow array "gap", escaping "what" with a backslash.
 */
    static void
concat_esc(gap, text, what)
    garray_T    *gap;
    char_u      *text;
    int         what;
{
    while (*text != NUL)
    {
#ifdef FEAT_MBYTE
        int l = (*mb_ptr2len)(text);

        if (l > 1)
        {
            while (--l >= 0)
                ga_append(gap, *text++);
            continue;
        }
#endif
        if (*text == what)
            ga_append(gap, '\\');
        ga_append(gap, *text);
        ++text;
    }
}

/*
 * Handle the press of a button in the find-replace dialog.
 * Return TRUE when something was added to the input buffer.
 */
    int
gui_do_findrepl(flags, find_text, repl_text, down)
    int         flags;          /* one of FRD_REPLACE, FRD_FINDNEXT, etc. */
    char_u      *find_text;
    char_u      *repl_text;
    int         down;           /* Search downwards. */
{
    garray_T    ga;
    int         i;
    int         type = (flags & FRD_TYPE_MASK);
    char_u      *p;
    regmatch_T  regmatch;
    int         save_did_emsg = did_emsg;

    ga_init2(&ga, 1, 100);
    if (type == FRD_REPLACEALL)
        ga_concat(&ga, (char_u *)"%s/");

    ga_concat(&ga, (char_u *)"\\V");
    if (flags & FRD_MATCH_CASE)
        ga_concat(&ga, (char_u *)"\\C");
    else
        ga_concat(&ga, (char_u *)"\\c");
    if (flags & FRD_WHOLE_WORD)
        ga_concat(&ga, (char_u *)"\\<");
    if (type == FRD_REPLACEALL || down)
        concat_esc(&ga, find_text, '/');        /* escape slashes */
    else
        concat_esc(&ga, find_text, '?');        /* escape '?' */
    if (flags & FRD_WHOLE_WORD)
        ga_concat(&ga, (char_u *)"\\>");

    if (type == FRD_REPLACEALL)
    {
        ga_concat(&ga, (char_u *)"/");
                                                /* escape / and \ */
        p = vim_strsave_escaped(repl_text, (char_u *)"/\\");
        if (p != NULL)
            ga_concat(&ga, p);
        vim_free(p);
        ga_concat(&ga, (char_u *)"/g");
    }
    ga_append(&ga, NUL);

    if (type == FRD_REPLACE)
    {
        /* Do the replacement when the text at the cursor matches.  Thus no
         * replacement is done if the cursor was moved! */
        regmatch.regprog = vim_regcomp(ga.ga_data, RE_MAGIC + RE_STRING);
        regmatch.rm_ic = 0;
        if (regmatch.regprog != NULL)
        {
            p = ml_get_cursor();
            if (vim_regexec_nl(&regmatch, p, (colnr_T)0)
                                                   && regmatch.startp[0] == p)
            {
                /* Clear the command line to remove any old "No match"
                 * error. */
                msg_end_prompt();

                if (u_save_cursor() == OK)
                {
                    /* A button was pressed thus undo should be synced. */
                    u_sync(FALSE);

                    del_bytes((long)(regmatch.endp[0] - regmatch.startp[0]),
                                                                FALSE, FALSE);
                    ins_str(repl_text);
                }
            }
            else
                MSG(_("No match at cursor, finding next"));
            vim_free(regmatch.regprog);
        }
    }

    if (type == FRD_REPLACEALL)
    {
        /* A button was pressed, thus undo should be synced. */
        u_sync(FALSE);
        do_cmdline_cmd(ga.ga_data);
    }
    else
    {
        /* Search for the next match. */
        i = msg_scroll;
        do_search(NULL, down ? '/' : '?', ga.ga_data, 1L,
                                              SEARCH_MSG + SEARCH_MARK, NULL);
        msg_scroll = i;     /* don't let an error message set msg_scroll */
    }

    /* Don't want to pass did_emsg to other code, it may cause disabling
     * syntax HL if we were busy redrawing. */
    did_emsg = save_did_emsg;

    if (State & (NORMAL | INSERT))
    {
        gui_update_screen();            /* update the screen */
        msg_didout = 0;                 /* overwrite any message */
        need_wait_return = FALSE;       /* don't wait for return */
    }

    vim_free(ga.ga_data);
    return (ga.ga_len > 0);
}

#endif

#if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
        || defined(FEAT_GUI_MSWIN) \
        || defined(FEAT_GUI_MAC) \
        || defined(PROTO)

#ifdef FEAT_WINDOWS
static void gui_wingoto_xy __ARGS((int x, int y));

/*
 * Jump to the window at specified point (x, y).
 */
    static void
gui_wingoto_xy(x, y)
    int x;
    int y;
{
    int         row = Y_2_ROW(y);
    int         col = X_2_COL(x);
    win_T       *wp;

    if (row >= 0 && col >= 0)
    {
        wp = mouse_find_win(&row, &col);
        if (wp != NULL && wp != curwin)
            win_goto(wp);
    }
}
#endif

/*
 * Process file drop.  Mouse cursor position, key modifiers, name of files
 * and count of files are given.  Argument "fnames[count]" has full pathnames
 * of dropped files, they will be freed in this function, and caller can't use
 * fnames after call this function.
 */
    void
gui_handle_drop(x, y, modifiers, fnames, count)
    int         x;
    int         y;
    int_u       modifiers;
    char_u      **fnames;
    int         count;
{
    int         i;
    char_u      *p;
    static int  entered = FALSE;

    /*
     * This function is called by event handlers.  Just in case we get a
     * second event before the first one is handled, ignore the second one.
     * Not sure if this can ever happen, just in case.
     */
    if (entered)
        return;
    entered = TRUE;

    /*
     * When the cursor is at the command line, add the file names to the
     * command line, don't edit the files.
     */
    if (State & CMDLINE)
    {
        shorten_filenames(fnames, count);
        for (i = 0; i < count; ++i)
        {
            if (fnames[i] != NULL)
            {
                if (i > 0)
                    add_to_input_buf((char_u*)" ", 1);

                /* We don't know what command is used thus we can't be sure
                 * about which characters need to be escaped.  Only escape the
                 * most common ones. */
# ifdef BACKSLASH_IN_FILENAME
                p = vim_strsave_escaped(fnames[i], (char_u *)" \t\"|");
# else
                p = vim_strsave_escaped(fnames[i], (char_u *)"\\ \t\"|");
# endif
                if (p != NULL)
                    add_to_input_buf_csi(p, (int)STRLEN(p));
                vim_free(p);
                vim_free(fnames[i]);
            }
        }
        vim_free(fnames);
    }
    else
    {
        /* Go to the window under mouse cursor, then shorten given "fnames" by
         * current window, because a window can have local current dir. */
# ifdef FEAT_WINDOWS
        gui_wingoto_xy(x, y);
# endif
        shorten_filenames(fnames, count);

        /* If Shift held down, remember the first item. */
        if ((modifiers & MOUSE_SHIFT) != 0)
            p = vim_strsave(fnames[0]);
        else
            p = NULL;

        /* Handle the drop, :edit or :split to get to the file.  This also
         * frees fnames[].  Skip this if there is only one item it's a
         * directory and Shift is held down. */
        if (count == 1 && (modifiers & MOUSE_SHIFT) != 0
                                                     && mch_isdir(fnames[0]))
        {
            vim_free(fnames[0]);
            vim_free(fnames);
        }
        else
            handle_drop(count, fnames, (modifiers & MOUSE_CTRL) != 0);

        /* If Shift held down, change to first file's directory.  If the first
         * item is a directory, change to that directory (and let the explorer
         * plugin show the contents). */
        if (p != NULL)
        {
            if (mch_isdir(p))
            {
                if (mch_chdir((char *)p) == 0)
                    shorten_fnames(TRUE);
            }
            else if (vim_chdirfile(p) == OK)
                shorten_fnames(TRUE);
            vim_free(p);
        }

        /* Update the screen display */
        update_screen(NOT_VALID);
# ifdef FEAT_MENU
        gui_update_menus(0);
# endif
        setcursor();
        out_flush();
        gui_update_cursor(FALSE, FALSE);
        gui_mch_flush();
    }

    entered = FALSE;
}
#endif