Merge branch 'vim-with-runtime' into feat/var-tabstops
[vim_extended.git] / src / message.c
bloba8c430025decba0d2771461d74e627efc2ef006a
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(FEAT_GUI_GTK) || 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 void
822 ex_messages(eap)
823 exarg_T *eap UNUSED;
825 struct msg_hist *p;
826 char_u *s;
828 msg_hist_off = TRUE;
830 s = mch_getenv((char_u *)"LANG");
831 if (s != NULL && *s != NUL)
832 msg_attr((char_u *)
833 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
834 hl_attr(HLF_T));
836 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
837 if (p->msg != NULL)
838 msg_attr(p->msg, p->attr);
840 msg_hist_off = FALSE;
843 #if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
845 * Call this after prompting the user. This will avoid a hit-return message
846 * and a delay.
848 void
849 msg_end_prompt()
851 need_wait_return = FALSE;
852 emsg_on_display = FALSE;
853 cmdline_row = msg_row;
854 msg_col = 0;
855 msg_clr_eos();
857 #endif
860 * wait for the user to hit a key (normally a return)
861 * if 'redraw' is TRUE, clear and redraw the screen
862 * if 'redraw' is FALSE, just redraw the screen
863 * if 'redraw' is -1, don't redraw at all
865 void
866 wait_return(redraw)
867 int redraw;
869 int c;
870 int oldState;
871 int tmpState;
872 int had_got_int;
874 if (redraw == TRUE)
875 must_redraw = CLEAR;
877 /* If using ":silent cmd", don't wait for a return. Also don't set
878 * need_wait_return to do it later. */
879 if (msg_silent != 0)
880 return;
883 * With the global command (and some others) we only need one return at the
884 * end. Adjust cmdline_row to avoid the next message overwriting the last one.
885 * When inside vgetc(), we can't wait for a typed character at all.
887 if (vgetc_busy > 0)
888 return;
889 if (no_wait_return)
891 need_wait_return = TRUE;
892 if (!exmode_active)
893 cmdline_row = msg_row;
894 return;
897 redir_off = TRUE; /* don't redirect this message */
898 oldState = State;
899 if (quit_more)
901 c = CAR; /* just pretend CR was hit */
902 quit_more = FALSE;
903 got_int = FALSE;
905 else if (exmode_active)
907 MSG_PUTS(" "); /* make sure the cursor is on the right line */
908 c = CAR; /* no need for a return in ex mode */
909 got_int = FALSE;
911 else
913 /* Make sure the hit-return prompt is on screen when 'guioptions' was
914 * just changed. */
915 screenalloc(FALSE);
917 State = HITRETURN;
918 #ifdef FEAT_MOUSE
919 setmouse();
920 #endif
921 #ifdef USE_ON_FLY_SCROLL
922 dont_scroll = TRUE; /* disallow scrolling here */
923 #endif
924 hit_return_msg();
928 /* Remember "got_int", if it is set vgetc() probably returns a
929 * CTRL-C, but we need to loop then. */
930 had_got_int = got_int;
932 /* Don't do mappings here, we put the character back in the
933 * typeahead buffer. */
934 ++no_mapping;
935 ++allow_keys;
936 c = safe_vgetc();
937 if (had_got_int && !global_busy)
938 got_int = FALSE;
939 --no_mapping;
940 --allow_keys;
942 #ifdef FEAT_CLIPBOARD
943 /* Strange way to allow copying (yanking) a modeless selection at
944 * the hit-enter prompt. Use CTRL-Y, because the same is used in
945 * Cmdline-mode and it's harmless when there is no selection. */
946 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
948 clip_copy_modeless_selection(TRUE);
949 c = K_IGNORE;
951 #endif
954 * Allow scrolling back in the messages.
955 * Also accept scroll-down commands when messages fill the screen,
956 * to avoid that typing one 'j' too many makes the messages
957 * disappear.
959 if (p_more && !p_cp)
961 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
963 /* scroll back to show older messages */
964 do_more_prompt(c);
965 if (quit_more)
967 c = CAR; /* just pretend CR was hit */
968 quit_more = FALSE;
969 got_int = FALSE;
971 else
973 c = K_IGNORE;
974 hit_return_msg();
977 else if (msg_scrolled > Rows - 2
978 && (c == 'j' || c == K_DOWN || c == 'd' || c == 'f'))
979 c = K_IGNORE;
981 } while ((had_got_int && c == Ctrl_C)
982 || c == K_IGNORE
983 #ifdef FEAT_GUI
984 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
985 #endif
986 #ifdef FEAT_MOUSE
987 || c == K_LEFTDRAG || c == K_LEFTRELEASE
988 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
989 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
990 || c == K_MOUSEDOWN || c == K_MOUSEUP
991 || (!mouse_has(MOUSE_RETURN)
992 && mouse_row < msg_row
993 && (c == K_LEFTMOUSE
994 || c == K_MIDDLEMOUSE
995 || c == K_RIGHTMOUSE
996 || c == K_X1MOUSE
997 || c == K_X2MOUSE))
998 #endif
1000 ui_breakcheck();
1001 #ifdef FEAT_MOUSE
1003 * Avoid that the mouse-up event causes visual mode to start.
1005 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1006 || c == K_X1MOUSE || c == K_X2MOUSE)
1007 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1008 else
1009 #endif
1010 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1012 /* Put the character back in the typeahead buffer. Don't use the
1013 * stuff buffer, because lmaps wouldn't work. */
1014 ins_char_typebuf(c);
1015 do_redraw = TRUE; /* need a redraw even though there is
1016 typeahead */
1019 redir_off = FALSE;
1022 * If the user hits ':', '?' or '/' we get a command line from the next
1023 * line.
1025 if (c == ':' || c == '?' || c == '/')
1027 if (!exmode_active)
1028 cmdline_row = msg_row;
1029 skip_redraw = TRUE; /* skip redraw once */
1030 do_redraw = FALSE;
1034 * If the window size changed set_shellsize() will redraw the screen.
1035 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1036 * typed.
1038 tmpState = State;
1039 State = oldState; /* restore State before set_shellsize */
1040 #ifdef FEAT_MOUSE
1041 setmouse();
1042 #endif
1043 msg_check();
1045 #if defined(UNIX) || defined(VMS)
1047 * When switching screens, we need to output an extra newline on exit.
1049 if (swapping_screen() && !termcap_active)
1050 newline_on_exit = TRUE;
1051 #endif
1053 need_wait_return = FALSE;
1054 did_wait_return = TRUE;
1055 emsg_on_display = FALSE; /* can delete error message now */
1056 lines_left = -1; /* reset lines_left at next msg_start() */
1057 reset_last_sourcing();
1058 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1059 (Rows - cmdline_row - 1) * Columns + sc_col)
1061 vim_free(keep_msg);
1062 keep_msg = NULL; /* don't redisplay message, it's too long */
1065 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1067 starttermcap(); /* start termcap before redrawing */
1068 shell_resized();
1070 else if (!skip_redraw
1071 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1073 starttermcap(); /* start termcap before redrawing */
1074 redraw_later(VALID);
1079 * Write the hit-return prompt.
1081 static void
1082 hit_return_msg()
1084 int save_p_more = p_more;
1086 p_more = FALSE; /* don't want see this message when scrolling back */
1087 if (msg_didout) /* start on a new line */
1088 msg_putchar('\n');
1089 if (got_int)
1090 MSG_PUTS(_("Interrupt: "));
1092 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
1093 if (!msg_use_printf())
1094 msg_clr_eos();
1095 p_more = save_p_more;
1099 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1101 void
1102 set_keep_msg(s, attr)
1103 char_u *s;
1104 int attr;
1106 vim_free(keep_msg);
1107 if (s != NULL && msg_silent == 0)
1108 keep_msg = vim_strsave(s);
1109 else
1110 keep_msg = NULL;
1111 keep_msg_more = FALSE;
1112 keep_msg_attr = attr;
1115 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1117 * If there currently is a message being displayed, set "keep_msg" to it, so
1118 * that it will be displayed again after redraw.
1120 void
1121 set_keep_msg_from_hist()
1123 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1124 && (State & NORMAL))
1125 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1127 #endif
1130 * Prepare for outputting characters in the command line.
1132 void
1133 msg_start()
1135 int did_return = FALSE;
1137 vim_free(keep_msg);
1138 keep_msg = NULL; /* don't display old message now */
1140 #ifdef FEAT_EVAL
1141 if (need_clr_eos)
1143 /* Halfway an ":echo" command and getting an (error) message: clear
1144 * any text from the command. */
1145 need_clr_eos = FALSE;
1146 msg_clr_eos();
1148 #endif
1150 if (!msg_scroll && full_screen) /* overwrite last message */
1152 msg_row = cmdline_row;
1153 msg_col =
1154 #ifdef FEAT_RIGHTLEFT
1155 cmdmsg_rl ? Columns - 1 :
1156 #endif
1159 else if (msg_didout) /* start message on next line */
1161 msg_putchar('\n');
1162 did_return = TRUE;
1163 if (exmode_active != EXMODE_NORMAL)
1164 cmdline_row = msg_row;
1166 if (!msg_didany || lines_left < 0)
1167 msg_starthere();
1168 if (msg_silent == 0)
1170 msg_didout = FALSE; /* no output on current line yet */
1171 cursor_off();
1174 /* when redirecting, may need to start a new line. */
1175 if (!did_return)
1176 redir_write((char_u *)"\n", -1);
1180 * Note that the current msg position is where messages start.
1182 void
1183 msg_starthere()
1185 lines_left = cmdline_row;
1186 msg_didany = FALSE;
1189 void
1190 msg_putchar(c)
1191 int c;
1193 msg_putchar_attr(c, 0);
1196 void
1197 msg_putchar_attr(c, attr)
1198 int c;
1199 int attr;
1201 #ifdef FEAT_MBYTE
1202 char_u buf[MB_MAXBYTES + 1];
1203 #else
1204 char_u buf[4];
1205 #endif
1207 if (IS_SPECIAL(c))
1209 buf[0] = K_SPECIAL;
1210 buf[1] = K_SECOND(c);
1211 buf[2] = K_THIRD(c);
1212 buf[3] = NUL;
1214 else
1216 #ifdef FEAT_MBYTE
1217 buf[(*mb_char2bytes)(c, buf)] = NUL;
1218 #else
1219 buf[0] = c;
1220 buf[1] = NUL;
1221 #endif
1223 msg_puts_attr(buf, attr);
1226 void
1227 msg_outnum(n)
1228 long n;
1230 char_u buf[20];
1232 sprintf((char *)buf, "%ld", n);
1233 msg_puts(buf);
1236 void
1237 msg_home_replace(fname)
1238 char_u *fname;
1240 msg_home_replace_attr(fname, 0);
1243 #if defined(FEAT_FIND_ID) || defined(PROTO)
1244 void
1245 msg_home_replace_hl(fname)
1246 char_u *fname;
1248 msg_home_replace_attr(fname, hl_attr(HLF_D));
1250 #endif
1252 static void
1253 msg_home_replace_attr(fname, attr)
1254 char_u *fname;
1255 int attr;
1257 char_u *name;
1259 name = home_replace_save(NULL, fname);
1260 if (name != NULL)
1261 msg_outtrans_attr(name, attr);
1262 vim_free(name);
1266 * Output 'len' characters in 'str' (including NULs) with translation
1267 * if 'len' is -1, output upto a NUL character.
1268 * Use attributes 'attr'.
1269 * Return the number of characters it takes on the screen.
1272 msg_outtrans(str)
1273 char_u *str;
1275 return msg_outtrans_attr(str, 0);
1279 msg_outtrans_attr(str, attr)
1280 char_u *str;
1281 int attr;
1283 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1287 msg_outtrans_len(str, len)
1288 char_u *str;
1289 int len;
1291 return msg_outtrans_len_attr(str, len, 0);
1295 * Output one character at "p". Return pointer to the next character.
1296 * Handles multi-byte characters.
1298 char_u *
1299 msg_outtrans_one(p, attr)
1300 char_u *p;
1301 int attr;
1303 #ifdef FEAT_MBYTE
1304 int l;
1306 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1308 msg_outtrans_len_attr(p, l, attr);
1309 return p + l;
1311 #endif
1312 msg_puts_attr(transchar_byte(*p), attr);
1313 return p + 1;
1317 msg_outtrans_len_attr(msgstr, len, attr)
1318 char_u *msgstr;
1319 int len;
1320 int attr;
1322 int retval = 0;
1323 char_u *str = msgstr;
1324 char_u *plain_start = msgstr;
1325 char_u *s;
1326 #ifdef FEAT_MBYTE
1327 int mb_l;
1328 int c;
1329 #endif
1331 /* if MSG_HIST flag set, add message to history */
1332 if (attr & MSG_HIST)
1334 add_msg_hist(str, len, attr);
1335 attr &= ~MSG_HIST;
1338 #ifdef FEAT_MBYTE
1339 /* If the string starts with a composing character first draw a space on
1340 * which the composing char can be drawn. */
1341 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1342 msg_puts_attr((char_u *)" ", attr);
1343 #endif
1346 * Go over the string. Special characters are translated and printed.
1347 * Normal characters are printed several at a time.
1349 while (--len >= 0)
1351 #ifdef FEAT_MBYTE
1352 if (enc_utf8)
1353 /* Don't include composing chars after the end. */
1354 mb_l = utfc_ptr2len_len(str, len + 1);
1355 else if (has_mbyte)
1356 mb_l = (*mb_ptr2len)(str);
1357 else
1358 mb_l = 1;
1359 if (has_mbyte && mb_l > 1)
1361 c = (*mb_ptr2char)(str);
1362 if (vim_isprintc(c))
1363 /* printable multi-byte char: count the cells. */
1364 retval += (*mb_ptr2cells)(str);
1365 else
1367 /* unprintable multi-byte char: print the printable chars so
1368 * far and the translation of the unprintable char. */
1369 if (str > plain_start)
1370 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1371 attr);
1372 plain_start = str + mb_l;
1373 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1374 retval += char2cells(c);
1376 len -= mb_l - 1;
1377 str += mb_l;
1379 else
1380 #endif
1382 s = transchar_byte(*str);
1383 if (s[1] != NUL)
1385 /* unprintable char: print the printable chars so far and the
1386 * translation of the unprintable char. */
1387 if (str > plain_start)
1388 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1389 attr);
1390 plain_start = str + 1;
1391 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
1392 retval += (int)STRLEN(s);
1394 else
1395 ++retval;
1396 ++str;
1400 if (str > plain_start)
1401 /* print the printable chars at the end */
1402 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1404 return retval;
1407 #if defined(FEAT_QUICKFIX) || defined(PROTO)
1408 void
1409 msg_make(arg)
1410 char_u *arg;
1412 int i;
1413 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1415 arg = skipwhite(arg);
1416 for (i = 5; *arg && i >= 0; --i)
1417 if (*arg++ != str[i])
1418 break;
1419 if (i < 0)
1421 msg_putchar('\n');
1422 for (i = 0; rs[i]; ++i)
1423 msg_putchar(rs[i] - 3);
1426 #endif
1429 * Output the string 'str' upto a NUL character.
1430 * Return the number of characters it takes on the screen.
1432 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1433 * following character and shown as <F1>, <S-Up> etc. Any other character
1434 * which is not printable shown in <> form.
1435 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1436 * If a character is displayed in one of these special ways, is also
1437 * highlighted (its highlight name is '8' in the p_hl variable).
1438 * Otherwise characters are not highlighted.
1439 * This function is used to show mappings, where we want to see how to type
1440 * the character/string -- webb
1443 msg_outtrans_special(strstart, from)
1444 char_u *strstart;
1445 int from; /* TRUE for lhs of a mapping */
1447 char_u *str = strstart;
1448 int retval = 0;
1449 char_u *string;
1450 int attr;
1451 int len;
1453 attr = hl_attr(HLF_8);
1454 while (*str != NUL)
1456 /* Leading and trailing spaces need to be displayed in <> form. */
1457 if ((str == strstart || str[1] == NUL) && *str == ' ')
1459 string = (char_u *)"<Space>";
1460 ++str;
1462 else
1463 string = str2special(&str, from);
1464 len = vim_strsize(string);
1465 /* Highlight special keys */
1466 msg_puts_attr(string, len > 1
1467 #ifdef FEAT_MBYTE
1468 && (*mb_ptr2len)(string) <= 1
1469 #endif
1470 ? attr : 0);
1471 retval += len;
1473 return retval;
1477 * Return the printable string for the key codes at "*sp".
1478 * Used for translating the lhs or rhs of a mapping to printable chars.
1479 * Advances "sp" to the next code.
1481 char_u *
1482 str2special(sp, from)
1483 char_u **sp;
1484 int from; /* TRUE for lhs of mapping */
1486 int c;
1487 static char_u buf[7];
1488 char_u *str = *sp;
1489 int modifiers = 0;
1490 int special = FALSE;
1492 #ifdef FEAT_MBYTE
1493 if (has_mbyte)
1495 char_u *p;
1497 /* Try to un-escape a multi-byte character. Return the un-escaped
1498 * string if it is a multi-byte character. */
1499 p = mb_unescape(sp);
1500 if (p != NULL)
1501 return p;
1503 #endif
1505 c = *str;
1506 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1508 if (str[1] == KS_MODIFIER)
1510 modifiers = str[2];
1511 str += 3;
1512 c = *str;
1514 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1516 c = TO_SPECIAL(str[1], str[2]);
1517 str += 2;
1518 if (c == K_ZERO) /* display <Nul> as ^@ */
1519 c = NUL;
1521 if (IS_SPECIAL(c) || modifiers) /* special key */
1522 special = TRUE;
1524 *sp = str + 1;
1526 #ifdef FEAT_MBYTE
1527 /* For multi-byte characters check for an illegal byte. */
1528 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
1530 transchar_nonprint(buf, c);
1531 return buf;
1533 #endif
1535 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1536 * Use <Space> only for lhs of a mapping. */
1537 if (special || char2cells(c) > 1 || (from && c == ' '))
1538 return get_special_key_name(c, modifiers);
1539 buf[0] = c;
1540 buf[1] = NUL;
1541 return buf;
1545 * Translate a key sequence into special key names.
1547 void
1548 str2specialbuf(sp, buf, len)
1549 char_u *sp;
1550 char_u *buf;
1551 int len;
1553 char_u *s;
1555 *buf = NUL;
1556 while (*sp)
1558 s = str2special(&sp, FALSE);
1559 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1560 STRCAT(buf, s);
1565 * print line for :print or :list command
1567 void
1568 msg_prt_line(s, list)
1569 char_u *s;
1570 int list;
1572 int c;
1573 int col = 0;
1574 int n_extra = 0;
1575 int c_extra = 0;
1576 char_u *p_extra = NULL; /* init to make SASC shut up */
1577 int n;
1578 int attr = 0;
1579 char_u *trail = NULL;
1580 #ifdef FEAT_MBYTE
1581 int l;
1582 char_u buf[MB_MAXBYTES + 1];
1583 #endif
1585 if (curwin->w_p_list)
1586 list = TRUE;
1588 /* find start of trailing whitespace */
1589 if (list && lcs_trail)
1591 trail = s + STRLEN(s);
1592 while (trail > s && vim_iswhite(trail[-1]))
1593 --trail;
1596 /* output a space for an empty line, otherwise the line will be
1597 * overwritten */
1598 if (*s == NUL && !(list && lcs_eol != NUL))
1599 msg_putchar(' ');
1601 while (!got_int)
1603 if (n_extra > 0)
1605 --n_extra;
1606 if (c_extra)
1607 c = c_extra;
1608 else
1609 c = *p_extra++;
1611 #ifdef FEAT_MBYTE
1612 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
1614 col += (*mb_ptr2cells)(s);
1615 mch_memmove(buf, s, (size_t)l);
1616 buf[l] = NUL;
1617 msg_puts(buf);
1618 s += l;
1619 continue;
1621 #endif
1622 else
1624 attr = 0;
1625 c = *s++;
1626 if (c == TAB && (!list || lcs_tab1))
1628 /* tab amount depends on current column */
1629 #ifdef FEAT_VARTABS
1630 n_extra = tabstop_padding(col, curbuf->b_p_ts, curbuf->b_p_vts_ary) - 1;
1631 #else
1632 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
1633 #endif
1634 if (!list)
1636 c = ' ';
1637 c_extra = ' ';
1639 else
1641 c = lcs_tab1;
1642 c_extra = lcs_tab2;
1643 attr = hl_attr(HLF_8);
1646 else if (c == NUL && list && lcs_eol != NUL)
1648 p_extra = (char_u *)"";
1649 c_extra = NUL;
1650 n_extra = 1;
1651 c = lcs_eol;
1652 attr = hl_attr(HLF_AT);
1653 --s;
1655 else if (c != NUL && (n = byte2cells(c)) > 1)
1657 n_extra = n - 1;
1658 p_extra = transchar_byte(c);
1659 c_extra = NUL;
1660 c = *p_extra++;
1661 /* Use special coloring to be able to distinguish <hex> from
1662 * the same in plain text. */
1663 attr = hl_attr(HLF_8);
1665 else if (c == ' ' && trail != NULL && s > trail)
1667 c = lcs_trail;
1668 attr = hl_attr(HLF_8);
1672 if (c == NUL)
1673 break;
1675 msg_putchar_attr(c, attr);
1676 col++;
1678 msg_clr_eos();
1681 #ifdef FEAT_MBYTE
1683 * Use screen_puts() to output one multi-byte character.
1684 * Return the pointer "s" advanced to the next character.
1686 static char_u *
1687 screen_puts_mbyte(s, l, attr)
1688 char_u *s;
1689 int l;
1690 int attr;
1692 int cw;
1694 msg_didout = TRUE; /* remember that line is not empty */
1695 cw = (*mb_ptr2cells)(s);
1696 if (cw > 1 && (
1697 #ifdef FEAT_RIGHTLEFT
1698 cmdmsg_rl ? msg_col <= 1 :
1699 #endif
1700 msg_col == Columns - 1))
1702 /* Doesn't fit, print a highlighted '>' to fill it up. */
1703 msg_screen_putchar('>', hl_attr(HLF_AT));
1704 return s;
1707 screen_puts_len(s, l, msg_row, msg_col, attr);
1708 #ifdef FEAT_RIGHTLEFT
1709 if (cmdmsg_rl)
1711 msg_col -= cw;
1712 if (msg_col == 0)
1714 msg_col = Columns;
1715 ++msg_row;
1718 else
1719 #endif
1721 msg_col += cw;
1722 if (msg_col >= Columns)
1724 msg_col = 0;
1725 ++msg_row;
1728 return s + l;
1730 #endif
1733 * Output a string to the screen at position msg_row, msg_col.
1734 * Update msg_row and msg_col for the next message.
1736 void
1737 msg_puts(s)
1738 char_u *s;
1740 msg_puts_attr(s, 0);
1743 void
1744 msg_puts_title(s)
1745 char_u *s;
1747 msg_puts_attr(s, hl_attr(HLF_T));
1751 * Show a message in such a way that it always fits in the line. Cut out a
1752 * part in the middle and replace it with "..." when necessary.
1753 * Does not handle multi-byte characters!
1755 void
1756 msg_puts_long_attr(longstr, attr)
1757 char_u *longstr;
1758 int attr;
1760 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1763 void
1764 msg_puts_long_len_attr(longstr, len, attr)
1765 char_u *longstr;
1766 int len;
1767 int attr;
1769 int slen = len;
1770 int room;
1772 room = Columns - msg_col;
1773 if (len > room && room >= 20)
1775 slen = (room - 3) / 2;
1776 msg_outtrans_len_attr(longstr, slen, attr);
1777 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1779 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1783 * Basic function for writing a message with highlight attributes.
1785 void
1786 msg_puts_attr(s, attr)
1787 char_u *s;
1788 int attr;
1790 msg_puts_attr_len(s, -1, attr);
1794 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1795 * When "maxlen" is -1 there is no maximum length.
1796 * When "maxlen" is >= 0 the message is not put in the history.
1798 static void
1799 msg_puts_attr_len(str, maxlen, attr)
1800 char_u *str;
1801 int maxlen;
1802 int attr;
1805 * If redirection is on, also write to the redirection file.
1807 redir_write(str, maxlen);
1810 * Don't print anything when using ":silent cmd".
1812 if (msg_silent != 0)
1813 return;
1815 /* if MSG_HIST flag set, add message to history */
1816 if ((attr & MSG_HIST) && maxlen < 0)
1818 add_msg_hist(str, -1, attr);
1819 attr &= ~MSG_HIST;
1823 * When writing something to the screen after it has scrolled, requires a
1824 * wait-return prompt later. Needed when scrolling, resetting
1825 * need_wait_return after some prompt, and then outputting something
1826 * without scrolling
1828 if (msg_scrolled != 0 && !msg_scrolled_ign)
1829 need_wait_return = TRUE;
1830 msg_didany = TRUE; /* remember that something was outputted */
1833 * If there is no valid screen, use fprintf so we can see error messages.
1834 * If termcap is not active, we may be writing in an alternate console
1835 * window, cursor positioning may not work correctly (window size may be
1836 * different, e.g. for Win32 console) or we just don't know where the
1837 * cursor is.
1839 if (msg_use_printf())
1840 msg_puts_printf(str, maxlen);
1841 else
1842 msg_puts_display(str, maxlen, attr, FALSE);
1846 * The display part of msg_puts_attr_len().
1847 * May be called recursively to display scroll-back text.
1849 static void
1850 msg_puts_display(str, maxlen, attr, recurse)
1851 char_u *str;
1852 int maxlen;
1853 int attr;
1854 int recurse;
1856 char_u *s = str;
1857 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1858 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1859 #ifdef FEAT_MBYTE
1860 int l;
1861 int cw;
1862 #endif
1863 char_u *sb_str = str;
1864 int sb_col = msg_col;
1865 int wrap;
1866 int did_last_char;
1868 did_wait_return = FALSE;
1869 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
1872 * We are at the end of the screen line when:
1873 * - When outputting a newline.
1874 * - When outputting a character in the last column.
1876 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
1877 #ifdef FEAT_RIGHTLEFT
1878 cmdmsg_rl
1880 msg_col <= 1
1881 || (*s == TAB && msg_col <= 7)
1882 # ifdef FEAT_MBYTE
1883 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1884 # endif
1887 #endif
1888 (msg_col + t_col >= Columns - 1
1889 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1890 # ifdef FEAT_MBYTE
1891 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1892 && msg_col + t_col >= Columns - 2)
1893 # endif
1894 ))))
1897 * The screen is scrolled up when at the last row (some terminals
1898 * scroll automatically, some don't. To avoid problems we scroll
1899 * ourselves).
1901 if (t_col > 0)
1902 /* output postponed text */
1903 t_puts(&t_col, t_s, s, attr);
1905 /* When no more prompt and no more room, truncate here */
1906 if (msg_no_more && lines_left == 0)
1907 break;
1909 /* Scroll the screen up one line. */
1910 msg_scroll_up();
1912 msg_row = Rows - 2;
1913 if (msg_col >= Columns) /* can happen after screen resize */
1914 msg_col = Columns - 1;
1916 /* Display char in last column before showing more-prompt. */
1917 if (*s >= ' '
1918 #ifdef FEAT_RIGHTLEFT
1919 && !cmdmsg_rl
1920 #endif
1923 #ifdef FEAT_MBYTE
1924 if (has_mbyte)
1926 if (enc_utf8 && maxlen >= 0)
1927 /* avoid including composing chars after the end */
1928 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
1929 else
1930 l = (*mb_ptr2len)(s);
1931 s = screen_puts_mbyte(s, l, attr);
1933 else
1934 #endif
1935 msg_screen_putchar(*s++, attr);
1936 did_last_char = TRUE;
1938 else
1939 did_last_char = FALSE;
1941 if (p_more)
1942 /* store text for scrolling back */
1943 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1945 inc_msg_scrolled();
1946 need_wait_return = TRUE; /* may need wait_return in main() */
1947 if (must_redraw < VALID)
1948 must_redraw = VALID;
1949 redraw_cmdline = TRUE;
1950 if (cmdline_row > 0 && !exmode_active)
1951 --cmdline_row;
1954 * If screen is completely filled and 'more' is set then wait
1955 * for a character.
1957 if (lines_left > 0)
1958 --lines_left;
1959 if (p_more && lines_left == 0 && State != HITRETURN
1960 && !msg_no_more && !exmode_active)
1962 #ifdef FEAT_CON_DIALOG
1963 if (do_more_prompt(NUL))
1964 s = confirm_msg_tail;
1965 #else
1966 (void)do_more_prompt(NUL);
1967 #endif
1968 if (quit_more)
1969 return;
1972 /* When we displayed a char in last column need to check if there
1973 * is still more. */
1974 if (did_last_char)
1975 continue;
1978 wrap = *s == '\n'
1979 || msg_col + t_col >= Columns
1980 #ifdef FEAT_MBYTE
1981 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1982 && msg_col + t_col >= Columns - 1)
1983 #endif
1985 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1986 || *s == '\t' || *s == BELL))
1987 /* output any postponed text */
1988 t_puts(&t_col, t_s, s, attr);
1990 if (wrap && p_more && !recurse)
1991 /* store text for scrolling back */
1992 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1994 if (*s == '\n') /* go to next line */
1996 msg_didout = FALSE; /* remember that line is empty */
1997 #ifdef FEAT_RIGHTLEFT
1998 if (cmdmsg_rl)
1999 msg_col = Columns - 1;
2000 else
2001 #endif
2002 msg_col = 0;
2003 if (++msg_row >= Rows) /* safety check */
2004 msg_row = Rows - 1;
2006 else if (*s == '\r') /* go to column 0 */
2008 msg_col = 0;
2010 else if (*s == '\b') /* go to previous char */
2012 if (msg_col)
2013 --msg_col;
2015 else if (*s == TAB) /* translate Tab into spaces */
2018 msg_screen_putchar(' ', attr);
2019 while (msg_col & 7);
2021 else if (*s == BELL) /* beep (from ":sh") */
2022 vim_beep();
2023 else
2025 #ifdef FEAT_MBYTE
2026 if (has_mbyte)
2028 cw = (*mb_ptr2cells)(s);
2029 if (enc_utf8 && maxlen >= 0)
2030 /* avoid including composing chars after the end */
2031 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
2032 else
2033 l = (*mb_ptr2len)(s);
2035 else
2037 cw = 1;
2038 l = 1;
2040 #endif
2041 /* When drawing from right to left or when a double-wide character
2042 * doesn't fit, draw a single character here. Otherwise collect
2043 * characters and draw them all at once later. */
2044 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2045 if (
2046 # ifdef FEAT_RIGHTLEFT
2047 cmdmsg_rl
2048 # ifdef FEAT_MBYTE
2050 # endif
2051 # endif
2052 # ifdef FEAT_MBYTE
2053 (cw > 1 && msg_col + t_col >= Columns - 1)
2054 # endif
2057 # ifdef FEAT_MBYTE
2058 if (l > 1)
2059 s = screen_puts_mbyte(s, l, attr) - 1;
2060 else
2061 # endif
2062 msg_screen_putchar(*s, attr);
2064 else
2065 #endif
2067 /* postpone this character until later */
2068 if (t_col == 0)
2069 t_s = s;
2070 #ifdef FEAT_MBYTE
2071 t_col += cw;
2072 s += l - 1;
2073 #else
2074 ++t_col;
2075 #endif
2078 ++s;
2081 /* output any postponed text */
2082 if (t_col > 0)
2083 t_puts(&t_col, t_s, s, attr);
2084 if (p_more && !recurse)
2085 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
2087 msg_check();
2091 * Scroll the screen up one line for displaying the next message line.
2093 static void
2094 msg_scroll_up()
2096 #ifdef FEAT_GUI
2097 /* Remove the cursor before scrolling, ScreenLines[] is going
2098 * to become invalid. */
2099 if (gui.in_use)
2100 gui_undraw_cursor();
2101 #endif
2102 /* scrolling up always works */
2103 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2105 if (!can_clear((char_u *)" "))
2107 /* Scrolling up doesn't result in the right background. Set the
2108 * background here. It's not efficient, but avoids that we have to do
2109 * it all over the code. */
2110 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2112 /* Also clear the last char of the last but one line if it was not
2113 * cleared before to avoid a scroll-up. */
2114 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2115 screen_fill((int)Rows - 2, (int)Rows - 1,
2116 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2121 * Increment "msg_scrolled".
2123 static void
2124 inc_msg_scrolled()
2126 #ifdef FEAT_EVAL
2127 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2129 char_u *p = sourcing_name;
2130 char_u *tofree = NULL;
2131 int len;
2133 /* v:scrollstart is empty, set it to the script/function name and line
2134 * number */
2135 if (p == NULL)
2136 p = (char_u *)_("Unknown");
2137 else
2139 len = (int)STRLEN(p) + 40;
2140 tofree = alloc(len);
2141 if (tofree != NULL)
2143 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2144 p, (long)sourcing_lnum);
2145 p = tofree;
2148 set_vim_var_string(VV_SCROLLSTART, p, -1);
2149 vim_free(tofree);
2151 #endif
2152 ++msg_scrolled;
2156 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2157 * store the displayed text and remember where screen lines start.
2159 typedef struct msgchunk_S msgchunk_T;
2160 struct msgchunk_S
2162 msgchunk_T *sb_next;
2163 msgchunk_T *sb_prev;
2164 char sb_eol; /* TRUE when line ends after this text */
2165 int sb_msg_col; /* column in which text starts */
2166 int sb_attr; /* text attributes */
2167 char_u sb_text[1]; /* text to be displayed, actually longer */
2170 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2172 static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2173 static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2175 static int do_clear_sb_text = FALSE; /* clear text on next msg */
2178 * Store part of a printed message for displaying when scrolling back.
2180 static void
2181 store_sb_text(sb_str, s, attr, sb_col, finish)
2182 char_u **sb_str; /* start of string */
2183 char_u *s; /* just after string */
2184 int attr;
2185 int *sb_col;
2186 int finish; /* line ends */
2188 msgchunk_T *mp;
2190 if (do_clear_sb_text)
2192 clear_sb_text();
2193 do_clear_sb_text = FALSE;
2196 if (s > *sb_str)
2198 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2199 if (mp != NULL)
2201 mp->sb_eol = finish;
2202 mp->sb_msg_col = *sb_col;
2203 mp->sb_attr = attr;
2204 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2206 if (last_msgchunk == NULL)
2208 last_msgchunk = mp;
2209 mp->sb_prev = NULL;
2211 else
2213 mp->sb_prev = last_msgchunk;
2214 last_msgchunk->sb_next = mp;
2215 last_msgchunk = mp;
2217 mp->sb_next = NULL;
2220 else if (finish && last_msgchunk != NULL)
2221 last_msgchunk->sb_eol = TRUE;
2223 *sb_str = s;
2224 *sb_col = 0;
2228 * Finished showing messages, clear the scroll-back text on the next message.
2230 void
2231 may_clear_sb_text()
2233 do_clear_sb_text = TRUE;
2237 * Clear any text remembered for scrolling back.
2238 * Called when redrawing the screen.
2240 void
2241 clear_sb_text()
2243 msgchunk_T *mp;
2245 while (last_msgchunk != NULL)
2247 mp = last_msgchunk->sb_prev;
2248 vim_free(last_msgchunk);
2249 last_msgchunk = mp;
2254 * "g<" command.
2256 void
2257 show_sb_text()
2259 msgchunk_T *mp;
2261 /* Only show something if there is more than one line, otherwise it looks
2262 * weird, typing a command without output results in one line. */
2263 mp = msg_sb_start(last_msgchunk);
2264 if (mp == NULL || mp->sb_prev == NULL)
2265 vim_beep();
2266 else
2268 do_more_prompt('G');
2269 wait_return(FALSE);
2274 * Move to the start of screen line in already displayed text.
2276 static msgchunk_T *
2277 msg_sb_start(mps)
2278 msgchunk_T *mps;
2280 msgchunk_T *mp = mps;
2282 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2283 mp = mp->sb_prev;
2284 return mp;
2288 * Display a screen line from previously displayed text at row "row".
2289 * Returns a pointer to the text for the next line (can be NULL).
2291 static msgchunk_T *
2292 disp_sb_line(row, smp)
2293 int row;
2294 msgchunk_T *smp;
2296 msgchunk_T *mp = smp;
2297 char_u *p;
2299 for (;;)
2301 msg_row = row;
2302 msg_col = mp->sb_msg_col;
2303 p = mp->sb_text;
2304 if (*p == '\n') /* don't display the line break */
2305 ++p;
2306 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2307 if (mp->sb_eol || mp->sb_next == NULL)
2308 break;
2309 mp = mp->sb_next;
2311 return mp->sb_next;
2315 * Output any postponed text for msg_puts_attr_len().
2317 static void
2318 t_puts(t_col, t_s, s, attr)
2319 int *t_col;
2320 char_u *t_s;
2321 char_u *s;
2322 int attr;
2324 /* output postponed text */
2325 msg_didout = TRUE; /* remember that line is not empty */
2326 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
2327 msg_col += *t_col;
2328 *t_col = 0;
2329 #ifdef FEAT_MBYTE
2330 /* If the string starts with a composing character don't increment the
2331 * column position for it. */
2332 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2333 --msg_col;
2334 #endif
2335 if (msg_col >= Columns)
2337 msg_col = 0;
2338 ++msg_row;
2343 * Returns TRUE when messages should be printed with mch_errmsg().
2344 * This is used when there is no valid screen, so we can see error messages.
2345 * If termcap is not active, we may be writing in an alternate console
2346 * window, cursor positioning may not work correctly (window size may be
2347 * different, e.g. for Win32 console) or we just don't know where the
2348 * cursor is.
2351 msg_use_printf()
2353 return (!msg_check_screen()
2354 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2355 || !termcap_active
2356 #endif
2357 || (swapping_screen() && !termcap_active)
2362 * Print a message when there is no valid screen.
2364 static void
2365 msg_puts_printf(str, maxlen)
2366 char_u *str;
2367 int maxlen;
2369 char_u *s = str;
2370 char_u buf[4];
2371 char_u *p;
2373 #ifdef WIN3264
2374 if (!(silent_mode && p_verbose == 0))
2375 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2376 #endif
2377 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2379 if (!(silent_mode && p_verbose == 0))
2381 /* NL --> CR NL translation (for Unix, not for "--version") */
2382 /* NL --> CR translation (for Mac) */
2383 p = &buf[0];
2384 if (*s == '\n' && !info_message)
2385 *p++ = '\r';
2386 #if defined(USE_CR) && !defined(MACOS_X_UNIX)
2387 else
2388 #endif
2389 *p++ = *s;
2390 *p = '\0';
2391 if (info_message) /* informative message, not an error */
2392 mch_msg((char *)buf);
2393 else
2394 mch_errmsg((char *)buf);
2397 /* primitive way to compute the current column */
2398 #ifdef FEAT_RIGHTLEFT
2399 if (cmdmsg_rl)
2401 if (*s == '\r' || *s == '\n')
2402 msg_col = Columns - 1;
2403 else
2404 --msg_col;
2406 else
2407 #endif
2409 if (*s == '\r' || *s == '\n')
2410 msg_col = 0;
2411 else
2412 ++msg_col;
2414 ++s;
2416 msg_didout = TRUE; /* assume that line is not empty */
2418 #ifdef WIN3264
2419 if (!(silent_mode && p_verbose == 0))
2420 mch_settmode(TMODE_RAW);
2421 #endif
2425 * Show the more-prompt and handle the user response.
2426 * This takes care of scrolling back and displaying previously displayed text.
2427 * When at hit-enter prompt "typed_char" is the already typed character,
2428 * otherwise it's NUL.
2429 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2431 static int
2432 do_more_prompt(typed_char)
2433 int typed_char;
2435 int used_typed_char = typed_char;
2436 int oldState = State;
2437 int c;
2438 #ifdef FEAT_CON_DIALOG
2439 int retval = FALSE;
2440 #endif
2441 int scroll;
2442 msgchunk_T *mp_last = NULL;
2443 msgchunk_T *mp;
2444 int i;
2446 if (typed_char == 'G')
2448 /* "g<": Find first line on the last page. */
2449 mp_last = msg_sb_start(last_msgchunk);
2450 for (i = 0; i < Rows - 2 && mp_last != NULL
2451 && mp_last->sb_prev != NULL; ++i)
2452 mp_last = msg_sb_start(mp_last->sb_prev);
2455 State = ASKMORE;
2456 #ifdef FEAT_MOUSE
2457 setmouse();
2458 #endif
2459 if (typed_char == NUL)
2460 msg_moremsg(FALSE);
2461 for (;;)
2464 * Get a typed character directly from the user.
2466 if (used_typed_char != NUL)
2468 c = used_typed_char; /* was typed at hit-enter prompt */
2469 used_typed_char = NUL;
2471 else
2472 c = get_keystroke();
2474 #if defined(FEAT_MENU) && defined(FEAT_GUI)
2475 if (c == K_MENU)
2477 int idx = get_menu_index(current_menu, ASKMORE);
2479 /* Used a menu. If it starts with CTRL-Y, it must
2480 * be a "Copy" for the clipboard. Otherwise
2481 * assume that we end */
2482 if (idx == MENU_INDEX_INVALID)
2483 continue;
2484 c = *current_menu->strings[idx];
2485 if (c != NUL && current_menu->strings[idx][1] != NUL)
2486 ins_typebuf(current_menu->strings[idx] + 1,
2487 current_menu->noremap[idx], 0, TRUE,
2488 current_menu->silent[idx]);
2490 #endif
2492 scroll = 0;
2493 switch (c)
2495 case BS: /* scroll one line back */
2496 case K_BS:
2497 case 'k':
2498 case K_UP:
2499 scroll = -1;
2500 break;
2502 case CAR: /* one extra line */
2503 case NL:
2504 case 'j':
2505 case K_DOWN:
2506 scroll = 1;
2507 break;
2509 case 'u': /* Up half a page */
2510 scroll = -(Rows / 2);
2511 break;
2513 case 'd': /* Down half a page */
2514 scroll = Rows / 2;
2515 break;
2517 case 'b': /* one page back */
2518 case K_PAGEUP:
2519 scroll = -(Rows - 1);
2520 break;
2522 case ' ': /* one extra page */
2523 case 'f':
2524 case K_PAGEDOWN:
2525 case K_LEFTMOUSE:
2526 scroll = Rows - 1;
2527 break;
2529 case 'g': /* all the way back to the start */
2530 scroll = -999999;
2531 break;
2533 case 'G': /* all the way to the end */
2534 scroll = 999999;
2535 lines_left = 999999;
2536 break;
2538 case ':': /* start new command line */
2539 #ifdef FEAT_CON_DIALOG
2540 if (!confirm_msg_used)
2541 #endif
2543 /* Since got_int is set all typeahead will be flushed, but we
2544 * want to keep this ':', remember that in a special way. */
2545 typeahead_noflush(':');
2546 cmdline_row = Rows - 1; /* put ':' on this line */
2547 skip_redraw = TRUE; /* skip redraw once */
2548 need_wait_return = FALSE; /* don't wait in main() */
2550 /*FALLTHROUGH*/
2551 case 'q': /* quit */
2552 case Ctrl_C:
2553 case ESC:
2554 #ifdef FEAT_CON_DIALOG
2555 if (confirm_msg_used)
2557 /* Jump to the choices of the dialog. */
2558 retval = TRUE;
2560 else
2561 #endif
2563 got_int = TRUE;
2564 quit_more = TRUE;
2566 /* When there is some more output (wrapping line) display that
2567 * without another prompt. */
2568 lines_left = Rows - 1;
2569 break;
2571 #ifdef FEAT_CLIPBOARD
2572 case Ctrl_Y:
2573 /* Strange way to allow copying (yanking) a modeless
2574 * selection at the more prompt. Use CTRL-Y,
2575 * because the same is used in Cmdline-mode and at the
2576 * hit-enter prompt. However, scrolling one line up
2577 * might be expected... */
2578 if (clip_star.state == SELECT_DONE)
2579 clip_copy_modeless_selection(TRUE);
2580 continue;
2581 #endif
2582 default: /* no valid response */
2583 msg_moremsg(TRUE);
2584 continue;
2587 if (scroll != 0)
2589 if (scroll < 0)
2591 /* go to start of last line */
2592 if (mp_last == NULL)
2593 mp = msg_sb_start(last_msgchunk);
2594 else if (mp_last->sb_prev != NULL)
2595 mp = msg_sb_start(mp_last->sb_prev);
2596 else
2597 mp = NULL;
2599 /* go to start of line at top of the screen */
2600 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2601 ++i)
2602 mp = msg_sb_start(mp->sb_prev);
2604 if (mp != NULL && mp->sb_prev != NULL)
2606 /* Find line to be displayed at top. */
2607 for (i = 0; i > scroll; --i)
2609 if (mp == NULL || mp->sb_prev == NULL)
2610 break;
2611 mp = msg_sb_start(mp->sb_prev);
2612 if (mp_last == NULL)
2613 mp_last = msg_sb_start(last_msgchunk);
2614 else
2615 mp_last = msg_sb_start(mp_last->sb_prev);
2618 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2619 (int)Rows, NULL) == OK)
2621 /* display line at top */
2622 (void)disp_sb_line(0, mp);
2624 else
2626 /* redisplay all lines */
2627 screenclear();
2628 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2630 mp = disp_sb_line(i, mp);
2631 ++msg_scrolled;
2634 scroll = 0;
2637 else
2639 /* First display any text that we scrolled back. */
2640 while (scroll > 0 && mp_last != NULL)
2642 /* scroll up, display line at bottom */
2643 msg_scroll_up();
2644 inc_msg_scrolled();
2645 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2646 (int)Columns, ' ', ' ', 0);
2647 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2648 --scroll;
2652 if (scroll <= 0)
2654 /* displayed the requested text, more prompt again */
2655 screen_fill((int)Rows - 1, (int)Rows, 0,
2656 (int)Columns, ' ', ' ', 0);
2657 msg_moremsg(FALSE);
2658 continue;
2661 /* display more text, return to caller */
2662 lines_left = scroll;
2665 break;
2668 /* clear the --more-- message */
2669 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2670 State = oldState;
2671 #ifdef FEAT_MOUSE
2672 setmouse();
2673 #endif
2674 if (quit_more)
2676 msg_row = Rows - 1;
2677 msg_col = 0;
2679 #ifdef FEAT_RIGHTLEFT
2680 else if (cmdmsg_rl)
2681 msg_col = Columns - 1;
2682 #endif
2684 #ifdef FEAT_CON_DIALOG
2685 return retval;
2686 #else
2687 return FALSE;
2688 #endif
2691 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
2693 #ifdef mch_errmsg
2694 # undef mch_errmsg
2695 #endif
2696 #ifdef mch_msg
2697 # undef mch_msg
2698 #endif
2701 * Give an error message. To be used when the screen hasn't been initialized
2702 * yet. When stderr can't be used, collect error messages until the GUI has
2703 * started and they can be displayed in a message box.
2705 void
2706 mch_errmsg(str)
2707 char *str;
2709 int len;
2711 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2712 /* On Unix use stderr if it's a tty.
2713 * When not going to start the GUI also use stderr.
2714 * On Mac, when started from Finder, stderr is the console. */
2715 if (
2716 # ifdef UNIX
2717 # ifdef MACOS_X_UNIX
2718 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2719 # else
2720 isatty(2)
2721 # endif
2722 # ifdef FEAT_GUI
2724 # endif
2725 # endif
2726 # ifdef FEAT_GUI
2727 !(gui.in_use || gui.starting)
2728 # endif
2731 fprintf(stderr, "%s", str);
2732 return;
2734 #endif
2736 /* avoid a delay for a message that isn't there */
2737 emsg_on_display = FALSE;
2739 len = (int)STRLEN(str) + 1;
2740 if (error_ga.ga_growsize == 0)
2742 error_ga.ga_growsize = 80;
2743 error_ga.ga_itemsize = 1;
2745 if (ga_grow(&error_ga, len) == OK)
2747 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2748 (char_u *)str, len);
2749 #ifdef UNIX
2750 /* remove CR characters, they are displayed */
2752 char_u *p;
2754 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2755 for (;;)
2757 p = vim_strchr(p, '\r');
2758 if (p == NULL)
2759 break;
2760 *p = ' ';
2763 #endif
2764 --len; /* don't count the NUL at the end */
2765 error_ga.ga_len += len;
2770 * Give a message. To be used when the screen hasn't been initialized yet.
2771 * When there is no tty, collect messages until the GUI has started and they
2772 * can be displayed in a message box.
2774 void
2775 mch_msg(str)
2776 char *str;
2778 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2779 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2780 * uses mch_errmsg() when started from the desktop.
2781 * When not going to start the GUI also use stdout.
2782 * On Mac, when started from Finder, stderr is the console. */
2783 if (
2784 # ifdef UNIX
2785 # ifdef MACOS_X_UNIX
2786 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2787 # else
2788 isatty(2)
2789 # endif
2790 # ifdef FEAT_GUI
2792 # endif
2793 # endif
2794 # ifdef FEAT_GUI
2795 !(gui.in_use || gui.starting)
2796 # endif
2799 printf("%s", str);
2800 return;
2802 # endif
2803 mch_errmsg(str);
2805 #endif /* USE_MCH_ERRMSG */
2808 * Put a character on the screen at the current message position and advance
2809 * to the next position. Only for printable ASCII!
2811 static void
2812 msg_screen_putchar(c, attr)
2813 int c;
2814 int attr;
2816 msg_didout = TRUE; /* remember that line is not empty */
2817 screen_putchar(c, msg_row, msg_col, attr);
2818 #ifdef FEAT_RIGHTLEFT
2819 if (cmdmsg_rl)
2821 if (--msg_col == 0)
2823 msg_col = Columns;
2824 ++msg_row;
2827 else
2828 #endif
2830 if (++msg_col >= Columns)
2832 msg_col = 0;
2833 ++msg_row;
2838 void
2839 msg_moremsg(full)
2840 int full;
2842 int attr;
2843 char_u *s = (char_u *)_("-- More --");
2845 attr = hl_attr(HLF_M);
2846 screen_puts(s, (int)Rows - 1, 0, attr);
2847 if (full)
2848 screen_puts((char_u *)
2849 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2850 (int)Rows - 1, vim_strsize(s), attr);
2854 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2855 * exmode_active.
2857 void
2858 repeat_message()
2860 if (State == ASKMORE)
2862 msg_moremsg(TRUE); /* display --more-- message again */
2863 msg_row = Rows - 1;
2865 #ifdef FEAT_CON_DIALOG
2866 else if (State == CONFIRM)
2868 display_confirm_msg(); /* display ":confirm" message again */
2869 msg_row = Rows - 1;
2871 #endif
2872 else if (State == EXTERNCMD)
2874 windgoto(msg_row, msg_col); /* put cursor back */
2876 else if (State == HITRETURN || State == SETWSIZE)
2878 if (msg_row == Rows - 1)
2880 /* Avoid drawing the "hit-enter" prompt below the previous one,
2881 * overwrite it. Esp. useful when regaining focus and a
2882 * FocusGained autocmd exists but didn't draw anything. */
2883 msg_didout = FALSE;
2884 msg_col = 0;
2885 msg_clr_eos();
2887 hit_return_msg();
2888 msg_row = Rows - 1;
2893 * msg_check_screen - check if the screen is initialized.
2894 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2895 * While starting the GUI the terminal codes will be set for the GUI, but the
2896 * output goes to the terminal. Don't use the terminal codes then.
2898 static int
2899 msg_check_screen()
2901 if (!full_screen || !screen_valid(FALSE))
2902 return FALSE;
2904 if (msg_row >= Rows)
2905 msg_row = Rows - 1;
2906 if (msg_col >= Columns)
2907 msg_col = Columns - 1;
2908 return TRUE;
2912 * Clear from current message position to end of screen.
2913 * Skip this when ":silent" was used, no need to clear for redirection.
2915 void
2916 msg_clr_eos()
2918 if (msg_silent == 0)
2919 msg_clr_eos_force();
2923 * Clear from current message position to end of screen.
2924 * Note: msg_col is not updated, so we remember the end of the message
2925 * for msg_check().
2927 void
2928 msg_clr_eos_force()
2930 if (msg_use_printf())
2932 if (full_screen) /* only when termcap codes are valid */
2934 if (*T_CD)
2935 out_str(T_CD); /* clear to end of display */
2936 else if (*T_CE)
2937 out_str(T_CE); /* clear to end of line */
2940 else
2942 #ifdef FEAT_RIGHTLEFT
2943 if (cmdmsg_rl)
2945 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2946 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2948 else
2949 #endif
2951 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2952 ' ', ' ', 0);
2953 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2959 * Clear the command line.
2961 void
2962 msg_clr_cmdline()
2964 msg_row = cmdline_row;
2965 msg_col = 0;
2966 msg_clr_eos_force();
2970 * end putting a message on the screen
2971 * call wait_return if the message does not fit in the available space
2972 * return TRUE if wait_return not called.
2975 msg_end()
2978 * if the string is larger than the window,
2979 * or the ruler option is set and we run into it,
2980 * we have to redraw the window.
2981 * Do not do this if we are abandoning the file or editing the command line.
2983 if (!exiting && need_wait_return && !(State & CMDLINE))
2985 wait_return(FALSE);
2986 return FALSE;
2988 out_flush();
2989 return TRUE;
2993 * If the written message runs into the shown command or ruler, we have to
2994 * wait for hit-return and redraw the window later.
2996 void
2997 msg_check()
2999 if (msg_row == Rows - 1 && msg_col >= sc_col)
3001 need_wait_return = TRUE;
3002 redraw_cmdline = TRUE;
3007 * May write a string to the redirection file.
3008 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3010 static void
3011 redir_write(str, maxlen)
3012 char_u *str;
3013 int maxlen;
3015 char_u *s = str;
3016 static int cur_col = 0;
3018 /* Don't do anything for displaying prompts and the like. */
3019 if (redir_off)
3020 return;
3023 * If 'verbosefile' is set write message in that file.
3024 * Must come before the rest because of updating "msg_col".
3026 if (*p_vfile != NUL)
3027 verbose_write(s, maxlen);
3029 if (redirecting())
3031 /* If the string doesn't start with CR or NL, go to msg_col */
3032 if (*s != '\n' && *s != '\r')
3034 while (cur_col < msg_col)
3036 #ifdef FEAT_EVAL
3037 if (redir_reg)
3038 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
3039 else if (redir_vname)
3040 var_redir_str((char_u *)" ", -1);
3041 else if (redir_fd)
3042 #endif
3043 fputs(" ", redir_fd);
3044 ++cur_col;
3048 #ifdef FEAT_EVAL
3049 if (redir_reg)
3050 write_reg_contents(redir_reg, s, maxlen, TRUE);
3051 if (redir_vname)
3052 var_redir_str(s, maxlen);
3053 #endif
3055 /* Adjust the current column */
3056 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3058 #ifdef FEAT_EVAL
3059 if (!redir_reg && !redir_vname && redir_fd != NULL)
3060 #endif
3061 putc(*s, redir_fd);
3062 if (*s == '\r' || *s == '\n')
3063 cur_col = 0;
3064 else if (*s == '\t')
3065 cur_col += (8 - cur_col % 8);
3066 else
3067 ++cur_col;
3068 ++s;
3071 if (msg_silent != 0) /* should update msg_col */
3072 msg_col = cur_col;
3077 redirecting()
3079 return redir_fd != NULL
3080 #ifdef FEAT_EVAL
3081 || redir_reg || redir_vname
3082 #endif
3087 * Before giving verbose message.
3088 * Must always be called paired with verbose_leave()!
3090 void
3091 verbose_enter()
3093 if (*p_vfile != NUL)
3094 ++msg_silent;
3098 * After giving verbose message.
3099 * Must always be called paired with verbose_enter()!
3101 void
3102 verbose_leave()
3104 if (*p_vfile != NUL)
3105 if (--msg_silent < 0)
3106 msg_silent = 0;
3110 * Like verbose_enter() and set msg_scroll when displaying the message.
3112 void
3113 verbose_enter_scroll()
3115 if (*p_vfile != NUL)
3116 ++msg_silent;
3117 else
3118 /* always scroll up, don't overwrite */
3119 msg_scroll = TRUE;
3123 * Like verbose_leave() and set cmdline_row when displaying the message.
3125 void
3126 verbose_leave_scroll()
3128 if (*p_vfile != NUL)
3130 if (--msg_silent < 0)
3131 msg_silent = 0;
3133 else
3134 cmdline_row = msg_row;
3137 static FILE *verbose_fd = NULL;
3138 static int verbose_did_open = FALSE;
3141 * Called when 'verbosefile' is set: stop writing to the file.
3143 void
3144 verbose_stop()
3146 if (verbose_fd != NULL)
3148 fclose(verbose_fd);
3149 verbose_fd = NULL;
3151 verbose_did_open = FALSE;
3155 * Open the file 'verbosefile'.
3156 * Return FAIL or OK.
3159 verbose_open()
3161 if (verbose_fd == NULL && !verbose_did_open)
3163 /* Only give the error message once. */
3164 verbose_did_open = TRUE;
3166 verbose_fd = mch_fopen((char *)p_vfile, "a");
3167 if (verbose_fd == NULL)
3169 EMSG2(_(e_notopen), p_vfile);
3170 return FAIL;
3173 return OK;
3177 * Write a string to 'verbosefile'.
3178 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3180 static void
3181 verbose_write(str, maxlen)
3182 char_u *str;
3183 int maxlen;
3185 char_u *s = str;
3186 static int cur_col = 0;
3188 /* Open the file when called the first time. */
3189 if (verbose_fd == NULL)
3190 verbose_open();
3192 if (verbose_fd != NULL)
3194 /* If the string doesn't start with CR or NL, go to msg_col */
3195 if (*s != '\n' && *s != '\r')
3197 while (cur_col < msg_col)
3199 fputs(" ", verbose_fd);
3200 ++cur_col;
3204 /* Adjust the current column */
3205 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3207 putc(*s, verbose_fd);
3208 if (*s == '\r' || *s == '\n')
3209 cur_col = 0;
3210 else if (*s == '\t')
3211 cur_col += (8 - cur_col % 8);
3212 else
3213 ++cur_col;
3214 ++s;
3220 * Give a warning message (for searching).
3221 * Use 'w' highlighting and may repeat the message after redrawing
3223 void
3224 give_warning(message, hl)
3225 char_u *message;
3226 int hl;
3228 /* Don't do this for ":silent". */
3229 if (msg_silent != 0)
3230 return;
3232 /* Don't want a hit-enter prompt here. */
3233 ++no_wait_return;
3235 #ifdef FEAT_EVAL
3236 set_vim_var_string(VV_WARNINGMSG, message, -1);
3237 #endif
3238 vim_free(keep_msg);
3239 keep_msg = NULL;
3240 if (hl)
3241 keep_msg_attr = hl_attr(HLF_W);
3242 else
3243 keep_msg_attr = 0;
3244 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
3245 set_keep_msg(message, keep_msg_attr);
3246 msg_didout = FALSE; /* overwrite this message */
3247 msg_nowait = TRUE; /* don't wait for this message */
3248 msg_col = 0;
3250 --no_wait_return;
3254 * Advance msg cursor to column "col".
3256 void
3257 msg_advance(col)
3258 int col;
3260 if (msg_silent != 0) /* nothing to advance to */
3262 msg_col = col; /* for redirection, may fill it up later */
3263 return;
3265 if (col >= Columns) /* not enough room */
3266 col = Columns - 1;
3267 #ifdef FEAT_RIGHTLEFT
3268 if (cmdmsg_rl)
3269 while (msg_col > Columns - col)
3270 msg_putchar(' ');
3271 else
3272 #endif
3273 while (msg_col < col)
3274 msg_putchar(' ');
3277 #if defined(FEAT_CON_DIALOG) || defined(PROTO)
3279 * Used for "confirm()" function, and the :confirm command prefix.
3280 * Versions which haven't got flexible dialogs yet, and console
3281 * versions, get this generic handler which uses the command line.
3283 * type = one of:
3284 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3285 * title = title string (can be NULL for default)
3286 * (neither used in console dialogs at the moment)
3288 * Format of the "buttons" string:
3289 * "Button1Name\nButton2Name\nButton3Name"
3290 * The first button should normally be the default/accept
3291 * The second button should be the 'Cancel' button
3292 * Other buttons- use your imagination!
3293 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3294 * different letter.
3297 do_dialog(type, title, message, buttons, dfltbutton, textfield)
3298 int type UNUSED;
3299 char_u *title UNUSED;
3300 char_u *message;
3301 char_u *buttons;
3302 int dfltbutton;
3303 char_u *textfield UNUSED; /* IObuff for inputdialog(), NULL
3304 otherwise */
3306 int oldState;
3307 int retval = 0;
3308 char_u *hotkeys;
3309 int c;
3310 int i;
3312 #ifndef NO_CONSOLE
3313 /* Don't output anything in silent mode ("ex -s") */
3314 if (silent_mode)
3315 return dfltbutton; /* return default option */
3316 #endif
3318 #ifdef FEAT_GUI_DIALOG
3319 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3320 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3322 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3323 textfield);
3324 /* avoid a hit-enter prompt without clearing the cmdline */
3325 need_wait_return = FALSE;
3326 emsg_on_display = FALSE;
3327 cmdline_row = msg_row;
3329 /* Flush output to avoid that further messages and redrawing is done
3330 * in the wrong order. */
3331 out_flush();
3332 gui_mch_update();
3334 return c;
3336 #endif
3338 oldState = State;
3339 State = CONFIRM;
3340 #ifdef FEAT_MOUSE
3341 setmouse();
3342 #endif
3345 * Since we wait for a keypress, don't make the
3346 * user press RETURN as well afterwards.
3348 ++no_wait_return;
3349 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3351 if (hotkeys != NULL)
3353 for (;;)
3355 /* Get a typed character directly from the user. */
3356 c = get_keystroke();
3357 switch (c)
3359 case CAR: /* User accepts default option */
3360 case NL:
3361 retval = dfltbutton;
3362 break;
3363 case Ctrl_C: /* User aborts/cancels */
3364 case ESC:
3365 retval = 0;
3366 break;
3367 default: /* Could be a hotkey? */
3368 if (c < 0) /* special keys are ignored here */
3369 continue;
3370 /* Make the character lowercase, as chars in "hotkeys" are. */
3371 c = MB_TOLOWER(c);
3372 retval = 1;
3373 for (i = 0; hotkeys[i]; ++i)
3375 #ifdef FEAT_MBYTE
3376 if (has_mbyte)
3378 if ((*mb_ptr2char)(hotkeys + i) == c)
3379 break;
3380 i += (*mb_ptr2len)(hotkeys + i) - 1;
3382 else
3383 #endif
3384 if (hotkeys[i] == c)
3385 break;
3386 ++retval;
3388 if (hotkeys[i])
3389 break;
3390 /* No hotkey match, so keep waiting */
3391 continue;
3393 break;
3396 vim_free(hotkeys);
3399 State = oldState;
3400 #ifdef FEAT_MOUSE
3401 setmouse();
3402 #endif
3403 --no_wait_return;
3404 msg_end_prompt();
3406 return retval;
3409 static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3412 * Copy one character from "*from" to "*to", taking care of multi-byte
3413 * characters. Return the length of the character in bytes.
3415 static int
3416 copy_char(from, to, lowercase)
3417 char_u *from;
3418 char_u *to;
3419 int lowercase; /* make character lower case */
3421 #ifdef FEAT_MBYTE
3422 int len;
3423 int c;
3425 if (has_mbyte)
3427 if (lowercase)
3429 c = MB_TOLOWER((*mb_ptr2char)(from));
3430 return (*mb_char2bytes)(c, to);
3432 else
3434 len = (*mb_ptr2len)(from);
3435 mch_memmove(to, from, (size_t)len);
3436 return len;
3439 else
3440 #endif
3442 if (lowercase)
3443 *to = (char_u)TOLOWER_LOC(*from);
3444 else
3445 *to = *from;
3446 return 1;
3451 * Format the dialog string, and display it at the bottom of
3452 * the screen. Return a string of hotkey chars (if defined) for
3453 * each 'button'. If a button has no hotkey defined, the first character of
3454 * the button is used.
3455 * The hotkeys can be multi-byte characters, but without combining chars.
3457 * Returns an allocated string with hotkeys, or NULL for error.
3459 static char_u *
3460 msg_show_console_dialog(message, buttons, dfltbutton)
3461 char_u *message;
3462 char_u *buttons;
3463 int dfltbutton;
3465 int len = 0;
3466 #ifdef FEAT_MBYTE
3467 # define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3468 #else
3469 # define HOTK_LEN 1
3470 #endif
3471 int lenhotkey = HOTK_LEN; /* count first button */
3472 char_u *hotk = NULL;
3473 char_u *msgp = NULL;
3474 char_u *hotkp = NULL;
3475 char_u *r;
3476 int copy;
3477 #define HAS_HOTKEY_LEN 30
3478 char_u has_hotkey[HAS_HOTKEY_LEN];
3479 int first_hotkey = FALSE; /* first char of button is hotkey */
3480 int idx;
3482 has_hotkey[0] = FALSE;
3485 * First loop: compute the size of memory to allocate.
3486 * Second loop: copy to the allocated memory.
3488 for (copy = 0; copy <= 1; ++copy)
3490 r = buttons;
3491 idx = 0;
3492 while (*r)
3494 if (*r == DLG_BUTTON_SEP)
3496 if (copy)
3498 *msgp++ = ',';
3499 *msgp++ = ' '; /* '\n' -> ', ' */
3501 /* advance to next hotkey and set default hotkey */
3502 #ifdef FEAT_MBYTE
3503 if (has_mbyte)
3504 hotkp += STRLEN(hotkp);
3505 else
3506 #endif
3507 ++hotkp;
3508 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
3509 if (dfltbutton)
3510 --dfltbutton;
3512 /* If no hotkey is specified first char is used. */
3513 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3514 first_hotkey = TRUE;
3516 else
3518 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3519 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3520 if (idx < HAS_HOTKEY_LEN - 1)
3521 has_hotkey[++idx] = FALSE;
3524 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3526 if (*r == DLG_HOTKEY_CHAR)
3527 ++r;
3528 first_hotkey = FALSE;
3529 if (copy)
3531 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3532 *msgp++ = *r;
3533 else
3535 /* '&a' -> '[a]' */
3536 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3537 msgp += copy_char(r, msgp, FALSE);
3538 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3540 /* redefine hotkey */
3541 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
3544 else
3546 ++len; /* '&a' -> '[a]' */
3547 if (idx < HAS_HOTKEY_LEN - 1)
3548 has_hotkey[idx] = TRUE;
3551 else
3553 /* everything else copy literally */
3554 if (copy)
3555 msgp += copy_char(r, msgp, FALSE);
3558 /* advance to the next character */
3559 mb_ptr_adv(r);
3562 if (copy)
3564 *msgp++ = ':';
3565 *msgp++ = ' ';
3566 *msgp = NUL;
3568 else
3570 len += (int)(STRLEN(message)
3571 + 2 /* for the NL's */
3572 + STRLEN(buttons)
3573 + 3); /* for the ": " and NUL */
3574 lenhotkey++; /* for the NUL */
3576 /* If no hotkey is specified first char is used. */
3577 if (!has_hotkey[0])
3579 first_hotkey = TRUE;
3580 len += 2; /* "x" -> "[x]" */
3584 * Now allocate and load the strings
3586 vim_free(confirm_msg);
3587 confirm_msg = alloc(len);
3588 if (confirm_msg == NULL)
3589 return NULL;
3590 *confirm_msg = NUL;
3591 hotk = alloc(lenhotkey);
3592 if (hotk == NULL)
3593 return NULL;
3595 *confirm_msg = '\n';
3596 STRCPY(confirm_msg + 1, message);
3598 msgp = confirm_msg + 1 + STRLEN(message);
3599 hotkp = hotk;
3601 /* Define first default hotkey. Keep the hotkey string NUL
3602 * terminated to avoid reading past the end. */
3603 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
3605 /* Remember where the choices start, displaying starts here when
3606 * "hotkp" typed at the more prompt. */
3607 confirm_msg_tail = msgp;
3608 *msgp++ = '\n';
3612 display_confirm_msg();
3613 return hotk;
3617 * Display the ":confirm" message. Also called when screen resized.
3619 void
3620 display_confirm_msg()
3622 /* avoid that 'q' at the more prompt truncates the message here */
3623 ++confirm_msg_used;
3624 if (confirm_msg != NULL)
3625 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3626 --confirm_msg_used;
3629 #endif /* FEAT_CON_DIALOG */
3631 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3634 vim_dialog_yesno(type, title, message, dflt)
3635 int type;
3636 char_u *title;
3637 char_u *message;
3638 int dflt;
3640 if (do_dialog(type,
3641 title == NULL ? (char_u *)_("Question") : title,
3642 message,
3643 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3644 return VIM_YES;
3645 return VIM_NO;
3649 vim_dialog_yesnocancel(type, title, message, dflt)
3650 int type;
3651 char_u *title;
3652 char_u *message;
3653 int dflt;
3655 switch (do_dialog(type,
3656 title == NULL ? (char_u *)_("Question") : title,
3657 message,
3658 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3660 case 1: return VIM_YES;
3661 case 2: return VIM_NO;
3663 return VIM_CANCEL;
3667 vim_dialog_yesnoallcancel(type, title, message, dflt)
3668 int type;
3669 char_u *title;
3670 char_u *message;
3671 int dflt;
3673 switch (do_dialog(type,
3674 title == NULL ? (char_u *)"Question" : title,
3675 message,
3676 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3677 dflt, NULL))
3679 case 1: return VIM_YES;
3680 case 2: return VIM_NO;
3681 case 3: return VIM_ALL;
3682 case 4: return VIM_DISCARDALL;
3684 return VIM_CANCEL;
3687 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3689 #if defined(FEAT_BROWSE) || defined(PROTO)
3691 * Generic browse function. Calls gui_mch_browse() when possible.
3692 * Later this may pop-up a non-GUI file selector (external command?).
3694 char_u *
3695 do_browse(flags, title, dflt, ext, initdir, filter, buf)
3696 int flags; /* BROWSE_SAVE and BROWSE_DIR */
3697 char_u *title; /* title for the window */
3698 char_u *dflt; /* default file name (may include directory) */
3699 char_u *ext; /* extension added */
3700 char_u *initdir; /* initial directory, NULL for current dir or
3701 when using path from "dflt" */
3702 char_u *filter; /* file name filter */
3703 buf_T *buf; /* buffer to read/write for */
3705 char_u *fname;
3706 static char_u *last_dir = NULL; /* last used directory */
3707 char_u *tofree = NULL;
3708 int save_browse = cmdmod.browse;
3710 /* Must turn off browse to avoid that autocommands will get the
3711 * flag too! */
3712 cmdmod.browse = FALSE;
3714 if (title == NULL || *title == NUL)
3716 if (flags & BROWSE_DIR)
3717 title = (char_u *)_("Select Directory dialog");
3718 else if (flags & BROWSE_SAVE)
3719 title = (char_u *)_("Save File dialog");
3720 else
3721 title = (char_u *)_("Open File dialog");
3724 /* When no directory specified, use default file name, default dir, buffer
3725 * dir, last dir or current dir */
3726 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3728 if (mch_isdir(dflt)) /* default file name is a directory */
3730 initdir = dflt;
3731 dflt = NULL;
3733 else if (gettail(dflt) != dflt) /* default file name includes a path */
3735 tofree = vim_strsave(dflt);
3736 if (tofree != NULL)
3738 initdir = tofree;
3739 *gettail(initdir) = NUL;
3740 dflt = gettail(dflt);
3745 if (initdir == NULL || *initdir == NUL)
3747 /* When 'browsedir' is a directory, use it */
3748 if (STRCMP(p_bsdir, "last") != 0
3749 && STRCMP(p_bsdir, "buffer") != 0
3750 && STRCMP(p_bsdir, "current") != 0
3751 && mch_isdir(p_bsdir))
3752 initdir = p_bsdir;
3753 /* When saving or 'browsedir' is "buffer", use buffer fname */
3754 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
3755 && buf != NULL && buf->b_ffname != NULL)
3757 if (dflt == NULL || *dflt == NUL)
3758 dflt = gettail(curbuf->b_ffname);
3759 tofree = vim_strsave(curbuf->b_ffname);
3760 if (tofree != NULL)
3762 initdir = tofree;
3763 *gettail(initdir) = NUL;
3766 /* When 'browsedir' is "last", use dir from last browse */
3767 else if (*p_bsdir == 'l')
3768 initdir = last_dir;
3769 /* When 'browsedir is "current", use current directory. This is the
3770 * default already, leave initdir empty. */
3773 # ifdef FEAT_GUI
3774 if (gui.in_use) /* when this changes, also adjust f_has()! */
3776 if (filter == NULL
3777 # ifdef FEAT_EVAL
3778 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3779 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3780 # endif
3782 filter = BROWSE_FILTER_DEFAULT;
3783 if (flags & BROWSE_DIR)
3785 # if defined(HAVE_GTK2) || defined(WIN3264)
3786 /* For systems that have a directory dialog. */
3787 fname = gui_mch_browsedir(title, initdir);
3788 # else
3789 /* Generic solution for selecting a directory: select a file and
3790 * remove the file name. */
3791 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3792 # endif
3793 # if !defined(HAVE_GTK2)
3794 /* Win32 adds a dummy file name, others return an arbitrary file
3795 * name. GTK+ 2 returns only the directory, */
3796 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3798 /* Remove the file name. */
3799 char_u *tail = gettail_sep(fname);
3801 if (tail == fname)
3802 *tail++ = '.'; /* use current dir */
3803 *tail = NUL;
3805 # endif
3807 else
3808 fname = gui_mch_browse(flags & BROWSE_SAVE,
3809 title, dflt, ext, initdir, filter);
3811 /* We hang around in the dialog for a while, the user might do some
3812 * things to our files. The Win32 dialog allows deleting or renaming
3813 * a file, check timestamps. */
3814 need_check_timestamps = TRUE;
3815 did_check_timestamps = FALSE;
3817 else
3818 # endif
3820 /* TODO: non-GUI file selector here */
3821 EMSG(_("E338: Sorry, no file browser in console mode"));
3822 fname = NULL;
3825 /* keep the directory for next time */
3826 if (fname != NULL)
3828 vim_free(last_dir);
3829 last_dir = vim_strsave(fname);
3830 if (last_dir != NULL && !(flags & BROWSE_DIR))
3832 *gettail(last_dir) = NUL;
3833 if (*last_dir == NUL)
3835 /* filename only returned, must be in current dir */
3836 vim_free(last_dir);
3837 last_dir = alloc(MAXPATHL);
3838 if (last_dir != NULL)
3839 mch_dirname(last_dir, MAXPATHL);
3844 vim_free(tofree);
3845 cmdmod.browse = save_browse;
3847 return fname;
3849 #endif
3851 #if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3852 static char *e_printf = N_("E766: Insufficient arguments for printf()");
3854 static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3855 static char *tv_str __ARGS((typval_T *tvs, int *idxp));
3856 # ifdef FEAT_FLOAT
3857 static double tv_float __ARGS((typval_T *tvs, int *idxp));
3858 # endif
3861 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3863 static long
3864 tv_nr(tvs, idxp)
3865 typval_T *tvs;
3866 int *idxp;
3868 int idx = *idxp - 1;
3869 long n = 0;
3870 int err = FALSE;
3872 if (tvs[idx].v_type == VAR_UNKNOWN)
3873 EMSG(_(e_printf));
3874 else
3876 ++*idxp;
3877 n = get_tv_number_chk(&tvs[idx], &err);
3878 if (err)
3879 n = 0;
3881 return n;
3885 * Get string argument from "idxp" entry in "tvs". First entry is 1.
3886 * Returns NULL for an error.
3888 static char *
3889 tv_str(tvs, idxp)
3890 typval_T *tvs;
3891 int *idxp;
3893 int idx = *idxp - 1;
3894 char *s = NULL;
3896 if (tvs[idx].v_type == VAR_UNKNOWN)
3897 EMSG(_(e_printf));
3898 else
3900 ++*idxp;
3901 s = (char *)get_tv_string_chk(&tvs[idx]);
3903 return s;
3906 # ifdef FEAT_FLOAT
3908 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3910 static double
3911 tv_float(tvs, idxp)
3912 typval_T *tvs;
3913 int *idxp;
3915 int idx = *idxp - 1;
3916 double f = 0;
3918 if (tvs[idx].v_type == VAR_UNKNOWN)
3919 EMSG(_(e_printf));
3920 else
3922 ++*idxp;
3923 if (tvs[idx].v_type == VAR_FLOAT)
3924 f = tvs[idx].vval.v_float;
3925 else if (tvs[idx].v_type == VAR_NUMBER)
3926 f = tvs[idx].vval.v_number;
3927 else
3928 EMSG(_("E807: Expected Float argument for printf()"));
3930 return f;
3932 # endif
3933 #endif
3936 * This code was included to provide a portable vsnprintf() and snprintf().
3937 * Some systems may provide their own, but we always use this one for
3938 * consistency.
3940 * This code is based on snprintf.c - a portable implementation of snprintf
3941 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
3942 * Included with permission. It was heavily modified to fit in Vim.
3943 * The original code, including useful comments, can be found here:
3944 * http://www.ijs.si/software/snprintf/
3946 * This snprintf() only supports the following conversion specifiers:
3947 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3948 * with flags: '-', '+', ' ', '0' and '#'.
3949 * An asterisk is supported for field width as well as precision.
3951 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3953 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3954 * 'll' (long long int) is not supported.
3956 * The locale is not used, the string is used as a byte string. This is only
3957 * relevant for double-byte encodings where the second byte may be '%'.
3959 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3960 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
3962 * The return value is the number of characters which would be generated
3963 * for the given input, excluding the trailing null. If this value
3964 * is greater or equal to "str_m", not all characters from the result
3965 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3966 * are discarded. If "str_m" is greater than zero it is guaranteed
3967 * the resulting string will be null-terminated.
3971 * When va_list is not supported we only define vim_snprintf().
3973 * vim_vsnprintf() can be invoked with either "va_list" or a list of
3974 * "typval_T". When the latter is not used it must be NULL.
3977 /* When generating prototypes all of this is skipped, cproto doesn't
3978 * understand this. */
3979 #ifndef PROTO
3980 # ifdef HAVE_STDARG_H
3982 vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3984 va_list ap;
3985 int str_l;
3987 va_start(ap, fmt);
3988 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
3989 va_end(ap);
3990 return str_l;
3994 vim_vsnprintf(str, str_m, fmt, ap, tvs)
3995 # else
3996 /* clumsy way to work around missing va_list */
3997 # 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)
3999 /* VARARGS */
4001 #ifdef __BORLANDC__
4002 _RTLENTRYF
4003 #endif
4004 vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4005 # endif
4006 char *str;
4007 size_t str_m;
4008 char *fmt;
4009 # ifdef HAVE_STDARG_H
4010 va_list ap;
4011 typval_T *tvs;
4012 # else
4013 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4014 # endif
4016 size_t str_l = 0;
4017 char *p = fmt;
4018 int arg_idx = 1;
4020 if (p == NULL)
4021 p = "";
4022 while (*p != NUL)
4024 if (*p != '%')
4026 char *q = strchr(p + 1, '%');
4027 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
4029 /* Copy up to the next '%' or NUL without any changes. */
4030 if (str_l < str_m)
4032 size_t avail = str_m - str_l;
4034 mch_memmove(str + str_l, p, n > avail ? avail : n);
4036 p += n;
4037 str_l += n;
4039 else
4041 size_t min_field_width = 0, precision = 0;
4042 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4043 int alternate_form = 0, force_sign = 0;
4045 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4046 * ignored. */
4047 int space_for_positive = 1;
4049 /* allowed values: \0, h, l, L */
4050 char length_modifier = '\0';
4052 /* temporary buffer for simple numeric->string conversion */
4053 #ifdef FEAT_FLOAT
4054 # define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
4055 * That sounds reasonable to use as the maximum
4056 * printable. */
4057 #else
4058 # define TMP_LEN 32
4059 #endif
4060 char tmp[TMP_LEN];
4062 /* string address in case of string argument */
4063 char *str_arg;
4065 /* natural field width of arg without padding and sign */
4066 size_t str_arg_l;
4068 /* unsigned char argument value - only defined for c conversion.
4069 * N.B. standard explicitly states the char argument for the c
4070 * conversion is unsigned */
4071 unsigned char uchar_arg;
4073 /* number of zeros to be inserted for numeric conversions as
4074 * required by the precision or minimal field width */
4075 size_t number_of_zeros_to_pad = 0;
4077 /* index into tmp where zero padding is to be inserted */
4078 size_t zero_padding_insertion_ind = 0;
4080 /* current conversion specifier character */
4081 char fmt_spec = '\0';
4083 str_arg = NULL;
4084 p++; /* skip '%' */
4086 /* parse flags */
4087 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4088 || *p == '#' || *p == '\'')
4090 switch (*p)
4092 case '0': zero_padding = 1; break;
4093 case '-': justify_left = 1; break;
4094 case '+': force_sign = 1; space_for_positive = 0; break;
4095 case ' ': force_sign = 1;
4096 /* If both the ' ' and '+' flags appear, the ' '
4097 * flag should be ignored */
4098 break;
4099 case '#': alternate_form = 1; break;
4100 case '\'': break;
4102 p++;
4104 /* If the '0' and '-' flags both appear, the '0' flag should be
4105 * ignored. */
4107 /* parse field width */
4108 if (*p == '*')
4110 int j;
4112 p++;
4114 #ifndef HAVE_STDARG_H
4115 get_a_arg(arg_idx);
4116 #else
4117 # if defined(FEAT_EVAL)
4118 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4119 # endif
4120 va_arg(ap, int);
4121 #endif
4122 if (j >= 0)
4123 min_field_width = j;
4124 else
4126 min_field_width = -j;
4127 justify_left = 1;
4130 else if (VIM_ISDIGIT((int)(*p)))
4132 /* size_t could be wider than unsigned int; make sure we treat
4133 * argument like common implementations do */
4134 unsigned int uj = *p++ - '0';
4136 while (VIM_ISDIGIT((int)(*p)))
4137 uj = 10 * uj + (unsigned int)(*p++ - '0');
4138 min_field_width = uj;
4141 /* parse precision */
4142 if (*p == '.')
4144 p++;
4145 precision_specified = 1;
4146 if (*p == '*')
4148 int j;
4151 #ifndef HAVE_STDARG_H
4152 get_a_arg(arg_idx);
4153 #else
4154 # if defined(FEAT_EVAL)
4155 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4156 # endif
4157 va_arg(ap, int);
4158 #endif
4159 p++;
4160 if (j >= 0)
4161 precision = j;
4162 else
4164 precision_specified = 0;
4165 precision = 0;
4168 else if (VIM_ISDIGIT((int)(*p)))
4170 /* size_t could be wider than unsigned int; make sure we
4171 * treat argument like common implementations do */
4172 unsigned int uj = *p++ - '0';
4174 while (VIM_ISDIGIT((int)(*p)))
4175 uj = 10 * uj + (unsigned int)(*p++ - '0');
4176 precision = uj;
4180 /* parse 'h', 'l' and 'll' length modifiers */
4181 if (*p == 'h' || *p == 'l')
4183 length_modifier = *p;
4184 p++;
4185 if (length_modifier == 'l' && *p == 'l')
4187 /* double l = long long */
4188 length_modifier = 'l'; /* treat it as a single 'l' */
4189 p++;
4192 fmt_spec = *p;
4194 /* common synonyms: */
4195 switch (fmt_spec)
4197 case 'i': fmt_spec = 'd'; break;
4198 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4199 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4200 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4201 case 'F': fmt_spec = 'f'; break;
4202 default: break;
4205 /* get parameter value, do initial processing */
4206 switch (fmt_spec)
4208 /* '%' and 'c' behave similar to 's' regarding flags and field
4209 * widths */
4210 case '%':
4211 case 'c':
4212 case 's':
4213 length_modifier = '\0';
4214 str_arg_l = 1;
4215 switch (fmt_spec)
4217 case '%':
4218 str_arg = p;
4219 break;
4221 case 'c':
4223 int j;
4226 #ifndef HAVE_STDARG_H
4227 get_a_arg(arg_idx);
4228 #else
4229 # if defined(FEAT_EVAL)
4230 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4231 # endif
4232 va_arg(ap, int);
4233 #endif
4234 /* standard demands unsigned char */
4235 uchar_arg = (unsigned char)j;
4236 str_arg = (char *)&uchar_arg;
4237 break;
4240 case 's':
4241 str_arg =
4242 #ifndef HAVE_STDARG_H
4243 (char *)get_a_arg(arg_idx);
4244 #else
4245 # if defined(FEAT_EVAL)
4246 tvs != NULL ? tv_str(tvs, &arg_idx) :
4247 # endif
4248 va_arg(ap, char *);
4249 #endif
4250 if (str_arg == NULL)
4252 str_arg = "[NULL]";
4253 str_arg_l = 6;
4255 /* make sure not to address string beyond the specified
4256 * precision !!! */
4257 else if (!precision_specified)
4258 str_arg_l = strlen(str_arg);
4259 /* truncate string if necessary as requested by precision */
4260 else if (precision == 0)
4261 str_arg_l = 0;
4262 else
4264 /* Don't put the #if inside memchr(), it can be a
4265 * macro. */
4266 #if SIZEOF_INT <= 2
4267 char *q = memchr(str_arg, '\0', precision);
4268 #else
4269 /* memchr on HP does not like n > 2^31 !!! */
4270 char *q = memchr(str_arg, '\0',
4271 precision <= (size_t)0x7fffffffL ? precision
4272 : (size_t)0x7fffffffL);
4273 #endif
4274 str_arg_l = (q == NULL) ? precision
4275 : (size_t)(q - str_arg);
4277 break;
4279 default:
4280 break;
4282 break;
4284 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4286 /* NOTE: the u, o, x, X and p conversion specifiers
4287 * imply the value is unsigned; d implies a signed
4288 * value */
4290 /* 0 if numeric argument is zero (or if pointer is
4291 * NULL for 'p'), +1 if greater than zero (or nonzero
4292 * for unsigned arguments), -1 if negative (unsigned
4293 * argument is never negative) */
4294 int arg_sign = 0;
4296 /* only defined for length modifier h, or for no
4297 * length modifiers */
4298 int int_arg = 0;
4299 unsigned int uint_arg = 0;
4301 /* only defined for length modifier l */
4302 long int long_arg = 0;
4303 unsigned long int ulong_arg = 0;
4305 /* pointer argument value -only defined for p
4306 * conversion */
4307 void *ptr_arg = NULL;
4309 if (fmt_spec == 'p')
4311 length_modifier = '\0';
4312 ptr_arg =
4313 #ifndef HAVE_STDARG_H
4314 (void *)get_a_arg(arg_idx);
4315 #else
4316 # if defined(FEAT_EVAL)
4317 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
4318 # endif
4319 va_arg(ap, void *);
4320 #endif
4321 if (ptr_arg != NULL)
4322 arg_sign = 1;
4324 else if (fmt_spec == 'd')
4326 /* signed */
4327 switch (length_modifier)
4329 case '\0':
4330 case 'h':
4331 /* char and short arguments are passed as int. */
4332 int_arg =
4333 #ifndef HAVE_STDARG_H
4334 get_a_arg(arg_idx);
4335 #else
4336 # if defined(FEAT_EVAL)
4337 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4338 # endif
4339 va_arg(ap, int);
4340 #endif
4341 if (int_arg > 0)
4342 arg_sign = 1;
4343 else if (int_arg < 0)
4344 arg_sign = -1;
4345 break;
4346 case 'l':
4347 long_arg =
4348 #ifndef HAVE_STDARG_H
4349 get_a_arg(arg_idx);
4350 #else
4351 # if defined(FEAT_EVAL)
4352 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4353 # endif
4354 va_arg(ap, long int);
4355 #endif
4356 if (long_arg > 0)
4357 arg_sign = 1;
4358 else if (long_arg < 0)
4359 arg_sign = -1;
4360 break;
4363 else
4365 /* unsigned */
4366 switch (length_modifier)
4368 case '\0':
4369 case 'h':
4370 uint_arg =
4371 #ifndef HAVE_STDARG_H
4372 get_a_arg(arg_idx);
4373 #else
4374 # if defined(FEAT_EVAL)
4375 tvs != NULL ? (unsigned)
4376 tv_nr(tvs, &arg_idx) :
4377 # endif
4378 va_arg(ap, unsigned int);
4379 #endif
4380 if (uint_arg != 0)
4381 arg_sign = 1;
4382 break;
4383 case 'l':
4384 ulong_arg =
4385 #ifndef HAVE_STDARG_H
4386 get_a_arg(arg_idx);
4387 #else
4388 # if defined(FEAT_EVAL)
4389 tvs != NULL ? (unsigned long)
4390 tv_nr(tvs, &arg_idx) :
4391 # endif
4392 va_arg(ap, unsigned long int);
4393 #endif
4394 if (ulong_arg != 0)
4395 arg_sign = 1;
4396 break;
4400 str_arg = tmp;
4401 str_arg_l = 0;
4403 /* NOTE:
4404 * For d, i, u, o, x, and X conversions, if precision is
4405 * specified, the '0' flag should be ignored. This is so
4406 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4407 * FreeBSD, NetBSD; but not with Perl.
4409 if (precision_specified)
4410 zero_padding = 0;
4411 if (fmt_spec == 'd')
4413 if (force_sign && arg_sign >= 0)
4414 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4415 /* leave negative numbers for sprintf to handle, to
4416 * avoid handling tricky cases like (short int)-32768 */
4418 else if (alternate_form)
4420 if (arg_sign != 0
4421 && (fmt_spec == 'x' || fmt_spec == 'X') )
4423 tmp[str_arg_l++] = '0';
4424 tmp[str_arg_l++] = fmt_spec;
4426 /* alternate form should have no effect for p
4427 * conversion, but ... */
4430 zero_padding_insertion_ind = str_arg_l;
4431 if (!precision_specified)
4432 precision = 1; /* default precision is 1 */
4433 if (precision == 0 && arg_sign == 0)
4435 /* When zero value is formatted with an explicit
4436 * precision 0, the resulting formatted string is
4437 * empty (d, i, u, o, x, X, p). */
4439 else
4441 char f[5];
4442 int f_l = 0;
4444 /* construct a simple format string for sprintf */
4445 f[f_l++] = '%';
4446 if (!length_modifier)
4448 else if (length_modifier == '2')
4450 f[f_l++] = 'l';
4451 f[f_l++] = 'l';
4453 else
4454 f[f_l++] = length_modifier;
4455 f[f_l++] = fmt_spec;
4456 f[f_l++] = '\0';
4458 if (fmt_spec == 'p')
4459 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4460 else if (fmt_spec == 'd')
4462 /* signed */
4463 switch (length_modifier)
4465 case '\0':
4466 case 'h': str_arg_l += sprintf(
4467 tmp + str_arg_l, f, int_arg);
4468 break;
4469 case 'l': str_arg_l += sprintf(
4470 tmp + str_arg_l, f, long_arg);
4471 break;
4474 else
4476 /* unsigned */
4477 switch (length_modifier)
4479 case '\0':
4480 case 'h': str_arg_l += sprintf(
4481 tmp + str_arg_l, f, uint_arg);
4482 break;
4483 case 'l': str_arg_l += sprintf(
4484 tmp + str_arg_l, f, ulong_arg);
4485 break;
4489 /* include the optional minus sign and possible
4490 * "0x" in the region before the zero padding
4491 * insertion point */
4492 if (zero_padding_insertion_ind < str_arg_l
4493 && tmp[zero_padding_insertion_ind] == '-')
4494 zero_padding_insertion_ind++;
4495 if (zero_padding_insertion_ind + 1 < str_arg_l
4496 && tmp[zero_padding_insertion_ind] == '0'
4497 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4498 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4499 zero_padding_insertion_ind += 2;
4503 size_t num_of_digits = str_arg_l
4504 - zero_padding_insertion_ind;
4506 if (alternate_form && fmt_spec == 'o'
4507 /* unless zero is already the first
4508 * character */
4509 && !(zero_padding_insertion_ind < str_arg_l
4510 && tmp[zero_padding_insertion_ind] == '0'))
4512 /* assure leading zero for alternate-form
4513 * octal numbers */
4514 if (!precision_specified
4515 || precision < num_of_digits + 1)
4517 /* precision is increased to force the
4518 * first character to be zero, except if a
4519 * zero value is formatted with an
4520 * explicit precision of zero */
4521 precision = num_of_digits + 1;
4522 precision_specified = 1;
4525 /* zero padding to specified precision? */
4526 if (num_of_digits < precision)
4527 number_of_zeros_to_pad = precision - num_of_digits;
4529 /* zero padding to specified minimal field width? */
4530 if (!justify_left && zero_padding)
4532 int n = (int)(min_field_width - (str_arg_l
4533 + number_of_zeros_to_pad));
4534 if (n > 0)
4535 number_of_zeros_to_pad += n;
4537 break;
4540 #ifdef FEAT_FLOAT
4541 case 'f':
4542 case 'e':
4543 case 'E':
4544 case 'g':
4545 case 'G':
4547 /* Floating point. */
4548 double f;
4549 double abs_f;
4550 char format[40];
4551 int l;
4552 int remove_trailing_zeroes = FALSE;
4555 # ifndef HAVE_STDARG_H
4556 get_a_arg(arg_idx);
4557 # else
4558 # if defined(FEAT_EVAL)
4559 tvs != NULL ? tv_float(tvs, &arg_idx) :
4560 # endif
4561 va_arg(ap, double);
4562 # endif
4563 abs_f = f < 0 ? -f : f;
4565 if (fmt_spec == 'g' || fmt_spec == 'G')
4567 /* Would be nice to use %g directly, but it prints
4568 * "1.0" as "1", we don't want that. */
4569 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4570 || abs_f == 0.0)
4571 fmt_spec = 'f';
4572 else
4573 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4574 remove_trailing_zeroes = TRUE;
4577 if (fmt_spec == 'f' &&
4578 #ifdef VAX
4579 abs_f > 1.0e38
4580 #else
4581 abs_f > 1.0e307
4582 #endif
4585 /* Avoid a buffer overflow */
4586 strcpy(tmp, "inf");
4587 str_arg_l = 3;
4589 else
4591 format[0] = '%';
4592 l = 1;
4593 if (precision_specified)
4595 size_t max_prec = TMP_LEN - 10;
4597 /* Make sure we don't get more digits than we
4598 * have room for. */
4599 if (fmt_spec == 'f' && abs_f > 1.0)
4600 max_prec -= (size_t)log10(abs_f);
4601 if (precision > max_prec)
4602 precision = max_prec;
4603 l += sprintf(format + 1, ".%d", (int)precision);
4605 format[l] = fmt_spec;
4606 format[l + 1] = NUL;
4607 str_arg_l = sprintf(tmp, format, f);
4609 if (remove_trailing_zeroes)
4611 int i;
4612 char *tp;
4614 /* Using %g or %G: remove superfluous zeroes. */
4615 if (fmt_spec == 'f')
4616 tp = tmp + str_arg_l - 1;
4617 else
4619 tp = (char *)vim_strchr((char_u *)tmp,
4620 fmt_spec == 'e' ? 'e' : 'E');
4621 if (tp != NULL)
4623 /* Remove superfluous '+' and leading
4624 * zeroes from the exponent. */
4625 if (tp[1] == '+')
4627 /* Change "1.0e+07" to "1.0e07" */
4628 STRMOVE(tp + 1, tp + 2);
4629 --str_arg_l;
4631 i = (tp[1] == '-') ? 2 : 1;
4632 while (tp[i] == '0')
4634 /* Change "1.0e07" to "1.0e7" */
4635 STRMOVE(tp + i, tp + i + 1);
4636 --str_arg_l;
4638 --tp;
4642 if (tp != NULL && !precision_specified)
4643 /* Remove trailing zeroes, but keep the one
4644 * just after a dot. */
4645 while (tp > tmp + 2 && *tp == '0'
4646 && tp[-1] != '.')
4648 STRMOVE(tp, tp + 1);
4649 --tp;
4650 --str_arg_l;
4653 else
4655 char *tp;
4657 /* Be consistent: some printf("%e") use 1.0e+12
4658 * and some 1.0e+012. Remove one zero in the last
4659 * case. */
4660 tp = (char *)vim_strchr((char_u *)tmp,
4661 fmt_spec == 'e' ? 'e' : 'E');
4662 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4663 && tp[2] == '0'
4664 && vim_isdigit(tp[3])
4665 && vim_isdigit(tp[4]))
4667 STRMOVE(tp + 2, tp + 3);
4668 --str_arg_l;
4672 str_arg = tmp;
4673 break;
4675 #endif
4677 default:
4678 /* unrecognized conversion specifier, keep format string
4679 * as-is */
4680 zero_padding = 0; /* turn zero padding off for non-numeric
4681 conversion */
4682 justify_left = 1;
4683 min_field_width = 0; /* reset flags */
4685 /* discard the unrecognized conversion, just keep *
4686 * the unrecognized conversion character */
4687 str_arg = p;
4688 str_arg_l = 0;
4689 if (*p != NUL)
4690 str_arg_l++; /* include invalid conversion specifier
4691 unchanged if not at end-of-string */
4692 break;
4695 if (*p != NUL)
4696 p++; /* step over the just processed conversion specifier */
4698 /* insert padding to the left as requested by min_field_width;
4699 * this does not include the zero padding in case of numerical
4700 * conversions*/
4701 if (!justify_left)
4703 /* left padding with blank or zero */
4704 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4706 if (pn > 0)
4708 if (str_l < str_m)
4710 size_t avail = str_m - str_l;
4712 vim_memset(str + str_l, zero_padding ? '0' : ' ',
4713 (size_t)pn > avail ? avail
4714 : (size_t)pn);
4716 str_l += pn;
4720 /* zero padding as requested by the precision or by the minimal
4721 * field width for numeric conversions required? */
4722 if (number_of_zeros_to_pad == 0)
4724 /* will not copy first part of numeric right now, *
4725 * force it to be copied later in its entirety */
4726 zero_padding_insertion_ind = 0;
4728 else
4730 /* insert first part of numerics (sign or '0x') before zero
4731 * padding */
4732 int zn = (int)zero_padding_insertion_ind;
4734 if (zn > 0)
4736 if (str_l < str_m)
4738 size_t avail = str_m - str_l;
4740 mch_memmove(str + str_l, str_arg,
4741 (size_t)zn > avail ? avail
4742 : (size_t)zn);
4744 str_l += zn;
4747 /* insert zero padding as requested by the precision or min
4748 * field width */
4749 zn = (int)number_of_zeros_to_pad;
4750 if (zn > 0)
4752 if (str_l < str_m)
4754 size_t avail = str_m-str_l;
4756 vim_memset(str + str_l, '0',
4757 (size_t)zn > avail ? avail
4758 : (size_t)zn);
4760 str_l += zn;
4764 /* insert formatted string
4765 * (or as-is conversion specifier for unknown conversions) */
4767 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
4769 if (sn > 0)
4771 if (str_l < str_m)
4773 size_t avail = str_m - str_l;
4775 mch_memmove(str + str_l,
4776 str_arg + zero_padding_insertion_ind,
4777 (size_t)sn > avail ? avail : (size_t)sn);
4779 str_l += sn;
4783 /* insert right padding */
4784 if (justify_left)
4786 /* right blank padding to the field width */
4787 int pn = (int)(min_field_width
4788 - (str_arg_l + number_of_zeros_to_pad));
4790 if (pn > 0)
4792 if (str_l < str_m)
4794 size_t avail = str_m - str_l;
4796 vim_memset(str + str_l, ' ',
4797 (size_t)pn > avail ? avail
4798 : (size_t)pn);
4800 str_l += pn;
4806 if (str_m > 0)
4808 /* make sure the string is nul-terminated even at the expense of
4809 * overwriting the last character (shouldn't happen, but just in case)
4810 * */
4811 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4814 #ifdef HAVE_STDARG_H
4815 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
4816 EMSG(_("E767: Too many arguments to printf()"));
4817 #endif
4819 /* Return the number of characters formatted (excluding trailing nul
4820 * character), that is, the number of characters that would have been
4821 * written to the buffer if it were large enough. */
4822 return (int)str_l;
4825 #endif /* PROTO */