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