Synced with the latest developing branch.
[MacVim/jjgod.git] / src / message.c
blob9c574916353bbac032d3093be2a6b1357a1b6342
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; 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
948 * Allow scrolling back in the messages.
949 * Also accept scroll-down commands when messages fill the screen,
950 * to avoid that typing one 'j' too many makes the messages
951 * disappear.
953 if (p_more && !p_cp)
955 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
957 /* scroll back to show older messages */
958 do_more_prompt(c);
959 if (quit_more)
961 c = CAR; /* just pretend CR was hit */
962 quit_more = FALSE;
963 got_int = FALSE;
965 else
967 c = K_IGNORE;
968 hit_return_msg();
971 else if (msg_scrolled > Rows - 2
972 && (c == 'j' || c == K_DOWN || c == 'd'))
973 c = K_IGNORE;
975 } while ((had_got_int && c == Ctrl_C)
976 || c == K_IGNORE
977 #ifdef FEAT_GUI
978 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
979 #endif
980 #ifdef FEAT_MOUSE
981 || c == K_LEFTDRAG || c == K_LEFTRELEASE
982 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
983 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
984 || c == K_MOUSEDOWN || c == K_MOUSEUP
985 || (!mouse_has(MOUSE_RETURN)
986 && mouse_row < msg_row
987 && (c == K_LEFTMOUSE
988 || c == K_MIDDLEMOUSE
989 || c == K_RIGHTMOUSE
990 || c == K_X1MOUSE
991 || c == K_X2MOUSE))
992 #endif
994 ui_breakcheck();
995 #ifdef FEAT_MOUSE
997 * Avoid that the mouse-up event causes visual mode to start.
999 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1000 || c == K_X1MOUSE || c == K_X2MOUSE)
1001 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1002 else
1003 #endif
1004 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1006 /* Put the character back in the typeahead buffer. Don't use the
1007 * stuff buffer, because lmaps wouldn't work. */
1008 ins_char_typebuf(c);
1009 do_redraw = TRUE; /* need a redraw even though there is
1010 typeahead */
1013 redir_off = FALSE;
1016 * If the user hits ':', '?' or '/' we get a command line from the next
1017 * line.
1019 if (c == ':' || c == '?' || c == '/')
1021 if (!exmode_active)
1022 cmdline_row = msg_row;
1023 skip_redraw = TRUE; /* skip redraw once */
1024 do_redraw = FALSE;
1028 * If the window size changed set_shellsize() will redraw the screen.
1029 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1030 * typed.
1032 tmpState = State;
1033 State = oldState; /* restore State before set_shellsize */
1034 #ifdef FEAT_MOUSE
1035 setmouse();
1036 #endif
1037 msg_check();
1039 #if defined(UNIX) || defined(VMS)
1041 * When switching screens, we need to output an extra newline on exit.
1043 if (swapping_screen() && !termcap_active)
1044 newline_on_exit = TRUE;
1045 #endif
1047 need_wait_return = FALSE;
1048 did_wait_return = TRUE;
1049 emsg_on_display = FALSE; /* can delete error message now */
1050 lines_left = -1; /* reset lines_left at next msg_start() */
1051 reset_last_sourcing();
1052 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1053 (Rows - cmdline_row - 1) * Columns + sc_col)
1055 vim_free(keep_msg);
1056 keep_msg = NULL; /* don't redisplay message, it's too long */
1059 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1061 starttermcap(); /* start termcap before redrawing */
1062 shell_resized();
1064 else if (!skip_redraw
1065 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1067 starttermcap(); /* start termcap before redrawing */
1068 redraw_later(VALID);
1073 * Write the hit-return prompt.
1075 static void
1076 hit_return_msg()
1078 int save_p_more = p_more;
1080 p_more = FALSE; /* don't want see this message when scrolling back */
1081 if (msg_didout) /* start on a new line */
1082 msg_putchar('\n');
1083 if (got_int)
1084 MSG_PUTS(_("Interrupt: "));
1086 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
1087 if (!msg_use_printf())
1088 msg_clr_eos();
1089 p_more = save_p_more;
1093 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1095 void
1096 set_keep_msg(s, attr)
1097 char_u *s;
1098 int attr;
1100 vim_free(keep_msg);
1101 if (s != NULL && msg_silent == 0)
1102 keep_msg = vim_strsave(s);
1103 else
1104 keep_msg = NULL;
1105 keep_msg_more = FALSE;
1106 keep_msg_attr = attr;
1109 #if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1111 * If there currently is a message being displayed, set "keep_msg" to it, so
1112 * that it will be displayed again after redraw.
1114 void
1115 set_keep_msg_from_hist()
1117 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1118 && (State & NORMAL))
1119 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1121 #endif
1124 * Prepare for outputting characters in the command line.
1126 void
1127 msg_start()
1129 int did_return = FALSE;
1131 vim_free(keep_msg);
1132 keep_msg = NULL; /* don't display old message now */
1133 if (!msg_scroll && full_screen) /* overwrite last message */
1135 msg_row = cmdline_row;
1136 msg_col =
1137 #ifdef FEAT_RIGHTLEFT
1138 cmdmsg_rl ? Columns - 1 :
1139 #endif
1142 else if (msg_didout) /* start message on next line */
1144 msg_putchar('\n');
1145 did_return = TRUE;
1146 if (exmode_active != EXMODE_NORMAL)
1147 cmdline_row = msg_row;
1149 if (!msg_didany || lines_left < 0)
1150 msg_starthere();
1151 if (msg_silent == 0)
1153 msg_didout = FALSE; /* no output on current line yet */
1154 cursor_off();
1157 /* when redirecting, may need to start a new line. */
1158 if (!did_return)
1159 redir_write((char_u *)"\n", -1);
1163 * Note that the current msg position is where messages start.
1165 void
1166 msg_starthere()
1168 lines_left = cmdline_row;
1169 msg_didany = FALSE;
1172 void
1173 msg_putchar(c)
1174 int c;
1176 msg_putchar_attr(c, 0);
1179 void
1180 msg_putchar_attr(c, attr)
1181 int c;
1182 int attr;
1184 #ifdef FEAT_MBYTE
1185 char_u buf[MB_MAXBYTES + 1];
1186 #else
1187 char_u buf[4];
1188 #endif
1190 if (IS_SPECIAL(c))
1192 buf[0] = K_SPECIAL;
1193 buf[1] = K_SECOND(c);
1194 buf[2] = K_THIRD(c);
1195 buf[3] = NUL;
1197 else
1199 #ifdef FEAT_MBYTE
1200 buf[(*mb_char2bytes)(c, buf)] = NUL;
1201 #else
1202 buf[0] = c;
1203 buf[1] = NUL;
1204 #endif
1206 msg_puts_attr(buf, attr);
1209 void
1210 msg_outnum(n)
1211 long n;
1213 char_u buf[20];
1215 sprintf((char *)buf, "%ld", n);
1216 msg_puts(buf);
1219 void
1220 msg_home_replace(fname)
1221 char_u *fname;
1223 msg_home_replace_attr(fname, 0);
1226 #if defined(FEAT_FIND_ID) || defined(PROTO)
1227 void
1228 msg_home_replace_hl(fname)
1229 char_u *fname;
1231 msg_home_replace_attr(fname, hl_attr(HLF_D));
1233 #endif
1235 static void
1236 msg_home_replace_attr(fname, attr)
1237 char_u *fname;
1238 int attr;
1240 char_u *name;
1242 name = home_replace_save(NULL, fname);
1243 if (name != NULL)
1244 msg_outtrans_attr(name, attr);
1245 vim_free(name);
1249 * Output 'len' characters in 'str' (including NULs) with translation
1250 * if 'len' is -1, output upto a NUL character.
1251 * Use attributes 'attr'.
1252 * Return the number of characters it takes on the screen.
1255 msg_outtrans(str)
1256 char_u *str;
1258 return msg_outtrans_attr(str, 0);
1262 msg_outtrans_attr(str, attr)
1263 char_u *str;
1264 int attr;
1266 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1270 msg_outtrans_len(str, len)
1271 char_u *str;
1272 int len;
1274 return msg_outtrans_len_attr(str, len, 0);
1278 * Output one character at "p". Return pointer to the next character.
1279 * Handles multi-byte characters.
1281 char_u *
1282 msg_outtrans_one(p, attr)
1283 char_u *p;
1284 int attr;
1286 #ifdef FEAT_MBYTE
1287 int l;
1289 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
1291 msg_outtrans_len_attr(p, l, attr);
1292 return p + l;
1294 #endif
1295 msg_puts_attr(transchar_byte(*p), attr);
1296 return p + 1;
1300 msg_outtrans_len_attr(msgstr, len, attr)
1301 char_u *msgstr;
1302 int len;
1303 int attr;
1305 int retval = 0;
1306 char_u *str = msgstr;
1307 char_u *plain_start = msgstr;
1308 char_u *s;
1309 #ifdef FEAT_MBYTE
1310 int mb_l;
1311 int c;
1312 #endif
1314 /* if MSG_HIST flag set, add message to history */
1315 if (attr & MSG_HIST)
1317 add_msg_hist(str, len, attr);
1318 attr &= ~MSG_HIST;
1321 #ifdef FEAT_MBYTE
1322 /* If the string starts with a composing character first draw a space on
1323 * which the composing char can be drawn. */
1324 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1325 msg_puts_attr((char_u *)" ", attr);
1326 #endif
1329 * Go over the string. Special characters are translated and printed.
1330 * Normal characters are printed several at a time.
1332 while (--len >= 0)
1334 #ifdef FEAT_MBYTE
1335 if (enc_utf8)
1336 /* Don't include composing chars after the end. */
1337 mb_l = utfc_ptr2len_len(str, len + 1);
1338 else if (has_mbyte)
1339 mb_l = (*mb_ptr2len)(str);
1340 else
1341 mb_l = 1;
1342 if (has_mbyte && mb_l > 1)
1344 c = (*mb_ptr2char)(str);
1345 if (vim_isprintc(c))
1346 /* printable multi-byte char: count the cells. */
1347 retval += (*mb_ptr2cells)(str);
1348 else
1350 /* unprintable multi-byte char: print the printable chars so
1351 * far and the translation of the unprintable char. */
1352 if (str > plain_start)
1353 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1354 attr);
1355 plain_start = str + mb_l;
1356 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1357 retval += char2cells(c);
1359 len -= mb_l - 1;
1360 str += mb_l;
1362 else
1363 #endif
1365 s = transchar_byte(*str);
1366 if (s[1] != NUL)
1368 /* unprintable char: print the printable chars so far and the
1369 * translation of the unprintable char. */
1370 if (str > plain_start)
1371 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1372 attr);
1373 plain_start = str + 1;
1374 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
1376 retval += ptr2cells(str);
1377 ++str;
1381 if (str > plain_start)
1382 /* print the printable chars at the end */
1383 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1385 return retval;
1388 #if defined(FEAT_QUICKFIX) || defined(PROTO)
1389 void
1390 msg_make(arg)
1391 char_u *arg;
1393 int i;
1394 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1396 arg = skipwhite(arg);
1397 for (i = 5; *arg && i >= 0; --i)
1398 if (*arg++ != str[i])
1399 break;
1400 if (i < 0)
1402 msg_putchar('\n');
1403 for (i = 0; rs[i]; ++i)
1404 msg_putchar(rs[i] - 3);
1407 #endif
1410 * Output the string 'str' upto a NUL character.
1411 * Return the number of characters it takes on the screen.
1413 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1414 * following character and shown as <F1>, <S-Up> etc. Any other character
1415 * which is not printable shown in <> form.
1416 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1417 * If a character is displayed in one of these special ways, is also
1418 * highlighted (its highlight name is '8' in the p_hl variable).
1419 * Otherwise characters are not highlighted.
1420 * This function is used to show mappings, where we want to see how to type
1421 * the character/string -- webb
1424 msg_outtrans_special(strstart, from)
1425 char_u *strstart;
1426 int from; /* TRUE for lhs of a mapping */
1428 char_u *str = strstart;
1429 int retval = 0;
1430 char_u *string;
1431 int attr;
1432 int len;
1434 attr = hl_attr(HLF_8);
1435 while (*str != NUL)
1437 /* Leading and trailing spaces need to be displayed in <> form. */
1438 if ((str == strstart || str[1] == NUL) && *str == ' ')
1440 string = (char_u *)"<Space>";
1441 ++str;
1443 else
1444 string = str2special(&str, from);
1445 len = vim_strsize(string);
1446 /* Highlight special keys */
1447 msg_puts_attr(string, len > 1
1448 #ifdef FEAT_MBYTE
1449 && (*mb_ptr2len)(string) <= 1
1450 #endif
1451 ? attr : 0);
1452 retval += len;
1454 return retval;
1458 * Return the printable string for the key codes at "*sp".
1459 * Used for translating the lhs or rhs of a mapping to printable chars.
1460 * Advances "sp" to the next code.
1462 char_u *
1463 str2special(sp, from)
1464 char_u **sp;
1465 int from; /* TRUE for lhs of mapping */
1467 int c;
1468 static char_u buf[7];
1469 char_u *str = *sp;
1470 int modifiers = 0;
1471 int special = FALSE;
1473 #ifdef FEAT_MBYTE
1474 if (has_mbyte)
1476 char_u *p;
1478 /* Try to un-escape a multi-byte character. Return the un-escaped
1479 * string if it is a multi-byte character. */
1480 p = mb_unescape(sp);
1481 if (p != NULL)
1482 return p;
1484 #endif
1486 c = *str;
1487 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1489 if (str[1] == KS_MODIFIER)
1491 modifiers = str[2];
1492 str += 3;
1493 c = *str;
1495 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1497 c = TO_SPECIAL(str[1], str[2]);
1498 str += 2;
1499 if (c == K_ZERO) /* display <Nul> as ^@ */
1500 c = NUL;
1502 if (IS_SPECIAL(c) || modifiers) /* special key */
1503 special = TRUE;
1505 *sp = str + 1;
1507 #ifdef FEAT_MBYTE
1508 /* For multi-byte characters check for an illegal byte. */
1509 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
1511 transchar_nonprint(buf, c);
1512 return buf;
1514 #endif
1516 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1517 * Use <Space> only for lhs of a mapping. */
1518 if (special || char2cells(c) > 1 || (from && c == ' '))
1519 return get_special_key_name(c, modifiers);
1520 buf[0] = c;
1521 buf[1] = NUL;
1522 return buf;
1526 * Translate a key sequence into special key names.
1528 void
1529 str2specialbuf(sp, buf, len)
1530 char_u *sp;
1531 char_u *buf;
1532 int len;
1534 char_u *s;
1536 *buf = NUL;
1537 while (*sp)
1539 s = str2special(&sp, FALSE);
1540 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1541 STRCAT(buf, s);
1546 * print line for :print or :list command
1548 void
1549 msg_prt_line(s, list)
1550 char_u *s;
1551 int list;
1553 int c;
1554 int col = 0;
1555 int n_extra = 0;
1556 int c_extra = 0;
1557 char_u *p_extra = NULL; /* init to make SASC shut up */
1558 int n;
1559 int attr = 0;
1560 char_u *trail = NULL;
1561 #ifdef FEAT_MBYTE
1562 int l;
1563 char_u buf[MB_MAXBYTES + 1];
1564 #endif
1566 if (curwin->w_p_list)
1567 list = TRUE;
1569 /* find start of trailing whitespace */
1570 if (list && lcs_trail)
1572 trail = s + STRLEN(s);
1573 while (trail > s && vim_iswhite(trail[-1]))
1574 --trail;
1577 /* output a space for an empty line, otherwise the line will be
1578 * overwritten */
1579 if (*s == NUL && !(list && lcs_eol != NUL))
1580 msg_putchar(' ');
1582 while (!got_int)
1584 if (n_extra > 0)
1586 --n_extra;
1587 if (c_extra)
1588 c = c_extra;
1589 else
1590 c = *p_extra++;
1592 #ifdef FEAT_MBYTE
1593 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
1595 col += (*mb_ptr2cells)(s);
1596 mch_memmove(buf, s, (size_t)l);
1597 buf[l] = NUL;
1598 msg_puts(buf);
1599 s += l;
1600 continue;
1602 #endif
1603 else
1605 attr = 0;
1606 c = *s++;
1607 if (c == TAB && (!list || lcs_tab1))
1609 /* tab amount depends on current column */
1610 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
1611 if (!list)
1613 c = ' ';
1614 c_extra = ' ';
1616 else
1618 c = lcs_tab1;
1619 c_extra = lcs_tab2;
1620 attr = hl_attr(HLF_8);
1623 else if (c == NUL && list && lcs_eol != NUL)
1625 p_extra = (char_u *)"";
1626 c_extra = NUL;
1627 n_extra = 1;
1628 c = lcs_eol;
1629 attr = hl_attr(HLF_AT);
1630 --s;
1632 else if (c != NUL && (n = byte2cells(c)) > 1)
1634 n_extra = n - 1;
1635 p_extra = transchar_byte(c);
1636 c_extra = NUL;
1637 c = *p_extra++;
1638 /* Use special coloring to be able to distinguish <hex> from
1639 * the same in plain text. */
1640 attr = hl_attr(HLF_8);
1642 else if (c == ' ' && trail != NULL && s > trail)
1644 c = lcs_trail;
1645 attr = hl_attr(HLF_8);
1649 if (c == NUL)
1650 break;
1652 msg_putchar_attr(c, attr);
1653 col++;
1655 msg_clr_eos();
1658 #ifdef FEAT_MBYTE
1660 * Use screen_puts() to output one multi-byte character.
1661 * Return the pointer "s" advanced to the next character.
1663 static char_u *
1664 screen_puts_mbyte(s, l, attr)
1665 char_u *s;
1666 int l;
1667 int attr;
1669 int cw;
1671 msg_didout = TRUE; /* remember that line is not empty */
1672 cw = (*mb_ptr2cells)(s);
1673 if (cw > 1 && (
1674 #ifdef FEAT_RIGHTLEFT
1675 cmdmsg_rl ? msg_col <= 1 :
1676 #endif
1677 msg_col == Columns - 1))
1679 /* Doesn't fit, print a highlighted '>' to fill it up. */
1680 msg_screen_putchar('>', hl_attr(HLF_AT));
1681 return s;
1684 screen_puts_len(s, l, msg_row, msg_col, attr);
1685 #ifdef FEAT_RIGHTLEFT
1686 if (cmdmsg_rl)
1688 msg_col -= cw;
1689 if (msg_col == 0)
1691 msg_col = Columns;
1692 ++msg_row;
1695 else
1696 #endif
1698 msg_col += cw;
1699 if (msg_col >= Columns)
1701 msg_col = 0;
1702 ++msg_row;
1705 return s + l;
1707 #endif
1710 * Output a string to the screen at position msg_row, msg_col.
1711 * Update msg_row and msg_col for the next message.
1713 void
1714 msg_puts(s)
1715 char_u *s;
1717 msg_puts_attr(s, 0);
1720 void
1721 msg_puts_title(s)
1722 char_u *s;
1724 msg_puts_attr(s, hl_attr(HLF_T));
1728 * Show a message in such a way that it always fits in the line. Cut out a
1729 * part in the middle and replace it with "..." when necessary.
1730 * Does not handle multi-byte characters!
1732 void
1733 msg_puts_long_attr(longstr, attr)
1734 char_u *longstr;
1735 int attr;
1737 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1740 void
1741 msg_puts_long_len_attr(longstr, len, attr)
1742 char_u *longstr;
1743 int len;
1744 int attr;
1746 int slen = len;
1747 int room;
1749 room = Columns - msg_col;
1750 if (len > room && room >= 20)
1752 slen = (room - 3) / 2;
1753 msg_outtrans_len_attr(longstr, slen, attr);
1754 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1756 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1760 * Basic function for writing a message with highlight attributes.
1762 void
1763 msg_puts_attr(s, attr)
1764 char_u *s;
1765 int attr;
1767 msg_puts_attr_len(s, -1, attr);
1771 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1772 * When "maxlen" is -1 there is no maximum length.
1773 * When "maxlen" is >= 0 the message is not put in the history.
1775 static void
1776 msg_puts_attr_len(str, maxlen, attr)
1777 char_u *str;
1778 int maxlen;
1779 int attr;
1782 * If redirection is on, also write to the redirection file.
1784 redir_write(str, maxlen);
1787 * Don't print anything when using ":silent cmd".
1789 if (msg_silent != 0)
1790 return;
1792 /* if MSG_HIST flag set, add message to history */
1793 if ((attr & MSG_HIST) && maxlen < 0)
1795 add_msg_hist(str, -1, attr);
1796 attr &= ~MSG_HIST;
1800 * When writing something to the screen after it has scrolled, requires a
1801 * wait-return prompt later. Needed when scrolling, resetting
1802 * need_wait_return after some prompt, and then outputting something
1803 * without scrolling
1805 if (msg_scrolled != 0 && !msg_scrolled_ign)
1806 need_wait_return = TRUE;
1807 msg_didany = TRUE; /* remember that something was outputted */
1810 * If there is no valid screen, use fprintf so we can see error messages.
1811 * If termcap is not active, we may be writing in an alternate console
1812 * window, cursor positioning may not work correctly (window size may be
1813 * different, e.g. for Win32 console) or we just don't know where the
1814 * cursor is.
1816 if (msg_use_printf())
1817 msg_puts_printf(str, maxlen);
1818 else
1819 msg_puts_display(str, maxlen, attr, FALSE);
1823 * The display part of msg_puts_attr_len().
1824 * May be called recursively to display scroll-back text.
1826 static void
1827 msg_puts_display(str, maxlen, attr, recurse)
1828 char_u *str;
1829 int maxlen;
1830 int attr;
1831 int recurse;
1833 char_u *s = str;
1834 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1835 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1836 #ifdef FEAT_MBYTE
1837 int l;
1838 int cw;
1839 #endif
1840 char_u *sb_str = str;
1841 int sb_col = msg_col;
1842 int wrap;
1844 did_wait_return = FALSE;
1845 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
1848 * We are at the end of the screen line when:
1849 * - When outputting a newline.
1850 * - When outputting a character in the last column.
1852 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
1853 #ifdef FEAT_RIGHTLEFT
1854 cmdmsg_rl
1856 msg_col <= 1
1857 || (*s == TAB && msg_col <= 7)
1858 # ifdef FEAT_MBYTE
1859 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1860 # endif
1863 #endif
1864 (msg_col + t_col >= Columns - 1
1865 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1866 # ifdef FEAT_MBYTE
1867 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1868 && msg_col + t_col >= Columns - 2)
1869 # endif
1870 ))))
1873 * The screen is scrolled up when at the last row (some terminals
1874 * scroll automatically, some don't. To avoid problems we scroll
1875 * ourselves).
1877 if (t_col > 0)
1878 /* output postponed text */
1879 t_puts(&t_col, t_s, s, attr);
1881 /* When no more prompt an no more room, truncate here */
1882 if (msg_no_more && lines_left == 0)
1883 break;
1885 /* Scroll the screen up one line. */
1886 msg_scroll_up();
1888 msg_row = Rows - 2;
1889 if (msg_col >= Columns) /* can happen after screen resize */
1890 msg_col = Columns - 1;
1892 /* Display char in last column before showing more-prompt. */
1893 if (*s >= ' '
1894 #ifdef FEAT_RIGHTLEFT
1895 && !cmdmsg_rl
1896 #endif
1899 #ifdef FEAT_MBYTE
1900 if (has_mbyte)
1902 if (enc_utf8 && maxlen >= 0)
1903 /* avoid including composing chars after the end */
1904 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
1905 else
1906 l = (*mb_ptr2len)(s);
1907 s = screen_puts_mbyte(s, l, attr);
1909 else
1910 #endif
1911 msg_screen_putchar(*s++, attr);
1914 if (p_more)
1915 /* store text for scrolling back */
1916 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1918 inc_msg_scrolled();
1919 need_wait_return = TRUE; /* may need wait_return in main() */
1920 if (must_redraw < VALID)
1921 must_redraw = VALID;
1922 redraw_cmdline = TRUE;
1923 if (cmdline_row > 0 && !exmode_active)
1924 --cmdline_row;
1927 * If screen is completely filled and 'more' is set then wait
1928 * for a character.
1930 --lines_left;
1931 if (p_more && lines_left == 0 && State != HITRETURN
1932 && !msg_no_more && !exmode_active)
1934 #ifdef FEAT_CON_DIALOG
1935 if (do_more_prompt(NUL))
1936 s = confirm_msg_tail;
1937 #else
1938 (void)do_more_prompt(NUL);
1939 #endif
1940 if (quit_more)
1941 return;
1944 /* When we displayed a char in last column need to check if there
1945 * is still more. */
1946 if (*s >= ' '
1947 #ifdef FEAT_RIGHTLEFT
1948 && !cmdmsg_rl
1949 #endif
1951 continue;
1954 wrap = *s == '\n'
1955 || msg_col + t_col >= Columns
1956 #ifdef FEAT_MBYTE
1957 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1958 && msg_col + t_col >= Columns - 1)
1959 #endif
1961 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1962 || *s == '\t' || *s == BELL))
1963 /* output any postponed text */
1964 t_puts(&t_col, t_s, s, attr);
1966 if (wrap && p_more && !recurse)
1967 /* store text for scrolling back */
1968 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1970 if (*s == '\n') /* go to next line */
1972 msg_didout = FALSE; /* remember that line is empty */
1973 #ifdef FEAT_RIGHTLEFT
1974 if (cmdmsg_rl)
1975 msg_col = Columns - 1;
1976 else
1977 #endif
1978 msg_col = 0;
1979 if (++msg_row >= Rows) /* safety check */
1980 msg_row = Rows - 1;
1982 else if (*s == '\r') /* go to column 0 */
1984 msg_col = 0;
1986 else if (*s == '\b') /* go to previous char */
1988 if (msg_col)
1989 --msg_col;
1991 else if (*s == TAB) /* translate Tab into spaces */
1994 msg_screen_putchar(' ', attr);
1995 while (msg_col & 7);
1997 else if (*s == BELL) /* beep (from ":sh") */
1998 vim_beep();
1999 else
2001 #ifdef FEAT_MBYTE
2002 if (has_mbyte)
2004 cw = (*mb_ptr2cells)(s);
2005 if (enc_utf8 && maxlen >= 0)
2006 /* avoid including composing chars after the end */
2007 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
2008 else
2009 l = (*mb_ptr2len)(s);
2011 else
2013 cw = 1;
2014 l = 1;
2016 #endif
2017 /* When drawing from right to left or when a double-wide character
2018 * doesn't fit, draw a single character here. Otherwise collect
2019 * characters and draw them all at once later. */
2020 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2021 if (
2022 # ifdef FEAT_RIGHTLEFT
2023 cmdmsg_rl
2024 # ifdef FEAT_MBYTE
2026 # endif
2027 # endif
2028 # ifdef FEAT_MBYTE
2029 (cw > 1 && msg_col + t_col >= Columns - 1)
2030 # endif
2033 # ifdef FEAT_MBYTE
2034 if (l > 1)
2035 s = screen_puts_mbyte(s, l, attr) - 1;
2036 else
2037 # endif
2038 msg_screen_putchar(*s, attr);
2040 else
2041 #endif
2043 /* postpone this character until later */
2044 if (t_col == 0)
2045 t_s = s;
2046 #ifdef FEAT_MBYTE
2047 t_col += cw;
2048 s += l - 1;
2049 #else
2050 ++t_col;
2051 #endif
2054 ++s;
2057 /* output any postponed text */
2058 if (t_col > 0)
2059 t_puts(&t_col, t_s, s, attr);
2060 if (p_more && !recurse)
2061 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
2063 msg_check();
2067 * Scroll the screen up one line for displaying the next message line.
2069 static void
2070 msg_scroll_up()
2072 #ifdef FEAT_GUI
2073 /* Remove the cursor before scrolling, ScreenLines[] is going
2074 * to become invalid. */
2075 if (gui.in_use)
2076 gui_undraw_cursor();
2077 #endif
2078 /* scrolling up always works */
2079 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2081 if (!can_clear((char_u *)" "))
2083 /* Scrolling up doesn't result in the right background. Set the
2084 * background here. It's not efficient, but avoids that we have to do
2085 * it all over the code. */
2086 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2088 /* Also clear the last char of the last but one line if it was not
2089 * cleared before to avoid a scroll-up. */
2090 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2091 screen_fill((int)Rows - 2, (int)Rows - 1,
2092 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2097 * Increment "msg_scrolled".
2099 static void
2100 inc_msg_scrolled()
2102 #ifdef FEAT_EVAL
2103 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2105 char_u *p = sourcing_name;
2106 char_u *tofree = NULL;
2107 int len;
2109 /* v:scrollstart is empty, set it to the script/function name and line
2110 * number */
2111 if (p == NULL)
2112 p = (char_u *)_("Unknown");
2113 else
2115 len = (int)STRLEN(p) + 40;
2116 tofree = alloc(len);
2117 if (tofree != NULL)
2119 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2120 p, (long)sourcing_lnum);
2121 p = tofree;
2124 set_vim_var_string(VV_SCROLLSTART, p, -1);
2125 vim_free(tofree);
2127 #endif
2128 ++msg_scrolled;
2132 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2133 * store the displayed text and remember where screen lines start.
2135 typedef struct msgchunk_S msgchunk_T;
2136 struct msgchunk_S
2138 msgchunk_T *sb_next;
2139 msgchunk_T *sb_prev;
2140 char sb_eol; /* TRUE when line ends after this text */
2141 int sb_msg_col; /* column in which text starts */
2142 int sb_attr; /* text attributes */
2143 char_u sb_text[1]; /* text to be displayed, actually longer */
2146 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2148 static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2149 static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2151 static int do_clear_sb_text = FALSE; /* clear text on next msg */
2154 * Store part of a printed message for displaying when scrolling back.
2156 static void
2157 store_sb_text(sb_str, s, attr, sb_col, finish)
2158 char_u **sb_str; /* start of string */
2159 char_u *s; /* just after string */
2160 int attr;
2161 int *sb_col;
2162 int finish; /* line ends */
2164 msgchunk_T *mp;
2166 if (do_clear_sb_text)
2168 clear_sb_text();
2169 do_clear_sb_text = FALSE;
2172 if (s > *sb_str)
2174 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2175 if (mp != NULL)
2177 mp->sb_eol = finish;
2178 mp->sb_msg_col = *sb_col;
2179 mp->sb_attr = attr;
2180 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2182 if (last_msgchunk == NULL)
2184 last_msgchunk = mp;
2185 mp->sb_prev = NULL;
2187 else
2189 mp->sb_prev = last_msgchunk;
2190 last_msgchunk->sb_next = mp;
2191 last_msgchunk = mp;
2193 mp->sb_next = NULL;
2196 else if (finish && last_msgchunk != NULL)
2197 last_msgchunk->sb_eol = TRUE;
2199 *sb_str = s;
2200 *sb_col = 0;
2204 * Finished showing messages, clear the scroll-back text on the next message.
2206 void
2207 may_clear_sb_text()
2209 do_clear_sb_text = TRUE;
2213 * Clear any text remembered for scrolling back.
2214 * Called when redrawing the screen.
2216 void
2217 clear_sb_text()
2219 msgchunk_T *mp;
2221 while (last_msgchunk != NULL)
2223 mp = last_msgchunk->sb_prev;
2224 vim_free(last_msgchunk);
2225 last_msgchunk = mp;
2230 * "g<" command.
2232 void
2233 show_sb_text()
2235 msgchunk_T *mp;
2237 /* Only show somethign if there is more than one line, otherwise it looks
2238 * weird, typing a command without output results in one line. */
2239 mp = msg_sb_start(last_msgchunk);
2240 if (mp == NULL || mp->sb_prev == NULL)
2241 vim_beep();
2242 else
2244 do_more_prompt('G');
2245 wait_return(FALSE);
2250 * Move to the start of screen line in already displayed text.
2252 static msgchunk_T *
2253 msg_sb_start(mps)
2254 msgchunk_T *mps;
2256 msgchunk_T *mp = mps;
2258 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2259 mp = mp->sb_prev;
2260 return mp;
2264 * Display a screen line from previously displayed text at row "row".
2265 * Returns a pointer to the text for the next line (can be NULL).
2267 static msgchunk_T *
2268 disp_sb_line(row, smp)
2269 int row;
2270 msgchunk_T *smp;
2272 msgchunk_T *mp = smp;
2273 char_u *p;
2275 for (;;)
2277 msg_row = row;
2278 msg_col = mp->sb_msg_col;
2279 p = mp->sb_text;
2280 if (*p == '\n') /* don't display the line break */
2281 ++p;
2282 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2283 if (mp->sb_eol || mp->sb_next == NULL)
2284 break;
2285 mp = mp->sb_next;
2287 return mp->sb_next;
2291 * Output any postponed text for msg_puts_attr_len().
2293 static void
2294 t_puts(t_col, t_s, s, attr)
2295 int *t_col;
2296 char_u *t_s;
2297 char_u *s;
2298 int attr;
2300 /* output postponed text */
2301 msg_didout = TRUE; /* remember that line is not empty */
2302 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
2303 msg_col += *t_col;
2304 *t_col = 0;
2305 #ifdef FEAT_MBYTE
2306 /* If the string starts with a composing character don't increment the
2307 * column position for it. */
2308 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2309 --msg_col;
2310 #endif
2311 if (msg_col >= Columns)
2313 msg_col = 0;
2314 ++msg_row;
2319 * Returns TRUE when messages should be printed with mch_errmsg().
2320 * This is used when there is no valid screen, so we can see error messages.
2321 * If termcap is not active, we may be writing in an alternate console
2322 * window, cursor positioning may not work correctly (window size may be
2323 * different, e.g. for Win32 console) or we just don't know where the
2324 * cursor is.
2327 msg_use_printf()
2329 return (!msg_check_screen()
2330 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2331 || !termcap_active
2332 #endif
2333 || (swapping_screen() && !termcap_active)
2338 * Print a message when there is no valid screen.
2340 static void
2341 msg_puts_printf(str, maxlen)
2342 char_u *str;
2343 int maxlen;
2345 char_u *s = str;
2346 char_u buf[4];
2347 char_u *p;
2349 #ifdef WIN3264
2350 if (!(silent_mode && p_verbose == 0))
2351 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2352 #endif
2353 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2355 if (!(silent_mode && p_verbose == 0))
2357 /* NL --> CR NL translation (for Unix, not for "--version") */
2358 /* NL --> CR translation (for Mac) */
2359 p = &buf[0];
2360 if (*s == '\n' && !info_message)
2361 *p++ = '\r';
2362 #if defined(USE_CR) && !defined(MACOS_X_UNIX)
2363 else
2364 #endif
2365 *p++ = *s;
2366 *p = '\0';
2367 if (info_message) /* informative message, not an error */
2368 mch_msg((char *)buf);
2369 else
2370 mch_errmsg((char *)buf);
2373 /* primitive way to compute the current column */
2374 #ifdef FEAT_RIGHTLEFT
2375 if (cmdmsg_rl)
2377 if (*s == '\r' || *s == '\n')
2378 msg_col = Columns - 1;
2379 else
2380 --msg_col;
2382 else
2383 #endif
2385 if (*s == '\r' || *s == '\n')
2386 msg_col = 0;
2387 else
2388 ++msg_col;
2390 ++s;
2392 msg_didout = TRUE; /* assume that line is not empty */
2394 #ifdef WIN3264
2395 if (!(silent_mode && p_verbose == 0))
2396 mch_settmode(TMODE_RAW);
2397 #endif
2401 * Show the more-prompt and handle the user response.
2402 * This takes care of scrolling back and displaying previously displayed text.
2403 * When at hit-enter prompt "typed_char" is the already typed character,
2404 * otherwise it's NUL.
2405 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2407 static int
2408 do_more_prompt(typed_char)
2409 int typed_char;
2411 int used_typed_char = typed_char;
2412 int oldState = State;
2413 int c;
2414 #ifdef FEAT_CON_DIALOG
2415 int retval = FALSE;
2416 #endif
2417 int scroll;
2418 msgchunk_T *mp_last = NULL;
2419 msgchunk_T *mp;
2420 int i;
2422 if (typed_char == 'G')
2424 /* "g<": Find first line on the last page. */
2425 mp_last = msg_sb_start(last_msgchunk);
2426 for (i = 0; i < Rows - 2 && mp_last != NULL
2427 && mp_last->sb_prev != NULL; ++i)
2428 mp_last = msg_sb_start(mp_last->sb_prev);
2431 State = ASKMORE;
2432 #ifdef FEAT_MOUSE
2433 setmouse();
2434 #endif
2435 if (typed_char == NUL)
2436 msg_moremsg(FALSE);
2437 for (;;)
2440 * Get a typed character directly from the user.
2442 if (used_typed_char != NUL)
2444 c = used_typed_char; /* was typed at hit-enter prompt */
2445 used_typed_char = NUL;
2447 else
2448 c = get_keystroke();
2450 #if defined(FEAT_MENU) && defined(FEAT_GUI)
2451 if (c == K_MENU)
2453 int idx = get_menu_index(current_menu, ASKMORE);
2455 /* Used a menu. If it starts with CTRL-Y, it must
2456 * be a "Copy" for the clipboard. Otherwise
2457 * assume that we end */
2458 if (idx == MENU_INDEX_INVALID)
2459 continue;
2460 c = *current_menu->strings[idx];
2461 if (c != NUL && current_menu->strings[idx][1] != NUL)
2462 ins_typebuf(current_menu->strings[idx] + 1,
2463 current_menu->noremap[idx], 0, TRUE,
2464 current_menu->silent[idx]);
2466 #endif
2468 scroll = 0;
2469 switch (c)
2471 case BS: /* scroll one line back */
2472 case K_BS:
2473 case 'k':
2474 case K_UP:
2475 scroll = -1;
2476 break;
2478 case CAR: /* one extra line */
2479 case NL:
2480 case 'j':
2481 case K_DOWN:
2482 scroll = 1;
2483 break;
2485 case 'u': /* Up half a page */
2486 case K_PAGEUP:
2487 scroll = -(Rows / 2);
2488 break;
2490 case 'd': /* Down half a page */
2491 scroll = Rows / 2;
2492 break;
2494 case 'b': /* one page back */
2495 scroll = -(Rows - 1);
2496 break;
2498 case ' ': /* one extra page */
2499 case K_PAGEDOWN:
2500 case K_LEFTMOUSE:
2501 scroll = Rows - 1;
2502 break;
2504 case 'g': /* all the way back to the start */
2505 scroll = -999999;
2506 break;
2508 case 'G': /* all the way to the end */
2509 scroll = 999999;
2510 lines_left = 999999;
2511 break;
2513 case ':': /* start new command line */
2514 #ifdef FEAT_CON_DIALOG
2515 if (!confirm_msg_used)
2516 #endif
2518 /* Since got_int is set all typeahead will be flushed, but we
2519 * want to keep this ':', remember that in a special way. */
2520 typeahead_noflush(':');
2521 cmdline_row = Rows - 1; /* put ':' on this line */
2522 skip_redraw = TRUE; /* skip redraw once */
2523 need_wait_return = FALSE; /* don't wait in main() */
2525 /*FALLTHROUGH*/
2526 case 'q': /* quit */
2527 case Ctrl_C:
2528 case ESC:
2529 #ifdef FEAT_CON_DIALOG
2530 if (confirm_msg_used)
2532 /* Jump to the choices of the dialog. */
2533 retval = TRUE;
2534 lines_left = Rows - 1;
2536 else
2537 #endif
2539 got_int = TRUE;
2540 quit_more = TRUE;
2542 break;
2544 #ifdef FEAT_CLIPBOARD
2545 case Ctrl_Y:
2546 /* Strange way to allow copying (yanking) a modeless
2547 * selection at the more prompt. Use CTRL-Y,
2548 * because the same is used in Cmdline-mode and at the
2549 * hit-enter prompt. However, scrolling one line up
2550 * might be expected... */
2551 if (clip_star.state == SELECT_DONE)
2552 clip_copy_modeless_selection(TRUE);
2553 continue;
2554 #endif
2555 default: /* no valid response */
2556 msg_moremsg(TRUE);
2557 continue;
2560 if (scroll != 0)
2562 if (scroll < 0)
2564 /* go to start of last line */
2565 if (mp_last == NULL)
2566 mp = msg_sb_start(last_msgchunk);
2567 else if (mp_last->sb_prev != NULL)
2568 mp = msg_sb_start(mp_last->sb_prev);
2569 else
2570 mp = NULL;
2572 /* go to start of line at top of the screen */
2573 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2574 ++i)
2575 mp = msg_sb_start(mp->sb_prev);
2577 if (mp != NULL && mp->sb_prev != NULL)
2579 /* Find line to be displayed at top. */
2580 for (i = 0; i > scroll; --i)
2582 if (mp == NULL || mp->sb_prev == NULL)
2583 break;
2584 mp = msg_sb_start(mp->sb_prev);
2585 if (mp_last == NULL)
2586 mp_last = msg_sb_start(last_msgchunk);
2587 else
2588 mp_last = msg_sb_start(mp_last->sb_prev);
2591 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2592 (int)Rows, NULL) == OK)
2594 /* display line at top */
2595 (void)disp_sb_line(0, mp);
2597 else
2599 /* redisplay all lines */
2600 screenclear();
2601 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2603 mp = disp_sb_line(i, mp);
2604 ++msg_scrolled;
2607 scroll = 0;
2610 else
2612 /* First display any text that we scrolled back. */
2613 while (scroll > 0 && mp_last != NULL)
2615 /* scroll up, display line at bottom */
2616 msg_scroll_up();
2617 inc_msg_scrolled();
2618 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2619 (int)Columns, ' ', ' ', 0);
2620 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2621 --scroll;
2625 if (scroll < 0 || (scroll == 0 && mp_last != NULL))
2627 /* displayed the requested text, more prompt again */
2628 screen_fill((int)Rows - 1, (int)Rows, 0,
2629 (int)Columns, ' ', ' ', 0);
2630 msg_moremsg(FALSE);
2631 continue;
2634 /* display more text, return to caller */
2635 lines_left = scroll;
2638 break;
2641 /* clear the --more-- message */
2642 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2643 State = oldState;
2644 #ifdef FEAT_MOUSE
2645 setmouse();
2646 #endif
2647 if (quit_more)
2649 msg_row = Rows - 1;
2650 msg_col = 0;
2652 #ifdef FEAT_RIGHTLEFT
2653 else if (cmdmsg_rl)
2654 msg_col = Columns - 1;
2655 #endif
2657 #ifdef FEAT_CON_DIALOG
2658 return retval;
2659 #else
2660 return FALSE;
2661 #endif
2664 #if defined(USE_MCH_ERRMSG) || defined(PROTO)
2666 #ifdef mch_errmsg
2667 # undef mch_errmsg
2668 #endif
2669 #ifdef mch_msg
2670 # undef mch_msg
2671 #endif
2674 * Give an error message. To be used when the screen hasn't been initialized
2675 * yet. When stderr can't be used, collect error messages until the GUI has
2676 * started and they can be displayed in a message box.
2678 void
2679 mch_errmsg(str)
2680 char *str;
2682 int len;
2684 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2685 /* On Unix use stderr if it's a tty.
2686 * When not going to start the GUI also use stderr.
2687 * On Mac, when started from Finder, stderr is the console. */
2688 if (
2689 # ifdef UNIX
2690 # ifdef MACOS_X_UNIX
2691 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2692 # else
2693 isatty(2)
2694 # endif
2695 # ifdef FEAT_GUI
2697 # endif
2698 # endif
2699 # ifdef FEAT_GUI
2700 !(gui.in_use || gui.starting)
2701 # endif
2704 fprintf(stderr, "%s", str);
2705 return;
2707 #endif
2709 /* avoid a delay for a message that isn't there */
2710 emsg_on_display = FALSE;
2712 len = (int)STRLEN(str) + 1;
2713 if (error_ga.ga_growsize == 0)
2715 error_ga.ga_growsize = 80;
2716 error_ga.ga_itemsize = 1;
2718 if (ga_grow(&error_ga, len) == OK)
2720 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2721 (char_u *)str, len);
2722 #ifdef UNIX
2723 /* remove CR characters, they are displayed */
2725 char_u *p;
2727 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2728 for (;;)
2730 p = vim_strchr(p, '\r');
2731 if (p == NULL)
2732 break;
2733 *p = ' ';
2736 #endif
2737 --len; /* don't count the NUL at the end */
2738 error_ga.ga_len += len;
2743 * Give a message. To be used when the screen hasn't been initialized yet.
2744 * When there is no tty, collect messages until the GUI has started and they
2745 * can be displayed in a message box.
2747 void
2748 mch_msg(str)
2749 char *str;
2751 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2752 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2753 * uses mch_errmsg() when started from the desktop.
2754 * When not going to start the GUI also use stdout.
2755 * On Mac, when started from Finder, stderr is the console. */
2756 if (
2757 # ifdef UNIX
2758 # ifdef MACOS_X_UNIX
2759 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2760 # else
2761 isatty(2)
2762 # endif
2763 # ifdef FEAT_GUI
2765 # endif
2766 # endif
2767 # ifdef FEAT_GUI
2768 !(gui.in_use || gui.starting)
2769 # endif
2772 printf("%s", str);
2773 return;
2775 # endif
2776 mch_errmsg(str);
2778 #endif /* USE_MCH_ERRMSG */
2781 * Put a character on the screen at the current message position and advance
2782 * to the next position. Only for printable ASCII!
2784 static void
2785 msg_screen_putchar(c, attr)
2786 int c;
2787 int attr;
2789 msg_didout = TRUE; /* remember that line is not empty */
2790 screen_putchar(c, msg_row, msg_col, attr);
2791 #ifdef FEAT_RIGHTLEFT
2792 if (cmdmsg_rl)
2794 if (--msg_col == 0)
2796 msg_col = Columns;
2797 ++msg_row;
2800 else
2801 #endif
2803 if (++msg_col >= Columns)
2805 msg_col = 0;
2806 ++msg_row;
2811 void
2812 msg_moremsg(full)
2813 int full;
2815 int attr;
2816 char_u *s = (char_u *)_("-- More --");
2818 attr = hl_attr(HLF_M);
2819 screen_puts(s, (int)Rows - 1, 0, attr);
2820 if (full)
2821 screen_puts((char_u *)
2822 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2823 (int)Rows - 1, vim_strsize(s), attr);
2827 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2828 * exmode_active.
2830 void
2831 repeat_message()
2833 if (State == ASKMORE)
2835 msg_moremsg(TRUE); /* display --more-- message again */
2836 msg_row = Rows - 1;
2838 #ifdef FEAT_CON_DIALOG
2839 else if (State == CONFIRM)
2841 display_confirm_msg(); /* display ":confirm" message again */
2842 msg_row = Rows - 1;
2844 #endif
2845 else if (State == EXTERNCMD)
2847 windgoto(msg_row, msg_col); /* put cursor back */
2849 else if (State == HITRETURN || State == SETWSIZE)
2851 hit_return_msg();
2852 msg_row = Rows - 1;
2857 * msg_check_screen - check if the screen is initialized.
2858 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2859 * While starting the GUI the terminal codes will be set for the GUI, but the
2860 * output goes to the terminal. Don't use the terminal codes then.
2862 static int
2863 msg_check_screen()
2865 if (!full_screen || !screen_valid(FALSE))
2866 return FALSE;
2868 if (msg_row >= Rows)
2869 msg_row = Rows - 1;
2870 if (msg_col >= Columns)
2871 msg_col = Columns - 1;
2872 return TRUE;
2876 * Clear from current message position to end of screen.
2877 * Skip this when ":silent" was used, no need to clear for redirection.
2879 void
2880 msg_clr_eos()
2882 if (msg_silent == 0)
2883 msg_clr_eos_force();
2887 * Clear from current message position to end of screen.
2888 * Note: msg_col is not updated, so we remember the end of the message
2889 * for msg_check().
2891 void
2892 msg_clr_eos_force()
2894 if (msg_use_printf())
2896 if (full_screen) /* only when termcap codes are valid */
2898 if (*T_CD)
2899 out_str(T_CD); /* clear to end of display */
2900 else if (*T_CE)
2901 out_str(T_CE); /* clear to end of line */
2904 else
2906 #ifdef FEAT_RIGHTLEFT
2907 if (cmdmsg_rl)
2909 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2910 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2912 else
2913 #endif
2915 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2916 ' ', ' ', 0);
2917 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2923 * Clear the command line.
2925 void
2926 msg_clr_cmdline()
2928 msg_row = cmdline_row;
2929 msg_col = 0;
2930 msg_clr_eos_force();
2934 * end putting a message on the screen
2935 * call wait_return if the message does not fit in the available space
2936 * return TRUE if wait_return not called.
2939 msg_end()
2942 * if the string is larger than the window,
2943 * or the ruler option is set and we run into it,
2944 * we have to redraw the window.
2945 * Do not do this if we are abandoning the file or editing the command line.
2947 if (!exiting && need_wait_return && !(State & CMDLINE))
2949 wait_return(FALSE);
2950 return FALSE;
2952 out_flush();
2953 return TRUE;
2957 * If the written message runs into the shown command or ruler, we have to
2958 * wait for hit-return and redraw the window later.
2960 void
2961 msg_check()
2963 if (msg_row == Rows - 1 && msg_col >= sc_col)
2965 need_wait_return = TRUE;
2966 redraw_cmdline = TRUE;
2971 * May write a string to the redirection file.
2972 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
2974 static void
2975 redir_write(str, maxlen)
2976 char_u *str;
2977 int maxlen;
2979 char_u *s = str;
2980 static int cur_col = 0;
2982 /* Don't do anything for displaying prompts and the like. */
2983 if (redir_off)
2984 return;
2987 * If 'verbosefile' is set write message in that file.
2988 * Must come before the rest because of updating "msg_col".
2990 if (*p_vfile != NUL)
2991 verbose_write(s, maxlen);
2993 if (redir_fd != NULL
2994 #ifdef FEAT_EVAL
2995 || redir_reg || redir_vname
2996 #endif
2999 /* If the string doesn't start with CR or NL, go to msg_col */
3000 if (*s != '\n' && *s != '\r')
3002 while (cur_col < msg_col)
3004 #ifdef FEAT_EVAL
3005 if (redir_reg)
3006 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
3007 else if (redir_vname)
3008 var_redir_str((char_u *)" ", -1);
3009 else if (redir_fd)
3010 #endif
3011 fputs(" ", redir_fd);
3012 ++cur_col;
3016 #ifdef FEAT_EVAL
3017 if (redir_reg)
3018 write_reg_contents(redir_reg, s, maxlen, TRUE);
3019 if (redir_vname)
3020 var_redir_str(s, maxlen);
3021 #endif
3023 /* Adjust the current column */
3024 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3026 #ifdef FEAT_EVAL
3027 if (!redir_reg && !redir_vname && redir_fd != NULL)
3028 #endif
3029 putc(*s, redir_fd);
3030 if (*s == '\r' || *s == '\n')
3031 cur_col = 0;
3032 else if (*s == '\t')
3033 cur_col += (8 - cur_col % 8);
3034 else
3035 ++cur_col;
3036 ++s;
3039 if (msg_silent != 0) /* should update msg_col */
3040 msg_col = cur_col;
3045 * Before giving verbose message.
3046 * Must always be called paired with verbose_leave()!
3048 void
3049 verbose_enter()
3051 if (*p_vfile != NUL)
3052 ++msg_silent;
3056 * After giving verbose message.
3057 * Must always be called paired with verbose_enter()!
3059 void
3060 verbose_leave()
3062 if (*p_vfile != NUL)
3063 if (--msg_silent < 0)
3064 msg_silent = 0;
3068 * Like verbose_enter() and set msg_scroll when displaying the message.
3070 void
3071 verbose_enter_scroll()
3073 if (*p_vfile != NUL)
3074 ++msg_silent;
3075 else
3076 /* always scroll up, don't overwrite */
3077 msg_scroll = TRUE;
3081 * Like verbose_leave() and set cmdline_row when displaying the message.
3083 void
3084 verbose_leave_scroll()
3086 if (*p_vfile != NUL)
3088 if (--msg_silent < 0)
3089 msg_silent = 0;
3091 else
3092 cmdline_row = msg_row;
3095 static FILE *verbose_fd = NULL;
3096 static int verbose_did_open = FALSE;
3099 * Called when 'verbosefile' is set: stop writing to the file.
3101 void
3102 verbose_stop()
3104 if (verbose_fd != NULL)
3106 fclose(verbose_fd);
3107 verbose_fd = NULL;
3109 verbose_did_open = FALSE;
3113 * Open the file 'verbosefile'.
3114 * Return FAIL or OK.
3117 verbose_open()
3119 if (verbose_fd == NULL && !verbose_did_open)
3121 /* Only give the error message once. */
3122 verbose_did_open = TRUE;
3124 verbose_fd = mch_fopen((char *)p_vfile, "a");
3125 if (verbose_fd == NULL)
3127 EMSG2(_(e_notopen), p_vfile);
3128 return FAIL;
3131 return OK;
3135 * Write a string to 'verbosefile'.
3136 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3138 static void
3139 verbose_write(str, maxlen)
3140 char_u *str;
3141 int maxlen;
3143 char_u *s = str;
3144 static int cur_col = 0;
3146 /* Open the file when called the first time. */
3147 if (verbose_fd == NULL)
3148 verbose_open();
3150 if (verbose_fd != NULL)
3152 /* If the string doesn't start with CR or NL, go to msg_col */
3153 if (*s != '\n' && *s != '\r')
3155 while (cur_col < msg_col)
3157 fputs(" ", verbose_fd);
3158 ++cur_col;
3162 /* Adjust the current column */
3163 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3165 putc(*s, verbose_fd);
3166 if (*s == '\r' || *s == '\n')
3167 cur_col = 0;
3168 else if (*s == '\t')
3169 cur_col += (8 - cur_col % 8);
3170 else
3171 ++cur_col;
3172 ++s;
3178 * Give a warning message (for searching).
3179 * Use 'w' highlighting and may repeat the message after redrawing
3181 void
3182 give_warning(message, hl)
3183 char_u *message;
3184 int hl;
3186 /* Don't do this for ":silent". */
3187 if (msg_silent != 0)
3188 return;
3190 /* Don't want a hit-enter prompt here. */
3191 ++no_wait_return;
3193 #ifdef FEAT_EVAL
3194 set_vim_var_string(VV_WARNINGMSG, message, -1);
3195 #endif
3196 vim_free(keep_msg);
3197 keep_msg = NULL;
3198 if (hl)
3199 keep_msg_attr = hl_attr(HLF_W);
3200 else
3201 keep_msg_attr = 0;
3202 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
3203 set_keep_msg(message, keep_msg_attr);
3204 msg_didout = FALSE; /* overwrite this message */
3205 msg_nowait = TRUE; /* don't wait for this message */
3206 msg_col = 0;
3208 --no_wait_return;
3212 * Advance msg cursor to column "col".
3214 void
3215 msg_advance(col)
3216 int col;
3218 if (msg_silent != 0) /* nothing to advance to */
3220 msg_col = col; /* for redirection, may fill it up later */
3221 return;
3223 if (col >= Columns) /* not enough room */
3224 col = Columns - 1;
3225 #ifdef FEAT_RIGHTLEFT
3226 if (cmdmsg_rl)
3227 while (msg_col > Columns - col)
3228 msg_putchar(' ');
3229 else
3230 #endif
3231 while (msg_col < col)
3232 msg_putchar(' ');
3235 #if defined(FEAT_CON_DIALOG) || defined(PROTO)
3237 * Used for "confirm()" function, and the :confirm command prefix.
3238 * Versions which haven't got flexible dialogs yet, and console
3239 * versions, get this generic handler which uses the command line.
3241 * type = one of:
3242 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3243 * title = title string (can be NULL for default)
3244 * (neither used in console dialogs at the moment)
3246 * Format of the "buttons" string:
3247 * "Button1Name\nButton2Name\nButton3Name"
3248 * The first button should normally be the default/accept
3249 * The second button should be the 'Cancel' button
3250 * Other buttons- use your imagination!
3251 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3252 * different letter.
3254 /* ARGSUSED */
3256 do_dialog(type, title, message, buttons, dfltbutton, textfield)
3257 int type;
3258 char_u *title;
3259 char_u *message;
3260 char_u *buttons;
3261 int dfltbutton;
3262 char_u *textfield; /* IObuff for inputdialog(), NULL otherwise */
3264 int oldState;
3265 int retval = 0;
3266 char_u *hotkeys;
3267 int c;
3268 int i;
3270 #ifndef NO_CONSOLE
3271 /* Don't output anything in silent mode ("ex -s") */
3272 if (silent_mode)
3273 return dfltbutton; /* return default option */
3274 #endif
3276 #ifdef FEAT_GUI_DIALOG
3277 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3278 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3280 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3281 textfield);
3282 msg_end_prompt();
3284 /* Flush output to avoid that further messages and redrawing is done
3285 * in the wrong order. */
3286 out_flush();
3287 gui_mch_update();
3289 return c;
3291 #endif
3293 oldState = State;
3294 State = CONFIRM;
3295 #ifdef FEAT_MOUSE
3296 setmouse();
3297 #endif
3300 * Since we wait for a keypress, don't make the
3301 * user press RETURN as well afterwards.
3303 ++no_wait_return;
3304 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3306 if (hotkeys != NULL)
3308 for (;;)
3310 /* Get a typed character directly from the user. */
3311 c = get_keystroke();
3312 switch (c)
3314 case CAR: /* User accepts default option */
3315 case NL:
3316 retval = dfltbutton;
3317 break;
3318 case Ctrl_C: /* User aborts/cancels */
3319 case ESC:
3320 retval = 0;
3321 break;
3322 default: /* Could be a hotkey? */
3323 if (c < 0) /* special keys are ignored here */
3324 continue;
3325 /* Make the character lowercase, as chars in "hotkeys" are. */
3326 c = MB_TOLOWER(c);
3327 retval = 1;
3328 for (i = 0; hotkeys[i]; ++i)
3330 #ifdef FEAT_MBYTE
3331 if (has_mbyte)
3333 if ((*mb_ptr2char)(hotkeys + i) == c)
3334 break;
3335 i += (*mb_ptr2len)(hotkeys + i) - 1;
3337 else
3338 #endif
3339 if (hotkeys[i] == c)
3340 break;
3341 ++retval;
3343 if (hotkeys[i])
3344 break;
3345 /* No hotkey match, so keep waiting */
3346 continue;
3348 break;
3351 vim_free(hotkeys);
3354 State = oldState;
3355 #ifdef FEAT_MOUSE
3356 setmouse();
3357 #endif
3358 --no_wait_return;
3359 msg_end_prompt();
3361 return retval;
3364 static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3367 * Copy one character from "*from" to "*to", taking care of multi-byte
3368 * characters. Return the length of the character in bytes.
3370 static int
3371 copy_char(from, to, lowercase)
3372 char_u *from;
3373 char_u *to;
3374 int lowercase; /* make character lower case */
3376 #ifdef FEAT_MBYTE
3377 int len;
3378 int c;
3380 if (has_mbyte)
3382 if (lowercase)
3384 c = MB_TOLOWER((*mb_ptr2char)(from));
3385 return (*mb_char2bytes)(c, to);
3387 else
3389 len = (*mb_ptr2len)(from);
3390 mch_memmove(to, from, (size_t)len);
3391 return len;
3394 else
3395 #endif
3397 if (lowercase)
3398 *to = (char_u)TOLOWER_LOC(*from);
3399 else
3400 *to = *from;
3401 return 1;
3406 * Format the dialog string, and display it at the bottom of
3407 * the screen. Return a string of hotkey chars (if defined) for
3408 * each 'button'. If a button has no hotkey defined, the first character of
3409 * the button is used.
3410 * The hotkeys can be multi-byte characters, but without combining chars.
3412 * Returns an allocated string with hotkeys, or NULL for error.
3414 static char_u *
3415 msg_show_console_dialog(message, buttons, dfltbutton)
3416 char_u *message;
3417 char_u *buttons;
3418 int dfltbutton;
3420 int len = 0;
3421 #ifdef FEAT_MBYTE
3422 # define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3423 #else
3424 # define HOTK_LEN 1
3425 #endif
3426 int lenhotkey = HOTK_LEN; /* count first button */
3427 char_u *hotk = NULL;
3428 char_u *msgp = NULL;
3429 char_u *hotkp = NULL;
3430 char_u *r;
3431 int copy;
3432 #define HAS_HOTKEY_LEN 30
3433 char_u has_hotkey[HAS_HOTKEY_LEN];
3434 int first_hotkey = FALSE; /* first char of button is hotkey */
3435 int idx;
3437 has_hotkey[0] = FALSE;
3440 * First loop: compute the size of memory to allocate.
3441 * Second loop: copy to the allocated memory.
3443 for (copy = 0; copy <= 1; ++copy)
3445 r = buttons;
3446 idx = 0;
3447 while (*r)
3449 if (*r == DLG_BUTTON_SEP)
3451 if (copy)
3453 *msgp++ = ',';
3454 *msgp++ = ' '; /* '\n' -> ', ' */
3456 /* advance to next hotkey and set default hotkey */
3457 #ifdef FEAT_MBYTE
3458 if (has_mbyte)
3459 hotkp += STRLEN(hotkp);
3460 else
3461 #endif
3462 ++hotkp;
3463 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
3464 if (dfltbutton)
3465 --dfltbutton;
3467 /* If no hotkey is specified first char is used. */
3468 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3469 first_hotkey = TRUE;
3471 else
3473 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3474 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3475 if (idx < HAS_HOTKEY_LEN - 1)
3476 has_hotkey[++idx] = FALSE;
3479 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3481 if (*r == DLG_HOTKEY_CHAR)
3482 ++r;
3483 first_hotkey = FALSE;
3484 if (copy)
3486 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3487 *msgp++ = *r;
3488 else
3490 /* '&a' -> '[a]' */
3491 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3492 msgp += copy_char(r, msgp, FALSE);
3493 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3495 /* redefine hotkey */
3496 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
3499 else
3501 ++len; /* '&a' -> '[a]' */
3502 if (idx < HAS_HOTKEY_LEN - 1)
3503 has_hotkey[idx] = TRUE;
3506 else
3508 /* everything else copy literally */
3509 if (copy)
3510 msgp += copy_char(r, msgp, FALSE);
3513 /* advance to the next character */
3514 mb_ptr_adv(r);
3517 if (copy)
3519 *msgp++ = ':';
3520 *msgp++ = ' ';
3521 *msgp = NUL;
3523 else
3525 len += (int)(STRLEN(message)
3526 + 2 /* for the NL's */
3527 + STRLEN(buttons)
3528 + 3); /* for the ": " and NUL */
3529 lenhotkey++; /* for the NUL */
3531 /* If no hotkey is specified first char is used. */
3532 if (!has_hotkey[0])
3534 first_hotkey = TRUE;
3535 len += 2; /* "x" -> "[x]" */
3539 * Now allocate and load the strings
3541 vim_free(confirm_msg);
3542 confirm_msg = alloc(len);
3543 if (confirm_msg == NULL)
3544 return NULL;
3545 *confirm_msg = NUL;
3546 hotk = alloc(lenhotkey);
3547 if (hotk == NULL)
3548 return NULL;
3550 *confirm_msg = '\n';
3551 STRCPY(confirm_msg + 1, message);
3553 msgp = confirm_msg + 1 + STRLEN(message);
3554 hotkp = hotk;
3556 /* Define first default hotkey. Keep the hotkey string NUL
3557 * terminated to avoid reading past the end. */
3558 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
3560 /* Remember where the choices start, displaying starts here when
3561 * "hotkp" typed at the more prompt. */
3562 confirm_msg_tail = msgp;
3563 *msgp++ = '\n';
3567 display_confirm_msg();
3568 return hotk;
3572 * Display the ":confirm" message. Also called when screen resized.
3574 void
3575 display_confirm_msg()
3577 /* avoid that 'q' at the more prompt truncates the message here */
3578 ++confirm_msg_used;
3579 if (confirm_msg != NULL)
3580 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3581 --confirm_msg_used;
3584 #endif /* FEAT_CON_DIALOG */
3586 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3589 vim_dialog_yesno(type, title, message, dflt)
3590 int type;
3591 char_u *title;
3592 char_u *message;
3593 int dflt;
3595 if (do_dialog(type,
3596 title == NULL ? (char_u *)_("Question") : title,
3597 message,
3598 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3599 return VIM_YES;
3600 return VIM_NO;
3604 vim_dialog_yesnocancel(type, title, message, dflt)
3605 int type;
3606 char_u *title;
3607 char_u *message;
3608 int dflt;
3610 switch (do_dialog(type,
3611 title == NULL ? (char_u *)_("Question") : title,
3612 message,
3613 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3615 case 1: return VIM_YES;
3616 case 2: return VIM_NO;
3618 return VIM_CANCEL;
3622 vim_dialog_yesnoallcancel(type, title, message, dflt)
3623 int type;
3624 char_u *title;
3625 char_u *message;
3626 int dflt;
3628 switch (do_dialog(type,
3629 title == NULL ? (char_u *)"Question" : title,
3630 message,
3631 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3632 dflt, NULL))
3634 case 1: return VIM_YES;
3635 case 2: return VIM_NO;
3636 case 3: return VIM_ALL;
3637 case 4: return VIM_DISCARDALL;
3639 return VIM_CANCEL;
3642 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3644 #if defined(FEAT_BROWSE) || defined(PROTO)
3646 * Generic browse function. Calls gui_mch_browse() when possible.
3647 * Later this may pop-up a non-GUI file selector (external command?).
3649 char_u *
3650 do_browse(flags, title, dflt, ext, initdir, filter, buf)
3651 int flags; /* BROWSE_SAVE and BROWSE_DIR */
3652 char_u *title; /* title for the window */
3653 char_u *dflt; /* default file name (may include directory) */
3654 char_u *ext; /* extension added */
3655 char_u *initdir; /* initial directory, NULL for current dir or
3656 when using path from "dflt" */
3657 char_u *filter; /* file name filter */
3658 buf_T *buf; /* buffer to read/write for */
3660 char_u *fname;
3661 static char_u *last_dir = NULL; /* last used directory */
3662 char_u *tofree = NULL;
3663 int save_browse = cmdmod.browse;
3665 /* Must turn off browse to avoid that autocommands will get the
3666 * flag too! */
3667 cmdmod.browse = FALSE;
3669 if (title == NULL || *title == NUL)
3671 if (flags & BROWSE_DIR)
3672 title = (char_u *)_("Select Directory dialog");
3673 else if (flags & BROWSE_SAVE)
3674 title = (char_u *)_("Save File dialog");
3675 else
3676 title = (char_u *)_("Open File dialog");
3679 /* When no directory specified, use default file name, default dir, buffer
3680 * dir, last dir or current dir */
3681 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3683 if (mch_isdir(dflt)) /* default file name is a directory */
3685 initdir = dflt;
3686 dflt = NULL;
3688 else if (gettail(dflt) != dflt) /* default file name includes a path */
3690 tofree = vim_strsave(dflt);
3691 if (tofree != NULL)
3693 initdir = tofree;
3694 *gettail(initdir) = NUL;
3695 dflt = gettail(dflt);
3700 if (initdir == NULL || *initdir == NUL)
3702 /* When 'browsedir' is a directory, use it */
3703 if (STRCMP(p_bsdir, "last") != 0
3704 && STRCMP(p_bsdir, "buffer") != 0
3705 && STRCMP(p_bsdir, "current") != 0
3706 && mch_isdir(p_bsdir))
3707 initdir = p_bsdir;
3708 /* When saving or 'browsedir' is "buffer", use buffer fname */
3709 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
3710 && buf != NULL && buf->b_ffname != NULL)
3712 if (dflt == NULL || *dflt == NUL)
3713 dflt = gettail(curbuf->b_ffname);
3714 tofree = vim_strsave(curbuf->b_ffname);
3715 if (tofree != NULL)
3717 initdir = tofree;
3718 *gettail(initdir) = NUL;
3721 /* When 'browsedir' is "last", use dir from last browse */
3722 else if (*p_bsdir == 'l')
3723 initdir = last_dir;
3724 /* When 'browsedir is "current", use current directory. This is the
3725 * default already, leave initdir empty. */
3728 # ifdef FEAT_GUI
3729 if (gui.in_use) /* when this changes, also adjust f_has()! */
3731 if (filter == NULL
3732 # ifdef FEAT_EVAL
3733 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3734 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3735 # endif
3737 filter = BROWSE_FILTER_DEFAULT;
3738 if (flags & BROWSE_DIR)
3740 # if defined(HAVE_GTK2) || defined(WIN3264)
3741 /* For systems that have a directory dialog. */
3742 fname = gui_mch_browsedir(title, initdir);
3743 # else
3744 /* Generic solution for selecting a directory: select a file and
3745 * remove the file name. */
3746 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3747 # endif
3748 # if !defined(HAVE_GTK2)
3749 /* Win32 adds a dummy file name, others return an arbitrary file
3750 * name. GTK+ 2 returns only the directory, */
3751 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3753 /* Remove the file name. */
3754 char_u *tail = gettail_sep(fname);
3756 if (tail == fname)
3757 *tail++ = '.'; /* use current dir */
3758 *tail = NUL;
3760 # endif
3762 else
3763 fname = gui_mch_browse(flags & BROWSE_SAVE,
3764 title, dflt, ext, initdir, filter);
3766 /* We hang around in the dialog for a while, the user might do some
3767 * things to our files. The Win32 dialog allows deleting or renaming
3768 * a file, check timestamps. */
3769 need_check_timestamps = TRUE;
3770 did_check_timestamps = FALSE;
3772 else
3773 # endif
3775 /* TODO: non-GUI file selector here */
3776 EMSG(_("E338: Sorry, no file browser in console mode"));
3777 fname = NULL;
3780 /* keep the directory for next time */
3781 if (fname != NULL)
3783 vim_free(last_dir);
3784 last_dir = vim_strsave(fname);
3785 if (last_dir != NULL && !(flags & BROWSE_DIR))
3787 *gettail(last_dir) = NUL;
3788 if (*last_dir == NUL)
3790 /* filename only returned, must be in current dir */
3791 vim_free(last_dir);
3792 last_dir = alloc(MAXPATHL);
3793 if (last_dir != NULL)
3794 mch_dirname(last_dir, MAXPATHL);
3799 vim_free(tofree);
3800 cmdmod.browse = save_browse;
3802 return fname;
3804 #endif
3806 #if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3807 static char *e_printf = N_("E766: Insufficient arguments for printf()");
3809 static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3810 static char *tv_str __ARGS((typval_T *tvs, int *idxp));
3813 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3815 static long
3816 tv_nr(tvs, idxp)
3817 typval_T *tvs;
3818 int *idxp;
3820 int idx = *idxp - 1;
3821 long n = 0;
3822 int err = FALSE;
3824 if (tvs[idx].v_type == VAR_UNKNOWN)
3825 EMSG(_(e_printf));
3826 else
3828 ++*idxp;
3829 n = get_tv_number_chk(&tvs[idx], &err);
3830 if (err)
3831 n = 0;
3833 return n;
3837 * Get string argument from "idxp" entry in "tvs". First entry is 1.
3838 * Returns NULL for an error.
3840 static char *
3841 tv_str(tvs, idxp)
3842 typval_T *tvs;
3843 int *idxp;
3845 int idx = *idxp - 1;
3846 char *s = NULL;
3848 if (tvs[idx].v_type == VAR_UNKNOWN)
3849 EMSG(_(e_printf));
3850 else
3852 ++*idxp;
3853 s = (char *)get_tv_string_chk(&tvs[idx]);
3855 return s;
3857 #endif
3860 * This code was included to provide a portable vsnprintf() and snprintf().
3861 * Some systems may provide their own, but we always use this one for
3862 * consistency.
3864 * This code is based on snprintf.c - a portable implementation of snprintf
3865 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
3866 * Included with permission. It was heavily modified to fit in Vim.
3867 * The original code, including useful comments, can be found here:
3868 * http://www.ijs.si/software/snprintf/
3870 * This snprintf() only supports the following conversion specifiers:
3871 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3872 * with flags: '-', '+', ' ', '0' and '#'.
3873 * An asterisk is supported for field width as well as precision.
3875 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3876 * 'll' (long long int) is not supported.
3878 * The locale is not used, the string is used as a byte string. This is only
3879 * relevant for double-byte encodings where the second byte may be '%'.
3881 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3882 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
3884 * The return value is the number of characters which would be generated
3885 * for the given input, excluding the trailing null. If this value
3886 * is greater or equal to "str_m", not all characters from the result
3887 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3888 * are discarded. If "str_m" is greater than zero it is guaranteed
3889 * the resulting string will be null-terminated.
3893 * When va_list is not supported we only define vim_snprintf().
3895 * vim_vsnprintf() can be invoked with either "va_list" or a list of
3896 * "typval_T". When the latter is not used it must be NULL.
3899 /* When generating prototypes all of this is skipped, cproto doesn't
3900 * understand this. */
3901 #ifndef PROTO
3902 # ifdef HAVE_STDARG_H
3904 vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3906 va_list ap;
3907 int str_l;
3909 va_start(ap, fmt);
3910 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
3911 va_end(ap);
3912 return str_l;
3916 vim_vsnprintf(str, str_m, fmt, ap, tvs)
3917 # else
3918 /* clumsy way to work around missing va_list */
3919 # 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)
3921 /* VARARGS */
3923 #ifdef __BORLANDC__
3924 _RTLENTRYF
3925 #endif
3926 vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
3927 # endif
3928 char *str;
3929 size_t str_m;
3930 char *fmt;
3931 # ifdef HAVE_STDARG_H
3932 va_list ap;
3933 typval_T *tvs;
3934 # else
3935 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
3936 # endif
3938 size_t str_l = 0;
3939 char *p = fmt;
3940 int arg_idx = 1;
3942 if (p == NULL)
3943 p = "";
3944 while (*p != NUL)
3946 if (*p != '%')
3948 char *q = strchr(p + 1, '%');
3949 size_t n = (q == NULL) ? STRLEN(p) : (q - p);
3951 /* Copy up to the next '%' or NUL without any changes. */
3952 if (str_l < str_m)
3954 size_t avail = str_m - str_l;
3956 mch_memmove(str + str_l, p, n > avail ? avail : n);
3958 p += n;
3959 str_l += n;
3961 else
3963 size_t min_field_width = 0, precision = 0;
3964 int zero_padding = 0, precision_specified = 0, justify_left = 0;
3965 int alternate_form = 0, force_sign = 0;
3967 /* If both the ' ' and '+' flags appear, the ' ' flag should be
3968 * ignored. */
3969 int space_for_positive = 1;
3971 /* allowed values: \0, h, l, L */
3972 char length_modifier = '\0';
3974 /* temporary buffer for simple numeric->string conversion */
3975 char tmp[32];
3977 /* string address in case of string argument */
3978 char *str_arg;
3980 /* natural field width of arg without padding and sign */
3981 size_t str_arg_l;
3983 /* unsigned char argument value - only defined for c conversion.
3984 * N.B. standard explicitly states the char argument for the c
3985 * conversion is unsigned */
3986 unsigned char uchar_arg;
3988 /* number of zeros to be inserted for numeric conversions as
3989 * required by the precision or minimal field width */
3990 size_t number_of_zeros_to_pad = 0;
3992 /* index into tmp where zero padding is to be inserted */
3993 size_t zero_padding_insertion_ind = 0;
3995 /* current conversion specifier character */
3996 char fmt_spec = '\0';
3998 str_arg = NULL;
3999 p++; /* skip '%' */
4001 /* parse flags */
4002 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4003 || *p == '#' || *p == '\'')
4005 switch (*p)
4007 case '0': zero_padding = 1; break;
4008 case '-': justify_left = 1; break;
4009 case '+': force_sign = 1; space_for_positive = 0; break;
4010 case ' ': force_sign = 1;
4011 /* If both the ' ' and '+' flags appear, the ' '
4012 * flag should be ignored */
4013 break;
4014 case '#': alternate_form = 1; break;
4015 case '\'': break;
4017 p++;
4019 /* If the '0' and '-' flags both appear, the '0' flag should be
4020 * ignored. */
4022 /* parse field width */
4023 if (*p == '*')
4025 int j;
4027 p++;
4029 #ifndef HAVE_STDARG_H
4030 get_a_arg(arg_idx);
4031 #else
4032 # if defined(FEAT_EVAL)
4033 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4034 # endif
4035 va_arg(ap, int);
4036 #endif
4037 if (j >= 0)
4038 min_field_width = j;
4039 else
4041 min_field_width = -j;
4042 justify_left = 1;
4045 else if (VIM_ISDIGIT((int)(*p)))
4047 /* size_t could be wider than unsigned int; make sure we treat
4048 * argument like common implementations do */
4049 unsigned int uj = *p++ - '0';
4051 while (VIM_ISDIGIT((int)(*p)))
4052 uj = 10 * uj + (unsigned int)(*p++ - '0');
4053 min_field_width = uj;
4056 /* parse precision */
4057 if (*p == '.')
4059 p++;
4060 precision_specified = 1;
4061 if (*p == '*')
4063 int j;
4066 #ifndef HAVE_STDARG_H
4067 get_a_arg(arg_idx);
4068 #else
4069 # if defined(FEAT_EVAL)
4070 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4071 # endif
4072 va_arg(ap, int);
4073 #endif
4074 p++;
4075 if (j >= 0)
4076 precision = j;
4077 else
4079 precision_specified = 0;
4080 precision = 0;
4083 else if (VIM_ISDIGIT((int)(*p)))
4085 /* size_t could be wider than unsigned int; make sure we
4086 * treat argument like common implementations do */
4087 unsigned int uj = *p++ - '0';
4089 while (VIM_ISDIGIT((int)(*p)))
4090 uj = 10 * uj + (unsigned int)(*p++ - '0');
4091 precision = uj;
4095 /* parse 'h', 'l' and 'll' length modifiers */
4096 if (*p == 'h' || *p == 'l')
4098 length_modifier = *p;
4099 p++;
4100 if (length_modifier == 'l' && *p == 'l')
4102 /* double l = long long */
4103 length_modifier = 'l'; /* treat it as a single 'l' */
4104 p++;
4107 fmt_spec = *p;
4109 /* common synonyms: */
4110 switch (fmt_spec)
4112 case 'i': fmt_spec = 'd'; break;
4113 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4114 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4115 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4116 default: break;
4119 /* get parameter value, do initial processing */
4120 switch (fmt_spec)
4122 /* '%' and 'c' behave similar to 's' regarding flags and field
4123 * widths */
4124 case '%':
4125 case 'c':
4126 case 's':
4127 length_modifier = '\0';
4128 str_arg_l = 1;
4129 switch (fmt_spec)
4131 case '%':
4132 str_arg = p;
4133 break;
4135 case 'c':
4137 int j;
4140 #ifndef HAVE_STDARG_H
4141 get_a_arg(arg_idx);
4142 #else
4143 # if defined(FEAT_EVAL)
4144 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4145 # endif
4146 va_arg(ap, int);
4147 #endif
4148 /* standard demands unsigned char */
4149 uchar_arg = (unsigned char)j;
4150 str_arg = (char *)&uchar_arg;
4151 break;
4154 case 's':
4155 str_arg =
4156 #ifndef HAVE_STDARG_H
4157 (char *)get_a_arg(arg_idx);
4158 #else
4159 # if defined(FEAT_EVAL)
4160 tvs != NULL ? tv_str(tvs, &arg_idx) :
4161 # endif
4162 va_arg(ap, char *);
4163 #endif
4164 if (str_arg == NULL)
4166 str_arg = "[NULL]";
4167 str_arg_l = 6;
4169 /* make sure not to address string beyond the specified
4170 * precision !!! */
4171 else if (!precision_specified)
4172 str_arg_l = strlen(str_arg);
4173 /* truncate string if necessary as requested by precision */
4174 else if (precision == 0)
4175 str_arg_l = 0;
4176 else
4178 /* Don't put the #if inside memchr(), it can be a
4179 * macro. */
4180 #if SIZEOF_INT <= 2
4181 char *q = memchr(str_arg, '\0', precision);
4182 #else
4183 /* memchr on HP does not like n > 2^31 !!! */
4184 char *q = memchr(str_arg, '\0',
4185 precision <= (size_t)0x7fffffffL ? precision
4186 : (size_t)0x7fffffffL);
4187 #endif
4188 str_arg_l = (q == NULL) ? precision : q - str_arg;
4190 break;
4192 default:
4193 break;
4195 break;
4197 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4199 /* NOTE: the u, o, x, X and p conversion specifiers
4200 * imply the value is unsigned; d implies a signed
4201 * value */
4203 /* 0 if numeric argument is zero (or if pointer is
4204 * NULL for 'p'), +1 if greater than zero (or nonzero
4205 * for unsigned arguments), -1 if negative (unsigned
4206 * argument is never negative) */
4207 int arg_sign = 0;
4209 /* only defined for length modifier h, or for no
4210 * length modifiers */
4211 int int_arg = 0;
4212 unsigned int uint_arg = 0;
4214 /* only defined for length modifier l */
4215 long int long_arg = 0;
4216 unsigned long int ulong_arg = 0;
4218 /* pointer argument value -only defined for p
4219 * conversion */
4220 void *ptr_arg = NULL;
4222 if (fmt_spec == 'p')
4224 length_modifier = '\0';
4225 ptr_arg =
4226 #ifndef HAVE_STDARG_H
4227 (void *)get_a_arg(arg_idx);
4228 #else
4229 # if defined(FEAT_EVAL)
4230 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
4231 # endif
4232 va_arg(ap, void *);
4233 #endif
4234 if (ptr_arg != NULL)
4235 arg_sign = 1;
4237 else if (fmt_spec == 'd')
4239 /* signed */
4240 switch (length_modifier)
4242 case '\0':
4243 case 'h':
4244 /* char and short arguments are passed as int. */
4245 int_arg =
4246 #ifndef HAVE_STDARG_H
4247 get_a_arg(arg_idx);
4248 #else
4249 # if defined(FEAT_EVAL)
4250 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4251 # endif
4252 va_arg(ap, int);
4253 #endif
4254 if (int_arg > 0)
4255 arg_sign = 1;
4256 else if (int_arg < 0)
4257 arg_sign = -1;
4258 break;
4259 case 'l':
4260 long_arg =
4261 #ifndef HAVE_STDARG_H
4262 get_a_arg(arg_idx);
4263 #else
4264 # if defined(FEAT_EVAL)
4265 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4266 # endif
4267 va_arg(ap, long int);
4268 #endif
4269 if (long_arg > 0)
4270 arg_sign = 1;
4271 else if (long_arg < 0)
4272 arg_sign = -1;
4273 break;
4276 else
4278 /* unsigned */
4279 switch (length_modifier)
4281 case '\0':
4282 case 'h':
4283 uint_arg =
4284 #ifndef HAVE_STDARG_H
4285 get_a_arg(arg_idx);
4286 #else
4287 # if defined(FEAT_EVAL)
4288 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4289 # endif
4290 va_arg(ap, unsigned int);
4291 #endif
4292 if (uint_arg != 0)
4293 arg_sign = 1;
4294 break;
4295 case 'l':
4296 ulong_arg =
4297 #ifndef HAVE_STDARG_H
4298 get_a_arg(arg_idx);
4299 #else
4300 # if defined(FEAT_EVAL)
4301 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4302 # endif
4303 va_arg(ap, unsigned long int);
4304 #endif
4305 if (ulong_arg != 0)
4306 arg_sign = 1;
4307 break;
4311 str_arg = tmp;
4312 str_arg_l = 0;
4314 /* NOTE:
4315 * For d, i, u, o, x, and X conversions, if precision is
4316 * specified, the '0' flag should be ignored. This is so
4317 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4318 * FreeBSD, NetBSD; but not with Perl.
4320 if (precision_specified)
4321 zero_padding = 0;
4322 if (fmt_spec == 'd')
4324 if (force_sign && arg_sign >= 0)
4325 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4326 /* leave negative numbers for sprintf to handle, to
4327 * avoid handling tricky cases like (short int)-32768 */
4329 else if (alternate_form)
4331 if (arg_sign != 0
4332 && (fmt_spec == 'x' || fmt_spec == 'X') )
4334 tmp[str_arg_l++] = '0';
4335 tmp[str_arg_l++] = fmt_spec;
4337 /* alternate form should have no effect for p
4338 * conversion, but ... */
4341 zero_padding_insertion_ind = str_arg_l;
4342 if (!precision_specified)
4343 precision = 1; /* default precision is 1 */
4344 if (precision == 0 && arg_sign == 0)
4346 /* When zero value is formatted with an explicit
4347 * precision 0, the resulting formatted string is
4348 * empty (d, i, u, o, x, X, p). */
4350 else
4352 char f[5];
4353 int f_l = 0;
4355 /* construct a simple format string for sprintf */
4356 f[f_l++] = '%';
4357 if (!length_modifier)
4359 else if (length_modifier == '2')
4361 f[f_l++] = 'l';
4362 f[f_l++] = 'l';
4364 else
4365 f[f_l++] = length_modifier;
4366 f[f_l++] = fmt_spec;
4367 f[f_l++] = '\0';
4369 if (fmt_spec == 'p')
4370 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4371 else if (fmt_spec == 'd')
4373 /* signed */
4374 switch (length_modifier)
4376 case '\0':
4377 case 'h': str_arg_l += sprintf(
4378 tmp + str_arg_l, f, int_arg);
4379 break;
4380 case 'l': str_arg_l += sprintf(
4381 tmp + str_arg_l, f, long_arg);
4382 break;
4385 else
4387 /* unsigned */
4388 switch (length_modifier)
4390 case '\0':
4391 case 'h': str_arg_l += sprintf(
4392 tmp + str_arg_l, f, uint_arg);
4393 break;
4394 case 'l': str_arg_l += sprintf(
4395 tmp + str_arg_l, f, ulong_arg);
4396 break;
4400 /* include the optional minus sign and possible
4401 * "0x" in the region before the zero padding
4402 * insertion point */
4403 if (zero_padding_insertion_ind < str_arg_l
4404 && tmp[zero_padding_insertion_ind] == '-')
4405 zero_padding_insertion_ind++;
4406 if (zero_padding_insertion_ind + 1 < str_arg_l
4407 && tmp[zero_padding_insertion_ind] == '0'
4408 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4409 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4410 zero_padding_insertion_ind += 2;
4414 size_t num_of_digits = str_arg_l
4415 - zero_padding_insertion_ind;
4417 if (alternate_form && fmt_spec == 'o'
4418 /* unless zero is already the first
4419 * character */
4420 && !(zero_padding_insertion_ind < str_arg_l
4421 && tmp[zero_padding_insertion_ind] == '0'))
4423 /* assure leading zero for alternate-form
4424 * octal numbers */
4425 if (!precision_specified
4426 || precision < num_of_digits + 1)
4428 /* precision is increased to force the
4429 * first character to be zero, except if a
4430 * zero value is formatted with an
4431 * explicit precision of zero */
4432 precision = num_of_digits + 1;
4433 precision_specified = 1;
4436 /* zero padding to specified precision? */
4437 if (num_of_digits < precision)
4438 number_of_zeros_to_pad = precision - num_of_digits;
4440 /* zero padding to specified minimal field width? */
4441 if (!justify_left && zero_padding)
4443 int n = (int)(min_field_width - (str_arg_l
4444 + number_of_zeros_to_pad));
4445 if (n > 0)
4446 number_of_zeros_to_pad += n;
4448 break;
4451 default:
4452 /* unrecognized conversion specifier, keep format string
4453 * as-is */
4454 zero_padding = 0; /* turn zero padding off for non-numeric
4455 conversion */
4456 justify_left = 1;
4457 min_field_width = 0; /* reset flags */
4459 /* discard the unrecognized conversion, just keep *
4460 * the unrecognized conversion character */
4461 str_arg = p;
4462 str_arg_l = 0;
4463 if (*p != NUL)
4464 str_arg_l++; /* include invalid conversion specifier
4465 unchanged if not at end-of-string */
4466 break;
4469 if (*p != NUL)
4470 p++; /* step over the just processed conversion specifier */
4472 /* insert padding to the left as requested by min_field_width;
4473 * this does not include the zero padding in case of numerical
4474 * conversions*/
4475 if (!justify_left)
4477 /* left padding with blank or zero */
4478 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4480 if (pn > 0)
4482 if (str_l < str_m)
4484 size_t avail = str_m - str_l;
4486 vim_memset(str + str_l, zero_padding ? '0' : ' ',
4487 (size_t)pn > avail ? avail : pn);
4489 str_l += pn;
4493 /* zero padding as requested by the precision or by the minimal
4494 * field width for numeric conversions required? */
4495 if (number_of_zeros_to_pad == 0)
4497 /* will not copy first part of numeric right now, *
4498 * force it to be copied later in its entirety */
4499 zero_padding_insertion_ind = 0;
4501 else
4503 /* insert first part of numerics (sign or '0x') before zero
4504 * padding */
4505 int zn = (int)zero_padding_insertion_ind;
4507 if (zn > 0)
4509 if (str_l < str_m)
4511 size_t avail = str_m - str_l;
4513 mch_memmove(str + str_l, str_arg,
4514 (size_t)zn > avail ? avail : zn);
4516 str_l += zn;
4519 /* insert zero padding as requested by the precision or min
4520 * field width */
4521 zn = (int)number_of_zeros_to_pad;
4522 if (zn > 0)
4524 if (str_l < str_m)
4526 size_t avail = str_m-str_l;
4528 vim_memset(str + str_l, '0',
4529 (size_t)zn > avail ? avail : zn);
4531 str_l += zn;
4535 /* insert formatted string
4536 * (or as-is conversion specifier for unknown conversions) */
4538 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
4540 if (sn > 0)
4542 if (str_l < str_m)
4544 size_t avail = str_m - str_l;
4546 mch_memmove(str + str_l,
4547 str_arg + zero_padding_insertion_ind,
4548 (size_t)sn > avail ? avail : sn);
4550 str_l += sn;
4554 /* insert right padding */
4555 if (justify_left)
4557 /* right blank padding to the field width */
4558 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
4560 if (pn > 0)
4562 if (str_l < str_m)
4564 size_t avail = str_m - str_l;
4566 vim_memset(str + str_l, ' ',
4567 (size_t)pn > avail ? avail : pn);
4569 str_l += pn;
4575 if (str_m > 0)
4577 /* make sure the string is nul-terminated even at the expense of
4578 * overwriting the last character (shouldn't happen, but just in case)
4579 * */
4580 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4583 #ifdef HAVE_STDARG_H
4584 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
4585 EMSG(_("E767: Too many arguments to printf()"));
4586 #endif
4588 /* Return the number of characters formatted (excluding trailing nul
4589 * character), that is, the number of characters that would have been
4590 * written to the buffer if it were large enough. */
4591 return (int)str_l;
4594 #endif /* PROTO */