blob: ac81948f2c087ffe86300603dda87f97eb887c04 [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) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000110 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000111/*
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)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200811 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 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 void
822ex_messages(eap)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +0000823 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824{
825 struct msg_hist *p;
826 char_u *s;
827
828 msg_hist_off = TRUE;
829
830 s = mch_getenv((char_u *)"LANG");
831 if (s != NULL && *s != NUL)
832 msg_attr((char_u *)
833 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
834 hl_attr(HLF_T));
835
Bram Moolenaar5c2e0f22007-09-13 20:05:18 +0000836 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 if (p->msg != NULL)
838 msg_attr(p->msg, p->attr);
839
840 msg_hist_off = FALSE;
841}
842
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000843#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844/*
845 * Call this after prompting the user. This will avoid a hit-return message
846 * and a delay.
847 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000848 void
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849msg_end_prompt()
850{
851 need_wait_return = FALSE;
852 emsg_on_display = FALSE;
853 cmdline_row = msg_row;
854 msg_col = 0;
855 msg_clr_eos();
856}
857#endif
858
859/*
860 * wait for the user to hit a key (normally a return)
861 * if 'redraw' is TRUE, clear and redraw the screen
862 * if 'redraw' is FALSE, just redraw the screen
863 * if 'redraw' is -1, don't redraw at all
864 */
865 void
866wait_return(redraw)
867 int redraw;
868{
869 int c;
870 int oldState;
871 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 int had_got_int;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 if (redraw == TRUE)
875 must_redraw = CLEAR;
876
877 /* If using ":silent cmd", don't wait for a return. Also don't set
878 * need_wait_return to do it later. */
879 if (msg_silent != 0)
880 return;
881
882/*
883 * With the global command (and some others) we only need one return at the
884 * end. Adjust cmdline_row to avoid the next message overwriting the last one.
885 * When inside vgetc(), we can't wait for a typed character at all.
886 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000887 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 return;
889 if (no_wait_return)
890 {
891 need_wait_return = TRUE;
892 if (!exmode_active)
893 cmdline_row = msg_row;
894 return;
895 }
896
897 redir_off = TRUE; /* don't redirect this message */
898 oldState = State;
899 if (quit_more)
900 {
901 c = CAR; /* just pretend CR was hit */
902 quit_more = FALSE;
903 got_int = FALSE;
904 }
905 else if (exmode_active)
906 {
907 MSG_PUTS(" "); /* make sure the cursor is on the right line */
908 c = CAR; /* no need for a return in ex mode */
909 got_int = FALSE;
910 }
911 else
912 {
913 /* Make sure the hit-return prompt is on screen when 'guioptions' was
914 * just changed. */
915 screenalloc(FALSE);
916
917 State = HITRETURN;
918#ifdef FEAT_MOUSE
919 setmouse();
920#endif
921#ifdef USE_ON_FLY_SCROLL
922 dont_scroll = TRUE; /* disallow scrolling here */
923#endif
924 hit_return_msg();
925
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 do
927 {
928 /* Remember "got_int", if it is set vgetc() probably returns a
929 * CTRL-C, but we need to loop then. */
930 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000931
932 /* Don't do mappings here, we put the character back in the
933 * typeahead buffer. */
934 ++no_mapping;
935 ++allow_keys;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000937 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000939 --no_mapping;
940 --allow_keys;
941
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942#ifdef FEAT_CLIPBOARD
943 /* Strange way to allow copying (yanking) a modeless selection at
944 * the hit-enter prompt. Use CTRL-Y, because the same is used in
945 * Cmdline-mode and it's harmless when there is no selection. */
946 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
947 {
948 clip_copy_modeless_selection(TRUE);
949 c = K_IGNORE;
950 }
951#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000952
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000953 /*
954 * Allow scrolling back in the messages.
955 * Also accept scroll-down commands when messages fill the screen,
956 * to avoid that typing one 'j' too many makes the messages
957 * disappear.
958 */
959 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000960 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000961 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000962 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000963 /* scroll back to show older messages */
964 do_more_prompt(c);
965 if (quit_more)
966 {
967 c = CAR; /* just pretend CR was hit */
968 quit_more = FALSE;
969 got_int = FALSE;
970 }
971 else
972 {
973 c = K_IGNORE;
974 hit_return_msg();
975 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000976 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000977 else if (msg_scrolled > Rows - 2
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +0000978 && (c == 'j' || c == K_DOWN || c == 'd' || c == 'f'))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000979 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000980 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 } while ((had_got_int && c == Ctrl_C)
982 || c == K_IGNORE
983#ifdef FEAT_GUI
984 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
985#endif
986#ifdef FEAT_MOUSE
987 || c == K_LEFTDRAG || c == K_LEFTRELEASE
988 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
989 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +0200990 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 || 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
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001138 if (!msg_silent)
1139 {
1140 vim_free(keep_msg);
1141 keep_msg = NULL; /* don't display old message now */
1142 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001143
1144#ifdef FEAT_EVAL
1145 if (need_clr_eos)
1146 {
1147 /* Halfway an ":echo" command and getting an (error) message: clear
1148 * any text from the command. */
1149 need_clr_eos = FALSE;
1150 msg_clr_eos();
1151 }
1152#endif
1153
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 if (!msg_scroll && full_screen) /* overwrite last message */
1155 {
1156 msg_row = cmdline_row;
1157 msg_col =
1158#ifdef FEAT_RIGHTLEFT
1159 cmdmsg_rl ? Columns - 1 :
1160#endif
1161 0;
1162 }
1163 else if (msg_didout) /* start message on next line */
1164 {
1165 msg_putchar('\n');
1166 did_return = TRUE;
1167 if (exmode_active != EXMODE_NORMAL)
1168 cmdline_row = msg_row;
1169 }
1170 if (!msg_didany || lines_left < 0)
1171 msg_starthere();
1172 if (msg_silent == 0)
1173 {
1174 msg_didout = FALSE; /* no output on current line yet */
1175 cursor_off();
1176 }
1177
1178 /* when redirecting, may need to start a new line. */
1179 if (!did_return)
1180 redir_write((char_u *)"\n", -1);
1181}
1182
1183/*
1184 * Note that the current msg position is where messages start.
1185 */
1186 void
1187msg_starthere()
1188{
1189 lines_left = cmdline_row;
1190 msg_didany = FALSE;
1191}
1192
1193 void
1194msg_putchar(c)
1195 int c;
1196{
1197 msg_putchar_attr(c, 0);
1198}
1199
1200 void
1201msg_putchar_attr(c, attr)
1202 int c;
1203 int attr;
1204{
1205#ifdef FEAT_MBYTE
1206 char_u buf[MB_MAXBYTES + 1];
1207#else
1208 char_u buf[4];
1209#endif
1210
1211 if (IS_SPECIAL(c))
1212 {
1213 buf[0] = K_SPECIAL;
1214 buf[1] = K_SECOND(c);
1215 buf[2] = K_THIRD(c);
1216 buf[3] = NUL;
1217 }
1218 else
1219 {
1220#ifdef FEAT_MBYTE
1221 buf[(*mb_char2bytes)(c, buf)] = NUL;
1222#else
1223 buf[0] = c;
1224 buf[1] = NUL;
1225#endif
1226 }
1227 msg_puts_attr(buf, attr);
1228}
1229
1230 void
1231msg_outnum(n)
1232 long n;
1233{
1234 char_u buf[20];
1235
1236 sprintf((char *)buf, "%ld", n);
1237 msg_puts(buf);
1238}
1239
1240 void
1241msg_home_replace(fname)
1242 char_u *fname;
1243{
1244 msg_home_replace_attr(fname, 0);
1245}
1246
1247#if defined(FEAT_FIND_ID) || defined(PROTO)
1248 void
1249msg_home_replace_hl(fname)
1250 char_u *fname;
1251{
1252 msg_home_replace_attr(fname, hl_attr(HLF_D));
1253}
1254#endif
1255
1256 static void
1257msg_home_replace_attr(fname, attr)
1258 char_u *fname;
1259 int attr;
1260{
1261 char_u *name;
1262
1263 name = home_replace_save(NULL, fname);
1264 if (name != NULL)
1265 msg_outtrans_attr(name, attr);
1266 vim_free(name);
1267}
1268
1269/*
1270 * Output 'len' characters in 'str' (including NULs) with translation
1271 * if 'len' is -1, output upto a NUL character.
1272 * Use attributes 'attr'.
1273 * Return the number of characters it takes on the screen.
1274 */
1275 int
1276msg_outtrans(str)
1277 char_u *str;
1278{
1279 return msg_outtrans_attr(str, 0);
1280}
1281
1282 int
1283msg_outtrans_attr(str, attr)
1284 char_u *str;
1285 int attr;
1286{
1287 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1288}
1289
1290 int
1291msg_outtrans_len(str, len)
1292 char_u *str;
1293 int len;
1294{
1295 return msg_outtrans_len_attr(str, len, 0);
1296}
1297
1298/*
1299 * Output one character at "p". Return pointer to the next character.
1300 * Handles multi-byte characters.
1301 */
1302 char_u *
1303msg_outtrans_one(p, attr)
1304 char_u *p;
1305 int attr;
1306{
1307#ifdef FEAT_MBYTE
1308 int l;
1309
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001310 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 {
1312 msg_outtrans_len_attr(p, l, attr);
1313 return p + l;
1314 }
1315#endif
1316 msg_puts_attr(transchar_byte(*p), attr);
1317 return p + 1;
1318}
1319
1320 int
1321msg_outtrans_len_attr(msgstr, len, attr)
1322 char_u *msgstr;
1323 int len;
1324 int attr;
1325{
1326 int retval = 0;
1327 char_u *str = msgstr;
1328 char_u *plain_start = msgstr;
1329 char_u *s;
1330#ifdef FEAT_MBYTE
1331 int mb_l;
1332 int c;
1333#endif
1334
1335 /* if MSG_HIST flag set, add message to history */
1336 if (attr & MSG_HIST)
1337 {
1338 add_msg_hist(str, len, attr);
1339 attr &= ~MSG_HIST;
1340 }
1341
1342#ifdef FEAT_MBYTE
1343 /* If the string starts with a composing character first draw a space on
1344 * which the composing char can be drawn. */
1345 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1346 msg_puts_attr((char_u *)" ", attr);
1347#endif
1348
1349 /*
1350 * Go over the string. Special characters are translated and printed.
1351 * Normal characters are printed several at a time.
1352 */
1353 while (--len >= 0)
1354 {
1355#ifdef FEAT_MBYTE
1356 if (enc_utf8)
1357 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001358 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001360 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 else
1362 mb_l = 1;
1363 if (has_mbyte && mb_l > 1)
1364 {
1365 c = (*mb_ptr2char)(str);
1366 if (vim_isprintc(c))
1367 /* printable multi-byte char: count the cells. */
1368 retval += (*mb_ptr2cells)(str);
1369 else
1370 {
1371 /* unprintable multi-byte char: print the printable chars so
1372 * far and the translation of the unprintable char. */
1373 if (str > plain_start)
1374 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1375 attr);
1376 plain_start = str + mb_l;
1377 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1378 retval += char2cells(c);
1379 }
1380 len -= mb_l - 1;
1381 str += mb_l;
1382 }
1383 else
1384#endif
1385 {
1386 s = transchar_byte(*str);
1387 if (s[1] != NUL)
1388 {
1389 /* unprintable char: print the printable chars so far and the
1390 * translation of the unprintable char. */
1391 if (str > plain_start)
1392 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1393 attr);
1394 plain_start = str + 1;
1395 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001396 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001398 else
1399 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 ++str;
1401 }
1402 }
1403
1404 if (str > plain_start)
1405 /* print the printable chars at the end */
1406 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1407
1408 return retval;
1409}
1410
1411#if defined(FEAT_QUICKFIX) || defined(PROTO)
1412 void
1413msg_make(arg)
1414 char_u *arg;
1415{
1416 int i;
1417 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1418
1419 arg = skipwhite(arg);
1420 for (i = 5; *arg && i >= 0; --i)
1421 if (*arg++ != str[i])
1422 break;
1423 if (i < 0)
1424 {
1425 msg_putchar('\n');
1426 for (i = 0; rs[i]; ++i)
1427 msg_putchar(rs[i] - 3);
1428 }
1429}
1430#endif
1431
1432/*
1433 * Output the string 'str' upto a NUL character.
1434 * Return the number of characters it takes on the screen.
1435 *
1436 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1437 * following character and shown as <F1>, <S-Up> etc. Any other character
1438 * which is not printable shown in <> form.
1439 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1440 * If a character is displayed in one of these special ways, is also
1441 * highlighted (its highlight name is '8' in the p_hl variable).
1442 * Otherwise characters are not highlighted.
1443 * This function is used to show mappings, where we want to see how to type
1444 * the character/string -- webb
1445 */
1446 int
1447msg_outtrans_special(strstart, from)
1448 char_u *strstart;
1449 int from; /* TRUE for lhs of a mapping */
1450{
1451 char_u *str = strstart;
1452 int retval = 0;
1453 char_u *string;
1454 int attr;
1455 int len;
1456
1457 attr = hl_attr(HLF_8);
1458 while (*str != NUL)
1459 {
1460 /* Leading and trailing spaces need to be displayed in <> form. */
1461 if ((str == strstart || str[1] == NUL) && *str == ' ')
1462 {
1463 string = (char_u *)"<Space>";
1464 ++str;
1465 }
1466 else
1467 string = str2special(&str, from);
1468 len = vim_strsize(string);
1469 /* Highlight special keys */
1470 msg_puts_attr(string, len > 1
1471#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001472 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473#endif
1474 ? attr : 0);
1475 retval += len;
1476 }
1477 return retval;
1478}
1479
Bram Moolenaarbd743252010-10-20 21:23:33 +02001480#if defined(FEAT_EVAL) || defined(PROTO)
1481/*
1482 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1483 * strings, in an allocated string.
1484 */
1485 char_u *
1486str2special_save(str, is_lhs)
1487 char_u *str;
1488 int is_lhs; /* TRUE for lhs, FALSE for rhs */
1489{
1490 garray_T ga;
1491 char_u *p = str;
1492
1493 ga_init2(&ga, 1, 40);
1494 while (*p != NUL)
1495 ga_concat(&ga, str2special(&p, is_lhs));
1496 ga_append(&ga, NUL);
1497 return (char_u *)ga.ga_data;
1498}
1499#endif
1500
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501/*
1502 * Return the printable string for the key codes at "*sp".
1503 * Used for translating the lhs or rhs of a mapping to printable chars.
1504 * Advances "sp" to the next code.
1505 */
1506 char_u *
1507str2special(sp, from)
1508 char_u **sp;
1509 int from; /* TRUE for lhs of mapping */
1510{
1511 int c;
1512 static char_u buf[7];
1513 char_u *str = *sp;
1514 int modifiers = 0;
1515 int special = FALSE;
1516
1517#ifdef FEAT_MBYTE
1518 if (has_mbyte)
1519 {
1520 char_u *p;
1521
1522 /* Try to un-escape a multi-byte character. Return the un-escaped
1523 * string if it is a multi-byte character. */
1524 p = mb_unescape(sp);
1525 if (p != NULL)
1526 return p;
1527 }
1528#endif
1529
1530 c = *str;
1531 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1532 {
1533 if (str[1] == KS_MODIFIER)
1534 {
1535 modifiers = str[2];
1536 str += 3;
1537 c = *str;
1538 }
1539 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1540 {
1541 c = TO_SPECIAL(str[1], str[2]);
1542 str += 2;
1543 if (c == K_ZERO) /* display <Nul> as ^@ */
1544 c = NUL;
1545 }
1546 if (IS_SPECIAL(c) || modifiers) /* special key */
1547 special = TRUE;
1548 }
1549 *sp = str + 1;
1550
1551#ifdef FEAT_MBYTE
1552 /* For multi-byte characters check for an illegal byte. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001553 if (has_mbyte && MB_BYTE2LEN(*str) > (*mb_ptr2len)(str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 {
1555 transchar_nonprint(buf, c);
1556 return buf;
1557 }
1558#endif
1559
1560 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1561 * Use <Space> only for lhs of a mapping. */
1562 if (special || char2cells(c) > 1 || (from && c == ' '))
1563 return get_special_key_name(c, modifiers);
1564 buf[0] = c;
1565 buf[1] = NUL;
1566 return buf;
1567}
1568
1569/*
1570 * Translate a key sequence into special key names.
1571 */
1572 void
1573str2specialbuf(sp, buf, len)
1574 char_u *sp;
1575 char_u *buf;
1576 int len;
1577{
1578 char_u *s;
1579
1580 *buf = NUL;
1581 while (*sp)
1582 {
1583 s = str2special(&sp, FALSE);
1584 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1585 STRCAT(buf, s);
1586 }
1587}
1588
1589/*
1590 * print line for :print or :list command
1591 */
1592 void
Bram Moolenaardf177f62005-02-22 08:39:57 +00001593msg_prt_line(s, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 char_u *s;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001595 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596{
1597 int c;
1598 int col = 0;
1599 int n_extra = 0;
1600 int c_extra = 0;
1601 char_u *p_extra = NULL; /* init to make SASC shut up */
1602 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001603 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 char_u *trail = NULL;
1605#ifdef FEAT_MBYTE
1606 int l;
1607 char_u buf[MB_MAXBYTES + 1];
1608#endif
1609
Bram Moolenaardf177f62005-02-22 08:39:57 +00001610 if (curwin->w_p_list)
1611 list = TRUE;
1612
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001614 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 {
1616 trail = s + STRLEN(s);
1617 while (trail > s && vim_iswhite(trail[-1]))
1618 --trail;
1619 }
1620
1621 /* output a space for an empty line, otherwise the line will be
1622 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001623 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 msg_putchar(' ');
1625
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001626 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001628 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 {
1630 --n_extra;
1631 if (c_extra)
1632 c = c_extra;
1633 else
1634 c = *p_extra++;
1635 }
1636#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001637 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 {
1639 col += (*mb_ptr2cells)(s);
1640 mch_memmove(buf, s, (size_t)l);
1641 buf[l] = NUL;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001642 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 s += l;
1644 continue;
1645 }
1646#endif
1647 else
1648 {
1649 attr = 0;
1650 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001651 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 {
1653 /* tab amount depends on current column */
1654 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001655 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 {
1657 c = ' ';
1658 c_extra = ' ';
1659 }
1660 else
1661 {
1662 c = lcs_tab1;
1663 c_extra = lcs_tab2;
1664 attr = hl_attr(HLF_8);
1665 }
1666 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001667 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 {
1669 p_extra = (char_u *)"";
1670 c_extra = NUL;
1671 n_extra = 1;
1672 c = lcs_eol;
1673 attr = hl_attr(HLF_AT);
1674 --s;
1675 }
1676 else if (c != NUL && (n = byte2cells(c)) > 1)
1677 {
1678 n_extra = n - 1;
1679 p_extra = transchar_byte(c);
1680 c_extra = NUL;
1681 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001682 /* Use special coloring to be able to distinguish <hex> from
1683 * the same in plain text. */
1684 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 }
1686 else if (c == ' ' && trail != NULL && s > trail)
1687 {
1688 c = lcs_trail;
1689 attr = hl_attr(HLF_8);
1690 }
1691 }
1692
1693 if (c == NUL)
1694 break;
1695
1696 msg_putchar_attr(c, attr);
1697 col++;
1698 }
1699 msg_clr_eos();
1700}
1701
1702#ifdef FEAT_MBYTE
1703/*
1704 * Use screen_puts() to output one multi-byte character.
1705 * Return the pointer "s" advanced to the next character.
1706 */
1707 static char_u *
1708screen_puts_mbyte(s, l, attr)
1709 char_u *s;
1710 int l;
1711 int attr;
1712{
1713 int cw;
1714
1715 msg_didout = TRUE; /* remember that line is not empty */
1716 cw = (*mb_ptr2cells)(s);
1717 if (cw > 1 && (
1718#ifdef FEAT_RIGHTLEFT
1719 cmdmsg_rl ? msg_col <= 1 :
1720#endif
1721 msg_col == Columns - 1))
1722 {
1723 /* Doesn't fit, print a highlighted '>' to fill it up. */
1724 msg_screen_putchar('>', hl_attr(HLF_AT));
1725 return s;
1726 }
1727
1728 screen_puts_len(s, l, msg_row, msg_col, attr);
1729#ifdef FEAT_RIGHTLEFT
1730 if (cmdmsg_rl)
1731 {
1732 msg_col -= cw;
1733 if (msg_col == 0)
1734 {
1735 msg_col = Columns;
1736 ++msg_row;
1737 }
1738 }
1739 else
1740#endif
1741 {
1742 msg_col += cw;
1743 if (msg_col >= Columns)
1744 {
1745 msg_col = 0;
1746 ++msg_row;
1747 }
1748 }
1749 return s + l;
1750}
1751#endif
1752
1753/*
1754 * Output a string to the screen at position msg_row, msg_col.
1755 * Update msg_row and msg_col for the next message.
1756 */
1757 void
1758msg_puts(s)
1759 char_u *s;
1760{
1761 msg_puts_attr(s, 0);
1762}
1763
1764 void
1765msg_puts_title(s)
1766 char_u *s;
1767{
1768 msg_puts_attr(s, hl_attr(HLF_T));
1769}
1770
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771/*
1772 * Show a message in such a way that it always fits in the line. Cut out a
1773 * part in the middle and replace it with "..." when necessary.
1774 * Does not handle multi-byte characters!
1775 */
1776 void
1777msg_puts_long_attr(longstr, attr)
1778 char_u *longstr;
1779 int attr;
1780{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001781 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782}
1783
1784 void
1785msg_puts_long_len_attr(longstr, len, attr)
1786 char_u *longstr;
1787 int len;
1788 int attr;
1789{
1790 int slen = len;
1791 int room;
1792
1793 room = Columns - msg_col;
1794 if (len > room && room >= 20)
1795 {
1796 slen = (room - 3) / 2;
1797 msg_outtrans_len_attr(longstr, slen, attr);
1798 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1799 }
1800 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1801}
1802
1803/*
1804 * Basic function for writing a message with highlight attributes.
1805 */
1806 void
1807msg_puts_attr(s, attr)
1808 char_u *s;
1809 int attr;
1810{
1811 msg_puts_attr_len(s, -1, attr);
1812}
1813
1814/*
1815 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1816 * When "maxlen" is -1 there is no maximum length.
1817 * When "maxlen" is >= 0 the message is not put in the history.
1818 */
1819 static void
1820msg_puts_attr_len(str, maxlen, attr)
1821 char_u *str;
1822 int maxlen;
1823 int attr;
1824{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 /*
1826 * If redirection is on, also write to the redirection file.
1827 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001828 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829
1830 /*
1831 * Don't print anything when using ":silent cmd".
1832 */
1833 if (msg_silent != 0)
1834 return;
1835
1836 /* if MSG_HIST flag set, add message to history */
1837 if ((attr & MSG_HIST) && maxlen < 0)
1838 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001839 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 attr &= ~MSG_HIST;
1841 }
1842
1843 /*
1844 * When writing something to the screen after it has scrolled, requires a
1845 * wait-return prompt later. Needed when scrolling, resetting
1846 * need_wait_return after some prompt, and then outputting something
1847 * without scrolling
1848 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001849 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 need_wait_return = TRUE;
1851 msg_didany = TRUE; /* remember that something was outputted */
1852
1853 /*
1854 * If there is no valid screen, use fprintf so we can see error messages.
1855 * If termcap is not active, we may be writing in an alternate console
1856 * window, cursor positioning may not work correctly (window size may be
1857 * different, e.g. for Win32 console) or we just don't know where the
1858 * cursor is.
1859 */
1860 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001861 msg_puts_printf(str, maxlen);
1862 else
1863 msg_puts_display(str, maxlen, attr, FALSE);
1864}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001866/*
1867 * The display part of msg_puts_attr_len().
1868 * May be called recursively to display scroll-back text.
1869 */
1870 static void
1871msg_puts_display(str, maxlen, attr, recurse)
1872 char_u *str;
1873 int maxlen;
1874 int attr;
1875 int recurse;
1876{
1877 char_u *s = str;
1878 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1879 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1880#ifdef FEAT_MBYTE
1881 int l;
1882 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001884 char_u *sb_str = str;
1885 int sb_col = msg_col;
1886 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001887 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888
1889 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001890 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 {
1892 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001893 * We are at the end of the screen line when:
1894 * - When outputting a newline.
1895 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001897 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898#ifdef FEAT_RIGHTLEFT
1899 cmdmsg_rl
1900 ? (
1901 msg_col <= 1
1902 || (*s == TAB && msg_col <= 7)
1903# ifdef FEAT_MBYTE
1904 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1905# endif
1906 )
1907 :
1908#endif
1909 (msg_col + t_col >= Columns - 1
1910 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1911# ifdef FEAT_MBYTE
1912 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1913 && msg_col + t_col >= Columns - 2)
1914# endif
1915 ))))
1916 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001917 /*
1918 * The screen is scrolled up when at the last row (some terminals
1919 * scroll automatically, some don't. To avoid problems we scroll
1920 * ourselves).
1921 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001924 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001926 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 if (msg_no_more && lines_left == 0)
1928 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001930 /* Scroll the screen up one line. */
1931 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932
1933 msg_row = Rows - 2;
1934 if (msg_col >= Columns) /* can happen after screen resize */
1935 msg_col = Columns - 1;
1936
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001937 /* Display char in last column before showing more-prompt. */
1938 if (*s >= ' '
1939#ifdef FEAT_RIGHTLEFT
1940 && !cmdmsg_rl
1941#endif
1942 )
1943 {
1944#ifdef FEAT_MBYTE
1945 if (has_mbyte)
1946 {
1947 if (enc_utf8 && maxlen >= 0)
1948 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001949 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001950 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001951 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001952 s = screen_puts_mbyte(s, l, attr);
1953 }
1954 else
1955#endif
1956 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001957 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001958 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001959 else
1960 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001961
1962 if (p_more)
1963 /* store text for scrolling back */
1964 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1965
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001966 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001967 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 if (must_redraw < VALID)
1969 must_redraw = VALID;
1970 redraw_cmdline = TRUE;
1971 if (cmdline_row > 0 && !exmode_active)
1972 --cmdline_row;
1973
1974 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001975 * If screen is completely filled and 'more' is set then wait
1976 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001978 if (lines_left > 0)
1979 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001980 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 && !msg_no_more && !exmode_active)
1982 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001984 if (do_more_prompt(NUL))
1985 s = confirm_msg_tail;
1986#else
1987 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988#endif
1989 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001990 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001992
1993 /* When we displayed a char in last column need to check if there
1994 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001995 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001996 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 }
1998
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001999 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 || msg_col + t_col >= Columns
2001#ifdef FEAT_MBYTE
2002 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2003 && msg_col + t_col >= Columns - 1)
2004#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002005 ;
2006 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2007 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002009 t_puts(&t_col, t_s, s, attr);
2010
2011 if (wrap && p_more && !recurse)
2012 /* store text for scrolling back */
2013 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014
2015 if (*s == '\n') /* go to next line */
2016 {
2017 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002018#ifdef FEAT_RIGHTLEFT
2019 if (cmdmsg_rl)
2020 msg_col = Columns - 1;
2021 else
2022#endif
2023 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 if (++msg_row >= Rows) /* safety check */
2025 msg_row = Rows - 1;
2026 }
2027 else if (*s == '\r') /* go to column 0 */
2028 {
2029 msg_col = 0;
2030 }
2031 else if (*s == '\b') /* go to previous char */
2032 {
2033 if (msg_col)
2034 --msg_col;
2035 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002036 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 {
2038 do
2039 msg_screen_putchar(' ', attr);
2040 while (msg_col & 7);
2041 }
2042 else if (*s == BELL) /* beep (from ":sh") */
2043 vim_beep();
2044 else
2045 {
2046#ifdef FEAT_MBYTE
2047 if (has_mbyte)
2048 {
2049 cw = (*mb_ptr2cells)(s);
2050 if (enc_utf8 && maxlen >= 0)
2051 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002052 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002054 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 }
2056 else
2057 {
2058 cw = 1;
2059 l = 1;
2060 }
2061#endif
2062 /* When drawing from right to left or when a double-wide character
2063 * doesn't fit, draw a single character here. Otherwise collect
2064 * characters and draw them all at once later. */
2065#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2066 if (
2067# ifdef FEAT_RIGHTLEFT
2068 cmdmsg_rl
2069# ifdef FEAT_MBYTE
2070 ||
2071# endif
2072# endif
2073# ifdef FEAT_MBYTE
2074 (cw > 1 && msg_col + t_col >= Columns - 1)
2075# endif
2076 )
2077 {
2078# ifdef FEAT_MBYTE
2079 if (l > 1)
2080 s = screen_puts_mbyte(s, l, attr) - 1;
2081 else
2082# endif
2083 msg_screen_putchar(*s, attr);
2084 }
2085 else
2086#endif
2087 {
2088 /* postpone this character until later */
2089 if (t_col == 0)
2090 t_s = s;
2091#ifdef FEAT_MBYTE
2092 t_col += cw;
2093 s += l - 1;
2094#else
2095 ++t_col;
2096#endif
2097 }
2098 }
2099 ++s;
2100 }
2101
2102 /* output any postponed text */
2103 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002104 t_puts(&t_col, t_s, s, attr);
2105 if (p_more && !recurse)
2106 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107
2108 msg_check();
2109}
2110
2111/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002112 * Scroll the screen up one line for displaying the next message line.
2113 */
2114 static void
2115msg_scroll_up()
2116{
2117#ifdef FEAT_GUI
2118 /* Remove the cursor before scrolling, ScreenLines[] is going
2119 * to become invalid. */
2120 if (gui.in_use)
2121 gui_undraw_cursor();
2122#endif
2123 /* scrolling up always works */
2124 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2125
2126 if (!can_clear((char_u *)" "))
2127 {
2128 /* Scrolling up doesn't result in the right background. Set the
2129 * background here. It's not efficient, but avoids that we have to do
2130 * it all over the code. */
2131 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2132
2133 /* Also clear the last char of the last but one line if it was not
2134 * cleared before to avoid a scroll-up. */
2135 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2136 screen_fill((int)Rows - 2, (int)Rows - 1,
2137 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2138 }
2139}
2140
2141/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002142 * Increment "msg_scrolled".
2143 */
2144 static void
2145inc_msg_scrolled()
2146{
2147#ifdef FEAT_EVAL
2148 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2149 {
2150 char_u *p = sourcing_name;
2151 char_u *tofree = NULL;
2152 int len;
2153
2154 /* v:scrollstart is empty, set it to the script/function name and line
2155 * number */
2156 if (p == NULL)
2157 p = (char_u *)_("Unknown");
2158 else
2159 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002160 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002161 tofree = alloc(len);
2162 if (tofree != NULL)
2163 {
2164 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2165 p, (long)sourcing_lnum);
2166 p = tofree;
2167 }
2168 }
2169 set_vim_var_string(VV_SCROLLSTART, p, -1);
2170 vim_free(tofree);
2171 }
2172#endif
2173 ++msg_scrolled;
2174}
2175
2176/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002177 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2178 * store the displayed text and remember where screen lines start.
2179 */
2180typedef struct msgchunk_S msgchunk_T;
2181struct msgchunk_S
2182{
2183 msgchunk_T *sb_next;
2184 msgchunk_T *sb_prev;
2185 char sb_eol; /* TRUE when line ends after this text */
2186 int sb_msg_col; /* column in which text starts */
2187 int sb_attr; /* text attributes */
2188 char_u sb_text[1]; /* text to be displayed, actually longer */
2189};
2190
2191static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2192
2193static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2194static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2195
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002196static int do_clear_sb_text = FALSE; /* clear text on next msg */
2197
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002198/*
2199 * Store part of a printed message for displaying when scrolling back.
2200 */
2201 static void
2202store_sb_text(sb_str, s, attr, sb_col, finish)
2203 char_u **sb_str; /* start of string */
2204 char_u *s; /* just after string */
2205 int attr;
2206 int *sb_col;
2207 int finish; /* line ends */
2208{
2209 msgchunk_T *mp;
2210
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002211 if (do_clear_sb_text)
2212 {
2213 clear_sb_text();
2214 do_clear_sb_text = FALSE;
2215 }
2216
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002217 if (s > *sb_str)
2218 {
2219 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2220 if (mp != NULL)
2221 {
2222 mp->sb_eol = finish;
2223 mp->sb_msg_col = *sb_col;
2224 mp->sb_attr = attr;
2225 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2226
2227 if (last_msgchunk == NULL)
2228 {
2229 last_msgchunk = mp;
2230 mp->sb_prev = NULL;
2231 }
2232 else
2233 {
2234 mp->sb_prev = last_msgchunk;
2235 last_msgchunk->sb_next = mp;
2236 last_msgchunk = mp;
2237 }
2238 mp->sb_next = NULL;
2239 }
2240 }
2241 else if (finish && last_msgchunk != NULL)
2242 last_msgchunk->sb_eol = TRUE;
2243
2244 *sb_str = s;
2245 *sb_col = 0;
2246}
2247
2248/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002249 * Finished showing messages, clear the scroll-back text on the next message.
2250 */
2251 void
2252may_clear_sb_text()
2253{
2254 do_clear_sb_text = TRUE;
2255}
2256
2257/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002258 * Clear any text remembered for scrolling back.
2259 * Called when redrawing the screen.
2260 */
2261 void
2262clear_sb_text()
2263{
2264 msgchunk_T *mp;
2265
2266 while (last_msgchunk != NULL)
2267 {
2268 mp = last_msgchunk->sb_prev;
2269 vim_free(last_msgchunk);
2270 last_msgchunk = mp;
2271 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002272}
2273
2274/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002275 * "g<" command.
2276 */
2277 void
2278show_sb_text()
2279{
2280 msgchunk_T *mp;
2281
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002282 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002283 * weird, typing a command without output results in one line. */
2284 mp = msg_sb_start(last_msgchunk);
2285 if (mp == NULL || mp->sb_prev == NULL)
2286 vim_beep();
2287 else
2288 {
2289 do_more_prompt('G');
2290 wait_return(FALSE);
2291 }
2292}
2293
2294/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002295 * Move to the start of screen line in already displayed text.
2296 */
2297 static msgchunk_T *
2298msg_sb_start(mps)
2299 msgchunk_T *mps;
2300{
2301 msgchunk_T *mp = mps;
2302
2303 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2304 mp = mp->sb_prev;
2305 return mp;
2306}
2307
2308/*
2309 * Display a screen line from previously displayed text at row "row".
2310 * Returns a pointer to the text for the next line (can be NULL).
2311 */
2312 static msgchunk_T *
2313disp_sb_line(row, smp)
2314 int row;
2315 msgchunk_T *smp;
2316{
2317 msgchunk_T *mp = smp;
2318 char_u *p;
2319
2320 for (;;)
2321 {
2322 msg_row = row;
2323 msg_col = mp->sb_msg_col;
2324 p = mp->sb_text;
2325 if (*p == '\n') /* don't display the line break */
2326 ++p;
2327 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2328 if (mp->sb_eol || mp->sb_next == NULL)
2329 break;
2330 mp = mp->sb_next;
2331 }
2332 return mp->sb_next;
2333}
2334
2335/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 * Output any postponed text for msg_puts_attr_len().
2337 */
2338 static void
2339t_puts(t_col, t_s, s, attr)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002340 int *t_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 char_u *t_s;
2342 char_u *s;
2343 int attr;
2344{
2345 /* output postponed text */
2346 msg_didout = TRUE; /* remember that line is not empty */
2347 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002348 msg_col += *t_col;
2349 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350#ifdef FEAT_MBYTE
2351 /* If the string starts with a composing character don't increment the
2352 * column position for it. */
2353 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2354 --msg_col;
2355#endif
2356 if (msg_col >= Columns)
2357 {
2358 msg_col = 0;
2359 ++msg_row;
2360 }
2361}
2362
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363/*
2364 * Returns TRUE when messages should be printed with mch_errmsg().
2365 * This is used when there is no valid screen, so we can see error messages.
2366 * If termcap is not active, we may be writing in an alternate console
2367 * window, cursor positioning may not work correctly (window size may be
2368 * different, e.g. for Win32 console) or we just don't know where the
2369 * cursor is.
2370 */
2371 int
2372msg_use_printf()
2373{
2374 return (!msg_check_screen()
2375#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2376 || !termcap_active
2377#endif
2378 || (swapping_screen() && !termcap_active)
2379 );
2380}
2381
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002382/*
2383 * Print a message when there is no valid screen.
2384 */
2385 static void
2386msg_puts_printf(str, maxlen)
2387 char_u *str;
2388 int maxlen;
2389{
2390 char_u *s = str;
2391 char_u buf[4];
2392 char_u *p;
2393
2394#ifdef WIN3264
2395 if (!(silent_mode && p_verbose == 0))
2396 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2397#endif
2398 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2399 {
2400 if (!(silent_mode && p_verbose == 0))
2401 {
2402 /* NL --> CR NL translation (for Unix, not for "--version") */
2403 /* NL --> CR translation (for Mac) */
2404 p = &buf[0];
2405 if (*s == '\n' && !info_message)
2406 *p++ = '\r';
2407#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2408 else
2409#endif
2410 *p++ = *s;
2411 *p = '\0';
2412 if (info_message) /* informative message, not an error */
2413 mch_msg((char *)buf);
2414 else
2415 mch_errmsg((char *)buf);
2416 }
2417
2418 /* primitive way to compute the current column */
2419#ifdef FEAT_RIGHTLEFT
2420 if (cmdmsg_rl)
2421 {
2422 if (*s == '\r' || *s == '\n')
2423 msg_col = Columns - 1;
2424 else
2425 --msg_col;
2426 }
2427 else
2428#endif
2429 {
2430 if (*s == '\r' || *s == '\n')
2431 msg_col = 0;
2432 else
2433 ++msg_col;
2434 }
2435 ++s;
2436 }
2437 msg_didout = TRUE; /* assume that line is not empty */
2438
2439#ifdef WIN3264
2440 if (!(silent_mode && p_verbose == 0))
2441 mch_settmode(TMODE_RAW);
2442#endif
2443}
2444
2445/*
2446 * Show the more-prompt and handle the user response.
2447 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002448 * When at hit-enter prompt "typed_char" is the already typed character,
2449 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002450 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2451 */
2452 static int
2453do_more_prompt(typed_char)
2454 int typed_char;
2455{
2456 int used_typed_char = typed_char;
2457 int oldState = State;
2458 int c;
2459#ifdef FEAT_CON_DIALOG
2460 int retval = FALSE;
2461#endif
2462 int scroll;
2463 msgchunk_T *mp_last = NULL;
2464 msgchunk_T *mp;
2465 int i;
2466
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002467 if (typed_char == 'G')
2468 {
2469 /* "g<": Find first line on the last page. */
2470 mp_last = msg_sb_start(last_msgchunk);
2471 for (i = 0; i < Rows - 2 && mp_last != NULL
2472 && mp_last->sb_prev != NULL; ++i)
2473 mp_last = msg_sb_start(mp_last->sb_prev);
2474 }
2475
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002476 State = ASKMORE;
2477#ifdef FEAT_MOUSE
2478 setmouse();
2479#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002480 if (typed_char == NUL)
2481 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002482 for (;;)
2483 {
2484 /*
2485 * Get a typed character directly from the user.
2486 */
2487 if (used_typed_char != NUL)
2488 {
2489 c = used_typed_char; /* was typed at hit-enter prompt */
2490 used_typed_char = NUL;
2491 }
2492 else
2493 c = get_keystroke();
2494
2495#if defined(FEAT_MENU) && defined(FEAT_GUI)
2496 if (c == K_MENU)
2497 {
2498 int idx = get_menu_index(current_menu, ASKMORE);
2499
2500 /* Used a menu. If it starts with CTRL-Y, it must
2501 * be a "Copy" for the clipboard. Otherwise
2502 * assume that we end */
2503 if (idx == MENU_INDEX_INVALID)
2504 continue;
2505 c = *current_menu->strings[idx];
2506 if (c != NUL && current_menu->strings[idx][1] != NUL)
2507 ins_typebuf(current_menu->strings[idx] + 1,
2508 current_menu->noremap[idx], 0, TRUE,
2509 current_menu->silent[idx]);
2510 }
2511#endif
2512
2513 scroll = 0;
2514 switch (c)
2515 {
2516 case BS: /* scroll one line back */
2517 case K_BS:
2518 case 'k':
2519 case K_UP:
2520 scroll = -1;
2521 break;
2522
2523 case CAR: /* one extra line */
2524 case NL:
2525 case 'j':
2526 case K_DOWN:
2527 scroll = 1;
2528 break;
2529
2530 case 'u': /* Up half a page */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002531 scroll = -(Rows / 2);
2532 break;
2533
2534 case 'd': /* Down half a page */
2535 scroll = Rows / 2;
2536 break;
2537
2538 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002539 case K_PAGEUP:
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002540 scroll = -(Rows - 1);
2541 break;
2542
2543 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002544 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002545 case K_PAGEDOWN:
2546 case K_LEFTMOUSE:
2547 scroll = Rows - 1;
2548 break;
2549
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002550 case 'g': /* all the way back to the start */
2551 scroll = -999999;
2552 break;
2553
2554 case 'G': /* all the way to the end */
2555 scroll = 999999;
2556 lines_left = 999999;
2557 break;
2558
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002559 case ':': /* start new command line */
2560#ifdef FEAT_CON_DIALOG
2561 if (!confirm_msg_used)
2562#endif
2563 {
2564 /* Since got_int is set all typeahead will be flushed, but we
2565 * want to keep this ':', remember that in a special way. */
2566 typeahead_noflush(':');
2567 cmdline_row = Rows - 1; /* put ':' on this line */
2568 skip_redraw = TRUE; /* skip redraw once */
2569 need_wait_return = FALSE; /* don't wait in main() */
2570 }
2571 /*FALLTHROUGH*/
2572 case 'q': /* quit */
2573 case Ctrl_C:
2574 case ESC:
2575#ifdef FEAT_CON_DIALOG
2576 if (confirm_msg_used)
2577 {
2578 /* Jump to the choices of the dialog. */
2579 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002580 }
2581 else
2582#endif
2583 {
2584 got_int = TRUE;
2585 quit_more = TRUE;
2586 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002587 /* When there is some more output (wrapping line) display that
2588 * without another prompt. */
2589 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002590 break;
2591
2592#ifdef FEAT_CLIPBOARD
2593 case Ctrl_Y:
2594 /* Strange way to allow copying (yanking) a modeless
2595 * selection at the more prompt. Use CTRL-Y,
2596 * because the same is used in Cmdline-mode and at the
2597 * hit-enter prompt. However, scrolling one line up
2598 * might be expected... */
2599 if (clip_star.state == SELECT_DONE)
2600 clip_copy_modeless_selection(TRUE);
2601 continue;
2602#endif
2603 default: /* no valid response */
2604 msg_moremsg(TRUE);
2605 continue;
2606 }
2607
2608 if (scroll != 0)
2609 {
2610 if (scroll < 0)
2611 {
2612 /* go to start of last line */
2613 if (mp_last == NULL)
2614 mp = msg_sb_start(last_msgchunk);
2615 else if (mp_last->sb_prev != NULL)
2616 mp = msg_sb_start(mp_last->sb_prev);
2617 else
2618 mp = NULL;
2619
2620 /* go to start of line at top of the screen */
2621 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2622 ++i)
2623 mp = msg_sb_start(mp->sb_prev);
2624
2625 if (mp != NULL && mp->sb_prev != NULL)
2626 {
2627 /* Find line to be displayed at top. */
2628 for (i = 0; i > scroll; --i)
2629 {
2630 if (mp == NULL || mp->sb_prev == NULL)
2631 break;
2632 mp = msg_sb_start(mp->sb_prev);
2633 if (mp_last == NULL)
2634 mp_last = msg_sb_start(last_msgchunk);
2635 else
2636 mp_last = msg_sb_start(mp_last->sb_prev);
2637 }
2638
2639 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2640 (int)Rows, NULL) == OK)
2641 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002642 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002643 (void)disp_sb_line(0, mp);
2644 }
2645 else
2646 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002647 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002648 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002649 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2650 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002651 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002652 ++msg_scrolled;
2653 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002654 }
2655 scroll = 0;
2656 }
2657 }
2658 else
2659 {
2660 /* First display any text that we scrolled back. */
2661 while (scroll > 0 && mp_last != NULL)
2662 {
2663 /* scroll up, display line at bottom */
2664 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002665 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002666 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2667 (int)Columns, ' ', ' ', 0);
2668 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2669 --scroll;
2670 }
2671 }
2672
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002673 if (scroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002674 {
2675 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002676 screen_fill((int)Rows - 1, (int)Rows, 0,
2677 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002678 msg_moremsg(FALSE);
2679 continue;
2680 }
2681
2682 /* display more text, return to caller */
2683 lines_left = scroll;
2684 }
2685
2686 break;
2687 }
2688
2689 /* clear the --more-- message */
2690 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2691 State = oldState;
2692#ifdef FEAT_MOUSE
2693 setmouse();
2694#endif
2695 if (quit_more)
2696 {
2697 msg_row = Rows - 1;
2698 msg_col = 0;
2699 }
2700#ifdef FEAT_RIGHTLEFT
2701 else if (cmdmsg_rl)
2702 msg_col = Columns - 1;
2703#endif
2704
2705#ifdef FEAT_CON_DIALOG
2706 return retval;
2707#else
2708 return FALSE;
2709#endif
2710}
2711
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2713
2714#ifdef mch_errmsg
2715# undef mch_errmsg
2716#endif
2717#ifdef mch_msg
2718# undef mch_msg
2719#endif
2720
2721/*
2722 * Give an error message. To be used when the screen hasn't been initialized
2723 * yet. When stderr can't be used, collect error messages until the GUI has
2724 * started and they can be displayed in a message box.
2725 */
2726 void
2727mch_errmsg(str)
2728 char *str;
2729{
2730 int len;
2731
2732#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2733 /* On Unix use stderr if it's a tty.
2734 * When not going to start the GUI also use stderr.
2735 * On Mac, when started from Finder, stderr is the console. */
2736 if (
2737# ifdef UNIX
2738# ifdef MACOS_X_UNIX
2739 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2740# else
2741 isatty(2)
2742# endif
2743# ifdef FEAT_GUI
2744 ||
2745# endif
2746# endif
2747# ifdef FEAT_GUI
2748 !(gui.in_use || gui.starting)
2749# endif
2750 )
2751 {
2752 fprintf(stderr, "%s", str);
2753 return;
2754 }
2755#endif
2756
2757 /* avoid a delay for a message that isn't there */
2758 emsg_on_display = FALSE;
2759
2760 len = (int)STRLEN(str) + 1;
2761 if (error_ga.ga_growsize == 0)
2762 {
2763 error_ga.ga_growsize = 80;
2764 error_ga.ga_itemsize = 1;
2765 }
2766 if (ga_grow(&error_ga, len) == OK)
2767 {
2768 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2769 (char_u *)str, len);
2770#ifdef UNIX
2771 /* remove CR characters, they are displayed */
2772 {
2773 char_u *p;
2774
2775 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2776 for (;;)
2777 {
2778 p = vim_strchr(p, '\r');
2779 if (p == NULL)
2780 break;
2781 *p = ' ';
2782 }
2783 }
2784#endif
2785 --len; /* don't count the NUL at the end */
2786 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 }
2788}
2789
2790/*
2791 * Give a message. To be used when the screen hasn't been initialized yet.
2792 * When there is no tty, collect messages until the GUI has started and they
2793 * can be displayed in a message box.
2794 */
2795 void
2796mch_msg(str)
2797 char *str;
2798{
2799#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2800 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2801 * uses mch_errmsg() when started from the desktop.
2802 * When not going to start the GUI also use stdout.
2803 * On Mac, when started from Finder, stderr is the console. */
2804 if (
2805# ifdef UNIX
2806# ifdef MACOS_X_UNIX
2807 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2808# else
2809 isatty(2)
2810# endif
2811# ifdef FEAT_GUI
2812 ||
2813# endif
2814# endif
2815# ifdef FEAT_GUI
2816 !(gui.in_use || gui.starting)
2817# endif
2818 )
2819 {
2820 printf("%s", str);
2821 return;
2822 }
2823# endif
2824 mch_errmsg(str);
2825}
2826#endif /* USE_MCH_ERRMSG */
2827
2828/*
2829 * Put a character on the screen at the current message position and advance
2830 * to the next position. Only for printable ASCII!
2831 */
2832 static void
2833msg_screen_putchar(c, attr)
2834 int c;
2835 int attr;
2836{
2837 msg_didout = TRUE; /* remember that line is not empty */
2838 screen_putchar(c, msg_row, msg_col, attr);
2839#ifdef FEAT_RIGHTLEFT
2840 if (cmdmsg_rl)
2841 {
2842 if (--msg_col == 0)
2843 {
2844 msg_col = Columns;
2845 ++msg_row;
2846 }
2847 }
2848 else
2849#endif
2850 {
2851 if (++msg_col >= Columns)
2852 {
2853 msg_col = 0;
2854 ++msg_row;
2855 }
2856 }
2857}
2858
2859 void
2860msg_moremsg(full)
2861 int full;
2862{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002863 int attr;
2864 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865
2866 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002867 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002869 screen_puts((char_u *)
2870 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2871 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872}
2873
2874/*
2875 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2876 * exmode_active.
2877 */
2878 void
2879repeat_message()
2880{
2881 if (State == ASKMORE)
2882 {
2883 msg_moremsg(TRUE); /* display --more-- message again */
2884 msg_row = Rows - 1;
2885 }
2886#ifdef FEAT_CON_DIALOG
2887 else if (State == CONFIRM)
2888 {
2889 display_confirm_msg(); /* display ":confirm" message again */
2890 msg_row = Rows - 1;
2891 }
2892#endif
2893 else if (State == EXTERNCMD)
2894 {
2895 windgoto(msg_row, msg_col); /* put cursor back */
2896 }
2897 else if (State == HITRETURN || State == SETWSIZE)
2898 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002899 if (msg_row == Rows - 1)
2900 {
2901 /* Avoid drawing the "hit-enter" prompt below the previous one,
2902 * overwrite it. Esp. useful when regaining focus and a
2903 * FocusGained autocmd exists but didn't draw anything. */
2904 msg_didout = FALSE;
2905 msg_col = 0;
2906 msg_clr_eos();
2907 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 hit_return_msg();
2909 msg_row = Rows - 1;
2910 }
2911}
2912
2913/*
2914 * msg_check_screen - check if the screen is initialized.
2915 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2916 * While starting the GUI the terminal codes will be set for the GUI, but the
2917 * output goes to the terminal. Don't use the terminal codes then.
2918 */
2919 static int
2920msg_check_screen()
2921{
2922 if (!full_screen || !screen_valid(FALSE))
2923 return FALSE;
2924
2925 if (msg_row >= Rows)
2926 msg_row = Rows - 1;
2927 if (msg_col >= Columns)
2928 msg_col = Columns - 1;
2929 return TRUE;
2930}
2931
2932/*
2933 * Clear from current message position to end of screen.
2934 * Skip this when ":silent" was used, no need to clear for redirection.
2935 */
2936 void
2937msg_clr_eos()
2938{
2939 if (msg_silent == 0)
2940 msg_clr_eos_force();
2941}
2942
2943/*
2944 * Clear from current message position to end of screen.
2945 * Note: msg_col is not updated, so we remember the end of the message
2946 * for msg_check().
2947 */
2948 void
2949msg_clr_eos_force()
2950{
2951 if (msg_use_printf())
2952 {
2953 if (full_screen) /* only when termcap codes are valid */
2954 {
2955 if (*T_CD)
2956 out_str(T_CD); /* clear to end of display */
2957 else if (*T_CE)
2958 out_str(T_CE); /* clear to end of line */
2959 }
2960 }
2961 else
2962 {
2963#ifdef FEAT_RIGHTLEFT
2964 if (cmdmsg_rl)
2965 {
2966 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2967 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2968 }
2969 else
2970#endif
2971 {
2972 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2973 ' ', ' ', 0);
2974 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2975 }
2976 }
2977}
2978
2979/*
2980 * Clear the command line.
2981 */
2982 void
2983msg_clr_cmdline()
2984{
2985 msg_row = cmdline_row;
2986 msg_col = 0;
2987 msg_clr_eos_force();
2988}
2989
2990/*
2991 * end putting a message on the screen
2992 * call wait_return if the message does not fit in the available space
2993 * return TRUE if wait_return not called.
2994 */
2995 int
2996msg_end()
2997{
2998 /*
2999 * if the string is larger than the window,
3000 * or the ruler option is set and we run into it,
3001 * we have to redraw the window.
3002 * Do not do this if we are abandoning the file or editing the command line.
3003 */
3004 if (!exiting && need_wait_return && !(State & CMDLINE))
3005 {
3006 wait_return(FALSE);
3007 return FALSE;
3008 }
3009 out_flush();
3010 return TRUE;
3011}
3012
3013/*
3014 * If the written message runs into the shown command or ruler, we have to
3015 * wait for hit-return and redraw the window later.
3016 */
3017 void
3018msg_check()
3019{
3020 if (msg_row == Rows - 1 && msg_col >= sc_col)
3021 {
3022 need_wait_return = TRUE;
3023 redraw_cmdline = TRUE;
3024 }
3025}
3026
3027/*
3028 * May write a string to the redirection file.
3029 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3030 */
3031 static void
3032redir_write(str, maxlen)
3033 char_u *str;
3034 int maxlen;
3035{
3036 char_u *s = str;
3037 static int cur_col = 0;
3038
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003039 /* Don't do anything for displaying prompts and the like. */
3040 if (redir_off)
3041 return;
3042
3043 /*
3044 * If 'verbosefile' is set write message in that file.
3045 * Must come before the rest because of updating "msg_col".
3046 */
3047 if (*p_vfile != NUL)
3048 verbose_write(s, maxlen);
3049
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003050 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 {
3052 /* If the string doesn't start with CR or NL, go to msg_col */
3053 if (*s != '\n' && *s != '\r')
3054 {
3055 while (cur_col < msg_col)
3056 {
3057#ifdef FEAT_EVAL
3058 if (redir_reg)
3059 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003060 else if (redir_vname)
3061 var_redir_str((char_u *)" ", -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 else if (redir_fd)
3063#endif
3064 fputs(" ", redir_fd);
3065 ++cur_col;
3066 }
3067 }
3068
3069#ifdef FEAT_EVAL
3070 if (redir_reg)
3071 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003072 if (redir_vname)
3073 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074#endif
3075
3076 /* Adjust the current column */
3077 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3078 {
3079#ifdef FEAT_EVAL
Bram Moolenaardf177f62005-02-22 08:39:57 +00003080 if (!redir_reg && !redir_vname && redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081#endif
3082 putc(*s, redir_fd);
3083 if (*s == '\r' || *s == '\n')
3084 cur_col = 0;
3085 else if (*s == '\t')
3086 cur_col += (8 - cur_col % 8);
3087 else
3088 ++cur_col;
3089 ++s;
3090 }
3091
3092 if (msg_silent != 0) /* should update msg_col */
3093 msg_col = cur_col;
3094 }
3095}
3096
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003097 int
3098redirecting()
3099{
3100 return redir_fd != NULL
3101#ifdef FEAT_EVAL
3102 || redir_reg || redir_vname
3103#endif
3104 ;
3105}
3106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003108 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003109 * Must always be called paired with verbose_leave()!
3110 */
3111 void
3112verbose_enter()
3113{
3114 if (*p_vfile != NUL)
3115 ++msg_silent;
3116}
3117
3118/*
3119 * After giving verbose message.
3120 * Must always be called paired with verbose_enter()!
3121 */
3122 void
3123verbose_leave()
3124{
3125 if (*p_vfile != NUL)
3126 if (--msg_silent < 0)
3127 msg_silent = 0;
3128}
3129
3130/*
3131 * Like verbose_enter() and set msg_scroll when displaying the message.
3132 */
3133 void
3134verbose_enter_scroll()
3135{
3136 if (*p_vfile != NUL)
3137 ++msg_silent;
3138 else
3139 /* always scroll up, don't overwrite */
3140 msg_scroll = TRUE;
3141}
3142
3143/*
3144 * Like verbose_leave() and set cmdline_row when displaying the message.
3145 */
3146 void
3147verbose_leave_scroll()
3148{
3149 if (*p_vfile != NUL)
3150 {
3151 if (--msg_silent < 0)
3152 msg_silent = 0;
3153 }
3154 else
3155 cmdline_row = msg_row;
3156}
3157
3158static FILE *verbose_fd = NULL;
3159static int verbose_did_open = FALSE;
3160
3161/*
3162 * Called when 'verbosefile' is set: stop writing to the file.
3163 */
3164 void
3165verbose_stop()
3166{
3167 if (verbose_fd != NULL)
3168 {
3169 fclose(verbose_fd);
3170 verbose_fd = NULL;
3171 }
3172 verbose_did_open = FALSE;
3173}
3174
3175/*
3176 * Open the file 'verbosefile'.
3177 * Return FAIL or OK.
3178 */
3179 int
3180verbose_open()
3181{
3182 if (verbose_fd == NULL && !verbose_did_open)
3183 {
3184 /* Only give the error message once. */
3185 verbose_did_open = TRUE;
3186
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003187 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003188 if (verbose_fd == NULL)
3189 {
3190 EMSG2(_(e_notopen), p_vfile);
3191 return FAIL;
3192 }
3193 }
3194 return OK;
3195}
3196
3197/*
3198 * Write a string to 'verbosefile'.
3199 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3200 */
3201 static void
3202verbose_write(str, maxlen)
3203 char_u *str;
3204 int maxlen;
3205{
3206 char_u *s = str;
3207 static int cur_col = 0;
3208
3209 /* Open the file when called the first time. */
3210 if (verbose_fd == NULL)
3211 verbose_open();
3212
3213 if (verbose_fd != NULL)
3214 {
3215 /* If the string doesn't start with CR or NL, go to msg_col */
3216 if (*s != '\n' && *s != '\r')
3217 {
3218 while (cur_col < msg_col)
3219 {
3220 fputs(" ", verbose_fd);
3221 ++cur_col;
3222 }
3223 }
3224
3225 /* Adjust the current column */
3226 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3227 {
3228 putc(*s, verbose_fd);
3229 if (*s == '\r' || *s == '\n')
3230 cur_col = 0;
3231 else if (*s == '\t')
3232 cur_col += (8 - cur_col % 8);
3233 else
3234 ++cur_col;
3235 ++s;
3236 }
3237 }
3238}
3239
3240/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 * Give a warning message (for searching).
3242 * Use 'w' highlighting and may repeat the message after redrawing
3243 */
3244 void
3245give_warning(message, hl)
3246 char_u *message;
3247 int hl;
3248{
3249 /* Don't do this for ":silent". */
3250 if (msg_silent != 0)
3251 return;
3252
3253 /* Don't want a hit-enter prompt here. */
3254 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003255
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256#ifdef FEAT_EVAL
3257 set_vim_var_string(VV_WARNINGMSG, message, -1);
3258#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 vim_free(keep_msg);
3260 keep_msg = NULL;
3261 if (hl)
3262 keep_msg_attr = hl_attr(HLF_W);
3263 else
3264 keep_msg_attr = 0;
3265 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003266 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 msg_didout = FALSE; /* overwrite this message */
3268 msg_nowait = TRUE; /* don't wait for this message */
3269 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003270
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 --no_wait_return;
3272}
3273
3274/*
3275 * Advance msg cursor to column "col".
3276 */
3277 void
3278msg_advance(col)
3279 int col;
3280{
3281 if (msg_silent != 0) /* nothing to advance to */
3282 {
3283 msg_col = col; /* for redirection, may fill it up later */
3284 return;
3285 }
3286 if (col >= Columns) /* not enough room */
3287 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003288#ifdef FEAT_RIGHTLEFT
3289 if (cmdmsg_rl)
3290 while (msg_col > Columns - col)
3291 msg_putchar(' ');
3292 else
3293#endif
3294 while (msg_col < col)
3295 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296}
3297
3298#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3299/*
3300 * Used for "confirm()" function, and the :confirm command prefix.
3301 * Versions which haven't got flexible dialogs yet, and console
3302 * versions, get this generic handler which uses the command line.
3303 *
3304 * type = one of:
3305 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3306 * title = title string (can be NULL for default)
3307 * (neither used in console dialogs at the moment)
3308 *
3309 * Format of the "buttons" string:
3310 * "Button1Name\nButton2Name\nButton3Name"
3311 * The first button should normally be the default/accept
3312 * The second button should be the 'Cancel' button
3313 * Other buttons- use your imagination!
3314 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3315 * different letter.
3316 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 int
3318do_dialog(type, title, message, buttons, dfltbutton, textfield)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003319 int type UNUSED;
3320 char_u *title UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 char_u *message;
3322 char_u *buttons;
3323 int dfltbutton;
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003324 char_u *textfield UNUSED; /* IObuff for inputdialog(), NULL
3325 otherwise */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326{
3327 int oldState;
3328 int retval = 0;
3329 char_u *hotkeys;
3330 int c;
3331 int i;
3332
3333#ifndef NO_CONSOLE
3334 /* Don't output anything in silent mode ("ex -s") */
3335 if (silent_mode)
3336 return dfltbutton; /* return default option */
3337#endif
3338
3339#ifdef FEAT_GUI_DIALOG
3340 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3341 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3342 {
3343 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
3344 textfield);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003345 /* avoid a hit-enter prompt without clearing the cmdline */
3346 need_wait_return = FALSE;
3347 emsg_on_display = FALSE;
3348 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349
3350 /* Flush output to avoid that further messages and redrawing is done
3351 * in the wrong order. */
3352 out_flush();
3353 gui_mch_update();
3354
3355 return c;
3356 }
3357#endif
3358
3359 oldState = State;
3360 State = CONFIRM;
3361#ifdef FEAT_MOUSE
3362 setmouse();
3363#endif
3364
3365 /*
3366 * Since we wait for a keypress, don't make the
3367 * user press RETURN as well afterwards.
3368 */
3369 ++no_wait_return;
3370 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3371
3372 if (hotkeys != NULL)
3373 {
3374 for (;;)
3375 {
3376 /* Get a typed character directly from the user. */
3377 c = get_keystroke();
3378 switch (c)
3379 {
3380 case CAR: /* User accepts default option */
3381 case NL:
3382 retval = dfltbutton;
3383 break;
3384 case Ctrl_C: /* User aborts/cancels */
3385 case ESC:
3386 retval = 0;
3387 break;
3388 default: /* Could be a hotkey? */
3389 if (c < 0) /* special keys are ignored here */
3390 continue;
3391 /* Make the character lowercase, as chars in "hotkeys" are. */
3392 c = MB_TOLOWER(c);
3393 retval = 1;
3394 for (i = 0; hotkeys[i]; ++i)
3395 {
3396#ifdef FEAT_MBYTE
3397 if (has_mbyte)
3398 {
3399 if ((*mb_ptr2char)(hotkeys + i) == c)
3400 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003401 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 }
3403 else
3404#endif
3405 if (hotkeys[i] == c)
3406 break;
3407 ++retval;
3408 }
3409 if (hotkeys[i])
3410 break;
3411 /* No hotkey match, so keep waiting */
3412 continue;
3413 }
3414 break;
3415 }
3416
3417 vim_free(hotkeys);
3418 }
3419
3420 State = oldState;
3421#ifdef FEAT_MOUSE
3422 setmouse();
3423#endif
3424 --no_wait_return;
3425 msg_end_prompt();
3426
3427 return retval;
3428}
3429
3430static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3431
3432/*
3433 * Copy one character from "*from" to "*to", taking care of multi-byte
3434 * characters. Return the length of the character in bytes.
3435 */
3436 static int
3437copy_char(from, to, lowercase)
3438 char_u *from;
3439 char_u *to;
3440 int lowercase; /* make character lower case */
3441{
3442#ifdef FEAT_MBYTE
3443 int len;
3444 int c;
3445
3446 if (has_mbyte)
3447 {
3448 if (lowercase)
3449 {
3450 c = MB_TOLOWER((*mb_ptr2char)(from));
3451 return (*mb_char2bytes)(c, to);
3452 }
3453 else
3454 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003455 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 mch_memmove(to, from, (size_t)len);
3457 return len;
3458 }
3459 }
3460 else
3461#endif
3462 {
3463 if (lowercase)
3464 *to = (char_u)TOLOWER_LOC(*from);
3465 else
3466 *to = *from;
3467 return 1;
3468 }
3469}
3470
3471/*
3472 * Format the dialog string, and display it at the bottom of
3473 * the screen. Return a string of hotkey chars (if defined) for
3474 * each 'button'. If a button has no hotkey defined, the first character of
3475 * the button is used.
3476 * The hotkeys can be multi-byte characters, but without combining chars.
3477 *
3478 * Returns an allocated string with hotkeys, or NULL for error.
3479 */
3480 static char_u *
3481msg_show_console_dialog(message, buttons, dfltbutton)
3482 char_u *message;
3483 char_u *buttons;
3484 int dfltbutton;
3485{
3486 int len = 0;
3487#ifdef FEAT_MBYTE
3488# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3489#else
3490# define HOTK_LEN 1
3491#endif
3492 int lenhotkey = HOTK_LEN; /* count first button */
3493 char_u *hotk = NULL;
3494 char_u *msgp = NULL;
3495 char_u *hotkp = NULL;
3496 char_u *r;
3497 int copy;
3498#define HAS_HOTKEY_LEN 30
3499 char_u has_hotkey[HAS_HOTKEY_LEN];
3500 int first_hotkey = FALSE; /* first char of button is hotkey */
3501 int idx;
3502
3503 has_hotkey[0] = FALSE;
3504
3505 /*
3506 * First loop: compute the size of memory to allocate.
3507 * Second loop: copy to the allocated memory.
3508 */
3509 for (copy = 0; copy <= 1; ++copy)
3510 {
3511 r = buttons;
3512 idx = 0;
3513 while (*r)
3514 {
3515 if (*r == DLG_BUTTON_SEP)
3516 {
3517 if (copy)
3518 {
3519 *msgp++ = ',';
3520 *msgp++ = ' '; /* '\n' -> ', ' */
3521
3522 /* advance to next hotkey and set default hotkey */
3523#ifdef FEAT_MBYTE
3524 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003525 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 else
3527#endif
3528 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003529 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 if (dfltbutton)
3531 --dfltbutton;
3532
3533 /* If no hotkey is specified first char is used. */
3534 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3535 first_hotkey = TRUE;
3536 }
3537 else
3538 {
3539 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3540 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3541 if (idx < HAS_HOTKEY_LEN - 1)
3542 has_hotkey[++idx] = FALSE;
3543 }
3544 }
3545 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3546 {
3547 if (*r == DLG_HOTKEY_CHAR)
3548 ++r;
3549 first_hotkey = FALSE;
3550 if (copy)
3551 {
3552 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3553 *msgp++ = *r;
3554 else
3555 {
3556 /* '&a' -> '[a]' */
3557 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3558 msgp += copy_char(r, msgp, FALSE);
3559 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3560
3561 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003562 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 }
3564 }
3565 else
3566 {
3567 ++len; /* '&a' -> '[a]' */
3568 if (idx < HAS_HOTKEY_LEN - 1)
3569 has_hotkey[idx] = TRUE;
3570 }
3571 }
3572 else
3573 {
3574 /* everything else copy literally */
3575 if (copy)
3576 msgp += copy_char(r, msgp, FALSE);
3577 }
3578
3579 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003580 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 }
3582
3583 if (copy)
3584 {
3585 *msgp++ = ':';
3586 *msgp++ = ' ';
3587 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 }
3589 else
3590 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003591 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003592 + 2 /* for the NL's */
3593 + STRLEN(buttons)
3594 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003595 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596
3597 /* If no hotkey is specified first char is used. */
3598 if (!has_hotkey[0])
3599 {
3600 first_hotkey = TRUE;
3601 len += 2; /* "x" -> "[x]" */
3602 }
3603
3604 /*
3605 * Now allocate and load the strings
3606 */
3607 vim_free(confirm_msg);
3608 confirm_msg = alloc(len);
3609 if (confirm_msg == NULL)
3610 return NULL;
3611 *confirm_msg = NUL;
3612 hotk = alloc(lenhotkey);
3613 if (hotk == NULL)
3614 return NULL;
3615
3616 *confirm_msg = '\n';
3617 STRCPY(confirm_msg + 1, message);
3618
3619 msgp = confirm_msg + 1 + STRLEN(message);
3620 hotkp = hotk;
3621
Bram Moolenaar6a516062007-07-05 08:11:42 +00003622 /* Define first default hotkey. Keep the hotkey string NUL
3623 * terminated to avoid reading past the end. */
3624 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625
3626 /* Remember where the choices start, displaying starts here when
3627 * "hotkp" typed at the more prompt. */
3628 confirm_msg_tail = msgp;
3629 *msgp++ = '\n';
3630 }
3631 }
3632
3633 display_confirm_msg();
3634 return hotk;
3635}
3636
3637/*
3638 * Display the ":confirm" message. Also called when screen resized.
3639 */
3640 void
3641display_confirm_msg()
3642{
3643 /* avoid that 'q' at the more prompt truncates the message here */
3644 ++confirm_msg_used;
3645 if (confirm_msg != NULL)
3646 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3647 --confirm_msg_used;
3648}
3649
3650#endif /* FEAT_CON_DIALOG */
3651
3652#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3653
3654 int
3655vim_dialog_yesno(type, title, message, dflt)
3656 int type;
3657 char_u *title;
3658 char_u *message;
3659 int dflt;
3660{
3661 if (do_dialog(type,
3662 title == NULL ? (char_u *)_("Question") : title,
3663 message,
3664 (char_u *)_("&Yes\n&No"), dflt, NULL) == 1)
3665 return VIM_YES;
3666 return VIM_NO;
3667}
3668
3669 int
3670vim_dialog_yesnocancel(type, title, message, dflt)
3671 int type;
3672 char_u *title;
3673 char_u *message;
3674 int dflt;
3675{
3676 switch (do_dialog(type,
3677 title == NULL ? (char_u *)_("Question") : title,
3678 message,
3679 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL))
3680 {
3681 case 1: return VIM_YES;
3682 case 2: return VIM_NO;
3683 }
3684 return VIM_CANCEL;
3685}
3686
3687 int
3688vim_dialog_yesnoallcancel(type, title, message, dflt)
3689 int type;
3690 char_u *title;
3691 char_u *message;
3692 int dflt;
3693{
3694 switch (do_dialog(type,
3695 title == NULL ? (char_u *)"Question" : title,
3696 message,
3697 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
3698 dflt, NULL))
3699 {
3700 case 1: return VIM_YES;
3701 case 2: return VIM_NO;
3702 case 3: return VIM_ALL;
3703 case 4: return VIM_DISCARDALL;
3704 }
3705 return VIM_CANCEL;
3706}
3707
3708#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3709
3710#if defined(FEAT_BROWSE) || defined(PROTO)
3711/*
3712 * Generic browse function. Calls gui_mch_browse() when possible.
3713 * Later this may pop-up a non-GUI file selector (external command?).
3714 */
3715 char_u *
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003716do_browse(flags, title, dflt, ext, initdir, filter, buf)
3717 int flags; /* BROWSE_SAVE and BROWSE_DIR */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 char_u *title; /* title for the window */
3719 char_u *dflt; /* default file name (may include directory) */
3720 char_u *ext; /* extension added */
3721 char_u *initdir; /* initial directory, NULL for current dir or
3722 when using path from "dflt" */
3723 char_u *filter; /* file name filter */
3724 buf_T *buf; /* buffer to read/write for */
3725{
3726 char_u *fname;
3727 static char_u *last_dir = NULL; /* last used directory */
3728 char_u *tofree = NULL;
3729 int save_browse = cmdmod.browse;
3730
3731 /* Must turn off browse to avoid that autocommands will get the
3732 * flag too! */
3733 cmdmod.browse = FALSE;
3734
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003735 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003737 if (flags & BROWSE_DIR)
3738 title = (char_u *)_("Select Directory dialog");
3739 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 title = (char_u *)_("Save File dialog");
3741 else
3742 title = (char_u *)_("Open File dialog");
3743 }
3744
3745 /* When no directory specified, use default file name, default dir, buffer
3746 * dir, last dir or current dir */
3747 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3748 {
3749 if (mch_isdir(dflt)) /* default file name is a directory */
3750 {
3751 initdir = dflt;
3752 dflt = NULL;
3753 }
3754 else if (gettail(dflt) != dflt) /* default file name includes a path */
3755 {
3756 tofree = vim_strsave(dflt);
3757 if (tofree != NULL)
3758 {
3759 initdir = tofree;
3760 *gettail(initdir) = NUL;
3761 dflt = gettail(dflt);
3762 }
3763 }
3764 }
3765
3766 if (initdir == NULL || *initdir == NUL)
3767 {
3768 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003769 if (STRCMP(p_bsdir, "last") != 0
3770 && STRCMP(p_bsdir, "buffer") != 0
3771 && STRCMP(p_bsdir, "current") != 0
3772 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 initdir = p_bsdir;
3774 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003775 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 && buf != NULL && buf->b_ffname != NULL)
3777 {
3778 if (dflt == NULL || *dflt == NUL)
3779 dflt = gettail(curbuf->b_ffname);
3780 tofree = vim_strsave(curbuf->b_ffname);
3781 if (tofree != NULL)
3782 {
3783 initdir = tofree;
3784 *gettail(initdir) = NUL;
3785 }
3786 }
3787 /* When 'browsedir' is "last", use dir from last browse */
3788 else if (*p_bsdir == 'l')
3789 initdir = last_dir;
3790 /* When 'browsedir is "current", use current directory. This is the
3791 * default already, leave initdir empty. */
3792 }
3793
3794# ifdef FEAT_GUI
3795 if (gui.in_use) /* when this changes, also adjust f_has()! */
3796 {
3797 if (filter == NULL
3798# ifdef FEAT_EVAL
3799 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3800 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3801# endif
3802 )
3803 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003804 if (flags & BROWSE_DIR)
3805 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003806# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003807 /* For systems that have a directory dialog. */
3808 fname = gui_mch_browsedir(title, initdir);
3809# else
3810 /* Generic solution for selecting a directory: select a file and
3811 * remove the file name. */
3812 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3813# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003814# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003815 /* Win32 adds a dummy file name, others return an arbitrary file
3816 * name. GTK+ 2 returns only the directory, */
3817 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3818 {
3819 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003820 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003821
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003822 if (tail == fname)
3823 *tail++ = '.'; /* use current dir */
3824 *tail = NUL;
3825 }
3826# endif
3827 }
3828 else
3829 fname = gui_mch_browse(flags & BROWSE_SAVE,
3830 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831
3832 /* We hang around in the dialog for a while, the user might do some
3833 * things to our files. The Win32 dialog allows deleting or renaming
3834 * a file, check timestamps. */
3835 need_check_timestamps = TRUE;
3836 did_check_timestamps = FALSE;
3837 }
3838 else
3839# endif
3840 {
3841 /* TODO: non-GUI file selector here */
3842 EMSG(_("E338: Sorry, no file browser in console mode"));
3843 fname = NULL;
3844 }
3845
3846 /* keep the directory for next time */
3847 if (fname != NULL)
3848 {
3849 vim_free(last_dir);
3850 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003851 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 {
3853 *gettail(last_dir) = NUL;
3854 if (*last_dir == NUL)
3855 {
3856 /* filename only returned, must be in current dir */
3857 vim_free(last_dir);
3858 last_dir = alloc(MAXPATHL);
3859 if (last_dir != NULL)
3860 mch_dirname(last_dir, MAXPATHL);
3861 }
3862 }
3863 }
3864
3865 vim_free(tofree);
3866 cmdmod.browse = save_browse;
3867
3868 return fname;
3869}
3870#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003871
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003872#if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3873static char *e_printf = N_("E766: Insufficient arguments for printf()");
3874
3875static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3876static char *tv_str __ARGS((typval_T *tvs, int *idxp));
Bram Moolenaara7241f52008-06-24 20:39:31 +00003877# ifdef FEAT_FLOAT
3878static double tv_float __ARGS((typval_T *tvs, int *idxp));
3879# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003880
3881/*
3882 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3883 */
3884 static long
3885tv_nr(tvs, idxp)
3886 typval_T *tvs;
3887 int *idxp;
3888{
3889 int idx = *idxp - 1;
3890 long n = 0;
3891 int err = FALSE;
3892
3893 if (tvs[idx].v_type == VAR_UNKNOWN)
3894 EMSG(_(e_printf));
3895 else
3896 {
3897 ++*idxp;
3898 n = get_tv_number_chk(&tvs[idx], &err);
3899 if (err)
3900 n = 0;
3901 }
3902 return n;
3903}
3904
3905/*
3906 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003907 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003908 */
3909 static char *
3910tv_str(tvs, idxp)
3911 typval_T *tvs;
3912 int *idxp;
3913{
3914 int idx = *idxp - 1;
3915 char *s = NULL;
3916
3917 if (tvs[idx].v_type == VAR_UNKNOWN)
3918 EMSG(_(e_printf));
3919 else
3920 {
3921 ++*idxp;
3922 s = (char *)get_tv_string_chk(&tvs[idx]);
3923 }
3924 return s;
3925}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003926
3927# ifdef FEAT_FLOAT
3928/*
3929 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3930 */
3931 static double
3932tv_float(tvs, idxp)
3933 typval_T *tvs;
3934 int *idxp;
3935{
3936 int idx = *idxp - 1;
3937 double f = 0;
3938
3939 if (tvs[idx].v_type == VAR_UNKNOWN)
3940 EMSG(_(e_printf));
3941 else
3942 {
3943 ++*idxp;
3944 if (tvs[idx].v_type == VAR_FLOAT)
3945 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003946 else if (tvs[idx].v_type == VAR_NUMBER)
3947 f = tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003948 else
3949 EMSG(_("E807: Expected Float argument for printf()"));
3950 }
3951 return f;
3952}
3953# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003954#endif
3955
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003956/*
3957 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003958 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003959 * consistency.
3960 *
3961 * This code is based on snprintf.c - a portable implementation of snprintf
3962 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003963 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003964 * The original code, including useful comments, can be found here:
3965 * http://www.ijs.si/software/snprintf/
3966 *
3967 * This snprintf() only supports the following conversion specifiers:
3968 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3969 * with flags: '-', '+', ' ', '0' and '#'.
3970 * An asterisk is supported for field width as well as precision.
3971 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00003972 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3973 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003974 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3975 * 'll' (long long int) is not supported.
3976 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003977 * The locale is not used, the string is used as a byte string. This is only
3978 * relevant for double-byte encodings where the second byte may be '%'.
3979 *
Bram Moolenaara2031822006-03-07 22:29:51 +00003980 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3981 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003982 *
3983 * The return value is the number of characters which would be generated
3984 * for the given input, excluding the trailing null. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00003985 * is greater or equal to "str_m", not all characters from the result
3986 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3987 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003988 * the resulting string will be null-terminated.
3989 */
3990
3991/*
3992 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003993 *
3994 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003995 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003996 */
3997
3998/* When generating prototypes all of this is skipped, cproto doesn't
3999 * understand this. */
4000#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004001
4002# ifdef HAVE_STDARG_H
4003/* Like vim_vsnprintf() but append to the string. */
4004 int
4005vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4006{
4007 va_list ap;
4008 int str_l;
4009 size_t len = STRLEN(str);
4010 size_t space;
4011
4012 if (str_m <= len)
4013 space = 0;
4014 else
4015 space = str_m - len;
4016 va_start(ap, fmt);
4017 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
4018 va_end(ap);
4019 return str_l;
4020}
4021# else
4022/* Like vim_vsnprintf() but append to the string. */
4023 int
4024vim_snprintf_add(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4025 char *str;
4026 size_t str_m;
4027 char *fmt;
4028 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4029{
4030 size_t len = STRLEN(str);
4031 size_t space;
4032
4033 if (str_m <= len)
4034 space = 0;
4035 else
4036 space = str_m - len;
4037 return vim_vsnprintf(str + len, space, fmt,
4038 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
4039}
4040# endif
4041
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004042# ifdef HAVE_STDARG_H
4043 int
4044vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4045{
4046 va_list ap;
4047 int str_l;
4048
4049 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004050 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004051 va_end(ap);
4052 return str_l;
4053}
4054
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004055 int
4056vim_vsnprintf(str, str_m, fmt, ap, tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004057# else
4058 /* clumsy way to work around missing va_list */
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004059# 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 +00004060
4061/* VARARGS */
4062 int
4063#ifdef __BORLANDC__
4064_RTLENTRYF
4065#endif
4066vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4067# endif
4068 char *str;
4069 size_t str_m;
4070 char *fmt;
4071# ifdef HAVE_STDARG_H
4072 va_list ap;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004073 typval_T *tvs;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004074# else
4075 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4076# endif
4077{
4078 size_t str_l = 0;
4079 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004080 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004081
4082 if (p == NULL)
4083 p = "";
4084 while (*p != NUL)
4085 {
4086 if (*p != '%')
4087 {
4088 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004089 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004090
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004091 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004092 if (str_l < str_m)
4093 {
4094 size_t avail = str_m - str_l;
4095
4096 mch_memmove(str + str_l, p, n > avail ? avail : n);
4097 }
4098 p += n;
4099 str_l += n;
4100 }
4101 else
4102 {
4103 size_t min_field_width = 0, precision = 0;
4104 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4105 int alternate_form = 0, force_sign = 0;
4106
4107 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4108 * ignored. */
4109 int space_for_positive = 1;
4110
4111 /* allowed values: \0, h, l, L */
4112 char length_modifier = '\0';
4113
4114 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004115#ifdef FEAT_FLOAT
4116# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
4117 * That sounds reasonable to use as the maximum
4118 * printable. */
4119#else
4120# define TMP_LEN 32
4121#endif
4122 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004123
4124 /* string address in case of string argument */
4125 char *str_arg;
4126
4127 /* natural field width of arg without padding and sign */
4128 size_t str_arg_l;
4129
4130 /* unsigned char argument value - only defined for c conversion.
4131 * N.B. standard explicitly states the char argument for the c
4132 * conversion is unsigned */
4133 unsigned char uchar_arg;
4134
4135 /* number of zeros to be inserted for numeric conversions as
4136 * required by the precision or minimal field width */
4137 size_t number_of_zeros_to_pad = 0;
4138
4139 /* index into tmp where zero padding is to be inserted */
4140 size_t zero_padding_insertion_ind = 0;
4141
4142 /* current conversion specifier character */
4143 char fmt_spec = '\0';
4144
4145 str_arg = NULL;
4146 p++; /* skip '%' */
4147
4148 /* parse flags */
4149 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4150 || *p == '#' || *p == '\'')
4151 {
4152 switch (*p)
4153 {
4154 case '0': zero_padding = 1; break;
4155 case '-': justify_left = 1; break;
4156 case '+': force_sign = 1; space_for_positive = 0; break;
4157 case ' ': force_sign = 1;
4158 /* If both the ' ' and '+' flags appear, the ' '
4159 * flag should be ignored */
4160 break;
4161 case '#': alternate_form = 1; break;
4162 case '\'': break;
4163 }
4164 p++;
4165 }
4166 /* If the '0' and '-' flags both appear, the '0' flag should be
4167 * ignored. */
4168
4169 /* parse field width */
4170 if (*p == '*')
4171 {
4172 int j;
4173
4174 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004175 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004176#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004177 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004178#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004179# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004180 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004181# endif
4182 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004183#endif
4184 if (j >= 0)
4185 min_field_width = j;
4186 else
4187 {
4188 min_field_width = -j;
4189 justify_left = 1;
4190 }
4191 }
4192 else if (VIM_ISDIGIT((int)(*p)))
4193 {
4194 /* size_t could be wider than unsigned int; make sure we treat
4195 * argument like common implementations do */
4196 unsigned int uj = *p++ - '0';
4197
4198 while (VIM_ISDIGIT((int)(*p)))
4199 uj = 10 * uj + (unsigned int)(*p++ - '0');
4200 min_field_width = uj;
4201 }
4202
4203 /* parse precision */
4204 if (*p == '.')
4205 {
4206 p++;
4207 precision_specified = 1;
4208 if (*p == '*')
4209 {
4210 int j;
4211
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004212 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004213#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004214 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004215#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004216# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004217 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004218# endif
4219 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004220#endif
4221 p++;
4222 if (j >= 0)
4223 precision = j;
4224 else
4225 {
4226 precision_specified = 0;
4227 precision = 0;
4228 }
4229 }
4230 else if (VIM_ISDIGIT((int)(*p)))
4231 {
4232 /* size_t could be wider than unsigned int; make sure we
4233 * treat argument like common implementations do */
4234 unsigned int uj = *p++ - '0';
4235
4236 while (VIM_ISDIGIT((int)(*p)))
4237 uj = 10 * uj + (unsigned int)(*p++ - '0');
4238 precision = uj;
4239 }
4240 }
4241
4242 /* parse 'h', 'l' and 'll' length modifiers */
4243 if (*p == 'h' || *p == 'l')
4244 {
4245 length_modifier = *p;
4246 p++;
4247 if (length_modifier == 'l' && *p == 'l')
4248 {
4249 /* double l = long long */
4250 length_modifier = 'l'; /* treat it as a single 'l' */
4251 p++;
4252 }
4253 }
4254 fmt_spec = *p;
4255
4256 /* common synonyms: */
4257 switch (fmt_spec)
4258 {
4259 case 'i': fmt_spec = 'd'; break;
4260 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4261 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4262 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004263 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004264 default: break;
4265 }
4266
4267 /* get parameter value, do initial processing */
4268 switch (fmt_spec)
4269 {
4270 /* '%' and 'c' behave similar to 's' regarding flags and field
4271 * widths */
4272 case '%':
4273 case 'c':
4274 case 's':
4275 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004276 str_arg_l = 1;
4277 switch (fmt_spec)
4278 {
4279 case '%':
4280 str_arg = p;
4281 break;
4282
4283 case 'c':
4284 {
4285 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004286
4287 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004288#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004289 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004290#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004291# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004292 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004293# endif
4294 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004295#endif
4296 /* standard demands unsigned char */
4297 uchar_arg = (unsigned char)j;
4298 str_arg = (char *)&uchar_arg;
4299 break;
4300 }
4301
4302 case 's':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004303 str_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004304#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004305 (char *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004306#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004307# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004308 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004309# endif
4310 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004311#endif
4312 if (str_arg == NULL)
4313 {
4314 str_arg = "[NULL]";
4315 str_arg_l = 6;
4316 }
4317 /* make sure not to address string beyond the specified
4318 * precision !!! */
4319 else if (!precision_specified)
4320 str_arg_l = strlen(str_arg);
4321 /* truncate string if necessary as requested by precision */
4322 else if (precision == 0)
4323 str_arg_l = 0;
4324 else
4325 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004326 /* Don't put the #if inside memchr(), it can be a
4327 * macro. */
4328#if SIZEOF_INT <= 2
4329 char *q = memchr(str_arg, '\0', precision);
4330#else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004331 /* memchr on HP does not like n > 2^31 !!! */
4332 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004333 precision <= (size_t)0x7fffffffL ? precision
4334 : (size_t)0x7fffffffL);
Bram Moolenaar3991dab2006-03-27 17:01:56 +00004335#endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004336 str_arg_l = (q == NULL) ? precision
4337 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004338 }
4339 break;
4340
4341 default:
4342 break;
4343 }
4344 break;
4345
4346 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4347 {
4348 /* NOTE: the u, o, x, X and p conversion specifiers
4349 * imply the value is unsigned; d implies a signed
4350 * value */
4351
4352 /* 0 if numeric argument is zero (or if pointer is
4353 * NULL for 'p'), +1 if greater than zero (or nonzero
4354 * for unsigned arguments), -1 if negative (unsigned
4355 * argument is never negative) */
4356 int arg_sign = 0;
4357
4358 /* only defined for length modifier h, or for no
4359 * length modifiers */
4360 int int_arg = 0;
4361 unsigned int uint_arg = 0;
4362
4363 /* only defined for length modifier l */
4364 long int long_arg = 0;
4365 unsigned long int ulong_arg = 0;
4366
4367 /* pointer argument value -only defined for p
4368 * conversion */
4369 void *ptr_arg = NULL;
4370
4371 if (fmt_spec == 'p')
4372 {
4373 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004374 ptr_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004375#ifndef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004376 (void *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004377#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004378# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004379 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004380# endif
4381 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004382#endif
4383 if (ptr_arg != NULL)
4384 arg_sign = 1;
4385 }
4386 else if (fmt_spec == 'd')
4387 {
4388 /* signed */
4389 switch (length_modifier)
4390 {
4391 case '\0':
4392 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004393 /* char and short arguments are passed as int. */
4394 int_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004395#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004396 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004397#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004398# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004399 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004400# endif
4401 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004402#endif
4403 if (int_arg > 0)
4404 arg_sign = 1;
4405 else if (int_arg < 0)
4406 arg_sign = -1;
4407 break;
4408 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004409 long_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004410#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004411 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004412#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004413# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004414 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004415# endif
4416 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004417#endif
4418 if (long_arg > 0)
4419 arg_sign = 1;
4420 else if (long_arg < 0)
4421 arg_sign = -1;
4422 break;
4423 }
4424 }
4425 else
4426 {
4427 /* unsigned */
4428 switch (length_modifier)
4429 {
4430 case '\0':
4431 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004432 uint_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004433#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004434 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004435#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004436# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004437 tvs != NULL ? (unsigned)
4438 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004439# endif
4440 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004441#endif
4442 if (uint_arg != 0)
4443 arg_sign = 1;
4444 break;
4445 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004446 ulong_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004447#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004448 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004449#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004450# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004451 tvs != NULL ? (unsigned long)
4452 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004453# endif
4454 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004455#endif
4456 if (ulong_arg != 0)
4457 arg_sign = 1;
4458 break;
4459 }
4460 }
4461
4462 str_arg = tmp;
4463 str_arg_l = 0;
4464
4465 /* NOTE:
4466 * For d, i, u, o, x, and X conversions, if precision is
4467 * specified, the '0' flag should be ignored. This is so
4468 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4469 * FreeBSD, NetBSD; but not with Perl.
4470 */
4471 if (precision_specified)
4472 zero_padding = 0;
4473 if (fmt_spec == 'd')
4474 {
4475 if (force_sign && arg_sign >= 0)
4476 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4477 /* leave negative numbers for sprintf to handle, to
4478 * avoid handling tricky cases like (short int)-32768 */
4479 }
4480 else if (alternate_form)
4481 {
4482 if (arg_sign != 0
4483 && (fmt_spec == 'x' || fmt_spec == 'X') )
4484 {
4485 tmp[str_arg_l++] = '0';
4486 tmp[str_arg_l++] = fmt_spec;
4487 }
4488 /* alternate form should have no effect for p
4489 * conversion, but ... */
4490 }
4491
4492 zero_padding_insertion_ind = str_arg_l;
4493 if (!precision_specified)
4494 precision = 1; /* default precision is 1 */
4495 if (precision == 0 && arg_sign == 0)
4496 {
4497 /* When zero value is formatted with an explicit
4498 * precision 0, the resulting formatted string is
4499 * empty (d, i, u, o, x, X, p). */
4500 }
4501 else
4502 {
4503 char f[5];
4504 int f_l = 0;
4505
4506 /* construct a simple format string for sprintf */
4507 f[f_l++] = '%';
4508 if (!length_modifier)
4509 ;
4510 else if (length_modifier == '2')
4511 {
4512 f[f_l++] = 'l';
4513 f[f_l++] = 'l';
4514 }
4515 else
4516 f[f_l++] = length_modifier;
4517 f[f_l++] = fmt_spec;
4518 f[f_l++] = '\0';
4519
4520 if (fmt_spec == 'p')
4521 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4522 else if (fmt_spec == 'd')
4523 {
4524 /* signed */
4525 switch (length_modifier)
4526 {
4527 case '\0':
4528 case 'h': str_arg_l += sprintf(
4529 tmp + str_arg_l, f, int_arg);
4530 break;
4531 case 'l': str_arg_l += sprintf(
4532 tmp + str_arg_l, f, long_arg);
4533 break;
4534 }
4535 }
4536 else
4537 {
4538 /* unsigned */
4539 switch (length_modifier)
4540 {
4541 case '\0':
4542 case 'h': str_arg_l += sprintf(
4543 tmp + str_arg_l, f, uint_arg);
4544 break;
4545 case 'l': str_arg_l += sprintf(
4546 tmp + str_arg_l, f, ulong_arg);
4547 break;
4548 }
4549 }
4550
4551 /* include the optional minus sign and possible
4552 * "0x" in the region before the zero padding
4553 * insertion point */
4554 if (zero_padding_insertion_ind < str_arg_l
4555 && tmp[zero_padding_insertion_ind] == '-')
4556 zero_padding_insertion_ind++;
4557 if (zero_padding_insertion_ind + 1 < str_arg_l
4558 && tmp[zero_padding_insertion_ind] == '0'
4559 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4560 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4561 zero_padding_insertion_ind += 2;
4562 }
4563
4564 {
4565 size_t num_of_digits = str_arg_l
4566 - zero_padding_insertion_ind;
4567
4568 if (alternate_form && fmt_spec == 'o'
4569 /* unless zero is already the first
4570 * character */
4571 && !(zero_padding_insertion_ind < str_arg_l
4572 && tmp[zero_padding_insertion_ind] == '0'))
4573 {
4574 /* assure leading zero for alternate-form
4575 * octal numbers */
4576 if (!precision_specified
4577 || precision < num_of_digits + 1)
4578 {
4579 /* precision is increased to force the
4580 * first character to be zero, except if a
4581 * zero value is formatted with an
4582 * explicit precision of zero */
4583 precision = num_of_digits + 1;
4584 precision_specified = 1;
4585 }
4586 }
4587 /* zero padding to specified precision? */
4588 if (num_of_digits < precision)
4589 number_of_zeros_to_pad = precision - num_of_digits;
4590 }
4591 /* zero padding to specified minimal field width? */
4592 if (!justify_left && zero_padding)
4593 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004594 int n = (int)(min_field_width - (str_arg_l
4595 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004596 if (n > 0)
4597 number_of_zeros_to_pad += n;
4598 }
4599 break;
4600 }
4601
Bram Moolenaara7241f52008-06-24 20:39:31 +00004602#ifdef FEAT_FLOAT
4603 case 'f':
4604 case 'e':
4605 case 'E':
4606 case 'g':
4607 case 'G':
4608 {
4609 /* Floating point. */
4610 double f;
4611 double abs_f;
4612 char format[40];
4613 int l;
4614 int remove_trailing_zeroes = FALSE;
4615
4616 f =
4617# ifndef HAVE_STDARG_H
4618 get_a_arg(arg_idx);
4619# else
4620# if defined(FEAT_EVAL)
4621 tvs != NULL ? tv_float(tvs, &arg_idx) :
4622# endif
4623 va_arg(ap, double);
4624# endif
4625 abs_f = f < 0 ? -f : f;
4626
4627 if (fmt_spec == 'g' || fmt_spec == 'G')
4628 {
4629 /* Would be nice to use %g directly, but it prints
4630 * "1.0" as "1", we don't want that. */
4631 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4632 || abs_f == 0.0)
4633 fmt_spec = 'f';
4634 else
4635 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4636 remove_trailing_zeroes = TRUE;
4637 }
4638
Bram Moolenaarc9372132009-01-13 15:38:37 +00004639 if (fmt_spec == 'f' &&
4640#ifdef VAX
4641 abs_f > 1.0e38
4642#else
4643 abs_f > 1.0e307
4644#endif
4645 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004646 {
4647 /* Avoid a buffer overflow */
4648 strcpy(tmp, "inf");
4649 str_arg_l = 3;
4650 }
4651 else
4652 {
4653 format[0] = '%';
4654 l = 1;
4655 if (precision_specified)
4656 {
4657 size_t max_prec = TMP_LEN - 10;
4658
4659 /* Make sure we don't get more digits than we
4660 * have room for. */
4661 if (fmt_spec == 'f' && abs_f > 1.0)
4662 max_prec -= (size_t)log10(abs_f);
4663 if (precision > max_prec)
4664 precision = max_prec;
4665 l += sprintf(format + 1, ".%d", (int)precision);
4666 }
4667 format[l] = fmt_spec;
4668 format[l + 1] = NUL;
4669 str_arg_l = sprintf(tmp, format, f);
4670
4671 if (remove_trailing_zeroes)
4672 {
4673 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004674 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004675
4676 /* Using %g or %G: remove superfluous zeroes. */
4677 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004678 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004679 else
4680 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004681 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004682 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004683 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004684 {
4685 /* Remove superfluous '+' and leading
4686 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004687 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004688 {
4689 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004690 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004691 --str_arg_l;
4692 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004693 i = (tp[1] == '-') ? 2 : 1;
4694 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004695 {
4696 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004697 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004698 --str_arg_l;
4699 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004700 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004701 }
4702 }
4703
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004704 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004705 /* Remove trailing zeroes, but keep the one
4706 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004707 while (tp > tmp + 2 && *tp == '0'
4708 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004709 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004710 STRMOVE(tp, tp + 1);
4711 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004712 --str_arg_l;
4713 }
4714 }
4715 else
4716 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004717 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004718
4719 /* Be consistent: some printf("%e") use 1.0e+12
4720 * and some 1.0e+012. Remove one zero in the last
4721 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004722 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004723 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004724 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4725 && tp[2] == '0'
4726 && vim_isdigit(tp[3])
4727 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004728 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004729 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004730 --str_arg_l;
4731 }
4732 }
4733 }
4734 str_arg = tmp;
4735 break;
4736 }
4737#endif
4738
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004739 default:
4740 /* unrecognized conversion specifier, keep format string
4741 * as-is */
4742 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004743 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004744 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004745 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004746
4747 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004748 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004749 str_arg = p;
4750 str_arg_l = 0;
4751 if (*p != NUL)
4752 str_arg_l++; /* include invalid conversion specifier
4753 unchanged if not at end-of-string */
4754 break;
4755 }
4756
4757 if (*p != NUL)
4758 p++; /* step over the just processed conversion specifier */
4759
4760 /* insert padding to the left as requested by min_field_width;
4761 * this does not include the zero padding in case of numerical
4762 * conversions*/
4763 if (!justify_left)
4764 {
4765 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004766 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004767
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004768 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004769 {
4770 if (str_l < str_m)
4771 {
4772 size_t avail = str_m - str_l;
4773
4774 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004775 (size_t)pn > avail ? avail
4776 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004777 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004778 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004779 }
4780 }
4781
4782 /* zero padding as requested by the precision or by the minimal
4783 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004784 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004785 {
4786 /* will not copy first part of numeric right now, *
4787 * force it to be copied later in its entirety */
4788 zero_padding_insertion_ind = 0;
4789 }
4790 else
4791 {
4792 /* insert first part of numerics (sign or '0x') before zero
4793 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004794 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004795
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004796 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004797 {
4798 if (str_l < str_m)
4799 {
4800 size_t avail = str_m - str_l;
4801
4802 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004803 (size_t)zn > avail ? avail
4804 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004805 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004806 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004807 }
4808
4809 /* insert zero padding as requested by the precision or min
4810 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004811 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004812 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004813 {
4814 if (str_l < str_m)
4815 {
4816 size_t avail = str_m-str_l;
4817
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004818 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004819 (size_t)zn > avail ? avail
4820 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004821 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004822 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004823 }
4824 }
4825
4826 /* insert formatted string
4827 * (or as-is conversion specifier for unknown conversions) */
4828 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004829 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004830
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004831 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004832 {
4833 if (str_l < str_m)
4834 {
4835 size_t avail = str_m - str_l;
4836
4837 mch_memmove(str + str_l,
4838 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004839 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004840 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004841 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004842 }
4843 }
4844
4845 /* insert right padding */
4846 if (justify_left)
4847 {
4848 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004849 int pn = (int)(min_field_width
4850 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004851
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004852 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004853 {
4854 if (str_l < str_m)
4855 {
4856 size_t avail = str_m - str_l;
4857
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004858 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004859 (size_t)pn > avail ? avail
4860 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004861 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004862 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004863 }
4864 }
4865 }
4866 }
4867
4868 if (str_m > 0)
4869 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004870 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004871 * overwriting the last character (shouldn't happen, but just in case)
4872 * */
4873 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4874 }
4875
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004876#ifdef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004877 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004878 EMSG(_("E767: Too many arguments to printf()"));
4879#endif
4880
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004881 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004882 * character), that is, the number of characters that would have been
4883 * written to the buffer if it were large enough. */
4884 return (int)str_l;
4885}
4886
4887#endif /* PROTO */