xref: /vim-8.2.3635/src/message.c (revision 57e4ee4d)
1 /* vi:set ts=8 sts=4 sw=4:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 
10 /*
11  * message.c: functions for displaying messages on the command line
12  */
13 
14 #define MESSAGE_FILE		/* don't include prototype for smsg() */
15 
16 #include "vim.h"
17 
18 #if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
19 # include <math.h>
20 #endif
21 
22 static int other_sourcing_name __ARGS((void));
23 static char_u *get_emsg_source __ARGS((void));
24 static char_u *get_emsg_lnum __ARGS((void));
25 static void add_msg_hist __ARGS((char_u *s, int len, int attr));
26 static void hit_return_msg __ARGS((void));
27 static void msg_home_replace_attr __ARGS((char_u *fname, int attr));
28 #ifdef FEAT_MBYTE
29 static char_u *screen_puts_mbyte __ARGS((char_u *s, int l, int attr));
30 #endif
31 static void msg_puts_attr_len __ARGS((char_u *str, int maxlen, int attr));
32 static void msg_puts_display __ARGS((char_u *str, int maxlen, int attr, int recurse));
33 static void msg_scroll_up __ARGS((void));
34 static void inc_msg_scrolled __ARGS((void));
35 static void store_sb_text __ARGS((char_u **sb_str, char_u *s, int attr, int *sb_col, int finish));
36 static void t_puts __ARGS((int *t_col, char_u *t_s, char_u *s, int attr));
37 static void msg_puts_printf __ARGS((char_u *str, int maxlen));
38 static int do_more_prompt __ARGS((int typed_char));
39 static void msg_screen_putchar __ARGS((int c, int attr));
40 static int  msg_check_screen __ARGS((void));
41 static void redir_write __ARGS((char_u *s, int maxlen));
42 #ifdef FEAT_CON_DIALOG
43 static char_u *msg_show_console_dialog __ARGS((char_u *message, char_u *buttons, int dfltbutton));
44 static int	confirm_msg_used = FALSE;	/* displaying confirm_msg */
45 static char_u	*confirm_msg = NULL;		/* ":confirm" message */
46 static char_u	*confirm_msg_tail;		/* tail of confirm_msg */
47 #endif
48 
49 struct msg_hist
50 {
51     struct msg_hist	*next;
52     char_u		*msg;
53     int			attr;
54 };
55 
56 static struct msg_hist *first_msg_hist = NULL;
57 static struct msg_hist *last_msg_hist = NULL;
58 static int msg_hist_len = 0;
59 
60 static FILE *verbose_fd = NULL;
61 static int  verbose_did_open = FALSE;
62 
63 /*
64  * When writing messages to the screen, there are many different situations.
65  * A number of variables is used to remember the current state:
66  * msg_didany	    TRUE when messages were written since the last time the
67  *		    user reacted to a prompt.
68  *		    Reset: After hitting a key for the hit-return prompt,
69  *		    hitting <CR> for the command line or input().
70  *		    Set: When any message is written to the screen.
71  * msg_didout	    TRUE when something was written to the current line.
72  *		    Reset: When advancing to the next line, when the current
73  *		    text can be overwritten.
74  *		    Set: When any message is written to the screen.
75  * msg_nowait	    No extra delay for the last drawn message.
76  *		    Used in normal_cmd() before the mode message is drawn.
77  * emsg_on_display  There was an error message recently.  Indicates that there
78  *		    should be a delay before redrawing.
79  * msg_scroll	    The next message should not overwrite the current one.
80  * msg_scrolled	    How many lines the screen has been scrolled (because of
81  *		    messages).  Used in update_screen() to scroll the screen
82  *		    back.  Incremented each time the screen scrolls a line.
83  * msg_scrolled_ign  TRUE when msg_scrolled is non-zero and msg_puts_attr()
84  *		    writes something without scrolling should not make
85  *		    need_wait_return to be set.  This is a hack to make ":ts"
86  *		    work without an extra prompt.
87  * lines_left	    Number of lines available for messages before the
88  *		    more-prompt is to be given.  -1 when not set.
89  * need_wait_return TRUE when the hit-return prompt is needed.
90  *		    Reset: After giving the hit-return prompt, when the user
91  *		    has answered some other prompt.
92  *		    Set: When the ruler or typeahead display is overwritten,
93  *		    scrolling the screen for some message.
94  * keep_msg	    Message to be displayed after redrawing the screen, in
95  *		    main_loop().
96  *		    This is an allocated string or NULL when not used.
97  */
98 
99 /*
100  * msg(s) - displays the string 's' on the status line
101  * When terminal not initialized (yet) mch_errmsg(..) is used.
102  * return TRUE if wait_return not called
103  */
104     int
105 msg(s)
106     char_u	*s;
107 {
108     return msg_attr_keep(s, 0, FALSE);
109 }
110 
111 #if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
112     || defined(FEAT_GUI_GTK) || defined(PROTO)
113 /*
114  * Like msg() but keep it silent when 'verbosefile' is set.
115  */
116     int
117 verb_msg(s)
118     char_u	*s;
119 {
120     int		n;
121 
122     verbose_enter();
123     n = msg_attr_keep(s, 0, FALSE);
124     verbose_leave();
125 
126     return n;
127 }
128 #endif
129 
130     int
131 msg_attr(s, attr)
132     char_u	*s;
133     int		attr;
134 {
135     return msg_attr_keep(s, attr, FALSE);
136 }
137 
138     int
139 msg_attr_keep(s, attr, keep)
140     char_u	*s;
141     int		attr;
142     int		keep;	    /* TRUE: set keep_msg if it doesn't scroll */
143 {
144     static int	entered = 0;
145     int		retval;
146     char_u	*buf = NULL;
147 
148 #ifdef FEAT_EVAL
149     if (attr == 0)
150 	set_vim_var_string(VV_STATUSMSG, s, -1);
151 #endif
152 
153     /*
154      * It is possible that displaying a messages causes a problem (e.g.,
155      * when redrawing the window), which causes another message, etc..	To
156      * break this loop, limit the recursiveness to 3 levels.
157      */
158     if (entered >= 3)
159 	return TRUE;
160     ++entered;
161 
162     /* Add message to history (unless it's a repeated kept message or a
163      * truncated message) */
164     if (s != keep_msg
165 	    || (*s != '<'
166 		&& last_msg_hist != NULL
167 		&& last_msg_hist->msg != NULL
168 		&& STRCMP(s, last_msg_hist->msg)))
169 	add_msg_hist(s, -1, attr);
170 
171     /* When displaying keep_msg, don't let msg_start() free it, caller must do
172      * that. */
173     if (s == keep_msg)
174 	keep_msg = NULL;
175 
176     /* Truncate the message if needed. */
177     msg_start();
178     buf = msg_strtrunc(s, FALSE);
179     if (buf != NULL)
180 	s = buf;
181 
182     msg_outtrans_attr(s, attr);
183     msg_clr_eos();
184     retval = msg_end();
185 
186     if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
187 							   * Columns + sc_col)
188 	set_keep_msg(s, 0);
189 
190     vim_free(buf);
191     --entered;
192     return retval;
193 }
194 
195 /*
196  * Truncate a string such that it can be printed without causing a scroll.
197  * Returns an allocated string or NULL when no truncating is done.
198  */
199     char_u *
200 msg_strtrunc(s, force)
201     char_u	*s;
202     int		force;	    /* always truncate */
203 {
204     char_u	*buf = NULL;
205     int		len;
206     int		room;
207 
208     /* May truncate message to avoid a hit-return prompt */
209     if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
210 			       && !exmode_active && msg_silent == 0) || force)
211     {
212 	len = vim_strsize(s);
213 	if (msg_scrolled != 0)
214 	    /* Use all the columns. */
215 	    room = (int)(Rows - msg_row) * Columns - 1;
216 	else
217 	    /* Use up to 'showcmd' column. */
218 	    room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
219 	if (len > room && room > 0)
220 	{
221 #ifdef FEAT_MBYTE
222 	    if (enc_utf8)
223 		/* may have up to 18 bytes per cell (6 per char, up to two
224 		 * composing chars) */
225 		len = (room + 2) * 18;
226 	    else if (enc_dbcs == DBCS_JPNU)
227 		/* may have up to 2 bytes per cell for euc-jp */
228 		len = (room + 2) * 2;
229 	    else
230 #endif
231 		len = room + 2;
232 	    buf = alloc(len);
233 	    if (buf != NULL)
234 		trunc_string(s, buf, room, len);
235 	}
236     }
237     return buf;
238 }
239 
240 /*
241  * Truncate a string "s" to "buf" with cell width "room".
242  * "s" and "buf" may be equal.
243  */
244     void
245 trunc_string(s, buf, room, buflen)
246     char_u	*s;
247     char_u	*buf;
248     int		room;
249     int		buflen;
250 {
251     int		half;
252     int		len;
253     int		e;
254     int		i;
255     int		n;
256 
257     room -= 3;
258     half = room / 2;
259     len = 0;
260 
261     /* First part: Start of the string. */
262     for (e = 0; len < half && e < buflen; ++e)
263     {
264 	if (s[e] == NUL)
265 	{
266 	    /* text fits without truncating! */
267 	    buf[e] = NUL;
268 	    return;
269 	}
270 	n = ptr2cells(s + e);
271 	if (len + n >= half)
272 	    break;
273 	len += n;
274 	buf[e] = s[e];
275 #ifdef FEAT_MBYTE
276 	if (has_mbyte)
277 	    for (n = (*mb_ptr2len)(s + e); --n > 0; )
278 	    {
279 		if (++e == buflen)
280 		    break;
281 		buf[e] = s[e];
282 	    }
283 #endif
284     }
285 
286     /* Last part: End of the string. */
287     i = e;
288 #ifdef FEAT_MBYTE
289     if (enc_dbcs != 0)
290     {
291 	/* For DBCS going backwards in a string is slow, but
292 	 * computing the cell width isn't too slow: go forward
293 	 * until the rest fits. */
294 	n = vim_strsize(s + i);
295 	while (len + n > room)
296 	{
297 	    n -= ptr2cells(s + i);
298 	    i += (*mb_ptr2len)(s + i);
299 	}
300     }
301     else if (enc_utf8)
302     {
303 	/* For UTF-8 we can go backwards easily. */
304 	half = i = (int)STRLEN(s);
305 	for (;;)
306 	{
307 	    do
308 		half = half - (*mb_head_off)(s, s + half - 1) - 1;
309 	    while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
310 	    n = ptr2cells(s + half);
311 	    if (len + n > room)
312 		break;
313 	    len += n;
314 	    i = half;
315 	}
316     }
317     else
318 #endif
319     {
320 	for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
321 	    len += n;
322     }
323 
324     /* Set the middle and copy the last part. */
325     if (e + 3 < buflen)
326     {
327 	mch_memmove(buf + e, "...", (size_t)3);
328 	len = (int)STRLEN(s + i) + 1;
329 	if (len >= buflen - e - 3)
330 	    len = buflen - e - 3 - 1;
331 	mch_memmove(buf + e + 3, s + i, len);
332 	buf[e + 3 + len - 1] = NUL;
333     }
334     else
335     {
336 	buf[e - 1] = NUL;  /* make sure it is truncated */
337     }
338 }
339 
340 /*
341  * Automatic prototype generation does not understand this function.
342  * Note: Caller of smgs() and smsg_attr() must check the resulting string is
343  * shorter than IOSIZE!!!
344  */
345 #ifndef PROTO
346 # ifndef HAVE_STDARG_H
347 
348 int
349 #ifdef __BORLANDC__
350 _RTLENTRYF
351 #endif
352 smsg __ARGS((char_u *, long, long, long,
353 			long, long, long, long, long, long, long));
354 int
355 #ifdef __BORLANDC__
356 _RTLENTRYF
357 #endif
358 smsg_attr __ARGS((int, char_u *, long, long, long,
359 			long, long, long, long, long, long, long));
360 
361 int vim_snprintf __ARGS((char *, size_t, char *, long, long, long,
362 				   long, long, long, long, long, long, long));
363 
364 /*
365  * smsg(str, arg, ...) is like using sprintf(buf, str, arg, ...) and then
366  * calling msg(buf).
367  * The buffer used is IObuff, the message is truncated at IOSIZE.
368  */
369 
370 /* VARARGS */
371     int
372 #ifdef __BORLANDC__
373 _RTLENTRYF
374 #endif
375 smsg(s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
376     char_u	*s;
377     long	a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
378 {
379     return smsg_attr(0, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
380 }
381 
382 /* VARARGS */
383     int
384 #ifdef __BORLANDC__
385 _RTLENTRYF
386 #endif
387 smsg_attr(attr, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
388     int		attr;
389     char_u	*s;
390     long	a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
391 {
392     vim_snprintf((char *)IObuff, IOSIZE, (char *)s,
393 				     a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
394     return msg_attr(IObuff, attr);
395 }
396 
397 # else /* HAVE_STDARG_H */
398 
399 int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
400 
401     int
402 #ifdef __BORLANDC__
403 _RTLENTRYF
404 #endif
405 smsg(char_u *s, ...)
406 {
407     va_list arglist;
408 
409     va_start(arglist, s);
410     vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
411     va_end(arglist);
412     return msg(IObuff);
413 }
414 
415     int
416 #ifdef __BORLANDC__
417 _RTLENTRYF
418 #endif
419 smsg_attr(int attr, char_u *s, ...)
420 {
421     va_list arglist;
422 
423     va_start(arglist, s);
424     vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
425     va_end(arglist);
426     return msg_attr(IObuff, attr);
427 }
428 
429 # endif /* HAVE_STDARG_H */
430 #endif
431 
432 /*
433  * Remember the last sourcing name/lnum used in an error message, so that it
434  * isn't printed each time when it didn't change.
435  */
436 static int	last_sourcing_lnum = 0;
437 static char_u   *last_sourcing_name = NULL;
438 
439 /*
440  * Reset the last used sourcing name/lnum.  Makes sure it is displayed again
441  * for the next error message;
442  */
443     void
444 reset_last_sourcing()
445 {
446     vim_free(last_sourcing_name);
447     last_sourcing_name = NULL;
448     last_sourcing_lnum = 0;
449 }
450 
451 /*
452  * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
453  */
454     static int
455 other_sourcing_name()
456 {
457     if (sourcing_name != NULL)
458     {
459 	if (last_sourcing_name != NULL)
460 	    return STRCMP(sourcing_name, last_sourcing_name) != 0;
461 	return TRUE;
462     }
463     return FALSE;
464 }
465 
466 /*
467  * Get the message about the source, as used for an error message.
468  * Returns an allocated string with room for one more character.
469  * Returns NULL when no message is to be given.
470  */
471     static char_u *
472 get_emsg_source()
473 {
474     char_u	*Buf, *p;
475 
476     if (sourcing_name != NULL && other_sourcing_name())
477     {
478 	p = (char_u *)_("Error detected while processing %s:");
479 	Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
480 	if (Buf != NULL)
481 	    sprintf((char *)Buf, (char *)p, sourcing_name);
482 	return Buf;
483     }
484     return NULL;
485 }
486 
487 /*
488  * Get the message about the source lnum, as used for an error message.
489  * Returns an allocated string with room for one more character.
490  * Returns NULL when no message is to be given.
491  */
492     static char_u *
493 get_emsg_lnum()
494 {
495     char_u	*Buf, *p;
496 
497     /* lnum is 0 when executing a command from the command line
498      * argument, we don't want a line number then */
499     if (sourcing_name != NULL
500 	    && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
501 	    && sourcing_lnum != 0)
502     {
503 	p = (char_u *)_("line %4ld:");
504 	Buf = alloc((unsigned)(STRLEN(p) + 20));
505 	if (Buf != NULL)
506 	    sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
507 	return Buf;
508     }
509     return NULL;
510 }
511 
512 /*
513  * Display name and line number for the source of an error.
514  * Remember the file name and line number, so that for the next error the info
515  * is only displayed if it changed.
516  */
517     void
518 msg_source(attr)
519     int		attr;
520 {
521     char_u	*p;
522 
523     ++no_wait_return;
524     p = get_emsg_source();
525     if (p != NULL)
526     {
527 	msg_attr(p, attr);
528 	vim_free(p);
529     }
530     p = get_emsg_lnum();
531     if (p != NULL)
532     {
533 	msg_attr(p, hl_attr(HLF_N));
534 	vim_free(p);
535 	last_sourcing_lnum = sourcing_lnum;  /* only once for each line */
536     }
537 
538     /* remember the last sourcing name printed, also when it's empty */
539     if (sourcing_name == NULL || other_sourcing_name())
540     {
541 	vim_free(last_sourcing_name);
542 	if (sourcing_name == NULL)
543 	    last_sourcing_name = NULL;
544 	else
545 	    last_sourcing_name = vim_strsave(sourcing_name);
546     }
547     --no_wait_return;
548 }
549 
550 /*
551  * Return TRUE if not giving error messages right now:
552  * If "emsg_off" is set: no error messages at the moment.
553  * If "msg" is in 'debug': do error message but without side effects.
554  * If "emsg_skip" is set: never do error messages.
555  */
556     int
557 emsg_not_now()
558 {
559     if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
560 					  && vim_strchr(p_debug, 't') == NULL)
561 #ifdef FEAT_EVAL
562 	    || emsg_skip > 0
563 #endif
564 	    )
565 	return TRUE;
566     return FALSE;
567 }
568 
569 /*
570  * emsg() - display an error message
571  *
572  * Rings the bell, if appropriate, and calls message() to do the real work
573  * When terminal not initialized (yet) mch_errmsg(..) is used.
574  *
575  * return TRUE if wait_return not called
576  */
577     int
578 emsg(s)
579     char_u	*s;
580 {
581     int		attr;
582     char_u	*p;
583 #ifdef FEAT_EVAL
584     int		ignore = FALSE;
585     int		severe;
586 #endif
587 
588     /* Skip this if not giving error messages at the moment. */
589     if (emsg_not_now())
590 	return TRUE;
591 
592     called_emsg = TRUE;
593     ex_exitval = 1;
594 
595     /*
596      * If "emsg_severe" is TRUE: When an error exception is to be thrown,
597      * prefer this message over previous messages for the same command.
598      */
599 #ifdef FEAT_EVAL
600     severe = emsg_severe;
601     emsg_severe = FALSE;
602 #endif
603 
604     if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
605     {
606 #ifdef FEAT_EVAL
607 	/*
608 	 * Cause a throw of an error exception if appropriate.  Don't display
609 	 * the error message in this case.  (If no matching catch clause will
610 	 * be found, the message will be displayed later on.)  "ignore" is set
611 	 * when the message should be ignored completely (used for the
612 	 * interrupt message).
613 	 */
614 	if (cause_errthrow(s, severe, &ignore) == TRUE)
615 	{
616 	    if (!ignore)
617 		did_emsg = TRUE;
618 	    return TRUE;
619 	}
620 
621 	/* set "v:errmsg", also when using ":silent! cmd" */
622 	set_vim_var_string(VV_ERRMSG, s, -1);
623 #endif
624 
625 	/*
626 	 * When using ":silent! cmd" ignore error messages.
627 	 * But do write it to the redirection file.
628 	 */
629 	if (emsg_silent != 0)
630 	{
631 	    msg_start();
632 	    p = get_emsg_source();
633 	    if (p != NULL)
634 	    {
635 		STRCAT(p, "\n");
636 		redir_write(p, -1);
637 		vim_free(p);
638 	    }
639 	    p = get_emsg_lnum();
640 	    if (p != NULL)
641 	    {
642 		STRCAT(p, "\n");
643 		redir_write(p, -1);
644 		vim_free(p);
645 	    }
646 	    redir_write(s, -1);
647 	    return TRUE;
648 	}
649 
650 	/* Reset msg_silent, an error causes messages to be switched back on. */
651 	msg_silent = 0;
652 	cmd_silent = FALSE;
653 
654 	if (global_busy)		/* break :global command */
655 	    ++global_busy;
656 
657 	if (p_eb)
658 	    beep_flush();		/* also includes flush_buffers() */
659 	else
660 	    flush_buffers(FALSE);	/* flush internal buffers */
661 	did_emsg = TRUE;		/* flag for DoOneCmd() */
662     }
663 
664     emsg_on_display = TRUE;	/* remember there is an error message */
665     ++msg_scroll;		/* don't overwrite a previous message */
666     attr = hl_attr(HLF_E);	/* set highlight mode for error messages */
667     if (msg_scrolled != 0)
668 	need_wait_return = TRUE;    /* needed in case emsg() is called after
669 				     * wait_return has reset need_wait_return
670 				     * and a redraw is expected because
671 				     * msg_scrolled is non-zero */
672 
673     /*
674      * Display name and line number for the source of the error.
675      */
676     msg_source(attr);
677 
678     /*
679      * Display the error message itself.
680      */
681     msg_nowait = FALSE;			/* wait for this msg */
682     return msg_attr(s, attr);
683 }
684 
685 /*
686  * Print an error message with one "%s" and one string argument.
687  */
688     int
689 emsg2(s, a1)
690     char_u *s, *a1;
691 {
692     return emsg3(s, a1, NULL);
693 }
694 
695 /* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
696 
697     void
698 emsg_invreg(name)
699     int	    name;
700 {
701     EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
702 }
703 
704 /*
705  * Like msg(), but truncate to a single line if p_shm contains 't', or when
706  * "force" is TRUE.  This truncates in another way as for normal messages.
707  * Careful: The string may be changed by msg_may_trunc()!
708  * Returns a pointer to the printed message, if wait_return() not called.
709  */
710     char_u *
711 msg_trunc_attr(s, force, attr)
712     char_u	*s;
713     int		force;
714     int		attr;
715 {
716     int		n;
717 
718     /* Add message to history before truncating */
719     add_msg_hist(s, -1, attr);
720 
721     s = msg_may_trunc(force, s);
722 
723     msg_hist_off = TRUE;
724     n = msg_attr(s, attr);
725     msg_hist_off = FALSE;
726 
727     if (n)
728 	return s;
729     return NULL;
730 }
731 
732 /*
733  * Check if message "s" should be truncated at the start (for filenames).
734  * Return a pointer to where the truncated message starts.
735  * Note: May change the message by replacing a character with '<'.
736  */
737     char_u *
738 msg_may_trunc(force, s)
739     int		force;
740     char_u	*s;
741 {
742     int		n;
743     int		room;
744 
745     room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
746     if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
747 	    && (n = (int)STRLEN(s) - room) > 0)
748     {
749 #ifdef FEAT_MBYTE
750 	if (has_mbyte)
751 	{
752 	    int	size = vim_strsize(s);
753 
754 	    /* There may be room anyway when there are multibyte chars. */
755 	    if (size <= room)
756 		return s;
757 
758 	    for (n = 0; size >= room; )
759 	    {
760 		size -= (*mb_ptr2cells)(s + n);
761 		n += (*mb_ptr2len)(s + n);
762 	    }
763 	    --n;
764 	}
765 #endif
766 	s += n;
767 	*s = '<';
768     }
769     return s;
770 }
771 
772     static void
773 add_msg_hist(s, len, attr)
774     char_u	*s;
775     int		len;		/* -1 for undetermined length */
776     int		attr;
777 {
778     struct msg_hist *p;
779 
780     if (msg_hist_off || msg_silent != 0)
781 	return;
782 
783     /* Don't let the message history get too big */
784     while (msg_hist_len > MAX_MSG_HIST_LEN)
785 	(void)delete_first_msg();
786 
787     /* allocate an entry and add the message at the end of the history */
788     p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
789     if (p != NULL)
790     {
791 	if (len < 0)
792 	    len = (int)STRLEN(s);
793 	/* remove leading and trailing newlines */
794 	while (len > 0 && *s == '\n')
795 	{
796 	    ++s;
797 	    --len;
798 	}
799 	while (len > 0 && s[len - 1] == '\n')
800 	    --len;
801 	p->msg = vim_strnsave(s, len);
802 	p->next = NULL;
803 	p->attr = attr;
804 	if (last_msg_hist != NULL)
805 	    last_msg_hist->next = p;
806 	last_msg_hist = p;
807 	if (first_msg_hist == NULL)
808 	    first_msg_hist = last_msg_hist;
809 	++msg_hist_len;
810     }
811 }
812 
813 /*
814  * Delete the first (oldest) message from the history.
815  * Returns FAIL if there are no messages.
816  */
817     int
818 delete_first_msg()
819 {
820     struct msg_hist *p;
821 
822     if (msg_hist_len <= 0)
823 	return FAIL;
824     p = first_msg_hist;
825     first_msg_hist = p->next;
826     if (first_msg_hist == NULL)
827 	last_msg_hist = NULL;  /* history is empty */
828     vim_free(p->msg);
829     vim_free(p);
830     --msg_hist_len;
831     return OK;
832 }
833 
834 /*
835  * ":messages" command.
836  */
837     void
838 ex_messages(eap)
839     exarg_T	*eap UNUSED;
840 {
841     struct msg_hist *p;
842     char_u	    *s;
843 
844     msg_hist_off = TRUE;
845 
846     s = mch_getenv((char_u *)"LANG");
847     if (s != NULL && *s != NUL)
848 	msg_attr((char_u *)
849 		_("Messages maintainer: Bram Moolenaar <[email protected]>"),
850 		hl_attr(HLF_T));
851 
852     for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
853 	if (p->msg != NULL)
854 	    msg_attr(p->msg, p->attr);
855 
856     msg_hist_off = FALSE;
857 }
858 
859 #if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
860 /*
861  * Call this after prompting the user.  This will avoid a hit-return message
862  * and a delay.
863  */
864     void
865 msg_end_prompt()
866 {
867     need_wait_return = FALSE;
868     emsg_on_display = FALSE;
869     cmdline_row = msg_row;
870     msg_col = 0;
871     msg_clr_eos();
872     lines_left = -1;
873 }
874 #endif
875 
876 /*
877  * wait for the user to hit a key (normally a return)
878  * if 'redraw' is TRUE, clear and redraw the screen
879  * if 'redraw' is FALSE, just redraw the screen
880  * if 'redraw' is -1, don't redraw at all
881  */
882     void
883 wait_return(redraw)
884     int		redraw;
885 {
886     int		c;
887     int		oldState;
888     int		tmpState;
889     int		had_got_int;
890 
891     if (redraw == TRUE)
892 	must_redraw = CLEAR;
893 
894     /* If using ":silent cmd", don't wait for a return.  Also don't set
895      * need_wait_return to do it later. */
896     if (msg_silent != 0)
897 	return;
898 
899     /*
900      * When inside vgetc(), we can't wait for a typed character at all.
901      * With the global command (and some others) we only need one return at
902      * the end. Adjust cmdline_row to avoid the next message overwriting the
903      * last one.
904      */
905     if (vgetc_busy > 0)
906 	return;
907     need_wait_return = TRUE;
908     if (no_wait_return)
909     {
910 	if (!exmode_active)
911 	    cmdline_row = msg_row;
912 	return;
913     }
914 
915     redir_off = TRUE;		/* don't redirect this message */
916     oldState = State;
917     if (quit_more)
918     {
919 	c = CAR;		/* just pretend CR was hit */
920 	quit_more = FALSE;
921 	got_int = FALSE;
922     }
923     else if (exmode_active)
924     {
925 	MSG_PUTS(" ");		/* make sure the cursor is on the right line */
926 	c = CAR;		/* no need for a return in ex mode */
927 	got_int = FALSE;
928     }
929     else
930     {
931 	/* Make sure the hit-return prompt is on screen when 'guioptions' was
932 	 * just changed. */
933 	screenalloc(FALSE);
934 
935 	State = HITRETURN;
936 #ifdef FEAT_MOUSE
937 	setmouse();
938 #endif
939 #ifdef USE_ON_FLY_SCROLL
940 	dont_scroll = TRUE;		/* disallow scrolling here */
941 #endif
942 	hit_return_msg();
943 
944 	do
945 	{
946 	    /* Remember "got_int", if it is set vgetc() probably returns a
947 	     * CTRL-C, but we need to loop then. */
948 	    had_got_int = got_int;
949 
950 	    /* Don't do mappings here, we put the character back in the
951 	     * typeahead buffer. */
952 	    ++no_mapping;
953 	    ++allow_keys;
954 	    c = safe_vgetc();
955 	    if (had_got_int && !global_busy)
956 		got_int = FALSE;
957 	    --no_mapping;
958 	    --allow_keys;
959 
960 #ifdef FEAT_CLIPBOARD
961 	    /* Strange way to allow copying (yanking) a modeless selection at
962 	     * the hit-enter prompt.  Use CTRL-Y, because the same is used in
963 	     * Cmdline-mode and it's harmless when there is no selection. */
964 	    if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
965 	    {
966 		clip_copy_modeless_selection(TRUE);
967 		c = K_IGNORE;
968 	    }
969 #endif
970 
971 	    /*
972 	     * Allow scrolling back in the messages.
973 	     * Also accept scroll-down commands when messages fill the screen,
974 	     * to avoid that typing one 'j' too many makes the messages
975 	     * disappear.
976 	     */
977 	    if (p_more && !p_cp)
978 	    {
979 		if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
980 		{
981 		    /* scroll back to show older messages */
982 		    do_more_prompt(c);
983 		    if (quit_more)
984 		    {
985 			c = CAR;		/* just pretend CR was hit */
986 			quit_more = FALSE;
987 			got_int = FALSE;
988 		    }
989 		    else
990 		    {
991 			c = K_IGNORE;
992 			hit_return_msg();
993 		    }
994 		}
995 		else if (msg_scrolled > Rows - 2
996 			 && (c == 'j' || c == K_DOWN || c == 'd' || c == 'f'))
997 		    c = K_IGNORE;
998 	    }
999 	} while ((had_got_int && c == Ctrl_C)
1000 				|| c == K_IGNORE
1001 #ifdef FEAT_GUI
1002 				|| c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1003 #endif
1004 #ifdef FEAT_MOUSE
1005 				|| c == K_LEFTDRAG   || c == K_LEFTRELEASE
1006 				|| c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1007 				|| c == K_RIGHTDRAG  || c == K_RIGHTRELEASE
1008 				|| c == K_MOUSELEFT  || c == K_MOUSERIGHT
1009 				|| c == K_MOUSEDOWN  || c == K_MOUSEUP
1010 				|| (!mouse_has(MOUSE_RETURN)
1011 				    && mouse_row < msg_row
1012 				    && (c == K_LEFTMOUSE
1013 					|| c == K_MIDDLEMOUSE
1014 					|| c == K_RIGHTMOUSE
1015 					|| c == K_X1MOUSE
1016 					|| c == K_X2MOUSE))
1017 #endif
1018 				);
1019 	ui_breakcheck();
1020 #ifdef FEAT_MOUSE
1021 	/*
1022 	 * Avoid that the mouse-up event causes visual mode to start.
1023 	 */
1024 	if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1025 					  || c == K_X1MOUSE || c == K_X2MOUSE)
1026 	    (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1027 	else
1028 #endif
1029 	    if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1030 	{
1031 	    /* Put the character back in the typeahead buffer.  Don't use the
1032 	     * stuff buffer, because lmaps wouldn't work. */
1033 	    ins_char_typebuf(c);
1034 	    do_redraw = TRUE;	    /* need a redraw even though there is
1035 				       typeahead */
1036 	}
1037     }
1038     redir_off = FALSE;
1039 
1040     /*
1041      * If the user hits ':', '?' or '/' we get a command line from the next
1042      * line.
1043      */
1044     if (c == ':' || c == '?' || c == '/')
1045     {
1046 	if (!exmode_active)
1047 	    cmdline_row = msg_row;
1048 	skip_redraw = TRUE;	    /* skip redraw once */
1049 	do_redraw = FALSE;
1050     }
1051 
1052     /*
1053      * If the window size changed set_shellsize() will redraw the screen.
1054      * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1055      * typed.
1056      */
1057     tmpState = State;
1058     State = oldState;		    /* restore State before set_shellsize */
1059 #ifdef FEAT_MOUSE
1060     setmouse();
1061 #endif
1062     msg_check();
1063 
1064 #if defined(UNIX) || defined(VMS)
1065     /*
1066      * When switching screens, we need to output an extra newline on exit.
1067      */
1068     if (swapping_screen() && !termcap_active)
1069 	newline_on_exit = TRUE;
1070 #endif
1071 
1072     need_wait_return = FALSE;
1073     did_wait_return = TRUE;
1074     emsg_on_display = FALSE;	/* can delete error message now */
1075     lines_left = -1;		/* reset lines_left at next msg_start() */
1076     reset_last_sourcing();
1077     if (keep_msg != NULL && vim_strsize(keep_msg) >=
1078 				  (Rows - cmdline_row - 1) * Columns + sc_col)
1079     {
1080 	vim_free(keep_msg);
1081 	keep_msg = NULL;	    /* don't redisplay message, it's too long */
1082     }
1083 
1084     if (tmpState == SETWSIZE)	    /* got resize event while in vgetc() */
1085     {
1086 	starttermcap();		    /* start termcap before redrawing */
1087 	shell_resized();
1088     }
1089     else if (!skip_redraw
1090 	    && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1091     {
1092 	starttermcap();		    /* start termcap before redrawing */
1093 	redraw_later(VALID);
1094     }
1095 }
1096 
1097 /*
1098  * Write the hit-return prompt.
1099  */
1100     static void
1101 hit_return_msg()
1102 {
1103     int		save_p_more = p_more;
1104 
1105     p_more = FALSE;	/* don't want see this message when scrolling back */
1106     if (msg_didout)	/* start on a new line */
1107 	msg_putchar('\n');
1108     if (got_int)
1109 	MSG_PUTS(_("Interrupt: "));
1110 
1111     MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
1112     if (!msg_use_printf())
1113 	msg_clr_eos();
1114     p_more = save_p_more;
1115 }
1116 
1117 /*
1118  * Set "keep_msg" to "s".  Free the old value and check for NULL pointer.
1119  */
1120     void
1121 set_keep_msg(s, attr)
1122     char_u	*s;
1123     int		attr;
1124 {
1125     vim_free(keep_msg);
1126     if (s != NULL && msg_silent == 0)
1127 	keep_msg = vim_strsave(s);
1128     else
1129 	keep_msg = NULL;
1130     keep_msg_more = FALSE;
1131     keep_msg_attr = attr;
1132 }
1133 
1134 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1135 /*
1136  * If there currently is a message being displayed, set "keep_msg" to it, so
1137  * that it will be displayed again after redraw.
1138  */
1139     void
1140 set_keep_msg_from_hist()
1141 {
1142     if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1143 							  && (State & NORMAL))
1144 	set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1145 }
1146 #endif
1147 
1148 /*
1149  * Prepare for outputting characters in the command line.
1150  */
1151     void
1152 msg_start()
1153 {
1154     int		did_return = FALSE;
1155 
1156     if (!msg_silent)
1157     {
1158 	vim_free(keep_msg);
1159 	keep_msg = NULL;		/* don't display old message now */
1160     }
1161 
1162 #ifdef FEAT_EVAL
1163     if (need_clr_eos)
1164     {
1165 	/* Halfway an ":echo" command and getting an (error) message: clear
1166 	 * any text from the command. */
1167 	need_clr_eos = FALSE;
1168 	msg_clr_eos();
1169     }
1170 #endif
1171 
1172     if (!msg_scroll && full_screen)	/* overwrite last message */
1173     {
1174 	msg_row = cmdline_row;
1175 	msg_col =
1176 #ifdef FEAT_RIGHTLEFT
1177 	    cmdmsg_rl ? Columns - 1 :
1178 #endif
1179 	    0;
1180     }
1181     else if (msg_didout)		    /* start message on next line */
1182     {
1183 	msg_putchar('\n');
1184 	did_return = TRUE;
1185 	if (exmode_active != EXMODE_NORMAL)
1186 	    cmdline_row = msg_row;
1187     }
1188     if (!msg_didany || lines_left < 0)
1189 	msg_starthere();
1190     if (msg_silent == 0)
1191     {
1192 	msg_didout = FALSE;		    /* no output on current line yet */
1193 	cursor_off();
1194     }
1195 
1196     /* when redirecting, may need to start a new line. */
1197     if (!did_return)
1198 	redir_write((char_u *)"\n", -1);
1199 }
1200 
1201 /*
1202  * Note that the current msg position is where messages start.
1203  */
1204     void
1205 msg_starthere()
1206 {
1207     lines_left = cmdline_row;
1208     msg_didany = FALSE;
1209 }
1210 
1211     void
1212 msg_putchar(c)
1213     int		c;
1214 {
1215     msg_putchar_attr(c, 0);
1216 }
1217 
1218     void
1219 msg_putchar_attr(c, attr)
1220     int		c;
1221     int		attr;
1222 {
1223 #ifdef FEAT_MBYTE
1224     char_u	buf[MB_MAXBYTES + 1];
1225 #else
1226     char_u	buf[4];
1227 #endif
1228 
1229     if (IS_SPECIAL(c))
1230     {
1231 	buf[0] = K_SPECIAL;
1232 	buf[1] = K_SECOND(c);
1233 	buf[2] = K_THIRD(c);
1234 	buf[3] = NUL;
1235     }
1236     else
1237     {
1238 #ifdef FEAT_MBYTE
1239 	buf[(*mb_char2bytes)(c, buf)] = NUL;
1240 #else
1241 	buf[0] = c;
1242 	buf[1] = NUL;
1243 #endif
1244     }
1245     msg_puts_attr(buf, attr);
1246 }
1247 
1248     void
1249 msg_outnum(n)
1250     long	n;
1251 {
1252     char_u	buf[20];
1253 
1254     sprintf((char *)buf, "%ld", n);
1255     msg_puts(buf);
1256 }
1257 
1258     void
1259 msg_home_replace(fname)
1260     char_u	*fname;
1261 {
1262     msg_home_replace_attr(fname, 0);
1263 }
1264 
1265 #if defined(FEAT_FIND_ID) || defined(PROTO)
1266     void
1267 msg_home_replace_hl(fname)
1268     char_u	*fname;
1269 {
1270     msg_home_replace_attr(fname, hl_attr(HLF_D));
1271 }
1272 #endif
1273 
1274     static void
1275 msg_home_replace_attr(fname, attr)
1276     char_u  *fname;
1277     int	    attr;
1278 {
1279     char_u	*name;
1280 
1281     name = home_replace_save(NULL, fname);
1282     if (name != NULL)
1283 	msg_outtrans_attr(name, attr);
1284     vim_free(name);
1285 }
1286 
1287 /*
1288  * Output 'len' characters in 'str' (including NULs) with translation
1289  * if 'len' is -1, output upto a NUL character.
1290  * Use attributes 'attr'.
1291  * Return the number of characters it takes on the screen.
1292  */
1293     int
1294 msg_outtrans(str)
1295     char_u	    *str;
1296 {
1297     return msg_outtrans_attr(str, 0);
1298 }
1299 
1300     int
1301 msg_outtrans_attr(str, attr)
1302     char_u	*str;
1303     int		attr;
1304 {
1305     return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1306 }
1307 
1308     int
1309 msg_outtrans_len(str, len)
1310     char_u	*str;
1311     int		len;
1312 {
1313     return msg_outtrans_len_attr(str, len, 0);
1314 }
1315 
1316 /*
1317  * Output one character at "p".  Return pointer to the next character.
1318  * Handles multi-byte characters.
1319  */
1320     char_u *
1321 msg_outtrans_one(p, attr)
1322     char_u	*p;
1323     int		attr;
1324 {
1325 #ifdef FEAT_MBYTE
1326     int		l;
1327 
1328     if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1329     {
1330 	msg_outtrans_len_attr(p, l, attr);
1331 	return p + l;
1332     }
1333 #endif
1334     msg_puts_attr(transchar_byte(*p), attr);
1335     return p + 1;
1336 }
1337 
1338     int
1339 msg_outtrans_len_attr(msgstr, len, attr)
1340     char_u	*msgstr;
1341     int		len;
1342     int		attr;
1343 {
1344     int		retval = 0;
1345     char_u	*str = msgstr;
1346     char_u	*plain_start = msgstr;
1347     char_u	*s;
1348 #ifdef FEAT_MBYTE
1349     int		mb_l;
1350     int		c;
1351 #endif
1352 
1353     /* if MSG_HIST flag set, add message to history */
1354     if (attr & MSG_HIST)
1355     {
1356 	add_msg_hist(str, len, attr);
1357 	attr &= ~MSG_HIST;
1358     }
1359 
1360 #ifdef FEAT_MBYTE
1361     /* If the string starts with a composing character first draw a space on
1362      * which the composing char can be drawn. */
1363     if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1364 	msg_puts_attr((char_u *)" ", attr);
1365 #endif
1366 
1367     /*
1368      * Go over the string.  Special characters are translated and printed.
1369      * Normal characters are printed several at a time.
1370      */
1371     while (--len >= 0)
1372     {
1373 #ifdef FEAT_MBYTE
1374 	if (enc_utf8)
1375 	    /* Don't include composing chars after the end. */
1376 	    mb_l = utfc_ptr2len_len(str, len + 1);
1377 	else if (has_mbyte)
1378 	    mb_l = (*mb_ptr2len)(str);
1379 	else
1380 	    mb_l = 1;
1381 	if (has_mbyte && mb_l > 1)
1382 	{
1383 	    c = (*mb_ptr2char)(str);
1384 	    if (vim_isprintc(c))
1385 		/* printable multi-byte char: count the cells. */
1386 		retval += (*mb_ptr2cells)(str);
1387 	    else
1388 	    {
1389 		/* unprintable multi-byte char: print the printable chars so
1390 		 * far and the translation of the unprintable char. */
1391 		if (str > plain_start)
1392 		    msg_puts_attr_len(plain_start, (int)(str - plain_start),
1393 									attr);
1394 		plain_start = str + mb_l;
1395 		msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1396 		retval += char2cells(c);
1397 	    }
1398 	    len -= mb_l - 1;
1399 	    str += mb_l;
1400 	}
1401 	else
1402 #endif
1403 	{
1404 	    s = transchar_byte(*str);
1405 	    if (s[1] != NUL)
1406 	    {
1407 		/* unprintable char: print the printable chars so far and the
1408 		 * translation of the unprintable char. */
1409 		if (str > plain_start)
1410 		    msg_puts_attr_len(plain_start, (int)(str - plain_start),
1411 									attr);
1412 		plain_start = str + 1;
1413 		msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
1414 		retval += (int)STRLEN(s);
1415 	    }
1416 	    else
1417 		++retval;
1418 	    ++str;
1419 	}
1420     }
1421 
1422     if (str > plain_start)
1423 	/* print the printable chars at the end */
1424 	msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1425 
1426     return retval;
1427 }
1428 
1429 #if defined(FEAT_QUICKFIX) || defined(PROTO)
1430     void
1431 msg_make(arg)
1432     char_u  *arg;
1433 {
1434     int	    i;
1435     static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1436 
1437     arg = skipwhite(arg);
1438     for (i = 5; *arg && i >= 0; --i)
1439 	if (*arg++ != str[i])
1440 	    break;
1441     if (i < 0)
1442     {
1443 	msg_putchar('\n');
1444 	for (i = 0; rs[i]; ++i)
1445 	    msg_putchar(rs[i] - 3);
1446     }
1447 }
1448 #endif
1449 
1450 /*
1451  * Output the string 'str' upto a NUL character.
1452  * Return the number of characters it takes on the screen.
1453  *
1454  * If K_SPECIAL is encountered, then it is taken in conjunction with the
1455  * following character and shown as <F1>, <S-Up> etc.  Any other character
1456  * which is not printable shown in <> form.
1457  * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1458  * If a character is displayed in one of these special ways, is also
1459  * highlighted (its highlight name is '8' in the p_hl variable).
1460  * Otherwise characters are not highlighted.
1461  * This function is used to show mappings, where we want to see how to type
1462  * the character/string -- webb
1463  */
1464     int
1465 msg_outtrans_special(strstart, from)
1466     char_u	*strstart;
1467     int		from;	/* TRUE for lhs of a mapping */
1468 {
1469     char_u	*str = strstart;
1470     int		retval = 0;
1471     char_u	*string;
1472     int		attr;
1473     int		len;
1474 
1475     attr = hl_attr(HLF_8);
1476     while (*str != NUL)
1477     {
1478 	/* Leading and trailing spaces need to be displayed in <> form. */
1479 	if ((str == strstart || str[1] == NUL) && *str == ' ')
1480 	{
1481 	    string = (char_u *)"<Space>";
1482 	    ++str;
1483 	}
1484 	else
1485 	    string = str2special(&str, from);
1486 	len = vim_strsize(string);
1487 	/* Highlight special keys */
1488 	msg_puts_attr(string, len > 1
1489 #ifdef FEAT_MBYTE
1490 		&& (*mb_ptr2len)(string) <= 1
1491 #endif
1492 		? attr : 0);
1493 	retval += len;
1494     }
1495     return retval;
1496 }
1497 
1498 #if defined(FEAT_EVAL) || defined(PROTO)
1499 /*
1500  * Return the lhs or rhs of a mapping, with the key codes turned into printable
1501  * strings, in an allocated string.
1502  */
1503     char_u *
1504 str2special_save(str, is_lhs)
1505     char_u  *str;
1506     int	    is_lhs;  /* TRUE for lhs, FALSE for rhs */
1507 {
1508     garray_T	ga;
1509     char_u	*p = str;
1510 
1511     ga_init2(&ga, 1, 40);
1512     while (*p != NUL)
1513 	ga_concat(&ga, str2special(&p, is_lhs));
1514     ga_append(&ga, NUL);
1515     return (char_u *)ga.ga_data;
1516 }
1517 #endif
1518 
1519 /*
1520  * Return the printable string for the key codes at "*sp".
1521  * Used for translating the lhs or rhs of a mapping to printable chars.
1522  * Advances "sp" to the next code.
1523  */
1524     char_u *
1525 str2special(sp, from)
1526     char_u	**sp;
1527     int		from;	/* TRUE for lhs of mapping */
1528 {
1529     int			c;
1530     static char_u	buf[7];
1531     char_u		*str = *sp;
1532     int			modifiers = 0;
1533     int			special = FALSE;
1534 
1535 #ifdef FEAT_MBYTE
1536     if (has_mbyte)
1537     {
1538 	char_u	*p;
1539 
1540 	/* Try to un-escape a multi-byte character.  Return the un-escaped
1541 	 * string if it is a multi-byte character. */
1542 	p = mb_unescape(sp);
1543 	if (p != NULL)
1544 	    return p;
1545     }
1546 #endif
1547 
1548     c = *str;
1549     if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1550     {
1551 	if (str[1] == KS_MODIFIER)
1552 	{
1553 	    modifiers = str[2];
1554 	    str += 3;
1555 	    c = *str;
1556 	}
1557 	if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1558 	{
1559 	    c = TO_SPECIAL(str[1], str[2]);
1560 	    str += 2;
1561 	    if (c == K_ZERO)	/* display <Nul> as ^@ */
1562 		c = NUL;
1563 	}
1564 	if (IS_SPECIAL(c) || modifiers)	/* special key */
1565 	    special = TRUE;
1566     }
1567 
1568 #ifdef FEAT_MBYTE
1569     if (has_mbyte && !IS_SPECIAL(c))
1570     {
1571 	int len = (*mb_ptr2len)(str);
1572 
1573 	/* For multi-byte characters check for an illegal byte. */
1574 	if (has_mbyte && MB_BYTE2LEN(*str) > len)
1575 	{
1576 	    transchar_nonprint(buf, c);
1577 	    *sp = str + 1;
1578 	    return buf;
1579 	}
1580 	/* Since 'special' is TRUE the multi-byte character 'c' will be
1581 	 * processed by get_special_key_name() */
1582 	c = (*mb_ptr2char)(str);
1583 	*sp = str + len;
1584     }
1585     else
1586 #endif
1587 	*sp = str + 1;
1588 
1589     /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1590      * Use <Space> only for lhs of a mapping. */
1591     if (special || char2cells(c) > 1 || (from && c == ' '))
1592 	return get_special_key_name(c, modifiers);
1593     buf[0] = c;
1594     buf[1] = NUL;
1595     return buf;
1596 }
1597 
1598 /*
1599  * Translate a key sequence into special key names.
1600  */
1601     void
1602 str2specialbuf(sp, buf, len)
1603     char_u	*sp;
1604     char_u	*buf;
1605     int		len;
1606 {
1607     char_u	*s;
1608 
1609     *buf = NUL;
1610     while (*sp)
1611     {
1612 	s = str2special(&sp, FALSE);
1613 	if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1614 	    STRCAT(buf, s);
1615     }
1616 }
1617 
1618 /*
1619  * print line for :print or :list command
1620  */
1621     void
1622 msg_prt_line(s, list)
1623     char_u	*s;
1624     int		list;
1625 {
1626     int		c;
1627     int		col = 0;
1628     int		n_extra = 0;
1629     int		c_extra = 0;
1630     char_u	*p_extra = NULL;	    /* init to make SASC shut up */
1631     int		n;
1632     int		attr = 0;
1633     char_u	*trail = NULL;
1634 #ifdef FEAT_MBYTE
1635     int		l;
1636     char_u	buf[MB_MAXBYTES + 1];
1637 #endif
1638 
1639     if (curwin->w_p_list)
1640 	list = TRUE;
1641 
1642     /* find start of trailing whitespace */
1643     if (list && lcs_trail)
1644     {
1645 	trail = s + STRLEN(s);
1646 	while (trail > s && vim_iswhite(trail[-1]))
1647 	    --trail;
1648     }
1649 
1650     /* output a space for an empty line, otherwise the line will be
1651      * overwritten */
1652     if (*s == NUL && !(list && lcs_eol != NUL))
1653 	msg_putchar(' ');
1654 
1655     while (!got_int)
1656     {
1657 	if (n_extra > 0)
1658 	{
1659 	    --n_extra;
1660 	    if (c_extra)
1661 		c = c_extra;
1662 	    else
1663 		c = *p_extra++;
1664 	}
1665 #ifdef FEAT_MBYTE
1666 	else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
1667 	{
1668 	    col += (*mb_ptr2cells)(s);
1669 	    if (lcs_nbsp != NUL && list && mb_ptr2char(s) == 160)
1670 	    {
1671 		mb_char2bytes(lcs_nbsp, buf);
1672 		buf[(*mb_ptr2len)(buf)] = NUL;
1673 	    }
1674 	    else
1675 	    {
1676 		mch_memmove(buf, s, (size_t)l);
1677 		buf[l] = NUL;
1678 	    }
1679 	    msg_puts(buf);
1680 	    s += l;
1681 	    continue;
1682 	}
1683 #endif
1684 	else
1685 	{
1686 	    attr = 0;
1687 	    c = *s++;
1688 	    if (c == TAB && (!list || lcs_tab1))
1689 	    {
1690 		/* tab amount depends on current column */
1691 		n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
1692 		if (!list)
1693 		{
1694 		    c = ' ';
1695 		    c_extra = ' ';
1696 		}
1697 		else
1698 		{
1699 		    c = lcs_tab1;
1700 		    c_extra = lcs_tab2;
1701 		    attr = hl_attr(HLF_8);
1702 		}
1703 	    }
1704 	    else if (c == 160 && list && lcs_nbsp != NUL)
1705 	    {
1706 		c = lcs_nbsp;
1707 		attr = hl_attr(HLF_8);
1708 	    }
1709 	    else if (c == NUL && list && lcs_eol != NUL)
1710 	    {
1711 		p_extra = (char_u *)"";
1712 		c_extra = NUL;
1713 		n_extra = 1;
1714 		c = lcs_eol;
1715 		attr = hl_attr(HLF_AT);
1716 		--s;
1717 	    }
1718 	    else if (c != NUL && (n = byte2cells(c)) > 1)
1719 	    {
1720 		n_extra = n - 1;
1721 		p_extra = transchar_byte(c);
1722 		c_extra = NUL;
1723 		c = *p_extra++;
1724 		/* Use special coloring to be able to distinguish <hex> from
1725 		 * the same in plain text. */
1726 		attr = hl_attr(HLF_8);
1727 	    }
1728 	    else if (c == ' ' && trail != NULL && s > trail)
1729 	    {
1730 		c = lcs_trail;
1731 		attr = hl_attr(HLF_8);
1732 	    }
1733 	}
1734 
1735 	if (c == NUL)
1736 	    break;
1737 
1738 	msg_putchar_attr(c, attr);
1739 	col++;
1740     }
1741     msg_clr_eos();
1742 }
1743 
1744 #ifdef FEAT_MBYTE
1745 /*
1746  * Use screen_puts() to output one multi-byte character.
1747  * Return the pointer "s" advanced to the next character.
1748  */
1749     static char_u *
1750 screen_puts_mbyte(s, l, attr)
1751     char_u	*s;
1752     int		l;
1753     int		attr;
1754 {
1755     int		cw;
1756 
1757     msg_didout = TRUE;		/* remember that line is not empty */
1758     cw = (*mb_ptr2cells)(s);
1759     if (cw > 1 && (
1760 #ifdef FEAT_RIGHTLEFT
1761 		cmdmsg_rl ? msg_col <= 1 :
1762 #endif
1763 		msg_col == Columns - 1))
1764     {
1765 	/* Doesn't fit, print a highlighted '>' to fill it up. */
1766 	msg_screen_putchar('>', hl_attr(HLF_AT));
1767 	return s;
1768     }
1769 
1770     screen_puts_len(s, l, msg_row, msg_col, attr);
1771 #ifdef FEAT_RIGHTLEFT
1772     if (cmdmsg_rl)
1773     {
1774 	msg_col -= cw;
1775 	if (msg_col == 0)
1776 	{
1777 	    msg_col = Columns;
1778 	    ++msg_row;
1779 	}
1780     }
1781     else
1782 #endif
1783     {
1784 	msg_col += cw;
1785 	if (msg_col >= Columns)
1786 	{
1787 	    msg_col = 0;
1788 	    ++msg_row;
1789 	}
1790     }
1791     return s + l;
1792 }
1793 #endif
1794 
1795 /*
1796  * Output a string to the screen at position msg_row, msg_col.
1797  * Update msg_row and msg_col for the next message.
1798  */
1799     void
1800 msg_puts(s)
1801     char_u	*s;
1802 {
1803     msg_puts_attr(s, 0);
1804 }
1805 
1806     void
1807 msg_puts_title(s)
1808     char_u	*s;
1809 {
1810     msg_puts_attr(s, hl_attr(HLF_T));
1811 }
1812 
1813 /*
1814  * Show a message in such a way that it always fits in the line.  Cut out a
1815  * part in the middle and replace it with "..." when necessary.
1816  * Does not handle multi-byte characters!
1817  */
1818     void
1819 msg_puts_long_attr(longstr, attr)
1820     char_u	*longstr;
1821     int		attr;
1822 {
1823     msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1824 }
1825 
1826     void
1827 msg_puts_long_len_attr(longstr, len, attr)
1828     char_u	*longstr;
1829     int		len;
1830     int		attr;
1831 {
1832     int		slen = len;
1833     int		room;
1834 
1835     room = Columns - msg_col;
1836     if (len > room && room >= 20)
1837     {
1838 	slen = (room - 3) / 2;
1839 	msg_outtrans_len_attr(longstr, slen, attr);
1840 	msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1841     }
1842     msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1843 }
1844 
1845 /*
1846  * Basic function for writing a message with highlight attributes.
1847  */
1848     void
1849 msg_puts_attr(s, attr)
1850     char_u	*s;
1851     int		attr;
1852 {
1853     msg_puts_attr_len(s, -1, attr);
1854 }
1855 
1856 /*
1857  * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1858  * When "maxlen" is -1 there is no maximum length.
1859  * When "maxlen" is >= 0 the message is not put in the history.
1860  */
1861     static void
1862 msg_puts_attr_len(str, maxlen, attr)
1863     char_u	*str;
1864     int		maxlen;
1865     int		attr;
1866 {
1867     /*
1868      * If redirection is on, also write to the redirection file.
1869      */
1870     redir_write(str, maxlen);
1871 
1872     /*
1873      * Don't print anything when using ":silent cmd".
1874      */
1875     if (msg_silent != 0)
1876 	return;
1877 
1878     /* if MSG_HIST flag set, add message to history */
1879     if ((attr & MSG_HIST) && maxlen < 0)
1880     {
1881 	add_msg_hist(str, -1, attr);
1882 	attr &= ~MSG_HIST;
1883     }
1884 
1885     /*
1886      * When writing something to the screen after it has scrolled, requires a
1887      * wait-return prompt later.  Needed when scrolling, resetting
1888      * need_wait_return after some prompt, and then outputting something
1889      * without scrolling
1890      */
1891     if (msg_scrolled != 0 && !msg_scrolled_ign)
1892 	need_wait_return = TRUE;
1893     msg_didany = TRUE;		/* remember that something was outputted */
1894 
1895     /*
1896      * If there is no valid screen, use fprintf so we can see error messages.
1897      * If termcap is not active, we may be writing in an alternate console
1898      * window, cursor positioning may not work correctly (window size may be
1899      * different, e.g. for Win32 console) or we just don't know where the
1900      * cursor is.
1901      */
1902     if (msg_use_printf())
1903 	msg_puts_printf(str, maxlen);
1904     else
1905 	msg_puts_display(str, maxlen, attr, FALSE);
1906 }
1907 
1908 /*
1909  * The display part of msg_puts_attr_len().
1910  * May be called recursively to display scroll-back text.
1911  */
1912     static void
1913 msg_puts_display(str, maxlen, attr, recurse)
1914     char_u	*str;
1915     int		maxlen;
1916     int		attr;
1917     int		recurse;
1918 {
1919     char_u	*s = str;
1920     char_u	*t_s = str;	/* string from "t_s" to "s" is still todo */
1921     int		t_col = 0;	/* screen cells todo, 0 when "t_s" not used */
1922 #ifdef FEAT_MBYTE
1923     int		l;
1924     int		cw;
1925 #endif
1926     char_u	*sb_str = str;
1927     int		sb_col = msg_col;
1928     int		wrap;
1929     int		did_last_char;
1930 
1931     did_wait_return = FALSE;
1932     while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
1933     {
1934 	/*
1935 	 * We are at the end of the screen line when:
1936 	 * - When outputting a newline.
1937 	 * - When outputting a character in the last column.
1938 	 */
1939 	if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
1940 #ifdef FEAT_RIGHTLEFT
1941 		    cmdmsg_rl
1942 		    ? (
1943 			msg_col <= 1
1944 			|| (*s == TAB && msg_col <= 7)
1945 # ifdef FEAT_MBYTE
1946 			|| (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1947 # endif
1948 		      )
1949 		    :
1950 #endif
1951 		      (msg_col + t_col >= Columns - 1
1952 		       || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1953 # ifdef FEAT_MBYTE
1954 		       || (has_mbyte && (*mb_ptr2cells)(s) > 1
1955 					    && msg_col + t_col >= Columns - 2)
1956 # endif
1957 		      ))))
1958 	{
1959 	    /*
1960 	     * The screen is scrolled up when at the last row (some terminals
1961 	     * scroll automatically, some don't.  To avoid problems we scroll
1962 	     * ourselves).
1963 	     */
1964 	    if (t_col > 0)
1965 		/* output postponed text */
1966 		t_puts(&t_col, t_s, s, attr);
1967 
1968 	    /* When no more prompt and no more room, truncate here */
1969 	    if (msg_no_more && lines_left == 0)
1970 		break;
1971 
1972 	    /* Scroll the screen up one line. */
1973 	    msg_scroll_up();
1974 
1975 	    msg_row = Rows - 2;
1976 	    if (msg_col >= Columns)	/* can happen after screen resize */
1977 		msg_col = Columns - 1;
1978 
1979 	    /* Display char in last column before showing more-prompt. */
1980 	    if (*s >= ' '
1981 #ifdef FEAT_RIGHTLEFT
1982 		    && !cmdmsg_rl
1983 #endif
1984 	       )
1985 	    {
1986 #ifdef FEAT_MBYTE
1987 		if (has_mbyte)
1988 		{
1989 		    if (enc_utf8 && maxlen >= 0)
1990 			/* avoid including composing chars after the end */
1991 			l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
1992 		    else
1993 			l = (*mb_ptr2len)(s);
1994 		    s = screen_puts_mbyte(s, l, attr);
1995 		}
1996 		else
1997 #endif
1998 		    msg_screen_putchar(*s++, attr);
1999 		did_last_char = TRUE;
2000 	    }
2001 	    else
2002 		did_last_char = FALSE;
2003 
2004 	    if (p_more)
2005 		/* store text for scrolling back */
2006 		store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2007 
2008 	    inc_msg_scrolled();
2009 	    need_wait_return = TRUE; /* may need wait_return in main() */
2010 	    if (must_redraw < VALID)
2011 		must_redraw = VALID;
2012 	    redraw_cmdline = TRUE;
2013 	    if (cmdline_row > 0 && !exmode_active)
2014 		--cmdline_row;
2015 
2016 	    /*
2017 	     * If screen is completely filled and 'more' is set then wait
2018 	     * for a character.
2019 	     */
2020 	    if (lines_left > 0)
2021 		--lines_left;
2022 	    if (p_more && lines_left == 0 && State != HITRETURN
2023 					    && !msg_no_more && !exmode_active)
2024 	    {
2025 #ifdef FEAT_CON_DIALOG
2026 		if (do_more_prompt(NUL))
2027 		    s = confirm_msg_tail;
2028 #else
2029 		(void)do_more_prompt(NUL);
2030 #endif
2031 		if (quit_more)
2032 		    return;
2033 	    }
2034 
2035 	    /* When we displayed a char in last column need to check if there
2036 	     * is still more. */
2037 	    if (did_last_char)
2038 		continue;
2039 	}
2040 
2041 	wrap = *s == '\n'
2042 		    || msg_col + t_col >= Columns
2043 #ifdef FEAT_MBYTE
2044 		    || (has_mbyte && (*mb_ptr2cells)(s) > 1
2045 					    && msg_col + t_col >= Columns - 1)
2046 #endif
2047 		    ;
2048 	if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2049 						 || *s == '\t' || *s == BELL))
2050 	    /* output any postponed text */
2051 	    t_puts(&t_col, t_s, s, attr);
2052 
2053 	if (wrap && p_more && !recurse)
2054 	    /* store text for scrolling back */
2055 	    store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2056 
2057 	if (*s == '\n')		    /* go to next line */
2058 	{
2059 	    msg_didout = FALSE;	    /* remember that line is empty */
2060 #ifdef FEAT_RIGHTLEFT
2061 	    if (cmdmsg_rl)
2062 		msg_col = Columns - 1;
2063 	    else
2064 #endif
2065 		msg_col = 0;
2066 	    if (++msg_row >= Rows)  /* safety check */
2067 		msg_row = Rows - 1;
2068 	}
2069 	else if (*s == '\r')	    /* go to column 0 */
2070 	{
2071 	    msg_col = 0;
2072 	}
2073 	else if (*s == '\b')	    /* go to previous char */
2074 	{
2075 	    if (msg_col)
2076 		--msg_col;
2077 	}
2078 	else if (*s == TAB)	    /* translate Tab into spaces */
2079 	{
2080 	    do
2081 		msg_screen_putchar(' ', attr);
2082 	    while (msg_col & 7);
2083 	}
2084 	else if (*s == BELL)	    /* beep (from ":sh") */
2085 	    vim_beep();
2086 	else
2087 	{
2088 #ifdef FEAT_MBYTE
2089 	    if (has_mbyte)
2090 	    {
2091 		cw = (*mb_ptr2cells)(s);
2092 		if (enc_utf8 && maxlen >= 0)
2093 		    /* avoid including composing chars after the end */
2094 		    l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
2095 		else
2096 		    l = (*mb_ptr2len)(s);
2097 	    }
2098 	    else
2099 	    {
2100 		cw = 1;
2101 		l = 1;
2102 	    }
2103 #endif
2104 	    /* When drawing from right to left or when a double-wide character
2105 	     * doesn't fit, draw a single character here.  Otherwise collect
2106 	     * characters and draw them all at once later. */
2107 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2108 	    if (
2109 # ifdef FEAT_RIGHTLEFT
2110 		    cmdmsg_rl
2111 #  ifdef FEAT_MBYTE
2112 		    ||
2113 #  endif
2114 # endif
2115 # ifdef FEAT_MBYTE
2116 		    (cw > 1 && msg_col + t_col >= Columns - 1)
2117 # endif
2118 		    )
2119 	    {
2120 # ifdef FEAT_MBYTE
2121 		if (l > 1)
2122 		    s = screen_puts_mbyte(s, l, attr) - 1;
2123 		else
2124 # endif
2125 		    msg_screen_putchar(*s, attr);
2126 	    }
2127 	    else
2128 #endif
2129 	    {
2130 		/* postpone this character until later */
2131 		if (t_col == 0)
2132 		    t_s = s;
2133 #ifdef FEAT_MBYTE
2134 		t_col += cw;
2135 		s += l - 1;
2136 #else
2137 		++t_col;
2138 #endif
2139 	    }
2140 	}
2141 	++s;
2142     }
2143 
2144     /* output any postponed text */
2145     if (t_col > 0)
2146 	t_puts(&t_col, t_s, s, attr);
2147     if (p_more && !recurse)
2148 	store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
2149 
2150     msg_check();
2151 }
2152 
2153 /*
2154  * Scroll the screen up one line for displaying the next message line.
2155  */
2156     static void
2157 msg_scroll_up()
2158 {
2159 #ifdef FEAT_GUI
2160     /* Remove the cursor before scrolling, ScreenLines[] is going
2161      * to become invalid. */
2162     if (gui.in_use)
2163 	gui_undraw_cursor();
2164 #endif
2165     /* scrolling up always works */
2166     screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2167 
2168     if (!can_clear((char_u *)" "))
2169     {
2170 	/* Scrolling up doesn't result in the right background.  Set the
2171 	 * background here.  It's not efficient, but avoids that we have to do
2172 	 * it all over the code. */
2173 	screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2174 
2175 	/* Also clear the last char of the last but one line if it was not
2176 	 * cleared before to avoid a scroll-up. */
2177 	if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2178 	    screen_fill((int)Rows - 2, (int)Rows - 1,
2179 				 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2180     }
2181 }
2182 
2183 /*
2184  * Increment "msg_scrolled".
2185  */
2186     static void
2187 inc_msg_scrolled()
2188 {
2189 #ifdef FEAT_EVAL
2190     if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2191     {
2192 	char_u	    *p = sourcing_name;
2193 	char_u	    *tofree = NULL;
2194 	int	    len;
2195 
2196 	/* v:scrollstart is empty, set it to the script/function name and line
2197 	 * number */
2198 	if (p == NULL)
2199 	    p = (char_u *)_("Unknown");
2200 	else
2201 	{
2202 	    len = (int)STRLEN(p) + 40;
2203 	    tofree = alloc(len);
2204 	    if (tofree != NULL)
2205 	    {
2206 		vim_snprintf((char *)tofree, len, _("%s line %ld"),
2207 						      p, (long)sourcing_lnum);
2208 		p = tofree;
2209 	    }
2210 	}
2211 	set_vim_var_string(VV_SCROLLSTART, p, -1);
2212 	vim_free(tofree);
2213     }
2214 #endif
2215     ++msg_scrolled;
2216 }
2217 
2218 /*
2219  * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2220  * store the displayed text and remember where screen lines start.
2221  */
2222 typedef struct msgchunk_S msgchunk_T;
2223 struct msgchunk_S
2224 {
2225     msgchunk_T	*sb_next;
2226     msgchunk_T	*sb_prev;
2227     char	sb_eol;		/* TRUE when line ends after this text */
2228     int		sb_msg_col;	/* column in which text starts */
2229     int		sb_attr;	/* text attributes */
2230     char_u	sb_text[1];	/* text to be displayed, actually longer */
2231 };
2232 
2233 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2234 
2235 static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2236 static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2237 
2238 static int do_clear_sb_text = FALSE;	/* clear text on next msg */
2239 
2240 /*
2241  * Store part of a printed message for displaying when scrolling back.
2242  */
2243     static void
2244 store_sb_text(sb_str, s, attr, sb_col, finish)
2245     char_u	**sb_str;	/* start of string */
2246     char_u	*s;		/* just after string */
2247     int		attr;
2248     int		*sb_col;
2249     int		finish;		/* line ends */
2250 {
2251     msgchunk_T	*mp;
2252 
2253     if (do_clear_sb_text)
2254     {
2255 	clear_sb_text();
2256 	do_clear_sb_text = FALSE;
2257     }
2258 
2259     if (s > *sb_str)
2260     {
2261 	mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2262 	if (mp != NULL)
2263 	{
2264 	    mp->sb_eol = finish;
2265 	    mp->sb_msg_col = *sb_col;
2266 	    mp->sb_attr = attr;
2267 	    vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2268 
2269 	    if (last_msgchunk == NULL)
2270 	    {
2271 		last_msgchunk = mp;
2272 		mp->sb_prev = NULL;
2273 	    }
2274 	    else
2275 	    {
2276 		mp->sb_prev = last_msgchunk;
2277 		last_msgchunk->sb_next = mp;
2278 		last_msgchunk = mp;
2279 	    }
2280 	    mp->sb_next = NULL;
2281 	}
2282     }
2283     else if (finish && last_msgchunk != NULL)
2284 	last_msgchunk->sb_eol = TRUE;
2285 
2286     *sb_str = s;
2287     *sb_col = 0;
2288 }
2289 
2290 /*
2291  * Finished showing messages, clear the scroll-back text on the next message.
2292  */
2293     void
2294 may_clear_sb_text()
2295 {
2296     do_clear_sb_text = TRUE;
2297 }
2298 
2299 /*
2300  * Clear any text remembered for scrolling back.
2301  * Called when redrawing the screen.
2302  */
2303     void
2304 clear_sb_text()
2305 {
2306     msgchunk_T	*mp;
2307 
2308     while (last_msgchunk != NULL)
2309     {
2310 	mp = last_msgchunk->sb_prev;
2311 	vim_free(last_msgchunk);
2312 	last_msgchunk = mp;
2313     }
2314 }
2315 
2316 /*
2317  * "g<" command.
2318  */
2319     void
2320 show_sb_text()
2321 {
2322     msgchunk_T	*mp;
2323 
2324     /* Only show something if there is more than one line, otherwise it looks
2325      * weird, typing a command without output results in one line. */
2326     mp = msg_sb_start(last_msgchunk);
2327     if (mp == NULL || mp->sb_prev == NULL)
2328 	vim_beep();
2329     else
2330     {
2331 	do_more_prompt('G');
2332 	wait_return(FALSE);
2333     }
2334 }
2335 
2336 /*
2337  * Move to the start of screen line in already displayed text.
2338  */
2339     static msgchunk_T *
2340 msg_sb_start(mps)
2341     msgchunk_T *mps;
2342 {
2343     msgchunk_T *mp = mps;
2344 
2345     while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2346 	mp = mp->sb_prev;
2347     return mp;
2348 }
2349 
2350 /*
2351  * Mark the last message chunk as finishing the line.
2352  */
2353     void
2354 msg_sb_eol()
2355 {
2356     if (last_msgchunk != NULL)
2357 	last_msgchunk->sb_eol = TRUE;
2358 }
2359 
2360 /*
2361  * Display a screen line from previously displayed text at row "row".
2362  * Returns a pointer to the text for the next line (can be NULL).
2363  */
2364     static msgchunk_T *
2365 disp_sb_line(row, smp)
2366     int		row;
2367     msgchunk_T	*smp;
2368 {
2369     msgchunk_T	*mp = smp;
2370     char_u	*p;
2371 
2372     for (;;)
2373     {
2374 	msg_row = row;
2375 	msg_col = mp->sb_msg_col;
2376 	p = mp->sb_text;
2377 	if (*p == '\n')	    /* don't display the line break */
2378 	    ++p;
2379 	msg_puts_display(p, -1, mp->sb_attr, TRUE);
2380 	if (mp->sb_eol || mp->sb_next == NULL)
2381 	    break;
2382 	mp = mp->sb_next;
2383     }
2384     return mp->sb_next;
2385 }
2386 
2387 /*
2388  * Output any postponed text for msg_puts_attr_len().
2389  */
2390     static void
2391 t_puts(t_col, t_s, s, attr)
2392     int		*t_col;
2393     char_u	*t_s;
2394     char_u	*s;
2395     int		attr;
2396 {
2397     /* output postponed text */
2398     msg_didout = TRUE;		/* remember that line is not empty */
2399     screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
2400     msg_col += *t_col;
2401     *t_col = 0;
2402 #ifdef FEAT_MBYTE
2403     /* If the string starts with a composing character don't increment the
2404      * column position for it. */
2405     if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2406 	--msg_col;
2407 #endif
2408     if (msg_col >= Columns)
2409     {
2410 	msg_col = 0;
2411 	++msg_row;
2412     }
2413 }
2414 
2415 /*
2416  * Returns TRUE when messages should be printed with mch_errmsg().
2417  * This is used when there is no valid screen, so we can see error messages.
2418  * If termcap is not active, we may be writing in an alternate console
2419  * window, cursor positioning may not work correctly (window size may be
2420  * different, e.g. for Win32 console) or we just don't know where the
2421  * cursor is.
2422  */
2423     int
2424 msg_use_printf()
2425 {
2426     return (!msg_check_screen()
2427 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2428 	    || !termcap_active
2429 #endif
2430 	    || (swapping_screen() && !termcap_active)
2431 	       );
2432 }
2433 
2434 /*
2435  * Print a message when there is no valid screen.
2436  */
2437     static void
2438 msg_puts_printf(str, maxlen)
2439     char_u	*str;
2440     int		maxlen;
2441 {
2442     char_u	*s = str;
2443     char_u	buf[4];
2444     char_u	*p;
2445 
2446 #ifdef WIN3264
2447     if (!(silent_mode && p_verbose == 0))
2448 	mch_settmode(TMODE_COOK);	/* handle '\r' and '\n' correctly */
2449 #endif
2450     while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2451     {
2452 	if (!(silent_mode && p_verbose == 0))
2453 	{
2454 	    /* NL --> CR NL translation (for Unix, not for "--version") */
2455 	    /* NL --> CR translation (for Mac) */
2456 	    p = &buf[0];
2457 	    if (*s == '\n' && !info_message)
2458 		*p++ = '\r';
2459 #if defined(USE_CR) && !defined(MACOS_X_UNIX)
2460 	    else
2461 #endif
2462 		*p++ = *s;
2463 	    *p = '\0';
2464 	    if (info_message)	/* informative message, not an error */
2465 		mch_msg((char *)buf);
2466 	    else
2467 		mch_errmsg((char *)buf);
2468 	}
2469 
2470 	/* primitive way to compute the current column */
2471 #ifdef FEAT_RIGHTLEFT
2472 	if (cmdmsg_rl)
2473 	{
2474 	    if (*s == '\r' || *s == '\n')
2475 		msg_col = Columns - 1;
2476 	    else
2477 		--msg_col;
2478 	}
2479 	else
2480 #endif
2481 	{
2482 	    if (*s == '\r' || *s == '\n')
2483 		msg_col = 0;
2484 	    else
2485 		++msg_col;
2486 	}
2487 	++s;
2488     }
2489     msg_didout = TRUE;	    /* assume that line is not empty */
2490 
2491 #ifdef WIN3264
2492     if (!(silent_mode && p_verbose == 0))
2493 	mch_settmode(TMODE_RAW);
2494 #endif
2495 }
2496 
2497 /*
2498  * Show the more-prompt and handle the user response.
2499  * This takes care of scrolling back and displaying previously displayed text.
2500  * When at hit-enter prompt "typed_char" is the already typed character,
2501  * otherwise it's NUL.
2502  * Returns TRUE when jumping ahead to "confirm_msg_tail".
2503  */
2504     static int
2505 do_more_prompt(typed_char)
2506     int		typed_char;
2507 {
2508     int		used_typed_char = typed_char;
2509     int		oldState = State;
2510     int		c;
2511 #ifdef FEAT_CON_DIALOG
2512     int		retval = FALSE;
2513 #endif
2514     int		toscroll;
2515     msgchunk_T	*mp_last = NULL;
2516     msgchunk_T	*mp;
2517     int		i;
2518 
2519     if (typed_char == 'G')
2520     {
2521 	/* "g<": Find first line on the last page. */
2522 	mp_last = msg_sb_start(last_msgchunk);
2523 	for (i = 0; i < Rows - 2 && mp_last != NULL
2524 					     && mp_last->sb_prev != NULL; ++i)
2525 	    mp_last = msg_sb_start(mp_last->sb_prev);
2526     }
2527 
2528     State = ASKMORE;
2529 #ifdef FEAT_MOUSE
2530     setmouse();
2531 #endif
2532     if (typed_char == NUL)
2533 	msg_moremsg(FALSE);
2534     for (;;)
2535     {
2536 	/*
2537 	 * Get a typed character directly from the user.
2538 	 */
2539 	if (used_typed_char != NUL)
2540 	{
2541 	    c = used_typed_char;	/* was typed at hit-enter prompt */
2542 	    used_typed_char = NUL;
2543 	}
2544 	else
2545 	    c = get_keystroke();
2546 
2547 #if defined(FEAT_MENU) && defined(FEAT_GUI)
2548 	if (c == K_MENU)
2549 	{
2550 	    int idx = get_menu_index(current_menu, ASKMORE);
2551 
2552 	    /* Used a menu.  If it starts with CTRL-Y, it must
2553 	     * be a "Copy" for the clipboard.  Otherwise
2554 	     * assume that we end */
2555 	    if (idx == MENU_INDEX_INVALID)
2556 		continue;
2557 	    c = *current_menu->strings[idx];
2558 	    if (c != NUL && current_menu->strings[idx][1] != NUL)
2559 		ins_typebuf(current_menu->strings[idx] + 1,
2560 				current_menu->noremap[idx], 0, TRUE,
2561 						   current_menu->silent[idx]);
2562 	}
2563 #endif
2564 
2565 	toscroll = 0;
2566 	switch (c)
2567 	{
2568 	case BS:		/* scroll one line back */
2569 	case K_BS:
2570 	case 'k':
2571 	case K_UP:
2572 	    toscroll = -1;
2573 	    break;
2574 
2575 	case CAR:		/* one extra line */
2576 	case NL:
2577 	case 'j':
2578 	case K_DOWN:
2579 	    toscroll = 1;
2580 	    break;
2581 
2582 	case 'u':		/* Up half a page */
2583 	    toscroll = -(Rows / 2);
2584 	    break;
2585 
2586 	case 'd':		/* Down half a page */
2587 	    toscroll = Rows / 2;
2588 	    break;
2589 
2590 	case 'b':		/* one page back */
2591 	case K_PAGEUP:
2592 	    toscroll = -(Rows - 1);
2593 	    break;
2594 
2595 	case ' ':		/* one extra page */
2596 	case 'f':
2597 	case K_PAGEDOWN:
2598 	case K_LEFTMOUSE:
2599 	    toscroll = Rows - 1;
2600 	    break;
2601 
2602 	case 'g':		/* all the way back to the start */
2603 	    toscroll = -999999;
2604 	    break;
2605 
2606 	case 'G':		/* all the way to the end */
2607 	    toscroll = 999999;
2608 	    lines_left = 999999;
2609 	    break;
2610 
2611 	case ':':		/* start new command line */
2612 #ifdef FEAT_CON_DIALOG
2613 	    if (!confirm_msg_used)
2614 #endif
2615 	    {
2616 		/* Since got_int is set all typeahead will be flushed, but we
2617 		 * want to keep this ':', remember that in a special way. */
2618 		typeahead_noflush(':');
2619 		cmdline_row = Rows - 1;		/* put ':' on this line */
2620 		skip_redraw = TRUE;		/* skip redraw once */
2621 		need_wait_return = FALSE;	/* don't wait in main() */
2622 	    }
2623 	    /*FALLTHROUGH*/
2624 	case 'q':		/* quit */
2625 	case Ctrl_C:
2626 	case ESC:
2627 #ifdef FEAT_CON_DIALOG
2628 	    if (confirm_msg_used)
2629 	    {
2630 		/* Jump to the choices of the dialog. */
2631 		retval = TRUE;
2632 	    }
2633 	    else
2634 #endif
2635 	    {
2636 		got_int = TRUE;
2637 		quit_more = TRUE;
2638 	    }
2639 	    /* When there is some more output (wrapping line) display that
2640 	     * without another prompt. */
2641 	    lines_left = Rows - 1;
2642 	    break;
2643 
2644 #ifdef FEAT_CLIPBOARD
2645 	case Ctrl_Y:
2646 	    /* Strange way to allow copying (yanking) a modeless
2647 	     * selection at the more prompt.  Use CTRL-Y,
2648 	     * because the same is used in Cmdline-mode and at the
2649 	     * hit-enter prompt.  However, scrolling one line up
2650 	     * might be expected... */
2651 	    if (clip_star.state == SELECT_DONE)
2652 		clip_copy_modeless_selection(TRUE);
2653 	    continue;
2654 #endif
2655 	default:		/* no valid response */
2656 	    msg_moremsg(TRUE);
2657 	    continue;
2658 	}
2659 
2660 	if (toscroll != 0)
2661 	{
2662 	    if (toscroll < 0)
2663 	    {
2664 		/* go to start of last line */
2665 		if (mp_last == NULL)
2666 		    mp = msg_sb_start(last_msgchunk);
2667 		else if (mp_last->sb_prev != NULL)
2668 		    mp = msg_sb_start(mp_last->sb_prev);
2669 		else
2670 		    mp = NULL;
2671 
2672 		/* go to start of line at top of the screen */
2673 		for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2674 									  ++i)
2675 		    mp = msg_sb_start(mp->sb_prev);
2676 
2677 		if (mp != NULL && mp->sb_prev != NULL)
2678 		{
2679 		    /* Find line to be displayed at top. */
2680 		    for (i = 0; i > toscroll; --i)
2681 		    {
2682 			if (mp == NULL || mp->sb_prev == NULL)
2683 			    break;
2684 			mp = msg_sb_start(mp->sb_prev);
2685 			if (mp_last == NULL)
2686 			    mp_last = msg_sb_start(last_msgchunk);
2687 			else
2688 			    mp_last = msg_sb_start(mp_last->sb_prev);
2689 		    }
2690 
2691 		    if (toscroll == -1 && screen_ins_lines(0, 0, 1,
2692 						       (int)Rows, NULL) == OK)
2693 		    {
2694 			/* display line at top */
2695 			(void)disp_sb_line(0, mp);
2696 		    }
2697 		    else
2698 		    {
2699 			/* redisplay all lines */
2700 			screenclear();
2701 			for (i = 0; mp != NULL && i < Rows - 1; ++i)
2702 			{
2703 			    mp = disp_sb_line(i, mp);
2704 			    ++msg_scrolled;
2705 			}
2706 		    }
2707 		    toscroll = 0;
2708 		}
2709 	    }
2710 	    else
2711 	    {
2712 		/* First display any text that we scrolled back. */
2713 		while (toscroll > 0 && mp_last != NULL)
2714 		{
2715 		    /* scroll up, display line at bottom */
2716 		    msg_scroll_up();
2717 		    inc_msg_scrolled();
2718 		    screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2719 						   (int)Columns, ' ', ' ', 0);
2720 		    mp_last = disp_sb_line((int)Rows - 2, mp_last);
2721 		    --toscroll;
2722 		}
2723 	    }
2724 
2725 	    if (toscroll <= 0)
2726 	    {
2727 		/* displayed the requested text, more prompt again */
2728 		screen_fill((int)Rows - 1, (int)Rows, 0,
2729 						   (int)Columns, ' ', ' ', 0);
2730 		msg_moremsg(FALSE);
2731 		continue;
2732 	    }
2733 
2734 	    /* display more text, return to caller */
2735 	    lines_left = toscroll;
2736 	}
2737 
2738 	break;
2739     }
2740 
2741     /* clear the --more-- message */
2742     screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2743     State = oldState;
2744 #ifdef FEAT_MOUSE
2745     setmouse();
2746 #endif
2747     if (quit_more)
2748     {
2749 	msg_row = Rows - 1;
2750 	msg_col = 0;
2751     }
2752 #ifdef FEAT_RIGHTLEFT
2753     else if (cmdmsg_rl)
2754 	msg_col = Columns - 1;
2755 #endif
2756 
2757 #ifdef FEAT_CON_DIALOG
2758     return retval;
2759 #else
2760     return FALSE;
2761 #endif
2762 }
2763 
2764 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
2765 
2766 #ifdef mch_errmsg
2767 # undef mch_errmsg
2768 #endif
2769 #ifdef mch_msg
2770 # undef mch_msg
2771 #endif
2772 
2773 /*
2774  * Give an error message.  To be used when the screen hasn't been initialized
2775  * yet.  When stderr can't be used, collect error messages until the GUI has
2776  * started and they can be displayed in a message box.
2777  */
2778     void
2779 mch_errmsg(str)
2780     char	*str;
2781 {
2782     int		len;
2783 
2784 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2785     /* On Unix use stderr if it's a tty.
2786      * When not going to start the GUI also use stderr.
2787      * On Mac, when started from Finder, stderr is the console. */
2788     if (
2789 # ifdef UNIX
2790 #  ifdef MACOS_X_UNIX
2791 	    (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2792 #  else
2793 	    isatty(2)
2794 #  endif
2795 #  ifdef FEAT_GUI
2796 	    ||
2797 #  endif
2798 # endif
2799 # ifdef FEAT_GUI
2800 	    !(gui.in_use || gui.starting)
2801 # endif
2802 	    )
2803     {
2804 	fprintf(stderr, "%s", str);
2805 	return;
2806     }
2807 #endif
2808 
2809     /* avoid a delay for a message that isn't there */
2810     emsg_on_display = FALSE;
2811 
2812     len = (int)STRLEN(str) + 1;
2813     if (error_ga.ga_growsize == 0)
2814     {
2815 	error_ga.ga_growsize = 80;
2816 	error_ga.ga_itemsize = 1;
2817     }
2818     if (ga_grow(&error_ga, len) == OK)
2819     {
2820 	mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2821 							  (char_u *)str, len);
2822 #ifdef UNIX
2823 	/* remove CR characters, they are displayed */
2824 	{
2825 	    char_u	*p;
2826 
2827 	    p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2828 	    for (;;)
2829 	    {
2830 		p = vim_strchr(p, '\r');
2831 		if (p == NULL)
2832 		    break;
2833 		*p = ' ';
2834 	    }
2835 	}
2836 #endif
2837 	--len;		/* don't count the NUL at the end */
2838 	error_ga.ga_len += len;
2839     }
2840 }
2841 
2842 /*
2843  * Give a message.  To be used when the screen hasn't been initialized yet.
2844  * When there is no tty, collect messages until the GUI has started and they
2845  * can be displayed in a message box.
2846  */
2847     void
2848 mch_msg(str)
2849     char	*str;
2850 {
2851 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2852     /* On Unix use stdout if we have a tty.  This allows "vim -h | more" and
2853      * uses mch_errmsg() when started from the desktop.
2854      * When not going to start the GUI also use stdout.
2855      * On Mac, when started from Finder, stderr is the console. */
2856     if (
2857 #  ifdef UNIX
2858 #   ifdef MACOS_X_UNIX
2859 	    (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2860 #   else
2861 	    isatty(2)
2862 #    endif
2863 #   ifdef FEAT_GUI
2864 	    ||
2865 #   endif
2866 #  endif
2867 #  ifdef FEAT_GUI
2868 	    !(gui.in_use || gui.starting)
2869 #  endif
2870 	    )
2871     {
2872 	printf("%s", str);
2873 	return;
2874     }
2875 # endif
2876     mch_errmsg(str);
2877 }
2878 #endif /* USE_MCH_ERRMSG */
2879 
2880 /*
2881  * Put a character on the screen at the current message position and advance
2882  * to the next position.  Only for printable ASCII!
2883  */
2884     static void
2885 msg_screen_putchar(c, attr)
2886     int		c;
2887     int		attr;
2888 {
2889     msg_didout = TRUE;		/* remember that line is not empty */
2890     screen_putchar(c, msg_row, msg_col, attr);
2891 #ifdef FEAT_RIGHTLEFT
2892     if (cmdmsg_rl)
2893     {
2894 	if (--msg_col == 0)
2895 	{
2896 	    msg_col = Columns;
2897 	    ++msg_row;
2898 	}
2899     }
2900     else
2901 #endif
2902     {
2903 	if (++msg_col >= Columns)
2904 	{
2905 	    msg_col = 0;
2906 	    ++msg_row;
2907 	}
2908     }
2909 }
2910 
2911     void
2912 msg_moremsg(full)
2913     int	    full;
2914 {
2915     int		attr;
2916     char_u	*s = (char_u *)_("-- More --");
2917 
2918     attr = hl_attr(HLF_M);
2919     screen_puts(s, (int)Rows - 1, 0, attr);
2920     if (full)
2921 	screen_puts((char_u *)
2922 		_(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2923 		(int)Rows - 1, vim_strsize(s), attr);
2924 }
2925 
2926 /*
2927  * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2928  * exmode_active.
2929  */
2930     void
2931 repeat_message()
2932 {
2933     if (State == ASKMORE)
2934     {
2935 	msg_moremsg(TRUE);	/* display --more-- message again */
2936 	msg_row = Rows - 1;
2937     }
2938 #ifdef FEAT_CON_DIALOG
2939     else if (State == CONFIRM)
2940     {
2941 	display_confirm_msg();	/* display ":confirm" message again */
2942 	msg_row = Rows - 1;
2943     }
2944 #endif
2945     else if (State == EXTERNCMD)
2946     {
2947 	windgoto(msg_row, msg_col); /* put cursor back */
2948     }
2949     else if (State == HITRETURN || State == SETWSIZE)
2950     {
2951 	if (msg_row == Rows - 1)
2952 	{
2953 	    /* Avoid drawing the "hit-enter" prompt below the previous one,
2954 	     * overwrite it.  Esp. useful when regaining focus and a
2955 	     * FocusGained autocmd exists but didn't draw anything. */
2956 	    msg_didout = FALSE;
2957 	    msg_col = 0;
2958 	    msg_clr_eos();
2959 	}
2960 	hit_return_msg();
2961 	msg_row = Rows - 1;
2962     }
2963 }
2964 
2965 /*
2966  * msg_check_screen - check if the screen is initialized.
2967  * Also check msg_row and msg_col, if they are too big it may cause a crash.
2968  * While starting the GUI the terminal codes will be set for the GUI, but the
2969  * output goes to the terminal.  Don't use the terminal codes then.
2970  */
2971     static int
2972 msg_check_screen()
2973 {
2974     if (!full_screen || !screen_valid(FALSE))
2975 	return FALSE;
2976 
2977     if (msg_row >= Rows)
2978 	msg_row = Rows - 1;
2979     if (msg_col >= Columns)
2980 	msg_col = Columns - 1;
2981     return TRUE;
2982 }
2983 
2984 /*
2985  * Clear from current message position to end of screen.
2986  * Skip this when ":silent" was used, no need to clear for redirection.
2987  */
2988     void
2989 msg_clr_eos()
2990 {
2991     if (msg_silent == 0)
2992 	msg_clr_eos_force();
2993 }
2994 
2995 /*
2996  * Clear from current message position to end of screen.
2997  * Note: msg_col is not updated, so we remember the end of the message
2998  * for msg_check().
2999  */
3000     void
3001 msg_clr_eos_force()
3002 {
3003     if (msg_use_printf())
3004     {
3005 	if (full_screen)	/* only when termcap codes are valid */
3006 	{
3007 	    if (*T_CD)
3008 		out_str(T_CD);	/* clear to end of display */
3009 	    else if (*T_CE)
3010 		out_str(T_CE);	/* clear to end of line */
3011 	}
3012     }
3013     else
3014     {
3015 #ifdef FEAT_RIGHTLEFT
3016 	if (cmdmsg_rl)
3017 	{
3018 	    screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3019 	    screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3020 	}
3021 	else
3022 #endif
3023 	{
3024 	    screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3025 								 ' ', ' ', 0);
3026 	    screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3027 	}
3028     }
3029 }
3030 
3031 /*
3032  * Clear the command line.
3033  */
3034     void
3035 msg_clr_cmdline()
3036 {
3037     msg_row = cmdline_row;
3038     msg_col = 0;
3039     msg_clr_eos_force();
3040 }
3041 
3042 /*
3043  * end putting a message on the screen
3044  * call wait_return if the message does not fit in the available space
3045  * return TRUE if wait_return not called.
3046  */
3047     int
3048 msg_end()
3049 {
3050     /*
3051      * if the string is larger than the window,
3052      * or the ruler option is set and we run into it,
3053      * we have to redraw the window.
3054      * Do not do this if we are abandoning the file or editing the command line.
3055      */
3056     if (!exiting && need_wait_return && !(State & CMDLINE))
3057     {
3058 	wait_return(FALSE);
3059 	return FALSE;
3060     }
3061     out_flush();
3062     return TRUE;
3063 }
3064 
3065 /*
3066  * If the written message runs into the shown command or ruler, we have to
3067  * wait for hit-return and redraw the window later.
3068  */
3069     void
3070 msg_check()
3071 {
3072     if (msg_row == Rows - 1 && msg_col >= sc_col)
3073     {
3074 	need_wait_return = TRUE;
3075 	redraw_cmdline = TRUE;
3076     }
3077 }
3078 
3079 /*
3080  * May write a string to the redirection file.
3081  * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3082  */
3083     static void
3084 redir_write(str, maxlen)
3085     char_u	*str;
3086     int		maxlen;
3087 {
3088     char_u	*s = str;
3089     static int	cur_col = 0;
3090 
3091     /* Don't do anything for displaying prompts and the like. */
3092     if (redir_off)
3093 	return;
3094 
3095     /* If 'verbosefile' is set prepare for writing in that file. */
3096     if (*p_vfile != NUL && verbose_fd == NULL)
3097 	verbose_open();
3098 
3099     if (redirecting())
3100     {
3101 	/* If the string doesn't start with CR or NL, go to msg_col */
3102 	if (*s != '\n' && *s != '\r')
3103 	{
3104 	    while (cur_col < msg_col)
3105 	    {
3106 #ifdef FEAT_EVAL
3107 		if (redir_reg)
3108 		    write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
3109 		else if (redir_vname)
3110 		    var_redir_str((char_u *)" ", -1);
3111 		else
3112 #endif
3113 		    if (redir_fd != NULL)
3114 		    fputs(" ", redir_fd);
3115 		if (verbose_fd != NULL)
3116 		    fputs(" ", verbose_fd);
3117 		++cur_col;
3118 	    }
3119 	}
3120 
3121 #ifdef FEAT_EVAL
3122 	if (redir_reg)
3123 	    write_reg_contents(redir_reg, s, maxlen, TRUE);
3124 	if (redir_vname)
3125 	    var_redir_str(s, maxlen);
3126 #endif
3127 
3128 	/* Write and adjust the current column. */
3129 	while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3130 	{
3131 #ifdef FEAT_EVAL
3132 	    if (!redir_reg && !redir_vname)
3133 #endif
3134 		if (redir_fd != NULL)
3135 		    putc(*s, redir_fd);
3136 	    if (verbose_fd != NULL)
3137 		putc(*s, verbose_fd);
3138 	    if (*s == '\r' || *s == '\n')
3139 		cur_col = 0;
3140 	    else if (*s == '\t')
3141 		cur_col += (8 - cur_col % 8);
3142 	    else
3143 		++cur_col;
3144 	    ++s;
3145 	}
3146 
3147 	if (msg_silent != 0)	/* should update msg_col */
3148 	    msg_col = cur_col;
3149     }
3150 }
3151 
3152     int
3153 redirecting()
3154 {
3155     return redir_fd != NULL || *p_vfile != NUL
3156 #ifdef FEAT_EVAL
3157 			  || redir_reg || redir_vname
3158 #endif
3159 				       ;
3160 }
3161 
3162 /*
3163  * Before giving verbose message.
3164  * Must always be called paired with verbose_leave()!
3165  */
3166     void
3167 verbose_enter()
3168 {
3169     if (*p_vfile != NUL)
3170 	++msg_silent;
3171 }
3172 
3173 /*
3174  * After giving verbose message.
3175  * Must always be called paired with verbose_enter()!
3176  */
3177     void
3178 verbose_leave()
3179 {
3180     if (*p_vfile != NUL)
3181 	if (--msg_silent < 0)
3182 	    msg_silent = 0;
3183 }
3184 
3185 /*
3186  * Like verbose_enter() and set msg_scroll when displaying the message.
3187  */
3188     void
3189 verbose_enter_scroll()
3190 {
3191     if (*p_vfile != NUL)
3192 	++msg_silent;
3193     else
3194 	/* always scroll up, don't overwrite */
3195 	msg_scroll = TRUE;
3196 }
3197 
3198 /*
3199  * Like verbose_leave() and set cmdline_row when displaying the message.
3200  */
3201     void
3202 verbose_leave_scroll()
3203 {
3204     if (*p_vfile != NUL)
3205     {
3206 	if (--msg_silent < 0)
3207 	    msg_silent = 0;
3208     }
3209     else
3210 	cmdline_row = msg_row;
3211 }
3212 
3213 /*
3214  * Called when 'verbosefile' is set: stop writing to the file.
3215  */
3216     void
3217 verbose_stop()
3218 {
3219     if (verbose_fd != NULL)
3220     {
3221 	fclose(verbose_fd);
3222 	verbose_fd = NULL;
3223     }
3224     verbose_did_open = FALSE;
3225 }
3226 
3227 /*
3228  * Open the file 'verbosefile'.
3229  * Return FAIL or OK.
3230  */
3231     int
3232 verbose_open()
3233 {
3234     if (verbose_fd == NULL && !verbose_did_open)
3235     {
3236 	/* Only give the error message once. */
3237 	verbose_did_open = TRUE;
3238 
3239 	verbose_fd = mch_fopen((char *)p_vfile, "a");
3240 	if (verbose_fd == NULL)
3241 	{
3242 	    EMSG2(_(e_notopen), p_vfile);
3243 	    return FAIL;
3244 	}
3245     }
3246     return OK;
3247 }
3248 
3249 /*
3250  * Give a warning message (for searching).
3251  * Use 'w' highlighting and may repeat the message after redrawing
3252  */
3253     void
3254 give_warning(message, hl)
3255     char_u  *message;
3256     int	    hl;
3257 {
3258     /* Don't do this for ":silent". */
3259     if (msg_silent != 0)
3260 	return;
3261 
3262     /* Don't want a hit-enter prompt here. */
3263     ++no_wait_return;
3264 
3265 #ifdef FEAT_EVAL
3266     set_vim_var_string(VV_WARNINGMSG, message, -1);
3267 #endif
3268     vim_free(keep_msg);
3269     keep_msg = NULL;
3270     if (hl)
3271 	keep_msg_attr = hl_attr(HLF_W);
3272     else
3273 	keep_msg_attr = 0;
3274     if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
3275 	set_keep_msg(message, keep_msg_attr);
3276     msg_didout = FALSE;	    /* overwrite this message */
3277     msg_nowait = TRUE;	    /* don't wait for this message */
3278     msg_col = 0;
3279 
3280     --no_wait_return;
3281 }
3282 
3283 /*
3284  * Advance msg cursor to column "col".
3285  */
3286     void
3287 msg_advance(col)
3288     int	    col;
3289 {
3290     if (msg_silent != 0)	/* nothing to advance to */
3291     {
3292 	msg_col = col;		/* for redirection, may fill it up later */
3293 	return;
3294     }
3295     if (col >= Columns)		/* not enough room */
3296 	col = Columns - 1;
3297 #ifdef FEAT_RIGHTLEFT
3298     if (cmdmsg_rl)
3299 	while (msg_col > Columns - col)
3300 	    msg_putchar(' ');
3301     else
3302 #endif
3303 	while (msg_col < col)
3304 	    msg_putchar(' ');
3305 }
3306 
3307 #if defined(FEAT_CON_DIALOG) || defined(PROTO)
3308 /*
3309  * Used for "confirm()" function, and the :confirm command prefix.
3310  * Versions which haven't got flexible dialogs yet, and console
3311  * versions, get this generic handler which uses the command line.
3312  *
3313  * type  = one of:
3314  *	   VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3315  * title = title string (can be NULL for default)
3316  * (neither used in console dialogs at the moment)
3317  *
3318  * Format of the "buttons" string:
3319  * "Button1Name\nButton2Name\nButton3Name"
3320  * The first button should normally be the default/accept
3321  * The second button should be the 'Cancel' button
3322  * Other buttons- use your imagination!
3323  * A '&' in a button name becomes a shortcut, so each '&' should be before a
3324  * different letter.
3325  */
3326     int
3327 do_dialog(type, title, message, buttons, dfltbutton, textfield, ex_cmd)
3328     int		type UNUSED;
3329     char_u	*title UNUSED;
3330     char_u	*message;
3331     char_u	*buttons;
3332     int		dfltbutton;
3333     char_u	*textfield UNUSED;	/* IObuff for inputdialog(), NULL
3334 					   otherwise */
3335     int		ex_cmd;	    /* when TRUE pressing : accepts default and starts
3336 			       Ex command */
3337 {
3338     int		oldState;
3339     int		retval = 0;
3340     char_u	*hotkeys;
3341     int		c;
3342     int		i;
3343 
3344 #ifndef NO_CONSOLE
3345     /* Don't output anything in silent mode ("ex -s") */
3346     if (silent_mode)
3347 	return dfltbutton;   /* return default option */
3348 #endif
3349 
3350 #ifdef FEAT_GUI_DIALOG
3351     /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3352     if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3353     {
3354 	c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3355 							   textfield, ex_cmd);
3356 	/* avoid a hit-enter prompt without clearing the cmdline */
3357 	need_wait_return = FALSE;
3358 	emsg_on_display = FALSE;
3359 	cmdline_row = msg_row;
3360 
3361 	/* Flush output to avoid that further messages and redrawing is done
3362 	 * in the wrong order. */
3363 	out_flush();
3364 	gui_mch_update();
3365 
3366 	return c;
3367     }
3368 #endif
3369 
3370     oldState = State;
3371     State = CONFIRM;
3372 #ifdef FEAT_MOUSE
3373     setmouse();
3374 #endif
3375 
3376     /*
3377      * Since we wait for a keypress, don't make the
3378      * user press RETURN as well afterwards.
3379      */
3380     ++no_wait_return;
3381     hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3382 
3383     if (hotkeys != NULL)
3384     {
3385 	for (;;)
3386 	{
3387 	    /* Get a typed character directly from the user. */
3388 	    c = get_keystroke();
3389 	    switch (c)
3390 	    {
3391 	    case CAR:		/* User accepts default option */
3392 	    case NL:
3393 		retval = dfltbutton;
3394 		break;
3395 	    case Ctrl_C:	/* User aborts/cancels */
3396 	    case ESC:
3397 		retval = 0;
3398 		break;
3399 	    default:		/* Could be a hotkey? */
3400 		if (c < 0)	/* special keys are ignored here */
3401 		    continue;
3402 		if (c == ':' && ex_cmd)
3403 		{
3404 		    retval = dfltbutton;
3405 		    ins_char_typebuf(':');
3406 		    break;
3407 		}
3408 
3409 		/* Make the character lowercase, as chars in "hotkeys" are. */
3410 		c = MB_TOLOWER(c);
3411 		retval = 1;
3412 		for (i = 0; hotkeys[i]; ++i)
3413 		{
3414 #ifdef FEAT_MBYTE
3415 		    if (has_mbyte)
3416 		    {
3417 			if ((*mb_ptr2char)(hotkeys + i) == c)
3418 			    break;
3419 			i += (*mb_ptr2len)(hotkeys + i) - 1;
3420 		    }
3421 		    else
3422 #endif
3423 			if (hotkeys[i] == c)
3424 			    break;
3425 		    ++retval;
3426 		}
3427 		if (hotkeys[i])
3428 		    break;
3429 		/* No hotkey match, so keep waiting */
3430 		continue;
3431 	    }
3432 	    break;
3433 	}
3434 
3435 	vim_free(hotkeys);
3436     }
3437 
3438     State = oldState;
3439 #ifdef FEAT_MOUSE
3440     setmouse();
3441 #endif
3442     --no_wait_return;
3443     msg_end_prompt();
3444 
3445     return retval;
3446 }
3447 
3448 static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3449 
3450 /*
3451  * Copy one character from "*from" to "*to", taking care of multi-byte
3452  * characters.  Return the length of the character in bytes.
3453  */
3454     static int
3455 copy_char(from, to, lowercase)
3456     char_u	*from;
3457     char_u	*to;
3458     int		lowercase;	/* make character lower case */
3459 {
3460 #ifdef FEAT_MBYTE
3461     int		len;
3462     int		c;
3463 
3464     if (has_mbyte)
3465     {
3466 	if (lowercase)
3467 	{
3468 	    c = MB_TOLOWER((*mb_ptr2char)(from));
3469 	    return (*mb_char2bytes)(c, to);
3470 	}
3471 	else
3472 	{
3473 	    len = (*mb_ptr2len)(from);
3474 	    mch_memmove(to, from, (size_t)len);
3475 	    return len;
3476 	}
3477     }
3478     else
3479 #endif
3480     {
3481 	if (lowercase)
3482 	    *to = (char_u)TOLOWER_LOC(*from);
3483 	else
3484 	    *to = *from;
3485 	return 1;
3486     }
3487 }
3488 
3489 /*
3490  * Format the dialog string, and display it at the bottom of
3491  * the screen. Return a string of hotkey chars (if defined) for
3492  * each 'button'. If a button has no hotkey defined, the first character of
3493  * the button is used.
3494  * The hotkeys can be multi-byte characters, but without combining chars.
3495  *
3496  * Returns an allocated string with hotkeys, or NULL for error.
3497  */
3498     static char_u *
3499 msg_show_console_dialog(message, buttons, dfltbutton)
3500     char_u	*message;
3501     char_u	*buttons;
3502     int		dfltbutton;
3503 {
3504     int		len = 0;
3505 #ifdef FEAT_MBYTE
3506 # define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3507 #else
3508 # define HOTK_LEN 1
3509 #endif
3510     int		lenhotkey = HOTK_LEN;	/* count first button */
3511     char_u	*hotk = NULL;
3512     char_u	*msgp = NULL;
3513     char_u	*hotkp = NULL;
3514     char_u	*r;
3515     int		copy;
3516 #define HAS_HOTKEY_LEN 30
3517     char_u	has_hotkey[HAS_HOTKEY_LEN];
3518     int		first_hotkey = FALSE;	/* first char of button is hotkey */
3519     int		idx;
3520 
3521     has_hotkey[0] = FALSE;
3522 
3523     /*
3524      * First loop: compute the size of memory to allocate.
3525      * Second loop: copy to the allocated memory.
3526      */
3527     for (copy = 0; copy <= 1; ++copy)
3528     {
3529 	r = buttons;
3530 	idx = 0;
3531 	while (*r)
3532 	{
3533 	    if (*r == DLG_BUTTON_SEP)
3534 	    {
3535 		if (copy)
3536 		{
3537 		    *msgp++ = ',';
3538 		    *msgp++ = ' ';	    /* '\n' -> ', ' */
3539 
3540 		    /* advance to next hotkey and set default hotkey */
3541 #ifdef FEAT_MBYTE
3542 		    if (has_mbyte)
3543 			hotkp += STRLEN(hotkp);
3544 		    else
3545 #endif
3546 			++hotkp;
3547 		    hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
3548 		    if (dfltbutton)
3549 			--dfltbutton;
3550 
3551 		    /* If no hotkey is specified first char is used. */
3552 		    if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3553 			first_hotkey = TRUE;
3554 		}
3555 		else
3556 		{
3557 		    len += 3;		    /* '\n' -> ', '; 'x' -> '(x)' */
3558 		    lenhotkey += HOTK_LEN;  /* each button needs a hotkey */
3559 		    if (idx < HAS_HOTKEY_LEN - 1)
3560 			has_hotkey[++idx] = FALSE;
3561 		}
3562 	    }
3563 	    else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3564 	    {
3565 		if (*r == DLG_HOTKEY_CHAR)
3566 		    ++r;
3567 		first_hotkey = FALSE;
3568 		if (copy)
3569 		{
3570 		    if (*r == DLG_HOTKEY_CHAR)		/* '&&a' -> '&a' */
3571 			*msgp++ = *r;
3572 		    else
3573 		    {
3574 			/* '&a' -> '[a]' */
3575 			*msgp++ = (dfltbutton == 1) ? '[' : '(';
3576 			msgp += copy_char(r, msgp, FALSE);
3577 			*msgp++ = (dfltbutton == 1) ? ']' : ')';
3578 
3579 			/* redefine hotkey */
3580 			hotkp[copy_char(r, hotkp, TRUE)] = NUL;
3581 		    }
3582 		}
3583 		else
3584 		{
3585 		    ++len;	    /* '&a' -> '[a]' */
3586 		    if (idx < HAS_HOTKEY_LEN - 1)
3587 			has_hotkey[idx] = TRUE;
3588 		}
3589 	    }
3590 	    else
3591 	    {
3592 		/* everything else copy literally */
3593 		if (copy)
3594 		    msgp += copy_char(r, msgp, FALSE);
3595 	    }
3596 
3597 	    /* advance to the next character */
3598 	    mb_ptr_adv(r);
3599 	}
3600 
3601 	if (copy)
3602 	{
3603 	    *msgp++ = ':';
3604 	    *msgp++ = ' ';
3605 	    *msgp = NUL;
3606 	}
3607 	else
3608 	{
3609 	    len += (int)(STRLEN(message)
3610 			+ 2			/* for the NL's */
3611 			+ STRLEN(buttons)
3612 			+ 3);			/* for the ": " and NUL */
3613 	    lenhotkey++;			/* for the NUL */
3614 
3615 	    /* If no hotkey is specified first char is used. */
3616 	    if (!has_hotkey[0])
3617 	    {
3618 		first_hotkey = TRUE;
3619 		len += 2;		/* "x" -> "[x]" */
3620 	    }
3621 
3622 	    /*
3623 	     * Now allocate and load the strings
3624 	     */
3625 	    vim_free(confirm_msg);
3626 	    confirm_msg = alloc(len);
3627 	    if (confirm_msg == NULL)
3628 		return NULL;
3629 	    *confirm_msg = NUL;
3630 	    hotk = alloc(lenhotkey);
3631 	    if (hotk == NULL)
3632 		return NULL;
3633 
3634 	    *confirm_msg = '\n';
3635 	    STRCPY(confirm_msg + 1, message);
3636 
3637 	    msgp = confirm_msg + 1 + STRLEN(message);
3638 	    hotkp = hotk;
3639 
3640 	    /* Define first default hotkey.  Keep the hotkey string NUL
3641 	     * terminated to avoid reading past the end. */
3642 	    hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
3643 
3644 	    /* Remember where the choices start, displaying starts here when
3645 	     * "hotkp" typed at the more prompt. */
3646 	    confirm_msg_tail = msgp;
3647 	    *msgp++ = '\n';
3648 	}
3649     }
3650 
3651     display_confirm_msg();
3652     return hotk;
3653 }
3654 
3655 /*
3656  * Display the ":confirm" message.  Also called when screen resized.
3657  */
3658     void
3659 display_confirm_msg()
3660 {
3661     /* avoid that 'q' at the more prompt truncates the message here */
3662     ++confirm_msg_used;
3663     if (confirm_msg != NULL)
3664 	msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3665     --confirm_msg_used;
3666 }
3667 
3668 #endif /* FEAT_CON_DIALOG */
3669 
3670 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3671 
3672     int
3673 vim_dialog_yesno(type, title, message, dflt)
3674     int		type;
3675     char_u	*title;
3676     char_u	*message;
3677     int		dflt;
3678 {
3679     if (do_dialog(type,
3680 		title == NULL ? (char_u *)_("Question") : title,
3681 		message,
3682 		(char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
3683 	return VIM_YES;
3684     return VIM_NO;
3685 }
3686 
3687     int
3688 vim_dialog_yesnocancel(type, title, message, dflt)
3689     int		type;
3690     char_u	*title;
3691     char_u	*message;
3692     int		dflt;
3693 {
3694     switch (do_dialog(type,
3695 		title == NULL ? (char_u *)_("Question") : title,
3696 		message,
3697 		(char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
3698     {
3699 	case 1: return VIM_YES;
3700 	case 2: return VIM_NO;
3701     }
3702     return VIM_CANCEL;
3703 }
3704 
3705     int
3706 vim_dialog_yesnoallcancel(type, title, message, dflt)
3707     int		type;
3708     char_u	*title;
3709     char_u	*message;
3710     int		dflt;
3711 {
3712     switch (do_dialog(type,
3713 		title == NULL ? (char_u *)"Question" : title,
3714 		message,
3715 		(char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3716 							   dflt, NULL, FALSE))
3717     {
3718 	case 1: return VIM_YES;
3719 	case 2: return VIM_NO;
3720 	case 3: return VIM_ALL;
3721 	case 4: return VIM_DISCARDALL;
3722     }
3723     return VIM_CANCEL;
3724 }
3725 
3726 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3727 
3728 #if defined(FEAT_BROWSE) || defined(PROTO)
3729 /*
3730  * Generic browse function.  Calls gui_mch_browse() when possible.
3731  * Later this may pop-up a non-GUI file selector (external command?).
3732  */
3733     char_u *
3734 do_browse(flags, title, dflt, ext, initdir, filter, buf)
3735     int		flags;		/* BROWSE_SAVE and BROWSE_DIR */
3736     char_u	*title;		/* title for the window */
3737     char_u	*dflt;		/* default file name (may include directory) */
3738     char_u	*ext;		/* extension added */
3739     char_u	*initdir;	/* initial directory, NULL for current dir or
3740 				   when using path from "dflt" */
3741     char_u	*filter;	/* file name filter */
3742     buf_T	*buf;		/* buffer to read/write for */
3743 {
3744     char_u		*fname;
3745     static char_u	*last_dir = NULL;    /* last used directory */
3746     char_u		*tofree = NULL;
3747     int			save_browse = cmdmod.browse;
3748 
3749     /* Must turn off browse to avoid that autocommands will get the
3750      * flag too!  */
3751     cmdmod.browse = FALSE;
3752 
3753     if (title == NULL || *title == NUL)
3754     {
3755 	if (flags & BROWSE_DIR)
3756 	    title = (char_u *)_("Select Directory dialog");
3757 	else if (flags & BROWSE_SAVE)
3758 	    title = (char_u *)_("Save File dialog");
3759 	else
3760 	    title = (char_u *)_("Open File dialog");
3761     }
3762 
3763     /* When no directory specified, use default file name, default dir, buffer
3764      * dir, last dir or current dir */
3765     if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3766     {
3767 	if (mch_isdir(dflt))		/* default file name is a directory */
3768 	{
3769 	    initdir = dflt;
3770 	    dflt = NULL;
3771 	}
3772 	else if (gettail(dflt) != dflt)	/* default file name includes a path */
3773 	{
3774 	    tofree = vim_strsave(dflt);
3775 	    if (tofree != NULL)
3776 	    {
3777 		initdir = tofree;
3778 		*gettail(initdir) = NUL;
3779 		dflt = gettail(dflt);
3780 	    }
3781 	}
3782     }
3783 
3784     if (initdir == NULL || *initdir == NUL)
3785     {
3786 	/* When 'browsedir' is a directory, use it */
3787 	if (STRCMP(p_bsdir, "last") != 0
3788 		&& STRCMP(p_bsdir, "buffer") != 0
3789 		&& STRCMP(p_bsdir, "current") != 0
3790 		&& mch_isdir(p_bsdir))
3791 	    initdir = p_bsdir;
3792 	/* When saving or 'browsedir' is "buffer", use buffer fname */
3793 	else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
3794 		&& buf != NULL && buf->b_ffname != NULL)
3795 	{
3796 	    if (dflt == NULL || *dflt == NUL)
3797 		dflt = gettail(curbuf->b_ffname);
3798 	    tofree = vim_strsave(curbuf->b_ffname);
3799 	    if (tofree != NULL)
3800 	    {
3801 		initdir = tofree;
3802 		*gettail(initdir) = NUL;
3803 	    }
3804 	}
3805 	/* When 'browsedir' is "last", use dir from last browse */
3806 	else if (*p_bsdir == 'l')
3807 	    initdir = last_dir;
3808 	/* When 'browsedir is "current", use current directory.  This is the
3809 	 * default already, leave initdir empty. */
3810     }
3811 
3812 # ifdef FEAT_GUI
3813     if (gui.in_use)		/* when this changes, also adjust f_has()! */
3814     {
3815 	if (filter == NULL
3816 #  ifdef FEAT_EVAL
3817 		&& (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3818 		&& (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3819 #  endif
3820 	)
3821 	    filter = BROWSE_FILTER_DEFAULT;
3822 	if (flags & BROWSE_DIR)
3823 	{
3824 #  if defined(FEAT_GUI_GTK) || defined(WIN3264)
3825 	    /* For systems that have a directory dialog. */
3826 	    fname = gui_mch_browsedir(title, initdir);
3827 #  else
3828 	    /* Generic solution for selecting a directory: select a file and
3829 	     * remove the file name. */
3830 	    fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3831 #  endif
3832 #  if !defined(FEAT_GUI_GTK)
3833 	    /* Win32 adds a dummy file name, others return an arbitrary file
3834 	     * name.  GTK+ 2 returns only the directory, */
3835 	    if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3836 	    {
3837 		/* Remove the file name. */
3838 		char_u	    *tail = gettail_sep(fname);
3839 
3840 		if (tail == fname)
3841 		    *tail++ = '.';	/* use current dir */
3842 		*tail = NUL;
3843 	    }
3844 #  endif
3845 	}
3846 	else
3847 	    fname = gui_mch_browse(flags & BROWSE_SAVE,
3848 					   title, dflt, ext, initdir, filter);
3849 
3850 	/* We hang around in the dialog for a while, the user might do some
3851 	 * things to our files.  The Win32 dialog allows deleting or renaming
3852 	 * a file, check timestamps. */
3853 	need_check_timestamps = TRUE;
3854 	did_check_timestamps = FALSE;
3855     }
3856     else
3857 # endif
3858     {
3859 	/* TODO: non-GUI file selector here */
3860 	EMSG(_("E338: Sorry, no file browser in console mode"));
3861 	fname = NULL;
3862     }
3863 
3864     /* keep the directory for next time */
3865     if (fname != NULL)
3866     {
3867 	vim_free(last_dir);
3868 	last_dir = vim_strsave(fname);
3869 	if (last_dir != NULL && !(flags & BROWSE_DIR))
3870 	{
3871 	    *gettail(last_dir) = NUL;
3872 	    if (*last_dir == NUL)
3873 	    {
3874 		/* filename only returned, must be in current dir */
3875 		vim_free(last_dir);
3876 		last_dir = alloc(MAXPATHL);
3877 		if (last_dir != NULL)
3878 		    mch_dirname(last_dir, MAXPATHL);
3879 	    }
3880 	}
3881     }
3882 
3883     vim_free(tofree);
3884     cmdmod.browse = save_browse;
3885 
3886     return fname;
3887 }
3888 #endif
3889 
3890 #if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3891 static char *e_printf = N_("E766: Insufficient arguments for printf()");
3892 
3893 static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3894 static char *tv_str __ARGS((typval_T *tvs, int *idxp));
3895 # ifdef FEAT_FLOAT
3896 static double tv_float __ARGS((typval_T *tvs, int *idxp));
3897 # endif
3898 
3899 /*
3900  * Get number argument from "idxp" entry in "tvs".  First entry is 1.
3901  */
3902     static long
3903 tv_nr(tvs, idxp)
3904     typval_T	*tvs;
3905     int		*idxp;
3906 {
3907     int		idx = *idxp - 1;
3908     long	n = 0;
3909     int		err = FALSE;
3910 
3911     if (tvs[idx].v_type == VAR_UNKNOWN)
3912 	EMSG(_(e_printf));
3913     else
3914     {
3915 	++*idxp;
3916 	n = get_tv_number_chk(&tvs[idx], &err);
3917 	if (err)
3918 	    n = 0;
3919     }
3920     return n;
3921 }
3922 
3923 /*
3924  * Get string argument from "idxp" entry in "tvs".  First entry is 1.
3925  * Returns NULL for an error.
3926  */
3927     static char *
3928 tv_str(tvs, idxp)
3929     typval_T	*tvs;
3930     int		*idxp;
3931 {
3932     int		idx = *idxp - 1;
3933     char	*s = NULL;
3934 
3935     if (tvs[idx].v_type == VAR_UNKNOWN)
3936 	EMSG(_(e_printf));
3937     else
3938     {
3939 	++*idxp;
3940 	s = (char *)get_tv_string_chk(&tvs[idx]);
3941     }
3942     return s;
3943 }
3944 
3945 # ifdef FEAT_FLOAT
3946 /*
3947  * Get float argument from "idxp" entry in "tvs".  First entry is 1.
3948  */
3949     static double
3950 tv_float(tvs, idxp)
3951     typval_T	*tvs;
3952     int		*idxp;
3953 {
3954     int		idx = *idxp - 1;
3955     double	f = 0;
3956 
3957     if (tvs[idx].v_type == VAR_UNKNOWN)
3958 	EMSG(_(e_printf));
3959     else
3960     {
3961 	++*idxp;
3962 	if (tvs[idx].v_type == VAR_FLOAT)
3963 	    f = tvs[idx].vval.v_float;
3964 	else if (tvs[idx].v_type == VAR_NUMBER)
3965 	    f = tvs[idx].vval.v_number;
3966 	else
3967 	    EMSG(_("E807: Expected Float argument for printf()"));
3968     }
3969     return f;
3970 }
3971 # endif
3972 #endif
3973 
3974 /*
3975  * This code was included to provide a portable vsnprintf() and snprintf().
3976  * Some systems may provide their own, but we always use this one for
3977  * consistency.
3978  *
3979  * This code is based on snprintf.c - a portable implementation of snprintf
3980  * by Mark Martinec <[email protected]>, Version 2.2, 2000-10-06.
3981  * Included with permission.  It was heavily modified to fit in Vim.
3982  * The original code, including useful comments, can be found here:
3983  *	http://www.ijs.si/software/snprintf/
3984  *
3985  * This snprintf() only supports the following conversion specifiers:
3986  * s, c, d, u, o, x, X, p  (and synonyms: i, D, U, O - see below)
3987  * with flags: '-', '+', ' ', '0' and '#'.
3988  * An asterisk is supported for field width as well as precision.
3989  *
3990  * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3991  *
3992  * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3993  * 'll' (long long int) is not supported.
3994  *
3995  * The locale is not used, the string is used as a byte string.  This is only
3996  * relevant for double-byte encodings where the second byte may be '%'.
3997  *
3998  * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3999  * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
4000  *
4001  * The return value is the number of characters which would be generated
4002  * for the given input, excluding the trailing null. If this value
4003  * is greater or equal to "str_m", not all characters from the result
4004  * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4005  * are discarded. If "str_m" is greater than zero it is guaranteed
4006  * the resulting string will be null-terminated.
4007  */
4008 
4009 /*
4010  * When va_list is not supported we only define vim_snprintf().
4011  *
4012  * vim_vsnprintf() can be invoked with either "va_list" or a list of
4013  * "typval_T".  When the latter is not used it must be NULL.
4014  */
4015 
4016 /* When generating prototypes all of this is skipped, cproto doesn't
4017  * understand this. */
4018 #ifndef PROTO
4019 
4020 # ifdef HAVE_STDARG_H
4021 /* Like vim_vsnprintf() but append to the string. */
4022     int
4023 vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4024 {
4025     va_list	ap;
4026     int		str_l;
4027     size_t	len = STRLEN(str);
4028     size_t	space;
4029 
4030     if (str_m <= len)
4031 	space = 0;
4032     else
4033 	space = str_m - len;
4034     va_start(ap, fmt);
4035     str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
4036     va_end(ap);
4037     return str_l;
4038 }
4039 # else
4040 /* Like vim_vsnprintf() but append to the string. */
4041     int
4042 vim_snprintf_add(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4043     char	*str;
4044     size_t	str_m;
4045     char	*fmt;
4046     long	a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4047 {
4048     size_t	len = STRLEN(str);
4049     size_t	space;
4050 
4051     if (str_m <= len)
4052 	space = 0;
4053     else
4054 	space = str_m - len;
4055     return vim_vsnprintf(str + len, space, fmt,
4056 				     a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
4057 }
4058 # endif
4059 
4060 # ifdef HAVE_STDARG_H
4061     int
4062 vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4063 {
4064     va_list	ap;
4065     int		str_l;
4066 
4067     va_start(ap, fmt);
4068     str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
4069     va_end(ap);
4070     return str_l;
4071 }
4072 
4073     int
4074 vim_vsnprintf(str, str_m, fmt, ap, tvs)
4075 # else
4076     /* clumsy way to work around missing va_list */
4077 #  define get_a_arg(i) (++i, i == 2 ? a1 : i == 3 ? a2 : i == 4 ? a3 : i == 5 ? a4 : i == 6 ? a5 : i == 7 ? a6 : i == 8 ? a7 : i == 9 ? a8 : i == 10 ? a9 : a10)
4078 
4079 /* VARARGS */
4080     int
4081 #ifdef __BORLANDC__
4082 _RTLENTRYF
4083 #endif
4084 vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4085 # endif
4086     char	*str;
4087     size_t	str_m;
4088     char	*fmt;
4089 # ifdef HAVE_STDARG_H
4090     va_list	ap;
4091     typval_T	*tvs;
4092 # else
4093     long	a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4094 # endif
4095 {
4096     size_t	str_l = 0;
4097     char	*p = fmt;
4098     int		arg_idx = 1;
4099 
4100     if (p == NULL)
4101 	p = "";
4102     while (*p != NUL)
4103     {
4104 	if (*p != '%')
4105 	{
4106 	    char    *q = strchr(p + 1, '%');
4107 	    size_t  n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
4108 
4109 	    /* Copy up to the next '%' or NUL without any changes. */
4110 	    if (str_l < str_m)
4111 	    {
4112 		size_t avail = str_m - str_l;
4113 
4114 		mch_memmove(str + str_l, p, n > avail ? avail : n);
4115 	    }
4116 	    p += n;
4117 	    str_l += n;
4118 	}
4119 	else
4120 	{
4121 	    size_t  min_field_width = 0, precision = 0;
4122 	    int	    zero_padding = 0, precision_specified = 0, justify_left = 0;
4123 	    int	    alternate_form = 0, force_sign = 0;
4124 
4125 	    /* If both the ' ' and '+' flags appear, the ' ' flag should be
4126 	     * ignored. */
4127 	    int	    space_for_positive = 1;
4128 
4129 	    /* allowed values: \0, h, l, L */
4130 	    char    length_modifier = '\0';
4131 
4132 	    /* temporary buffer for simple numeric->string conversion */
4133 #ifdef FEAT_FLOAT
4134 # define TMP_LEN 350	/* On my system 1e308 is the biggest number possible.
4135 			 * That sounds reasonable to use as the maximum
4136 			 * printable. */
4137 #else
4138 # define TMP_LEN 32
4139 #endif
4140 	    char    tmp[TMP_LEN];
4141 
4142 	    /* string address in case of string argument */
4143 	    char    *str_arg;
4144 
4145 	    /* natural field width of arg without padding and sign */
4146 	    size_t  str_arg_l;
4147 
4148 	    /* unsigned char argument value - only defined for c conversion.
4149 	     * N.B. standard explicitly states the char argument for the c
4150 	     * conversion is unsigned */
4151 	    unsigned char uchar_arg;
4152 
4153 	    /* number of zeros to be inserted for numeric conversions as
4154 	     * required by the precision or minimal field width */
4155 	    size_t  number_of_zeros_to_pad = 0;
4156 
4157 	    /* index into tmp where zero padding is to be inserted */
4158 	    size_t  zero_padding_insertion_ind = 0;
4159 
4160 	    /* current conversion specifier character */
4161 	    char    fmt_spec = '\0';
4162 
4163 	    str_arg = NULL;
4164 	    p++;  /* skip '%' */
4165 
4166 	    /* parse flags */
4167 	    while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4168 						   || *p == '#' || *p == '\'')
4169 	    {
4170 		switch (*p)
4171 		{
4172 		    case '0': zero_padding = 1; break;
4173 		    case '-': justify_left = 1; break;
4174 		    case '+': force_sign = 1; space_for_positive = 0; break;
4175 		    case ' ': force_sign = 1;
4176 			      /* If both the ' ' and '+' flags appear, the ' '
4177 			       * flag should be ignored */
4178 			      break;
4179 		    case '#': alternate_form = 1; break;
4180 		    case '\'': break;
4181 		}
4182 		p++;
4183 	    }
4184 	    /* If the '0' and '-' flags both appear, the '0' flag should be
4185 	     * ignored. */
4186 
4187 	    /* parse field width */
4188 	    if (*p == '*')
4189 	    {
4190 		int j;
4191 
4192 		p++;
4193 		j =
4194 #ifndef HAVE_STDARG_H
4195 		    get_a_arg(arg_idx);
4196 #else
4197 # if defined(FEAT_EVAL)
4198 		    tvs != NULL ? tv_nr(tvs, &arg_idx) :
4199 # endif
4200 			va_arg(ap, int);
4201 #endif
4202 		if (j >= 0)
4203 		    min_field_width = j;
4204 		else
4205 		{
4206 		    min_field_width = -j;
4207 		    justify_left = 1;
4208 		}
4209 	    }
4210 	    else if (VIM_ISDIGIT((int)(*p)))
4211 	    {
4212 		/* size_t could be wider than unsigned int; make sure we treat
4213 		 * argument like common implementations do */
4214 		unsigned int uj = *p++ - '0';
4215 
4216 		while (VIM_ISDIGIT((int)(*p)))
4217 		    uj = 10 * uj + (unsigned int)(*p++ - '0');
4218 		min_field_width = uj;
4219 	    }
4220 
4221 	    /* parse precision */
4222 	    if (*p == '.')
4223 	    {
4224 		p++;
4225 		precision_specified = 1;
4226 		if (*p == '*')
4227 		{
4228 		    int j;
4229 
4230 		    j =
4231 #ifndef HAVE_STDARG_H
4232 			get_a_arg(arg_idx);
4233 #else
4234 # if defined(FEAT_EVAL)
4235 			tvs != NULL ? tv_nr(tvs, &arg_idx) :
4236 # endif
4237 			    va_arg(ap, int);
4238 #endif
4239 		    p++;
4240 		    if (j >= 0)
4241 			precision = j;
4242 		    else
4243 		    {
4244 			precision_specified = 0;
4245 			precision = 0;
4246 		    }
4247 		}
4248 		else if (VIM_ISDIGIT((int)(*p)))
4249 		{
4250 		    /* size_t could be wider than unsigned int; make sure we
4251 		     * treat argument like common implementations do */
4252 		    unsigned int uj = *p++ - '0';
4253 
4254 		    while (VIM_ISDIGIT((int)(*p)))
4255 			uj = 10 * uj + (unsigned int)(*p++ - '0');
4256 		    precision = uj;
4257 		}
4258 	    }
4259 
4260 	    /* parse 'h', 'l' and 'll' length modifiers */
4261 	    if (*p == 'h' || *p == 'l')
4262 	    {
4263 		length_modifier = *p;
4264 		p++;
4265 		if (length_modifier == 'l' && *p == 'l')
4266 		{
4267 		    /* double l = long long */
4268 		    length_modifier = 'l';	/* treat it as a single 'l' */
4269 		    p++;
4270 		}
4271 	    }
4272 	    fmt_spec = *p;
4273 
4274 	    /* common synonyms: */
4275 	    switch (fmt_spec)
4276 	    {
4277 		case 'i': fmt_spec = 'd'; break;
4278 		case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4279 		case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4280 		case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4281 		case 'F': fmt_spec = 'f'; break;
4282 		default: break;
4283 	    }
4284 
4285 	    /* get parameter value, do initial processing */
4286 	    switch (fmt_spec)
4287 	    {
4288 		/* '%' and 'c' behave similar to 's' regarding flags and field
4289 		 * widths */
4290 	    case '%':
4291 	    case 'c':
4292 	    case 's':
4293 	    case 'S':
4294 		length_modifier = '\0';
4295 		str_arg_l = 1;
4296 		switch (fmt_spec)
4297 		{
4298 		case '%':
4299 		    str_arg = p;
4300 		    break;
4301 
4302 		case 'c':
4303 		    {
4304 			int j;
4305 
4306 			j =
4307 #ifndef HAVE_STDARG_H
4308 			    get_a_arg(arg_idx);
4309 #else
4310 # if defined(FEAT_EVAL)
4311 			    tvs != NULL ? tv_nr(tvs, &arg_idx) :
4312 # endif
4313 				va_arg(ap, int);
4314 #endif
4315 			/* standard demands unsigned char */
4316 			uchar_arg = (unsigned char)j;
4317 			str_arg = (char *)&uchar_arg;
4318 			break;
4319 		    }
4320 
4321 		case 's':
4322 		case 'S':
4323 		    str_arg =
4324 #ifndef HAVE_STDARG_H
4325 				(char *)get_a_arg(arg_idx);
4326 #else
4327 # if defined(FEAT_EVAL)
4328 				tvs != NULL ? tv_str(tvs, &arg_idx) :
4329 # endif
4330 				    va_arg(ap, char *);
4331 #endif
4332 		    if (str_arg == NULL)
4333 		    {
4334 			str_arg = "[NULL]";
4335 			str_arg_l = 6;
4336 		    }
4337 		    /* make sure not to address string beyond the specified
4338 		     * precision !!! */
4339 		    else if (!precision_specified)
4340 			str_arg_l = strlen(str_arg);
4341 		    /* truncate string if necessary as requested by precision */
4342 		    else if (precision == 0)
4343 			str_arg_l = 0;
4344 		    else
4345 		    {
4346 			/* Don't put the #if inside memchr(), it can be a
4347 			 * macro. */
4348 #if SIZEOF_INT <= 2
4349 			char *q = memchr(str_arg, '\0', precision);
4350 #else
4351 			/* memchr on HP does not like n > 2^31  !!! */
4352 			char *q = memchr(str_arg, '\0',
4353 				  precision <= (size_t)0x7fffffffL ? precision
4354 						       : (size_t)0x7fffffffL);
4355 #endif
4356 			str_arg_l = (q == NULL) ? precision
4357 						      : (size_t)(q - str_arg);
4358 		    }
4359 #ifdef FEAT_MBYTE
4360 		    if (fmt_spec == 'S')
4361 		    {
4362 			if (min_field_width != 0)
4363 			    min_field_width += STRLEN(str_arg)
4364 				     - mb_string2cells((char_u *)str_arg, -1);
4365 			if (precision)
4366 			{
4367 			    char_u *p1 = (char_u *)str_arg;
4368 			    size_t i;
4369 
4370 			    for (i = 0; i < precision && *p1; i++)
4371 				p1 += mb_ptr2len(p1);
4372 
4373 			    str_arg_l = precision = p1 - (char_u *)str_arg;
4374 			}
4375 		    }
4376 #endif
4377 		    break;
4378 
4379 		default:
4380 		    break;
4381 		}
4382 		break;
4383 
4384 	    case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4385 		{
4386 		    /* NOTE: the u, o, x, X and p conversion specifiers
4387 		     * imply the value is unsigned;  d implies a signed
4388 		     * value */
4389 
4390 		    /* 0 if numeric argument is zero (or if pointer is
4391 		     * NULL for 'p'), +1 if greater than zero (or nonzero
4392 		     * for unsigned arguments), -1 if negative (unsigned
4393 		     * argument is never negative) */
4394 		    int arg_sign = 0;
4395 
4396 		    /* only defined for length modifier h, or for no
4397 		     * length modifiers */
4398 		    int int_arg = 0;
4399 		    unsigned int uint_arg = 0;
4400 
4401 		    /* only defined for length modifier l */
4402 		    long int long_arg = 0;
4403 		    unsigned long int ulong_arg = 0;
4404 
4405 		    /* pointer argument value -only defined for p
4406 		     * conversion */
4407 		    void *ptr_arg = NULL;
4408 
4409 		    if (fmt_spec == 'p')
4410 		    {
4411 			length_modifier = '\0';
4412 			ptr_arg =
4413 #ifndef HAVE_STDARG_H
4414 				 (void *)get_a_arg(arg_idx);
4415 #else
4416 # if defined(FEAT_EVAL)
4417 				 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
4418 # endif
4419 					va_arg(ap, void *);
4420 #endif
4421 			if (ptr_arg != NULL)
4422 			    arg_sign = 1;
4423 		    }
4424 		    else if (fmt_spec == 'd')
4425 		    {
4426 			/* signed */
4427 			switch (length_modifier)
4428 			{
4429 			case '\0':
4430 			case 'h':
4431 			    /* char and short arguments are passed as int. */
4432 			    int_arg =
4433 #ifndef HAVE_STDARG_H
4434 					get_a_arg(arg_idx);
4435 #else
4436 # if defined(FEAT_EVAL)
4437 					tvs != NULL ? tv_nr(tvs, &arg_idx) :
4438 # endif
4439 					    va_arg(ap, int);
4440 #endif
4441 			    if (int_arg > 0)
4442 				arg_sign =  1;
4443 			    else if (int_arg < 0)
4444 				arg_sign = -1;
4445 			    break;
4446 			case 'l':
4447 			    long_arg =
4448 #ifndef HAVE_STDARG_H
4449 					get_a_arg(arg_idx);
4450 #else
4451 # if defined(FEAT_EVAL)
4452 					tvs != NULL ? tv_nr(tvs, &arg_idx) :
4453 # endif
4454 					    va_arg(ap, long int);
4455 #endif
4456 			    if (long_arg > 0)
4457 				arg_sign =  1;
4458 			    else if (long_arg < 0)
4459 				arg_sign = -1;
4460 			    break;
4461 			}
4462 		    }
4463 		    else
4464 		    {
4465 			/* unsigned */
4466 			switch (length_modifier)
4467 			{
4468 			    case '\0':
4469 			    case 'h':
4470 				uint_arg =
4471 #ifndef HAVE_STDARG_H
4472 					    get_a_arg(arg_idx);
4473 #else
4474 # if defined(FEAT_EVAL)
4475 					    tvs != NULL ? (unsigned)
4476 							tv_nr(tvs, &arg_idx) :
4477 # endif
4478 						va_arg(ap, unsigned int);
4479 #endif
4480 				if (uint_arg != 0)
4481 				    arg_sign = 1;
4482 				break;
4483 			    case 'l':
4484 				ulong_arg =
4485 #ifndef HAVE_STDARG_H
4486 					    get_a_arg(arg_idx);
4487 #else
4488 # if defined(FEAT_EVAL)
4489 					    tvs != NULL ? (unsigned long)
4490 							tv_nr(tvs, &arg_idx) :
4491 # endif
4492 						va_arg(ap, unsigned long int);
4493 #endif
4494 				if (ulong_arg != 0)
4495 				    arg_sign = 1;
4496 				break;
4497 			}
4498 		    }
4499 
4500 		    str_arg = tmp;
4501 		    str_arg_l = 0;
4502 
4503 		    /* NOTE:
4504 		     *   For d, i, u, o, x, and X conversions, if precision is
4505 		     *   specified, the '0' flag should be ignored. This is so
4506 		     *   with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4507 		     *   FreeBSD, NetBSD; but not with Perl.
4508 		     */
4509 		    if (precision_specified)
4510 			zero_padding = 0;
4511 		    if (fmt_spec == 'd')
4512 		    {
4513 			if (force_sign && arg_sign >= 0)
4514 			    tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4515 			/* leave negative numbers for sprintf to handle, to
4516 			 * avoid handling tricky cases like (short int)-32768 */
4517 		    }
4518 		    else if (alternate_form)
4519 		    {
4520 			if (arg_sign != 0
4521 				     && (fmt_spec == 'x' || fmt_spec == 'X') )
4522 			{
4523 			    tmp[str_arg_l++] = '0';
4524 			    tmp[str_arg_l++] = fmt_spec;
4525 			}
4526 			/* alternate form should have no effect for p
4527 			 * conversion, but ... */
4528 		    }
4529 
4530 		    zero_padding_insertion_ind = str_arg_l;
4531 		    if (!precision_specified)
4532 			precision = 1;   /* default precision is 1 */
4533 		    if (precision == 0 && arg_sign == 0)
4534 		    {
4535 			/* When zero value is formatted with an explicit
4536 			 * precision 0, the resulting formatted string is
4537 			 * empty (d, i, u, o, x, X, p).   */
4538 		    }
4539 		    else
4540 		    {
4541 			char	f[5];
4542 			int	f_l = 0;
4543 
4544 			/* construct a simple format string for sprintf */
4545 			f[f_l++] = '%';
4546 			if (!length_modifier)
4547 			    ;
4548 			else if (length_modifier == '2')
4549 			{
4550 			    f[f_l++] = 'l';
4551 			    f[f_l++] = 'l';
4552 			}
4553 			else
4554 			    f[f_l++] = length_modifier;
4555 			f[f_l++] = fmt_spec;
4556 			f[f_l++] = '\0';
4557 
4558 			if (fmt_spec == 'p')
4559 			    str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4560 			else if (fmt_spec == 'd')
4561 			{
4562 			    /* signed */
4563 			    switch (length_modifier)
4564 			    {
4565 			    case '\0':
4566 			    case 'h': str_arg_l += sprintf(
4567 						 tmp + str_arg_l, f, int_arg);
4568 				      break;
4569 			    case 'l': str_arg_l += sprintf(
4570 						tmp + str_arg_l, f, long_arg);
4571 				      break;
4572 			    }
4573 			}
4574 			else
4575 			{
4576 			    /* unsigned */
4577 			    switch (length_modifier)
4578 			    {
4579 			    case '\0':
4580 			    case 'h': str_arg_l += sprintf(
4581 						tmp + str_arg_l, f, uint_arg);
4582 				      break;
4583 			    case 'l': str_arg_l += sprintf(
4584 					       tmp + str_arg_l, f, ulong_arg);
4585 				      break;
4586 			    }
4587 			}
4588 
4589 			/* include the optional minus sign and possible
4590 			 * "0x" in the region before the zero padding
4591 			 * insertion point */
4592 			if (zero_padding_insertion_ind < str_arg_l
4593 				&& tmp[zero_padding_insertion_ind] == '-')
4594 			    zero_padding_insertion_ind++;
4595 			if (zero_padding_insertion_ind + 1 < str_arg_l
4596 				&& tmp[zero_padding_insertion_ind]   == '0'
4597 				&& (tmp[zero_padding_insertion_ind + 1] == 'x'
4598 				 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4599 			    zero_padding_insertion_ind += 2;
4600 		    }
4601 
4602 		    {
4603 			size_t num_of_digits = str_arg_l
4604 						 - zero_padding_insertion_ind;
4605 
4606 			if (alternate_form && fmt_spec == 'o'
4607 				/* unless zero is already the first
4608 				 * character */
4609 				&& !(zero_padding_insertion_ind < str_arg_l
4610 				    && tmp[zero_padding_insertion_ind] == '0'))
4611 			{
4612 			    /* assure leading zero for alternate-form
4613 			     * octal numbers */
4614 			    if (!precision_specified
4615 					     || precision < num_of_digits + 1)
4616 			    {
4617 				/* precision is increased to force the
4618 				 * first character to be zero, except if a
4619 				 * zero value is formatted with an
4620 				 * explicit precision of zero */
4621 				precision = num_of_digits + 1;
4622 				precision_specified = 1;
4623 			    }
4624 			}
4625 			/* zero padding to specified precision? */
4626 			if (num_of_digits < precision)
4627 			    number_of_zeros_to_pad = precision - num_of_digits;
4628 		    }
4629 		    /* zero padding to specified minimal field width? */
4630 		    if (!justify_left && zero_padding)
4631 		    {
4632 			int n = (int)(min_field_width - (str_arg_l
4633 						    + number_of_zeros_to_pad));
4634 			if (n > 0)
4635 			    number_of_zeros_to_pad += n;
4636 		    }
4637 		    break;
4638 		}
4639 
4640 #ifdef FEAT_FLOAT
4641 	    case 'f':
4642 	    case 'e':
4643 	    case 'E':
4644 	    case 'g':
4645 	    case 'G':
4646 		{
4647 		    /* Floating point. */
4648 		    double	f;
4649 		    double	abs_f;
4650 		    char	format[40];
4651 		    int		l;
4652 		    int		remove_trailing_zeroes = FALSE;
4653 
4654 		    f =
4655 # ifndef HAVE_STDARG_H
4656 			get_a_arg(arg_idx);
4657 # else
4658 #  if defined(FEAT_EVAL)
4659 			tvs != NULL ? tv_float(tvs, &arg_idx) :
4660 #  endif
4661 			    va_arg(ap, double);
4662 # endif
4663 		    abs_f = f < 0 ? -f : f;
4664 
4665 		    if (fmt_spec == 'g' || fmt_spec == 'G')
4666 		    {
4667 			/* Would be nice to use %g directly, but it prints
4668 			 * "1.0" as "1", we don't want that. */
4669 			if ((abs_f >= 0.001 && abs_f < 10000000.0)
4670 							      || abs_f == 0.0)
4671 			    fmt_spec = 'f';
4672 			else
4673 			    fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4674 			remove_trailing_zeroes = TRUE;
4675 		    }
4676 
4677 		    if (fmt_spec == 'f' &&
4678 #ifdef VAX
4679 			    abs_f > 1.0e38
4680 #else
4681 			    abs_f > 1.0e307
4682 #endif
4683 			    )
4684 		    {
4685 			/* Avoid a buffer overflow */
4686 			strcpy(tmp, "inf");
4687 			str_arg_l = 3;
4688 		    }
4689 		    else
4690 		    {
4691 			format[0] = '%';
4692 			l = 1;
4693 			if (precision_specified)
4694 			{
4695 			    size_t max_prec = TMP_LEN - 10;
4696 
4697 			    /* Make sure we don't get more digits than we
4698 			     * have room for. */
4699 			    if (fmt_spec == 'f' && abs_f > 1.0)
4700 				max_prec -= (size_t)log10(abs_f);
4701 			    if (precision > max_prec)
4702 				precision = max_prec;
4703 			    l += sprintf(format + 1, ".%d", (int)precision);
4704 			}
4705 			format[l] = fmt_spec;
4706 			format[l + 1] = NUL;
4707 			str_arg_l = sprintf(tmp, format, f);
4708 
4709 			if (remove_trailing_zeroes)
4710 			{
4711 			    int i;
4712 			    char *tp;
4713 
4714 			    /* Using %g or %G: remove superfluous zeroes. */
4715 			    if (fmt_spec == 'f')
4716 				tp = tmp + str_arg_l - 1;
4717 			    else
4718 			    {
4719 				tp = (char *)vim_strchr((char_u *)tmp,
4720 						 fmt_spec == 'e' ? 'e' : 'E');
4721 				if (tp != NULL)
4722 				{
4723 				    /* Remove superfluous '+' and leading
4724 				     * zeroes from the exponent. */
4725 				    if (tp[1] == '+')
4726 				    {
4727 					/* Change "1.0e+07" to "1.0e07" */
4728 					STRMOVE(tp + 1, tp + 2);
4729 					--str_arg_l;
4730 				    }
4731 				    i = (tp[1] == '-') ? 2 : 1;
4732 				    while (tp[i] == '0')
4733 				    {
4734 					/* Change "1.0e07" to "1.0e7" */
4735 					STRMOVE(tp + i, tp + i + 1);
4736 					--str_arg_l;
4737 				    }
4738 				    --tp;
4739 				}
4740 			    }
4741 
4742 			    if (tp != NULL && !precision_specified)
4743 				/* Remove trailing zeroes, but keep the one
4744 				 * just after a dot. */
4745 				while (tp > tmp + 2 && *tp == '0'
4746 							     && tp[-1] != '.')
4747 				{
4748 				    STRMOVE(tp, tp + 1);
4749 				    --tp;
4750 				    --str_arg_l;
4751 				}
4752 			}
4753 			else
4754 			{
4755 			    char *tp;
4756 
4757 			    /* Be consistent: some printf("%e") use 1.0e+12
4758 			     * and some 1.0e+012.  Remove one zero in the last
4759 			     * case. */
4760 			    tp = (char *)vim_strchr((char_u *)tmp,
4761 						 fmt_spec == 'e' ? 'e' : 'E');
4762 			    if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4763 					  && tp[2] == '0'
4764 					  && vim_isdigit(tp[3])
4765 					  && vim_isdigit(tp[4]))
4766 			    {
4767 				STRMOVE(tp + 2, tp + 3);
4768 				--str_arg_l;
4769 			    }
4770 			}
4771 		    }
4772 		    str_arg = tmp;
4773 		    break;
4774 		}
4775 #endif
4776 
4777 	    default:
4778 		/* unrecognized conversion specifier, keep format string
4779 		 * as-is */
4780 		zero_padding = 0;  /* turn zero padding off for non-numeric
4781 				      conversion */
4782 		justify_left = 1;
4783 		min_field_width = 0;		    /* reset flags */
4784 
4785 		/* discard the unrecognized conversion, just keep *
4786 		 * the unrecognized conversion character	  */
4787 		str_arg = p;
4788 		str_arg_l = 0;
4789 		if (*p != NUL)
4790 		    str_arg_l++;  /* include invalid conversion specifier
4791 				     unchanged if not at end-of-string */
4792 		break;
4793 	    }
4794 
4795 	    if (*p != NUL)
4796 		p++;     /* step over the just processed conversion specifier */
4797 
4798 	    /* insert padding to the left as requested by min_field_width;
4799 	     * this does not include the zero padding in case of numerical
4800 	     * conversions*/
4801 	    if (!justify_left)
4802 	    {
4803 		/* left padding with blank or zero */
4804 		int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4805 
4806 		if (pn > 0)
4807 		{
4808 		    if (str_l < str_m)
4809 		    {
4810 			size_t avail = str_m - str_l;
4811 
4812 			vim_memset(str + str_l, zero_padding ? '0' : ' ',
4813 					     (size_t)pn > avail ? avail
4814 								: (size_t)pn);
4815 		    }
4816 		    str_l += pn;
4817 		}
4818 	    }
4819 
4820 	    /* zero padding as requested by the precision or by the minimal
4821 	     * field width for numeric conversions required? */
4822 	    if (number_of_zeros_to_pad == 0)
4823 	    {
4824 		/* will not copy first part of numeric right now, *
4825 		 * force it to be copied later in its entirety    */
4826 		zero_padding_insertion_ind = 0;
4827 	    }
4828 	    else
4829 	    {
4830 		/* insert first part of numerics (sign or '0x') before zero
4831 		 * padding */
4832 		int zn = (int)zero_padding_insertion_ind;
4833 
4834 		if (zn > 0)
4835 		{
4836 		    if (str_l < str_m)
4837 		    {
4838 			size_t avail = str_m - str_l;
4839 
4840 			mch_memmove(str + str_l, str_arg,
4841 					     (size_t)zn > avail ? avail
4842 								: (size_t)zn);
4843 		    }
4844 		    str_l += zn;
4845 		}
4846 
4847 		/* insert zero padding as requested by the precision or min
4848 		 * field width */
4849 		zn = (int)number_of_zeros_to_pad;
4850 		if (zn > 0)
4851 		{
4852 		    if (str_l < str_m)
4853 		    {
4854 			size_t avail = str_m-str_l;
4855 
4856 			vim_memset(str + str_l, '0',
4857 					     (size_t)zn > avail ? avail
4858 								: (size_t)zn);
4859 		    }
4860 		    str_l += zn;
4861 		}
4862 	    }
4863 
4864 	    /* insert formatted string
4865 	     * (or as-is conversion specifier for unknown conversions) */
4866 	    {
4867 		int sn = (int)(str_arg_l - zero_padding_insertion_ind);
4868 
4869 		if (sn > 0)
4870 		{
4871 		    if (str_l < str_m)
4872 		    {
4873 			size_t avail = str_m - str_l;
4874 
4875 			mch_memmove(str + str_l,
4876 				str_arg + zero_padding_insertion_ind,
4877 				(size_t)sn > avail ? avail : (size_t)sn);
4878 		    }
4879 		    str_l += sn;
4880 		}
4881 	    }
4882 
4883 	    /* insert right padding */
4884 	    if (justify_left)
4885 	    {
4886 		/* right blank padding to the field width */
4887 		int pn = (int)(min_field_width
4888 				      - (str_arg_l + number_of_zeros_to_pad));
4889 
4890 		if (pn > 0)
4891 		{
4892 		    if (str_l < str_m)
4893 		    {
4894 			size_t avail = str_m - str_l;
4895 
4896 			vim_memset(str + str_l, ' ',
4897 					     (size_t)pn > avail ? avail
4898 								: (size_t)pn);
4899 		    }
4900 		    str_l += pn;
4901 		}
4902 	    }
4903 	}
4904     }
4905 
4906     if (str_m > 0)
4907     {
4908 	/* make sure the string is nul-terminated even at the expense of
4909 	 * overwriting the last character (shouldn't happen, but just in case)
4910 	 * */
4911 	str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4912     }
4913 
4914 #ifdef HAVE_STDARG_H
4915     if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
4916 	EMSG(_("E767: Too many arguments to printf()"));
4917 #endif
4918 
4919     /* Return the number of characters formatted (excluding trailing nul
4920      * character), that is, the number of characters that would have been
4921      * written to the buffer if it were large enough. */
4922     return (int)str_l;
4923 }
4924 
4925 #endif /* PROTO */
4926