Merged from the latest developing branch.
[MacVim.git] / src / message.c
blob66bab9e923a018d7e44c7fb9ffe2ab3d4d927b43
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
11 * message.c: functions for displaying messages on the command line
14 #define MESSAGE_FILE /* don't include prototype for smsg() */
16 #include "vim.h"
18 #if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
19 # include <math.h>
20 #endif
22 static int other_sourcing_name __ARGS((void));
23 static char_u *get_emsg_source __ARGS((void));
24 static char_u *get_emsg_lnum __ARGS((void));
25 static void add_msg_hist __ARGS((char_u *s, int len, int attr));
26 static void hit_return_msg __ARGS((void));
27 static void msg_home_replace_attr __ARGS((char_u *fname, int attr));
28 #ifdef FEAT_MBYTE
29 static char_u *screen_puts_mbyte __ARGS((char_u *s, int l, int attr));
30 #endif
31 static void msg_puts_attr_len __ARGS((char_u *str, int maxlen, int attr));
32 static void msg_puts_display __ARGS((char_u *str, int maxlen, int attr, int recurse));
33 static void msg_scroll_up __ARGS((void));
34 static void inc_msg_scrolled __ARGS((void));
35 static void store_sb_text __ARGS((char_u **sb_str, char_u *s, int attr, int *sb_col, int finish));
36 static void t_puts __ARGS((int *t_col, char_u *t_s, char_u *s, int attr));
37 static void msg_puts_printf __ARGS((char_u *str, int maxlen));
38 static int do_more_prompt __ARGS((int typed_char));
39 static void msg_screen_putchar __ARGS((int c, int attr));
40 static int msg_check_screen __ARGS((void));
41 static void redir_write __ARGS((char_u *s, int maxlen));
42 static void verbose_write __ARGS((char_u *s, int maxlen));
43 #ifdef FEAT_CON_DIALOG
44 static char_u *msg_show_console_dialog __ARGS((char_u *message, char_u *buttons, int dfltbutton));
45 static int confirm_msg_used = FALSE; /* displaying confirm_msg */
46 static char_u *confirm_msg = NULL; /* ":confirm" message */
47 static char_u *confirm_msg_tail; /* tail of confirm_msg */
48 #endif
50 struct msg_hist
52 struct msg_hist *next;
53 char_u *msg;
54 int attr;
57 static struct msg_hist *first_msg_hist = NULL;
58 static struct msg_hist *last_msg_hist = NULL;
59 static int msg_hist_len = 0;
62 * When writing messages to the screen, there are many different situations.
63 * A number of variables is used to remember the current state:
64 * msg_didany TRUE when messages were written since the last time the
65 * user reacted to a prompt.
66 * Reset: After hitting a key for the hit-return prompt,
67 * hitting <CR> for the command line or input().
68 * Set: When any message is written to the screen.
69 * msg_didout TRUE when something was written to the current line.
70 * Reset: When advancing to the next line, when the current
71 * text can be overwritten.
72 * Set: When any message is written to the screen.
73 * msg_nowait No extra delay for the last drawn message.
74 * Used in normal_cmd() before the mode message is drawn.
75 * emsg_on_display There was an error message recently. Indicates that there
76 * should be a delay before redrawing.
77 * msg_scroll The next message should not overwrite the current one.
78 * msg_scrolled How many lines the screen has been scrolled (because of
79 * messages). Used in update_screen() to scroll the screen
80 * back. Incremented each time the screen scrolls a line.
81 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
82 * writes something without scrolling should not make
83 * need_wait_return to be set. This is a hack to make ":ts"
84 * work without an extra prompt.
85 * lines_left Number of lines available for messages before the
86 * more-prompt is to be given.
87 * need_wait_return TRUE when the hit-return prompt is needed.
88 * Reset: After giving the hit-return prompt, when the user
89 * has answered some other prompt.
90 * Set: When the ruler or typeahead display is overwritten,
91 * scrolling the screen for some message.
92 * keep_msg Message to be displayed after redrawing the screen, in
93 * main_loop().
94 * This is an allocated string or NULL when not used.
98 * msg(s) - displays the string 's' on the status line
99 * When terminal not initialized (yet) mch_errmsg(..) is used.
100 * return TRUE if wait_return not called
103 msg(s)
104 char_u *s;
106 return msg_attr_keep(s, 0, FALSE);
109 #if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
110 || defined(PROTO)
112 * Like msg() but keep it silent when 'verbosefile' is set.
115 verb_msg(s)
116 char_u *s;
118 int n;
120 verbose_enter();
121 n = msg_attr_keep(s, 0, FALSE);
122 verbose_leave();
124 return n;
126 #endif
129 msg_attr(s, attr)
130 char_u *s;
131 int attr;
133 return msg_attr_keep(s, attr, FALSE);
137 msg_attr_keep(s, attr, keep)
138 char_u *s;
139 int attr;
140 int keep; /* TRUE: set keep_msg if it doesn't scroll */
142 static int entered = 0;
143 int retval;
144 char_u *buf = NULL;
146 #ifdef FEAT_EVAL
147 if (attr == 0)
148 set_vim_var_string(VV_STATUSMSG, s, -1);
149 #endif
152 * It is possible that displaying a messages causes a problem (e.g.,
153 * when redrawing the window), which causes another message, etc.. To
154 * break this loop, limit the recursiveness to 3 levels.
156 if (entered >= 3)
157 return TRUE;
158 ++entered;
160 /* Add message to history (unless it's a repeated kept message or a
161 * truncated message) */
162 if (s != keep_msg
163 || (*s != '<'
164 && last_msg_hist != NULL
165 && last_msg_hist->msg != NULL
166 && STRCMP(s, last_msg_hist->msg)))
167 add_msg_hist(s, -1, attr);
169 /* When displaying keep_msg, don't let msg_start() free it, caller must do
170 * that. */
171 if (s == keep_msg)
172 keep_msg = NULL;
174 /* Truncate the message if needed. */
175 msg_start();
176 buf = msg_strtrunc(s, FALSE);
177 if (buf != NULL)
178 s = buf;
180 msg_outtrans_attr(s, attr);
181 msg_clr_eos();
182 retval = msg_end();
184 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
185 * Columns + sc_col)
186 set_keep_msg(s, 0);
188 vim_free(buf);
189 --entered;
190 return retval;
194 * Truncate a string such that it can be printed without causing a scroll.
195 * Returns an allocated string or NULL when no truncating is done.
197 char_u *
198 msg_strtrunc(s, force)
199 char_u *s;
200 int force; /* always truncate */
202 char_u *buf = NULL;
203 int len;
204 int room;
206 /* May truncate message to avoid a hit-return prompt */
207 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
208 && !exmode_active && msg_silent == 0) || force)
210 len = vim_strsize(s);
211 if (msg_scrolled != 0)
212 /* Use all the columns. */
213 room = (int)(Rows - msg_row) * Columns - 1;
214 else
215 /* Use up to 'showcmd' column. */
216 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
217 if (len > room && room > 0)
219 #ifdef FEAT_MBYTE
220 if (enc_utf8)
221 /* may have up to 18 bytes per cell (6 per char, up to two
222 * composing chars) */
223 buf = alloc((room + 2) * 18);
224 else if (enc_dbcs == DBCS_JPNU)
225 /* may have up to 2 bytes per cell for euc-jp */
226 buf = alloc((room + 2) * 2);
227 else
228 #endif
229 buf = alloc(room + 2);
230 if (buf != NULL)
231 trunc_string(s, buf, room);
234 return buf;
238 * Truncate a string "s" to "buf" with cell width "room".
239 * "s" and "buf" may be equal.
241 void
242 trunc_string(s, buf, room)
243 char_u *s;
244 char_u *buf;
245 int room;
247 int half;
248 int len;
249 int e;
250 int i;
251 int n;
253 room -= 3;
254 half = room / 2;
255 len = 0;
257 /* First part: Start of the string. */
258 for (e = 0; len < half; ++e)
260 if (s[e] == NUL)
262 /* text fits without truncating! */
263 buf[e] = NUL;
264 return;
266 n = ptr2cells(s + e);
267 if (len + n >= half)
268 break;
269 len += n;
270 buf[e] = s[e];
271 #ifdef FEAT_MBYTE
272 if (has_mbyte)
273 for (n = (*mb_ptr2len)(s + e); --n > 0; )
275 ++e;
276 buf[e] = s[e];
278 #endif
281 /* Last part: End of the string. */
282 i = e;
283 #ifdef FEAT_MBYTE
284 if (enc_dbcs != 0)
286 /* For DBCS going backwards in a string is slow, but
287 * computing the cell width isn't too slow: go forward
288 * until the rest fits. */
289 n = vim_strsize(s + i);
290 while (len + n > room)
292 n -= ptr2cells(s + i);
293 i += (*mb_ptr2len)(s + i);
296 else if (enc_utf8)
298 /* For UTF-8 we can go backwards easily. */
299 half = i = (int)STRLEN(s);
300 for (;;)
303 half = half - (*mb_head_off)(s, s + half - 1) - 1;
304 while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
305 n = ptr2cells(s + half);
306 if (len + n > room)
307 break;
308 len += n;
309 i = half;
312 else
313 #endif
315 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
316 len += n;
319 /* Set the middle and copy the last part. */
320 mch_memmove(buf + e, "...", (size_t)3);
321 STRMOVE(buf + e + 3, s + i);
325 * Automatic prototype generation does not understand this function.
326 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
327 * shorter than IOSIZE!!!
329 #ifndef PROTO
330 # ifndef HAVE_STDARG_H
333 #ifdef __BORLANDC__
334 _RTLENTRYF
335 #endif
336 smsg __ARGS((char_u *, long, long, long,
337 long, long, long, long, long, long, long));
339 #ifdef __BORLANDC__
340 _RTLENTRYF
341 #endif
342 smsg_attr __ARGS((int, char_u *, long, long, long,
343 long, long, long, long, long, long, long));
345 int vim_snprintf __ARGS((char *, size_t, char *, long, long, long,
346 long, long, long, long, long, long, long));
349 * smsg(str, arg, ...) is like using sprintf(buf, str, arg, ...) and then
350 * calling msg(buf).
351 * The buffer used is IObuff, the message is truncated at IOSIZE.
354 /* VARARGS */
356 #ifdef __BORLANDC__
357 _RTLENTRYF
358 #endif
359 smsg(s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
360 char_u *s;
361 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
363 return smsg_attr(0, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
366 /* VARARGS */
368 #ifdef __BORLANDC__
369 _RTLENTRYF
370 #endif
371 smsg_attr(attr, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
372 int attr;
373 char_u *s;
374 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
376 vim_snprintf((char *)IObuff, IOSIZE, (char *)s,
377 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
378 return msg_attr(IObuff, attr);
381 # else /* HAVE_STDARG_H */
383 int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
386 #ifdef __BORLANDC__
387 _RTLENTRYF
388 #endif
389 smsg(char_u *s, ...)
391 va_list arglist;
393 va_start(arglist, s);
394 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
395 va_end(arglist);
396 return msg(IObuff);
400 #ifdef __BORLANDC__
401 _RTLENTRYF
402 #endif
403 smsg_attr(int attr, char_u *s, ...)
405 va_list arglist;
407 va_start(arglist, s);
408 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
409 va_end(arglist);
410 return msg_attr(IObuff, attr);
413 # endif /* HAVE_STDARG_H */
414 #endif
417 * Remember the last sourcing name/lnum used in an error message, so that it
418 * isn't printed each time when it didn't change.
420 static int last_sourcing_lnum = 0;
421 static char_u *last_sourcing_name = NULL;
424 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
425 * for the next error message;
427 void
428 reset_last_sourcing()
430 vim_free(last_sourcing_name);
431 last_sourcing_name = NULL;
432 last_sourcing_lnum = 0;
436 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
438 static int
439 other_sourcing_name()
441 if (sourcing_name != NULL)
443 if (last_sourcing_name != NULL)
444 return STRCMP(sourcing_name, last_sourcing_name) != 0;
445 return TRUE;
447 return FALSE;
451 * Get the message about the source, as used for an error message.
452 * Returns an allocated string with room for one more character.
453 * Returns NULL when no message is to be given.
455 static char_u *
456 get_emsg_source()
458 char_u *Buf, *p;
460 if (sourcing_name != NULL && other_sourcing_name())
462 p = (char_u *)_("Error detected while processing %s:");
463 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
464 if (Buf != NULL)
465 sprintf((char *)Buf, (char *)p, sourcing_name);
466 return Buf;
468 return NULL;
472 * Get the message about the source lnum, as used for an error message.
473 * Returns an allocated string with room for one more character.
474 * Returns NULL when no message is to be given.
476 static char_u *
477 get_emsg_lnum()
479 char_u *Buf, *p;
481 /* lnum is 0 when executing a command from the command line
482 * argument, we don't want a line number then */
483 if (sourcing_name != NULL
484 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
485 && sourcing_lnum != 0)
487 p = (char_u *)_("line %4ld:");
488 Buf = alloc((unsigned)(STRLEN(p) + 20));
489 if (Buf != NULL)
490 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
491 return Buf;
493 return NULL;
497 * Display name and line number for the source of an error.
498 * Remember the file name and line number, so that for the next error the info
499 * is only displayed if it changed.
501 void
502 msg_source(attr)
503 int attr;
505 char_u *p;
507 ++no_wait_return;
508 p = get_emsg_source();
509 if (p != NULL)
511 msg_attr(p, attr);
512 vim_free(p);
514 p = get_emsg_lnum();
515 if (p != NULL)
517 msg_attr(p, hl_attr(HLF_N));
518 vim_free(p);
519 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
522 /* remember the last sourcing name printed, also when it's empty */
523 if (sourcing_name == NULL || other_sourcing_name())
525 vim_free(last_sourcing_name);
526 if (sourcing_name == NULL)
527 last_sourcing_name = NULL;
528 else
529 last_sourcing_name = vim_strsave(sourcing_name);
531 --no_wait_return;
535 * Return TRUE if not giving error messages right now:
536 * If "emsg_off" is set: no error messages at the moment.
537 * If "msg" is in 'debug': do error message but without side effects.
538 * If "emsg_skip" is set: never do error messages.
541 emsg_not_now()
543 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
544 && vim_strchr(p_debug, 't') == NULL)
545 #ifdef FEAT_EVAL
546 || emsg_skip > 0
547 #endif
549 return TRUE;
550 return FALSE;
554 * emsg() - display an error message
556 * Rings the bell, if appropriate, and calls message() to do the real work
557 * When terminal not initialized (yet) mch_errmsg(..) is used.
559 * return TRUE if wait_return not called
562 emsg(s)
563 char_u *s;
565 int attr;
566 char_u *p;
567 #ifdef FEAT_EVAL
568 int ignore = FALSE;
569 int severe;
570 #endif
572 called_emsg = TRUE;
573 ex_exitval = 1;
576 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
577 * prefer this message over previous messages for the same command.
579 #ifdef FEAT_EVAL
580 severe = emsg_severe;
581 emsg_severe = FALSE;
582 #endif
584 /* Skip this if not giving error messages at the moment. */
585 if (emsg_not_now())
586 return TRUE;
588 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
590 #ifdef FEAT_EVAL
592 * Cause a throw of an error exception if appropriate. Don't display
593 * the error message in this case. (If no matching catch clause will
594 * be found, the message will be displayed later on.) "ignore" is set
595 * when the message should be ignored completely (used for the
596 * interrupt message).
598 if (cause_errthrow(s, severe, &ignore) == TRUE)
600 if (!ignore)
601 did_emsg = TRUE;
602 return TRUE;
605 /* set "v:errmsg", also when using ":silent! cmd" */
606 set_vim_var_string(VV_ERRMSG, s, -1);
607 #endif
610 * When using ":silent! cmd" ignore error messages.
611 * But do write it to the redirection file.
613 if (emsg_silent != 0)
615 msg_start();
616 p = get_emsg_source();
617 if (p != NULL)
619 STRCAT(p, "\n");
620 redir_write(p, -1);
621 vim_free(p);
623 p = get_emsg_lnum();
624 if (p != NULL)
626 STRCAT(p, "\n");
627 redir_write(p, -1);
628 vim_free(p);
630 redir_write(s, -1);
631 return TRUE;
634 /* Reset msg_silent, an error causes messages to be switched back on. */
635 msg_silent = 0;
636 cmd_silent = FALSE;
638 if (global_busy) /* break :global command */
639 ++global_busy;
641 if (p_eb)
642 beep_flush(); /* also includes flush_buffers() */
643 else
644 flush_buffers(FALSE); /* flush internal buffers */
645 did_emsg = TRUE; /* flag for DoOneCmd() */
648 emsg_on_display = TRUE; /* remember there is an error message */
649 ++msg_scroll; /* don't overwrite a previous message */
650 attr = hl_attr(HLF_E); /* set highlight mode for error messages */
651 if (msg_scrolled != 0)
652 need_wait_return = TRUE; /* needed in case emsg() is called after
653 * wait_return has reset need_wait_return
654 * and a redraw is expected because
655 * msg_scrolled is non-zero */
658 * Display name and line number for the source of the error.
660 msg_source(attr);
663 * Display the error message itself.
665 msg_nowait = FALSE; /* wait for this msg */
666 return msg_attr(s, attr);
670 * Print an error message with one "%s" and one string argument.
673 emsg2(s, a1)
674 char_u *s, *a1;
676 return emsg3(s, a1, NULL);
679 /* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
681 void
682 emsg_invreg(name)
683 int name;
685 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
689 * Like msg(), but truncate to a single line if p_shm contains 't', or when
690 * "force" is TRUE. This truncates in another way as for normal messages.
691 * Careful: The string may be changed by msg_may_trunc()!
692 * Returns a pointer to the printed message, if wait_return() not called.
694 char_u *
695 msg_trunc_attr(s, force, attr)
696 char_u *s;
697 int force;
698 int attr;
700 int n;
702 /* Add message to history before truncating */
703 add_msg_hist(s, -1, attr);
705 s = msg_may_trunc(force, s);
707 msg_hist_off = TRUE;
708 n = msg_attr(s, attr);
709 msg_hist_off = FALSE;
711 if (n)
712 return s;
713 return NULL;
717 * Check if message "s" should be truncated at the start (for filenames).
718 * Return a pointer to where the truncated message starts.
719 * Note: May change the message by replacing a character with '<'.
721 char_u *
722 msg_may_trunc(force, s)
723 int force;
724 char_u *s;
726 int n;
727 int room;
729 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
730 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
731 && (n = (int)STRLEN(s) - room) > 0)
733 #ifdef FEAT_MBYTE
734 if (has_mbyte)
736 int size = vim_strsize(s);
738 /* There may be room anyway when there are multibyte chars. */
739 if (size <= room)
740 return s;
742 for (n = 0; size >= room; )
744 size -= (*mb_ptr2cells)(s + n);
745 n += (*mb_ptr2len)(s + n);
747 --n;
749 #endif
750 s += n;
751 *s = '<';
753 return s;
756 static void
757 add_msg_hist(s, len, attr)
758 char_u *s;
759 int len; /* -1 for undetermined length */
760 int attr;
762 struct msg_hist *p;
764 if (msg_hist_off || msg_silent != 0)
765 return;
767 /* Don't let the message history get too big */
768 while (msg_hist_len > MAX_MSG_HIST_LEN)
769 (void)delete_first_msg();
771 /* allocate an entry and add the message at the end of the history */
772 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
773 if (p != NULL)
775 if (len < 0)
776 len = (int)STRLEN(s);
777 /* remove leading and trailing newlines */
778 while (len > 0 && *s == '\n')
780 ++s;
781 --len;
783 while (len > 0 && s[len - 1] == '\n')
784 --len;
785 p->msg = vim_strnsave(s, len);
786 p->next = NULL;
787 p->attr = attr;
788 if (last_msg_hist != NULL)
789 last_msg_hist->next = p;
790 last_msg_hist = p;
791 if (first_msg_hist == NULL)
792 first_msg_hist = last_msg_hist;
793 ++msg_hist_len;
798 * Delete the first (oldest) message from the history.
799 * Returns FAIL if there are no messages.
802 delete_first_msg()
804 struct msg_hist *p;
806 if (msg_hist_len <= 0)
807 return FAIL;
808 p = first_msg_hist;
809 first_msg_hist = p->next;
810 if (first_msg_hist == NULL)
811 last_msg_hist = NULL; /* history is empty */
812 vim_free(p->msg);
813 vim_free(p);
814 --msg_hist_len;
815 return OK;
819 * ":messages" command.
821 /*ARGSUSED*/
822 void
823 ex_messages(eap)
824 exarg_T *eap;
826 struct msg_hist *p;
827 char_u *s;
829 msg_hist_off = TRUE;
831 s = mch_getenv((char_u *)"LANG");
832 if (s != NULL && *s != NUL)
833 msg_attr((char_u *)
834 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
835 hl_attr(HLF_T));
837 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
838 if (p->msg != NULL)
839 msg_attr(p->msg, p->attr);
841 msg_hist_off = FALSE;
844 #if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
846 * Call this after prompting the user. This will avoid a hit-return message
847 * and a delay.
849 void
850 msg_end_prompt()
852 need_wait_return = FALSE;
853 emsg_on_display = FALSE;
854 cmdline_row = msg_row;
855 msg_col = 0;
856 msg_clr_eos();
858 #endif
861 * wait for the user to hit a key (normally a return)
862 * if 'redraw' is TRUE, clear and redraw the screen
863 * if 'redraw' is FALSE, just redraw the screen
864 * if 'redraw' is -1, don't redraw at all
866 void
867 wait_return(redraw)
868 int redraw;
870 int c;
871 int oldState;
872 int tmpState;
873 int had_got_int;
875 if (redraw == TRUE)
876 must_redraw = CLEAR;
878 /* If using ":silent cmd", don't wait for a return. Also don't set
879 * need_wait_return to do it later. */
880 if (msg_silent != 0)
881 return;
884 * With the global command (and some others) we only need one return at the
885 * end. Adjust cmdline_row to avoid the next message overwriting the last one.
886 * When inside vgetc(), we can't wait for a typed character at all.
888 if (vgetc_busy > 0)
889 return;
890 if (no_wait_return)
892 need_wait_return = TRUE;
893 if (!exmode_active)
894 cmdline_row = msg_row;
895 return;
898 redir_off = TRUE; /* don't redirect this message */
899 oldState = State;
900 if (quit_more)
902 c = CAR; /* just pretend CR was hit */
903 quit_more = FALSE;
904 got_int = FALSE;
906 else if (exmode_active)
908 MSG_PUTS(" "); /* make sure the cursor is on the right line */
909 c = CAR; /* no need for a return in ex mode */
910 got_int = FALSE;
912 else
914 /* Make sure the hit-return prompt is on screen when 'guioptions' was
915 * just changed. */
916 screenalloc(FALSE);
918 State = HITRETURN;
919 #ifdef FEAT_MOUSE
920 setmouse();
921 #endif
922 #ifdef USE_ON_FLY_SCROLL
923 dont_scroll = TRUE; /* disallow scrolling here */
924 #endif
925 hit_return_msg();
929 /* Remember "got_int", if it is set vgetc() probably returns a
930 * CTRL-C, but we need to loop then. */
931 had_got_int = got_int;
933 /* Don't do mappings here, we put the character back in the
934 * typeahead buffer. */
935 ++no_mapping;
936 ++allow_keys;
937 c = safe_vgetc();
938 if (had_got_int && !global_busy)
939 got_int = FALSE;
940 --no_mapping;
941 --allow_keys;
943 #ifdef FEAT_CLIPBOARD
944 /* Strange way to allow copying (yanking) a modeless selection at
945 * the hit-enter prompt. Use CTRL-Y, because the same is used in
946 * Cmdline-mode and it's harmless when there is no selection. */
947 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
949 clip_copy_modeless_selection(TRUE);
950 c = K_IGNORE;
952 #endif
955 * Allow scrolling back in the messages.
956 * Also accept scroll-down commands when messages fill the screen,
957 * to avoid that typing one 'j' too many makes the messages
958 * disappear.
960 if (p_more && !p_cp)
962 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
964 /* scroll back to show older messages */
965 do_more_prompt(c);
966 if (quit_more)
968 c = CAR; /* just pretend CR was hit */
969 quit_more = FALSE;
970 got_int = FALSE;
972 else
974 c = K_IGNORE;
975 hit_return_msg();
978 else if (msg_scrolled > Rows - 2
979 && (c == 'j' || c == K_DOWN || c == 'd' || c == 'f'))
980 c = K_IGNORE;
982 } while ((had_got_int && c == Ctrl_C)
983 || c == K_IGNORE
984 #ifdef FEAT_GUI
985 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
986 #endif
987 #ifdef FEAT_MOUSE
988 || c == K_LEFTDRAG || c == K_LEFTRELEASE
989 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
990 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
991 || c == K_MOUSEDOWN || c == K_MOUSEUP
992 || (!mouse_has(MOUSE_RETURN)
993 && mouse_row < msg_row
994 && (c == K_LEFTMOUSE
995 || c == K_MIDDLEMOUSE
996 || c == K_RIGHTMOUSE
997 || c == K_X1MOUSE
998 || c == K_X2MOUSE))
999 #endif
1001 ui_breakcheck();
1002 #ifdef FEAT_MOUSE
1004 * Avoid that the mouse-up event causes visual mode to start.
1006 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1007 || c == K_X1MOUSE || c == K_X2MOUSE)
1008 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1009 else
1010 #endif
1011 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1013 /* Put the character back in the typeahead buffer. Don't use the
1014 * stuff buffer, because lmaps wouldn't work. */
1015 ins_char_typebuf(c);
1016 do_redraw = TRUE; /* need a redraw even though there is
1017 typeahead */
1020 redir_off = FALSE;
1023 * If the user hits ':', '?' or '/' we get a command line from the next
1024 * line.
1026 if (c == ':' || c == '?' || c == '/')
1028 if (!exmode_active)
1029 cmdline_row = msg_row;
1030 skip_redraw = TRUE; /* skip redraw once */
1031 do_redraw = FALSE;
1035 * If the window size changed set_shellsize() will redraw the screen.
1036 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1037 * typed.
1039 tmpState = State;
1040 State = oldState; /* restore State before set_shellsize */
1041 #ifdef FEAT_MOUSE
1042 setmouse();
1043 #endif
1044 msg_check();
1046 #if defined(UNIX) || defined(VMS)
1048 * When switching screens, we need to output an extra newline on exit.
1050 if (swapping_screen() && !termcap_active)
1051 newline_on_exit = TRUE;
1052 #endif
1054 need_wait_return = FALSE;
1055 did_wait_return = TRUE;
1056 emsg_on_display = FALSE; /* can delete error message now */
1057 lines_left = -1; /* reset lines_left at next msg_start() */
1058 reset_last_sourcing();
1059 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1060 (Rows - cmdline_row - 1) * Columns + sc_col)
1062 vim_free(keep_msg);
1063 keep_msg = NULL; /* don't redisplay message, it's too long */
1066 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1068 starttermcap(); /* start termcap before redrawing */
1069 shell_resized();
1071 else if (!skip_redraw
1072 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1074 starttermcap(); /* start termcap before redrawing */
1075 redraw_later(VALID);
1080 * Write the hit-return prompt.
1082 static void
1083 hit_return_msg()
1085 int save_p_more = p_more;
1087 p_more = FALSE; /* don't want see this message when scrolling back */
1088 if (msg_didout) /* start on a new line */
1089 msg_putchar('\n');
1090 if (got_int)
1091 MSG_PUTS(_("Interrupt: "));
1093 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
1094 if (!msg_use_printf())
1095 msg_clr_eos();
1096 p_more = save_p_more;
1100 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1102 void
1103 set_keep_msg(s, attr)
1104 char_u *s;
1105 int attr;
1107 vim_free(keep_msg);
1108 if (s != NULL && msg_silent == 0)
1109 keep_msg = vim_strsave(s);
1110 else
1111 keep_msg = NULL;
1112 keep_msg_more = FALSE;
1113 keep_msg_attr = attr;
1116 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1118 * If there currently is a message being displayed, set "keep_msg" to it, so
1119 * that it will be displayed again after redraw.
1121 void
1122 set_keep_msg_from_hist()
1124 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1125 && (State & NORMAL))
1126 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1128 #endif
1131 * Prepare for outputting characters in the command line.
1133 void
1134 msg_start()
1136 int did_return = FALSE;
1138 vim_free(keep_msg);
1139 keep_msg = NULL; /* don't display old message now */
1141 #ifdef FEAT_EVAL
1142 if (need_clr_eos)
1144 /* Halfway an ":echo" command and getting an (error) message: clear
1145 * any text from the command. */
1146 need_clr_eos = FALSE;
1147 msg_clr_eos();
1149 #endif
1151 if (!msg_scroll && full_screen) /* overwrite last message */
1153 msg_row = cmdline_row;
1154 msg_col =
1155 #ifdef FEAT_RIGHTLEFT
1156 cmdmsg_rl ? Columns - 1 :
1157 #endif
1160 else if (msg_didout) /* start message on next line */
1162 msg_putchar('\n');
1163 did_return = TRUE;
1164 if (exmode_active != EXMODE_NORMAL)
1165 cmdline_row = msg_row;
1167 if (!msg_didany || lines_left < 0)
1168 msg_starthere();
1169 if (msg_silent == 0)
1171 msg_didout = FALSE; /* no output on current line yet */
1172 cursor_off();
1175 /* when redirecting, may need to start a new line. */
1176 if (!did_return)
1177 redir_write((char_u *)"\n", -1);
1181 * Note that the current msg position is where messages start.
1183 void
1184 msg_starthere()
1186 lines_left = cmdline_row;
1187 msg_didany = FALSE;
1190 void
1191 msg_putchar(c)
1192 int c;
1194 msg_putchar_attr(c, 0);
1197 void
1198 msg_putchar_attr(c, attr)
1199 int c;
1200 int attr;
1202 #ifdef FEAT_MBYTE
1203 char_u buf[MB_MAXBYTES + 1];
1204 #else
1205 char_u buf[4];
1206 #endif
1208 if (IS_SPECIAL(c))
1210 buf[0] = K_SPECIAL;
1211 buf[1] = K_SECOND(c);
1212 buf[2] = K_THIRD(c);
1213 buf[3] = NUL;
1215 else
1217 #ifdef FEAT_MBYTE
1218 buf[(*mb_char2bytes)(c, buf)] = NUL;
1219 #else
1220 buf[0] = c;
1221 buf[1] = NUL;
1222 #endif
1224 msg_puts_attr(buf, attr);
1227 void
1228 msg_outnum(n)
1229 long n;
1231 char_u buf[20];
1233 sprintf((char *)buf, "%ld", n);
1234 msg_puts(buf);
1237 void
1238 msg_home_replace(fname)
1239 char_u *fname;
1241 msg_home_replace_attr(fname, 0);
1244 #if defined(FEAT_FIND_ID) || defined(PROTO)
1245 void
1246 msg_home_replace_hl(fname)
1247 char_u *fname;
1249 msg_home_replace_attr(fname, hl_attr(HLF_D));
1251 #endif
1253 static void
1254 msg_home_replace_attr(fname, attr)
1255 char_u *fname;
1256 int attr;
1258 char_u *name;
1260 name = home_replace_save(NULL, fname);
1261 if (name != NULL)
1262 msg_outtrans_attr(name, attr);
1263 vim_free(name);
1267 * Output 'len' characters in 'str' (including NULs) with translation
1268 * if 'len' is -1, output upto a NUL character.
1269 * Use attributes 'attr'.
1270 * Return the number of characters it takes on the screen.
1273 msg_outtrans(str)
1274 char_u *str;
1276 return msg_outtrans_attr(str, 0);
1280 msg_outtrans_attr(str, attr)
1281 char_u *str;
1282 int attr;
1284 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1288 msg_outtrans_len(str, len)
1289 char_u *str;
1290 int len;
1292 return msg_outtrans_len_attr(str, len, 0);
1296 * Output one character at "p". Return pointer to the next character.
1297 * Handles multi-byte characters.
1299 char_u *
1300 msg_outtrans_one(p, attr)
1301 char_u *p;
1302 int attr;
1304 #ifdef FEAT_MBYTE
1305 int l;
1307 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1309 msg_outtrans_len_attr(p, l, attr);
1310 return p + l;
1312 #endif
1313 msg_puts_attr(transchar_byte(*p), attr);
1314 return p + 1;
1318 msg_outtrans_len_attr(msgstr, len, attr)
1319 char_u *msgstr;
1320 int len;
1321 int attr;
1323 int retval = 0;
1324 char_u *str = msgstr;
1325 char_u *plain_start = msgstr;
1326 char_u *s;
1327 #ifdef FEAT_MBYTE
1328 int mb_l;
1329 int c;
1330 #endif
1332 /* if MSG_HIST flag set, add message to history */
1333 if (attr & MSG_HIST)
1335 add_msg_hist(str, len, attr);
1336 attr &= ~MSG_HIST;
1339 #ifdef FEAT_MBYTE
1340 /* If the string starts with a composing character first draw a space on
1341 * which the composing char can be drawn. */
1342 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1343 msg_puts_attr((char_u *)" ", attr);
1344 #endif
1347 * Go over the string. Special characters are translated and printed.
1348 * Normal characters are printed several at a time.
1350 while (--len >= 0)
1352 #ifdef FEAT_MBYTE
1353 if (enc_utf8)
1354 /* Don't include composing chars after the end. */
1355 mb_l = utfc_ptr2len_len(str, len + 1);
1356 else if (has_mbyte)
1357 mb_l = (*mb_ptr2len)(str);
1358 else
1359 mb_l = 1;
1360 if (has_mbyte && mb_l > 1)
1362 c = (*mb_ptr2char)(str);
1363 if (vim_isprintc(c))
1364 /* printable multi-byte char: count the cells. */
1365 retval += (*mb_ptr2cells)(str);
1366 else
1368 /* unprintable multi-byte char: print the printable chars so
1369 * far and the translation of the unprintable char. */
1370 if (str > plain_start)
1371 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1372 attr);
1373 plain_start = str + mb_l;
1374 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1375 retval += char2cells(c);
1377 len -= mb_l - 1;
1378 str += mb_l;
1380 else
1381 #endif
1383 s = transchar_byte(*str);
1384 if (s[1] != NUL)
1386 /* unprintable char: print the printable chars so far and the
1387 * translation of the unprintable char. */
1388 if (str > plain_start)
1389 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1390 attr);
1391 plain_start = str + 1;
1392 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
1393 retval += (int)STRLEN(s);
1395 else
1396 ++retval;
1397 ++str;
1401 if (str > plain_start)
1402 /* print the printable chars at the end */
1403 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1405 return retval;
1408 #if defined(FEAT_QUICKFIX) || defined(PROTO)
1409 void
1410 msg_make(arg)
1411 char_u *arg;
1413 int i;
1414 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1416 arg = skipwhite(arg);
1417 for (i = 5; *arg && i >= 0; --i)
1418 if (*arg++ != str[i])
1419 break;
1420 if (i < 0)
1422 msg_putchar('\n');
1423 for (i = 0; rs[i]; ++i)
1424 msg_putchar(rs[i] - 3);
1427 #endif
1430 * Output the string 'str' upto a NUL character.
1431 * Return the number of characters it takes on the screen.
1433 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1434 * following character and shown as <F1>, <S-Up> etc. Any other character
1435 * which is not printable shown in <> form.
1436 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1437 * If a character is displayed in one of these special ways, is also
1438 * highlighted (its highlight name is '8' in the p_hl variable).
1439 * Otherwise characters are not highlighted.
1440 * This function is used to show mappings, where we want to see how to type
1441 * the character/string -- webb
1444 msg_outtrans_special(strstart, from)
1445 char_u *strstart;
1446 int from; /* TRUE for lhs of a mapping */
1448 char_u *str = strstart;
1449 int retval = 0;
1450 char_u *string;
1451 int attr;
1452 int len;
1454 attr = hl_attr(HLF_8);
1455 while (*str != NUL)
1457 /* Leading and trailing spaces need to be displayed in <> form. */
1458 if ((str == strstart || str[1] == NUL) && *str == ' ')
1460 string = (char_u *)"<Space>";
1461 ++str;
1463 else
1464 string = str2special(&str, from);
1465 len = vim_strsize(string);
1466 /* Highlight special keys */
1467 msg_puts_attr(string, len > 1
1468 #ifdef FEAT_MBYTE
1469 && (*mb_ptr2len)(string) <= 1
1470 #endif
1471 ? attr : 0);
1472 retval += len;
1474 return retval;
1478 * Return the printable string for the key codes at "*sp".
1479 * Used for translating the lhs or rhs of a mapping to printable chars.
1480 * Advances "sp" to the next code.
1482 char_u *
1483 str2special(sp, from)
1484 char_u **sp;
1485 int from; /* TRUE for lhs of mapping */
1487 int c;
1488 static char_u buf[7];
1489 char_u *str = *sp;
1490 int modifiers = 0;
1491 int special = FALSE;
1493 #ifdef FEAT_MBYTE
1494 if (has_mbyte)
1496 char_u *p;
1498 /* Try to un-escape a multi-byte character. Return the un-escaped
1499 * string if it is a multi-byte character. */
1500 p = mb_unescape(sp);
1501 if (p != NULL)
1502 return p;
1504 #endif
1506 c = *str;
1507 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1509 if (str[1] == KS_MODIFIER)
1511 modifiers = str[2];
1512 str += 3;
1513 c = *str;
1515 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1517 c = TO_SPECIAL(str[1], str[2]);
1518 str += 2;
1519 if (c == K_ZERO) /* display <Nul> as ^@ */
1520 c = NUL;
1522 if (IS_SPECIAL(c) || modifiers) /* special key */
1523 special = TRUE;
1525 *sp = str + 1;
1527 #ifdef FEAT_MBYTE
1528 /* For multi-byte characters check for an illegal byte. */
1529 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
1531 transchar_nonprint(buf, c);
1532 return buf;
1534 #endif
1536 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1537 * Use <Space> only for lhs of a mapping. */
1538 if (special || char2cells(c) > 1 || (from && c == ' '))
1539 return get_special_key_name(c, modifiers);
1540 buf[0] = c;
1541 buf[1] = NUL;
1542 return buf;
1546 * Translate a key sequence into special key names.
1548 void
1549 str2specialbuf(sp, buf, len)
1550 char_u *sp;
1551 char_u *buf;
1552 int len;
1554 char_u *s;
1556 *buf = NUL;
1557 while (*sp)
1559 s = str2special(&sp, FALSE);
1560 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1561 STRCAT(buf, s);
1566 * print line for :print or :list command
1568 void
1569 msg_prt_line(s, list)
1570 char_u *s;
1571 int list;
1573 int c;
1574 int col = 0;
1575 int n_extra = 0;
1576 int c_extra = 0;
1577 char_u *p_extra = NULL; /* init to make SASC shut up */
1578 int n;
1579 int attr = 0;
1580 char_u *trail = NULL;
1581 #ifdef FEAT_MBYTE
1582 int l;
1583 char_u buf[MB_MAXBYTES + 1];
1584 #endif
1586 if (curwin->w_p_list)
1587 list = TRUE;
1589 /* find start of trailing whitespace */
1590 if (list && lcs_trail)
1592 trail = s + STRLEN(s);
1593 while (trail > s && vim_iswhite(trail[-1]))
1594 --trail;
1597 /* output a space for an empty line, otherwise the line will be
1598 * overwritten */
1599 if (*s == NUL && !(list && lcs_eol != NUL))
1600 msg_putchar(' ');
1602 while (!got_int)
1604 if (n_extra > 0)
1606 --n_extra;
1607 if (c_extra)
1608 c = c_extra;
1609 else
1610 c = *p_extra++;
1612 #ifdef FEAT_MBYTE
1613 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
1615 col += (*mb_ptr2cells)(s);
1616 mch_memmove(buf, s, (size_t)l);
1617 buf[l] = NUL;
1618 msg_puts(buf);
1619 s += l;
1620 continue;
1622 #endif
1623 else
1625 attr = 0;
1626 c = *s++;
1627 if (c == TAB && (!list || lcs_tab1))
1629 /* tab amount depends on current column */
1630 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
1631 if (!list)
1633 c = ' ';
1634 c_extra = ' ';
1636 else
1638 c = lcs_tab1;
1639 c_extra = lcs_tab2;
1640 attr = hl_attr(HLF_8);
1643 else if (c == NUL && list && lcs_eol != NUL)
1645 p_extra = (char_u *)"";
1646 c_extra = NUL;
1647 n_extra = 1;
1648 c = lcs_eol;
1649 attr = hl_attr(HLF_AT);
1650 --s;
1652 else if (c != NUL && (n = byte2cells(c)) > 1)
1654 n_extra = n - 1;
1655 p_extra = transchar_byte(c);
1656 c_extra = NUL;
1657 c = *p_extra++;
1658 /* Use special coloring to be able to distinguish <hex> from
1659 * the same in plain text. */
1660 attr = hl_attr(HLF_8);
1662 else if (c == ' ' && trail != NULL && s > trail)
1664 c = lcs_trail;
1665 attr = hl_attr(HLF_8);
1669 if (c == NUL)
1670 break;
1672 msg_putchar_attr(c, attr);
1673 col++;
1675 msg_clr_eos();
1678 #ifdef FEAT_MBYTE
1680 * Use screen_puts() to output one multi-byte character.
1681 * Return the pointer "s" advanced to the next character.
1683 static char_u *
1684 screen_puts_mbyte(s, l, attr)
1685 char_u *s;
1686 int l;
1687 int attr;
1689 int cw;
1691 msg_didout = TRUE; /* remember that line is not empty */
1692 cw = (*mb_ptr2cells)(s);
1693 if (cw > 1 && (
1694 #ifdef FEAT_RIGHTLEFT
1695 cmdmsg_rl ? msg_col <= 1 :
1696 #endif
1697 msg_col == Columns - 1))
1699 /* Doesn't fit, print a highlighted '>' to fill it up. */
1700 msg_screen_putchar('>', hl_attr(HLF_AT));
1701 return s;
1704 screen_puts_len(s, l, msg_row, msg_col, attr);
1705 #ifdef FEAT_RIGHTLEFT
1706 if (cmdmsg_rl)
1708 msg_col -= cw;
1709 if (msg_col == 0)
1711 msg_col = Columns;
1712 ++msg_row;
1715 else
1716 #endif
1718 msg_col += cw;
1719 if (msg_col >= Columns)
1721 msg_col = 0;
1722 ++msg_row;
1725 return s + l;
1727 #endif
1730 * Output a string to the screen at position msg_row, msg_col.
1731 * Update msg_row and msg_col for the next message.
1733 void
1734 msg_puts(s)
1735 char_u *s;
1737 msg_puts_attr(s, 0);
1740 void
1741 msg_puts_title(s)
1742 char_u *s;
1744 msg_puts_attr(s, hl_attr(HLF_T));
1748 * Show a message in such a way that it always fits in the line. Cut out a
1749 * part in the middle and replace it with "..." when necessary.
1750 * Does not handle multi-byte characters!
1752 void
1753 msg_puts_long_attr(longstr, attr)
1754 char_u *longstr;
1755 int attr;
1757 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1760 void
1761 msg_puts_long_len_attr(longstr, len, attr)
1762 char_u *longstr;
1763 int len;
1764 int attr;
1766 int slen = len;
1767 int room;
1769 room = Columns - msg_col;
1770 if (len > room && room >= 20)
1772 slen = (room - 3) / 2;
1773 msg_outtrans_len_attr(longstr, slen, attr);
1774 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1776 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1780 * Basic function for writing a message with highlight attributes.
1782 void
1783 msg_puts_attr(s, attr)
1784 char_u *s;
1785 int attr;
1787 msg_puts_attr_len(s, -1, attr);
1791 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1792 * When "maxlen" is -1 there is no maximum length.
1793 * When "maxlen" is >= 0 the message is not put in the history.
1795 static void
1796 msg_puts_attr_len(str, maxlen, attr)
1797 char_u *str;
1798 int maxlen;
1799 int attr;
1802 * If redirection is on, also write to the redirection file.
1804 redir_write(str, maxlen);
1807 * Don't print anything when using ":silent cmd".
1809 if (msg_silent != 0)
1810 return;
1812 /* if MSG_HIST flag set, add message to history */
1813 if ((attr & MSG_HIST) && maxlen < 0)
1815 add_msg_hist(str, -1, attr);
1816 attr &= ~MSG_HIST;
1820 * When writing something to the screen after it has scrolled, requires a
1821 * wait-return prompt later. Needed when scrolling, resetting
1822 * need_wait_return after some prompt, and then outputting something
1823 * without scrolling
1825 if (msg_scrolled != 0 && !msg_scrolled_ign)
1826 need_wait_return = TRUE;
1827 msg_didany = TRUE; /* remember that something was outputted */
1830 * If there is no valid screen, use fprintf so we can see error messages.
1831 * If termcap is not active, we may be writing in an alternate console
1832 * window, cursor positioning may not work correctly (window size may be
1833 * different, e.g. for Win32 console) or we just don't know where the
1834 * cursor is.
1836 if (msg_use_printf())
1837 msg_puts_printf(str, maxlen);
1838 else
1839 msg_puts_display(str, maxlen, attr, FALSE);
1843 * The display part of msg_puts_attr_len().
1844 * May be called recursively to display scroll-back text.
1846 static void
1847 msg_puts_display(str, maxlen, attr, recurse)
1848 char_u *str;
1849 int maxlen;
1850 int attr;
1851 int recurse;
1853 char_u *s = str;
1854 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1855 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1856 #ifdef FEAT_MBYTE
1857 int l;
1858 int cw;
1859 #endif
1860 char_u *sb_str = str;
1861 int sb_col = msg_col;
1862 int wrap;
1863 int did_last_char;
1865 did_wait_return = FALSE;
1866 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
1869 * We are at the end of the screen line when:
1870 * - When outputting a newline.
1871 * - When outputting a character in the last column.
1873 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
1874 #ifdef FEAT_RIGHTLEFT
1875 cmdmsg_rl
1877 msg_col <= 1
1878 || (*s == TAB && msg_col <= 7)
1879 # ifdef FEAT_MBYTE
1880 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1881 # endif
1884 #endif
1885 (msg_col + t_col >= Columns - 1
1886 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1887 # ifdef FEAT_MBYTE
1888 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1889 && msg_col + t_col >= Columns - 2)
1890 # endif
1891 ))))
1894 * The screen is scrolled up when at the last row (some terminals
1895 * scroll automatically, some don't. To avoid problems we scroll
1896 * ourselves).
1898 if (t_col > 0)
1899 /* output postponed text */
1900 t_puts(&t_col, t_s, s, attr);
1902 /* When no more prompt and no more room, truncate here */
1903 if (msg_no_more && lines_left == 0)
1904 break;
1906 /* Scroll the screen up one line. */
1907 msg_scroll_up();
1909 msg_row = Rows - 2;
1910 if (msg_col >= Columns) /* can happen after screen resize */
1911 msg_col = Columns - 1;
1913 /* Display char in last column before showing more-prompt. */
1914 if (*s >= ' '
1915 #ifdef FEAT_RIGHTLEFT
1916 && !cmdmsg_rl
1917 #endif
1920 #ifdef FEAT_MBYTE
1921 if (has_mbyte)
1923 if (enc_utf8 && maxlen >= 0)
1924 /* avoid including composing chars after the end */
1925 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
1926 else
1927 l = (*mb_ptr2len)(s);
1928 s = screen_puts_mbyte(s, l, attr);
1930 else
1931 #endif
1932 msg_screen_putchar(*s++, attr);
1933 did_last_char = TRUE;
1935 else
1936 did_last_char = FALSE;
1938 if (p_more)
1939 /* store text for scrolling back */
1940 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1942 inc_msg_scrolled();
1943 need_wait_return = TRUE; /* may need wait_return in main() */
1944 if (must_redraw < VALID)
1945 must_redraw = VALID;
1946 redraw_cmdline = TRUE;
1947 if (cmdline_row > 0 && !exmode_active)
1948 --cmdline_row;
1951 * If screen is completely filled and 'more' is set then wait
1952 * for a character.
1954 if (lines_left > 0)
1955 --lines_left;
1956 if (p_more && lines_left == 0 && State != HITRETURN
1957 && !msg_no_more && !exmode_active)
1959 #ifdef FEAT_CON_DIALOG
1960 if (do_more_prompt(NUL))
1961 s = confirm_msg_tail;
1962 #else
1963 (void)do_more_prompt(NUL);
1964 #endif
1965 if (quit_more)
1966 return;
1969 /* When we displayed a char in last column need to check if there
1970 * is still more. */
1971 if (did_last_char)
1972 continue;
1975 wrap = *s == '\n'
1976 || msg_col + t_col >= Columns
1977 #ifdef FEAT_MBYTE
1978 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1979 && msg_col + t_col >= Columns - 1)
1980 #endif
1982 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1983 || *s == '\t' || *s == BELL))
1984 /* output any postponed text */
1985 t_puts(&t_col, t_s, s, attr);
1987 if (wrap && p_more && !recurse)
1988 /* store text for scrolling back */
1989 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1991 if (*s == '\n') /* go to next line */
1993 msg_didout = FALSE; /* remember that line is empty */
1994 #ifdef FEAT_RIGHTLEFT
1995 if (cmdmsg_rl)
1996 msg_col = Columns - 1;
1997 else
1998 #endif
1999 msg_col = 0;
2000 if (++msg_row >= Rows) /* safety check */
2001 msg_row = Rows - 1;
2003 else if (*s == '\r') /* go to column 0 */
2005 msg_col = 0;
2007 else if (*s == '\b') /* go to previous char */
2009 if (msg_col)
2010 --msg_col;
2012 else if (*s == TAB) /* translate Tab into spaces */
2015 msg_screen_putchar(' ', attr);
2016 while (msg_col & 7);
2018 else if (*s == BELL) /* beep (from ":sh") */
2019 vim_beep();
2020 else
2022 #ifdef FEAT_MBYTE
2023 if (has_mbyte)
2025 cw = (*mb_ptr2cells)(s);
2026 if (enc_utf8 && maxlen >= 0)
2027 /* avoid including composing chars after the end */
2028 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
2029 else
2030 l = (*mb_ptr2len)(s);
2032 else
2034 cw = 1;
2035 l = 1;
2037 #endif
2038 /* When drawing from right to left or when a double-wide character
2039 * doesn't fit, draw a single character here. Otherwise collect
2040 * characters and draw them all at once later. */
2041 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2042 if (
2043 # ifdef FEAT_RIGHTLEFT
2044 cmdmsg_rl
2045 # ifdef FEAT_MBYTE
2047 # endif
2048 # endif
2049 # ifdef FEAT_MBYTE
2050 (cw > 1 && msg_col + t_col >= Columns - 1)
2051 # endif
2054 # ifdef FEAT_MBYTE
2055 if (l > 1)
2056 s = screen_puts_mbyte(s, l, attr) - 1;
2057 else
2058 # endif
2059 msg_screen_putchar(*s, attr);
2061 else
2062 #endif
2064 /* postpone this character until later */
2065 if (t_col == 0)
2066 t_s = s;
2067 #ifdef FEAT_MBYTE
2068 t_col += cw;
2069 s += l - 1;
2070 #else
2071 ++t_col;
2072 #endif
2075 ++s;
2078 /* output any postponed text */
2079 if (t_col > 0)
2080 t_puts(&t_col, t_s, s, attr);
2081 if (p_more && !recurse)
2082 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
2084 msg_check();
2088 * Scroll the screen up one line for displaying the next message line.
2090 static void
2091 msg_scroll_up()
2093 #ifdef FEAT_GUI
2094 /* Remove the cursor before scrolling, ScreenLines[] is going
2095 * to become invalid. */
2096 if (gui.in_use)
2097 gui_undraw_cursor();
2098 #endif
2099 /* scrolling up always works */
2100 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2102 if (!can_clear((char_u *)" "))
2104 /* Scrolling up doesn't result in the right background. Set the
2105 * background here. It's not efficient, but avoids that we have to do
2106 * it all over the code. */
2107 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2109 /* Also clear the last char of the last but one line if it was not
2110 * cleared before to avoid a scroll-up. */
2111 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2112 screen_fill((int)Rows - 2, (int)Rows - 1,
2113 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2118 * Increment "msg_scrolled".
2120 static void
2121 inc_msg_scrolled()
2123 #ifdef FEAT_EVAL
2124 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2126 char_u *p = sourcing_name;
2127 char_u *tofree = NULL;
2128 int len;
2130 /* v:scrollstart is empty, set it to the script/function name and line
2131 * number */
2132 if (p == NULL)
2133 p = (char_u *)_("Unknown");
2134 else
2136 len = (int)STRLEN(p) + 40;
2137 tofree = alloc(len);
2138 if (tofree != NULL)
2140 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2141 p, (long)sourcing_lnum);
2142 p = tofree;
2145 set_vim_var_string(VV_SCROLLSTART, p, -1);
2146 vim_free(tofree);
2148 #endif
2149 ++msg_scrolled;
2153 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2154 * store the displayed text and remember where screen lines start.
2156 typedef struct msgchunk_S msgchunk_T;
2157 struct msgchunk_S
2159 msgchunk_T *sb_next;
2160 msgchunk_T *sb_prev;
2161 char sb_eol; /* TRUE when line ends after this text */
2162 int sb_msg_col; /* column in which text starts */
2163 int sb_attr; /* text attributes */
2164 char_u sb_text[1]; /* text to be displayed, actually longer */
2167 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2169 static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2170 static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2172 static int do_clear_sb_text = FALSE; /* clear text on next msg */
2175 * Store part of a printed message for displaying when scrolling back.
2177 static void
2178 store_sb_text(sb_str, s, attr, sb_col, finish)
2179 char_u **sb_str; /* start of string */
2180 char_u *s; /* just after string */
2181 int attr;
2182 int *sb_col;
2183 int finish; /* line ends */
2185 msgchunk_T *mp;
2187 if (do_clear_sb_text)
2189 clear_sb_text();
2190 do_clear_sb_text = FALSE;
2193 if (s > *sb_str)
2195 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2196 if (mp != NULL)
2198 mp->sb_eol = finish;
2199 mp->sb_msg_col = *sb_col;
2200 mp->sb_attr = attr;
2201 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2203 if (last_msgchunk == NULL)
2205 last_msgchunk = mp;
2206 mp->sb_prev = NULL;
2208 else
2210 mp->sb_prev = last_msgchunk;
2211 last_msgchunk->sb_next = mp;
2212 last_msgchunk = mp;
2214 mp->sb_next = NULL;
2217 else if (finish && last_msgchunk != NULL)
2218 last_msgchunk->sb_eol = TRUE;
2220 *sb_str = s;
2221 *sb_col = 0;
2225 * Finished showing messages, clear the scroll-back text on the next message.
2227 void
2228 may_clear_sb_text()
2230 do_clear_sb_text = TRUE;
2234 * Clear any text remembered for scrolling back.
2235 * Called when redrawing the screen.
2237 void
2238 clear_sb_text()
2240 msgchunk_T *mp;
2242 while (last_msgchunk != NULL)
2244 mp = last_msgchunk->sb_prev;
2245 vim_free(last_msgchunk);
2246 last_msgchunk = mp;
2251 * "g<" command.
2253 void
2254 show_sb_text()
2256 msgchunk_T *mp;
2258 /* Only show something if there is more than one line, otherwise it looks
2259 * weird, typing a command without output results in one line. */
2260 mp = msg_sb_start(last_msgchunk);
2261 if (mp == NULL || mp->sb_prev == NULL)
2262 vim_beep();
2263 else
2265 do_more_prompt('G');
2266 wait_return(FALSE);
2271 * Move to the start of screen line in already displayed text.
2273 static msgchunk_T *
2274 msg_sb_start(mps)
2275 msgchunk_T *mps;
2277 msgchunk_T *mp = mps;
2279 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2280 mp = mp->sb_prev;
2281 return mp;
2285 * Display a screen line from previously displayed text at row "row".
2286 * Returns a pointer to the text for the next line (can be NULL).
2288 static msgchunk_T *
2289 disp_sb_line(row, smp)
2290 int row;
2291 msgchunk_T *smp;
2293 msgchunk_T *mp = smp;
2294 char_u *p;
2296 for (;;)
2298 msg_row = row;
2299 msg_col = mp->sb_msg_col;
2300 p = mp->sb_text;
2301 if (*p == '\n') /* don't display the line break */
2302 ++p;
2303 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2304 if (mp->sb_eol || mp->sb_next == NULL)
2305 break;
2306 mp = mp->sb_next;
2308 return mp->sb_next;
2312 * Output any postponed text for msg_puts_attr_len().
2314 static void
2315 t_puts(t_col, t_s, s, attr)
2316 int *t_col;
2317 char_u *t_s;
2318 char_u *s;
2319 int attr;
2321 /* output postponed text */
2322 msg_didout = TRUE; /* remember that line is not empty */
2323 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
2324 msg_col += *t_col;
2325 *t_col = 0;
2326 #ifdef FEAT_MBYTE
2327 /* If the string starts with a composing character don't increment the
2328 * column position for it. */
2329 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2330 --msg_col;
2331 #endif
2332 if (msg_col >= Columns)
2334 msg_col = 0;
2335 ++msg_row;
2340 * Returns TRUE when messages should be printed with mch_errmsg().
2341 * This is used when there is no valid screen, so we can see error messages.
2342 * If termcap is not active, we may be writing in an alternate console
2343 * window, cursor positioning may not work correctly (window size may be
2344 * different, e.g. for Win32 console) or we just don't know where the
2345 * cursor is.
2348 msg_use_printf()
2350 return (!msg_check_screen()
2351 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2352 || !termcap_active
2353 #endif
2354 || (swapping_screen() && !termcap_active)
2359 * Print a message when there is no valid screen.
2361 static void
2362 msg_puts_printf(str, maxlen)
2363 char_u *str;
2364 int maxlen;
2366 char_u *s = str;
2367 char_u buf[4];
2368 char_u *p;
2370 #ifdef WIN3264
2371 if (!(silent_mode && p_verbose == 0))
2372 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2373 #endif
2374 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2376 if (!(silent_mode && p_verbose == 0))
2378 /* NL --> CR NL translation (for Unix, not for "--version") */
2379 /* NL --> CR translation (for Mac) */
2380 p = &buf[0];
2381 if (*s == '\n' && !info_message)
2382 *p++ = '\r';
2383 #if defined(USE_CR) && !defined(MACOS_X_UNIX)
2384 else
2385 #endif
2386 *p++ = *s;
2387 *p = '\0';
2388 if (info_message) /* informative message, not an error */
2389 mch_msg((char *)buf);
2390 else
2391 mch_errmsg((char *)buf);
2394 /* primitive way to compute the current column */
2395 #ifdef FEAT_RIGHTLEFT
2396 if (cmdmsg_rl)
2398 if (*s == '\r' || *s == '\n')
2399 msg_col = Columns - 1;
2400 else
2401 --msg_col;
2403 else
2404 #endif
2406 if (*s == '\r' || *s == '\n')
2407 msg_col = 0;
2408 else
2409 ++msg_col;
2411 ++s;
2413 msg_didout = TRUE; /* assume that line is not empty */
2415 #ifdef WIN3264
2416 if (!(silent_mode && p_verbose == 0))
2417 mch_settmode(TMODE_RAW);
2418 #endif
2422 * Show the more-prompt and handle the user response.
2423 * This takes care of scrolling back and displaying previously displayed text.
2424 * When at hit-enter prompt "typed_char" is the already typed character,
2425 * otherwise it's NUL.
2426 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2428 static int
2429 do_more_prompt(typed_char)
2430 int typed_char;
2432 int used_typed_char = typed_char;
2433 int oldState = State;
2434 int c;
2435 #ifdef FEAT_CON_DIALOG
2436 int retval = FALSE;
2437 #endif
2438 int scroll;
2439 msgchunk_T *mp_last = NULL;
2440 msgchunk_T *mp;
2441 int i;
2443 if (typed_char == 'G')
2445 /* "g<": Find first line on the last page. */
2446 mp_last = msg_sb_start(last_msgchunk);
2447 for (i = 0; i < Rows - 2 && mp_last != NULL
2448 && mp_last->sb_prev != NULL; ++i)
2449 mp_last = msg_sb_start(mp_last->sb_prev);
2452 State = ASKMORE;
2453 #ifdef FEAT_MOUSE
2454 setmouse();
2455 #endif
2456 if (typed_char == NUL)
2457 msg_moremsg(FALSE);
2458 for (;;)
2461 * Get a typed character directly from the user.
2463 if (used_typed_char != NUL)
2465 c = used_typed_char; /* was typed at hit-enter prompt */
2466 used_typed_char = NUL;
2468 else
2469 c = get_keystroke();
2471 #if defined(FEAT_MENU) && defined(FEAT_GUI)
2472 if (c == K_MENU)
2474 int idx = get_menu_index(current_menu, ASKMORE);
2476 /* Used a menu. If it starts with CTRL-Y, it must
2477 * be a "Copy" for the clipboard. Otherwise
2478 * assume that we end */
2479 if (idx == MENU_INDEX_INVALID)
2480 continue;
2481 c = *current_menu->strings[idx];
2482 if (c != NUL && current_menu->strings[idx][1] != NUL)
2483 ins_typebuf(current_menu->strings[idx] + 1,
2484 current_menu->noremap[idx], 0, TRUE,
2485 current_menu->silent[idx]);
2487 #endif
2489 scroll = 0;
2490 switch (c)
2492 case BS: /* scroll one line back */
2493 case K_BS:
2494 case 'k':
2495 case K_UP:
2496 scroll = -1;
2497 break;
2499 case CAR: /* one extra line */
2500 case NL:
2501 case 'j':
2502 case K_DOWN:
2503 scroll = 1;
2504 break;
2506 case 'u': /* Up half a page */
2507 scroll = -(Rows / 2);
2508 break;
2510 case 'd': /* Down half a page */
2511 scroll = Rows / 2;
2512 break;
2514 case 'b': /* one page back */
2515 case K_PAGEUP:
2516 scroll = -(Rows - 1);
2517 break;
2519 case ' ': /* one extra page */
2520 case 'f':
2521 case K_PAGEDOWN:
2522 case K_LEFTMOUSE:
2523 scroll = Rows - 1;
2524 break;
2526 case 'g': /* all the way back to the start */
2527 scroll = -999999;
2528 break;
2530 case 'G': /* all the way to the end */
2531 scroll = 999999;
2532 lines_left = 999999;
2533 break;
2535 case ':': /* start new command line */
2536 #ifdef FEAT_CON_DIALOG
2537 if (!confirm_msg_used)
2538 #endif
2540 /* Since got_int is set all typeahead will be flushed, but we
2541 * want to keep this ':', remember that in a special way. */
2542 typeahead_noflush(':');
2543 cmdline_row = Rows - 1; /* put ':' on this line */
2544 skip_redraw = TRUE; /* skip redraw once */
2545 need_wait_return = FALSE; /* don't wait in main() */
2547 /*FALLTHROUGH*/
2548 case 'q': /* quit */
2549 case Ctrl_C:
2550 case ESC:
2551 #ifdef FEAT_CON_DIALOG
2552 if (confirm_msg_used)
2554 /* Jump to the choices of the dialog. */
2555 retval = TRUE;
2556 lines_left = Rows - 1;
2558 else
2559 #endif
2561 got_int = TRUE;
2562 quit_more = TRUE;
2564 break;
2566 #ifdef FEAT_CLIPBOARD
2567 case Ctrl_Y:
2568 /* Strange way to allow copying (yanking) a modeless
2569 * selection at the more prompt. Use CTRL-Y,
2570 * because the same is used in Cmdline-mode and at the
2571 * hit-enter prompt. However, scrolling one line up
2572 * might be expected... */
2573 if (clip_star.state == SELECT_DONE)
2574 clip_copy_modeless_selection(TRUE);
2575 continue;
2576 #endif
2577 default: /* no valid response */
2578 msg_moremsg(TRUE);
2579 continue;
2582 if (scroll != 0)
2584 if (scroll < 0)
2586 /* go to start of last line */
2587 if (mp_last == NULL)
2588 mp = msg_sb_start(last_msgchunk);
2589 else if (mp_last->sb_prev != NULL)
2590 mp = msg_sb_start(mp_last->sb_prev);
2591 else
2592 mp = NULL;
2594 /* go to start of line at top of the screen */
2595 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2596 ++i)
2597 mp = msg_sb_start(mp->sb_prev);
2599 if (mp != NULL && mp->sb_prev != NULL)
2601 /* Find line to be displayed at top. */
2602 for (i = 0; i > scroll; --i)
2604 if (mp == NULL || mp->sb_prev == NULL)
2605 break;
2606 mp = msg_sb_start(mp->sb_prev);
2607 if (mp_last == NULL)
2608 mp_last = msg_sb_start(last_msgchunk);
2609 else
2610 mp_last = msg_sb_start(mp_last->sb_prev);
2613 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2614 (int)Rows, NULL) == OK)
2616 /* display line at top */
2617 (void)disp_sb_line(0, mp);
2619 else
2621 /* redisplay all lines */
2622 screenclear();
2623 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2625 mp = disp_sb_line(i, mp);
2626 ++msg_scrolled;
2629 scroll = 0;
2632 else
2634 /* First display any text that we scrolled back. */
2635 while (scroll > 0 && mp_last != NULL)
2637 /* scroll up, display line at bottom */
2638 msg_scroll_up();
2639 inc_msg_scrolled();
2640 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2641 (int)Columns, ' ', ' ', 0);
2642 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2643 --scroll;
2647 if (scroll <= 0)
2649 /* displayed the requested text, more prompt again */
2650 screen_fill((int)Rows - 1, (int)Rows, 0,
2651 (int)Columns, ' ', ' ', 0);
2652 msg_moremsg(FALSE);
2653 continue;
2656 /* display more text, return to caller */
2657 lines_left = scroll;
2660 break;
2663 /* clear the --more-- message */
2664 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2665 State = oldState;
2666 #ifdef FEAT_MOUSE
2667 setmouse();
2668 #endif
2669 if (quit_more)
2671 msg_row = Rows - 1;
2672 msg_col = 0;
2674 #ifdef FEAT_RIGHTLEFT
2675 else if (cmdmsg_rl)
2676 msg_col = Columns - 1;
2677 #endif
2679 #ifdef FEAT_CON_DIALOG
2680 return retval;
2681 #else
2682 return FALSE;
2683 #endif
2686 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
2688 #ifdef mch_errmsg
2689 # undef mch_errmsg
2690 #endif
2691 #ifdef mch_msg
2692 # undef mch_msg
2693 #endif
2696 * Give an error message. To be used when the screen hasn't been initialized
2697 * yet. When stderr can't be used, collect error messages until the GUI has
2698 * started and they can be displayed in a message box.
2700 void
2701 mch_errmsg(str)
2702 char *str;
2704 int len;
2706 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2707 /* On Unix use stderr if it's a tty.
2708 * When not going to start the GUI also use stderr.
2709 * On Mac, when started from Finder, stderr is the console. */
2710 if (
2711 # ifdef UNIX
2712 # ifdef MACOS_X_UNIX
2713 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2714 # else
2715 isatty(2)
2716 # endif
2717 # ifdef FEAT_GUI
2719 # endif
2720 # endif
2721 # ifdef FEAT_GUI
2722 !(gui.in_use || gui.starting)
2723 # endif
2726 fprintf(stderr, "%s", str);
2727 return;
2729 #endif
2731 /* avoid a delay for a message that isn't there */
2732 emsg_on_display = FALSE;
2734 len = (int)STRLEN(str) + 1;
2735 if (error_ga.ga_growsize == 0)
2737 error_ga.ga_growsize = 80;
2738 error_ga.ga_itemsize = 1;
2740 if (ga_grow(&error_ga, len) == OK)
2742 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2743 (char_u *)str, len);
2744 #ifdef UNIX
2745 /* remove CR characters, they are displayed */
2747 char_u *p;
2749 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2750 for (;;)
2752 p = vim_strchr(p, '\r');
2753 if (p == NULL)
2754 break;
2755 *p = ' ';
2758 #endif
2759 --len; /* don't count the NUL at the end */
2760 error_ga.ga_len += len;
2765 * Give a message. To be used when the screen hasn't been initialized yet.
2766 * When there is no tty, collect messages until the GUI has started and they
2767 * can be displayed in a message box.
2769 void
2770 mch_msg(str)
2771 char *str;
2773 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2774 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2775 * uses mch_errmsg() when started from the desktop.
2776 * When not going to start the GUI also use stdout.
2777 * On Mac, when started from Finder, stderr is the console. */
2778 if (
2779 # ifdef UNIX
2780 # ifdef MACOS_X_UNIX
2781 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2782 # else
2783 isatty(2)
2784 # endif
2785 # ifdef FEAT_GUI
2787 # endif
2788 # endif
2789 # ifdef FEAT_GUI
2790 !(gui.in_use || gui.starting)
2791 # endif
2794 printf("%s", str);
2795 return;
2797 # endif
2798 mch_errmsg(str);
2800 #endif /* USE_MCH_ERRMSG */
2803 * Put a character on the screen at the current message position and advance
2804 * to the next position. Only for printable ASCII!
2806 static void
2807 msg_screen_putchar(c, attr)
2808 int c;
2809 int attr;
2811 msg_didout = TRUE; /* remember that line is not empty */
2812 screen_putchar(c, msg_row, msg_col, attr);
2813 #ifdef FEAT_RIGHTLEFT
2814 if (cmdmsg_rl)
2816 if (--msg_col == 0)
2818 msg_col = Columns;
2819 ++msg_row;
2822 else
2823 #endif
2825 if (++msg_col >= Columns)
2827 msg_col = 0;
2828 ++msg_row;
2833 void
2834 msg_moremsg(full)
2835 int full;
2837 int attr;
2838 char_u *s = (char_u *)_("-- More --");
2840 attr = hl_attr(HLF_M);
2841 screen_puts(s, (int)Rows - 1, 0, attr);
2842 if (full)
2843 screen_puts((char_u *)
2844 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2845 (int)Rows - 1, vim_strsize(s), attr);
2849 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2850 * exmode_active.
2852 void
2853 repeat_message()
2855 if (State == ASKMORE)
2857 msg_moremsg(TRUE); /* display --more-- message again */
2858 msg_row = Rows - 1;
2860 #ifdef FEAT_CON_DIALOG
2861 else if (State == CONFIRM)
2863 display_confirm_msg(); /* display ":confirm" message again */
2864 msg_row = Rows - 1;
2866 #endif
2867 else if (State == EXTERNCMD)
2869 windgoto(msg_row, msg_col); /* put cursor back */
2871 else if (State == HITRETURN || State == SETWSIZE)
2873 if (msg_row == Rows - 1)
2875 /* Avoid drawing the "hit-enter" prompt below the previous one,
2876 * overwrite it. Esp. useful when regaining focus and a
2877 * FocusGained autocmd exists but didn't draw anything. */
2878 msg_didout = FALSE;
2879 msg_col = 0;
2880 msg_clr_eos();
2882 hit_return_msg();
2883 msg_row = Rows - 1;
2888 * msg_check_screen - check if the screen is initialized.
2889 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2890 * While starting the GUI the terminal codes will be set for the GUI, but the
2891 * output goes to the terminal. Don't use the terminal codes then.
2893 static int
2894 msg_check_screen()
2896 if (!full_screen || !screen_valid(FALSE))
2897 return FALSE;
2899 if (msg_row >= Rows)
2900 msg_row = Rows - 1;
2901 if (msg_col >= Columns)
2902 msg_col = Columns - 1;
2903 return TRUE;
2907 * Clear from current message position to end of screen.
2908 * Skip this when ":silent" was used, no need to clear for redirection.
2910 void
2911 msg_clr_eos()
2913 if (msg_silent == 0)
2914 msg_clr_eos_force();
2918 * Clear from current message position to end of screen.
2919 * Note: msg_col is not updated, so we remember the end of the message
2920 * for msg_check().
2922 void
2923 msg_clr_eos_force()
2925 if (msg_use_printf())
2927 if (full_screen) /* only when termcap codes are valid */
2929 if (*T_CD)
2930 out_str(T_CD); /* clear to end of display */
2931 else if (*T_CE)
2932 out_str(T_CE); /* clear to end of line */
2935 else
2937 #ifdef FEAT_RIGHTLEFT
2938 if (cmdmsg_rl)
2940 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2941 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2943 else
2944 #endif
2946 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2947 ' ', ' ', 0);
2948 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2954 * Clear the command line.
2956 void
2957 msg_clr_cmdline()
2959 msg_row = cmdline_row;
2960 msg_col = 0;
2961 msg_clr_eos_force();
2965 * end putting a message on the screen
2966 * call wait_return if the message does not fit in the available space
2967 * return TRUE if wait_return not called.
2970 msg_end()
2973 * if the string is larger than the window,
2974 * or the ruler option is set and we run into it,
2975 * we have to redraw the window.
2976 * Do not do this if we are abandoning the file or editing the command line.
2978 if (!exiting && need_wait_return && !(State & CMDLINE))
2980 wait_return(FALSE);
2981 return FALSE;
2983 out_flush();
2984 return TRUE;
2988 * If the written message runs into the shown command or ruler, we have to
2989 * wait for hit-return and redraw the window later.
2991 void
2992 msg_check()
2994 if (msg_row == Rows - 1 && msg_col >= sc_col)
2996 need_wait_return = TRUE;
2997 redraw_cmdline = TRUE;
3002 * May write a string to the redirection file.
3003 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3005 static void
3006 redir_write(str, maxlen)
3007 char_u *str;
3008 int maxlen;
3010 char_u *s = str;
3011 static int cur_col = 0;
3013 /* Don't do anything for displaying prompts and the like. */
3014 if (redir_off)
3015 return;
3018 * If 'verbosefile' is set write message in that file.
3019 * Must come before the rest because of updating "msg_col".
3021 if (*p_vfile != NUL)
3022 verbose_write(s, maxlen);
3024 if (redir_fd != NULL
3025 #ifdef FEAT_EVAL
3026 || redir_reg || redir_vname
3027 #endif
3030 /* If the string doesn't start with CR or NL, go to msg_col */
3031 if (*s != '\n' && *s != '\r')
3033 while (cur_col < msg_col)
3035 #ifdef FEAT_EVAL
3036 if (redir_reg)
3037 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
3038 else if (redir_vname)
3039 var_redir_str((char_u *)" ", -1);
3040 else if (redir_fd)
3041 #endif
3042 fputs(" ", redir_fd);
3043 ++cur_col;
3047 #ifdef FEAT_EVAL
3048 if (redir_reg)
3049 write_reg_contents(redir_reg, s, maxlen, TRUE);
3050 if (redir_vname)
3051 var_redir_str(s, maxlen);
3052 #endif
3054 /* Adjust the current column */
3055 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3057 #ifdef FEAT_EVAL
3058 if (!redir_reg && !redir_vname && redir_fd != NULL)
3059 #endif
3060 putc(*s, redir_fd);
3061 if (*s == '\r' || *s == '\n')
3062 cur_col = 0;
3063 else if (*s == '\t')
3064 cur_col += (8 - cur_col % 8);
3065 else
3066 ++cur_col;
3067 ++s;
3070 if (msg_silent != 0) /* should update msg_col */
3071 msg_col = cur_col;
3076 * Before giving verbose message.
3077 * Must always be called paired with verbose_leave()!
3079 void
3080 verbose_enter()
3082 if (*p_vfile != NUL)
3083 ++msg_silent;
3087 * After giving verbose message.
3088 * Must always be called paired with verbose_enter()!
3090 void
3091 verbose_leave()
3093 if (*p_vfile != NUL)
3094 if (--msg_silent < 0)
3095 msg_silent = 0;
3099 * Like verbose_enter() and set msg_scroll when displaying the message.
3101 void
3102 verbose_enter_scroll()
3104 if (*p_vfile != NUL)
3105 ++msg_silent;
3106 else
3107 /* always scroll up, don't overwrite */
3108 msg_scroll = TRUE;
3112 * Like verbose_leave() and set cmdline_row when displaying the message.
3114 void
3115 verbose_leave_scroll()
3117 if (*p_vfile != NUL)
3119 if (--msg_silent < 0)
3120 msg_silent = 0;
3122 else
3123 cmdline_row = msg_row;
3126 static FILE *verbose_fd = NULL;
3127 static int verbose_did_open = FALSE;
3130 * Called when 'verbosefile' is set: stop writing to the file.
3132 void
3133 verbose_stop()
3135 if (verbose_fd != NULL)
3137 fclose(verbose_fd);
3138 verbose_fd = NULL;
3140 verbose_did_open = FALSE;
3144 * Open the file 'verbosefile'.
3145 * Return FAIL or OK.
3148 verbose_open()
3150 if (verbose_fd == NULL && !verbose_did_open)
3152 /* Only give the error message once. */
3153 verbose_did_open = TRUE;
3155 verbose_fd = mch_fopen((char *)p_vfile, "a");
3156 if (verbose_fd == NULL)
3158 EMSG2(_(e_notopen), p_vfile);
3159 return FAIL;
3162 return OK;
3166 * Write a string to 'verbosefile'.
3167 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3169 static void
3170 verbose_write(str, maxlen)
3171 char_u *str;
3172 int maxlen;
3174 char_u *s = str;
3175 static int cur_col = 0;
3177 /* Open the file when called the first time. */
3178 if (verbose_fd == NULL)
3179 verbose_open();
3181 if (verbose_fd != NULL)
3183 /* If the string doesn't start with CR or NL, go to msg_col */
3184 if (*s != '\n' && *s != '\r')
3186 while (cur_col < msg_col)
3188 fputs(" ", verbose_fd);
3189 ++cur_col;
3193 /* Adjust the current column */
3194 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3196 putc(*s, verbose_fd);
3197 if (*s == '\r' || *s == '\n')
3198 cur_col = 0;
3199 else if (*s == '\t')
3200 cur_col += (8 - cur_col % 8);
3201 else
3202 ++cur_col;
3203 ++s;
3209 * Give a warning message (for searching).
3210 * Use 'w' highlighting and may repeat the message after redrawing
3212 void
3213 give_warning(message, hl)
3214 char_u *message;
3215 int hl;
3217 /* Don't do this for ":silent". */
3218 if (msg_silent != 0)
3219 return;
3221 /* Don't want a hit-enter prompt here. */
3222 ++no_wait_return;
3224 #ifdef FEAT_EVAL
3225 set_vim_var_string(VV_WARNINGMSG, message, -1);
3226 #endif
3227 vim_free(keep_msg);
3228 keep_msg = NULL;
3229 if (hl)
3230 keep_msg_attr = hl_attr(HLF_W);
3231 else
3232 keep_msg_attr = 0;
3233 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
3234 set_keep_msg(message, keep_msg_attr);
3235 msg_didout = FALSE; /* overwrite this message */
3236 msg_nowait = TRUE; /* don't wait for this message */
3237 msg_col = 0;
3239 --no_wait_return;
3243 * Advance msg cursor to column "col".
3245 void
3246 msg_advance(col)
3247 int col;
3249 if (msg_silent != 0) /* nothing to advance to */
3251 msg_col = col; /* for redirection, may fill it up later */
3252 return;
3254 if (col >= Columns) /* not enough room */
3255 col = Columns - 1;
3256 #ifdef FEAT_RIGHTLEFT
3257 if (cmdmsg_rl)
3258 while (msg_col > Columns - col)
3259 msg_putchar(' ');
3260 else
3261 #endif
3262 while (msg_col < col)
3263 msg_putchar(' ');
3266 #if defined(FEAT_CON_DIALOG) || defined(PROTO)
3268 * Used for "confirm()" function, and the :confirm command prefix.
3269 * Versions which haven't got flexible dialogs yet, and console
3270 * versions, get this generic handler which uses the command line.
3272 * type = one of:
3273 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3274 * title = title string (can be NULL for default)
3275 * (neither used in console dialogs at the moment)
3277 * Format of the "buttons" string:
3278 * "Button1Name\nButton2Name\nButton3Name"
3279 * The first button should normally be the default/accept
3280 * The second button should be the 'Cancel' button
3281 * Other buttons- use your imagination!
3282 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3283 * different letter.
3285 /* ARGSUSED */
3287 do_dialog(type, title, message, buttons, dfltbutton, textfield)
3288 int type;
3289 char_u *title;
3290 char_u *message;
3291 char_u *buttons;
3292 int dfltbutton;
3293 char_u *textfield; /* IObuff for inputdialog(), NULL otherwise */
3295 int oldState;
3296 int retval = 0;
3297 char_u *hotkeys;
3298 int c;
3299 int i;
3301 #ifndef NO_CONSOLE
3302 /* Don't output anything in silent mode ("ex -s") */
3303 if (silent_mode)
3304 return dfltbutton; /* return default option */
3305 #endif
3307 #ifdef FEAT_GUI_DIALOG
3308 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3309 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3311 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3312 textfield);
3313 /* avoid a hit-enter prompt without clearing the cmdline */
3314 need_wait_return = FALSE;
3315 emsg_on_display = FALSE;
3316 cmdline_row = msg_row;
3318 /* Flush output to avoid that further messages and redrawing is done
3319 * in the wrong order. */
3320 out_flush();
3321 gui_mch_update();
3323 return c;
3325 #endif
3327 oldState = State;
3328 State = CONFIRM;
3329 #ifdef FEAT_MOUSE
3330 setmouse();
3331 #endif
3334 * Since we wait for a keypress, don't make the
3335 * user press RETURN as well afterwards.
3337 ++no_wait_return;
3338 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3340 if (hotkeys != NULL)
3342 for (;;)
3344 /* Get a typed character directly from the user. */
3345 c = get_keystroke();
3346 switch (c)
3348 case CAR: /* User accepts default option */
3349 case NL:
3350 retval = dfltbutton;
3351 break;
3352 case Ctrl_C: /* User aborts/cancels */
3353 case ESC:
3354 retval = 0;
3355 break;
3356 default: /* Could be a hotkey? */
3357 if (c < 0) /* special keys are ignored here */
3358 continue;
3359 /* Make the character lowercase, as chars in "hotkeys" are. */
3360 c = MB_TOLOWER(c);
3361 retval = 1;
3362 for (i = 0; hotkeys[i]; ++i)
3364 #ifdef FEAT_MBYTE
3365 if (has_mbyte)
3367 if ((*mb_ptr2char)(hotkeys + i) == c)
3368 break;
3369 i += (*mb_ptr2len)(hotkeys + i) - 1;
3371 else
3372 #endif
3373 if (hotkeys[i] == c)
3374 break;
3375 ++retval;
3377 if (hotkeys[i])
3378 break;
3379 /* No hotkey match, so keep waiting */
3380 continue;
3382 break;
3385 vim_free(hotkeys);
3388 State = oldState;
3389 #ifdef FEAT_MOUSE
3390 setmouse();
3391 #endif
3392 --no_wait_return;
3393 msg_end_prompt();
3395 return retval;
3398 static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3401 * Copy one character from "*from" to "*to", taking care of multi-byte
3402 * characters. Return the length of the character in bytes.
3404 static int
3405 copy_char(from, to, lowercase)
3406 char_u *from;
3407 char_u *to;
3408 int lowercase; /* make character lower case */
3410 #ifdef FEAT_MBYTE
3411 int len;
3412 int c;
3414 if (has_mbyte)
3416 if (lowercase)
3418 c = MB_TOLOWER((*mb_ptr2char)(from));
3419 return (*mb_char2bytes)(c, to);
3421 else
3423 len = (*mb_ptr2len)(from);
3424 mch_memmove(to, from, (size_t)len);
3425 return len;
3428 else
3429 #endif
3431 if (lowercase)
3432 *to = (char_u)TOLOWER_LOC(*from);
3433 else
3434 *to = *from;
3435 return 1;
3440 * Format the dialog string, and display it at the bottom of
3441 * the screen. Return a string of hotkey chars (if defined) for
3442 * each 'button'. If a button has no hotkey defined, the first character of
3443 * the button is used.
3444 * The hotkeys can be multi-byte characters, but without combining chars.
3446 * Returns an allocated string with hotkeys, or NULL for error.
3448 static char_u *
3449 msg_show_console_dialog(message, buttons, dfltbutton)
3450 char_u *message;
3451 char_u *buttons;
3452 int dfltbutton;
3454 int len = 0;
3455 #ifdef FEAT_MBYTE
3456 # define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3457 #else
3458 # define HOTK_LEN 1
3459 #endif
3460 int lenhotkey = HOTK_LEN; /* count first button */
3461 char_u *hotk = NULL;
3462 char_u *msgp = NULL;
3463 char_u *hotkp = NULL;
3464 char_u *r;
3465 int copy;
3466 #define HAS_HOTKEY_LEN 30
3467 char_u has_hotkey[HAS_HOTKEY_LEN];
3468 int first_hotkey = FALSE; /* first char of button is hotkey */
3469 int idx;
3471 has_hotkey[0] = FALSE;
3474 * First loop: compute the size of memory to allocate.
3475 * Second loop: copy to the allocated memory.
3477 for (copy = 0; copy <= 1; ++copy)
3479 r = buttons;
3480 idx = 0;
3481 while (*r)
3483 if (*r == DLG_BUTTON_SEP)
3485 if (copy)
3487 *msgp++ = ',';
3488 *msgp++ = ' '; /* '\n' -> ', ' */
3490 /* advance to next hotkey and set default hotkey */
3491 #ifdef FEAT_MBYTE
3492 if (has_mbyte)
3493 hotkp += STRLEN(hotkp);
3494 else
3495 #endif
3496 ++hotkp;
3497 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
3498 if (dfltbutton)
3499 --dfltbutton;
3501 /* If no hotkey is specified first char is used. */
3502 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3503 first_hotkey = TRUE;
3505 else
3507 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3508 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3509 if (idx < HAS_HOTKEY_LEN - 1)
3510 has_hotkey[++idx] = FALSE;
3513 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3515 if (*r == DLG_HOTKEY_CHAR)
3516 ++r;
3517 first_hotkey = FALSE;
3518 if (copy)
3520 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3521 *msgp++ = *r;
3522 else
3524 /* '&a' -> '[a]' */
3525 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3526 msgp += copy_char(r, msgp, FALSE);
3527 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3529 /* redefine hotkey */
3530 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
3533 else
3535 ++len; /* '&a' -> '[a]' */
3536 if (idx < HAS_HOTKEY_LEN - 1)
3537 has_hotkey[idx] = TRUE;
3540 else
3542 /* everything else copy literally */
3543 if (copy)
3544 msgp += copy_char(r, msgp, FALSE);
3547 /* advance to the next character */
3548 mb_ptr_adv(r);
3551 if (copy)
3553 *msgp++ = ':';
3554 *msgp++ = ' ';
3555 *msgp = NUL;
3557 else
3559 len += (int)(STRLEN(message)
3560 + 2 /* for the NL's */
3561 + STRLEN(buttons)
3562 + 3); /* for the ": " and NUL */
3563 lenhotkey++; /* for the NUL */
3565 /* If no hotkey is specified first char is used. */
3566 if (!has_hotkey[0])
3568 first_hotkey = TRUE;
3569 len += 2; /* "x" -> "[x]" */
3573 * Now allocate and load the strings
3575 vim_free(confirm_msg);
3576 confirm_msg = alloc(len);
3577 if (confirm_msg == NULL)
3578 return NULL;
3579 *confirm_msg = NUL;
3580 hotk = alloc(lenhotkey);
3581 if (hotk == NULL)
3582 return NULL;
3584 *confirm_msg = '\n';
3585 STRCPY(confirm_msg + 1, message);
3587 msgp = confirm_msg + 1 + STRLEN(message);
3588 hotkp = hotk;
3590 /* Define first default hotkey. Keep the hotkey string NUL
3591 * terminated to avoid reading past the end. */
3592 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
3594 /* Remember where the choices start, displaying starts here when
3595 * "hotkp" typed at the more prompt. */
3596 confirm_msg_tail = msgp;
3597 *msgp++ = '\n';
3601 display_confirm_msg();
3602 return hotk;
3606 * Display the ":confirm" message. Also called when screen resized.
3608 void
3609 display_confirm_msg()
3611 /* avoid that 'q' at the more prompt truncates the message here */
3612 ++confirm_msg_used;
3613 if (confirm_msg != NULL)
3614 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3615 --confirm_msg_used;
3618 #endif /* FEAT_CON_DIALOG */
3620 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3623 vim_dialog_yesno(type, title, message, dflt)
3624 int type;
3625 char_u *title;
3626 char_u *message;
3627 int dflt;
3629 if (do_dialog(type,
3630 title == NULL ? (char_u *)_("Question") : title,
3631 message,
3632 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3633 return VIM_YES;
3634 return VIM_NO;
3638 vim_dialog_yesnocancel(type, title, message, dflt)
3639 int type;
3640 char_u *title;
3641 char_u *message;
3642 int dflt;
3644 switch (do_dialog(type,
3645 title == NULL ? (char_u *)_("Question") : title,
3646 message,
3647 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3649 case 1: return VIM_YES;
3650 case 2: return VIM_NO;
3652 return VIM_CANCEL;
3656 vim_dialog_yesnoallcancel(type, title, message, dflt)
3657 int type;
3658 char_u *title;
3659 char_u *message;
3660 int dflt;
3662 switch (do_dialog(type,
3663 title == NULL ? (char_u *)"Question" : title,
3664 message,
3665 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3666 dflt, NULL))
3668 case 1: return VIM_YES;
3669 case 2: return VIM_NO;
3670 case 3: return VIM_ALL;
3671 case 4: return VIM_DISCARDALL;
3673 return VIM_CANCEL;
3676 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3678 #if defined(FEAT_BROWSE) || defined(PROTO)
3680 * Generic browse function. Calls gui_mch_browse() when possible.
3681 * Later this may pop-up a non-GUI file selector (external command?).
3683 char_u *
3684 do_browse(flags, title, dflt, ext, initdir, filter, buf)
3685 int flags; /* BROWSE_SAVE and BROWSE_DIR */
3686 char_u *title; /* title for the window */
3687 char_u *dflt; /* default file name (may include directory) */
3688 char_u *ext; /* extension added */
3689 char_u *initdir; /* initial directory, NULL for current dir or
3690 when using path from "dflt" */
3691 char_u *filter; /* file name filter */
3692 buf_T *buf; /* buffer to read/write for */
3694 char_u *fname;
3695 static char_u *last_dir = NULL; /* last used directory */
3696 char_u *tofree = NULL;
3697 int save_browse = cmdmod.browse;
3699 /* Must turn off browse to avoid that autocommands will get the
3700 * flag too! */
3701 cmdmod.browse = FALSE;
3703 if (title == NULL || *title == NUL)
3705 if (flags & BROWSE_DIR)
3706 title = (char_u *)_("Select Directory dialog");
3707 else if (flags & BROWSE_SAVE)
3708 title = (char_u *)_("Save File dialog");
3709 else
3710 title = (char_u *)_("Open File dialog");
3713 /* When no directory specified, use default file name, default dir, buffer
3714 * dir, last dir or current dir */
3715 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3717 if (mch_isdir(dflt)) /* default file name is a directory */
3719 initdir = dflt;
3720 dflt = NULL;
3722 else if (gettail(dflt) != dflt) /* default file name includes a path */
3724 tofree = vim_strsave(dflt);
3725 if (tofree != NULL)
3727 initdir = tofree;
3728 *gettail(initdir) = NUL;
3729 dflt = gettail(dflt);
3734 if (initdir == NULL || *initdir == NUL)
3736 /* When 'browsedir' is a directory, use it */
3737 if (STRCMP(p_bsdir, "last") != 0
3738 && STRCMP(p_bsdir, "buffer") != 0
3739 && STRCMP(p_bsdir, "current") != 0
3740 && mch_isdir(p_bsdir))
3741 initdir = p_bsdir;
3742 /* When saving or 'browsedir' is "buffer", use buffer fname */
3743 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
3744 && buf != NULL && buf->b_ffname != NULL)
3746 if (dflt == NULL || *dflt == NUL)
3747 dflt = gettail(curbuf->b_ffname);
3748 tofree = vim_strsave(curbuf->b_ffname);
3749 if (tofree != NULL)
3751 initdir = tofree;
3752 *gettail(initdir) = NUL;
3755 /* When 'browsedir' is "last", use dir from last browse */
3756 else if (*p_bsdir == 'l')
3757 initdir = last_dir;
3758 /* When 'browsedir is "current", use current directory. This is the
3759 * default already, leave initdir empty. */
3762 # ifdef FEAT_GUI
3763 if (gui.in_use) /* when this changes, also adjust f_has()! */
3765 if (filter == NULL
3766 # ifdef FEAT_EVAL
3767 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3768 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3769 # endif
3771 filter = BROWSE_FILTER_DEFAULT;
3772 if (flags & BROWSE_DIR)
3774 # if defined(HAVE_GTK2) || defined(WIN3264)
3775 /* For systems that have a directory dialog. */
3776 fname = gui_mch_browsedir(title, initdir);
3777 # else
3778 /* Generic solution for selecting a directory: select a file and
3779 * remove the file name. */
3780 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3781 # endif
3782 # if !defined(HAVE_GTK2)
3783 /* Win32 adds a dummy file name, others return an arbitrary file
3784 * name. GTK+ 2 returns only the directory, */
3785 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3787 /* Remove the file name. */
3788 char_u *tail = gettail_sep(fname);
3790 if (tail == fname)
3791 *tail++ = '.'; /* use current dir */
3792 *tail = NUL;
3794 # endif
3796 else
3797 fname = gui_mch_browse(flags & BROWSE_SAVE,
3798 title, dflt, ext, initdir, filter);
3800 /* We hang around in the dialog for a while, the user might do some
3801 * things to our files. The Win32 dialog allows deleting or renaming
3802 * a file, check timestamps. */
3803 need_check_timestamps = TRUE;
3804 did_check_timestamps = FALSE;
3806 else
3807 # endif
3809 /* TODO: non-GUI file selector here */
3810 EMSG(_("E338: Sorry, no file browser in console mode"));
3811 fname = NULL;
3814 /* keep the directory for next time */
3815 if (fname != NULL)
3817 vim_free(last_dir);
3818 last_dir = vim_strsave(fname);
3819 if (last_dir != NULL && !(flags & BROWSE_DIR))
3821 *gettail(last_dir) = NUL;
3822 if (*last_dir == NUL)
3824 /* filename only returned, must be in current dir */
3825 vim_free(last_dir);
3826 last_dir = alloc(MAXPATHL);
3827 if (last_dir != NULL)
3828 mch_dirname(last_dir, MAXPATHL);
3833 vim_free(tofree);
3834 cmdmod.browse = save_browse;
3836 return fname;
3838 #endif
3840 #if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3841 static char *e_printf = N_("E766: Insufficient arguments for printf()");
3843 static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3844 static char *tv_str __ARGS((typval_T *tvs, int *idxp));
3845 # ifdef FEAT_FLOAT
3846 static double tv_float __ARGS((typval_T *tvs, int *idxp));
3847 # endif
3850 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3852 static long
3853 tv_nr(tvs, idxp)
3854 typval_T *tvs;
3855 int *idxp;
3857 int idx = *idxp - 1;
3858 long n = 0;
3859 int err = FALSE;
3861 if (tvs[idx].v_type == VAR_UNKNOWN)
3862 EMSG(_(e_printf));
3863 else
3865 ++*idxp;
3866 n = get_tv_number_chk(&tvs[idx], &err);
3867 if (err)
3868 n = 0;
3870 return n;
3874 * Get string argument from "idxp" entry in "tvs". First entry is 1.
3875 * Returns NULL for an error.
3877 static char *
3878 tv_str(tvs, idxp)
3879 typval_T *tvs;
3880 int *idxp;
3882 int idx = *idxp - 1;
3883 char *s = NULL;
3885 if (tvs[idx].v_type == VAR_UNKNOWN)
3886 EMSG(_(e_printf));
3887 else
3889 ++*idxp;
3890 s = (char *)get_tv_string_chk(&tvs[idx]);
3892 return s;
3895 # ifdef FEAT_FLOAT
3897 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3899 static double
3900 tv_float(tvs, idxp)
3901 typval_T *tvs;
3902 int *idxp;
3904 int idx = *idxp - 1;
3905 double f = 0;
3907 if (tvs[idx].v_type == VAR_UNKNOWN)
3908 EMSG(_(e_printf));
3909 else
3911 ++*idxp;
3912 if (tvs[idx].v_type == VAR_FLOAT)
3913 f = tvs[idx].vval.v_float;
3914 else if (tvs[idx].v_type == VAR_NUMBER)
3915 f = tvs[idx].vval.v_number;
3916 else
3917 EMSG(_("E807: Expected Float argument for printf()"));
3919 return f;
3921 # endif
3922 #endif
3925 * This code was included to provide a portable vsnprintf() and snprintf().
3926 * Some systems may provide their own, but we always use this one for
3927 * consistency.
3929 * This code is based on snprintf.c - a portable implementation of snprintf
3930 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
3931 * Included with permission. It was heavily modified to fit in Vim.
3932 * The original code, including useful comments, can be found here:
3933 * http://www.ijs.si/software/snprintf/
3935 * This snprintf() only supports the following conversion specifiers:
3936 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3937 * with flags: '-', '+', ' ', '0' and '#'.
3938 * An asterisk is supported for field width as well as precision.
3940 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3942 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3943 * 'll' (long long int) is not supported.
3945 * The locale is not used, the string is used as a byte string. This is only
3946 * relevant for double-byte encodings where the second byte may be '%'.
3948 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3949 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
3951 * The return value is the number of characters which would be generated
3952 * for the given input, excluding the trailing null. If this value
3953 * is greater or equal to "str_m", not all characters from the result
3954 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3955 * are discarded. If "str_m" is greater than zero it is guaranteed
3956 * the resulting string will be null-terminated.
3960 * When va_list is not supported we only define vim_snprintf().
3962 * vim_vsnprintf() can be invoked with either "va_list" or a list of
3963 * "typval_T". When the latter is not used it must be NULL.
3966 /* When generating prototypes all of this is skipped, cproto doesn't
3967 * understand this. */
3968 #ifndef PROTO
3969 # ifdef HAVE_STDARG_H
3971 vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3973 va_list ap;
3974 int str_l;
3976 va_start(ap, fmt);
3977 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
3978 va_end(ap);
3979 return str_l;
3983 vim_vsnprintf(str, str_m, fmt, ap, tvs)
3984 # else
3985 /* clumsy way to work around missing va_list */
3986 # define get_a_arg(i) (++i, i == 2 ? a1 : i == 3 ? a2 : i == 4 ? a3 : i == 5 ? a4 : i == 6 ? a5 : i == 7 ? a6 : i == 8 ? a7 : i == 9 ? a8 : i == 10 ? a9 : a10)
3988 /* VARARGS */
3990 #ifdef __BORLANDC__
3991 _RTLENTRYF
3992 #endif
3993 vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
3994 # endif
3995 char *str;
3996 size_t str_m;
3997 char *fmt;
3998 # ifdef HAVE_STDARG_H
3999 va_list ap;
4000 typval_T *tvs;
4001 # else
4002 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4003 # endif
4005 size_t str_l = 0;
4006 char *p = fmt;
4007 int arg_idx = 1;
4009 if (p == NULL)
4010 p = "";
4011 while (*p != NUL)
4013 if (*p != '%')
4015 char *q = strchr(p + 1, '%');
4016 size_t n = (q == NULL) ? STRLEN(p) : (q - p);
4018 /* Copy up to the next '%' or NUL without any changes. */
4019 if (str_l < str_m)
4021 size_t avail = str_m - str_l;
4023 mch_memmove(str + str_l, p, n > avail ? avail : n);
4025 p += n;
4026 str_l += n;
4028 else
4030 size_t min_field_width = 0, precision = 0;
4031 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4032 int alternate_form = 0, force_sign = 0;
4034 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4035 * ignored. */
4036 int space_for_positive = 1;
4038 /* allowed values: \0, h, l, L */
4039 char length_modifier = '\0';
4041 /* temporary buffer for simple numeric->string conversion */
4042 #ifdef FEAT_FLOAT
4043 # define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
4044 * That sounds reasonable to use as the maximum
4045 * printable. */
4046 #else
4047 # define TMP_LEN 32
4048 #endif
4049 char tmp[TMP_LEN];
4051 /* string address in case of string argument */
4052 char *str_arg;
4054 /* natural field width of arg without padding and sign */
4055 size_t str_arg_l;
4057 /* unsigned char argument value - only defined for c conversion.
4058 * N.B. standard explicitly states the char argument for the c
4059 * conversion is unsigned */
4060 unsigned char uchar_arg;
4062 /* number of zeros to be inserted for numeric conversions as
4063 * required by the precision or minimal field width */
4064 size_t number_of_zeros_to_pad = 0;
4066 /* index into tmp where zero padding is to be inserted */
4067 size_t zero_padding_insertion_ind = 0;
4069 /* current conversion specifier character */
4070 char fmt_spec = '\0';
4072 str_arg = NULL;
4073 p++; /* skip '%' */
4075 /* parse flags */
4076 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4077 || *p == '#' || *p == '\'')
4079 switch (*p)
4081 case '0': zero_padding = 1; break;
4082 case '-': justify_left = 1; break;
4083 case '+': force_sign = 1; space_for_positive = 0; break;
4084 case ' ': force_sign = 1;
4085 /* If both the ' ' and '+' flags appear, the ' '
4086 * flag should be ignored */
4087 break;
4088 case '#': alternate_form = 1; break;
4089 case '\'': break;
4091 p++;
4093 /* If the '0' and '-' flags both appear, the '0' flag should be
4094 * ignored. */
4096 /* parse field width */
4097 if (*p == '*')
4099 int j;
4101 p++;
4103 #ifndef HAVE_STDARG_H
4104 get_a_arg(arg_idx);
4105 #else
4106 # if defined(FEAT_EVAL)
4107 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4108 # endif
4109 va_arg(ap, int);
4110 #endif
4111 if (j >= 0)
4112 min_field_width = j;
4113 else
4115 min_field_width = -j;
4116 justify_left = 1;
4119 else if (VIM_ISDIGIT((int)(*p)))
4121 /* size_t could be wider than unsigned int; make sure we treat
4122 * argument like common implementations do */
4123 unsigned int uj = *p++ - '0';
4125 while (VIM_ISDIGIT((int)(*p)))
4126 uj = 10 * uj + (unsigned int)(*p++ - '0');
4127 min_field_width = uj;
4130 /* parse precision */
4131 if (*p == '.')
4133 p++;
4134 precision_specified = 1;
4135 if (*p == '*')
4137 int j;
4140 #ifndef HAVE_STDARG_H
4141 get_a_arg(arg_idx);
4142 #else
4143 # if defined(FEAT_EVAL)
4144 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4145 # endif
4146 va_arg(ap, int);
4147 #endif
4148 p++;
4149 if (j >= 0)
4150 precision = j;
4151 else
4153 precision_specified = 0;
4154 precision = 0;
4157 else if (VIM_ISDIGIT((int)(*p)))
4159 /* size_t could be wider than unsigned int; make sure we
4160 * treat argument like common implementations do */
4161 unsigned int uj = *p++ - '0';
4163 while (VIM_ISDIGIT((int)(*p)))
4164 uj = 10 * uj + (unsigned int)(*p++ - '0');
4165 precision = uj;
4169 /* parse 'h', 'l' and 'll' length modifiers */
4170 if (*p == 'h' || *p == 'l')
4172 length_modifier = *p;
4173 p++;
4174 if (length_modifier == 'l' && *p == 'l')
4176 /* double l = long long */
4177 length_modifier = 'l'; /* treat it as a single 'l' */
4178 p++;
4181 fmt_spec = *p;
4183 /* common synonyms: */
4184 switch (fmt_spec)
4186 case 'i': fmt_spec = 'd'; break;
4187 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4188 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4189 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4190 case 'F': fmt_spec = 'f'; break;
4191 default: break;
4194 /* get parameter value, do initial processing */
4195 switch (fmt_spec)
4197 /* '%' and 'c' behave similar to 's' regarding flags and field
4198 * widths */
4199 case '%':
4200 case 'c':
4201 case 's':
4202 length_modifier = '\0';
4203 str_arg_l = 1;
4204 switch (fmt_spec)
4206 case '%':
4207 str_arg = p;
4208 break;
4210 case 'c':
4212 int j;
4215 #ifndef HAVE_STDARG_H
4216 get_a_arg(arg_idx);
4217 #else
4218 # if defined(FEAT_EVAL)
4219 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4220 # endif
4221 va_arg(ap, int);
4222 #endif
4223 /* standard demands unsigned char */
4224 uchar_arg = (unsigned char)j;
4225 str_arg = (char *)&uchar_arg;
4226 break;
4229 case 's':
4230 str_arg =
4231 #ifndef HAVE_STDARG_H
4232 (char *)get_a_arg(arg_idx);
4233 #else
4234 # if defined(FEAT_EVAL)
4235 tvs != NULL ? tv_str(tvs, &arg_idx) :
4236 # endif
4237 va_arg(ap, char *);
4238 #endif
4239 if (str_arg == NULL)
4241 str_arg = "[NULL]";
4242 str_arg_l = 6;
4244 /* make sure not to address string beyond the specified
4245 * precision !!! */
4246 else if (!precision_specified)
4247 str_arg_l = strlen(str_arg);
4248 /* truncate string if necessary as requested by precision */
4249 else if (precision == 0)
4250 str_arg_l = 0;
4251 else
4253 /* Don't put the #if inside memchr(), it can be a
4254 * macro. */
4255 #if SIZEOF_INT <= 2
4256 char *q = memchr(str_arg, '\0', precision);
4257 #else
4258 /* memchr on HP does not like n > 2^31 !!! */
4259 char *q = memchr(str_arg, '\0',
4260 precision <= (size_t)0x7fffffffL ? precision
4261 : (size_t)0x7fffffffL);
4262 #endif
4263 str_arg_l = (q == NULL) ? precision : q - str_arg;
4265 break;
4267 default:
4268 break;
4270 break;
4272 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4274 /* NOTE: the u, o, x, X and p conversion specifiers
4275 * imply the value is unsigned; d implies a signed
4276 * value */
4278 /* 0 if numeric argument is zero (or if pointer is
4279 * NULL for 'p'), +1 if greater than zero (or nonzero
4280 * for unsigned arguments), -1 if negative (unsigned
4281 * argument is never negative) */
4282 int arg_sign = 0;
4284 /* only defined for length modifier h, or for no
4285 * length modifiers */
4286 int int_arg = 0;
4287 unsigned int uint_arg = 0;
4289 /* only defined for length modifier l */
4290 long int long_arg = 0;
4291 unsigned long int ulong_arg = 0;
4293 /* pointer argument value -only defined for p
4294 * conversion */
4295 void *ptr_arg = NULL;
4297 if (fmt_spec == 'p')
4299 length_modifier = '\0';
4300 ptr_arg =
4301 #ifndef HAVE_STDARG_H
4302 (void *)get_a_arg(arg_idx);
4303 #else
4304 # if defined(FEAT_EVAL)
4305 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
4306 # endif
4307 va_arg(ap, void *);
4308 #endif
4309 if (ptr_arg != NULL)
4310 arg_sign = 1;
4312 else if (fmt_spec == 'd')
4314 /* signed */
4315 switch (length_modifier)
4317 case '\0':
4318 case 'h':
4319 /* char and short arguments are passed as int. */
4320 int_arg =
4321 #ifndef HAVE_STDARG_H
4322 get_a_arg(arg_idx);
4323 #else
4324 # if defined(FEAT_EVAL)
4325 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4326 # endif
4327 va_arg(ap, int);
4328 #endif
4329 if (int_arg > 0)
4330 arg_sign = 1;
4331 else if (int_arg < 0)
4332 arg_sign = -1;
4333 break;
4334 case 'l':
4335 long_arg =
4336 #ifndef HAVE_STDARG_H
4337 get_a_arg(arg_idx);
4338 #else
4339 # if defined(FEAT_EVAL)
4340 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4341 # endif
4342 va_arg(ap, long int);
4343 #endif
4344 if (long_arg > 0)
4345 arg_sign = 1;
4346 else if (long_arg < 0)
4347 arg_sign = -1;
4348 break;
4351 else
4353 /* unsigned */
4354 switch (length_modifier)
4356 case '\0':
4357 case 'h':
4358 uint_arg =
4359 #ifndef HAVE_STDARG_H
4360 get_a_arg(arg_idx);
4361 #else
4362 # if defined(FEAT_EVAL)
4363 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4364 # endif
4365 va_arg(ap, unsigned int);
4366 #endif
4367 if (uint_arg != 0)
4368 arg_sign = 1;
4369 break;
4370 case 'l':
4371 ulong_arg =
4372 #ifndef HAVE_STDARG_H
4373 get_a_arg(arg_idx);
4374 #else
4375 # if defined(FEAT_EVAL)
4376 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4377 # endif
4378 va_arg(ap, unsigned long int);
4379 #endif
4380 if (ulong_arg != 0)
4381 arg_sign = 1;
4382 break;
4386 str_arg = tmp;
4387 str_arg_l = 0;
4389 /* NOTE:
4390 * For d, i, u, o, x, and X conversions, if precision is
4391 * specified, the '0' flag should be ignored. This is so
4392 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4393 * FreeBSD, NetBSD; but not with Perl.
4395 if (precision_specified)
4396 zero_padding = 0;
4397 if (fmt_spec == 'd')
4399 if (force_sign && arg_sign >= 0)
4400 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4401 /* leave negative numbers for sprintf to handle, to
4402 * avoid handling tricky cases like (short int)-32768 */
4404 else if (alternate_form)
4406 if (arg_sign != 0
4407 && (fmt_spec == 'x' || fmt_spec == 'X') )
4409 tmp[str_arg_l++] = '0';
4410 tmp[str_arg_l++] = fmt_spec;
4412 /* alternate form should have no effect for p
4413 * conversion, but ... */
4416 zero_padding_insertion_ind = str_arg_l;
4417 if (!precision_specified)
4418 precision = 1; /* default precision is 1 */
4419 if (precision == 0 && arg_sign == 0)
4421 /* When zero value is formatted with an explicit
4422 * precision 0, the resulting formatted string is
4423 * empty (d, i, u, o, x, X, p). */
4425 else
4427 char f[5];
4428 int f_l = 0;
4430 /* construct a simple format string for sprintf */
4431 f[f_l++] = '%';
4432 if (!length_modifier)
4434 else if (length_modifier == '2')
4436 f[f_l++] = 'l';
4437 f[f_l++] = 'l';
4439 else
4440 f[f_l++] = length_modifier;
4441 f[f_l++] = fmt_spec;
4442 f[f_l++] = '\0';
4444 if (fmt_spec == 'p')
4445 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4446 else if (fmt_spec == 'd')
4448 /* signed */
4449 switch (length_modifier)
4451 case '\0':
4452 case 'h': str_arg_l += sprintf(
4453 tmp + str_arg_l, f, int_arg);
4454 break;
4455 case 'l': str_arg_l += sprintf(
4456 tmp + str_arg_l, f, long_arg);
4457 break;
4460 else
4462 /* unsigned */
4463 switch (length_modifier)
4465 case '\0':
4466 case 'h': str_arg_l += sprintf(
4467 tmp + str_arg_l, f, uint_arg);
4468 break;
4469 case 'l': str_arg_l += sprintf(
4470 tmp + str_arg_l, f, ulong_arg);
4471 break;
4475 /* include the optional minus sign and possible
4476 * "0x" in the region before the zero padding
4477 * insertion point */
4478 if (zero_padding_insertion_ind < str_arg_l
4479 && tmp[zero_padding_insertion_ind] == '-')
4480 zero_padding_insertion_ind++;
4481 if (zero_padding_insertion_ind + 1 < str_arg_l
4482 && tmp[zero_padding_insertion_ind] == '0'
4483 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4484 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4485 zero_padding_insertion_ind += 2;
4489 size_t num_of_digits = str_arg_l
4490 - zero_padding_insertion_ind;
4492 if (alternate_form && fmt_spec == 'o'
4493 /* unless zero is already the first
4494 * character */
4495 && !(zero_padding_insertion_ind < str_arg_l
4496 && tmp[zero_padding_insertion_ind] == '0'))
4498 /* assure leading zero for alternate-form
4499 * octal numbers */
4500 if (!precision_specified
4501 || precision < num_of_digits + 1)
4503 /* precision is increased to force the
4504 * first character to be zero, except if a
4505 * zero value is formatted with an
4506 * explicit precision of zero */
4507 precision = num_of_digits + 1;
4508 precision_specified = 1;
4511 /* zero padding to specified precision? */
4512 if (num_of_digits < precision)
4513 number_of_zeros_to_pad = precision - num_of_digits;
4515 /* zero padding to specified minimal field width? */
4516 if (!justify_left && zero_padding)
4518 int n = (int)(min_field_width - (str_arg_l
4519 + number_of_zeros_to_pad));
4520 if (n > 0)
4521 number_of_zeros_to_pad += n;
4523 break;
4526 #ifdef FEAT_FLOAT
4527 case 'f':
4528 case 'e':
4529 case 'E':
4530 case 'g':
4531 case 'G':
4533 /* Floating point. */
4534 double f;
4535 double abs_f;
4536 char format[40];
4537 int l;
4538 int remove_trailing_zeroes = FALSE;
4541 # ifndef HAVE_STDARG_H
4542 get_a_arg(arg_idx);
4543 # else
4544 # if defined(FEAT_EVAL)
4545 tvs != NULL ? tv_float(tvs, &arg_idx) :
4546 # endif
4547 va_arg(ap, double);
4548 # endif
4549 abs_f = f < 0 ? -f : f;
4551 if (fmt_spec == 'g' || fmt_spec == 'G')
4553 /* Would be nice to use %g directly, but it prints
4554 * "1.0" as "1", we don't want that. */
4555 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4556 || abs_f == 0.0)
4557 fmt_spec = 'f';
4558 else
4559 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4560 remove_trailing_zeroes = TRUE;
4563 if (fmt_spec == 'f' &&
4564 #ifdef VAX
4565 abs_f > 1.0e38
4566 #else
4567 abs_f > 1.0e307
4568 #endif
4571 /* Avoid a buffer overflow */
4572 strcpy(tmp, "inf");
4573 str_arg_l = 3;
4575 else
4577 format[0] = '%';
4578 l = 1;
4579 if (precision_specified)
4581 size_t max_prec = TMP_LEN - 10;
4583 /* Make sure we don't get more digits than we
4584 * have room for. */
4585 if (fmt_spec == 'f' && abs_f > 1.0)
4586 max_prec -= (size_t)log10(abs_f);
4587 if (precision > max_prec)
4588 precision = max_prec;
4589 l += sprintf(format + 1, ".%d", (int)precision);
4591 format[l] = fmt_spec;
4592 format[l + 1] = NUL;
4593 str_arg_l = sprintf(tmp, format, f);
4595 if (remove_trailing_zeroes)
4597 int i;
4598 char *tp;
4600 /* Using %g or %G: remove superfluous zeroes. */
4601 if (fmt_spec == 'f')
4602 tp = tmp + str_arg_l - 1;
4603 else
4605 tp = (char *)vim_strchr((char_u *)tmp,
4606 fmt_spec == 'e' ? 'e' : 'E');
4607 if (tp != NULL)
4609 /* Remove superfluous '+' and leading
4610 * zeroes from the exponent. */
4611 if (tp[1] == '+')
4613 /* Change "1.0e+07" to "1.0e07" */
4614 STRMOVE(tp + 1, tp + 2);
4615 --str_arg_l;
4617 i = (tp[1] == '-') ? 2 : 1;
4618 while (tp[i] == '0')
4620 /* Change "1.0e07" to "1.0e7" */
4621 STRMOVE(tp + i, tp + i + 1);
4622 --str_arg_l;
4624 --tp;
4628 if (tp != NULL && !precision_specified)
4629 /* Remove trailing zeroes, but keep the one
4630 * just after a dot. */
4631 while (tp > tmp + 2 && *tp == '0'
4632 && tp[-1] != '.')
4634 STRMOVE(tp, tp + 1);
4635 --tp;
4636 --str_arg_l;
4639 else
4641 char *tp;
4643 /* Be consistent: some printf("%e") use 1.0e+12
4644 * and some 1.0e+012. Remove one zero in the last
4645 * case. */
4646 tp = (char *)vim_strchr((char_u *)tmp,
4647 fmt_spec == 'e' ? 'e' : 'E');
4648 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4649 && tp[2] == '0'
4650 && vim_isdigit(tp[3])
4651 && vim_isdigit(tp[4]))
4653 STRMOVE(tp + 2, tp + 3);
4654 --str_arg_l;
4658 str_arg = tmp;
4659 break;
4661 #endif
4663 default:
4664 /* unrecognized conversion specifier, keep format string
4665 * as-is */
4666 zero_padding = 0; /* turn zero padding off for non-numeric
4667 conversion */
4668 justify_left = 1;
4669 min_field_width = 0; /* reset flags */
4671 /* discard the unrecognized conversion, just keep *
4672 * the unrecognized conversion character */
4673 str_arg = p;
4674 str_arg_l = 0;
4675 if (*p != NUL)
4676 str_arg_l++; /* include invalid conversion specifier
4677 unchanged if not at end-of-string */
4678 break;
4681 if (*p != NUL)
4682 p++; /* step over the just processed conversion specifier */
4684 /* insert padding to the left as requested by min_field_width;
4685 * this does not include the zero padding in case of numerical
4686 * conversions*/
4687 if (!justify_left)
4689 /* left padding with blank or zero */
4690 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4692 if (pn > 0)
4694 if (str_l < str_m)
4696 size_t avail = str_m - str_l;
4698 vim_memset(str + str_l, zero_padding ? '0' : ' ',
4699 (size_t)pn > avail ? avail : pn);
4701 str_l += pn;
4705 /* zero padding as requested by the precision or by the minimal
4706 * field width for numeric conversions required? */
4707 if (number_of_zeros_to_pad == 0)
4709 /* will not copy first part of numeric right now, *
4710 * force it to be copied later in its entirety */
4711 zero_padding_insertion_ind = 0;
4713 else
4715 /* insert first part of numerics (sign or '0x') before zero
4716 * padding */
4717 int zn = (int)zero_padding_insertion_ind;
4719 if (zn > 0)
4721 if (str_l < str_m)
4723 size_t avail = str_m - str_l;
4725 mch_memmove(str + str_l, str_arg,
4726 (size_t)zn > avail ? avail : zn);
4728 str_l += zn;
4731 /* insert zero padding as requested by the precision or min
4732 * field width */
4733 zn = (int)number_of_zeros_to_pad;
4734 if (zn > 0)
4736 if (str_l < str_m)
4738 size_t avail = str_m-str_l;
4740 vim_memset(str + str_l, '0',
4741 (size_t)zn > avail ? avail : zn);
4743 str_l += zn;
4747 /* insert formatted string
4748 * (or as-is conversion specifier for unknown conversions) */
4750 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
4752 if (sn > 0)
4754 if (str_l < str_m)
4756 size_t avail = str_m - str_l;
4758 mch_memmove(str + str_l,
4759 str_arg + zero_padding_insertion_ind,
4760 (size_t)sn > avail ? avail : sn);
4762 str_l += sn;
4766 /* insert right padding */
4767 if (justify_left)
4769 /* right blank padding to the field width */
4770 int pn = (int)(min_field_width
4771 - (str_arg_l + number_of_zeros_to_pad));
4773 if (pn > 0)
4775 if (str_l < str_m)
4777 size_t avail = str_m - str_l;
4779 vim_memset(str + str_l, ' ',
4780 (size_t)pn > avail ? avail : pn);
4782 str_l += pn;
4788 if (str_m > 0)
4790 /* make sure the string is nul-terminated even at the expense of
4791 * overwriting the last character (shouldn't happen, but just in case)
4792 * */
4793 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4796 #ifdef HAVE_STDARG_H
4797 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
4798 EMSG(_("E767: Too many arguments to printf()"));
4799 #endif
4801 /* Return the number of characters formatted (excluding trailing nul
4802 * character), that is, the number of characters that would have been
4803 * written to the buffer if it were large enough. */
4804 return (int)str_l;
4807 #endif /* PROTO */