Merged from the latest developing branch.
[MacVim.git] / src / message.c
blobb2daa90e22ef902a246b9d22874ef33bc97c0ccb
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 static int other_sourcing_name __ARGS((void));
19 static char_u *get_emsg_source __ARGS((void));
20 static char_u *get_emsg_lnum __ARGS((void));
21 static void add_msg_hist __ARGS((char_u *s, int len, int attr));
22 static void hit_return_msg __ARGS((void));
23 static void msg_home_replace_attr __ARGS((char_u *fname, int attr));
24 #ifdef FEAT_MBYTE
25 static char_u *screen_puts_mbyte __ARGS((char_u *s, int l, int attr));
26 #endif
27 static void msg_puts_attr_len __ARGS((char_u *str, int maxlen, int attr));
28 static void msg_puts_display __ARGS((char_u *str, int maxlen, int attr, int recurse));
29 static void msg_scroll_up __ARGS((void));
30 static void inc_msg_scrolled __ARGS((void));
31 static void store_sb_text __ARGS((char_u **sb_str, char_u *s, int attr, int *sb_col, int finish));
32 static void t_puts __ARGS((int *t_col, char_u *t_s, char_u *s, int attr));
33 static void msg_puts_printf __ARGS((char_u *str, int maxlen));
34 static int do_more_prompt __ARGS((int typed_char));
35 static void msg_screen_putchar __ARGS((int c, int attr));
36 static int msg_check_screen __ARGS((void));
37 static void redir_write __ARGS((char_u *s, int maxlen));
38 static void verbose_write __ARGS((char_u *s, int maxlen));
39 #ifdef FEAT_CON_DIALOG
40 static char_u *msg_show_console_dialog __ARGS((char_u *message, char_u *buttons, int dfltbutton));
41 static int confirm_msg_used = FALSE; /* displaying confirm_msg */
42 static char_u *confirm_msg = NULL; /* ":confirm" message */
43 static char_u *confirm_msg_tail; /* tail of confirm_msg */
44 #endif
46 struct msg_hist
48 struct msg_hist *next;
49 char_u *msg;
50 int attr;
53 static struct msg_hist *first_msg_hist = NULL;
54 static struct msg_hist *last_msg_hist = NULL;
55 static int msg_hist_len = 0;
58 * When writing messages to the screen, there are many different situations.
59 * A number of variables is used to remember the current state:
60 * msg_didany TRUE when messages were written since the last time the
61 * user reacted to a prompt.
62 * Reset: After hitting a key for the hit-return prompt,
63 * hitting <CR> for the command line or input().
64 * Set: When any message is written to the screen.
65 * msg_didout TRUE when something was written to the current line.
66 * Reset: When advancing to the next line, when the current
67 * text can be overwritten.
68 * Set: When any message is written to the screen.
69 * msg_nowait No extra delay for the last drawn message.
70 * Used in normal_cmd() before the mode message is drawn.
71 * emsg_on_display There was an error message recently. Indicates that there
72 * should be a delay before redrawing.
73 * msg_scroll The next message should not overwrite the current one.
74 * msg_scrolled How many lines the screen has been scrolled (because of
75 * messages). Used in update_screen() to scroll the screen
76 * back. Incremented each time the screen scrolls a line.
77 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
78 * writes something without scrolling should not make
79 * need_wait_return to be set. This is a hack to make ":ts"
80 * work without an extra prompt.
81 * lines_left Number of lines available for messages before the
82 * more-prompt is to be given.
83 * need_wait_return TRUE when the hit-return prompt is needed.
84 * Reset: After giving the hit-return prompt, when the user
85 * has answered some other prompt.
86 * Set: When the ruler or typeahead display is overwritten,
87 * scrolling the screen for some message.
88 * keep_msg Message to be displayed after redrawing the screen, in
89 * main_loop().
90 * This is an allocated string or NULL when not used.
94 * msg(s) - displays the string 's' on the status line
95 * When terminal not initialized (yet) mch_errmsg(..) is used.
96 * return TRUE if wait_return not called
98 int
99 msg(s)
100 char_u *s;
102 return msg_attr_keep(s, 0, FALSE);
105 #if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
106 || defined(PROTO)
108 * Like msg() but keep it silent when 'verbosefile' is set.
111 verb_msg(s)
112 char_u *s;
114 int n;
116 verbose_enter();
117 n = msg_attr_keep(s, 0, FALSE);
118 verbose_leave();
120 return n;
122 #endif
125 msg_attr(s, attr)
126 char_u *s;
127 int attr;
129 return msg_attr_keep(s, attr, FALSE);
133 msg_attr_keep(s, attr, keep)
134 char_u *s;
135 int attr;
136 int keep; /* TRUE: set keep_msg if it doesn't scroll */
138 static int entered = 0;
139 int retval;
140 char_u *buf = NULL;
142 #ifdef FEAT_EVAL
143 if (attr == 0)
144 set_vim_var_string(VV_STATUSMSG, s, -1);
145 #endif
148 * It is possible that displaying a messages causes a problem (e.g.,
149 * when redrawing the window), which causes another message, etc.. To
150 * break this loop, limit the recursiveness to 3 levels.
152 if (entered >= 3)
153 return TRUE;
154 ++entered;
156 /* Add message to history (unless it's a repeated kept message or a
157 * truncated message) */
158 if (s != keep_msg
159 || (*s != '<'
160 && last_msg_hist != NULL
161 && last_msg_hist->msg != NULL
162 && STRCMP(s, last_msg_hist->msg)))
163 add_msg_hist(s, -1, attr);
165 /* When displaying keep_msg, don't let msg_start() free it, caller must do
166 * that. */
167 if (s == keep_msg)
168 keep_msg = NULL;
170 /* Truncate the message if needed. */
171 msg_start();
172 buf = msg_strtrunc(s, FALSE);
173 if (buf != NULL)
174 s = buf;
176 msg_outtrans_attr(s, attr);
177 msg_clr_eos();
178 retval = msg_end();
180 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
181 * Columns + sc_col)
182 set_keep_msg(s, 0);
184 vim_free(buf);
185 --entered;
186 return retval;
190 * Truncate a string such that it can be printed without causing a scroll.
191 * Returns an allocated string or NULL when no truncating is done.
193 char_u *
194 msg_strtrunc(s, force)
195 char_u *s;
196 int force; /* always truncate */
198 char_u *buf = NULL;
199 int len;
200 int room;
202 /* May truncate message to avoid a hit-return prompt */
203 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
204 && !exmode_active && msg_silent == 0) || force)
206 len = vim_strsize(s);
207 if (msg_scrolled != 0)
208 /* Use all the columns. */
209 room = (int)(Rows - msg_row) * Columns - 1;
210 else
211 /* Use up to 'showcmd' column. */
212 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
213 if (len > room && room > 0)
215 #ifdef FEAT_MBYTE
216 if (enc_utf8)
217 /* may have up to 18 bytes per cell (6 per char, up to two
218 * composing chars) */
219 buf = alloc((room + 2) * 18);
220 else if (enc_dbcs == DBCS_JPNU)
221 /* may have up to 2 bytes per cell for euc-jp */
222 buf = alloc((room + 2) * 2);
223 else
224 #endif
225 buf = alloc(room + 2);
226 if (buf != NULL)
227 trunc_string(s, buf, room);
230 return buf;
234 * Truncate a string "s" to "buf" with cell width "room".
235 * "s" and "buf" may be equal.
237 void
238 trunc_string(s, buf, room)
239 char_u *s;
240 char_u *buf;
241 int room;
243 int half;
244 int len;
245 int e;
246 int i;
247 int n;
249 room -= 3;
250 half = room / 2;
251 len = 0;
253 /* First part: Start of the string. */
254 for (e = 0; len < half; ++e)
256 if (s[e] == NUL)
258 /* text fits without truncating! */
259 buf[e] = NUL;
260 return;
262 n = ptr2cells(s + e);
263 if (len + n >= half)
264 break;
265 len += n;
266 buf[e] = s[e];
267 #ifdef FEAT_MBYTE
268 if (has_mbyte)
269 for (n = (*mb_ptr2len)(s + e); --n > 0; )
271 ++e;
272 buf[e] = s[e];
274 #endif
277 /* Last part: End of the string. */
278 i = e;
279 #ifdef FEAT_MBYTE
280 if (enc_dbcs != 0)
282 /* For DBCS going backwards in a string is slow, but
283 * computing the cell width isn't too slow: go forward
284 * until the rest fits. */
285 n = vim_strsize(s + i);
286 while (len + n > room)
288 n -= ptr2cells(s + i);
289 i += (*mb_ptr2len)(s + i);
292 else if (enc_utf8)
294 /* For UTF-8 we can go backwards easily. */
295 half = i = (int)STRLEN(s);
296 for (;;)
299 half = half - (*mb_head_off)(s, s + half - 1) - 1;
300 while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
301 n = ptr2cells(s + half);
302 if (len + n > room)
303 break;
304 len += n;
305 i = half;
308 else
309 #endif
311 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
312 len += n;
315 /* Set the middle and copy the last part. */
316 mch_memmove(buf + e, "...", (size_t)3);
317 mch_memmove(buf + e + 3, s + i, STRLEN(s + i) + 1);
321 * Automatic prototype generation does not understand this function.
322 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
323 * shorter than IOSIZE!!!
325 #ifndef PROTO
326 # ifndef HAVE_STDARG_H
329 #ifdef __BORLANDC__
330 _RTLENTRYF
331 #endif
332 smsg __ARGS((char_u *, long, long, long,
333 long, long, long, long, long, long, long));
335 #ifdef __BORLANDC__
336 _RTLENTRYF
337 #endif
338 smsg_attr __ARGS((int, char_u *, long, long, long,
339 long, long, long, long, long, long, long));
341 int vim_snprintf __ARGS((char *, size_t, char *, long, long, long,
342 long, long, long, long, long, long, long));
345 * smsg(str, arg, ...) is like using sprintf(buf, str, arg, ...) and then
346 * calling msg(buf).
347 * The buffer used is IObuff, the message is truncated at IOSIZE.
350 /* VARARGS */
352 #ifdef __BORLANDC__
353 _RTLENTRYF
354 #endif
355 smsg(s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
356 char_u *s;
357 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
359 return smsg_attr(0, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
362 /* VARARGS */
364 #ifdef __BORLANDC__
365 _RTLENTRYF
366 #endif
367 smsg_attr(attr, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
368 int attr;
369 char_u *s;
370 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
372 vim_snprintf((char *)IObuff, IOSIZE, (char *)s,
373 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
374 return msg_attr(IObuff, attr);
377 # else /* HAVE_STDARG_H */
379 int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
382 #ifdef __BORLANDC__
383 _RTLENTRYF
384 #endif
385 smsg(char_u *s, ...)
387 va_list arglist;
389 va_start(arglist, s);
390 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
391 va_end(arglist);
392 return msg(IObuff);
396 #ifdef __BORLANDC__
397 _RTLENTRYF
398 #endif
399 smsg_attr(int attr, char_u *s, ...)
401 va_list arglist;
403 va_start(arglist, s);
404 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
405 va_end(arglist);
406 return msg_attr(IObuff, attr);
409 # endif /* HAVE_STDARG_H */
410 #endif
413 * Remember the last sourcing name/lnum used in an error message, so that it
414 * isn't printed each time when it didn't change.
416 static int last_sourcing_lnum = 0;
417 static char_u *last_sourcing_name = NULL;
420 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
421 * for the next error message;
423 void
424 reset_last_sourcing()
426 vim_free(last_sourcing_name);
427 last_sourcing_name = NULL;
428 last_sourcing_lnum = 0;
432 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
434 static int
435 other_sourcing_name()
437 if (sourcing_name != NULL)
439 if (last_sourcing_name != NULL)
440 return STRCMP(sourcing_name, last_sourcing_name) != 0;
441 return TRUE;
443 return FALSE;
447 * Get the message about the source, as used for an error message.
448 * Returns an allocated string with room for one more character.
449 * Returns NULL when no message is to be given.
451 static char_u *
452 get_emsg_source()
454 char_u *Buf, *p;
456 if (sourcing_name != NULL && other_sourcing_name())
458 p = (char_u *)_("Error detected while processing %s:");
459 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
460 if (Buf != NULL)
461 sprintf((char *)Buf, (char *)p, sourcing_name);
462 return Buf;
464 return NULL;
468 * Get the message about the source lnum, as used for an error message.
469 * Returns an allocated string with room for one more character.
470 * Returns NULL when no message is to be given.
472 static char_u *
473 get_emsg_lnum()
475 char_u *Buf, *p;
477 /* lnum is 0 when executing a command from the command line
478 * argument, we don't want a line number then */
479 if (sourcing_name != NULL
480 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
481 && sourcing_lnum != 0)
483 p = (char_u *)_("line %4ld:");
484 Buf = alloc((unsigned)(STRLEN(p) + 20));
485 if (Buf != NULL)
486 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
487 return Buf;
489 return NULL;
493 * Display name and line number for the source of an error.
494 * Remember the file name and line number, so that for the next error the info
495 * is only displayed if it changed.
497 void
498 msg_source(attr)
499 int attr;
501 char_u *p;
503 ++no_wait_return;
504 p = get_emsg_source();
505 if (p != NULL)
507 msg_attr(p, attr);
508 vim_free(p);
510 p = get_emsg_lnum();
511 if (p != NULL)
513 msg_attr(p, hl_attr(HLF_N));
514 vim_free(p);
515 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
518 /* remember the last sourcing name printed, also when it's empty */
519 if (sourcing_name == NULL || other_sourcing_name())
521 vim_free(last_sourcing_name);
522 if (sourcing_name == NULL)
523 last_sourcing_name = NULL;
524 else
525 last_sourcing_name = vim_strsave(sourcing_name);
527 --no_wait_return;
531 * Return TRUE if not giving error messages right now:
532 * If "emsg_off" is set: no error messages at the moment.
533 * If "msg" is in 'debug': do error message but without side effects.
534 * If "emsg_skip" is set: never do error messages.
537 emsg_not_now()
539 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
540 && vim_strchr(p_debug, 't') == NULL)
541 #ifdef FEAT_EVAL
542 || emsg_skip > 0
543 #endif
545 return TRUE;
546 return FALSE;
550 * emsg() - display an error message
552 * Rings the bell, if appropriate, and calls message() to do the real work
553 * When terminal not initialized (yet) mch_errmsg(..) is used.
555 * return TRUE if wait_return not called
558 emsg(s)
559 char_u *s;
561 int attr;
562 char_u *p;
563 #ifdef FEAT_EVAL
564 int ignore = FALSE;
565 int severe;
566 #endif
568 called_emsg = TRUE;
569 ex_exitval = 1;
572 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
573 * prefer this message over previous messages for the same command.
575 #ifdef FEAT_EVAL
576 severe = emsg_severe;
577 emsg_severe = FALSE;
578 #endif
580 /* Skip this if not giving error messages at the moment. */
581 if (emsg_not_now())
582 return TRUE;
584 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
586 #ifdef FEAT_EVAL
588 * Cause a throw of an error exception if appropriate. Don't display
589 * the error message in this case. (If no matching catch clause will
590 * be found, the message will be displayed later on.) "ignore" is set
591 * when the message should be ignored completely (used for the
592 * interrupt message).
594 if (cause_errthrow(s, severe, &ignore) == TRUE)
596 if (!ignore)
597 did_emsg = TRUE;
598 return TRUE;
601 /* set "v:errmsg", also when using ":silent! cmd" */
602 set_vim_var_string(VV_ERRMSG, s, -1);
603 #endif
606 * When using ":silent! cmd" ignore error messsages.
607 * But do write it to the redirection file.
609 if (emsg_silent != 0)
611 msg_start();
612 p = get_emsg_source();
613 if (p != NULL)
615 STRCAT(p, "\n");
616 redir_write(p, -1);
617 vim_free(p);
619 p = get_emsg_lnum();
620 if (p != NULL)
622 STRCAT(p, "\n");
623 redir_write(p, -1);
624 vim_free(p);
626 redir_write(s, -1);
627 return TRUE;
630 /* Reset msg_silent, an error causes messages to be switched back on. */
631 msg_silent = 0;
632 cmd_silent = FALSE;
634 if (global_busy) /* break :global command */
635 ++global_busy;
637 if (p_eb)
638 beep_flush(); /* also includes flush_buffers() */
639 else
640 flush_buffers(FALSE); /* flush internal buffers */
641 did_emsg = TRUE; /* flag for DoOneCmd() */
644 emsg_on_display = TRUE; /* remember there is an error message */
645 ++msg_scroll; /* don't overwrite a previous message */
646 attr = hl_attr(HLF_E); /* set highlight mode for error messages */
647 if (msg_scrolled != 0)
648 need_wait_return = TRUE; /* needed in case emsg() is called after
649 * wait_return has reset need_wait_return
650 * and a redraw is expected because
651 * msg_scrolled is non-zero */
654 * Display name and line number for the source of the error.
656 msg_source(attr);
659 * Display the error message itself.
661 msg_nowait = FALSE; /* wait for this msg */
662 return msg_attr(s, attr);
666 * Print an error message with one "%s" and one string argument.
669 emsg2(s, a1)
670 char_u *s, *a1;
672 return emsg3(s, a1, NULL);
675 /* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
677 void
678 emsg_invreg(name)
679 int name;
681 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
685 * Like msg(), but truncate to a single line if p_shm contains 't', or when
686 * "force" is TRUE. This truncates in another way as for normal messages.
687 * Careful: The string may be changed by msg_may_trunc()!
688 * Returns a pointer to the printed message, if wait_return() not called.
690 char_u *
691 msg_trunc_attr(s, force, attr)
692 char_u *s;
693 int force;
694 int attr;
696 int n;
698 /* Add message to history before truncating */
699 add_msg_hist(s, -1, attr);
701 s = msg_may_trunc(force, s);
703 msg_hist_off = TRUE;
704 n = msg_attr(s, attr);
705 msg_hist_off = FALSE;
707 if (n)
708 return s;
709 return NULL;
713 * Check if message "s" should be truncated at the start (for filenames).
714 * Return a pointer to where the truncated message starts.
715 * Note: May change the message by replacing a character with '<'.
717 char_u *
718 msg_may_trunc(force, s)
719 int force;
720 char_u *s;
722 int n;
723 int room;
725 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
726 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
727 && (n = (int)STRLEN(s) - room) > 0)
729 #ifdef FEAT_MBYTE
730 if (has_mbyte)
732 int size = vim_strsize(s);
734 /* There may be room anyway when there are multibyte chars. */
735 if (size <= room)
736 return s;
738 for (n = 0; size >= room; )
740 size -= (*mb_ptr2cells)(s + n);
741 n += (*mb_ptr2len)(s + n);
743 --n;
745 #endif
746 s += n;
747 *s = '<';
749 return s;
752 static void
753 add_msg_hist(s, len, attr)
754 char_u *s;
755 int len; /* -1 for undetermined length */
756 int attr;
758 struct msg_hist *p;
760 if (msg_hist_off || msg_silent != 0)
761 return;
763 /* Don't let the message history get too big */
764 while (msg_hist_len > MAX_MSG_HIST_LEN)
765 (void)delete_first_msg();
767 /* allocate an entry and add the message at the end of the history */
768 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
769 if (p != NULL)
771 if (len < 0)
772 len = (int)STRLEN(s);
773 /* remove leading and trailing newlines */
774 while (len > 0 && *s == '\n')
776 ++s;
777 --len;
779 while (len > 0 && s[len - 1] == '\n')
780 --len;
781 p->msg = vim_strnsave(s, len);
782 p->next = NULL;
783 p->attr = attr;
784 if (last_msg_hist != NULL)
785 last_msg_hist->next = p;
786 last_msg_hist = p;
787 if (first_msg_hist == NULL)
788 first_msg_hist = last_msg_hist;
789 ++msg_hist_len;
794 * Delete the first (oldest) message from the history.
795 * Returns FAIL if there are no messages.
798 delete_first_msg()
800 struct msg_hist *p;
802 if (msg_hist_len <= 0)
803 return FAIL;
804 p = first_msg_hist;
805 first_msg_hist = p->next;
806 vim_free(p->msg);
807 vim_free(p);
808 --msg_hist_len;
809 return OK;
813 * ":messages" command.
815 /*ARGSUSED*/
816 void
817 ex_messages(eap)
818 exarg_T *eap;
820 struct msg_hist *p;
821 char_u *s;
823 msg_hist_off = TRUE;
825 s = mch_getenv((char_u *)"LANG");
826 if (s != NULL && *s != NUL)
827 msg_attr((char_u *)
828 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
829 hl_attr(HLF_T));
831 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
832 if (p->msg != NULL)
833 msg_attr(p->msg, p->attr);
835 msg_hist_off = FALSE;
838 #if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
840 * Call this after prompting the user. This will avoid a hit-return message
841 * and a delay.
843 void
844 msg_end_prompt()
846 need_wait_return = FALSE;
847 emsg_on_display = FALSE;
848 cmdline_row = msg_row;
849 msg_col = 0;
850 msg_clr_eos();
852 #endif
855 * wait for the user to hit a key (normally a return)
856 * if 'redraw' is TRUE, clear and redraw the screen
857 * if 'redraw' is FALSE, just redraw the screen
858 * if 'redraw' is -1, don't redraw at all
860 void
861 wait_return(redraw)
862 int redraw;
864 int c;
865 int oldState;
866 int tmpState;
867 int had_got_int;
869 if (redraw == TRUE)
870 must_redraw = CLEAR;
872 /* If using ":silent cmd", don't wait for a return. Also don't set
873 * need_wait_return to do it later. */
874 if (msg_silent != 0)
875 return;
878 * With the global command (and some others) we only need one return at the
879 * end. Adjust cmdline_row to avoid the next message overwriting the last one.
880 * When inside vgetc(), we can't wait for a typed character at all.
882 if (vgetc_busy > 0)
883 return;
884 if (no_wait_return)
886 need_wait_return = TRUE;
887 if (!exmode_active)
888 cmdline_row = msg_row;
889 return;
892 redir_off = TRUE; /* don't redirect this message */
893 oldState = State;
894 if (quit_more)
896 c = CAR; /* just pretend CR was hit */
897 quit_more = FALSE;
898 got_int = FALSE;
900 else if (exmode_active)
902 MSG_PUTS(" "); /* make sure the cursor is on the right line */
903 c = CAR; /* no need for a return in ex mode */
904 got_int = FALSE;
906 else
908 /* Make sure the hit-return prompt is on screen when 'guioptions' was
909 * just changed. */
910 screenalloc(FALSE);
912 State = HITRETURN;
913 #ifdef FEAT_MOUSE
914 setmouse();
915 #endif
916 #ifdef USE_ON_FLY_SCROLL
917 dont_scroll = TRUE; /* disallow scrolling here */
918 #endif
919 hit_return_msg();
923 /* Remember "got_int", if it is set vgetc() probably returns a
924 * CTRL-C, but we need to loop then. */
925 had_got_int = got_int;
927 /* Don't do mappings here, we put the character back in the
928 * typeahead buffer. */
929 ++no_mapping;
930 ++allow_keys;
931 c = safe_vgetc();
932 if (had_got_int && !global_busy)
933 got_int = FALSE;
934 --no_mapping;
935 --allow_keys;
937 #ifdef FEAT_CLIPBOARD
938 /* Strange way to allow copying (yanking) a modeless selection at
939 * the hit-enter prompt. Use CTRL-Y, because the same is used in
940 * Cmdline-mode and it's harmless when there is no selection. */
941 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
943 clip_copy_modeless_selection(TRUE);
944 c = K_IGNORE;
946 #endif
949 * Allow scrolling back in the messages.
950 * Also accept scroll-down commands when messages fill the screen,
951 * to avoid that typing one 'j' too many makes the messages
952 * disappear.
954 if (p_more && !p_cp)
956 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
958 /* scroll back to show older messages */
959 do_more_prompt(c);
960 if (quit_more)
962 c = CAR; /* just pretend CR was hit */
963 quit_more = FALSE;
964 got_int = FALSE;
966 else
968 c = K_IGNORE;
969 hit_return_msg();
972 else if (msg_scrolled > Rows - 2
973 && (c == 'j' || c == K_DOWN || c == 'd'))
974 c = K_IGNORE;
976 } while ((had_got_int && c == Ctrl_C)
977 || c == K_IGNORE
978 #ifdef FEAT_GUI
979 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
980 #endif
981 #ifdef FEAT_MOUSE
982 || c == K_LEFTDRAG || c == K_LEFTRELEASE
983 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
984 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
985 || c == K_MOUSEDOWN || c == K_MOUSEUP
986 || (!mouse_has(MOUSE_RETURN)
987 && mouse_row < msg_row
988 && (c == K_LEFTMOUSE
989 || c == K_MIDDLEMOUSE
990 || c == K_RIGHTMOUSE
991 || c == K_X1MOUSE
992 || c == K_X2MOUSE))
993 #endif
995 ui_breakcheck();
996 #ifdef FEAT_MOUSE
998 * Avoid that the mouse-up event causes visual mode to start.
1000 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1001 || c == K_X1MOUSE || c == K_X2MOUSE)
1002 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1003 else
1004 #endif
1005 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1007 /* Put the character back in the typeahead buffer. Don't use the
1008 * stuff buffer, because lmaps wouldn't work. */
1009 ins_char_typebuf(c);
1010 do_redraw = TRUE; /* need a redraw even though there is
1011 typeahead */
1014 redir_off = FALSE;
1017 * If the user hits ':', '?' or '/' we get a command line from the next
1018 * line.
1020 if (c == ':' || c == '?' || c == '/')
1022 if (!exmode_active)
1023 cmdline_row = msg_row;
1024 skip_redraw = TRUE; /* skip redraw once */
1025 do_redraw = FALSE;
1029 * If the window size changed set_shellsize() will redraw the screen.
1030 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1031 * typed.
1033 tmpState = State;
1034 State = oldState; /* restore State before set_shellsize */
1035 #ifdef FEAT_MOUSE
1036 setmouse();
1037 #endif
1038 msg_check();
1040 #if defined(UNIX) || defined(VMS)
1042 * When switching screens, we need to output an extra newline on exit.
1044 if (swapping_screen() && !termcap_active)
1045 newline_on_exit = TRUE;
1046 #endif
1048 need_wait_return = FALSE;
1049 did_wait_return = TRUE;
1050 emsg_on_display = FALSE; /* can delete error message now */
1051 lines_left = -1; /* reset lines_left at next msg_start() */
1052 reset_last_sourcing();
1053 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1054 (Rows - cmdline_row - 1) * Columns + sc_col)
1056 vim_free(keep_msg);
1057 keep_msg = NULL; /* don't redisplay message, it's too long */
1060 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1062 starttermcap(); /* start termcap before redrawing */
1063 shell_resized();
1065 else if (!skip_redraw
1066 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1068 starttermcap(); /* start termcap before redrawing */
1069 redraw_later(VALID);
1074 * Write the hit-return prompt.
1076 static void
1077 hit_return_msg()
1079 int save_p_more = p_more;
1081 p_more = FALSE; /* don't want see this message when scrolling back */
1082 if (msg_didout) /* start on a new line */
1083 msg_putchar('\n');
1084 if (got_int)
1085 MSG_PUTS(_("Interrupt: "));
1087 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
1088 if (!msg_use_printf())
1089 msg_clr_eos();
1090 p_more = save_p_more;
1094 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1096 void
1097 set_keep_msg(s, attr)
1098 char_u *s;
1099 int attr;
1101 vim_free(keep_msg);
1102 if (s != NULL && msg_silent == 0)
1103 keep_msg = vim_strsave(s);
1104 else
1105 keep_msg = NULL;
1106 keep_msg_more = FALSE;
1107 keep_msg_attr = attr;
1110 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1112 * If there currently is a message being displayed, set "keep_msg" to it, so
1113 * that it will be displayed again after redraw.
1115 void
1116 set_keep_msg_from_hist()
1118 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1119 && (State & NORMAL))
1120 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1122 #endif
1125 * Prepare for outputting characters in the command line.
1127 void
1128 msg_start()
1130 int did_return = FALSE;
1132 vim_free(keep_msg);
1133 keep_msg = NULL; /* don't display old message now */
1134 if (!msg_scroll && full_screen) /* overwrite last message */
1136 msg_row = cmdline_row;
1137 msg_col =
1138 #ifdef FEAT_RIGHTLEFT
1139 cmdmsg_rl ? Columns - 1 :
1140 #endif
1143 else if (msg_didout) /* start message on next line */
1145 msg_putchar('\n');
1146 did_return = TRUE;
1147 if (exmode_active != EXMODE_NORMAL)
1148 cmdline_row = msg_row;
1150 if (!msg_didany || lines_left < 0)
1151 msg_starthere();
1152 if (msg_silent == 0)
1154 msg_didout = FALSE; /* no output on current line yet */
1155 cursor_off();
1158 /* when redirecting, may need to start a new line. */
1159 if (!did_return)
1160 redir_write((char_u *)"\n", -1);
1164 * Note that the current msg position is where messages start.
1166 void
1167 msg_starthere()
1169 lines_left = cmdline_row;
1170 msg_didany = FALSE;
1173 void
1174 msg_putchar(c)
1175 int c;
1177 msg_putchar_attr(c, 0);
1180 void
1181 msg_putchar_attr(c, attr)
1182 int c;
1183 int attr;
1185 #ifdef FEAT_MBYTE
1186 char_u buf[MB_MAXBYTES + 1];
1187 #else
1188 char_u buf[4];
1189 #endif
1191 if (IS_SPECIAL(c))
1193 buf[0] = K_SPECIAL;
1194 buf[1] = K_SECOND(c);
1195 buf[2] = K_THIRD(c);
1196 buf[3] = NUL;
1198 else
1200 #ifdef FEAT_MBYTE
1201 buf[(*mb_char2bytes)(c, buf)] = NUL;
1202 #else
1203 buf[0] = c;
1204 buf[1] = NUL;
1205 #endif
1207 msg_puts_attr(buf, attr);
1210 void
1211 msg_outnum(n)
1212 long n;
1214 char_u buf[20];
1216 sprintf((char *)buf, "%ld", n);
1217 msg_puts(buf);
1220 void
1221 msg_home_replace(fname)
1222 char_u *fname;
1224 msg_home_replace_attr(fname, 0);
1227 #if defined(FEAT_FIND_ID) || defined(PROTO)
1228 void
1229 msg_home_replace_hl(fname)
1230 char_u *fname;
1232 msg_home_replace_attr(fname, hl_attr(HLF_D));
1234 #endif
1236 static void
1237 msg_home_replace_attr(fname, attr)
1238 char_u *fname;
1239 int attr;
1241 char_u *name;
1243 name = home_replace_save(NULL, fname);
1244 if (name != NULL)
1245 msg_outtrans_attr(name, attr);
1246 vim_free(name);
1250 * Output 'len' characters in 'str' (including NULs) with translation
1251 * if 'len' is -1, output upto a NUL character.
1252 * Use attributes 'attr'.
1253 * Return the number of characters it takes on the screen.
1256 msg_outtrans(str)
1257 char_u *str;
1259 return msg_outtrans_attr(str, 0);
1263 msg_outtrans_attr(str, attr)
1264 char_u *str;
1265 int attr;
1267 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1271 msg_outtrans_len(str, len)
1272 char_u *str;
1273 int len;
1275 return msg_outtrans_len_attr(str, len, 0);
1279 * Output one character at "p". Return pointer to the next character.
1280 * Handles multi-byte characters.
1282 char_u *
1283 msg_outtrans_one(p, attr)
1284 char_u *p;
1285 int attr;
1287 #ifdef FEAT_MBYTE
1288 int l;
1290 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1292 msg_outtrans_len_attr(p, l, attr);
1293 return p + l;
1295 #endif
1296 msg_puts_attr(transchar_byte(*p), attr);
1297 return p + 1;
1301 msg_outtrans_len_attr(msgstr, len, attr)
1302 char_u *msgstr;
1303 int len;
1304 int attr;
1306 int retval = 0;
1307 char_u *str = msgstr;
1308 char_u *plain_start = msgstr;
1309 char_u *s;
1310 #ifdef FEAT_MBYTE
1311 int mb_l;
1312 int c;
1313 #endif
1315 /* if MSG_HIST flag set, add message to history */
1316 if (attr & MSG_HIST)
1318 add_msg_hist(str, len, attr);
1319 attr &= ~MSG_HIST;
1322 #ifdef FEAT_MBYTE
1323 /* If the string starts with a composing character first draw a space on
1324 * which the composing char can be drawn. */
1325 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1326 msg_puts_attr((char_u *)" ", attr);
1327 #endif
1330 * Go over the string. Special characters are translated and printed.
1331 * Normal characters are printed several at a time.
1333 while (--len >= 0)
1335 #ifdef FEAT_MBYTE
1336 if (enc_utf8)
1337 /* Don't include composing chars after the end. */
1338 mb_l = utfc_ptr2len_len(str, len + 1);
1339 else if (has_mbyte)
1340 mb_l = (*mb_ptr2len)(str);
1341 else
1342 mb_l = 1;
1343 if (has_mbyte && mb_l > 1)
1345 c = (*mb_ptr2char)(str);
1346 if (vim_isprintc(c))
1347 /* printable multi-byte char: count the cells. */
1348 retval += (*mb_ptr2cells)(str);
1349 else
1351 /* unprintable multi-byte char: print the printable chars so
1352 * far and the translation of the unprintable char. */
1353 if (str > plain_start)
1354 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1355 attr);
1356 plain_start = str + mb_l;
1357 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1358 retval += char2cells(c);
1360 len -= mb_l - 1;
1361 str += mb_l;
1363 else
1364 #endif
1366 s = transchar_byte(*str);
1367 if (s[1] != NUL)
1369 /* unprintable char: print the printable chars so far and the
1370 * translation of the unprintable char. */
1371 if (str > plain_start)
1372 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1373 attr);
1374 plain_start = str + 1;
1375 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
1377 retval += ptr2cells(str);
1378 ++str;
1382 if (str > plain_start)
1383 /* print the printable chars at the end */
1384 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1386 return retval;
1389 #if defined(FEAT_QUICKFIX) || defined(PROTO)
1390 void
1391 msg_make(arg)
1392 char_u *arg;
1394 int i;
1395 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1397 arg = skipwhite(arg);
1398 for (i = 5; *arg && i >= 0; --i)
1399 if (*arg++ != str[i])
1400 break;
1401 if (i < 0)
1403 msg_putchar('\n');
1404 for (i = 0; rs[i]; ++i)
1405 msg_putchar(rs[i] - 3);
1408 #endif
1411 * Output the string 'str' upto a NUL character.
1412 * Return the number of characters it takes on the screen.
1414 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1415 * following character and shown as <F1>, <S-Up> etc. Any other character
1416 * which is not printable shown in <> form.
1417 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1418 * If a character is displayed in one of these special ways, is also
1419 * highlighted (its highlight name is '8' in the p_hl variable).
1420 * Otherwise characters are not highlighted.
1421 * This function is used to show mappings, where we want to see how to type
1422 * the character/string -- webb
1425 msg_outtrans_special(strstart, from)
1426 char_u *strstart;
1427 int from; /* TRUE for lhs of a mapping */
1429 char_u *str = strstart;
1430 int retval = 0;
1431 char_u *string;
1432 int attr;
1433 int len;
1435 attr = hl_attr(HLF_8);
1436 while (*str != NUL)
1438 /* Leading and trailing spaces need to be displayed in <> form. */
1439 if ((str == strstart || str[1] == NUL) && *str == ' ')
1441 string = (char_u *)"<Space>";
1442 ++str;
1444 else
1445 string = str2special(&str, from);
1446 len = vim_strsize(string);
1447 /* Highlight special keys */
1448 msg_puts_attr(string, len > 1
1449 #ifdef FEAT_MBYTE
1450 && (*mb_ptr2len)(string) <= 1
1451 #endif
1452 ? attr : 0);
1453 retval += len;
1455 return retval;
1459 * Return the printable string for the key codes at "*sp".
1460 * Used for translating the lhs or rhs of a mapping to printable chars.
1461 * Advances "sp" to the next code.
1463 char_u *
1464 str2special(sp, from)
1465 char_u **sp;
1466 int from; /* TRUE for lhs of mapping */
1468 int c;
1469 static char_u buf[7];
1470 char_u *str = *sp;
1471 int modifiers = 0;
1472 int special = FALSE;
1474 #ifdef FEAT_MBYTE
1475 if (has_mbyte)
1477 char_u *p;
1479 /* Try to un-escape a multi-byte character. Return the un-escaped
1480 * string if it is a multi-byte character. */
1481 p = mb_unescape(sp);
1482 if (p != NULL)
1483 return p;
1485 #endif
1487 c = *str;
1488 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1490 if (str[1] == KS_MODIFIER)
1492 modifiers = str[2];
1493 str += 3;
1494 c = *str;
1496 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1498 c = TO_SPECIAL(str[1], str[2]);
1499 str += 2;
1500 if (c == K_ZERO) /* display <Nul> as ^@ */
1501 c = NUL;
1503 if (IS_SPECIAL(c) || modifiers) /* special key */
1504 special = TRUE;
1506 *sp = str + 1;
1508 #ifdef FEAT_MBYTE
1509 /* For multi-byte characters check for an illegal byte. */
1510 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
1512 transchar_nonprint(buf, c);
1513 return buf;
1515 #endif
1517 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1518 * Use <Space> only for lhs of a mapping. */
1519 if (special || char2cells(c) > 1 || (from && c == ' '))
1520 return get_special_key_name(c, modifiers);
1521 buf[0] = c;
1522 buf[1] = NUL;
1523 return buf;
1527 * Translate a key sequence into special key names.
1529 void
1530 str2specialbuf(sp, buf, len)
1531 char_u *sp;
1532 char_u *buf;
1533 int len;
1535 char_u *s;
1537 *buf = NUL;
1538 while (*sp)
1540 s = str2special(&sp, FALSE);
1541 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1542 STRCAT(buf, s);
1547 * print line for :print or :list command
1549 void
1550 msg_prt_line(s, list)
1551 char_u *s;
1552 int list;
1554 int c;
1555 int col = 0;
1556 int n_extra = 0;
1557 int c_extra = 0;
1558 char_u *p_extra = NULL; /* init to make SASC shut up */
1559 int n;
1560 int attr = 0;
1561 char_u *trail = NULL;
1562 #ifdef FEAT_MBYTE
1563 int l;
1564 char_u buf[MB_MAXBYTES + 1];
1565 #endif
1567 if (curwin->w_p_list)
1568 list = TRUE;
1570 /* find start of trailing whitespace */
1571 if (list && lcs_trail)
1573 trail = s + STRLEN(s);
1574 while (trail > s && vim_iswhite(trail[-1]))
1575 --trail;
1578 /* output a space for an empty line, otherwise the line will be
1579 * overwritten */
1580 if (*s == NUL && !(list && lcs_eol != NUL))
1581 msg_putchar(' ');
1583 while (!got_int)
1585 if (n_extra > 0)
1587 --n_extra;
1588 if (c_extra)
1589 c = c_extra;
1590 else
1591 c = *p_extra++;
1593 #ifdef FEAT_MBYTE
1594 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
1596 col += (*mb_ptr2cells)(s);
1597 mch_memmove(buf, s, (size_t)l);
1598 buf[l] = NUL;
1599 msg_puts(buf);
1600 s += l;
1601 continue;
1603 #endif
1604 else
1606 attr = 0;
1607 c = *s++;
1608 if (c == TAB && (!list || lcs_tab1))
1610 /* tab amount depends on current column */
1611 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
1612 if (!list)
1614 c = ' ';
1615 c_extra = ' ';
1617 else
1619 c = lcs_tab1;
1620 c_extra = lcs_tab2;
1621 attr = hl_attr(HLF_8);
1624 else if (c == NUL && list && lcs_eol != NUL)
1626 p_extra = (char_u *)"";
1627 c_extra = NUL;
1628 n_extra = 1;
1629 c = lcs_eol;
1630 attr = hl_attr(HLF_AT);
1631 --s;
1633 else if (c != NUL && (n = byte2cells(c)) > 1)
1635 n_extra = n - 1;
1636 p_extra = transchar_byte(c);
1637 c_extra = NUL;
1638 c = *p_extra++;
1639 /* Use special coloring to be able to distinguish <hex> from
1640 * the same in plain text. */
1641 attr = hl_attr(HLF_8);
1643 else if (c == ' ' && trail != NULL && s > trail)
1645 c = lcs_trail;
1646 attr = hl_attr(HLF_8);
1650 if (c == NUL)
1651 break;
1653 msg_putchar_attr(c, attr);
1654 col++;
1656 msg_clr_eos();
1659 #ifdef FEAT_MBYTE
1661 * Use screen_puts() to output one multi-byte character.
1662 * Return the pointer "s" advanced to the next character.
1664 static char_u *
1665 screen_puts_mbyte(s, l, attr)
1666 char_u *s;
1667 int l;
1668 int attr;
1670 int cw;
1672 msg_didout = TRUE; /* remember that line is not empty */
1673 cw = (*mb_ptr2cells)(s);
1674 if (cw > 1 && (
1675 #ifdef FEAT_RIGHTLEFT
1676 cmdmsg_rl ? msg_col <= 1 :
1677 #endif
1678 msg_col == Columns - 1))
1680 /* Doesn't fit, print a highlighted '>' to fill it up. */
1681 msg_screen_putchar('>', hl_attr(HLF_AT));
1682 return s;
1685 screen_puts_len(s, l, msg_row, msg_col, attr);
1686 #ifdef FEAT_RIGHTLEFT
1687 if (cmdmsg_rl)
1689 msg_col -= cw;
1690 if (msg_col == 0)
1692 msg_col = Columns;
1693 ++msg_row;
1696 else
1697 #endif
1699 msg_col += cw;
1700 if (msg_col >= Columns)
1702 msg_col = 0;
1703 ++msg_row;
1706 return s + l;
1708 #endif
1711 * Output a string to the screen at position msg_row, msg_col.
1712 * Update msg_row and msg_col for the next message.
1714 void
1715 msg_puts(s)
1716 char_u *s;
1718 msg_puts_attr(s, 0);
1721 void
1722 msg_puts_title(s)
1723 char_u *s;
1725 msg_puts_attr(s, hl_attr(HLF_T));
1729 * Show a message in such a way that it always fits in the line. Cut out a
1730 * part in the middle and replace it with "..." when necessary.
1731 * Does not handle multi-byte characters!
1733 void
1734 msg_puts_long_attr(longstr, attr)
1735 char_u *longstr;
1736 int attr;
1738 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1741 void
1742 msg_puts_long_len_attr(longstr, len, attr)
1743 char_u *longstr;
1744 int len;
1745 int attr;
1747 int slen = len;
1748 int room;
1750 room = Columns - msg_col;
1751 if (len > room && room >= 20)
1753 slen = (room - 3) / 2;
1754 msg_outtrans_len_attr(longstr, slen, attr);
1755 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1757 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1761 * Basic function for writing a message with highlight attributes.
1763 void
1764 msg_puts_attr(s, attr)
1765 char_u *s;
1766 int attr;
1768 msg_puts_attr_len(s, -1, attr);
1772 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1773 * When "maxlen" is -1 there is no maximum length.
1774 * When "maxlen" is >= 0 the message is not put in the history.
1776 static void
1777 msg_puts_attr_len(str, maxlen, attr)
1778 char_u *str;
1779 int maxlen;
1780 int attr;
1783 * If redirection is on, also write to the redirection file.
1785 redir_write(str, maxlen);
1788 * Don't print anything when using ":silent cmd".
1790 if (msg_silent != 0)
1791 return;
1793 /* if MSG_HIST flag set, add message to history */
1794 if ((attr & MSG_HIST) && maxlen < 0)
1796 add_msg_hist(str, -1, attr);
1797 attr &= ~MSG_HIST;
1801 * When writing something to the screen after it has scrolled, requires a
1802 * wait-return prompt later. Needed when scrolling, resetting
1803 * need_wait_return after some prompt, and then outputting something
1804 * without scrolling
1806 if (msg_scrolled != 0 && !msg_scrolled_ign)
1807 need_wait_return = TRUE;
1808 msg_didany = TRUE; /* remember that something was outputted */
1811 * If there is no valid screen, use fprintf so we can see error messages.
1812 * If termcap is not active, we may be writing in an alternate console
1813 * window, cursor positioning may not work correctly (window size may be
1814 * different, e.g. for Win32 console) or we just don't know where the
1815 * cursor is.
1817 if (msg_use_printf())
1818 msg_puts_printf(str, maxlen);
1819 else
1820 msg_puts_display(str, maxlen, attr, FALSE);
1824 * The display part of msg_puts_attr_len().
1825 * May be called recursively to display scroll-back text.
1827 static void
1828 msg_puts_display(str, maxlen, attr, recurse)
1829 char_u *str;
1830 int maxlen;
1831 int attr;
1832 int recurse;
1834 char_u *s = str;
1835 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1836 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1837 #ifdef FEAT_MBYTE
1838 int l;
1839 int cw;
1840 #endif
1841 char_u *sb_str = str;
1842 int sb_col = msg_col;
1843 int wrap;
1844 int did_last_char;
1846 did_wait_return = FALSE;
1847 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
1850 * We are at the end of the screen line when:
1851 * - When outputting a newline.
1852 * - When outputting a character in the last column.
1854 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
1855 #ifdef FEAT_RIGHTLEFT
1856 cmdmsg_rl
1858 msg_col <= 1
1859 || (*s == TAB && msg_col <= 7)
1860 # ifdef FEAT_MBYTE
1861 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1862 # endif
1865 #endif
1866 (msg_col + t_col >= Columns - 1
1867 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1868 # ifdef FEAT_MBYTE
1869 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1870 && msg_col + t_col >= Columns - 2)
1871 # endif
1872 ))))
1875 * The screen is scrolled up when at the last row (some terminals
1876 * scroll automatically, some don't. To avoid problems we scroll
1877 * ourselves).
1879 if (t_col > 0)
1880 /* output postponed text */
1881 t_puts(&t_col, t_s, s, attr);
1883 /* When no more prompt and no more room, truncate here */
1884 if (msg_no_more && lines_left == 0)
1885 break;
1887 /* Scroll the screen up one line. */
1888 msg_scroll_up();
1890 msg_row = Rows - 2;
1891 if (msg_col >= Columns) /* can happen after screen resize */
1892 msg_col = Columns - 1;
1894 /* Display char in last column before showing more-prompt. */
1895 if (*s >= ' '
1896 #ifdef FEAT_RIGHTLEFT
1897 && !cmdmsg_rl
1898 #endif
1901 #ifdef FEAT_MBYTE
1902 if (has_mbyte)
1904 if (enc_utf8 && maxlen >= 0)
1905 /* avoid including composing chars after the end */
1906 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
1907 else
1908 l = (*mb_ptr2len)(s);
1909 s = screen_puts_mbyte(s, l, attr);
1911 else
1912 #endif
1913 msg_screen_putchar(*s++, attr);
1914 did_last_char = TRUE;
1916 else
1917 did_last_char = FALSE;
1919 if (p_more)
1920 /* store text for scrolling back */
1921 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1923 inc_msg_scrolled();
1924 need_wait_return = TRUE; /* may need wait_return in main() */
1925 if (must_redraw < VALID)
1926 must_redraw = VALID;
1927 redraw_cmdline = TRUE;
1928 if (cmdline_row > 0 && !exmode_active)
1929 --cmdline_row;
1932 * If screen is completely filled and 'more' is set then wait
1933 * for a character.
1935 if (lines_left > 0)
1936 --lines_left;
1937 if (p_more && lines_left == 0 && State != HITRETURN
1938 && !msg_no_more && !exmode_active)
1940 #ifdef FEAT_CON_DIALOG
1941 if (do_more_prompt(NUL))
1942 s = confirm_msg_tail;
1943 #else
1944 (void)do_more_prompt(NUL);
1945 #endif
1946 if (quit_more)
1947 return;
1950 /* When we displayed a char in last column need to check if there
1951 * is still more. */
1952 if (did_last_char)
1953 continue;
1956 wrap = *s == '\n'
1957 || msg_col + t_col >= Columns
1958 #ifdef FEAT_MBYTE
1959 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1960 && msg_col + t_col >= Columns - 1)
1961 #endif
1963 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1964 || *s == '\t' || *s == BELL))
1965 /* output any postponed text */
1966 t_puts(&t_col, t_s, s, attr);
1968 if (wrap && p_more && !recurse)
1969 /* store text for scrolling back */
1970 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1972 if (*s == '\n') /* go to next line */
1974 msg_didout = FALSE; /* remember that line is empty */
1975 #ifdef FEAT_RIGHTLEFT
1976 if (cmdmsg_rl)
1977 msg_col = Columns - 1;
1978 else
1979 #endif
1980 msg_col = 0;
1981 if (++msg_row >= Rows) /* safety check */
1982 msg_row = Rows - 1;
1984 else if (*s == '\r') /* go to column 0 */
1986 msg_col = 0;
1988 else if (*s == '\b') /* go to previous char */
1990 if (msg_col)
1991 --msg_col;
1993 else if (*s == TAB) /* translate Tab into spaces */
1996 msg_screen_putchar(' ', attr);
1997 while (msg_col & 7);
1999 else if (*s == BELL) /* beep (from ":sh") */
2000 vim_beep();
2001 else
2003 #ifdef FEAT_MBYTE
2004 if (has_mbyte)
2006 cw = (*mb_ptr2cells)(s);
2007 if (enc_utf8 && maxlen >= 0)
2008 /* avoid including composing chars after the end */
2009 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
2010 else
2011 l = (*mb_ptr2len)(s);
2013 else
2015 cw = 1;
2016 l = 1;
2018 #endif
2019 /* When drawing from right to left or when a double-wide character
2020 * doesn't fit, draw a single character here. Otherwise collect
2021 * characters and draw them all at once later. */
2022 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2023 if (
2024 # ifdef FEAT_RIGHTLEFT
2025 cmdmsg_rl
2026 # ifdef FEAT_MBYTE
2028 # endif
2029 # endif
2030 # ifdef FEAT_MBYTE
2031 (cw > 1 && msg_col + t_col >= Columns - 1)
2032 # endif
2035 # ifdef FEAT_MBYTE
2036 if (l > 1)
2037 s = screen_puts_mbyte(s, l, attr) - 1;
2038 else
2039 # endif
2040 msg_screen_putchar(*s, attr);
2042 else
2043 #endif
2045 /* postpone this character until later */
2046 if (t_col == 0)
2047 t_s = s;
2048 #ifdef FEAT_MBYTE
2049 t_col += cw;
2050 s += l - 1;
2051 #else
2052 ++t_col;
2053 #endif
2056 ++s;
2059 /* output any postponed text */
2060 if (t_col > 0)
2061 t_puts(&t_col, t_s, s, attr);
2062 if (p_more && !recurse)
2063 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
2065 msg_check();
2069 * Scroll the screen up one line for displaying the next message line.
2071 static void
2072 msg_scroll_up()
2074 #ifdef FEAT_GUI
2075 /* Remove the cursor before scrolling, ScreenLines[] is going
2076 * to become invalid. */
2077 if (gui.in_use)
2078 gui_undraw_cursor();
2079 #endif
2080 /* scrolling up always works */
2081 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2083 if (!can_clear((char_u *)" "))
2085 /* Scrolling up doesn't result in the right background. Set the
2086 * background here. It's not efficient, but avoids that we have to do
2087 * it all over the code. */
2088 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2090 /* Also clear the last char of the last but one line if it was not
2091 * cleared before to avoid a scroll-up. */
2092 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2093 screen_fill((int)Rows - 2, (int)Rows - 1,
2094 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2099 * Increment "msg_scrolled".
2101 static void
2102 inc_msg_scrolled()
2104 #ifdef FEAT_EVAL
2105 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2107 char_u *p = sourcing_name;
2108 char_u *tofree = NULL;
2109 int len;
2111 /* v:scrollstart is empty, set it to the script/function name and line
2112 * number */
2113 if (p == NULL)
2114 p = (char_u *)_("Unknown");
2115 else
2117 len = (int)STRLEN(p) + 40;
2118 tofree = alloc(len);
2119 if (tofree != NULL)
2121 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2122 p, (long)sourcing_lnum);
2123 p = tofree;
2126 set_vim_var_string(VV_SCROLLSTART, p, -1);
2127 vim_free(tofree);
2129 #endif
2130 ++msg_scrolled;
2134 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2135 * store the displayed text and remember where screen lines start.
2137 typedef struct msgchunk_S msgchunk_T;
2138 struct msgchunk_S
2140 msgchunk_T *sb_next;
2141 msgchunk_T *sb_prev;
2142 char sb_eol; /* TRUE when line ends after this text */
2143 int sb_msg_col; /* column in which text starts */
2144 int sb_attr; /* text attributes */
2145 char_u sb_text[1]; /* text to be displayed, actually longer */
2148 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2150 static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2151 static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2153 static int do_clear_sb_text = FALSE; /* clear text on next msg */
2156 * Store part of a printed message for displaying when scrolling back.
2158 static void
2159 store_sb_text(sb_str, s, attr, sb_col, finish)
2160 char_u **sb_str; /* start of string */
2161 char_u *s; /* just after string */
2162 int attr;
2163 int *sb_col;
2164 int finish; /* line ends */
2166 msgchunk_T *mp;
2168 if (do_clear_sb_text)
2170 clear_sb_text();
2171 do_clear_sb_text = FALSE;
2174 if (s > *sb_str)
2176 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2177 if (mp != NULL)
2179 mp->sb_eol = finish;
2180 mp->sb_msg_col = *sb_col;
2181 mp->sb_attr = attr;
2182 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2184 if (last_msgchunk == NULL)
2186 last_msgchunk = mp;
2187 mp->sb_prev = NULL;
2189 else
2191 mp->sb_prev = last_msgchunk;
2192 last_msgchunk->sb_next = mp;
2193 last_msgchunk = mp;
2195 mp->sb_next = NULL;
2198 else if (finish && last_msgchunk != NULL)
2199 last_msgchunk->sb_eol = TRUE;
2201 *sb_str = s;
2202 *sb_col = 0;
2206 * Finished showing messages, clear the scroll-back text on the next message.
2208 void
2209 may_clear_sb_text()
2211 do_clear_sb_text = TRUE;
2215 * Clear any text remembered for scrolling back.
2216 * Called when redrawing the screen.
2218 void
2219 clear_sb_text()
2221 msgchunk_T *mp;
2223 while (last_msgchunk != NULL)
2225 mp = last_msgchunk->sb_prev;
2226 vim_free(last_msgchunk);
2227 last_msgchunk = mp;
2232 * "g<" command.
2234 void
2235 show_sb_text()
2237 msgchunk_T *mp;
2239 /* Only show something if there is more than one line, otherwise it looks
2240 * weird, typing a command without output results in one line. */
2241 mp = msg_sb_start(last_msgchunk);
2242 if (mp == NULL || mp->sb_prev == NULL)
2243 vim_beep();
2244 else
2246 do_more_prompt('G');
2247 wait_return(FALSE);
2252 * Move to the start of screen line in already displayed text.
2254 static msgchunk_T *
2255 msg_sb_start(mps)
2256 msgchunk_T *mps;
2258 msgchunk_T *mp = mps;
2260 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2261 mp = mp->sb_prev;
2262 return mp;
2266 * Display a screen line from previously displayed text at row "row".
2267 * Returns a pointer to the text for the next line (can be NULL).
2269 static msgchunk_T *
2270 disp_sb_line(row, smp)
2271 int row;
2272 msgchunk_T *smp;
2274 msgchunk_T *mp = smp;
2275 char_u *p;
2277 for (;;)
2279 msg_row = row;
2280 msg_col = mp->sb_msg_col;
2281 p = mp->sb_text;
2282 if (*p == '\n') /* don't display the line break */
2283 ++p;
2284 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2285 if (mp->sb_eol || mp->sb_next == NULL)
2286 break;
2287 mp = mp->sb_next;
2289 return mp->sb_next;
2293 * Output any postponed text for msg_puts_attr_len().
2295 static void
2296 t_puts(t_col, t_s, s, attr)
2297 int *t_col;
2298 char_u *t_s;
2299 char_u *s;
2300 int attr;
2302 /* output postponed text */
2303 msg_didout = TRUE; /* remember that line is not empty */
2304 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
2305 msg_col += *t_col;
2306 *t_col = 0;
2307 #ifdef FEAT_MBYTE
2308 /* If the string starts with a composing character don't increment the
2309 * column position for it. */
2310 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2311 --msg_col;
2312 #endif
2313 if (msg_col >= Columns)
2315 msg_col = 0;
2316 ++msg_row;
2321 * Returns TRUE when messages should be printed with mch_errmsg().
2322 * This is used when there is no valid screen, so we can see error messages.
2323 * If termcap is not active, we may be writing in an alternate console
2324 * window, cursor positioning may not work correctly (window size may be
2325 * different, e.g. for Win32 console) or we just don't know where the
2326 * cursor is.
2329 msg_use_printf()
2331 return (!msg_check_screen()
2332 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2333 || !termcap_active
2334 #endif
2335 || (swapping_screen() && !termcap_active)
2340 * Print a message when there is no valid screen.
2342 static void
2343 msg_puts_printf(str, maxlen)
2344 char_u *str;
2345 int maxlen;
2347 char_u *s = str;
2348 char_u buf[4];
2349 char_u *p;
2351 #ifdef WIN3264
2352 if (!(silent_mode && p_verbose == 0))
2353 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2354 #endif
2355 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2357 if (!(silent_mode && p_verbose == 0))
2359 /* NL --> CR NL translation (for Unix, not for "--version") */
2360 /* NL --> CR translation (for Mac) */
2361 p = &buf[0];
2362 if (*s == '\n' && !info_message)
2363 *p++ = '\r';
2364 #if defined(USE_CR) && !defined(MACOS_X_UNIX)
2365 else
2366 #endif
2367 *p++ = *s;
2368 *p = '\0';
2369 if (info_message) /* informative message, not an error */
2370 mch_msg((char *)buf);
2371 else
2372 mch_errmsg((char *)buf);
2375 /* primitive way to compute the current column */
2376 #ifdef FEAT_RIGHTLEFT
2377 if (cmdmsg_rl)
2379 if (*s == '\r' || *s == '\n')
2380 msg_col = Columns - 1;
2381 else
2382 --msg_col;
2384 else
2385 #endif
2387 if (*s == '\r' || *s == '\n')
2388 msg_col = 0;
2389 else
2390 ++msg_col;
2392 ++s;
2394 msg_didout = TRUE; /* assume that line is not empty */
2396 #ifdef WIN3264
2397 if (!(silent_mode && p_verbose == 0))
2398 mch_settmode(TMODE_RAW);
2399 #endif
2403 * Show the more-prompt and handle the user response.
2404 * This takes care of scrolling back and displaying previously displayed text.
2405 * When at hit-enter prompt "typed_char" is the already typed character,
2406 * otherwise it's NUL.
2407 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2409 static int
2410 do_more_prompt(typed_char)
2411 int typed_char;
2413 int used_typed_char = typed_char;
2414 int oldState = State;
2415 int c;
2416 #ifdef FEAT_CON_DIALOG
2417 int retval = FALSE;
2418 #endif
2419 int scroll;
2420 msgchunk_T *mp_last = NULL;
2421 msgchunk_T *mp;
2422 int i;
2424 if (typed_char == 'G')
2426 /* "g<": Find first line on the last page. */
2427 mp_last = msg_sb_start(last_msgchunk);
2428 for (i = 0; i < Rows - 2 && mp_last != NULL
2429 && mp_last->sb_prev != NULL; ++i)
2430 mp_last = msg_sb_start(mp_last->sb_prev);
2433 State = ASKMORE;
2434 #ifdef FEAT_MOUSE
2435 setmouse();
2436 #endif
2437 if (typed_char == NUL)
2438 msg_moremsg(FALSE);
2439 for (;;)
2442 * Get a typed character directly from the user.
2444 if (used_typed_char != NUL)
2446 c = used_typed_char; /* was typed at hit-enter prompt */
2447 used_typed_char = NUL;
2449 else
2450 c = get_keystroke();
2452 #if defined(FEAT_MENU) && defined(FEAT_GUI)
2453 if (c == K_MENU)
2455 int idx = get_menu_index(current_menu, ASKMORE);
2457 /* Used a menu. If it starts with CTRL-Y, it must
2458 * be a "Copy" for the clipboard. Otherwise
2459 * assume that we end */
2460 if (idx == MENU_INDEX_INVALID)
2461 continue;
2462 c = *current_menu->strings[idx];
2463 if (c != NUL && current_menu->strings[idx][1] != NUL)
2464 ins_typebuf(current_menu->strings[idx] + 1,
2465 current_menu->noremap[idx], 0, TRUE,
2466 current_menu->silent[idx]);
2468 #endif
2470 scroll = 0;
2471 switch (c)
2473 case BS: /* scroll one line back */
2474 case K_BS:
2475 case 'k':
2476 case K_UP:
2477 scroll = -1;
2478 break;
2480 case CAR: /* one extra line */
2481 case NL:
2482 case 'j':
2483 case K_DOWN:
2484 scroll = 1;
2485 break;
2487 case 'u': /* Up half a page */
2488 case K_PAGEUP:
2489 scroll = -(Rows / 2);
2490 break;
2492 case 'd': /* Down half a page */
2493 scroll = Rows / 2;
2494 break;
2496 case 'b': /* one page back */
2497 scroll = -(Rows - 1);
2498 break;
2500 case ' ': /* one extra page */
2501 case K_PAGEDOWN:
2502 case K_LEFTMOUSE:
2503 scroll = Rows - 1;
2504 break;
2506 case 'g': /* all the way back to the start */
2507 scroll = -999999;
2508 break;
2510 case 'G': /* all the way to the end */
2511 scroll = 999999;
2512 lines_left = 999999;
2513 break;
2515 case ':': /* start new command line */
2516 #ifdef FEAT_CON_DIALOG
2517 if (!confirm_msg_used)
2518 #endif
2520 /* Since got_int is set all typeahead will be flushed, but we
2521 * want to keep this ':', remember that in a special way. */
2522 typeahead_noflush(':');
2523 cmdline_row = Rows - 1; /* put ':' on this line */
2524 skip_redraw = TRUE; /* skip redraw once */
2525 need_wait_return = FALSE; /* don't wait in main() */
2527 /*FALLTHROUGH*/
2528 case 'q': /* quit */
2529 case Ctrl_C:
2530 case ESC:
2531 #ifdef FEAT_CON_DIALOG
2532 if (confirm_msg_used)
2534 /* Jump to the choices of the dialog. */
2535 retval = TRUE;
2536 lines_left = Rows - 1;
2538 else
2539 #endif
2541 got_int = TRUE;
2542 quit_more = TRUE;
2544 break;
2546 #ifdef FEAT_CLIPBOARD
2547 case Ctrl_Y:
2548 /* Strange way to allow copying (yanking) a modeless
2549 * selection at the more prompt. Use CTRL-Y,
2550 * because the same is used in Cmdline-mode and at the
2551 * hit-enter prompt. However, scrolling one line up
2552 * might be expected... */
2553 if (clip_star.state == SELECT_DONE)
2554 clip_copy_modeless_selection(TRUE);
2555 continue;
2556 #endif
2557 default: /* no valid response */
2558 msg_moremsg(TRUE);
2559 continue;
2562 if (scroll != 0)
2564 if (scroll < 0)
2566 /* go to start of last line */
2567 if (mp_last == NULL)
2568 mp = msg_sb_start(last_msgchunk);
2569 else if (mp_last->sb_prev != NULL)
2570 mp = msg_sb_start(mp_last->sb_prev);
2571 else
2572 mp = NULL;
2574 /* go to start of line at top of the screen */
2575 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2576 ++i)
2577 mp = msg_sb_start(mp->sb_prev);
2579 if (mp != NULL && mp->sb_prev != NULL)
2581 /* Find line to be displayed at top. */
2582 for (i = 0; i > scroll; --i)
2584 if (mp == NULL || mp->sb_prev == NULL)
2585 break;
2586 mp = msg_sb_start(mp->sb_prev);
2587 if (mp_last == NULL)
2588 mp_last = msg_sb_start(last_msgchunk);
2589 else
2590 mp_last = msg_sb_start(mp_last->sb_prev);
2593 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2594 (int)Rows, NULL) == OK)
2596 /* display line at top */
2597 (void)disp_sb_line(0, mp);
2599 else
2601 /* redisplay all lines */
2602 screenclear();
2603 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2605 mp = disp_sb_line(i, mp);
2606 ++msg_scrolled;
2609 scroll = 0;
2612 else
2614 /* First display any text that we scrolled back. */
2615 while (scroll > 0 && mp_last != NULL)
2617 /* scroll up, display line at bottom */
2618 msg_scroll_up();
2619 inc_msg_scrolled();
2620 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2621 (int)Columns, ' ', ' ', 0);
2622 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2623 --scroll;
2627 if (scroll <= 0)
2629 /* displayed the requested text, more prompt again */
2630 screen_fill((int)Rows - 1, (int)Rows, 0,
2631 (int)Columns, ' ', ' ', 0);
2632 msg_moremsg(FALSE);
2633 continue;
2636 /* display more text, return to caller */
2637 lines_left = scroll;
2640 break;
2643 /* clear the --more-- message */
2644 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2645 State = oldState;
2646 #ifdef FEAT_MOUSE
2647 setmouse();
2648 #endif
2649 if (quit_more)
2651 msg_row = Rows - 1;
2652 msg_col = 0;
2654 #ifdef FEAT_RIGHTLEFT
2655 else if (cmdmsg_rl)
2656 msg_col = Columns - 1;
2657 #endif
2659 #ifdef FEAT_CON_DIALOG
2660 return retval;
2661 #else
2662 return FALSE;
2663 #endif
2666 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
2668 #ifdef mch_errmsg
2669 # undef mch_errmsg
2670 #endif
2671 #ifdef mch_msg
2672 # undef mch_msg
2673 #endif
2676 * Give an error message. To be used when the screen hasn't been initialized
2677 * yet. When stderr can't be used, collect error messages until the GUI has
2678 * started and they can be displayed in a message box.
2680 void
2681 mch_errmsg(str)
2682 char *str;
2684 int len;
2686 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2687 /* On Unix use stderr if it's a tty.
2688 * When not going to start the GUI also use stderr.
2689 * On Mac, when started from Finder, stderr is the console. */
2690 if (
2691 # ifdef UNIX
2692 # ifdef MACOS_X_UNIX
2693 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2694 # else
2695 isatty(2)
2696 # endif
2697 # ifdef FEAT_GUI
2699 # endif
2700 # endif
2701 # ifdef FEAT_GUI
2702 !(gui.in_use || gui.starting)
2703 # endif
2706 fprintf(stderr, "%s", str);
2707 return;
2709 #endif
2711 /* avoid a delay for a message that isn't there */
2712 emsg_on_display = FALSE;
2714 len = (int)STRLEN(str) + 1;
2715 if (error_ga.ga_growsize == 0)
2717 error_ga.ga_growsize = 80;
2718 error_ga.ga_itemsize = 1;
2720 if (ga_grow(&error_ga, len) == OK)
2722 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2723 (char_u *)str, len);
2724 #ifdef UNIX
2725 /* remove CR characters, they are displayed */
2727 char_u *p;
2729 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2730 for (;;)
2732 p = vim_strchr(p, '\r');
2733 if (p == NULL)
2734 break;
2735 *p = ' ';
2738 #endif
2739 --len; /* don't count the NUL at the end */
2740 error_ga.ga_len += len;
2745 * Give a message. To be used when the screen hasn't been initialized yet.
2746 * When there is no tty, collect messages until the GUI has started and they
2747 * can be displayed in a message box.
2749 void
2750 mch_msg(str)
2751 char *str;
2753 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2754 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2755 * uses mch_errmsg() when started from the desktop.
2756 * When not going to start the GUI also use stdout.
2757 * On Mac, when started from Finder, stderr is the console. */
2758 if (
2759 # ifdef UNIX
2760 # ifdef MACOS_X_UNIX
2761 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2762 # else
2763 isatty(2)
2764 # endif
2765 # ifdef FEAT_GUI
2767 # endif
2768 # endif
2769 # ifdef FEAT_GUI
2770 !(gui.in_use || gui.starting)
2771 # endif
2774 printf("%s", str);
2775 return;
2777 # endif
2778 mch_errmsg(str);
2780 #endif /* USE_MCH_ERRMSG */
2783 * Put a character on the screen at the current message position and advance
2784 * to the next position. Only for printable ASCII!
2786 static void
2787 msg_screen_putchar(c, attr)
2788 int c;
2789 int attr;
2791 msg_didout = TRUE; /* remember that line is not empty */
2792 screen_putchar(c, msg_row, msg_col, attr);
2793 #ifdef FEAT_RIGHTLEFT
2794 if (cmdmsg_rl)
2796 if (--msg_col == 0)
2798 msg_col = Columns;
2799 ++msg_row;
2802 else
2803 #endif
2805 if (++msg_col >= Columns)
2807 msg_col = 0;
2808 ++msg_row;
2813 void
2814 msg_moremsg(full)
2815 int full;
2817 int attr;
2818 char_u *s = (char_u *)_("-- More --");
2820 attr = hl_attr(HLF_M);
2821 screen_puts(s, (int)Rows - 1, 0, attr);
2822 if (full)
2823 screen_puts((char_u *)
2824 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2825 (int)Rows - 1, vim_strsize(s), attr);
2829 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2830 * exmode_active.
2832 void
2833 repeat_message()
2835 if (State == ASKMORE)
2837 msg_moremsg(TRUE); /* display --more-- message again */
2838 msg_row = Rows - 1;
2840 #ifdef FEAT_CON_DIALOG
2841 else if (State == CONFIRM)
2843 display_confirm_msg(); /* display ":confirm" message again */
2844 msg_row = Rows - 1;
2846 #endif
2847 else if (State == EXTERNCMD)
2849 windgoto(msg_row, msg_col); /* put cursor back */
2851 else if (State == HITRETURN || State == SETWSIZE)
2853 if (msg_row == Rows - 1)
2855 /* Avoid drawing the "hit-enter" prompt below the previous one,
2856 * overwrite it. Esp. useful when regaining focus and a
2857 * FocusGained autocmd exists but didn't draw anything. */
2858 msg_didout = FALSE;
2859 msg_col = 0;
2860 msg_clr_eos();
2862 hit_return_msg();
2863 msg_row = Rows - 1;
2868 * msg_check_screen - check if the screen is initialized.
2869 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2870 * While starting the GUI the terminal codes will be set for the GUI, but the
2871 * output goes to the terminal. Don't use the terminal codes then.
2873 static int
2874 msg_check_screen()
2876 if (!full_screen || !screen_valid(FALSE))
2877 return FALSE;
2879 if (msg_row >= Rows)
2880 msg_row = Rows - 1;
2881 if (msg_col >= Columns)
2882 msg_col = Columns - 1;
2883 return TRUE;
2887 * Clear from current message position to end of screen.
2888 * Skip this when ":silent" was used, no need to clear for redirection.
2890 void
2891 msg_clr_eos()
2893 if (msg_silent == 0)
2894 msg_clr_eos_force();
2898 * Clear from current message position to end of screen.
2899 * Note: msg_col is not updated, so we remember the end of the message
2900 * for msg_check().
2902 void
2903 msg_clr_eos_force()
2905 if (msg_use_printf())
2907 if (full_screen) /* only when termcap codes are valid */
2909 if (*T_CD)
2910 out_str(T_CD); /* clear to end of display */
2911 else if (*T_CE)
2912 out_str(T_CE); /* clear to end of line */
2915 else
2917 #ifdef FEAT_RIGHTLEFT
2918 if (cmdmsg_rl)
2920 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2921 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2923 else
2924 #endif
2926 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2927 ' ', ' ', 0);
2928 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2934 * Clear the command line.
2936 void
2937 msg_clr_cmdline()
2939 msg_row = cmdline_row;
2940 msg_col = 0;
2941 msg_clr_eos_force();
2945 * end putting a message on the screen
2946 * call wait_return if the message does not fit in the available space
2947 * return TRUE if wait_return not called.
2950 msg_end()
2953 * if the string is larger than the window,
2954 * or the ruler option is set and we run into it,
2955 * we have to redraw the window.
2956 * Do not do this if we are abandoning the file or editing the command line.
2958 if (!exiting && need_wait_return && !(State & CMDLINE))
2960 wait_return(FALSE);
2961 return FALSE;
2963 out_flush();
2964 return TRUE;
2968 * If the written message runs into the shown command or ruler, we have to
2969 * wait for hit-return and redraw the window later.
2971 void
2972 msg_check()
2974 if (msg_row == Rows - 1 && msg_col >= sc_col)
2976 need_wait_return = TRUE;
2977 redraw_cmdline = TRUE;
2982 * May write a string to the redirection file.
2983 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
2985 static void
2986 redir_write(str, maxlen)
2987 char_u *str;
2988 int maxlen;
2990 char_u *s = str;
2991 static int cur_col = 0;
2993 /* Don't do anything for displaying prompts and the like. */
2994 if (redir_off)
2995 return;
2998 * If 'verbosefile' is set write message in that file.
2999 * Must come before the rest because of updating "msg_col".
3001 if (*p_vfile != NUL)
3002 verbose_write(s, maxlen);
3004 if (redir_fd != NULL
3005 #ifdef FEAT_EVAL
3006 || redir_reg || redir_vname
3007 #endif
3010 /* If the string doesn't start with CR or NL, go to msg_col */
3011 if (*s != '\n' && *s != '\r')
3013 while (cur_col < msg_col)
3015 #ifdef FEAT_EVAL
3016 if (redir_reg)
3017 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
3018 else if (redir_vname)
3019 var_redir_str((char_u *)" ", -1);
3020 else if (redir_fd)
3021 #endif
3022 fputs(" ", redir_fd);
3023 ++cur_col;
3027 #ifdef FEAT_EVAL
3028 if (redir_reg)
3029 write_reg_contents(redir_reg, s, maxlen, TRUE);
3030 if (redir_vname)
3031 var_redir_str(s, maxlen);
3032 #endif
3034 /* Adjust the current column */
3035 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3037 #ifdef FEAT_EVAL
3038 if (!redir_reg && !redir_vname && redir_fd != NULL)
3039 #endif
3040 putc(*s, redir_fd);
3041 if (*s == '\r' || *s == '\n')
3042 cur_col = 0;
3043 else if (*s == '\t')
3044 cur_col += (8 - cur_col % 8);
3045 else
3046 ++cur_col;
3047 ++s;
3050 if (msg_silent != 0) /* should update msg_col */
3051 msg_col = cur_col;
3056 * Before giving verbose message.
3057 * Must always be called paired with verbose_leave()!
3059 void
3060 verbose_enter()
3062 if (*p_vfile != NUL)
3063 ++msg_silent;
3067 * After giving verbose message.
3068 * Must always be called paired with verbose_enter()!
3070 void
3071 verbose_leave()
3073 if (*p_vfile != NUL)
3074 if (--msg_silent < 0)
3075 msg_silent = 0;
3079 * Like verbose_enter() and set msg_scroll when displaying the message.
3081 void
3082 verbose_enter_scroll()
3084 if (*p_vfile != NUL)
3085 ++msg_silent;
3086 else
3087 /* always scroll up, don't overwrite */
3088 msg_scroll = TRUE;
3092 * Like verbose_leave() and set cmdline_row when displaying the message.
3094 void
3095 verbose_leave_scroll()
3097 if (*p_vfile != NUL)
3099 if (--msg_silent < 0)
3100 msg_silent = 0;
3102 else
3103 cmdline_row = msg_row;
3106 static FILE *verbose_fd = NULL;
3107 static int verbose_did_open = FALSE;
3110 * Called when 'verbosefile' is set: stop writing to the file.
3112 void
3113 verbose_stop()
3115 if (verbose_fd != NULL)
3117 fclose(verbose_fd);
3118 verbose_fd = NULL;
3120 verbose_did_open = FALSE;
3124 * Open the file 'verbosefile'.
3125 * Return FAIL or OK.
3128 verbose_open()
3130 if (verbose_fd == NULL && !verbose_did_open)
3132 /* Only give the error message once. */
3133 verbose_did_open = TRUE;
3135 verbose_fd = mch_fopen((char *)p_vfile, "a");
3136 if (verbose_fd == NULL)
3138 EMSG2(_(e_notopen), p_vfile);
3139 return FAIL;
3142 return OK;
3146 * Write a string to 'verbosefile'.
3147 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3149 static void
3150 verbose_write(str, maxlen)
3151 char_u *str;
3152 int maxlen;
3154 char_u *s = str;
3155 static int cur_col = 0;
3157 /* Open the file when called the first time. */
3158 if (verbose_fd == NULL)
3159 verbose_open();
3161 if (verbose_fd != NULL)
3163 /* If the string doesn't start with CR or NL, go to msg_col */
3164 if (*s != '\n' && *s != '\r')
3166 while (cur_col < msg_col)
3168 fputs(" ", verbose_fd);
3169 ++cur_col;
3173 /* Adjust the current column */
3174 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3176 putc(*s, verbose_fd);
3177 if (*s == '\r' || *s == '\n')
3178 cur_col = 0;
3179 else if (*s == '\t')
3180 cur_col += (8 - cur_col % 8);
3181 else
3182 ++cur_col;
3183 ++s;
3189 * Give a warning message (for searching).
3190 * Use 'w' highlighting and may repeat the message after redrawing
3192 void
3193 give_warning(message, hl)
3194 char_u *message;
3195 int hl;
3197 /* Don't do this for ":silent". */
3198 if (msg_silent != 0)
3199 return;
3201 /* Don't want a hit-enter prompt here. */
3202 ++no_wait_return;
3204 #ifdef FEAT_EVAL
3205 set_vim_var_string(VV_WARNINGMSG, message, -1);
3206 #endif
3207 vim_free(keep_msg);
3208 keep_msg = NULL;
3209 if (hl)
3210 keep_msg_attr = hl_attr(HLF_W);
3211 else
3212 keep_msg_attr = 0;
3213 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
3214 set_keep_msg(message, keep_msg_attr);
3215 msg_didout = FALSE; /* overwrite this message */
3216 msg_nowait = TRUE; /* don't wait for this message */
3217 msg_col = 0;
3219 --no_wait_return;
3223 * Advance msg cursor to column "col".
3225 void
3226 msg_advance(col)
3227 int col;
3229 if (msg_silent != 0) /* nothing to advance to */
3231 msg_col = col; /* for redirection, may fill it up later */
3232 return;
3234 if (col >= Columns) /* not enough room */
3235 col = Columns - 1;
3236 #ifdef FEAT_RIGHTLEFT
3237 if (cmdmsg_rl)
3238 while (msg_col > Columns - col)
3239 msg_putchar(' ');
3240 else
3241 #endif
3242 while (msg_col < col)
3243 msg_putchar(' ');
3246 #if defined(FEAT_CON_DIALOG) || defined(PROTO)
3248 * Used for "confirm()" function, and the :confirm command prefix.
3249 * Versions which haven't got flexible dialogs yet, and console
3250 * versions, get this generic handler which uses the command line.
3252 * type = one of:
3253 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3254 * title = title string (can be NULL for default)
3255 * (neither used in console dialogs at the moment)
3257 * Format of the "buttons" string:
3258 * "Button1Name\nButton2Name\nButton3Name"
3259 * The first button should normally be the default/accept
3260 * The second button should be the 'Cancel' button
3261 * Other buttons- use your imagination!
3262 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3263 * different letter.
3265 /* ARGSUSED */
3267 do_dialog(type, title, message, buttons, dfltbutton, textfield)
3268 int type;
3269 char_u *title;
3270 char_u *message;
3271 char_u *buttons;
3272 int dfltbutton;
3273 char_u *textfield; /* IObuff for inputdialog(), NULL otherwise */
3275 int oldState;
3276 int retval = 0;
3277 char_u *hotkeys;
3278 int c;
3279 int i;
3281 #ifndef NO_CONSOLE
3282 /* Don't output anything in silent mode ("ex -s") */
3283 if (silent_mode)
3284 return dfltbutton; /* return default option */
3285 #endif
3287 #ifdef FEAT_GUI_DIALOG
3288 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3289 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3291 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3292 textfield);
3293 msg_end_prompt();
3295 /* Flush output to avoid that further messages and redrawing is done
3296 * in the wrong order. */
3297 out_flush();
3298 gui_mch_update();
3300 return c;
3302 #endif
3304 oldState = State;
3305 State = CONFIRM;
3306 #ifdef FEAT_MOUSE
3307 setmouse();
3308 #endif
3311 * Since we wait for a keypress, don't make the
3312 * user press RETURN as well afterwards.
3314 ++no_wait_return;
3315 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3317 if (hotkeys != NULL)
3319 for (;;)
3321 /* Get a typed character directly from the user. */
3322 c = get_keystroke();
3323 switch (c)
3325 case CAR: /* User accepts default option */
3326 case NL:
3327 retval = dfltbutton;
3328 break;
3329 case Ctrl_C: /* User aborts/cancels */
3330 case ESC:
3331 retval = 0;
3332 break;
3333 default: /* Could be a hotkey? */
3334 if (c < 0) /* special keys are ignored here */
3335 continue;
3336 /* Make the character lowercase, as chars in "hotkeys" are. */
3337 c = MB_TOLOWER(c);
3338 retval = 1;
3339 for (i = 0; hotkeys[i]; ++i)
3341 #ifdef FEAT_MBYTE
3342 if (has_mbyte)
3344 if ((*mb_ptr2char)(hotkeys + i) == c)
3345 break;
3346 i += (*mb_ptr2len)(hotkeys + i) - 1;
3348 else
3349 #endif
3350 if (hotkeys[i] == c)
3351 break;
3352 ++retval;
3354 if (hotkeys[i])
3355 break;
3356 /* No hotkey match, so keep waiting */
3357 continue;
3359 break;
3362 vim_free(hotkeys);
3365 State = oldState;
3366 #ifdef FEAT_MOUSE
3367 setmouse();
3368 #endif
3369 --no_wait_return;
3370 msg_end_prompt();
3372 return retval;
3375 static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3378 * Copy one character from "*from" to "*to", taking care of multi-byte
3379 * characters. Return the length of the character in bytes.
3381 static int
3382 copy_char(from, to, lowercase)
3383 char_u *from;
3384 char_u *to;
3385 int lowercase; /* make character lower case */
3387 #ifdef FEAT_MBYTE
3388 int len;
3389 int c;
3391 if (has_mbyte)
3393 if (lowercase)
3395 c = MB_TOLOWER((*mb_ptr2char)(from));
3396 return (*mb_char2bytes)(c, to);
3398 else
3400 len = (*mb_ptr2len)(from);
3401 mch_memmove(to, from, (size_t)len);
3402 return len;
3405 else
3406 #endif
3408 if (lowercase)
3409 *to = (char_u)TOLOWER_LOC(*from);
3410 else
3411 *to = *from;
3412 return 1;
3417 * Format the dialog string, and display it at the bottom of
3418 * the screen. Return a string of hotkey chars (if defined) for
3419 * each 'button'. If a button has no hotkey defined, the first character of
3420 * the button is used.
3421 * The hotkeys can be multi-byte characters, but without combining chars.
3423 * Returns an allocated string with hotkeys, or NULL for error.
3425 static char_u *
3426 msg_show_console_dialog(message, buttons, dfltbutton)
3427 char_u *message;
3428 char_u *buttons;
3429 int dfltbutton;
3431 int len = 0;
3432 #ifdef FEAT_MBYTE
3433 # define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3434 #else
3435 # define HOTK_LEN 1
3436 #endif
3437 int lenhotkey = HOTK_LEN; /* count first button */
3438 char_u *hotk = NULL;
3439 char_u *msgp = NULL;
3440 char_u *hotkp = NULL;
3441 char_u *r;
3442 int copy;
3443 #define HAS_HOTKEY_LEN 30
3444 char_u has_hotkey[HAS_HOTKEY_LEN];
3445 int first_hotkey = FALSE; /* first char of button is hotkey */
3446 int idx;
3448 has_hotkey[0] = FALSE;
3451 * First loop: compute the size of memory to allocate.
3452 * Second loop: copy to the allocated memory.
3454 for (copy = 0; copy <= 1; ++copy)
3456 r = buttons;
3457 idx = 0;
3458 while (*r)
3460 if (*r == DLG_BUTTON_SEP)
3462 if (copy)
3464 *msgp++ = ',';
3465 *msgp++ = ' '; /* '\n' -> ', ' */
3467 /* advance to next hotkey and set default hotkey */
3468 #ifdef FEAT_MBYTE
3469 if (has_mbyte)
3470 hotkp += STRLEN(hotkp);
3471 else
3472 #endif
3473 ++hotkp;
3474 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
3475 if (dfltbutton)
3476 --dfltbutton;
3478 /* If no hotkey is specified first char is used. */
3479 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3480 first_hotkey = TRUE;
3482 else
3484 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3485 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3486 if (idx < HAS_HOTKEY_LEN - 1)
3487 has_hotkey[++idx] = FALSE;
3490 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3492 if (*r == DLG_HOTKEY_CHAR)
3493 ++r;
3494 first_hotkey = FALSE;
3495 if (copy)
3497 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3498 *msgp++ = *r;
3499 else
3501 /* '&a' -> '[a]' */
3502 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3503 msgp += copy_char(r, msgp, FALSE);
3504 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3506 /* redefine hotkey */
3507 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
3510 else
3512 ++len; /* '&a' -> '[a]' */
3513 if (idx < HAS_HOTKEY_LEN - 1)
3514 has_hotkey[idx] = TRUE;
3517 else
3519 /* everything else copy literally */
3520 if (copy)
3521 msgp += copy_char(r, msgp, FALSE);
3524 /* advance to the next character */
3525 mb_ptr_adv(r);
3528 if (copy)
3530 *msgp++ = ':';
3531 *msgp++ = ' ';
3532 *msgp = NUL;
3534 else
3536 len += (int)(STRLEN(message)
3537 + 2 /* for the NL's */
3538 + STRLEN(buttons)
3539 + 3); /* for the ": " and NUL */
3540 lenhotkey++; /* for the NUL */
3542 /* If no hotkey is specified first char is used. */
3543 if (!has_hotkey[0])
3545 first_hotkey = TRUE;
3546 len += 2; /* "x" -> "[x]" */
3550 * Now allocate and load the strings
3552 vim_free(confirm_msg);
3553 confirm_msg = alloc(len);
3554 if (confirm_msg == NULL)
3555 return NULL;
3556 *confirm_msg = NUL;
3557 hotk = alloc(lenhotkey);
3558 if (hotk == NULL)
3559 return NULL;
3561 *confirm_msg = '\n';
3562 STRCPY(confirm_msg + 1, message);
3564 msgp = confirm_msg + 1 + STRLEN(message);
3565 hotkp = hotk;
3567 /* Define first default hotkey. Keep the hotkey string NUL
3568 * terminated to avoid reading past the end. */
3569 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
3571 /* Remember where the choices start, displaying starts here when
3572 * "hotkp" typed at the more prompt. */
3573 confirm_msg_tail = msgp;
3574 *msgp++ = '\n';
3578 display_confirm_msg();
3579 return hotk;
3583 * Display the ":confirm" message. Also called when screen resized.
3585 void
3586 display_confirm_msg()
3588 /* avoid that 'q' at the more prompt truncates the message here */
3589 ++confirm_msg_used;
3590 if (confirm_msg != NULL)
3591 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3592 --confirm_msg_used;
3595 #endif /* FEAT_CON_DIALOG */
3597 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3600 vim_dialog_yesno(type, title, message, dflt)
3601 int type;
3602 char_u *title;
3603 char_u *message;
3604 int dflt;
3606 if (do_dialog(type,
3607 title == NULL ? (char_u *)_("Question") : title,
3608 message,
3609 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3610 return VIM_YES;
3611 return VIM_NO;
3615 vim_dialog_yesnocancel(type, title, message, dflt)
3616 int type;
3617 char_u *title;
3618 char_u *message;
3619 int dflt;
3621 switch (do_dialog(type,
3622 title == NULL ? (char_u *)_("Question") : title,
3623 message,
3624 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3626 case 1: return VIM_YES;
3627 case 2: return VIM_NO;
3629 return VIM_CANCEL;
3633 vim_dialog_yesnoallcancel(type, title, message, dflt)
3634 int type;
3635 char_u *title;
3636 char_u *message;
3637 int dflt;
3639 switch (do_dialog(type,
3640 title == NULL ? (char_u *)"Question" : title,
3641 message,
3642 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3643 dflt, NULL))
3645 case 1: return VIM_YES;
3646 case 2: return VIM_NO;
3647 case 3: return VIM_ALL;
3648 case 4: return VIM_DISCARDALL;
3650 return VIM_CANCEL;
3653 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3655 #if defined(FEAT_BROWSE) || defined(PROTO)
3657 * Generic browse function. Calls gui_mch_browse() when possible.
3658 * Later this may pop-up a non-GUI file selector (external command?).
3660 char_u *
3661 do_browse(flags, title, dflt, ext, initdir, filter, buf)
3662 int flags; /* BROWSE_SAVE and BROWSE_DIR */
3663 char_u *title; /* title for the window */
3664 char_u *dflt; /* default file name (may include directory) */
3665 char_u *ext; /* extension added */
3666 char_u *initdir; /* initial directory, NULL for current dir or
3667 when using path from "dflt" */
3668 char_u *filter; /* file name filter */
3669 buf_T *buf; /* buffer to read/write for */
3671 char_u *fname;
3672 static char_u *last_dir = NULL; /* last used directory */
3673 char_u *tofree = NULL;
3674 int save_browse = cmdmod.browse;
3676 /* Must turn off browse to avoid that autocommands will get the
3677 * flag too! */
3678 cmdmod.browse = FALSE;
3680 if (title == NULL || *title == NUL)
3682 if (flags & BROWSE_DIR)
3683 title = (char_u *)_("Select Directory dialog");
3684 else if (flags & BROWSE_SAVE)
3685 title = (char_u *)_("Save File dialog");
3686 else
3687 title = (char_u *)_("Open File dialog");
3690 /* When no directory specified, use default file name, default dir, buffer
3691 * dir, last dir or current dir */
3692 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3694 if (mch_isdir(dflt)) /* default file name is a directory */
3696 initdir = dflt;
3697 dflt = NULL;
3699 else if (gettail(dflt) != dflt) /* default file name includes a path */
3701 tofree = vim_strsave(dflt);
3702 if (tofree != NULL)
3704 initdir = tofree;
3705 *gettail(initdir) = NUL;
3706 dflt = gettail(dflt);
3711 if (initdir == NULL || *initdir == NUL)
3713 /* When 'browsedir' is a directory, use it */
3714 if (STRCMP(p_bsdir, "last") != 0
3715 && STRCMP(p_bsdir, "buffer") != 0
3716 && STRCMP(p_bsdir, "current") != 0
3717 && mch_isdir(p_bsdir))
3718 initdir = p_bsdir;
3719 /* When saving or 'browsedir' is "buffer", use buffer fname */
3720 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
3721 && buf != NULL && buf->b_ffname != NULL)
3723 if (dflt == NULL || *dflt == NUL)
3724 dflt = gettail(curbuf->b_ffname);
3725 tofree = vim_strsave(curbuf->b_ffname);
3726 if (tofree != NULL)
3728 initdir = tofree;
3729 *gettail(initdir) = NUL;
3732 /* When 'browsedir' is "last", use dir from last browse */
3733 else if (*p_bsdir == 'l')
3734 initdir = last_dir;
3735 /* When 'browsedir is "current", use current directory. This is the
3736 * default already, leave initdir empty. */
3739 # ifdef FEAT_GUI
3740 if (gui.in_use) /* when this changes, also adjust f_has()! */
3742 if (filter == NULL
3743 # ifdef FEAT_EVAL
3744 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3745 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3746 # endif
3748 filter = BROWSE_FILTER_DEFAULT;
3749 if (flags & BROWSE_DIR)
3751 # if defined(HAVE_GTK2) || defined(WIN3264)
3752 /* For systems that have a directory dialog. */
3753 fname = gui_mch_browsedir(title, initdir);
3754 # else
3755 /* Generic solution for selecting a directory: select a file and
3756 * remove the file name. */
3757 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3758 # endif
3759 # if !defined(HAVE_GTK2)
3760 /* Win32 adds a dummy file name, others return an arbitrary file
3761 * name. GTK+ 2 returns only the directory, */
3762 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3764 /* Remove the file name. */
3765 char_u *tail = gettail_sep(fname);
3767 if (tail == fname)
3768 *tail++ = '.'; /* use current dir */
3769 *tail = NUL;
3771 # endif
3773 else
3774 fname = gui_mch_browse(flags & BROWSE_SAVE,
3775 title, dflt, ext, initdir, filter);
3777 /* We hang around in the dialog for a while, the user might do some
3778 * things to our files. The Win32 dialog allows deleting or renaming
3779 * a file, check timestamps. */
3780 need_check_timestamps = TRUE;
3781 did_check_timestamps = FALSE;
3783 else
3784 # endif
3786 /* TODO: non-GUI file selector here */
3787 EMSG(_("E338: Sorry, no file browser in console mode"));
3788 fname = NULL;
3791 /* keep the directory for next time */
3792 if (fname != NULL)
3794 vim_free(last_dir);
3795 last_dir = vim_strsave(fname);
3796 if (last_dir != NULL && !(flags & BROWSE_DIR))
3798 *gettail(last_dir) = NUL;
3799 if (*last_dir == NUL)
3801 /* filename only returned, must be in current dir */
3802 vim_free(last_dir);
3803 last_dir = alloc(MAXPATHL);
3804 if (last_dir != NULL)
3805 mch_dirname(last_dir, MAXPATHL);
3810 vim_free(tofree);
3811 cmdmod.browse = save_browse;
3813 return fname;
3815 #endif
3817 #if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3818 static char *e_printf = N_("E766: Insufficient arguments for printf()");
3820 static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3821 static char *tv_str __ARGS((typval_T *tvs, int *idxp));
3824 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3826 static long
3827 tv_nr(tvs, idxp)
3828 typval_T *tvs;
3829 int *idxp;
3831 int idx = *idxp - 1;
3832 long n = 0;
3833 int err = FALSE;
3835 if (tvs[idx].v_type == VAR_UNKNOWN)
3836 EMSG(_(e_printf));
3837 else
3839 ++*idxp;
3840 n = get_tv_number_chk(&tvs[idx], &err);
3841 if (err)
3842 n = 0;
3844 return n;
3848 * Get string argument from "idxp" entry in "tvs". First entry is 1.
3849 * Returns NULL for an error.
3851 static char *
3852 tv_str(tvs, idxp)
3853 typval_T *tvs;
3854 int *idxp;
3856 int idx = *idxp - 1;
3857 char *s = NULL;
3859 if (tvs[idx].v_type == VAR_UNKNOWN)
3860 EMSG(_(e_printf));
3861 else
3863 ++*idxp;
3864 s = (char *)get_tv_string_chk(&tvs[idx]);
3866 return s;
3868 #endif
3871 * This code was included to provide a portable vsnprintf() and snprintf().
3872 * Some systems may provide their own, but we always use this one for
3873 * consistency.
3875 * This code is based on snprintf.c - a portable implementation of snprintf
3876 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
3877 * Included with permission. It was heavily modified to fit in Vim.
3878 * The original code, including useful comments, can be found here:
3879 * http://www.ijs.si/software/snprintf/
3881 * This snprintf() only supports the following conversion specifiers:
3882 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3883 * with flags: '-', '+', ' ', '0' and '#'.
3884 * An asterisk is supported for field width as well as precision.
3886 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3887 * 'll' (long long int) is not supported.
3889 * The locale is not used, the string is used as a byte string. This is only
3890 * relevant for double-byte encodings where the second byte may be '%'.
3892 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3893 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
3895 * The return value is the number of characters which would be generated
3896 * for the given input, excluding the trailing null. If this value
3897 * is greater or equal to "str_m", not all characters from the result
3898 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3899 * are discarded. If "str_m" is greater than zero it is guaranteed
3900 * the resulting string will be null-terminated.
3904 * When va_list is not supported we only define vim_snprintf().
3906 * vim_vsnprintf() can be invoked with either "va_list" or a list of
3907 * "typval_T". When the latter is not used it must be NULL.
3910 /* When generating prototypes all of this is skipped, cproto doesn't
3911 * understand this. */
3912 #ifndef PROTO
3913 # ifdef HAVE_STDARG_H
3915 vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3917 va_list ap;
3918 int str_l;
3920 va_start(ap, fmt);
3921 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
3922 va_end(ap);
3923 return str_l;
3927 vim_vsnprintf(str, str_m, fmt, ap, tvs)
3928 # else
3929 /* clumsy way to work around missing va_list */
3930 # 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)
3932 /* VARARGS */
3934 #ifdef __BORLANDC__
3935 _RTLENTRYF
3936 #endif
3937 vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
3938 # endif
3939 char *str;
3940 size_t str_m;
3941 char *fmt;
3942 # ifdef HAVE_STDARG_H
3943 va_list ap;
3944 typval_T *tvs;
3945 # else
3946 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
3947 # endif
3949 size_t str_l = 0;
3950 char *p = fmt;
3951 int arg_idx = 1;
3953 if (p == NULL)
3954 p = "";
3955 while (*p != NUL)
3957 if (*p != '%')
3959 char *q = strchr(p + 1, '%');
3960 size_t n = (q == NULL) ? STRLEN(p) : (q - p);
3962 /* Copy up to the next '%' or NUL without any changes. */
3963 if (str_l < str_m)
3965 size_t avail = str_m - str_l;
3967 mch_memmove(str + str_l, p, n > avail ? avail : n);
3969 p += n;
3970 str_l += n;
3972 else
3974 size_t min_field_width = 0, precision = 0;
3975 int zero_padding = 0, precision_specified = 0, justify_left = 0;
3976 int alternate_form = 0, force_sign = 0;
3978 /* If both the ' ' and '+' flags appear, the ' ' flag should be
3979 * ignored. */
3980 int space_for_positive = 1;
3982 /* allowed values: \0, h, l, L */
3983 char length_modifier = '\0';
3985 /* temporary buffer for simple numeric->string conversion */
3986 char tmp[32];
3988 /* string address in case of string argument */
3989 char *str_arg;
3991 /* natural field width of arg without padding and sign */
3992 size_t str_arg_l;
3994 /* unsigned char argument value - only defined for c conversion.
3995 * N.B. standard explicitly states the char argument for the c
3996 * conversion is unsigned */
3997 unsigned char uchar_arg;
3999 /* number of zeros to be inserted for numeric conversions as
4000 * required by the precision or minimal field width */
4001 size_t number_of_zeros_to_pad = 0;
4003 /* index into tmp where zero padding is to be inserted */
4004 size_t zero_padding_insertion_ind = 0;
4006 /* current conversion specifier character */
4007 char fmt_spec = '\0';
4009 str_arg = NULL;
4010 p++; /* skip '%' */
4012 /* parse flags */
4013 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4014 || *p == '#' || *p == '\'')
4016 switch (*p)
4018 case '0': zero_padding = 1; break;
4019 case '-': justify_left = 1; break;
4020 case '+': force_sign = 1; space_for_positive = 0; break;
4021 case ' ': force_sign = 1;
4022 /* If both the ' ' and '+' flags appear, the ' '
4023 * flag should be ignored */
4024 break;
4025 case '#': alternate_form = 1; break;
4026 case '\'': break;
4028 p++;
4030 /* If the '0' and '-' flags both appear, the '0' flag should be
4031 * ignored. */
4033 /* parse field width */
4034 if (*p == '*')
4036 int j;
4038 p++;
4040 #ifndef HAVE_STDARG_H
4041 get_a_arg(arg_idx);
4042 #else
4043 # if defined(FEAT_EVAL)
4044 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4045 # endif
4046 va_arg(ap, int);
4047 #endif
4048 if (j >= 0)
4049 min_field_width = j;
4050 else
4052 min_field_width = -j;
4053 justify_left = 1;
4056 else if (VIM_ISDIGIT((int)(*p)))
4058 /* size_t could be wider than unsigned int; make sure we treat
4059 * argument like common implementations do */
4060 unsigned int uj = *p++ - '0';
4062 while (VIM_ISDIGIT((int)(*p)))
4063 uj = 10 * uj + (unsigned int)(*p++ - '0');
4064 min_field_width = uj;
4067 /* parse precision */
4068 if (*p == '.')
4070 p++;
4071 precision_specified = 1;
4072 if (*p == '*')
4074 int j;
4077 #ifndef HAVE_STDARG_H
4078 get_a_arg(arg_idx);
4079 #else
4080 # if defined(FEAT_EVAL)
4081 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4082 # endif
4083 va_arg(ap, int);
4084 #endif
4085 p++;
4086 if (j >= 0)
4087 precision = j;
4088 else
4090 precision_specified = 0;
4091 precision = 0;
4094 else if (VIM_ISDIGIT((int)(*p)))
4096 /* size_t could be wider than unsigned int; make sure we
4097 * treat argument like common implementations do */
4098 unsigned int uj = *p++ - '0';
4100 while (VIM_ISDIGIT((int)(*p)))
4101 uj = 10 * uj + (unsigned int)(*p++ - '0');
4102 precision = uj;
4106 /* parse 'h', 'l' and 'll' length modifiers */
4107 if (*p == 'h' || *p == 'l')
4109 length_modifier = *p;
4110 p++;
4111 if (length_modifier == 'l' && *p == 'l')
4113 /* double l = long long */
4114 length_modifier = 'l'; /* treat it as a single 'l' */
4115 p++;
4118 fmt_spec = *p;
4120 /* common synonyms: */
4121 switch (fmt_spec)
4123 case 'i': fmt_spec = 'd'; break;
4124 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4125 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4126 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4127 default: break;
4130 /* get parameter value, do initial processing */
4131 switch (fmt_spec)
4133 /* '%' and 'c' behave similar to 's' regarding flags and field
4134 * widths */
4135 case '%':
4136 case 'c':
4137 case 's':
4138 length_modifier = '\0';
4139 str_arg_l = 1;
4140 switch (fmt_spec)
4142 case '%':
4143 str_arg = p;
4144 break;
4146 case 'c':
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 /* standard demands unsigned char */
4160 uchar_arg = (unsigned char)j;
4161 str_arg = (char *)&uchar_arg;
4162 break;
4165 case 's':
4166 str_arg =
4167 #ifndef HAVE_STDARG_H
4168 (char *)get_a_arg(arg_idx);
4169 #else
4170 # if defined(FEAT_EVAL)
4171 tvs != NULL ? tv_str(tvs, &arg_idx) :
4172 # endif
4173 va_arg(ap, char *);
4174 #endif
4175 if (str_arg == NULL)
4177 str_arg = "[NULL]";
4178 str_arg_l = 6;
4180 /* make sure not to address string beyond the specified
4181 * precision !!! */
4182 else if (!precision_specified)
4183 str_arg_l = strlen(str_arg);
4184 /* truncate string if necessary as requested by precision */
4185 else if (precision == 0)
4186 str_arg_l = 0;
4187 else
4189 /* Don't put the #if inside memchr(), it can be a
4190 * macro. */
4191 #if SIZEOF_INT <= 2
4192 char *q = memchr(str_arg, '\0', precision);
4193 #else
4194 /* memchr on HP does not like n > 2^31 !!! */
4195 char *q = memchr(str_arg, '\0',
4196 precision <= (size_t)0x7fffffffL ? precision
4197 : (size_t)0x7fffffffL);
4198 #endif
4199 str_arg_l = (q == NULL) ? precision : q - str_arg;
4201 break;
4203 default:
4204 break;
4206 break;
4208 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4210 /* NOTE: the u, o, x, X and p conversion specifiers
4211 * imply the value is unsigned; d implies a signed
4212 * value */
4214 /* 0 if numeric argument is zero (or if pointer is
4215 * NULL for 'p'), +1 if greater than zero (or nonzero
4216 * for unsigned arguments), -1 if negative (unsigned
4217 * argument is never negative) */
4218 int arg_sign = 0;
4220 /* only defined for length modifier h, or for no
4221 * length modifiers */
4222 int int_arg = 0;
4223 unsigned int uint_arg = 0;
4225 /* only defined for length modifier l */
4226 long int long_arg = 0;
4227 unsigned long int ulong_arg = 0;
4229 /* pointer argument value -only defined for p
4230 * conversion */
4231 void *ptr_arg = NULL;
4233 if (fmt_spec == 'p')
4235 length_modifier = '\0';
4236 ptr_arg =
4237 #ifndef HAVE_STDARG_H
4238 (void *)get_a_arg(arg_idx);
4239 #else
4240 # if defined(FEAT_EVAL)
4241 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
4242 # endif
4243 va_arg(ap, void *);
4244 #endif
4245 if (ptr_arg != NULL)
4246 arg_sign = 1;
4248 else if (fmt_spec == 'd')
4250 /* signed */
4251 switch (length_modifier)
4253 case '\0':
4254 case 'h':
4255 /* char and short arguments are passed as int. */
4256 int_arg =
4257 #ifndef HAVE_STDARG_H
4258 get_a_arg(arg_idx);
4259 #else
4260 # if defined(FEAT_EVAL)
4261 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4262 # endif
4263 va_arg(ap, int);
4264 #endif
4265 if (int_arg > 0)
4266 arg_sign = 1;
4267 else if (int_arg < 0)
4268 arg_sign = -1;
4269 break;
4270 case 'l':
4271 long_arg =
4272 #ifndef HAVE_STDARG_H
4273 get_a_arg(arg_idx);
4274 #else
4275 # if defined(FEAT_EVAL)
4276 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4277 # endif
4278 va_arg(ap, long int);
4279 #endif
4280 if (long_arg > 0)
4281 arg_sign = 1;
4282 else if (long_arg < 0)
4283 arg_sign = -1;
4284 break;
4287 else
4289 /* unsigned */
4290 switch (length_modifier)
4292 case '\0':
4293 case 'h':
4294 uint_arg =
4295 #ifndef HAVE_STDARG_H
4296 get_a_arg(arg_idx);
4297 #else
4298 # if defined(FEAT_EVAL)
4299 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4300 # endif
4301 va_arg(ap, unsigned int);
4302 #endif
4303 if (uint_arg != 0)
4304 arg_sign = 1;
4305 break;
4306 case 'l':
4307 ulong_arg =
4308 #ifndef HAVE_STDARG_H
4309 get_a_arg(arg_idx);
4310 #else
4311 # if defined(FEAT_EVAL)
4312 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4313 # endif
4314 va_arg(ap, unsigned long int);
4315 #endif
4316 if (ulong_arg != 0)
4317 arg_sign = 1;
4318 break;
4322 str_arg = tmp;
4323 str_arg_l = 0;
4325 /* NOTE:
4326 * For d, i, u, o, x, and X conversions, if precision is
4327 * specified, the '0' flag should be ignored. This is so
4328 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4329 * FreeBSD, NetBSD; but not with Perl.
4331 if (precision_specified)
4332 zero_padding = 0;
4333 if (fmt_spec == 'd')
4335 if (force_sign && arg_sign >= 0)
4336 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4337 /* leave negative numbers for sprintf to handle, to
4338 * avoid handling tricky cases like (short int)-32768 */
4340 else if (alternate_form)
4342 if (arg_sign != 0
4343 && (fmt_spec == 'x' || fmt_spec == 'X') )
4345 tmp[str_arg_l++] = '0';
4346 tmp[str_arg_l++] = fmt_spec;
4348 /* alternate form should have no effect for p
4349 * conversion, but ... */
4352 zero_padding_insertion_ind = str_arg_l;
4353 if (!precision_specified)
4354 precision = 1; /* default precision is 1 */
4355 if (precision == 0 && arg_sign == 0)
4357 /* When zero value is formatted with an explicit
4358 * precision 0, the resulting formatted string is
4359 * empty (d, i, u, o, x, X, p). */
4361 else
4363 char f[5];
4364 int f_l = 0;
4366 /* construct a simple format string for sprintf */
4367 f[f_l++] = '%';
4368 if (!length_modifier)
4370 else if (length_modifier == '2')
4372 f[f_l++] = 'l';
4373 f[f_l++] = 'l';
4375 else
4376 f[f_l++] = length_modifier;
4377 f[f_l++] = fmt_spec;
4378 f[f_l++] = '\0';
4380 if (fmt_spec == 'p')
4381 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4382 else if (fmt_spec == 'd')
4384 /* signed */
4385 switch (length_modifier)
4387 case '\0':
4388 case 'h': str_arg_l += sprintf(
4389 tmp + str_arg_l, f, int_arg);
4390 break;
4391 case 'l': str_arg_l += sprintf(
4392 tmp + str_arg_l, f, long_arg);
4393 break;
4396 else
4398 /* unsigned */
4399 switch (length_modifier)
4401 case '\0':
4402 case 'h': str_arg_l += sprintf(
4403 tmp + str_arg_l, f, uint_arg);
4404 break;
4405 case 'l': str_arg_l += sprintf(
4406 tmp + str_arg_l, f, ulong_arg);
4407 break;
4411 /* include the optional minus sign and possible
4412 * "0x" in the region before the zero padding
4413 * insertion point */
4414 if (zero_padding_insertion_ind < str_arg_l
4415 && tmp[zero_padding_insertion_ind] == '-')
4416 zero_padding_insertion_ind++;
4417 if (zero_padding_insertion_ind + 1 < str_arg_l
4418 && tmp[zero_padding_insertion_ind] == '0'
4419 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4420 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4421 zero_padding_insertion_ind += 2;
4425 size_t num_of_digits = str_arg_l
4426 - zero_padding_insertion_ind;
4428 if (alternate_form && fmt_spec == 'o'
4429 /* unless zero is already the first
4430 * character */
4431 && !(zero_padding_insertion_ind < str_arg_l
4432 && tmp[zero_padding_insertion_ind] == '0'))
4434 /* assure leading zero for alternate-form
4435 * octal numbers */
4436 if (!precision_specified
4437 || precision < num_of_digits + 1)
4439 /* precision is increased to force the
4440 * first character to be zero, except if a
4441 * zero value is formatted with an
4442 * explicit precision of zero */
4443 precision = num_of_digits + 1;
4444 precision_specified = 1;
4447 /* zero padding to specified precision? */
4448 if (num_of_digits < precision)
4449 number_of_zeros_to_pad = precision - num_of_digits;
4451 /* zero padding to specified minimal field width? */
4452 if (!justify_left && zero_padding)
4454 int n = (int)(min_field_width - (str_arg_l
4455 + number_of_zeros_to_pad));
4456 if (n > 0)
4457 number_of_zeros_to_pad += n;
4459 break;
4462 default:
4463 /* unrecognized conversion specifier, keep format string
4464 * as-is */
4465 zero_padding = 0; /* turn zero padding off for non-numeric
4466 conversion */
4467 justify_left = 1;
4468 min_field_width = 0; /* reset flags */
4470 /* discard the unrecognized conversion, just keep *
4471 * the unrecognized conversion character */
4472 str_arg = p;
4473 str_arg_l = 0;
4474 if (*p != NUL)
4475 str_arg_l++; /* include invalid conversion specifier
4476 unchanged if not at end-of-string */
4477 break;
4480 if (*p != NUL)
4481 p++; /* step over the just processed conversion specifier */
4483 /* insert padding to the left as requested by min_field_width;
4484 * this does not include the zero padding in case of numerical
4485 * conversions*/
4486 if (!justify_left)
4488 /* left padding with blank or zero */
4489 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4491 if (pn > 0)
4493 if (str_l < str_m)
4495 size_t avail = str_m - str_l;
4497 vim_memset(str + str_l, zero_padding ? '0' : ' ',
4498 (size_t)pn > avail ? avail : pn);
4500 str_l += pn;
4504 /* zero padding as requested by the precision or by the minimal
4505 * field width for numeric conversions required? */
4506 if (number_of_zeros_to_pad == 0)
4508 /* will not copy first part of numeric right now, *
4509 * force it to be copied later in its entirety */
4510 zero_padding_insertion_ind = 0;
4512 else
4514 /* insert first part of numerics (sign or '0x') before zero
4515 * padding */
4516 int zn = (int)zero_padding_insertion_ind;
4518 if (zn > 0)
4520 if (str_l < str_m)
4522 size_t avail = str_m - str_l;
4524 mch_memmove(str + str_l, str_arg,
4525 (size_t)zn > avail ? avail : zn);
4527 str_l += zn;
4530 /* insert zero padding as requested by the precision or min
4531 * field width */
4532 zn = (int)number_of_zeros_to_pad;
4533 if (zn > 0)
4535 if (str_l < str_m)
4537 size_t avail = str_m-str_l;
4539 vim_memset(str + str_l, '0',
4540 (size_t)zn > avail ? avail : zn);
4542 str_l += zn;
4546 /* insert formatted string
4547 * (or as-is conversion specifier for unknown conversions) */
4549 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
4551 if (sn > 0)
4553 if (str_l < str_m)
4555 size_t avail = str_m - str_l;
4557 mch_memmove(str + str_l,
4558 str_arg + zero_padding_insertion_ind,
4559 (size_t)sn > avail ? avail : sn);
4561 str_l += sn;
4565 /* insert right padding */
4566 if (justify_left)
4568 /* right blank padding to the field width */
4569 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4571 if (pn > 0)
4573 if (str_l < str_m)
4575 size_t avail = str_m - str_l;
4577 vim_memset(str + str_l, ' ',
4578 (size_t)pn > avail ? avail : pn);
4580 str_l += pn;
4586 if (str_m > 0)
4588 /* make sure the string is nul-terminated even at the expense of
4589 * overwriting the last character (shouldn't happen, but just in case)
4590 * */
4591 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4594 #ifdef HAVE_STDARG_H
4595 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
4596 EMSG(_("E767: Too many arguments to printf()"));
4597 #endif
4599 /* Return the number of characters formatted (excluding trailing nul
4600 * character), that is, the number of characters that would have been
4601 * written to the buffer if it were large enough. */
4602 return (int)str_l;
4605 #endif /* PROTO */