blob: 548a89eed083c7741ea5bc8fb98cbcc5435221f5 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * message.c: functions for displaying messages on the command line
12 */
13
14#define MESSAGE_FILE /* don't include prototype for smsg() */
15
16#include "vim.h"
17
Bram Moolenaara7241f52008-06-24 20:39:31 +000018#if defined(FEAT_FLOAT) && defined(HAVE_MATH_H)
19# include <math.h>
20#endif
21
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +000022static int other_sourcing_name __ARGS((void));
23static char_u *get_emsg_source __ARGS((void));
24static char_u *get_emsg_lnum __ARGS((void));
Bram Moolenaar071d4272004-06-13 20:20:40 +000025static void add_msg_hist __ARGS((char_u *s, int len, int attr));
26static void hit_return_msg __ARGS((void));
27static void msg_home_replace_attr __ARGS((char_u *fname, int attr));
28#ifdef FEAT_MBYTE
29static char_u *screen_puts_mbyte __ARGS((char_u *s, int l, int attr));
30#endif
31static void msg_puts_attr_len __ARGS((char_u *str, int maxlen, int attr));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +000032static void msg_puts_display __ARGS((char_u *str, int maxlen, int attr, int recurse));
33static void msg_scroll_up __ARGS((void));
Bram Moolenaarbb15b652005-10-03 21:52:09 +000034static void inc_msg_scrolled __ARGS((void));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +000035static void store_sb_text __ARGS((char_u **sb_str, char_u *s, int attr, int *sb_col, int finish));
36static void t_puts __ARGS((int *t_col, char_u *t_s, char_u *s, int attr));
37static void msg_puts_printf __ARGS((char_u *str, int maxlen));
38static int do_more_prompt __ARGS((int typed_char));
Bram Moolenaar071d4272004-06-13 20:20:40 +000039static void msg_screen_putchar __ARGS((int c, int attr));
40static int msg_check_screen __ARGS((void));
41static void redir_write __ARGS((char_u *s, int maxlen));
Bram Moolenaar8b044b32005-05-31 22:05:58 +000042static void verbose_write __ARGS((char_u *s, int maxlen));
Bram Moolenaar071d4272004-06-13 20:20:40 +000043#ifdef FEAT_CON_DIALOG
44static char_u *msg_show_console_dialog __ARGS((char_u *message, char_u *buttons, int dfltbutton));
45static int confirm_msg_used = FALSE; /* displaying confirm_msg */
46static char_u *confirm_msg = NULL; /* ":confirm" message */
47static char_u *confirm_msg_tail; /* tail of confirm_msg */
48#endif
49
50struct msg_hist
51{
52 struct msg_hist *next;
53 char_u *msg;
54 int attr;
55};
56
57static struct msg_hist *first_msg_hist = NULL;
58static struct msg_hist *last_msg_hist = NULL;
59static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
61/*
62 * When writing messages to the screen, there are many different situations.
63 * A number of variables is used to remember the current state:
64 * msg_didany TRUE when messages were written since the last time the
65 * user reacted to a prompt.
66 * Reset: After hitting a key for the hit-return prompt,
67 * hitting <CR> for the command line or input().
68 * Set: When any message is written to the screen.
69 * msg_didout TRUE when something was written to the current line.
70 * Reset: When advancing to the next line, when the current
71 * text can be overwritten.
72 * Set: When any message is written to the screen.
73 * msg_nowait No extra delay for the last drawn message.
74 * Used in normal_cmd() before the mode message is drawn.
75 * emsg_on_display There was an error message recently. Indicates that there
76 * should be a delay before redrawing.
77 * msg_scroll The next message should not overwrite the current one.
78 * msg_scrolled How many lines the screen has been scrolled (because of
79 * messages). Used in update_screen() to scroll the screen
80 * back. Incremented each time the screen scrolls a line.
81 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
82 * writes something without scrolling should not make
83 * need_wait_return to be set. This is a hack to make ":ts"
84 * work without an extra prompt.
85 * lines_left Number of lines available for messages before the
86 * more-prompt is to be given.
87 * need_wait_return TRUE when the hit-return prompt is needed.
88 * Reset: After giving the hit-return prompt, when the user
89 * has answered some other prompt.
90 * Set: When the ruler or typeahead display is overwritten,
91 * scrolling the screen for some message.
92 * keep_msg Message to be displayed after redrawing the screen, in
93 * main_loop().
94 * This is an allocated string or NULL when not used.
95 */
96
97/*
98 * msg(s) - displays the string 's' on the status line
99 * When terminal not initialized (yet) mch_errmsg(..) is used.
100 * return TRUE if wait_return not called
101 */
102 int
103msg(s)
104 char_u *s;
105{
106 return msg_attr_keep(s, 0, FALSE);
107}
108
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000109#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
110 || defined(PROTO)
111/*
112 * Like msg() but keep it silent when 'verbosefile' is set.
113 */
114 int
115verb_msg(s)
116 char_u *s;
117{
118 int n;
119
120 verbose_enter();
121 n = msg_attr_keep(s, 0, FALSE);
122 verbose_leave();
123
124 return n;
125}
126#endif
127
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 int
129msg_attr(s, attr)
130 char_u *s;
131 int attr;
132{
133 return msg_attr_keep(s, attr, FALSE);
134}
135
136 int
137msg_attr_keep(s, attr, keep)
138 char_u *s;
139 int attr;
140 int keep; /* TRUE: set keep_msg if it doesn't scroll */
141{
142 static int entered = 0;
143 int retval;
144 char_u *buf = NULL;
145
146#ifdef FEAT_EVAL
147 if (attr == 0)
148 set_vim_var_string(VV_STATUSMSG, s, -1);
149#endif
150
151 /*
152 * It is possible that displaying a messages causes a problem (e.g.,
153 * when redrawing the window), which causes another message, etc.. To
154 * break this loop, limit the recursiveness to 3 levels.
155 */
156 if (entered >= 3)
157 return TRUE;
158 ++entered;
159
160 /* Add message to history (unless it's a repeated kept message or a
161 * truncated message) */
162 if (s != keep_msg
163 || (*s != '<'
164 && last_msg_hist != NULL
165 && last_msg_hist->msg != NULL
166 && STRCMP(s, last_msg_hist->msg)))
167 add_msg_hist(s, -1, attr);
168
169 /* When displaying keep_msg, don't let msg_start() free it, caller must do
170 * that. */
171 if (s == keep_msg)
172 keep_msg = NULL;
173
174 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000175 msg_start();
176 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177 if (buf != NULL)
178 s = buf;
179
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 msg_outtrans_attr(s, attr);
181 msg_clr_eos();
182 retval = msg_end();
183
184 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
185 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000186 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187
188 vim_free(buf);
189 --entered;
190 return retval;
191}
192
193/*
194 * Truncate a string such that it can be printed without causing a scroll.
195 * Returns an allocated string or NULL when no truncating is done.
196 */
197 char_u *
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000198msg_strtrunc(s, force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199 char_u *s;
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000200 int force; /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201{
202 char_u *buf = NULL;
203 int len;
204 int room;
205
206 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000207 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
208 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209 {
210 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000211 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000212 /* Use all the columns. */
213 room = (int)(Rows - msg_row) * Columns - 1;
214 else
215 /* Use up to 'showcmd' column. */
216 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217 if (len > room && room > 0)
218 {
219#ifdef FEAT_MBYTE
220 if (enc_utf8)
221 /* may have up to 18 bytes per cell (6 per char, up to two
222 * composing chars) */
223 buf = alloc((room + 2) * 18);
224 else if (enc_dbcs == DBCS_JPNU)
225 /* may have up to 2 bytes per cell for euc-jp */
226 buf = alloc((room + 2) * 2);
227 else
228#endif
229 buf = alloc(room + 2);
230 if (buf != NULL)
231 trunc_string(s, buf, room);
232 }
233 }
234 return buf;
235}
236
237/*
238 * Truncate a string "s" to "buf" with cell width "room".
239 * "s" and "buf" may be equal.
240 */
241 void
242trunc_string(s, buf, room)
243 char_u *s;
244 char_u *buf;
245 int room;
246{
247 int half;
248 int len;
249 int e;
250 int i;
251 int n;
252
253 room -= 3;
254 half = room / 2;
255 len = 0;
256
257 /* First part: Start of the string. */
258 for (e = 0; len < half; ++e)
259 {
260 if (s[e] == NUL)
261 {
262 /* text fits without truncating! */
263 buf[e] = NUL;
264 return;
265 }
266 n = ptr2cells(s + e);
267 if (len + n >= half)
268 break;
269 len += n;
270 buf[e] = s[e];
271#ifdef FEAT_MBYTE
272 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000273 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 {
275 ++e;
276 buf[e] = s[e];
277 }
278#endif
279 }
280
281 /* Last part: End of the string. */
282 i = e;
283#ifdef FEAT_MBYTE
284 if (enc_dbcs != 0)
285 {
286 /* For DBCS going backwards in a string is slow, but
287 * computing the cell width isn't too slow: go forward
288 * until the rest fits. */
289 n = vim_strsize(s + i);
290 while (len + n > room)
291 {
292 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000293 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 }
295 }
296 else if (enc_utf8)
297 {
298 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000299 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300 for (;;)
301 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000302 do
303 half = half - (*mb_head_off)(s, s + half - 1) - 1;
304 while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 n = ptr2cells(s + half);
306 if (len + n > room)
307 break;
308 len += n;
309 i = half;
310 }
311 }
312 else
313#endif
314 {
315 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
316 len += n;
317 }
318
319 /* Set the middle and copy the last part. */
320 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaara7241f52008-06-24 20:39:31 +0000321 STRMOVE(buf + e + 3, s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322}
323
324/*
325 * Automatic prototype generation does not understand this function.
326 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
327 * shorter than IOSIZE!!!
328 */
329#ifndef PROTO
330# ifndef HAVE_STDARG_H
331
332int
333#ifdef __BORLANDC__
334_RTLENTRYF
335#endif
336smsg __ARGS((char_u *, long, long, long,
337 long, long, long, long, long, long, long));
338int
339#ifdef __BORLANDC__
340_RTLENTRYF
341#endif
342smsg_attr __ARGS((int, char_u *, long, long, long,
343 long, long, long, long, long, long, long));
344
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000345int vim_snprintf __ARGS((char *, size_t, char *, long, long, long,
346 long, long, long, long, long, long, long));
347
348/*
349 * smsg(str, arg, ...) is like using sprintf(buf, str, arg, ...) and then
350 * calling msg(buf).
351 * The buffer used is IObuff, the message is truncated at IOSIZE.
352 */
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354/* VARARGS */
355 int
356#ifdef __BORLANDC__
357_RTLENTRYF
358#endif
359smsg(s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
360 char_u *s;
361 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
362{
363 return smsg_attr(0, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
364}
365
366/* VARARGS */
367 int
368#ifdef __BORLANDC__
369_RTLENTRYF
370#endif
371smsg_attr(attr, s, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
372 int attr;
373 char_u *s;
374 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
375{
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000376 vim_snprintf((char *)IObuff, IOSIZE, (char *)s,
377 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378 return msg_attr(IObuff, attr);
379}
380
381# else /* HAVE_STDARG_H */
382
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000383int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000384
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385 int
386#ifdef __BORLANDC__
387_RTLENTRYF
388#endif
389smsg(char_u *s, ...)
390{
391 va_list arglist;
392
393 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000394 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 va_end(arglist);
396 return msg(IObuff);
397}
398
399 int
400#ifdef __BORLANDC__
401_RTLENTRYF
402#endif
403smsg_attr(int attr, char_u *s, ...)
404{
405 va_list arglist;
406
407 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000408 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 va_end(arglist);
410 return msg_attr(IObuff, attr);
411}
412
413# endif /* HAVE_STDARG_H */
414#endif
415
416/*
417 * Remember the last sourcing name/lnum used in an error message, so that it
418 * isn't printed each time when it didn't change.
419 */
420static int last_sourcing_lnum = 0;
421static char_u *last_sourcing_name = NULL;
422
423/*
424 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
425 * for the next error message;
426 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000427 void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428reset_last_sourcing()
429{
430 vim_free(last_sourcing_name);
431 last_sourcing_name = NULL;
432 last_sourcing_lnum = 0;
433}
434
435/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000436 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
437 */
438 static int
439other_sourcing_name()
440{
441 if (sourcing_name != NULL)
442 {
443 if (last_sourcing_name != NULL)
444 return STRCMP(sourcing_name, last_sourcing_name) != 0;
445 return TRUE;
446 }
447 return FALSE;
448}
449
450/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451 * Get the message about the source, as used for an error message.
452 * Returns an allocated string with room for one more character.
453 * Returns NULL when no message is to be given.
454 */
455 static char_u *
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000456get_emsg_source()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457{
458 char_u *Buf, *p;
459
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000460 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 {
462 p = (char_u *)_("Error detected while processing %s:");
463 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
464 if (Buf != NULL)
465 sprintf((char *)Buf, (char *)p, sourcing_name);
466 return Buf;
467 }
468 return NULL;
469}
470
471/*
472 * Get the message about the source lnum, as used for an error message.
473 * Returns an allocated string with room for one more character.
474 * Returns NULL when no message is to be given.
475 */
476 static char_u *
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000477get_emsg_lnum()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478{
479 char_u *Buf, *p;
480
481 /* lnum is 0 when executing a command from the command line
482 * argument, we don't want a line number then */
483 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000484 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485 && sourcing_lnum != 0)
486 {
487 p = (char_u *)_("line %4ld:");
488 Buf = alloc((unsigned)(STRLEN(p) + 20));
489 if (Buf != NULL)
490 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
491 return Buf;
492 }
493 return NULL;
494}
495
496/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000497 * Display name and line number for the source of an error.
498 * Remember the file name and line number, so that for the next error the info
499 * is only displayed if it changed.
500 */
501 void
502msg_source(attr)
503 int attr;
504{
505 char_u *p;
506
507 ++no_wait_return;
508 p = get_emsg_source();
509 if (p != NULL)
510 {
511 msg_attr(p, attr);
512 vim_free(p);
513 }
514 p = get_emsg_lnum();
515 if (p != NULL)
516 {
517 msg_attr(p, hl_attr(HLF_N));
518 vim_free(p);
519 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
520 }
521
522 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000523 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000524 {
525 vim_free(last_sourcing_name);
526 if (sourcing_name == NULL)
527 last_sourcing_name = NULL;
528 else
529 last_sourcing_name = vim_strsave(sourcing_name);
530 }
531 --no_wait_return;
532}
533
534/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000535 * Return TRUE if not giving error messages right now:
536 * If "emsg_off" is set: no error messages at the moment.
537 * If "msg" is in 'debug': do error message but without side effects.
538 * If "emsg_skip" is set: never do error messages.
539 */
540 int
541emsg_not_now()
542{
543 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
544 && vim_strchr(p_debug, 't') == NULL)
545#ifdef FEAT_EVAL
546 || emsg_skip > 0
547#endif
548 )
549 return TRUE;
550 return FALSE;
551}
552
553/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 * emsg() - display an error message
555 *
556 * Rings the bell, if appropriate, and calls message() to do the real work
557 * When terminal not initialized (yet) mch_errmsg(..) is used.
558 *
559 * return TRUE if wait_return not called
560 */
561 int
562emsg(s)
563 char_u *s;
564{
565 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 char_u *p;
567#ifdef FEAT_EVAL
568 int ignore = FALSE;
569 int severe;
570#endif
571
572 called_emsg = TRUE;
Bram Moolenaardf177f62005-02-22 08:39:57 +0000573 ex_exitval = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574
575 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000576 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
577 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 */
579#ifdef FEAT_EVAL
580 severe = emsg_severe;
581 emsg_severe = FALSE;
582#endif
583
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000584 /* Skip this if not giving error messages at the moment. */
585 if (emsg_not_now())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 return TRUE;
587
Bram Moolenaar57657d82006-04-21 22:12:41 +0000588 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589 {
590#ifdef FEAT_EVAL
591 /*
592 * Cause a throw of an error exception if appropriate. Don't display
593 * the error message in this case. (If no matching catch clause will
594 * be found, the message will be displayed later on.) "ignore" is set
595 * when the message should be ignored completely (used for the
596 * interrupt message).
597 */
598 if (cause_errthrow(s, severe, &ignore) == TRUE)
599 {
600 if (!ignore)
601 did_emsg = TRUE;
602 return TRUE;
603 }
604
605 /* set "v:errmsg", also when using ":silent! cmd" */
606 set_vim_var_string(VV_ERRMSG, s, -1);
607#endif
608
609 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000610 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 * But do write it to the redirection file.
612 */
613 if (emsg_silent != 0)
614 {
615 msg_start();
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000616 p = get_emsg_source();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 if (p != NULL)
618 {
619 STRCAT(p, "\n");
620 redir_write(p, -1);
621 vim_free(p);
622 }
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000623 p = get_emsg_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 if (p != NULL)
625 {
626 STRCAT(p, "\n");
627 redir_write(p, -1);
628 vim_free(p);
629 }
630 redir_write(s, -1);
631 return TRUE;
632 }
633
634 /* Reset msg_silent, an error causes messages to be switched back on. */
635 msg_silent = 0;
636 cmd_silent = FALSE;
637
638 if (global_busy) /* break :global command */
639 ++global_busy;
640
641 if (p_eb)
642 beep_flush(); /* also includes flush_buffers() */
643 else
644 flush_buffers(FALSE); /* flush internal buffers */
645 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 }
647
648 emsg_on_display = TRUE; /* remember there is an error message */
649 ++msg_scroll; /* don't overwrite a previous message */
650 attr = hl_attr(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000651 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 need_wait_return = TRUE; /* needed in case emsg() is called after
653 * wait_return has reset need_wait_return
654 * and a redraw is expected because
655 * msg_scrolled is non-zero */
656
657 /*
658 * Display name and line number for the source of the error.
659 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000660 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661
662 /*
663 * Display the error message itself.
664 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000665 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 return msg_attr(s, attr);
667}
668
669/*
670 * Print an error message with one "%s" and one string argument.
671 */
672 int
673emsg2(s, a1)
674 char_u *s, *a1;
675{
676 return emsg3(s, a1, NULL);
677}
678
Bram Moolenaarea424162005-06-16 21:51:00 +0000679/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
Bram Moolenaardf177f62005-02-22 08:39:57 +0000681 void
682emsg_invreg(name)
683 int name;
684{
685 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
686}
687
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688/*
689 * Like msg(), but truncate to a single line if p_shm contains 't', or when
690 * "force" is TRUE. This truncates in another way as for normal messages.
691 * Careful: The string may be changed by msg_may_trunc()!
692 * Returns a pointer to the printed message, if wait_return() not called.
693 */
694 char_u *
695msg_trunc_attr(s, force, attr)
696 char_u *s;
697 int force;
698 int attr;
699{
700 int n;
701
702 /* Add message to history before truncating */
703 add_msg_hist(s, -1, attr);
704
705 s = msg_may_trunc(force, s);
706
707 msg_hist_off = TRUE;
708 n = msg_attr(s, attr);
709 msg_hist_off = FALSE;
710
711 if (n)
712 return s;
713 return NULL;
714}
715
716/*
717 * Check if message "s" should be truncated at the start (for filenames).
718 * Return a pointer to where the truncated message starts.
719 * Note: May change the message by replacing a character with '<'.
720 */
721 char_u *
722msg_may_trunc(force, s)
723 int force;
724 char_u *s;
725{
726 int n;
727 int room;
728
729 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
730 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
731 && (n = (int)STRLEN(s) - room) > 0)
732 {
733#ifdef FEAT_MBYTE
734 if (has_mbyte)
735 {
736 int size = vim_strsize(s);
737
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000738 /* There may be room anyway when there are multibyte chars. */
739 if (size <= room)
740 return s;
741
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 for (n = 0; size >= room; )
743 {
744 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000745 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 }
747 --n;
748 }
749#endif
750 s += n;
751 *s = '<';
752 }
753 return s;
754}
755
756 static void
757add_msg_hist(s, len, attr)
758 char_u *s;
759 int len; /* -1 for undetermined length */
760 int attr;
761{
762 struct msg_hist *p;
763
764 if (msg_hist_off || msg_silent != 0)
765 return;
766
767 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000768 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000769 (void)delete_first_msg();
770
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 /* allocate an entry and add the message at the end of the history */
772 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
773 if (p != NULL)
774 {
775 if (len < 0)
776 len = (int)STRLEN(s);
777 /* remove leading and trailing newlines */
778 while (len > 0 && *s == '\n')
779 {
780 ++s;
781 --len;
782 }
783 while (len > 0 && s[len - 1] == '\n')
784 --len;
785 p->msg = vim_strnsave(s, len);
786 p->next = NULL;
787 p->attr = attr;
788 if (last_msg_hist != NULL)
789 last_msg_hist->next = p;
790 last_msg_hist = p;
791 if (first_msg_hist == NULL)
792 first_msg_hist = last_msg_hist;
793 ++msg_hist_len;
794 }
795}
796
797/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000798 * Delete the first (oldest) message from the history.
799 * Returns FAIL if there are no messages.
800 */
801 int
802delete_first_msg()
803{
804 struct msg_hist *p;
805
806 if (msg_hist_len <= 0)
807 return FAIL;
808 p = first_msg_hist;
809 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000810 if (first_msg_hist == NULL)
811 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000812 vim_free(p->msg);
813 vim_free(p);
814 --msg_hist_len;
815 return OK;
816}
817
818/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 * ":messages" command.
820 */
821/*ARGSUSED*/
822 void
823ex_messages(eap)
824 exarg_T *eap;
825{
826 struct msg_hist *p;
827 char_u *s;
828
829 msg_hist_off = TRUE;
830
831 s = mch_getenv((char_u *)"LANG");
832 if (s != NULL && *s != NUL)
833 msg_attr((char_u *)
834 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
835 hl_attr(HLF_T));
836
Bram Moolenaar5c2e0f22007-09-13 20:05:18 +0000837 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 if (p->msg != NULL)
839 msg_attr(p->msg, p->attr);
840
841 msg_hist_off = FALSE;
842}
843
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000844#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845/*
846 * Call this after prompting the user. This will avoid a hit-return message
847 * and a delay.
848 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000849 void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850msg_end_prompt()
851{
852 need_wait_return = FALSE;
853 emsg_on_display = FALSE;
854 cmdline_row = msg_row;
855 msg_col = 0;
856 msg_clr_eos();
857}
858#endif
859
860/*
861 * wait for the user to hit a key (normally a return)
862 * if 'redraw' is TRUE, clear and redraw the screen
863 * if 'redraw' is FALSE, just redraw the screen
864 * if 'redraw' is -1, don't redraw at all
865 */
866 void
867wait_return(redraw)
868 int redraw;
869{
870 int c;
871 int oldState;
872 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 int had_got_int;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874
875 if (redraw == TRUE)
876 must_redraw = CLEAR;
877
878 /* If using ":silent cmd", don't wait for a return. Also don't set
879 * need_wait_return to do it later. */
880 if (msg_silent != 0)
881 return;
882
883/*
884 * With the global command (and some others) we only need one return at the
885 * end. Adjust cmdline_row to avoid the next message overwriting the last one.
886 * When inside vgetc(), we can't wait for a typed character at all.
887 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000888 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 return;
890 if (no_wait_return)
891 {
892 need_wait_return = TRUE;
893 if (!exmode_active)
894 cmdline_row = msg_row;
895 return;
896 }
897
898 redir_off = TRUE; /* don't redirect this message */
899 oldState = State;
900 if (quit_more)
901 {
902 c = CAR; /* just pretend CR was hit */
903 quit_more = FALSE;
904 got_int = FALSE;
905 }
906 else if (exmode_active)
907 {
908 MSG_PUTS(" "); /* make sure the cursor is on the right line */
909 c = CAR; /* no need for a return in ex mode */
910 got_int = FALSE;
911 }
912 else
913 {
914 /* Make sure the hit-return prompt is on screen when 'guioptions' was
915 * just changed. */
916 screenalloc(FALSE);
917
918 State = HITRETURN;
919#ifdef FEAT_MOUSE
920 setmouse();
921#endif
922#ifdef USE_ON_FLY_SCROLL
923 dont_scroll = TRUE; /* disallow scrolling here */
924#endif
925 hit_return_msg();
926
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 do
928 {
929 /* Remember "got_int", if it is set vgetc() probably returns a
930 * CTRL-C, but we need to loop then. */
931 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000932
933 /* Don't do mappings here, we put the character back in the
934 * typeahead buffer. */
935 ++no_mapping;
936 ++allow_keys;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000938 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000940 --no_mapping;
941 --allow_keys;
942
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943#ifdef FEAT_CLIPBOARD
944 /* Strange way to allow copying (yanking) a modeless selection at
945 * the hit-enter prompt. Use CTRL-Y, because the same is used in
946 * Cmdline-mode and it's harmless when there is no selection. */
947 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
948 {
949 clip_copy_modeless_selection(TRUE);
950 c = K_IGNORE;
951 }
952#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000953
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000954 /*
955 * Allow scrolling back in the messages.
956 * Also accept scroll-down commands when messages fill the screen,
957 * to avoid that typing one 'j' too many makes the messages
958 * disappear.
959 */
960 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000961 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000962 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000963 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000964 /* scroll back to show older messages */
965 do_more_prompt(c);
966 if (quit_more)
967 {
968 c = CAR; /* just pretend CR was hit */
969 quit_more = FALSE;
970 got_int = FALSE;
971 }
972 else
973 {
974 c = K_IGNORE;
975 hit_return_msg();
976 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000977 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000978 else if (msg_scrolled > Rows - 2
979 && (c == 'j' || c == K_DOWN || c == 'd'))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000980 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000981 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 } while ((had_got_int && c == Ctrl_C)
983 || c == K_IGNORE
984#ifdef FEAT_GUI
985 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
986#endif
987#ifdef FEAT_MOUSE
988 || c == K_LEFTDRAG || c == K_LEFTRELEASE
989 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
990 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
991 || c == K_MOUSEDOWN || c == K_MOUSEUP
992 || (!mouse_has(MOUSE_RETURN)
993 && mouse_row < msg_row
994 && (c == K_LEFTMOUSE
995 || c == K_MIDDLEMOUSE
996 || c == K_RIGHTMOUSE
997 || c == K_X1MOUSE
998 || c == K_X2MOUSE))
999#endif
1000 );
1001 ui_breakcheck();
1002#ifdef FEAT_MOUSE
1003 /*
1004 * Avoid that the mouse-up event causes visual mode to start.
1005 */
1006 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1007 || c == K_X1MOUSE || c == K_X2MOUSE)
1008 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1009 else
1010#endif
1011 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1012 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001013 /* Put the character back in the typeahead buffer. Don't use the
1014 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001015 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001017 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 }
1020 redir_off = FALSE;
1021
1022 /*
1023 * If the user hits ':', '?' or '/' we get a command line from the next
1024 * line.
1025 */
1026 if (c == ':' || c == '?' || c == '/')
1027 {
1028 if (!exmode_active)
1029 cmdline_row = msg_row;
1030 skip_redraw = TRUE; /* skip redraw once */
1031 do_redraw = FALSE;
1032 }
1033
1034 /*
1035 * If the window size changed set_shellsize() will redraw the screen.
1036 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1037 * typed.
1038 */
1039 tmpState = State;
1040 State = oldState; /* restore State before set_shellsize */
1041#ifdef FEAT_MOUSE
1042 setmouse();
1043#endif
1044 msg_check();
1045
1046#if defined(UNIX) || defined(VMS)
1047 /*
1048 * When switching screens, we need to output an extra newline on exit.
1049 */
1050 if (swapping_screen() && !termcap_active)
1051 newline_on_exit = TRUE;
1052#endif
1053
1054 need_wait_return = FALSE;
1055 did_wait_return = TRUE;
1056 emsg_on_display = FALSE; /* can delete error message now */
1057 lines_left = -1; /* reset lines_left at next msg_start() */
1058 reset_last_sourcing();
1059 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1060 (Rows - cmdline_row - 1) * Columns + sc_col)
1061 {
1062 vim_free(keep_msg);
1063 keep_msg = NULL; /* don't redisplay message, it's too long */
1064 }
1065
1066 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1067 {
1068 starttermcap(); /* start termcap before redrawing */
1069 shell_resized();
1070 }
1071 else if (!skip_redraw
1072 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1073 {
1074 starttermcap(); /* start termcap before redrawing */
1075 redraw_later(VALID);
1076 }
1077}
1078
1079/*
1080 * Write the hit-return prompt.
1081 */
1082 static void
1083hit_return_msg()
1084{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001085 int save_p_more = p_more;
1086
1087 p_more = FALSE; /* don't want see this message when scrolling back */
1088 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 msg_putchar('\n');
1090 if (got_int)
1091 MSG_PUTS(_("Interrupt: "));
1092
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001093 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 if (!msg_use_printf())
1095 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001096 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097}
1098
1099/*
1100 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1101 */
1102 void
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001103set_keep_msg(s, attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 char_u *s;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001105 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106{
1107 vim_free(keep_msg);
1108 if (s != NULL && msg_silent == 0)
1109 keep_msg = vim_strsave(s);
1110 else
1111 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001112 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001113 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114}
1115
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001116#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1117/*
1118 * If there currently is a message being displayed, set "keep_msg" to it, so
1119 * that it will be displayed again after redraw.
1120 */
1121 void
1122set_keep_msg_from_hist()
1123{
1124 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1125 && (State & NORMAL))
1126 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1127}
1128#endif
1129
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130/*
1131 * Prepare for outputting characters in the command line.
1132 */
1133 void
1134msg_start()
1135{
1136 int did_return = FALSE;
1137
1138 vim_free(keep_msg);
1139 keep_msg = NULL; /* don't display old message now */
Bram Moolenaara7241f52008-06-24 20:39:31 +00001140
1141#ifdef FEAT_EVAL
1142 if (need_clr_eos)
1143 {
1144 /* Halfway an ":echo" command and getting an (error) message: clear
1145 * any text from the command. */
1146 need_clr_eos = FALSE;
1147 msg_clr_eos();
1148 }
1149#endif
1150
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 if (!msg_scroll && full_screen) /* overwrite last message */
1152 {
1153 msg_row = cmdline_row;
1154 msg_col =
1155#ifdef FEAT_RIGHTLEFT
1156 cmdmsg_rl ? Columns - 1 :
1157#endif
1158 0;
1159 }
1160 else if (msg_didout) /* start message on next line */
1161 {
1162 msg_putchar('\n');
1163 did_return = TRUE;
1164 if (exmode_active != EXMODE_NORMAL)
1165 cmdline_row = msg_row;
1166 }
1167 if (!msg_didany || lines_left < 0)
1168 msg_starthere();
1169 if (msg_silent == 0)
1170 {
1171 msg_didout = FALSE; /* no output on current line yet */
1172 cursor_off();
1173 }
1174
1175 /* when redirecting, may need to start a new line. */
1176 if (!did_return)
1177 redir_write((char_u *)"\n", -1);
1178}
1179
1180/*
1181 * Note that the current msg position is where messages start.
1182 */
1183 void
1184msg_starthere()
1185{
1186 lines_left = cmdline_row;
1187 msg_didany = FALSE;
1188}
1189
1190 void
1191msg_putchar(c)
1192 int c;
1193{
1194 msg_putchar_attr(c, 0);
1195}
1196
1197 void
1198msg_putchar_attr(c, attr)
1199 int c;
1200 int attr;
1201{
1202#ifdef FEAT_MBYTE
1203 char_u buf[MB_MAXBYTES + 1];
1204#else
1205 char_u buf[4];
1206#endif
1207
1208 if (IS_SPECIAL(c))
1209 {
1210 buf[0] = K_SPECIAL;
1211 buf[1] = K_SECOND(c);
1212 buf[2] = K_THIRD(c);
1213 buf[3] = NUL;
1214 }
1215 else
1216 {
1217#ifdef FEAT_MBYTE
1218 buf[(*mb_char2bytes)(c, buf)] = NUL;
1219#else
1220 buf[0] = c;
1221 buf[1] = NUL;
1222#endif
1223 }
1224 msg_puts_attr(buf, attr);
1225}
1226
1227 void
1228msg_outnum(n)
1229 long n;
1230{
1231 char_u buf[20];
1232
1233 sprintf((char *)buf, "%ld", n);
1234 msg_puts(buf);
1235}
1236
1237 void
1238msg_home_replace(fname)
1239 char_u *fname;
1240{
1241 msg_home_replace_attr(fname, 0);
1242}
1243
1244#if defined(FEAT_FIND_ID) || defined(PROTO)
1245 void
1246msg_home_replace_hl(fname)
1247 char_u *fname;
1248{
1249 msg_home_replace_attr(fname, hl_attr(HLF_D));
1250}
1251#endif
1252
1253 static void
1254msg_home_replace_attr(fname, attr)
1255 char_u *fname;
1256 int attr;
1257{
1258 char_u *name;
1259
1260 name = home_replace_save(NULL, fname);
1261 if (name != NULL)
1262 msg_outtrans_attr(name, attr);
1263 vim_free(name);
1264}
1265
1266/*
1267 * Output 'len' characters in 'str' (including NULs) with translation
1268 * if 'len' is -1, output upto a NUL character.
1269 * Use attributes 'attr'.
1270 * Return the number of characters it takes on the screen.
1271 */
1272 int
1273msg_outtrans(str)
1274 char_u *str;
1275{
1276 return msg_outtrans_attr(str, 0);
1277}
1278
1279 int
1280msg_outtrans_attr(str, attr)
1281 char_u *str;
1282 int attr;
1283{
1284 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1285}
1286
1287 int
1288msg_outtrans_len(str, len)
1289 char_u *str;
1290 int len;
1291{
1292 return msg_outtrans_len_attr(str, len, 0);
1293}
1294
1295/*
1296 * Output one character at "p". Return pointer to the next character.
1297 * Handles multi-byte characters.
1298 */
1299 char_u *
1300msg_outtrans_one(p, attr)
1301 char_u *p;
1302 int attr;
1303{
1304#ifdef FEAT_MBYTE
1305 int l;
1306
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001307 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 {
1309 msg_outtrans_len_attr(p, l, attr);
1310 return p + l;
1311 }
1312#endif
1313 msg_puts_attr(transchar_byte(*p), attr);
1314 return p + 1;
1315}
1316
1317 int
1318msg_outtrans_len_attr(msgstr, len, attr)
1319 char_u *msgstr;
1320 int len;
1321 int attr;
1322{
1323 int retval = 0;
1324 char_u *str = msgstr;
1325 char_u *plain_start = msgstr;
1326 char_u *s;
1327#ifdef FEAT_MBYTE
1328 int mb_l;
1329 int c;
1330#endif
1331
1332 /* if MSG_HIST flag set, add message to history */
1333 if (attr & MSG_HIST)
1334 {
1335 add_msg_hist(str, len, attr);
1336 attr &= ~MSG_HIST;
1337 }
1338
1339#ifdef FEAT_MBYTE
1340 /* If the string starts with a composing character first draw a space on
1341 * which the composing char can be drawn. */
1342 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1343 msg_puts_attr((char_u *)" ", attr);
1344#endif
1345
1346 /*
1347 * Go over the string. Special characters are translated and printed.
1348 * Normal characters are printed several at a time.
1349 */
1350 while (--len >= 0)
1351 {
1352#ifdef FEAT_MBYTE
1353 if (enc_utf8)
1354 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001355 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001357 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 else
1359 mb_l = 1;
1360 if (has_mbyte && mb_l > 1)
1361 {
1362 c = (*mb_ptr2char)(str);
1363 if (vim_isprintc(c))
1364 /* printable multi-byte char: count the cells. */
1365 retval += (*mb_ptr2cells)(str);
1366 else
1367 {
1368 /* unprintable multi-byte char: print the printable chars so
1369 * far and the translation of the unprintable char. */
1370 if (str > plain_start)
1371 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1372 attr);
1373 plain_start = str + mb_l;
1374 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1375 retval += char2cells(c);
1376 }
1377 len -= mb_l - 1;
1378 str += mb_l;
1379 }
1380 else
1381#endif
1382 {
1383 s = transchar_byte(*str);
1384 if (s[1] != NUL)
1385 {
1386 /* unprintable char: print the printable chars so far and the
1387 * translation of the unprintable char. */
1388 if (str > plain_start)
1389 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1390 attr);
1391 plain_start = str + 1;
1392 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001393 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001395 else
1396 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 ++str;
1398 }
1399 }
1400
1401 if (str > plain_start)
1402 /* print the printable chars at the end */
1403 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1404
1405 return retval;
1406}
1407
1408#if defined(FEAT_QUICKFIX) || defined(PROTO)
1409 void
1410msg_make(arg)
1411 char_u *arg;
1412{
1413 int i;
1414 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1415
1416 arg = skipwhite(arg);
1417 for (i = 5; *arg && i >= 0; --i)
1418 if (*arg++ != str[i])
1419 break;
1420 if (i < 0)
1421 {
1422 msg_putchar('\n');
1423 for (i = 0; rs[i]; ++i)
1424 msg_putchar(rs[i] - 3);
1425 }
1426}
1427#endif
1428
1429/*
1430 * Output the string 'str' upto a NUL character.
1431 * Return the number of characters it takes on the screen.
1432 *
1433 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1434 * following character and shown as <F1>, <S-Up> etc. Any other character
1435 * which is not printable shown in <> form.
1436 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1437 * If a character is displayed in one of these special ways, is also
1438 * highlighted (its highlight name is '8' in the p_hl variable).
1439 * Otherwise characters are not highlighted.
1440 * This function is used to show mappings, where we want to see how to type
1441 * the character/string -- webb
1442 */
1443 int
1444msg_outtrans_special(strstart, from)
1445 char_u *strstart;
1446 int from; /* TRUE for lhs of a mapping */
1447{
1448 char_u *str = strstart;
1449 int retval = 0;
1450 char_u *string;
1451 int attr;
1452 int len;
1453
1454 attr = hl_attr(HLF_8);
1455 while (*str != NUL)
1456 {
1457 /* Leading and trailing spaces need to be displayed in <> form. */
1458 if ((str == strstart || str[1] == NUL) && *str == ' ')
1459 {
1460 string = (char_u *)"<Space>";
1461 ++str;
1462 }
1463 else
1464 string = str2special(&str, from);
1465 len = vim_strsize(string);
1466 /* Highlight special keys */
1467 msg_puts_attr(string, len > 1
1468#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001469 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470#endif
1471 ? attr : 0);
1472 retval += len;
1473 }
1474 return retval;
1475}
1476
1477/*
1478 * Return the printable string for the key codes at "*sp".
1479 * Used for translating the lhs or rhs of a mapping to printable chars.
1480 * Advances "sp" to the next code.
1481 */
1482 char_u *
1483str2special(sp, from)
1484 char_u **sp;
1485 int from; /* TRUE for lhs of mapping */
1486{
1487 int c;
1488 static char_u buf[7];
1489 char_u *str = *sp;
1490 int modifiers = 0;
1491 int special = FALSE;
1492
1493#ifdef FEAT_MBYTE
1494 if (has_mbyte)
1495 {
1496 char_u *p;
1497
1498 /* Try to un-escape a multi-byte character. Return the un-escaped
1499 * string if it is a multi-byte character. */
1500 p = mb_unescape(sp);
1501 if (p != NULL)
1502 return p;
1503 }
1504#endif
1505
1506 c = *str;
1507 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1508 {
1509 if (str[1] == KS_MODIFIER)
1510 {
1511 modifiers = str[2];
1512 str += 3;
1513 c = *str;
1514 }
1515 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1516 {
1517 c = TO_SPECIAL(str[1], str[2]);
1518 str += 2;
1519 if (c == K_ZERO) /* display <Nul> as ^@ */
1520 c = NUL;
1521 }
1522 if (IS_SPECIAL(c) || modifiers) /* special key */
1523 special = TRUE;
1524 }
1525 *sp = str + 1;
1526
1527#ifdef FEAT_MBYTE
1528 /* For multi-byte characters check for an illegal byte. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001529 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {
1531 transchar_nonprint(buf, c);
1532 return buf;
1533 }
1534#endif
1535
1536 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1537 * Use <Space> only for lhs of a mapping. */
1538 if (special || char2cells(c) > 1 || (from && c == ' '))
1539 return get_special_key_name(c, modifiers);
1540 buf[0] = c;
1541 buf[1] = NUL;
1542 return buf;
1543}
1544
1545/*
1546 * Translate a key sequence into special key names.
1547 */
1548 void
1549str2specialbuf(sp, buf, len)
1550 char_u *sp;
1551 char_u *buf;
1552 int len;
1553{
1554 char_u *s;
1555
1556 *buf = NUL;
1557 while (*sp)
1558 {
1559 s = str2special(&sp, FALSE);
1560 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1561 STRCAT(buf, s);
1562 }
1563}
1564
1565/*
1566 * print line for :print or :list command
1567 */
1568 void
Bram Moolenaardf177f62005-02-22 08:39:57 +00001569msg_prt_line(s, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 char_u *s;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001571 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572{
1573 int c;
1574 int col = 0;
1575 int n_extra = 0;
1576 int c_extra = 0;
1577 char_u *p_extra = NULL; /* init to make SASC shut up */
1578 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001579 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 char_u *trail = NULL;
1581#ifdef FEAT_MBYTE
1582 int l;
1583 char_u buf[MB_MAXBYTES + 1];
1584#endif
1585
Bram Moolenaardf177f62005-02-22 08:39:57 +00001586 if (curwin->w_p_list)
1587 list = TRUE;
1588
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001590 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 {
1592 trail = s + STRLEN(s);
1593 while (trail > s && vim_iswhite(trail[-1]))
1594 --trail;
1595 }
1596
1597 /* output a space for an empty line, otherwise the line will be
1598 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001599 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 msg_putchar(' ');
1601
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001602 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001604 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 {
1606 --n_extra;
1607 if (c_extra)
1608 c = c_extra;
1609 else
1610 c = *p_extra++;
1611 }
1612#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001613 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 {
1615 col += (*mb_ptr2cells)(s);
1616 mch_memmove(buf, s, (size_t)l);
1617 buf[l] = NUL;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001618 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 s += l;
1620 continue;
1621 }
1622#endif
1623 else
1624 {
1625 attr = 0;
1626 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001627 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 {
1629 /* tab amount depends on current column */
1630 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001631 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 {
1633 c = ' ';
1634 c_extra = ' ';
1635 }
1636 else
1637 {
1638 c = lcs_tab1;
1639 c_extra = lcs_tab2;
1640 attr = hl_attr(HLF_8);
1641 }
1642 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001643 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 {
1645 p_extra = (char_u *)"";
1646 c_extra = NUL;
1647 n_extra = 1;
1648 c = lcs_eol;
1649 attr = hl_attr(HLF_AT);
1650 --s;
1651 }
1652 else if (c != NUL && (n = byte2cells(c)) > 1)
1653 {
1654 n_extra = n - 1;
1655 p_extra = transchar_byte(c);
1656 c_extra = NUL;
1657 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001658 /* Use special coloring to be able to distinguish <hex> from
1659 * the same in plain text. */
1660 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 }
1662 else if (c == ' ' && trail != NULL && s > trail)
1663 {
1664 c = lcs_trail;
1665 attr = hl_attr(HLF_8);
1666 }
1667 }
1668
1669 if (c == NUL)
1670 break;
1671
1672 msg_putchar_attr(c, attr);
1673 col++;
1674 }
1675 msg_clr_eos();
1676}
1677
1678#ifdef FEAT_MBYTE
1679/*
1680 * Use screen_puts() to output one multi-byte character.
1681 * Return the pointer "s" advanced to the next character.
1682 */
1683 static char_u *
1684screen_puts_mbyte(s, l, attr)
1685 char_u *s;
1686 int l;
1687 int attr;
1688{
1689 int cw;
1690
1691 msg_didout = TRUE; /* remember that line is not empty */
1692 cw = (*mb_ptr2cells)(s);
1693 if (cw > 1 && (
1694#ifdef FEAT_RIGHTLEFT
1695 cmdmsg_rl ? msg_col <= 1 :
1696#endif
1697 msg_col == Columns - 1))
1698 {
1699 /* Doesn't fit, print a highlighted '>' to fill it up. */
1700 msg_screen_putchar('>', hl_attr(HLF_AT));
1701 return s;
1702 }
1703
1704 screen_puts_len(s, l, msg_row, msg_col, attr);
1705#ifdef FEAT_RIGHTLEFT
1706 if (cmdmsg_rl)
1707 {
1708 msg_col -= cw;
1709 if (msg_col == 0)
1710 {
1711 msg_col = Columns;
1712 ++msg_row;
1713 }
1714 }
1715 else
1716#endif
1717 {
1718 msg_col += cw;
1719 if (msg_col >= Columns)
1720 {
1721 msg_col = 0;
1722 ++msg_row;
1723 }
1724 }
1725 return s + l;
1726}
1727#endif
1728
1729/*
1730 * Output a string to the screen at position msg_row, msg_col.
1731 * Update msg_row and msg_col for the next message.
1732 */
1733 void
1734msg_puts(s)
1735 char_u *s;
1736{
1737 msg_puts_attr(s, 0);
1738}
1739
1740 void
1741msg_puts_title(s)
1742 char_u *s;
1743{
1744 msg_puts_attr(s, hl_attr(HLF_T));
1745}
1746
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747/*
1748 * Show a message in such a way that it always fits in the line. Cut out a
1749 * part in the middle and replace it with "..." when necessary.
1750 * Does not handle multi-byte characters!
1751 */
1752 void
1753msg_puts_long_attr(longstr, attr)
1754 char_u *longstr;
1755 int attr;
1756{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001757 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758}
1759
1760 void
1761msg_puts_long_len_attr(longstr, len, attr)
1762 char_u *longstr;
1763 int len;
1764 int attr;
1765{
1766 int slen = len;
1767 int room;
1768
1769 room = Columns - msg_col;
1770 if (len > room && room >= 20)
1771 {
1772 slen = (room - 3) / 2;
1773 msg_outtrans_len_attr(longstr, slen, attr);
1774 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1775 }
1776 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1777}
1778
1779/*
1780 * Basic function for writing a message with highlight attributes.
1781 */
1782 void
1783msg_puts_attr(s, attr)
1784 char_u *s;
1785 int attr;
1786{
1787 msg_puts_attr_len(s, -1, attr);
1788}
1789
1790/*
1791 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1792 * When "maxlen" is -1 there is no maximum length.
1793 * When "maxlen" is >= 0 the message is not put in the history.
1794 */
1795 static void
1796msg_puts_attr_len(str, maxlen, attr)
1797 char_u *str;
1798 int maxlen;
1799 int attr;
1800{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 /*
1802 * If redirection is on, also write to the redirection file.
1803 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001804 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805
1806 /*
1807 * Don't print anything when using ":silent cmd".
1808 */
1809 if (msg_silent != 0)
1810 return;
1811
1812 /* if MSG_HIST flag set, add message to history */
1813 if ((attr & MSG_HIST) && maxlen < 0)
1814 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001815 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 attr &= ~MSG_HIST;
1817 }
1818
1819 /*
1820 * When writing something to the screen after it has scrolled, requires a
1821 * wait-return prompt later. Needed when scrolling, resetting
1822 * need_wait_return after some prompt, and then outputting something
1823 * without scrolling
1824 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001825 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 need_wait_return = TRUE;
1827 msg_didany = TRUE; /* remember that something was outputted */
1828
1829 /*
1830 * If there is no valid screen, use fprintf so we can see error messages.
1831 * If termcap is not active, we may be writing in an alternate console
1832 * window, cursor positioning may not work correctly (window size may be
1833 * different, e.g. for Win32 console) or we just don't know where the
1834 * cursor is.
1835 */
1836 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001837 msg_puts_printf(str, maxlen);
1838 else
1839 msg_puts_display(str, maxlen, attr, FALSE);
1840}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001842/*
1843 * The display part of msg_puts_attr_len().
1844 * May be called recursively to display scroll-back text.
1845 */
1846 static void
1847msg_puts_display(str, maxlen, attr, recurse)
1848 char_u *str;
1849 int maxlen;
1850 int attr;
1851 int recurse;
1852{
1853 char_u *s = str;
1854 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1855 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1856#ifdef FEAT_MBYTE
1857 int l;
1858 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001860 char_u *sb_str = str;
1861 int sb_col = msg_col;
1862 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001863 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
1865 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001866 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 {
1868 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001869 * We are at the end of the screen line when:
1870 * - When outputting a newline.
1871 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001873 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874#ifdef FEAT_RIGHTLEFT
1875 cmdmsg_rl
1876 ? (
1877 msg_col <= 1
1878 || (*s == TAB && msg_col <= 7)
1879# ifdef FEAT_MBYTE
1880 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1881# endif
1882 )
1883 :
1884#endif
1885 (msg_col + t_col >= Columns - 1
1886 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1887# ifdef FEAT_MBYTE
1888 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1889 && msg_col + t_col >= Columns - 2)
1890# endif
1891 ))))
1892 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001893 /*
1894 * The screen is scrolled up when at the last row (some terminals
1895 * scroll automatically, some don't. To avoid problems we scroll
1896 * ourselves).
1897 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001900 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001902 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903 if (msg_no_more && lines_left == 0)
1904 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001906 /* Scroll the screen up one line. */
1907 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908
1909 msg_row = Rows - 2;
1910 if (msg_col >= Columns) /* can happen after screen resize */
1911 msg_col = Columns - 1;
1912
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001913 /* Display char in last column before showing more-prompt. */
1914 if (*s >= ' '
1915#ifdef FEAT_RIGHTLEFT
1916 && !cmdmsg_rl
1917#endif
1918 )
1919 {
1920#ifdef FEAT_MBYTE
1921 if (has_mbyte)
1922 {
1923 if (enc_utf8 && maxlen >= 0)
1924 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001925 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001926 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001927 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001928 s = screen_puts_mbyte(s, l, attr);
1929 }
1930 else
1931#endif
1932 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001933 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001934 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001935 else
1936 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001937
1938 if (p_more)
1939 /* store text for scrolling back */
1940 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1941
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001942 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001943 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 if (must_redraw < VALID)
1945 must_redraw = VALID;
1946 redraw_cmdline = TRUE;
1947 if (cmdline_row > 0 && !exmode_active)
1948 --cmdline_row;
1949
1950 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001951 * If screen is completely filled and 'more' is set then wait
1952 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001954 if (lines_left > 0)
1955 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001956 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 && !msg_no_more && !exmode_active)
1958 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001960 if (do_more_prompt(NUL))
1961 s = confirm_msg_tail;
1962#else
1963 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964#endif
1965 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001966 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001968
1969 /* When we displayed a char in last column need to check if there
1970 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001971 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001972 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 }
1974
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001975 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 || msg_col + t_col >= Columns
1977#ifdef FEAT_MBYTE
1978 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1979 && msg_col + t_col >= Columns - 1)
1980#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001981 ;
1982 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1983 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001985 t_puts(&t_col, t_s, s, attr);
1986
1987 if (wrap && p_more && !recurse)
1988 /* store text for scrolling back */
1989 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
1991 if (*s == '\n') /* go to next line */
1992 {
1993 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001994#ifdef FEAT_RIGHTLEFT
1995 if (cmdmsg_rl)
1996 msg_col = Columns - 1;
1997 else
1998#endif
1999 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 if (++msg_row >= Rows) /* safety check */
2001 msg_row = Rows - 1;
2002 }
2003 else if (*s == '\r') /* go to column 0 */
2004 {
2005 msg_col = 0;
2006 }
2007 else if (*s == '\b') /* go to previous char */
2008 {
2009 if (msg_col)
2010 --msg_col;
2011 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002012 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 {
2014 do
2015 msg_screen_putchar(' ', attr);
2016 while (msg_col & 7);
2017 }
2018 else if (*s == BELL) /* beep (from ":sh") */
2019 vim_beep();
2020 else
2021 {
2022#ifdef FEAT_MBYTE
2023 if (has_mbyte)
2024 {
2025 cw = (*mb_ptr2cells)(s);
2026 if (enc_utf8 && maxlen >= 0)
2027 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002028 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002030 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 }
2032 else
2033 {
2034 cw = 1;
2035 l = 1;
2036 }
2037#endif
2038 /* When drawing from right to left or when a double-wide character
2039 * doesn't fit, draw a single character here. Otherwise collect
2040 * characters and draw them all at once later. */
2041#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2042 if (
2043# ifdef FEAT_RIGHTLEFT
2044 cmdmsg_rl
2045# ifdef FEAT_MBYTE
2046 ||
2047# endif
2048# endif
2049# ifdef FEAT_MBYTE
2050 (cw > 1 && msg_col + t_col >= Columns - 1)
2051# endif
2052 )
2053 {
2054# ifdef FEAT_MBYTE
2055 if (l > 1)
2056 s = screen_puts_mbyte(s, l, attr) - 1;
2057 else
2058# endif
2059 msg_screen_putchar(*s, attr);
2060 }
2061 else
2062#endif
2063 {
2064 /* postpone this character until later */
2065 if (t_col == 0)
2066 t_s = s;
2067#ifdef FEAT_MBYTE
2068 t_col += cw;
2069 s += l - 1;
2070#else
2071 ++t_col;
2072#endif
2073 }
2074 }
2075 ++s;
2076 }
2077
2078 /* output any postponed text */
2079 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002080 t_puts(&t_col, t_s, s, attr);
2081 if (p_more && !recurse)
2082 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083
2084 msg_check();
2085}
2086
2087/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 * Scroll the screen up one line for displaying the next message line.
2089 */
2090 static void
2091msg_scroll_up()
2092{
2093#ifdef FEAT_GUI
2094 /* Remove the cursor before scrolling, ScreenLines[] is going
2095 * to become invalid. */
2096 if (gui.in_use)
2097 gui_undraw_cursor();
2098#endif
2099 /* scrolling up always works */
2100 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2101
2102 if (!can_clear((char_u *)" "))
2103 {
2104 /* Scrolling up doesn't result in the right background. Set the
2105 * background here. It's not efficient, but avoids that we have to do
2106 * it all over the code. */
2107 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2108
2109 /* Also clear the last char of the last but one line if it was not
2110 * cleared before to avoid a scroll-up. */
2111 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2112 screen_fill((int)Rows - 2, (int)Rows - 1,
2113 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2114 }
2115}
2116
2117/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002118 * Increment "msg_scrolled".
2119 */
2120 static void
2121inc_msg_scrolled()
2122{
2123#ifdef FEAT_EVAL
2124 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2125 {
2126 char_u *p = sourcing_name;
2127 char_u *tofree = NULL;
2128 int len;
2129
2130 /* v:scrollstart is empty, set it to the script/function name and line
2131 * number */
2132 if (p == NULL)
2133 p = (char_u *)_("Unknown");
2134 else
2135 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002136 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002137 tofree = alloc(len);
2138 if (tofree != NULL)
2139 {
2140 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2141 p, (long)sourcing_lnum);
2142 p = tofree;
2143 }
2144 }
2145 set_vim_var_string(VV_SCROLLSTART, p, -1);
2146 vim_free(tofree);
2147 }
2148#endif
2149 ++msg_scrolled;
2150}
2151
2152/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002153 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2154 * store the displayed text and remember where screen lines start.
2155 */
2156typedef struct msgchunk_S msgchunk_T;
2157struct msgchunk_S
2158{
2159 msgchunk_T *sb_next;
2160 msgchunk_T *sb_prev;
2161 char sb_eol; /* TRUE when line ends after this text */
2162 int sb_msg_col; /* column in which text starts */
2163 int sb_attr; /* text attributes */
2164 char_u sb_text[1]; /* text to be displayed, actually longer */
2165};
2166
2167static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2168
2169static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2170static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2171
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002172static int do_clear_sb_text = FALSE; /* clear text on next msg */
2173
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002174/*
2175 * Store part of a printed message for displaying when scrolling back.
2176 */
2177 static void
2178store_sb_text(sb_str, s, attr, sb_col, finish)
2179 char_u **sb_str; /* start of string */
2180 char_u *s; /* just after string */
2181 int attr;
2182 int *sb_col;
2183 int finish; /* line ends */
2184{
2185 msgchunk_T *mp;
2186
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002187 if (do_clear_sb_text)
2188 {
2189 clear_sb_text();
2190 do_clear_sb_text = FALSE;
2191 }
2192
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002193 if (s > *sb_str)
2194 {
2195 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2196 if (mp != NULL)
2197 {
2198 mp->sb_eol = finish;
2199 mp->sb_msg_col = *sb_col;
2200 mp->sb_attr = attr;
2201 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2202
2203 if (last_msgchunk == NULL)
2204 {
2205 last_msgchunk = mp;
2206 mp->sb_prev = NULL;
2207 }
2208 else
2209 {
2210 mp->sb_prev = last_msgchunk;
2211 last_msgchunk->sb_next = mp;
2212 last_msgchunk = mp;
2213 }
2214 mp->sb_next = NULL;
2215 }
2216 }
2217 else if (finish && last_msgchunk != NULL)
2218 last_msgchunk->sb_eol = TRUE;
2219
2220 *sb_str = s;
2221 *sb_col = 0;
2222}
2223
2224/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002225 * Finished showing messages, clear the scroll-back text on the next message.
2226 */
2227 void
2228may_clear_sb_text()
2229{
2230 do_clear_sb_text = TRUE;
2231}
2232
2233/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002234 * Clear any text remembered for scrolling back.
2235 * Called when redrawing the screen.
2236 */
2237 void
2238clear_sb_text()
2239{
2240 msgchunk_T *mp;
2241
2242 while (last_msgchunk != NULL)
2243 {
2244 mp = last_msgchunk->sb_prev;
2245 vim_free(last_msgchunk);
2246 last_msgchunk = mp;
2247 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002248}
2249
2250/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002251 * "g<" command.
2252 */
2253 void
2254show_sb_text()
2255{
2256 msgchunk_T *mp;
2257
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002258 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002259 * weird, typing a command without output results in one line. */
2260 mp = msg_sb_start(last_msgchunk);
2261 if (mp == NULL || mp->sb_prev == NULL)
2262 vim_beep();
2263 else
2264 {
2265 do_more_prompt('G');
2266 wait_return(FALSE);
2267 }
2268}
2269
2270/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002271 * Move to the start of screen line in already displayed text.
2272 */
2273 static msgchunk_T *
2274msg_sb_start(mps)
2275 msgchunk_T *mps;
2276{
2277 msgchunk_T *mp = mps;
2278
2279 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2280 mp = mp->sb_prev;
2281 return mp;
2282}
2283
2284/*
2285 * Display a screen line from previously displayed text at row "row".
2286 * Returns a pointer to the text for the next line (can be NULL).
2287 */
2288 static msgchunk_T *
2289disp_sb_line(row, smp)
2290 int row;
2291 msgchunk_T *smp;
2292{
2293 msgchunk_T *mp = smp;
2294 char_u *p;
2295
2296 for (;;)
2297 {
2298 msg_row = row;
2299 msg_col = mp->sb_msg_col;
2300 p = mp->sb_text;
2301 if (*p == '\n') /* don't display the line break */
2302 ++p;
2303 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2304 if (mp->sb_eol || mp->sb_next == NULL)
2305 break;
2306 mp = mp->sb_next;
2307 }
2308 return mp->sb_next;
2309}
2310
2311/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 * Output any postponed text for msg_puts_attr_len().
2313 */
2314 static void
2315t_puts(t_col, t_s, s, attr)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002316 int *t_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 char_u *t_s;
2318 char_u *s;
2319 int attr;
2320{
2321 /* output postponed text */
2322 msg_didout = TRUE; /* remember that line is not empty */
2323 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002324 msg_col += *t_col;
2325 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326#ifdef FEAT_MBYTE
2327 /* If the string starts with a composing character don't increment the
2328 * column position for it. */
2329 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2330 --msg_col;
2331#endif
2332 if (msg_col >= Columns)
2333 {
2334 msg_col = 0;
2335 ++msg_row;
2336 }
2337}
2338
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339/*
2340 * Returns TRUE when messages should be printed with mch_errmsg().
2341 * This is used when there is no valid screen, so we can see error messages.
2342 * If termcap is not active, we may be writing in an alternate console
2343 * window, cursor positioning may not work correctly (window size may be
2344 * different, e.g. for Win32 console) or we just don't know where the
2345 * cursor is.
2346 */
2347 int
2348msg_use_printf()
2349{
2350 return (!msg_check_screen()
2351#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2352 || !termcap_active
2353#endif
2354 || (swapping_screen() && !termcap_active)
2355 );
2356}
2357
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002358/*
2359 * Print a message when there is no valid screen.
2360 */
2361 static void
2362msg_puts_printf(str, maxlen)
2363 char_u *str;
2364 int maxlen;
2365{
2366 char_u *s = str;
2367 char_u buf[4];
2368 char_u *p;
2369
2370#ifdef WIN3264
2371 if (!(silent_mode && p_verbose == 0))
2372 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2373#endif
2374 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2375 {
2376 if (!(silent_mode && p_verbose == 0))
2377 {
2378 /* NL --> CR NL translation (for Unix, not for "--version") */
2379 /* NL --> CR translation (for Mac) */
2380 p = &buf[0];
2381 if (*s == '\n' && !info_message)
2382 *p++ = '\r';
2383#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2384 else
2385#endif
2386 *p++ = *s;
2387 *p = '\0';
2388 if (info_message) /* informative message, not an error */
2389 mch_msg((char *)buf);
2390 else
2391 mch_errmsg((char *)buf);
2392 }
2393
2394 /* primitive way to compute the current column */
2395#ifdef FEAT_RIGHTLEFT
2396 if (cmdmsg_rl)
2397 {
2398 if (*s == '\r' || *s == '\n')
2399 msg_col = Columns - 1;
2400 else
2401 --msg_col;
2402 }
2403 else
2404#endif
2405 {
2406 if (*s == '\r' || *s == '\n')
2407 msg_col = 0;
2408 else
2409 ++msg_col;
2410 }
2411 ++s;
2412 }
2413 msg_didout = TRUE; /* assume that line is not empty */
2414
2415#ifdef WIN3264
2416 if (!(silent_mode && p_verbose == 0))
2417 mch_settmode(TMODE_RAW);
2418#endif
2419}
2420
2421/*
2422 * Show the more-prompt and handle the user response.
2423 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002424 * When at hit-enter prompt "typed_char" is the already typed character,
2425 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002426 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2427 */
2428 static int
2429do_more_prompt(typed_char)
2430 int typed_char;
2431{
2432 int used_typed_char = typed_char;
2433 int oldState = State;
2434 int c;
2435#ifdef FEAT_CON_DIALOG
2436 int retval = FALSE;
2437#endif
2438 int scroll;
2439 msgchunk_T *mp_last = NULL;
2440 msgchunk_T *mp;
2441 int i;
2442
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002443 if (typed_char == 'G')
2444 {
2445 /* "g<": Find first line on the last page. */
2446 mp_last = msg_sb_start(last_msgchunk);
2447 for (i = 0; i < Rows - 2 && mp_last != NULL
2448 && mp_last->sb_prev != NULL; ++i)
2449 mp_last = msg_sb_start(mp_last->sb_prev);
2450 }
2451
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002452 State = ASKMORE;
2453#ifdef FEAT_MOUSE
2454 setmouse();
2455#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002456 if (typed_char == NUL)
2457 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002458 for (;;)
2459 {
2460 /*
2461 * Get a typed character directly from the user.
2462 */
2463 if (used_typed_char != NUL)
2464 {
2465 c = used_typed_char; /* was typed at hit-enter prompt */
2466 used_typed_char = NUL;
2467 }
2468 else
2469 c = get_keystroke();
2470
2471#if defined(FEAT_MENU) && defined(FEAT_GUI)
2472 if (c == K_MENU)
2473 {
2474 int idx = get_menu_index(current_menu, ASKMORE);
2475
2476 /* Used a menu. If it starts with CTRL-Y, it must
2477 * be a "Copy" for the clipboard. Otherwise
2478 * assume that we end */
2479 if (idx == MENU_INDEX_INVALID)
2480 continue;
2481 c = *current_menu->strings[idx];
2482 if (c != NUL && current_menu->strings[idx][1] != NUL)
2483 ins_typebuf(current_menu->strings[idx] + 1,
2484 current_menu->noremap[idx], 0, TRUE,
2485 current_menu->silent[idx]);
2486 }
2487#endif
2488
2489 scroll = 0;
2490 switch (c)
2491 {
2492 case BS: /* scroll one line back */
2493 case K_BS:
2494 case 'k':
2495 case K_UP:
2496 scroll = -1;
2497 break;
2498
2499 case CAR: /* one extra line */
2500 case NL:
2501 case 'j':
2502 case K_DOWN:
2503 scroll = 1;
2504 break;
2505
2506 case 'u': /* Up half a page */
2507 case K_PAGEUP:
2508 scroll = -(Rows / 2);
2509 break;
2510
2511 case 'd': /* Down half a page */
2512 scroll = Rows / 2;
2513 break;
2514
2515 case 'b': /* one page back */
2516 scroll = -(Rows - 1);
2517 break;
2518
2519 case ' ': /* one extra page */
2520 case K_PAGEDOWN:
2521 case K_LEFTMOUSE:
2522 scroll = Rows - 1;
2523 break;
2524
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002525 case 'g': /* all the way back to the start */
2526 scroll = -999999;
2527 break;
2528
2529 case 'G': /* all the way to the end */
2530 scroll = 999999;
2531 lines_left = 999999;
2532 break;
2533
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002534 case ':': /* start new command line */
2535#ifdef FEAT_CON_DIALOG
2536 if (!confirm_msg_used)
2537#endif
2538 {
2539 /* Since got_int is set all typeahead will be flushed, but we
2540 * want to keep this ':', remember that in a special way. */
2541 typeahead_noflush(':');
2542 cmdline_row = Rows - 1; /* put ':' on this line */
2543 skip_redraw = TRUE; /* skip redraw once */
2544 need_wait_return = FALSE; /* don't wait in main() */
2545 }
2546 /*FALLTHROUGH*/
2547 case 'q': /* quit */
2548 case Ctrl_C:
2549 case ESC:
2550#ifdef FEAT_CON_DIALOG
2551 if (confirm_msg_used)
2552 {
2553 /* Jump to the choices of the dialog. */
2554 retval = TRUE;
2555 lines_left = Rows - 1;
2556 }
2557 else
2558#endif
2559 {
2560 got_int = TRUE;
2561 quit_more = TRUE;
2562 }
2563 break;
2564
2565#ifdef FEAT_CLIPBOARD
2566 case Ctrl_Y:
2567 /* Strange way to allow copying (yanking) a modeless
2568 * selection at the more prompt. Use CTRL-Y,
2569 * because the same is used in Cmdline-mode and at the
2570 * hit-enter prompt. However, scrolling one line up
2571 * might be expected... */
2572 if (clip_star.state == SELECT_DONE)
2573 clip_copy_modeless_selection(TRUE);
2574 continue;
2575#endif
2576 default: /* no valid response */
2577 msg_moremsg(TRUE);
2578 continue;
2579 }
2580
2581 if (scroll != 0)
2582 {
2583 if (scroll < 0)
2584 {
2585 /* go to start of last line */
2586 if (mp_last == NULL)
2587 mp = msg_sb_start(last_msgchunk);
2588 else if (mp_last->sb_prev != NULL)
2589 mp = msg_sb_start(mp_last->sb_prev);
2590 else
2591 mp = NULL;
2592
2593 /* go to start of line at top of the screen */
2594 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2595 ++i)
2596 mp = msg_sb_start(mp->sb_prev);
2597
2598 if (mp != NULL && mp->sb_prev != NULL)
2599 {
2600 /* Find line to be displayed at top. */
2601 for (i = 0; i > scroll; --i)
2602 {
2603 if (mp == NULL || mp->sb_prev == NULL)
2604 break;
2605 mp = msg_sb_start(mp->sb_prev);
2606 if (mp_last == NULL)
2607 mp_last = msg_sb_start(last_msgchunk);
2608 else
2609 mp_last = msg_sb_start(mp_last->sb_prev);
2610 }
2611
2612 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2613 (int)Rows, NULL) == OK)
2614 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002615 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002616 (void)disp_sb_line(0, mp);
2617 }
2618 else
2619 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002620 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002621 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002622 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2623 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002624 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002625 ++msg_scrolled;
2626 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002627 }
2628 scroll = 0;
2629 }
2630 }
2631 else
2632 {
2633 /* First display any text that we scrolled back. */
2634 while (scroll > 0 && mp_last != NULL)
2635 {
2636 /* scroll up, display line at bottom */
2637 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002638 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2640 (int)Columns, ' ', ' ', 0);
2641 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2642 --scroll;
2643 }
2644 }
2645
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002646 if (scroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002647 {
2648 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002649 screen_fill((int)Rows - 1, (int)Rows, 0,
2650 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002651 msg_moremsg(FALSE);
2652 continue;
2653 }
2654
2655 /* display more text, return to caller */
2656 lines_left = scroll;
2657 }
2658
2659 break;
2660 }
2661
2662 /* clear the --more-- message */
2663 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2664 State = oldState;
2665#ifdef FEAT_MOUSE
2666 setmouse();
2667#endif
2668 if (quit_more)
2669 {
2670 msg_row = Rows - 1;
2671 msg_col = 0;
2672 }
2673#ifdef FEAT_RIGHTLEFT
2674 else if (cmdmsg_rl)
2675 msg_col = Columns - 1;
2676#endif
2677
2678#ifdef FEAT_CON_DIALOG
2679 return retval;
2680#else
2681 return FALSE;
2682#endif
2683}
2684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2686
2687#ifdef mch_errmsg
2688# undef mch_errmsg
2689#endif
2690#ifdef mch_msg
2691# undef mch_msg
2692#endif
2693
2694/*
2695 * Give an error message. To be used when the screen hasn't been initialized
2696 * yet. When stderr can't be used, collect error messages until the GUI has
2697 * started and they can be displayed in a message box.
2698 */
2699 void
2700mch_errmsg(str)
2701 char *str;
2702{
2703 int len;
2704
2705#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2706 /* On Unix use stderr if it's a tty.
2707 * When not going to start the GUI also use stderr.
2708 * On Mac, when started from Finder, stderr is the console. */
2709 if (
2710# ifdef UNIX
2711# ifdef MACOS_X_UNIX
2712 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2713# else
2714 isatty(2)
2715# endif
2716# ifdef FEAT_GUI
2717 ||
2718# endif
2719# endif
2720# ifdef FEAT_GUI
2721 !(gui.in_use || gui.starting)
2722# endif
2723 )
2724 {
2725 fprintf(stderr, "%s", str);
2726 return;
2727 }
2728#endif
2729
2730 /* avoid a delay for a message that isn't there */
2731 emsg_on_display = FALSE;
2732
2733 len = (int)STRLEN(str) + 1;
2734 if (error_ga.ga_growsize == 0)
2735 {
2736 error_ga.ga_growsize = 80;
2737 error_ga.ga_itemsize = 1;
2738 }
2739 if (ga_grow(&error_ga, len) == OK)
2740 {
2741 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2742 (char_u *)str, len);
2743#ifdef UNIX
2744 /* remove CR characters, they are displayed */
2745 {
2746 char_u *p;
2747
2748 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2749 for (;;)
2750 {
2751 p = vim_strchr(p, '\r');
2752 if (p == NULL)
2753 break;
2754 *p = ' ';
2755 }
2756 }
2757#endif
2758 --len; /* don't count the NUL at the end */
2759 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 }
2761}
2762
2763/*
2764 * Give a message. To be used when the screen hasn't been initialized yet.
2765 * When there is no tty, collect messages until the GUI has started and they
2766 * can be displayed in a message box.
2767 */
2768 void
2769mch_msg(str)
2770 char *str;
2771{
2772#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2773 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2774 * uses mch_errmsg() when started from the desktop.
2775 * When not going to start the GUI also use stdout.
2776 * On Mac, when started from Finder, stderr is the console. */
2777 if (
2778# ifdef UNIX
2779# ifdef MACOS_X_UNIX
2780 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2781# else
2782 isatty(2)
2783# endif
2784# ifdef FEAT_GUI
2785 ||
2786# endif
2787# endif
2788# ifdef FEAT_GUI
2789 !(gui.in_use || gui.starting)
2790# endif
2791 )
2792 {
2793 printf("%s", str);
2794 return;
2795 }
2796# endif
2797 mch_errmsg(str);
2798}
2799#endif /* USE_MCH_ERRMSG */
2800
2801/*
2802 * Put a character on the screen at the current message position and advance
2803 * to the next position. Only for printable ASCII!
2804 */
2805 static void
2806msg_screen_putchar(c, attr)
2807 int c;
2808 int attr;
2809{
2810 msg_didout = TRUE; /* remember that line is not empty */
2811 screen_putchar(c, msg_row, msg_col, attr);
2812#ifdef FEAT_RIGHTLEFT
2813 if (cmdmsg_rl)
2814 {
2815 if (--msg_col == 0)
2816 {
2817 msg_col = Columns;
2818 ++msg_row;
2819 }
2820 }
2821 else
2822#endif
2823 {
2824 if (++msg_col >= Columns)
2825 {
2826 msg_col = 0;
2827 ++msg_row;
2828 }
2829 }
2830}
2831
2832 void
2833msg_moremsg(full)
2834 int full;
2835{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002836 int attr;
2837 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838
2839 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002840 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002842 screen_puts((char_u *)
2843 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2844 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845}
2846
2847/*
2848 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2849 * exmode_active.
2850 */
2851 void
2852repeat_message()
2853{
2854 if (State == ASKMORE)
2855 {
2856 msg_moremsg(TRUE); /* display --more-- message again */
2857 msg_row = Rows - 1;
2858 }
2859#ifdef FEAT_CON_DIALOG
2860 else if (State == CONFIRM)
2861 {
2862 display_confirm_msg(); /* display ":confirm" message again */
2863 msg_row = Rows - 1;
2864 }
2865#endif
2866 else if (State == EXTERNCMD)
2867 {
2868 windgoto(msg_row, msg_col); /* put cursor back */
2869 }
2870 else if (State == HITRETURN || State == SETWSIZE)
2871 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002872 if (msg_row == Rows - 1)
2873 {
2874 /* Avoid drawing the "hit-enter" prompt below the previous one,
2875 * overwrite it. Esp. useful when regaining focus and a
2876 * FocusGained autocmd exists but didn't draw anything. */
2877 msg_didout = FALSE;
2878 msg_col = 0;
2879 msg_clr_eos();
2880 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 hit_return_msg();
2882 msg_row = Rows - 1;
2883 }
2884}
2885
2886/*
2887 * msg_check_screen - check if the screen is initialized.
2888 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2889 * While starting the GUI the terminal codes will be set for the GUI, but the
2890 * output goes to the terminal. Don't use the terminal codes then.
2891 */
2892 static int
2893msg_check_screen()
2894{
2895 if (!full_screen || !screen_valid(FALSE))
2896 return FALSE;
2897
2898 if (msg_row >= Rows)
2899 msg_row = Rows - 1;
2900 if (msg_col >= Columns)
2901 msg_col = Columns - 1;
2902 return TRUE;
2903}
2904
2905/*
2906 * Clear from current message position to end of screen.
2907 * Skip this when ":silent" was used, no need to clear for redirection.
2908 */
2909 void
2910msg_clr_eos()
2911{
2912 if (msg_silent == 0)
2913 msg_clr_eos_force();
2914}
2915
2916/*
2917 * Clear from current message position to end of screen.
2918 * Note: msg_col is not updated, so we remember the end of the message
2919 * for msg_check().
2920 */
2921 void
2922msg_clr_eos_force()
2923{
2924 if (msg_use_printf())
2925 {
2926 if (full_screen) /* only when termcap codes are valid */
2927 {
2928 if (*T_CD)
2929 out_str(T_CD); /* clear to end of display */
2930 else if (*T_CE)
2931 out_str(T_CE); /* clear to end of line */
2932 }
2933 }
2934 else
2935 {
2936#ifdef FEAT_RIGHTLEFT
2937 if (cmdmsg_rl)
2938 {
2939 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2940 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2941 }
2942 else
2943#endif
2944 {
2945 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2946 ' ', ' ', 0);
2947 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2948 }
2949 }
2950}
2951
2952/*
2953 * Clear the command line.
2954 */
2955 void
2956msg_clr_cmdline()
2957{
2958 msg_row = cmdline_row;
2959 msg_col = 0;
2960 msg_clr_eos_force();
2961}
2962
2963/*
2964 * end putting a message on the screen
2965 * call wait_return if the message does not fit in the available space
2966 * return TRUE if wait_return not called.
2967 */
2968 int
2969msg_end()
2970{
2971 /*
2972 * if the string is larger than the window,
2973 * or the ruler option is set and we run into it,
2974 * we have to redraw the window.
2975 * Do not do this if we are abandoning the file or editing the command line.
2976 */
2977 if (!exiting && need_wait_return && !(State & CMDLINE))
2978 {
2979 wait_return(FALSE);
2980 return FALSE;
2981 }
2982 out_flush();
2983 return TRUE;
2984}
2985
2986/*
2987 * If the written message runs into the shown command or ruler, we have to
2988 * wait for hit-return and redraw the window later.
2989 */
2990 void
2991msg_check()
2992{
2993 if (msg_row == Rows - 1 && msg_col >= sc_col)
2994 {
2995 need_wait_return = TRUE;
2996 redraw_cmdline = TRUE;
2997 }
2998}
2999
3000/*
3001 * May write a string to the redirection file.
3002 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3003 */
3004 static void
3005redir_write(str, maxlen)
3006 char_u *str;
3007 int maxlen;
3008{
3009 char_u *s = str;
3010 static int cur_col = 0;
3011
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003012 /* Don't do anything for displaying prompts and the like. */
3013 if (redir_off)
3014 return;
3015
3016 /*
3017 * If 'verbosefile' is set write message in that file.
3018 * Must come before the rest because of updating "msg_col".
3019 */
3020 if (*p_vfile != NUL)
3021 verbose_write(s, maxlen);
3022
3023 if (redir_fd != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024#ifdef FEAT_EVAL
Bram Moolenaardf177f62005-02-22 08:39:57 +00003025 || redir_reg || redir_vname
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026#endif
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003027 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 {
3029 /* If the string doesn't start with CR or NL, go to msg_col */
3030 if (*s != '\n' && *s != '\r')
3031 {
3032 while (cur_col < msg_col)
3033 {
3034#ifdef FEAT_EVAL
3035 if (redir_reg)
3036 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003037 else if (redir_vname)
3038 var_redir_str((char_u *)" ", -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 else if (redir_fd)
3040#endif
3041 fputs(" ", redir_fd);
3042 ++cur_col;
3043 }
3044 }
3045
3046#ifdef FEAT_EVAL
3047 if (redir_reg)
3048 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003049 if (redir_vname)
3050 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051#endif
3052
3053 /* Adjust the current column */
3054 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3055 {
3056#ifdef FEAT_EVAL
Bram Moolenaardf177f62005-02-22 08:39:57 +00003057 if (!redir_reg && !redir_vname && redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058#endif
3059 putc(*s, redir_fd);
3060 if (*s == '\r' || *s == '\n')
3061 cur_col = 0;
3062 else if (*s == '\t')
3063 cur_col += (8 - cur_col % 8);
3064 else
3065 ++cur_col;
3066 ++s;
3067 }
3068
3069 if (msg_silent != 0) /* should update msg_col */
3070 msg_col = cur_col;
3071 }
3072}
3073
3074/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003075 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003076 * Must always be called paired with verbose_leave()!
3077 */
3078 void
3079verbose_enter()
3080{
3081 if (*p_vfile != NUL)
3082 ++msg_silent;
3083}
3084
3085/*
3086 * After giving verbose message.
3087 * Must always be called paired with verbose_enter()!
3088 */
3089 void
3090verbose_leave()
3091{
3092 if (*p_vfile != NUL)
3093 if (--msg_silent < 0)
3094 msg_silent = 0;
3095}
3096
3097/*
3098 * Like verbose_enter() and set msg_scroll when displaying the message.
3099 */
3100 void
3101verbose_enter_scroll()
3102{
3103 if (*p_vfile != NUL)
3104 ++msg_silent;
3105 else
3106 /* always scroll up, don't overwrite */
3107 msg_scroll = TRUE;
3108}
3109
3110/*
3111 * Like verbose_leave() and set cmdline_row when displaying the message.
3112 */
3113 void
3114verbose_leave_scroll()
3115{
3116 if (*p_vfile != NUL)
3117 {
3118 if (--msg_silent < 0)
3119 msg_silent = 0;
3120 }
3121 else
3122 cmdline_row = msg_row;
3123}
3124
3125static FILE *verbose_fd = NULL;
3126static int verbose_did_open = FALSE;
3127
3128/*
3129 * Called when 'verbosefile' is set: stop writing to the file.
3130 */
3131 void
3132verbose_stop()
3133{
3134 if (verbose_fd != NULL)
3135 {
3136 fclose(verbose_fd);
3137 verbose_fd = NULL;
3138 }
3139 verbose_did_open = FALSE;
3140}
3141
3142/*
3143 * Open the file 'verbosefile'.
3144 * Return FAIL or OK.
3145 */
3146 int
3147verbose_open()
3148{
3149 if (verbose_fd == NULL && !verbose_did_open)
3150 {
3151 /* Only give the error message once. */
3152 verbose_did_open = TRUE;
3153
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003154 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003155 if (verbose_fd == NULL)
3156 {
3157 EMSG2(_(e_notopen), p_vfile);
3158 return FAIL;
3159 }
3160 }
3161 return OK;
3162}
3163
3164/*
3165 * Write a string to 'verbosefile'.
3166 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3167 */
3168 static void
3169verbose_write(str, maxlen)
3170 char_u *str;
3171 int maxlen;
3172{
3173 char_u *s = str;
3174 static int cur_col = 0;
3175
3176 /* Open the file when called the first time. */
3177 if (verbose_fd == NULL)
3178 verbose_open();
3179
3180 if (verbose_fd != NULL)
3181 {
3182 /* If the string doesn't start with CR or NL, go to msg_col */
3183 if (*s != '\n' && *s != '\r')
3184 {
3185 while (cur_col < msg_col)
3186 {
3187 fputs(" ", verbose_fd);
3188 ++cur_col;
3189 }
3190 }
3191
3192 /* Adjust the current column */
3193 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3194 {
3195 putc(*s, verbose_fd);
3196 if (*s == '\r' || *s == '\n')
3197 cur_col = 0;
3198 else if (*s == '\t')
3199 cur_col += (8 - cur_col % 8);
3200 else
3201 ++cur_col;
3202 ++s;
3203 }
3204 }
3205}
3206
3207/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 * Give a warning message (for searching).
3209 * Use 'w' highlighting and may repeat the message after redrawing
3210 */
3211 void
3212give_warning(message, hl)
3213 char_u *message;
3214 int hl;
3215{
3216 /* Don't do this for ":silent". */
3217 if (msg_silent != 0)
3218 return;
3219
3220 /* Don't want a hit-enter prompt here. */
3221 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223#ifdef FEAT_EVAL
3224 set_vim_var_string(VV_WARNINGMSG, message, -1);
3225#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 vim_free(keep_msg);
3227 keep_msg = NULL;
3228 if (hl)
3229 keep_msg_attr = hl_attr(HLF_W);
3230 else
3231 keep_msg_attr = 0;
3232 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003233 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 msg_didout = FALSE; /* overwrite this message */
3235 msg_nowait = TRUE; /* don't wait for this message */
3236 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 --no_wait_return;
3239}
3240
3241/*
3242 * Advance msg cursor to column "col".
3243 */
3244 void
3245msg_advance(col)
3246 int col;
3247{
3248 if (msg_silent != 0) /* nothing to advance to */
3249 {
3250 msg_col = col; /* for redirection, may fill it up later */
3251 return;
3252 }
3253 if (col >= Columns) /* not enough room */
3254 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003255#ifdef FEAT_RIGHTLEFT
3256 if (cmdmsg_rl)
3257 while (msg_col > Columns - col)
3258 msg_putchar(' ');
3259 else
3260#endif
3261 while (msg_col < col)
3262 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263}
3264
3265#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3266/*
3267 * Used for "confirm()" function, and the :confirm command prefix.
3268 * Versions which haven't got flexible dialogs yet, and console
3269 * versions, get this generic handler which uses the command line.
3270 *
3271 * type = one of:
3272 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3273 * title = title string (can be NULL for default)
3274 * (neither used in console dialogs at the moment)
3275 *
3276 * Format of the "buttons" string:
3277 * "Button1Name\nButton2Name\nButton3Name"
3278 * The first button should normally be the default/accept
3279 * The second button should be the 'Cancel' button
3280 * Other buttons- use your imagination!
3281 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3282 * different letter.
3283 */
3284/* ARGSUSED */
3285 int
3286do_dialog(type, title, message, buttons, dfltbutton, textfield)
3287 int type;
3288 char_u *title;
3289 char_u *message;
3290 char_u *buttons;
3291 int dfltbutton;
3292 char_u *textfield; /* IObuff for inputdialog(), NULL otherwise */
3293{
3294 int oldState;
3295 int retval = 0;
3296 char_u *hotkeys;
3297 int c;
3298 int i;
3299
3300#ifndef NO_CONSOLE
3301 /* Don't output anything in silent mode ("ex -s") */
3302 if (silent_mode)
3303 return dfltbutton; /* return default option */
3304#endif
3305
3306#ifdef FEAT_GUI_DIALOG
3307 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3308 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3309 {
3310 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3311 textfield);
3312 msg_end_prompt();
3313
3314 /* Flush output to avoid that further messages and redrawing is done
3315 * in the wrong order. */
3316 out_flush();
3317 gui_mch_update();
3318
3319 return c;
3320 }
3321#endif
3322
3323 oldState = State;
3324 State = CONFIRM;
3325#ifdef FEAT_MOUSE
3326 setmouse();
3327#endif
3328
3329 /*
3330 * Since we wait for a keypress, don't make the
3331 * user press RETURN as well afterwards.
3332 */
3333 ++no_wait_return;
3334 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3335
3336 if (hotkeys != NULL)
3337 {
3338 for (;;)
3339 {
3340 /* Get a typed character directly from the user. */
3341 c = get_keystroke();
3342 switch (c)
3343 {
3344 case CAR: /* User accepts default option */
3345 case NL:
3346 retval = dfltbutton;
3347 break;
3348 case Ctrl_C: /* User aborts/cancels */
3349 case ESC:
3350 retval = 0;
3351 break;
3352 default: /* Could be a hotkey? */
3353 if (c < 0) /* special keys are ignored here */
3354 continue;
3355 /* Make the character lowercase, as chars in "hotkeys" are. */
3356 c = MB_TOLOWER(c);
3357 retval = 1;
3358 for (i = 0; hotkeys[i]; ++i)
3359 {
3360#ifdef FEAT_MBYTE
3361 if (has_mbyte)
3362 {
3363 if ((*mb_ptr2char)(hotkeys + i) == c)
3364 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003365 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 }
3367 else
3368#endif
3369 if (hotkeys[i] == c)
3370 break;
3371 ++retval;
3372 }
3373 if (hotkeys[i])
3374 break;
3375 /* No hotkey match, so keep waiting */
3376 continue;
3377 }
3378 break;
3379 }
3380
3381 vim_free(hotkeys);
3382 }
3383
3384 State = oldState;
3385#ifdef FEAT_MOUSE
3386 setmouse();
3387#endif
3388 --no_wait_return;
3389 msg_end_prompt();
3390
3391 return retval;
3392}
3393
3394static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3395
3396/*
3397 * Copy one character from "*from" to "*to", taking care of multi-byte
3398 * characters. Return the length of the character in bytes.
3399 */
3400 static int
3401copy_char(from, to, lowercase)
3402 char_u *from;
3403 char_u *to;
3404 int lowercase; /* make character lower case */
3405{
3406#ifdef FEAT_MBYTE
3407 int len;
3408 int c;
3409
3410 if (has_mbyte)
3411 {
3412 if (lowercase)
3413 {
3414 c = MB_TOLOWER((*mb_ptr2char)(from));
3415 return (*mb_char2bytes)(c, to);
3416 }
3417 else
3418 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003419 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 mch_memmove(to, from, (size_t)len);
3421 return len;
3422 }
3423 }
3424 else
3425#endif
3426 {
3427 if (lowercase)
3428 *to = (char_u)TOLOWER_LOC(*from);
3429 else
3430 *to = *from;
3431 return 1;
3432 }
3433}
3434
3435/*
3436 * Format the dialog string, and display it at the bottom of
3437 * the screen. Return a string of hotkey chars (if defined) for
3438 * each 'button'. If a button has no hotkey defined, the first character of
3439 * the button is used.
3440 * The hotkeys can be multi-byte characters, but without combining chars.
3441 *
3442 * Returns an allocated string with hotkeys, or NULL for error.
3443 */
3444 static char_u *
3445msg_show_console_dialog(message, buttons, dfltbutton)
3446 char_u *message;
3447 char_u *buttons;
3448 int dfltbutton;
3449{
3450 int len = 0;
3451#ifdef FEAT_MBYTE
3452# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3453#else
3454# define HOTK_LEN 1
3455#endif
3456 int lenhotkey = HOTK_LEN; /* count first button */
3457 char_u *hotk = NULL;
3458 char_u *msgp = NULL;
3459 char_u *hotkp = NULL;
3460 char_u *r;
3461 int copy;
3462#define HAS_HOTKEY_LEN 30
3463 char_u has_hotkey[HAS_HOTKEY_LEN];
3464 int first_hotkey = FALSE; /* first char of button is hotkey */
3465 int idx;
3466
3467 has_hotkey[0] = FALSE;
3468
3469 /*
3470 * First loop: compute the size of memory to allocate.
3471 * Second loop: copy to the allocated memory.
3472 */
3473 for (copy = 0; copy <= 1; ++copy)
3474 {
3475 r = buttons;
3476 idx = 0;
3477 while (*r)
3478 {
3479 if (*r == DLG_BUTTON_SEP)
3480 {
3481 if (copy)
3482 {
3483 *msgp++ = ',';
3484 *msgp++ = ' '; /* '\n' -> ', ' */
3485
3486 /* advance to next hotkey and set default hotkey */
3487#ifdef FEAT_MBYTE
3488 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003489 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 else
3491#endif
3492 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003493 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 if (dfltbutton)
3495 --dfltbutton;
3496
3497 /* If no hotkey is specified first char is used. */
3498 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3499 first_hotkey = TRUE;
3500 }
3501 else
3502 {
3503 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3504 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3505 if (idx < HAS_HOTKEY_LEN - 1)
3506 has_hotkey[++idx] = FALSE;
3507 }
3508 }
3509 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3510 {
3511 if (*r == DLG_HOTKEY_CHAR)
3512 ++r;
3513 first_hotkey = FALSE;
3514 if (copy)
3515 {
3516 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3517 *msgp++ = *r;
3518 else
3519 {
3520 /* '&a' -> '[a]' */
3521 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3522 msgp += copy_char(r, msgp, FALSE);
3523 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3524
3525 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003526 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 }
3528 }
3529 else
3530 {
3531 ++len; /* '&a' -> '[a]' */
3532 if (idx < HAS_HOTKEY_LEN - 1)
3533 has_hotkey[idx] = TRUE;
3534 }
3535 }
3536 else
3537 {
3538 /* everything else copy literally */
3539 if (copy)
3540 msgp += copy_char(r, msgp, FALSE);
3541 }
3542
3543 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003544 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 }
3546
3547 if (copy)
3548 {
3549 *msgp++ = ':';
3550 *msgp++ = ' ';
3551 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 }
3553 else
3554 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003555 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003556 + 2 /* for the NL's */
3557 + STRLEN(buttons)
3558 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003559 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 /* If no hotkey is specified first char is used. */
3562 if (!has_hotkey[0])
3563 {
3564 first_hotkey = TRUE;
3565 len += 2; /* "x" -> "[x]" */
3566 }
3567
3568 /*
3569 * Now allocate and load the strings
3570 */
3571 vim_free(confirm_msg);
3572 confirm_msg = alloc(len);
3573 if (confirm_msg == NULL)
3574 return NULL;
3575 *confirm_msg = NUL;
3576 hotk = alloc(lenhotkey);
3577 if (hotk == NULL)
3578 return NULL;
3579
3580 *confirm_msg = '\n';
3581 STRCPY(confirm_msg + 1, message);
3582
3583 msgp = confirm_msg + 1 + STRLEN(message);
3584 hotkp = hotk;
3585
Bram Moolenaar6a516062007-07-05 08:11:42 +00003586 /* Define first default hotkey. Keep the hotkey string NUL
3587 * terminated to avoid reading past the end. */
3588 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589
3590 /* Remember where the choices start, displaying starts here when
3591 * "hotkp" typed at the more prompt. */
3592 confirm_msg_tail = msgp;
3593 *msgp++ = '\n';
3594 }
3595 }
3596
3597 display_confirm_msg();
3598 return hotk;
3599}
3600
3601/*
3602 * Display the ":confirm" message. Also called when screen resized.
3603 */
3604 void
3605display_confirm_msg()
3606{
3607 /* avoid that 'q' at the more prompt truncates the message here */
3608 ++confirm_msg_used;
3609 if (confirm_msg != NULL)
3610 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3611 --confirm_msg_used;
3612}
3613
3614#endif /* FEAT_CON_DIALOG */
3615
3616#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3617
3618 int
3619vim_dialog_yesno(type, title, message, dflt)
3620 int type;
3621 char_u *title;
3622 char_u *message;
3623 int dflt;
3624{
3625 if (do_dialog(type,
3626 title == NULL ? (char_u *)_("Question") : title,
3627 message,
3628 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3629 return VIM_YES;
3630 return VIM_NO;
3631}
3632
3633 int
3634vim_dialog_yesnocancel(type, title, message, dflt)
3635 int type;
3636 char_u *title;
3637 char_u *message;
3638 int dflt;
3639{
3640 switch (do_dialog(type,
3641 title == NULL ? (char_u *)_("Question") : title,
3642 message,
3643 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3644 {
3645 case 1: return VIM_YES;
3646 case 2: return VIM_NO;
3647 }
3648 return VIM_CANCEL;
3649}
3650
3651 int
3652vim_dialog_yesnoallcancel(type, title, message, dflt)
3653 int type;
3654 char_u *title;
3655 char_u *message;
3656 int dflt;
3657{
3658 switch (do_dialog(type,
3659 title == NULL ? (char_u *)"Question" : title,
3660 message,
3661 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3662 dflt, NULL))
3663 {
3664 case 1: return VIM_YES;
3665 case 2: return VIM_NO;
3666 case 3: return VIM_ALL;
3667 case 4: return VIM_DISCARDALL;
3668 }
3669 return VIM_CANCEL;
3670}
3671
3672#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3673
3674#if defined(FEAT_BROWSE) || defined(PROTO)
3675/*
3676 * Generic browse function. Calls gui_mch_browse() when possible.
3677 * Later this may pop-up a non-GUI file selector (external command?).
3678 */
3679 char_u *
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003680do_browse(flags, title, dflt, ext, initdir, filter, buf)
3681 int flags; /* BROWSE_SAVE and BROWSE_DIR */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 char_u *title; /* title for the window */
3683 char_u *dflt; /* default file name (may include directory) */
3684 char_u *ext; /* extension added */
3685 char_u *initdir; /* initial directory, NULL for current dir or
3686 when using path from "dflt" */
3687 char_u *filter; /* file name filter */
3688 buf_T *buf; /* buffer to read/write for */
3689{
3690 char_u *fname;
3691 static char_u *last_dir = NULL; /* last used directory */
3692 char_u *tofree = NULL;
3693 int save_browse = cmdmod.browse;
3694
3695 /* Must turn off browse to avoid that autocommands will get the
3696 * flag too! */
3697 cmdmod.browse = FALSE;
3698
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003699 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003701 if (flags & BROWSE_DIR)
3702 title = (char_u *)_("Select Directory dialog");
3703 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 title = (char_u *)_("Save File dialog");
3705 else
3706 title = (char_u *)_("Open File dialog");
3707 }
3708
3709 /* When no directory specified, use default file name, default dir, buffer
3710 * dir, last dir or current dir */
3711 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3712 {
3713 if (mch_isdir(dflt)) /* default file name is a directory */
3714 {
3715 initdir = dflt;
3716 dflt = NULL;
3717 }
3718 else if (gettail(dflt) != dflt) /* default file name includes a path */
3719 {
3720 tofree = vim_strsave(dflt);
3721 if (tofree != NULL)
3722 {
3723 initdir = tofree;
3724 *gettail(initdir) = NUL;
3725 dflt = gettail(dflt);
3726 }
3727 }
3728 }
3729
3730 if (initdir == NULL || *initdir == NUL)
3731 {
3732 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003733 if (STRCMP(p_bsdir, "last") != 0
3734 && STRCMP(p_bsdir, "buffer") != 0
3735 && STRCMP(p_bsdir, "current") != 0
3736 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 initdir = p_bsdir;
3738 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003739 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 && buf != NULL && buf->b_ffname != NULL)
3741 {
3742 if (dflt == NULL || *dflt == NUL)
3743 dflt = gettail(curbuf->b_ffname);
3744 tofree = vim_strsave(curbuf->b_ffname);
3745 if (tofree != NULL)
3746 {
3747 initdir = tofree;
3748 *gettail(initdir) = NUL;
3749 }
3750 }
3751 /* When 'browsedir' is "last", use dir from last browse */
3752 else if (*p_bsdir == 'l')
3753 initdir = last_dir;
3754 /* When 'browsedir is "current", use current directory. This is the
3755 * default already, leave initdir empty. */
3756 }
3757
3758# ifdef FEAT_GUI
3759 if (gui.in_use) /* when this changes, also adjust f_has()! */
3760 {
3761 if (filter == NULL
3762# ifdef FEAT_EVAL
3763 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3764 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3765# endif
3766 )
3767 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003768 if (flags & BROWSE_DIR)
3769 {
3770# if defined(HAVE_GTK2) || defined(WIN3264)
3771 /* For systems that have a directory dialog. */
3772 fname = gui_mch_browsedir(title, initdir);
3773# else
3774 /* Generic solution for selecting a directory: select a file and
3775 * remove the file name. */
3776 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3777# endif
3778# if !defined(HAVE_GTK2)
3779 /* Win32 adds a dummy file name, others return an arbitrary file
3780 * name. GTK+ 2 returns only the directory, */
3781 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3782 {
3783 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003784 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003785
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003786 if (tail == fname)
3787 *tail++ = '.'; /* use current dir */
3788 *tail = NUL;
3789 }
3790# endif
3791 }
3792 else
3793 fname = gui_mch_browse(flags & BROWSE_SAVE,
3794 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795
3796 /* We hang around in the dialog for a while, the user might do some
3797 * things to our files. The Win32 dialog allows deleting or renaming
3798 * a file, check timestamps. */
3799 need_check_timestamps = TRUE;
3800 did_check_timestamps = FALSE;
3801 }
3802 else
3803# endif
3804 {
3805 /* TODO: non-GUI file selector here */
3806 EMSG(_("E338: Sorry, no file browser in console mode"));
3807 fname = NULL;
3808 }
3809
3810 /* keep the directory for next time */
3811 if (fname != NULL)
3812 {
3813 vim_free(last_dir);
3814 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003815 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {
3817 *gettail(last_dir) = NUL;
3818 if (*last_dir == NUL)
3819 {
3820 /* filename only returned, must be in current dir */
3821 vim_free(last_dir);
3822 last_dir = alloc(MAXPATHL);
3823 if (last_dir != NULL)
3824 mch_dirname(last_dir, MAXPATHL);
3825 }
3826 }
3827 }
3828
3829 vim_free(tofree);
3830 cmdmod.browse = save_browse;
3831
3832 return fname;
3833}
3834#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003835
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003836#if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3837static char *e_printf = N_("E766: Insufficient arguments for printf()");
3838
3839static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3840static char *tv_str __ARGS((typval_T *tvs, int *idxp));
Bram Moolenaara7241f52008-06-24 20:39:31 +00003841# ifdef FEAT_FLOAT
3842static double tv_float __ARGS((typval_T *tvs, int *idxp));
3843# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003844
3845/*
3846 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3847 */
3848 static long
3849tv_nr(tvs, idxp)
3850 typval_T *tvs;
3851 int *idxp;
3852{
3853 int idx = *idxp - 1;
3854 long n = 0;
3855 int err = FALSE;
3856
3857 if (tvs[idx].v_type == VAR_UNKNOWN)
3858 EMSG(_(e_printf));
3859 else
3860 {
3861 ++*idxp;
3862 n = get_tv_number_chk(&tvs[idx], &err);
3863 if (err)
3864 n = 0;
3865 }
3866 return n;
3867}
3868
3869/*
3870 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003871 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003872 */
3873 static char *
3874tv_str(tvs, idxp)
3875 typval_T *tvs;
3876 int *idxp;
3877{
3878 int idx = *idxp - 1;
3879 char *s = NULL;
3880
3881 if (tvs[idx].v_type == VAR_UNKNOWN)
3882 EMSG(_(e_printf));
3883 else
3884 {
3885 ++*idxp;
3886 s = (char *)get_tv_string_chk(&tvs[idx]);
3887 }
3888 return s;
3889}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003890
3891# ifdef FEAT_FLOAT
3892/*
3893 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3894 */
3895 static double
3896tv_float(tvs, idxp)
3897 typval_T *tvs;
3898 int *idxp;
3899{
3900 int idx = *idxp - 1;
3901 double f = 0;
3902
3903 if (tvs[idx].v_type == VAR_UNKNOWN)
3904 EMSG(_(e_printf));
3905 else
3906 {
3907 ++*idxp;
3908 if (tvs[idx].v_type == VAR_FLOAT)
3909 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003910 else if (tvs[idx].v_type == VAR_NUMBER)
3911 f = tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003912 else
3913 EMSG(_("E807: Expected Float argument for printf()"));
3914 }
3915 return f;
3916}
3917# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003918#endif
3919
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003920/*
3921 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003922 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003923 * consistency.
3924 *
3925 * This code is based on snprintf.c - a portable implementation of snprintf
3926 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003927 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003928 * The original code, including useful comments, can be found here:
3929 * http://www.ijs.si/software/snprintf/
3930 *
3931 * This snprintf() only supports the following conversion specifiers:
3932 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3933 * with flags: '-', '+', ' ', '0' and '#'.
3934 * An asterisk is supported for field width as well as precision.
3935 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00003936 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3937 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003938 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3939 * 'll' (long long int) is not supported.
3940 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003941 * The locale is not used, the string is used as a byte string. This is only
3942 * relevant for double-byte encodings where the second byte may be '%'.
3943 *
Bram Moolenaara2031822006-03-07 22:29:51 +00003944 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3945 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003946 *
3947 * The return value is the number of characters which would be generated
3948 * for the given input, excluding the trailing null. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00003949 * is greater or equal to "str_m", not all characters from the result
3950 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3951 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003952 * the resulting string will be null-terminated.
3953 */
3954
3955/*
3956 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003957 *
3958 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003959 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003960 */
3961
3962/* When generating prototypes all of this is skipped, cproto doesn't
3963 * understand this. */
3964#ifndef PROTO
3965# ifdef HAVE_STDARG_H
3966 int
3967vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3968{
3969 va_list ap;
3970 int str_l;
3971
3972 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003973 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003974 va_end(ap);
3975 return str_l;
3976}
3977
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003978 int
3979vim_vsnprintf(str, str_m, fmt, ap, tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003980# else
3981 /* clumsy way to work around missing va_list */
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003982# 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)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003983
3984/* VARARGS */
3985 int
3986#ifdef __BORLANDC__
3987_RTLENTRYF
3988#endif
3989vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
3990# endif
3991 char *str;
3992 size_t str_m;
3993 char *fmt;
3994# ifdef HAVE_STDARG_H
3995 va_list ap;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003996 typval_T *tvs;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003997# else
3998 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
3999# endif
4000{
4001 size_t str_l = 0;
4002 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004003 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004004
4005 if (p == NULL)
4006 p = "";
4007 while (*p != NUL)
4008 {
4009 if (*p != '%')
4010 {
4011 char *q = strchr(p + 1, '%');
4012 size_t n = (q == NULL) ? STRLEN(p) : (q - p);
4013
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004014 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004015 if (str_l < str_m)
4016 {
4017 size_t avail = str_m - str_l;
4018
4019 mch_memmove(str + str_l, p, n > avail ? avail : n);
4020 }
4021 p += n;
4022 str_l += n;
4023 }
4024 else
4025 {
4026 size_t min_field_width = 0, precision = 0;
4027 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4028 int alternate_form = 0, force_sign = 0;
4029
4030 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4031 * ignored. */
4032 int space_for_positive = 1;
4033
4034 /* allowed values: \0, h, l, L */
4035 char length_modifier = '\0';
4036
4037 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004038#ifdef FEAT_FLOAT
4039# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
4040 * That sounds reasonable to use as the maximum
4041 * printable. */
4042#else
4043# define TMP_LEN 32
4044#endif
4045 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004046
4047 /* string address in case of string argument */
4048 char *str_arg;
4049
4050 /* natural field width of arg without padding and sign */
4051 size_t str_arg_l;
4052
4053 /* unsigned char argument value - only defined for c conversion.
4054 * N.B. standard explicitly states the char argument for the c
4055 * conversion is unsigned */
4056 unsigned char uchar_arg;
4057
4058 /* number of zeros to be inserted for numeric conversions as
4059 * required by the precision or minimal field width */
4060 size_t number_of_zeros_to_pad = 0;
4061
4062 /* index into tmp where zero padding is to be inserted */
4063 size_t zero_padding_insertion_ind = 0;
4064
4065 /* current conversion specifier character */
4066 char fmt_spec = '\0';
4067
4068 str_arg = NULL;
4069 p++; /* skip '%' */
4070
4071 /* parse flags */
4072 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4073 || *p == '#' || *p == '\'')
4074 {
4075 switch (*p)
4076 {
4077 case '0': zero_padding = 1; break;
4078 case '-': justify_left = 1; break;
4079 case '+': force_sign = 1; space_for_positive = 0; break;
4080 case ' ': force_sign = 1;
4081 /* If both the ' ' and '+' flags appear, the ' '
4082 * flag should be ignored */
4083 break;
4084 case '#': alternate_form = 1; break;
4085 case '\'': break;
4086 }
4087 p++;
4088 }
4089 /* If the '0' and '-' flags both appear, the '0' flag should be
4090 * ignored. */
4091
4092 /* parse field width */
4093 if (*p == '*')
4094 {
4095 int j;
4096
4097 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004098 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004099#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004100 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004101#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004102# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004103 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004104# endif
4105 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004106#endif
4107 if (j >= 0)
4108 min_field_width = j;
4109 else
4110 {
4111 min_field_width = -j;
4112 justify_left = 1;
4113 }
4114 }
4115 else if (VIM_ISDIGIT((int)(*p)))
4116 {
4117 /* size_t could be wider than unsigned int; make sure we treat
4118 * argument like common implementations do */
4119 unsigned int uj = *p++ - '0';
4120
4121 while (VIM_ISDIGIT((int)(*p)))
4122 uj = 10 * uj + (unsigned int)(*p++ - '0');
4123 min_field_width = uj;
4124 }
4125
4126 /* parse precision */
4127 if (*p == '.')
4128 {
4129 p++;
4130 precision_specified = 1;
4131 if (*p == '*')
4132 {
4133 int j;
4134
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004135 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004136#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004137 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004138#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004139# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004140 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004141# endif
4142 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004143#endif
4144 p++;
4145 if (j >= 0)
4146 precision = j;
4147 else
4148 {
4149 precision_specified = 0;
4150 precision = 0;
4151 }
4152 }
4153 else if (VIM_ISDIGIT((int)(*p)))
4154 {
4155 /* size_t could be wider than unsigned int; make sure we
4156 * treat argument like common implementations do */
4157 unsigned int uj = *p++ - '0';
4158
4159 while (VIM_ISDIGIT((int)(*p)))
4160 uj = 10 * uj + (unsigned int)(*p++ - '0');
4161 precision = uj;
4162 }
4163 }
4164
4165 /* parse 'h', 'l' and 'll' length modifiers */
4166 if (*p == 'h' || *p == 'l')
4167 {
4168 length_modifier = *p;
4169 p++;
4170 if (length_modifier == 'l' && *p == 'l')
4171 {
4172 /* double l = long long */
4173 length_modifier = 'l'; /* treat it as a single 'l' */
4174 p++;
4175 }
4176 }
4177 fmt_spec = *p;
4178
4179 /* common synonyms: */
4180 switch (fmt_spec)
4181 {
4182 case 'i': fmt_spec = 'd'; break;
4183 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4184 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4185 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004186 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004187 default: break;
4188 }
4189
4190 /* get parameter value, do initial processing */
4191 switch (fmt_spec)
4192 {
4193 /* '%' and 'c' behave similar to 's' regarding flags and field
4194 * widths */
4195 case '%':
4196 case 'c':
4197 case 's':
4198 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004199 str_arg_l = 1;
4200 switch (fmt_spec)
4201 {
4202 case '%':
4203 str_arg = p;
4204 break;
4205
4206 case 'c':
4207 {
4208 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004209
4210 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004211#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004212 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004213#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004214# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004215 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004216# endif
4217 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004218#endif
4219 /* standard demands unsigned char */
4220 uchar_arg = (unsigned char)j;
4221 str_arg = (char *)&uchar_arg;
4222 break;
4223 }
4224
4225 case 's':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004226 str_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004227#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004228 (char *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004229#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004230# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004231 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004232# endif
4233 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004234#endif
4235 if (str_arg == NULL)
4236 {
4237 str_arg = "[NULL]";
4238 str_arg_l = 6;
4239 }
4240 /* make sure not to address string beyond the specified
4241 * precision !!! */
4242 else if (!precision_specified)
4243 str_arg_l = strlen(str_arg);
4244 /* truncate string if necessary as requested by precision */
4245 else if (precision == 0)
4246 str_arg_l = 0;
4247 else
4248 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004249 /* Don't put the #if inside memchr(), it can be a
4250 * macro. */
4251#if SIZEOF_INT <= 2
4252 char *q = memchr(str_arg, '\0', precision);
4253#else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004254 /* memchr on HP does not like n > 2^31 !!! */
4255 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004256 precision <= (size_t)0x7fffffffL ? precision
4257 : (size_t)0x7fffffffL);
Bram Moolenaar3991dab2006-03-27 17:01:56 +00004258#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004259 str_arg_l = (q == NULL) ? precision : q - str_arg;
4260 }
4261 break;
4262
4263 default:
4264 break;
4265 }
4266 break;
4267
4268 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4269 {
4270 /* NOTE: the u, o, x, X and p conversion specifiers
4271 * imply the value is unsigned; d implies a signed
4272 * value */
4273
4274 /* 0 if numeric argument is zero (or if pointer is
4275 * NULL for 'p'), +1 if greater than zero (or nonzero
4276 * for unsigned arguments), -1 if negative (unsigned
4277 * argument is never negative) */
4278 int arg_sign = 0;
4279
4280 /* only defined for length modifier h, or for no
4281 * length modifiers */
4282 int int_arg = 0;
4283 unsigned int uint_arg = 0;
4284
4285 /* only defined for length modifier l */
4286 long int long_arg = 0;
4287 unsigned long int ulong_arg = 0;
4288
4289 /* pointer argument value -only defined for p
4290 * conversion */
4291 void *ptr_arg = NULL;
4292
4293 if (fmt_spec == 'p')
4294 {
4295 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004296 ptr_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004297#ifndef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004298 (void *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004299#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004300# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004301 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004302# endif
4303 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004304#endif
4305 if (ptr_arg != NULL)
4306 arg_sign = 1;
4307 }
4308 else if (fmt_spec == 'd')
4309 {
4310 /* signed */
4311 switch (length_modifier)
4312 {
4313 case '\0':
4314 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004315 /* char and short arguments are passed as int. */
4316 int_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004317#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004318 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004319#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004320# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004321 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004322# endif
4323 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324#endif
4325 if (int_arg > 0)
4326 arg_sign = 1;
4327 else if (int_arg < 0)
4328 arg_sign = -1;
4329 break;
4330 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004331 long_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004332#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004333 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004334#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004335# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004336 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004337# endif
4338 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004339#endif
4340 if (long_arg > 0)
4341 arg_sign = 1;
4342 else if (long_arg < 0)
4343 arg_sign = -1;
4344 break;
4345 }
4346 }
4347 else
4348 {
4349 /* unsigned */
4350 switch (length_modifier)
4351 {
4352 case '\0':
4353 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004354 uint_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004355#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004356 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004357#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004358# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004359 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004360# endif
4361 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004362#endif
4363 if (uint_arg != 0)
4364 arg_sign = 1;
4365 break;
4366 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004367 ulong_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004368#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004369 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004370#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004371# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004372 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004373# endif
4374 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004375#endif
4376 if (ulong_arg != 0)
4377 arg_sign = 1;
4378 break;
4379 }
4380 }
4381
4382 str_arg = tmp;
4383 str_arg_l = 0;
4384
4385 /* NOTE:
4386 * For d, i, u, o, x, and X conversions, if precision is
4387 * specified, the '0' flag should be ignored. This is so
4388 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4389 * FreeBSD, NetBSD; but not with Perl.
4390 */
4391 if (precision_specified)
4392 zero_padding = 0;
4393 if (fmt_spec == 'd')
4394 {
4395 if (force_sign && arg_sign >= 0)
4396 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4397 /* leave negative numbers for sprintf to handle, to
4398 * avoid handling tricky cases like (short int)-32768 */
4399 }
4400 else if (alternate_form)
4401 {
4402 if (arg_sign != 0
4403 && (fmt_spec == 'x' || fmt_spec == 'X') )
4404 {
4405 tmp[str_arg_l++] = '0';
4406 tmp[str_arg_l++] = fmt_spec;
4407 }
4408 /* alternate form should have no effect for p
4409 * conversion, but ... */
4410 }
4411
4412 zero_padding_insertion_ind = str_arg_l;
4413 if (!precision_specified)
4414 precision = 1; /* default precision is 1 */
4415 if (precision == 0 && arg_sign == 0)
4416 {
4417 /* When zero value is formatted with an explicit
4418 * precision 0, the resulting formatted string is
4419 * empty (d, i, u, o, x, X, p). */
4420 }
4421 else
4422 {
4423 char f[5];
4424 int f_l = 0;
4425
4426 /* construct a simple format string for sprintf */
4427 f[f_l++] = '%';
4428 if (!length_modifier)
4429 ;
4430 else if (length_modifier == '2')
4431 {
4432 f[f_l++] = 'l';
4433 f[f_l++] = 'l';
4434 }
4435 else
4436 f[f_l++] = length_modifier;
4437 f[f_l++] = fmt_spec;
4438 f[f_l++] = '\0';
4439
4440 if (fmt_spec == 'p')
4441 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4442 else if (fmt_spec == 'd')
4443 {
4444 /* signed */
4445 switch (length_modifier)
4446 {
4447 case '\0':
4448 case 'h': str_arg_l += sprintf(
4449 tmp + str_arg_l, f, int_arg);
4450 break;
4451 case 'l': str_arg_l += sprintf(
4452 tmp + str_arg_l, f, long_arg);
4453 break;
4454 }
4455 }
4456 else
4457 {
4458 /* unsigned */
4459 switch (length_modifier)
4460 {
4461 case '\0':
4462 case 'h': str_arg_l += sprintf(
4463 tmp + str_arg_l, f, uint_arg);
4464 break;
4465 case 'l': str_arg_l += sprintf(
4466 tmp + str_arg_l, f, ulong_arg);
4467 break;
4468 }
4469 }
4470
4471 /* include the optional minus sign and possible
4472 * "0x" in the region before the zero padding
4473 * insertion point */
4474 if (zero_padding_insertion_ind < str_arg_l
4475 && tmp[zero_padding_insertion_ind] == '-')
4476 zero_padding_insertion_ind++;
4477 if (zero_padding_insertion_ind + 1 < str_arg_l
4478 && tmp[zero_padding_insertion_ind] == '0'
4479 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4480 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4481 zero_padding_insertion_ind += 2;
4482 }
4483
4484 {
4485 size_t num_of_digits = str_arg_l
4486 - zero_padding_insertion_ind;
4487
4488 if (alternate_form && fmt_spec == 'o'
4489 /* unless zero is already the first
4490 * character */
4491 && !(zero_padding_insertion_ind < str_arg_l
4492 && tmp[zero_padding_insertion_ind] == '0'))
4493 {
4494 /* assure leading zero for alternate-form
4495 * octal numbers */
4496 if (!precision_specified
4497 || precision < num_of_digits + 1)
4498 {
4499 /* precision is increased to force the
4500 * first character to be zero, except if a
4501 * zero value is formatted with an
4502 * explicit precision of zero */
4503 precision = num_of_digits + 1;
4504 precision_specified = 1;
4505 }
4506 }
4507 /* zero padding to specified precision? */
4508 if (num_of_digits < precision)
4509 number_of_zeros_to_pad = precision - num_of_digits;
4510 }
4511 /* zero padding to specified minimal field width? */
4512 if (!justify_left && zero_padding)
4513 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004514 int n = (int)(min_field_width - (str_arg_l
4515 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004516 if (n > 0)
4517 number_of_zeros_to_pad += n;
4518 }
4519 break;
4520 }
4521
Bram Moolenaara7241f52008-06-24 20:39:31 +00004522#ifdef FEAT_FLOAT
4523 case 'f':
4524 case 'e':
4525 case 'E':
4526 case 'g':
4527 case 'G':
4528 {
4529 /* Floating point. */
4530 double f;
4531 double abs_f;
4532 char format[40];
4533 int l;
4534 int remove_trailing_zeroes = FALSE;
4535
4536 f =
4537# ifndef HAVE_STDARG_H
4538 get_a_arg(arg_idx);
4539# else
4540# if defined(FEAT_EVAL)
4541 tvs != NULL ? tv_float(tvs, &arg_idx) :
4542# endif
4543 va_arg(ap, double);
4544# endif
4545 abs_f = f < 0 ? -f : f;
4546
4547 if (fmt_spec == 'g' || fmt_spec == 'G')
4548 {
4549 /* Would be nice to use %g directly, but it prints
4550 * "1.0" as "1", we don't want that. */
4551 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4552 || abs_f == 0.0)
4553 fmt_spec = 'f';
4554 else
4555 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4556 remove_trailing_zeroes = TRUE;
4557 }
4558
4559 if (fmt_spec == 'f' && abs_f > 1.0e307)
4560 {
4561 /* Avoid a buffer overflow */
4562 strcpy(tmp, "inf");
4563 str_arg_l = 3;
4564 }
4565 else
4566 {
4567 format[0] = '%';
4568 l = 1;
4569 if (precision_specified)
4570 {
4571 size_t max_prec = TMP_LEN - 10;
4572
4573 /* Make sure we don't get more digits than we
4574 * have room for. */
4575 if (fmt_spec == 'f' && abs_f > 1.0)
4576 max_prec -= (size_t)log10(abs_f);
4577 if (precision > max_prec)
4578 precision = max_prec;
4579 l += sprintf(format + 1, ".%d", (int)precision);
4580 }
4581 format[l] = fmt_spec;
4582 format[l + 1] = NUL;
4583 str_arg_l = sprintf(tmp, format, f);
4584
4585 if (remove_trailing_zeroes)
4586 {
4587 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004588 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004589
4590 /* Using %g or %G: remove superfluous zeroes. */
4591 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004592 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004593 else
4594 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004595 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004596 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004597 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004598 {
4599 /* Remove superfluous '+' and leading
4600 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004601 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004602 {
4603 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004604 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004605 --str_arg_l;
4606 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004607 i = (tp[1] == '-') ? 2 : 1;
4608 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004609 {
4610 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004611 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004612 --str_arg_l;
4613 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004614 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004615 }
4616 }
4617
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004618 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004619 /* Remove trailing zeroes, but keep the one
4620 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004621 while (tp > tmp + 2 && *tp == '0'
4622 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004623 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004624 STRMOVE(tp, tp + 1);
4625 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004626 --str_arg_l;
4627 }
4628 }
4629 else
4630 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004631 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004632
4633 /* Be consistent: some printf("%e") use 1.0e+12
4634 * and some 1.0e+012. Remove one zero in the last
4635 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004636 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004637 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004638 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4639 && tp[2] == '0'
4640 && vim_isdigit(tp[3])
4641 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004642 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004643 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004644 --str_arg_l;
4645 }
4646 }
4647 }
4648 str_arg = tmp;
4649 break;
4650 }
4651#endif
4652
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004653 default:
4654 /* unrecognized conversion specifier, keep format string
4655 * as-is */
4656 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004657 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004658 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004659 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004660
4661 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004662 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004663 str_arg = p;
4664 str_arg_l = 0;
4665 if (*p != NUL)
4666 str_arg_l++; /* include invalid conversion specifier
4667 unchanged if not at end-of-string */
4668 break;
4669 }
4670
4671 if (*p != NUL)
4672 p++; /* step over the just processed conversion specifier */
4673
4674 /* insert padding to the left as requested by min_field_width;
4675 * this does not include the zero padding in case of numerical
4676 * conversions*/
4677 if (!justify_left)
4678 {
4679 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004680 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004681
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004682 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004683 {
4684 if (str_l < str_m)
4685 {
4686 size_t avail = str_m - str_l;
4687
4688 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004689 (size_t)pn > avail ? avail : pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004690 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004691 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004692 }
4693 }
4694
4695 /* zero padding as requested by the precision or by the minimal
4696 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004697 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004698 {
4699 /* will not copy first part of numeric right now, *
4700 * force it to be copied later in its entirety */
4701 zero_padding_insertion_ind = 0;
4702 }
4703 else
4704 {
4705 /* insert first part of numerics (sign or '0x') before zero
4706 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004707 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004708
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004709 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004710 {
4711 if (str_l < str_m)
4712 {
4713 size_t avail = str_m - str_l;
4714
4715 mch_memmove(str + str_l, str_arg,
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004716 (size_t)zn > avail ? avail : zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004717 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004718 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004719 }
4720
4721 /* insert zero padding as requested by the precision or min
4722 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004723 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004724 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004725 {
4726 if (str_l < str_m)
4727 {
4728 size_t avail = str_m-str_l;
4729
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004730 vim_memset(str + str_l, '0',
4731 (size_t)zn > avail ? avail : zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004732 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004733 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004734 }
4735 }
4736
4737 /* insert formatted string
4738 * (or as-is conversion specifier for unknown conversions) */
4739 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004740 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004741
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004742 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004743 {
4744 if (str_l < str_m)
4745 {
4746 size_t avail = str_m - str_l;
4747
4748 mch_memmove(str + str_l,
4749 str_arg + zero_padding_insertion_ind,
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004750 (size_t)sn > avail ? avail : sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004751 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004752 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004753 }
4754 }
4755
4756 /* insert right padding */
4757 if (justify_left)
4758 {
4759 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004760 int pn = (int)(min_field_width
4761 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004762
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004763 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004764 {
4765 if (str_l < str_m)
4766 {
4767 size_t avail = str_m - str_l;
4768
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004769 vim_memset(str + str_l, ' ',
4770 (size_t)pn > avail ? avail : pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004771 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004772 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004773 }
4774 }
4775 }
4776 }
4777
4778 if (str_m > 0)
4779 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004780 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004781 * overwriting the last character (shouldn't happen, but just in case)
4782 * */
4783 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4784 }
4785
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004786#ifdef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004787 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004788 EMSG(_("E767: Too many arguments to printf()"));
4789#endif
4790
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004791 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004792 * character), that is, the number of characters that would have been
4793 * written to the buffer if it were large enough. */
4794 return (int)str_l;
4795}
4796
4797#endif /* PROTO */