blob: 76bf69d6d7ba429583e965c950d08b3d5719c4dd [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
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100572 /* Skip this if not giving error messages at the moment. */
573 if (emsg_not_now())
574 return TRUE;
575
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576 called_emsg = TRUE;
Bram Moolenaardf177f62005-02-22 08:39:57 +0000577 ex_exitval = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
579 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000580 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
581 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 */
583#ifdef FEAT_EVAL
584 severe = emsg_severe;
585 emsg_severe = FALSE;
586#endif
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
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100882 /*
883 * When inside vgetc(), we can't wait for a typed character at all.
884 * With the global command (and some others) we only need one return at
885 * the end. Adjust cmdline_row to avoid the next message overwriting the
886 * last one.
887 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000888 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100890 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 if (no_wait_return)
892 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 if (!exmode_active)
894 cmdline_row = msg_row;
895 return;
896 }
897
898 redir_off = TRUE; /* don't redirect this message */
899 oldState = State;
900 if (quit_more)
901 {
902 c = CAR; /* just pretend CR was hit */
903 quit_more = FALSE;
904 got_int = FALSE;
905 }
906 else if (exmode_active)
907 {
908 MSG_PUTS(" "); /* make sure the cursor is on the right line */
909 c = CAR; /* no need for a return in ex mode */
910 got_int = FALSE;
911 }
912 else
913 {
914 /* Make sure the hit-return prompt is on screen when 'guioptions' was
915 * just changed. */
916 screenalloc(FALSE);
917
918 State = HITRETURN;
919#ifdef FEAT_MOUSE
920 setmouse();
921#endif
922#ifdef USE_ON_FLY_SCROLL
923 dont_scroll = TRUE; /* disallow scrolling here */
924#endif
925 hit_return_msg();
926
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 do
928 {
929 /* Remember "got_int", if it is set vgetc() probably returns a
930 * CTRL-C, but we need to loop then. */
931 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000932
933 /* Don't do mappings here, we put the character back in the
934 * typeahead buffer. */
935 ++no_mapping;
936 ++allow_keys;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000938 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000940 --no_mapping;
941 --allow_keys;
942
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943#ifdef FEAT_CLIPBOARD
944 /* Strange way to allow copying (yanking) a modeless selection at
945 * the hit-enter prompt. Use CTRL-Y, because the same is used in
946 * Cmdline-mode and it's harmless when there is no selection. */
947 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
948 {
949 clip_copy_modeless_selection(TRUE);
950 c = K_IGNORE;
951 }
952#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000953
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000954 /*
955 * Allow scrolling back in the messages.
956 * Also accept scroll-down commands when messages fill the screen,
957 * to avoid that typing one 'j' too many makes the messages
958 * disappear.
959 */
960 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000961 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000962 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' || c == K_UP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000963 {
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000964 /* scroll back to show older messages */
965 do_more_prompt(c);
966 if (quit_more)
967 {
968 c = CAR; /* just pretend CR was hit */
969 quit_more = FALSE;
970 got_int = FALSE;
971 }
972 else
973 {
974 c = K_IGNORE;
975 hit_return_msg();
976 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000977 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000978 else if (msg_scrolled > Rows - 2
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +0000979 && (c == 'j' || c == K_DOWN || c == 'd' || c == 'f'))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000980 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000981 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 } while ((had_got_int && c == Ctrl_C)
983 || c == K_IGNORE
984#ifdef FEAT_GUI
985 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
986#endif
987#ifdef FEAT_MOUSE
988 || c == K_LEFTDRAG || c == K_LEFTRELEASE
989 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
990 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +0200991 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 || c == K_MOUSEDOWN || c == K_MOUSEUP
993 || (!mouse_has(MOUSE_RETURN)
994 && mouse_row < msg_row
995 && (c == K_LEFTMOUSE
996 || c == K_MIDDLEMOUSE
997 || c == K_RIGHTMOUSE
998 || c == K_X1MOUSE
999 || c == K_X2MOUSE))
1000#endif
1001 );
1002 ui_breakcheck();
1003#ifdef FEAT_MOUSE
1004 /*
1005 * Avoid that the mouse-up event causes visual mode to start.
1006 */
1007 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1008 || c == K_X1MOUSE || c == K_X2MOUSE)
1009 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1010 else
1011#endif
1012 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1013 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001014 /* Put the character back in the typeahead buffer. Don't use the
1015 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001016 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001018 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 }
1021 redir_off = FALSE;
1022
1023 /*
1024 * If the user hits ':', '?' or '/' we get a command line from the next
1025 * line.
1026 */
1027 if (c == ':' || c == '?' || c == '/')
1028 {
1029 if (!exmode_active)
1030 cmdline_row = msg_row;
1031 skip_redraw = TRUE; /* skip redraw once */
1032 do_redraw = FALSE;
1033 }
1034
1035 /*
1036 * If the window size changed set_shellsize() will redraw the screen.
1037 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1038 * typed.
1039 */
1040 tmpState = State;
1041 State = oldState; /* restore State before set_shellsize */
1042#ifdef FEAT_MOUSE
1043 setmouse();
1044#endif
1045 msg_check();
1046
1047#if defined(UNIX) || defined(VMS)
1048 /*
1049 * When switching screens, we need to output an extra newline on exit.
1050 */
1051 if (swapping_screen() && !termcap_active)
1052 newline_on_exit = TRUE;
1053#endif
1054
1055 need_wait_return = FALSE;
1056 did_wait_return = TRUE;
1057 emsg_on_display = FALSE; /* can delete error message now */
1058 lines_left = -1; /* reset lines_left at next msg_start() */
1059 reset_last_sourcing();
1060 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1061 (Rows - cmdline_row - 1) * Columns + sc_col)
1062 {
1063 vim_free(keep_msg);
1064 keep_msg = NULL; /* don't redisplay message, it's too long */
1065 }
1066
1067 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1068 {
1069 starttermcap(); /* start termcap before redrawing */
1070 shell_resized();
1071 }
1072 else if (!skip_redraw
1073 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1074 {
1075 starttermcap(); /* start termcap before redrawing */
1076 redraw_later(VALID);
1077 }
1078}
1079
1080/*
1081 * Write the hit-return prompt.
1082 */
1083 static void
1084hit_return_msg()
1085{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001086 int save_p_more = p_more;
1087
1088 p_more = FALSE; /* don't want see this message when scrolling back */
1089 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 msg_putchar('\n');
1091 if (got_int)
1092 MSG_PUTS(_("Interrupt: "));
1093
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001094 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 if (!msg_use_printf())
1096 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001097 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098}
1099
1100/*
1101 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1102 */
1103 void
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001104set_keep_msg(s, attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 char_u *s;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001106 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107{
1108 vim_free(keep_msg);
1109 if (s != NULL && msg_silent == 0)
1110 keep_msg = vim_strsave(s);
1111 else
1112 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001113 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001114 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115}
1116
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001117#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1118/*
1119 * If there currently is a message being displayed, set "keep_msg" to it, so
1120 * that it will be displayed again after redraw.
1121 */
1122 void
1123set_keep_msg_from_hist()
1124{
1125 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1126 && (State & NORMAL))
1127 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1128}
1129#endif
1130
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131/*
1132 * Prepare for outputting characters in the command line.
1133 */
1134 void
1135msg_start()
1136{
1137 int did_return = FALSE;
1138
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001139 if (!msg_silent)
1140 {
1141 vim_free(keep_msg);
1142 keep_msg = NULL; /* don't display old message now */
1143 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001144
1145#ifdef FEAT_EVAL
1146 if (need_clr_eos)
1147 {
1148 /* Halfway an ":echo" command and getting an (error) message: clear
1149 * any text from the command. */
1150 need_clr_eos = FALSE;
1151 msg_clr_eos();
1152 }
1153#endif
1154
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 if (!msg_scroll && full_screen) /* overwrite last message */
1156 {
1157 msg_row = cmdline_row;
1158 msg_col =
1159#ifdef FEAT_RIGHTLEFT
1160 cmdmsg_rl ? Columns - 1 :
1161#endif
1162 0;
1163 }
1164 else if (msg_didout) /* start message on next line */
1165 {
1166 msg_putchar('\n');
1167 did_return = TRUE;
1168 if (exmode_active != EXMODE_NORMAL)
1169 cmdline_row = msg_row;
1170 }
1171 if (!msg_didany || lines_left < 0)
1172 msg_starthere();
1173 if (msg_silent == 0)
1174 {
1175 msg_didout = FALSE; /* no output on current line yet */
1176 cursor_off();
1177 }
1178
1179 /* when redirecting, may need to start a new line. */
1180 if (!did_return)
1181 redir_write((char_u *)"\n", -1);
1182}
1183
1184/*
1185 * Note that the current msg position is where messages start.
1186 */
1187 void
1188msg_starthere()
1189{
1190 lines_left = cmdline_row;
1191 msg_didany = FALSE;
1192}
1193
1194 void
1195msg_putchar(c)
1196 int c;
1197{
1198 msg_putchar_attr(c, 0);
1199}
1200
1201 void
1202msg_putchar_attr(c, attr)
1203 int c;
1204 int attr;
1205{
1206#ifdef FEAT_MBYTE
1207 char_u buf[MB_MAXBYTES + 1];
1208#else
1209 char_u buf[4];
1210#endif
1211
1212 if (IS_SPECIAL(c))
1213 {
1214 buf[0] = K_SPECIAL;
1215 buf[1] = K_SECOND(c);
1216 buf[2] = K_THIRD(c);
1217 buf[3] = NUL;
1218 }
1219 else
1220 {
1221#ifdef FEAT_MBYTE
1222 buf[(*mb_char2bytes)(c, buf)] = NUL;
1223#else
1224 buf[0] = c;
1225 buf[1] = NUL;
1226#endif
1227 }
1228 msg_puts_attr(buf, attr);
1229}
1230
1231 void
1232msg_outnum(n)
1233 long n;
1234{
1235 char_u buf[20];
1236
1237 sprintf((char *)buf, "%ld", n);
1238 msg_puts(buf);
1239}
1240
1241 void
1242msg_home_replace(fname)
1243 char_u *fname;
1244{
1245 msg_home_replace_attr(fname, 0);
1246}
1247
1248#if defined(FEAT_FIND_ID) || defined(PROTO)
1249 void
1250msg_home_replace_hl(fname)
1251 char_u *fname;
1252{
1253 msg_home_replace_attr(fname, hl_attr(HLF_D));
1254}
1255#endif
1256
1257 static void
1258msg_home_replace_attr(fname, attr)
1259 char_u *fname;
1260 int attr;
1261{
1262 char_u *name;
1263
1264 name = home_replace_save(NULL, fname);
1265 if (name != NULL)
1266 msg_outtrans_attr(name, attr);
1267 vim_free(name);
1268}
1269
1270/*
1271 * Output 'len' characters in 'str' (including NULs) with translation
1272 * if 'len' is -1, output upto a NUL character.
1273 * Use attributes 'attr'.
1274 * Return the number of characters it takes on the screen.
1275 */
1276 int
1277msg_outtrans(str)
1278 char_u *str;
1279{
1280 return msg_outtrans_attr(str, 0);
1281}
1282
1283 int
1284msg_outtrans_attr(str, attr)
1285 char_u *str;
1286 int attr;
1287{
1288 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1289}
1290
1291 int
1292msg_outtrans_len(str, len)
1293 char_u *str;
1294 int len;
1295{
1296 return msg_outtrans_len_attr(str, len, 0);
1297}
1298
1299/*
1300 * Output one character at "p". Return pointer to the next character.
1301 * Handles multi-byte characters.
1302 */
1303 char_u *
1304msg_outtrans_one(p, attr)
1305 char_u *p;
1306 int attr;
1307{
1308#ifdef FEAT_MBYTE
1309 int l;
1310
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001311 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 {
1313 msg_outtrans_len_attr(p, l, attr);
1314 return p + l;
1315 }
1316#endif
1317 msg_puts_attr(transchar_byte(*p), attr);
1318 return p + 1;
1319}
1320
1321 int
1322msg_outtrans_len_attr(msgstr, len, attr)
1323 char_u *msgstr;
1324 int len;
1325 int attr;
1326{
1327 int retval = 0;
1328 char_u *str = msgstr;
1329 char_u *plain_start = msgstr;
1330 char_u *s;
1331#ifdef FEAT_MBYTE
1332 int mb_l;
1333 int c;
1334#endif
1335
1336 /* if MSG_HIST flag set, add message to history */
1337 if (attr & MSG_HIST)
1338 {
1339 add_msg_hist(str, len, attr);
1340 attr &= ~MSG_HIST;
1341 }
1342
1343#ifdef FEAT_MBYTE
1344 /* If the string starts with a composing character first draw a space on
1345 * which the composing char can be drawn. */
1346 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1347 msg_puts_attr((char_u *)" ", attr);
1348#endif
1349
1350 /*
1351 * Go over the string. Special characters are translated and printed.
1352 * Normal characters are printed several at a time.
1353 */
1354 while (--len >= 0)
1355 {
1356#ifdef FEAT_MBYTE
1357 if (enc_utf8)
1358 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001359 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001361 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 else
1363 mb_l = 1;
1364 if (has_mbyte && mb_l > 1)
1365 {
1366 c = (*mb_ptr2char)(str);
1367 if (vim_isprintc(c))
1368 /* printable multi-byte char: count the cells. */
1369 retval += (*mb_ptr2cells)(str);
1370 else
1371 {
1372 /* unprintable multi-byte char: print the printable chars so
1373 * far and the translation of the unprintable char. */
1374 if (str > plain_start)
1375 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1376 attr);
1377 plain_start = str + mb_l;
1378 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1379 retval += char2cells(c);
1380 }
1381 len -= mb_l - 1;
1382 str += mb_l;
1383 }
1384 else
1385#endif
1386 {
1387 s = transchar_byte(*str);
1388 if (s[1] != NUL)
1389 {
1390 /* unprintable char: print the printable chars so far and the
1391 * translation of the unprintable char. */
1392 if (str > plain_start)
1393 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1394 attr);
1395 plain_start = str + 1;
1396 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001397 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001399 else
1400 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 ++str;
1402 }
1403 }
1404
1405 if (str > plain_start)
1406 /* print the printable chars at the end */
1407 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1408
1409 return retval;
1410}
1411
1412#if defined(FEAT_QUICKFIX) || defined(PROTO)
1413 void
1414msg_make(arg)
1415 char_u *arg;
1416{
1417 int i;
1418 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1419
1420 arg = skipwhite(arg);
1421 for (i = 5; *arg && i >= 0; --i)
1422 if (*arg++ != str[i])
1423 break;
1424 if (i < 0)
1425 {
1426 msg_putchar('\n');
1427 for (i = 0; rs[i]; ++i)
1428 msg_putchar(rs[i] - 3);
1429 }
1430}
1431#endif
1432
1433/*
1434 * Output the string 'str' upto a NUL character.
1435 * Return the number of characters it takes on the screen.
1436 *
1437 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1438 * following character and shown as <F1>, <S-Up> etc. Any other character
1439 * which is not printable shown in <> form.
1440 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1441 * If a character is displayed in one of these special ways, is also
1442 * highlighted (its highlight name is '8' in the p_hl variable).
1443 * Otherwise characters are not highlighted.
1444 * This function is used to show mappings, where we want to see how to type
1445 * the character/string -- webb
1446 */
1447 int
1448msg_outtrans_special(strstart, from)
1449 char_u *strstart;
1450 int from; /* TRUE for lhs of a mapping */
1451{
1452 char_u *str = strstart;
1453 int retval = 0;
1454 char_u *string;
1455 int attr;
1456 int len;
1457
1458 attr = hl_attr(HLF_8);
1459 while (*str != NUL)
1460 {
1461 /* Leading and trailing spaces need to be displayed in <> form. */
1462 if ((str == strstart || str[1] == NUL) && *str == ' ')
1463 {
1464 string = (char_u *)"<Space>";
1465 ++str;
1466 }
1467 else
1468 string = str2special(&str, from);
1469 len = vim_strsize(string);
1470 /* Highlight special keys */
1471 msg_puts_attr(string, len > 1
1472#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001473 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474#endif
1475 ? attr : 0);
1476 retval += len;
1477 }
1478 return retval;
1479}
1480
Bram Moolenaarbd743252010-10-20 21:23:33 +02001481#if defined(FEAT_EVAL) || defined(PROTO)
1482/*
1483 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1484 * strings, in an allocated string.
1485 */
1486 char_u *
1487str2special_save(str, is_lhs)
1488 char_u *str;
1489 int is_lhs; /* TRUE for lhs, FALSE for rhs */
1490{
1491 garray_T ga;
1492 char_u *p = str;
1493
1494 ga_init2(&ga, 1, 40);
1495 while (*p != NUL)
1496 ga_concat(&ga, str2special(&p, is_lhs));
1497 ga_append(&ga, NUL);
1498 return (char_u *)ga.ga_data;
1499}
1500#endif
1501
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502/*
1503 * Return the printable string for the key codes at "*sp".
1504 * Used for translating the lhs or rhs of a mapping to printable chars.
1505 * Advances "sp" to the next code.
1506 */
1507 char_u *
1508str2special(sp, from)
1509 char_u **sp;
1510 int from; /* TRUE for lhs of mapping */
1511{
1512 int c;
1513 static char_u buf[7];
1514 char_u *str = *sp;
1515 int modifiers = 0;
1516 int special = FALSE;
1517
1518#ifdef FEAT_MBYTE
1519 if (has_mbyte)
1520 {
1521 char_u *p;
1522
1523 /* Try to un-escape a multi-byte character. Return the un-escaped
1524 * string if it is a multi-byte character. */
1525 p = mb_unescape(sp);
1526 if (p != NULL)
1527 return p;
1528 }
1529#endif
1530
1531 c = *str;
1532 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1533 {
1534 if (str[1] == KS_MODIFIER)
1535 {
1536 modifiers = str[2];
1537 str += 3;
1538 c = *str;
1539 }
1540 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1541 {
1542 c = TO_SPECIAL(str[1], str[2]);
1543 str += 2;
1544 if (c == K_ZERO) /* display <Nul> as ^@ */
1545 c = NUL;
1546 }
1547 if (IS_SPECIAL(c) || modifiers) /* special key */
1548 special = TRUE;
1549 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550
1551#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001552 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 {
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001554 int len = (*mb_ptr2len)(str);
1555
1556 /* For multi-byte characters check for an illegal byte. */
1557 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1558 {
1559 transchar_nonprint(buf, c);
1560 *sp = str + 1;
1561 return buf;
1562 }
1563 /* Since 'special' is TRUE the multi-byte character 'c' will be
1564 * processed by get_special_key_name() */
1565 c = (*mb_ptr2char)(str);
1566 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001568 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001570 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571
1572 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1573 * Use <Space> only for lhs of a mapping. */
1574 if (special || char2cells(c) > 1 || (from && c == ' '))
1575 return get_special_key_name(c, modifiers);
1576 buf[0] = c;
1577 buf[1] = NUL;
1578 return buf;
1579}
1580
1581/*
1582 * Translate a key sequence into special key names.
1583 */
1584 void
1585str2specialbuf(sp, buf, len)
1586 char_u *sp;
1587 char_u *buf;
1588 int len;
1589{
1590 char_u *s;
1591
1592 *buf = NUL;
1593 while (*sp)
1594 {
1595 s = str2special(&sp, FALSE);
1596 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1597 STRCAT(buf, s);
1598 }
1599}
1600
1601/*
1602 * print line for :print or :list command
1603 */
1604 void
Bram Moolenaardf177f62005-02-22 08:39:57 +00001605msg_prt_line(s, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 char_u *s;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001607 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608{
1609 int c;
1610 int col = 0;
1611 int n_extra = 0;
1612 int c_extra = 0;
1613 char_u *p_extra = NULL; /* init to make SASC shut up */
1614 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001615 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 char_u *trail = NULL;
1617#ifdef FEAT_MBYTE
1618 int l;
1619 char_u buf[MB_MAXBYTES + 1];
1620#endif
1621
Bram Moolenaardf177f62005-02-22 08:39:57 +00001622 if (curwin->w_p_list)
1623 list = TRUE;
1624
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001626 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 {
1628 trail = s + STRLEN(s);
1629 while (trail > s && vim_iswhite(trail[-1]))
1630 --trail;
1631 }
1632
1633 /* output a space for an empty line, otherwise the line will be
1634 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001635 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 msg_putchar(' ');
1637
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001638 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001640 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 {
1642 --n_extra;
1643 if (c_extra)
1644 c = c_extra;
1645 else
1646 c = *p_extra++;
1647 }
1648#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001649 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 {
1651 col += (*mb_ptr2cells)(s);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001652 if (lcs_nbsp != NUL && list && mb_ptr2char(s) == 160)
1653 {
1654 mb_char2bytes(lcs_nbsp, buf);
1655 buf[(*mb_ptr2len)(buf)] = NUL;
1656 }
1657 else
1658 {
1659 mch_memmove(buf, s, (size_t)l);
1660 buf[l] = NUL;
1661 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001662 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 s += l;
1664 continue;
1665 }
1666#endif
1667 else
1668 {
1669 attr = 0;
1670 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001671 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 {
1673 /* tab amount depends on current column */
1674 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001675 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 {
1677 c = ' ';
1678 c_extra = ' ';
1679 }
1680 else
1681 {
1682 c = lcs_tab1;
1683 c_extra = lcs_tab2;
1684 attr = hl_attr(HLF_8);
1685 }
1686 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001687 else if (c == 160 && list && lcs_nbsp != NUL)
1688 {
1689 c = lcs_nbsp;
1690 attr = hl_attr(HLF_8);
1691 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001692 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 {
1694 p_extra = (char_u *)"";
1695 c_extra = NUL;
1696 n_extra = 1;
1697 c = lcs_eol;
1698 attr = hl_attr(HLF_AT);
1699 --s;
1700 }
1701 else if (c != NUL && (n = byte2cells(c)) > 1)
1702 {
1703 n_extra = n - 1;
1704 p_extra = transchar_byte(c);
1705 c_extra = NUL;
1706 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001707 /* Use special coloring to be able to distinguish <hex> from
1708 * the same in plain text. */
1709 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 }
1711 else if (c == ' ' && trail != NULL && s > trail)
1712 {
1713 c = lcs_trail;
1714 attr = hl_attr(HLF_8);
1715 }
1716 }
1717
1718 if (c == NUL)
1719 break;
1720
1721 msg_putchar_attr(c, attr);
1722 col++;
1723 }
1724 msg_clr_eos();
1725}
1726
1727#ifdef FEAT_MBYTE
1728/*
1729 * Use screen_puts() to output one multi-byte character.
1730 * Return the pointer "s" advanced to the next character.
1731 */
1732 static char_u *
1733screen_puts_mbyte(s, l, attr)
1734 char_u *s;
1735 int l;
1736 int attr;
1737{
1738 int cw;
1739
1740 msg_didout = TRUE; /* remember that line is not empty */
1741 cw = (*mb_ptr2cells)(s);
1742 if (cw > 1 && (
1743#ifdef FEAT_RIGHTLEFT
1744 cmdmsg_rl ? msg_col <= 1 :
1745#endif
1746 msg_col == Columns - 1))
1747 {
1748 /* Doesn't fit, print a highlighted '>' to fill it up. */
1749 msg_screen_putchar('>', hl_attr(HLF_AT));
1750 return s;
1751 }
1752
1753 screen_puts_len(s, l, msg_row, msg_col, attr);
1754#ifdef FEAT_RIGHTLEFT
1755 if (cmdmsg_rl)
1756 {
1757 msg_col -= cw;
1758 if (msg_col == 0)
1759 {
1760 msg_col = Columns;
1761 ++msg_row;
1762 }
1763 }
1764 else
1765#endif
1766 {
1767 msg_col += cw;
1768 if (msg_col >= Columns)
1769 {
1770 msg_col = 0;
1771 ++msg_row;
1772 }
1773 }
1774 return s + l;
1775}
1776#endif
1777
1778/*
1779 * Output a string to the screen at position msg_row, msg_col.
1780 * Update msg_row and msg_col for the next message.
1781 */
1782 void
1783msg_puts(s)
1784 char_u *s;
1785{
1786 msg_puts_attr(s, 0);
1787}
1788
1789 void
1790msg_puts_title(s)
1791 char_u *s;
1792{
1793 msg_puts_attr(s, hl_attr(HLF_T));
1794}
1795
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796/*
1797 * Show a message in such a way that it always fits in the line. Cut out a
1798 * part in the middle and replace it with "..." when necessary.
1799 * Does not handle multi-byte characters!
1800 */
1801 void
1802msg_puts_long_attr(longstr, attr)
1803 char_u *longstr;
1804 int attr;
1805{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001806 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807}
1808
1809 void
1810msg_puts_long_len_attr(longstr, len, attr)
1811 char_u *longstr;
1812 int len;
1813 int attr;
1814{
1815 int slen = len;
1816 int room;
1817
1818 room = Columns - msg_col;
1819 if (len > room && room >= 20)
1820 {
1821 slen = (room - 3) / 2;
1822 msg_outtrans_len_attr(longstr, slen, attr);
1823 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1824 }
1825 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1826}
1827
1828/*
1829 * Basic function for writing a message with highlight attributes.
1830 */
1831 void
1832msg_puts_attr(s, attr)
1833 char_u *s;
1834 int attr;
1835{
1836 msg_puts_attr_len(s, -1, attr);
1837}
1838
1839/*
1840 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1841 * When "maxlen" is -1 there is no maximum length.
1842 * When "maxlen" is >= 0 the message is not put in the history.
1843 */
1844 static void
1845msg_puts_attr_len(str, maxlen, attr)
1846 char_u *str;
1847 int maxlen;
1848 int attr;
1849{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 /*
1851 * If redirection is on, also write to the redirection file.
1852 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001853 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854
1855 /*
1856 * Don't print anything when using ":silent cmd".
1857 */
1858 if (msg_silent != 0)
1859 return;
1860
1861 /* if MSG_HIST flag set, add message to history */
1862 if ((attr & MSG_HIST) && maxlen < 0)
1863 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001864 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 attr &= ~MSG_HIST;
1866 }
1867
1868 /*
1869 * When writing something to the screen after it has scrolled, requires a
1870 * wait-return prompt later. Needed when scrolling, resetting
1871 * need_wait_return after some prompt, and then outputting something
1872 * without scrolling
1873 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001874 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 need_wait_return = TRUE;
1876 msg_didany = TRUE; /* remember that something was outputted */
1877
1878 /*
1879 * If there is no valid screen, use fprintf so we can see error messages.
1880 * If termcap is not active, we may be writing in an alternate console
1881 * window, cursor positioning may not work correctly (window size may be
1882 * different, e.g. for Win32 console) or we just don't know where the
1883 * cursor is.
1884 */
1885 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001886 msg_puts_printf(str, maxlen);
1887 else
1888 msg_puts_display(str, maxlen, attr, FALSE);
1889}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001891/*
1892 * The display part of msg_puts_attr_len().
1893 * May be called recursively to display scroll-back text.
1894 */
1895 static void
1896msg_puts_display(str, maxlen, attr, recurse)
1897 char_u *str;
1898 int maxlen;
1899 int attr;
1900 int recurse;
1901{
1902 char_u *s = str;
1903 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1904 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1905#ifdef FEAT_MBYTE
1906 int l;
1907 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001909 char_u *sb_str = str;
1910 int sb_col = msg_col;
1911 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001912 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913
1914 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001915 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 {
1917 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001918 * We are at the end of the screen line when:
1919 * - When outputting a newline.
1920 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001922 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923#ifdef FEAT_RIGHTLEFT
1924 cmdmsg_rl
1925 ? (
1926 msg_col <= 1
1927 || (*s == TAB && msg_col <= 7)
1928# ifdef FEAT_MBYTE
1929 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1930# endif
1931 )
1932 :
1933#endif
1934 (msg_col + t_col >= Columns - 1
1935 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1936# ifdef FEAT_MBYTE
1937 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1938 && msg_col + t_col >= Columns - 2)
1939# endif
1940 ))))
1941 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001942 /*
1943 * The screen is scrolled up when at the last row (some terminals
1944 * scroll automatically, some don't. To avoid problems we scroll
1945 * ourselves).
1946 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001949 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001951 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 if (msg_no_more && lines_left == 0)
1953 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001955 /* Scroll the screen up one line. */
1956 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957
1958 msg_row = Rows - 2;
1959 if (msg_col >= Columns) /* can happen after screen resize */
1960 msg_col = Columns - 1;
1961
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001962 /* Display char in last column before showing more-prompt. */
1963 if (*s >= ' '
1964#ifdef FEAT_RIGHTLEFT
1965 && !cmdmsg_rl
1966#endif
1967 )
1968 {
1969#ifdef FEAT_MBYTE
1970 if (has_mbyte)
1971 {
1972 if (enc_utf8 && maxlen >= 0)
1973 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001974 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001975 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001976 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001977 s = screen_puts_mbyte(s, l, attr);
1978 }
1979 else
1980#endif
1981 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001982 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001983 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001984 else
1985 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001986
1987 if (p_more)
1988 /* store text for scrolling back */
1989 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1990
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001991 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001992 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 if (must_redraw < VALID)
1994 must_redraw = VALID;
1995 redraw_cmdline = TRUE;
1996 if (cmdline_row > 0 && !exmode_active)
1997 --cmdline_row;
1998
1999 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002000 * If screen is completely filled and 'more' is set then wait
2001 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002003 if (lines_left > 0)
2004 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002005 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 && !msg_no_more && !exmode_active)
2007 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002009 if (do_more_prompt(NUL))
2010 s = confirm_msg_tail;
2011#else
2012 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013#endif
2014 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002015 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002017
2018 /* When we displayed a char in last column need to check if there
2019 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002020 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002021 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 }
2023
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002024 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 || msg_col + t_col >= Columns
2026#ifdef FEAT_MBYTE
2027 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2028 && msg_col + t_col >= Columns - 1)
2029#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002030 ;
2031 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2032 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002034 t_puts(&t_col, t_s, s, attr);
2035
2036 if (wrap && p_more && !recurse)
2037 /* store text for scrolling back */
2038 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039
2040 if (*s == '\n') /* go to next line */
2041 {
2042 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002043#ifdef FEAT_RIGHTLEFT
2044 if (cmdmsg_rl)
2045 msg_col = Columns - 1;
2046 else
2047#endif
2048 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 if (++msg_row >= Rows) /* safety check */
2050 msg_row = Rows - 1;
2051 }
2052 else if (*s == '\r') /* go to column 0 */
2053 {
2054 msg_col = 0;
2055 }
2056 else if (*s == '\b') /* go to previous char */
2057 {
2058 if (msg_col)
2059 --msg_col;
2060 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002061 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 {
2063 do
2064 msg_screen_putchar(' ', attr);
2065 while (msg_col & 7);
2066 }
2067 else if (*s == BELL) /* beep (from ":sh") */
2068 vim_beep();
2069 else
2070 {
2071#ifdef FEAT_MBYTE
2072 if (has_mbyte)
2073 {
2074 cw = (*mb_ptr2cells)(s);
2075 if (enc_utf8 && maxlen >= 0)
2076 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002077 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002079 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 }
2081 else
2082 {
2083 cw = 1;
2084 l = 1;
2085 }
2086#endif
2087 /* When drawing from right to left or when a double-wide character
2088 * doesn't fit, draw a single character here. Otherwise collect
2089 * characters and draw them all at once later. */
2090#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2091 if (
2092# ifdef FEAT_RIGHTLEFT
2093 cmdmsg_rl
2094# ifdef FEAT_MBYTE
2095 ||
2096# endif
2097# endif
2098# ifdef FEAT_MBYTE
2099 (cw > 1 && msg_col + t_col >= Columns - 1)
2100# endif
2101 )
2102 {
2103# ifdef FEAT_MBYTE
2104 if (l > 1)
2105 s = screen_puts_mbyte(s, l, attr) - 1;
2106 else
2107# endif
2108 msg_screen_putchar(*s, attr);
2109 }
2110 else
2111#endif
2112 {
2113 /* postpone this character until later */
2114 if (t_col == 0)
2115 t_s = s;
2116#ifdef FEAT_MBYTE
2117 t_col += cw;
2118 s += l - 1;
2119#else
2120 ++t_col;
2121#endif
2122 }
2123 }
2124 ++s;
2125 }
2126
2127 /* output any postponed text */
2128 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002129 t_puts(&t_col, t_s, s, attr);
2130 if (p_more && !recurse)
2131 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132
2133 msg_check();
2134}
2135
2136/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002137 * Scroll the screen up one line for displaying the next message line.
2138 */
2139 static void
2140msg_scroll_up()
2141{
2142#ifdef FEAT_GUI
2143 /* Remove the cursor before scrolling, ScreenLines[] is going
2144 * to become invalid. */
2145 if (gui.in_use)
2146 gui_undraw_cursor();
2147#endif
2148 /* scrolling up always works */
2149 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2150
2151 if (!can_clear((char_u *)" "))
2152 {
2153 /* Scrolling up doesn't result in the right background. Set the
2154 * background here. It's not efficient, but avoids that we have to do
2155 * it all over the code. */
2156 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2157
2158 /* Also clear the last char of the last but one line if it was not
2159 * cleared before to avoid a scroll-up. */
2160 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2161 screen_fill((int)Rows - 2, (int)Rows - 1,
2162 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2163 }
2164}
2165
2166/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002167 * Increment "msg_scrolled".
2168 */
2169 static void
2170inc_msg_scrolled()
2171{
2172#ifdef FEAT_EVAL
2173 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2174 {
2175 char_u *p = sourcing_name;
2176 char_u *tofree = NULL;
2177 int len;
2178
2179 /* v:scrollstart is empty, set it to the script/function name and line
2180 * number */
2181 if (p == NULL)
2182 p = (char_u *)_("Unknown");
2183 else
2184 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002185 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002186 tofree = alloc(len);
2187 if (tofree != NULL)
2188 {
2189 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2190 p, (long)sourcing_lnum);
2191 p = tofree;
2192 }
2193 }
2194 set_vim_var_string(VV_SCROLLSTART, p, -1);
2195 vim_free(tofree);
2196 }
2197#endif
2198 ++msg_scrolled;
2199}
2200
2201/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002202 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2203 * store the displayed text and remember where screen lines start.
2204 */
2205typedef struct msgchunk_S msgchunk_T;
2206struct msgchunk_S
2207{
2208 msgchunk_T *sb_next;
2209 msgchunk_T *sb_prev;
2210 char sb_eol; /* TRUE when line ends after this text */
2211 int sb_msg_col; /* column in which text starts */
2212 int sb_attr; /* text attributes */
2213 char_u sb_text[1]; /* text to be displayed, actually longer */
2214};
2215
2216static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2217
2218static msgchunk_T *msg_sb_start __ARGS((msgchunk_T *mps));
2219static msgchunk_T *disp_sb_line __ARGS((int row, msgchunk_T *smp));
2220
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002221static int do_clear_sb_text = FALSE; /* clear text on next msg */
2222
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002223/*
2224 * Store part of a printed message for displaying when scrolling back.
2225 */
2226 static void
2227store_sb_text(sb_str, s, attr, sb_col, finish)
2228 char_u **sb_str; /* start of string */
2229 char_u *s; /* just after string */
2230 int attr;
2231 int *sb_col;
2232 int finish; /* line ends */
2233{
2234 msgchunk_T *mp;
2235
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002236 if (do_clear_sb_text)
2237 {
2238 clear_sb_text();
2239 do_clear_sb_text = FALSE;
2240 }
2241
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002242 if (s > *sb_str)
2243 {
2244 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2245 if (mp != NULL)
2246 {
2247 mp->sb_eol = finish;
2248 mp->sb_msg_col = *sb_col;
2249 mp->sb_attr = attr;
2250 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2251
2252 if (last_msgchunk == NULL)
2253 {
2254 last_msgchunk = mp;
2255 mp->sb_prev = NULL;
2256 }
2257 else
2258 {
2259 mp->sb_prev = last_msgchunk;
2260 last_msgchunk->sb_next = mp;
2261 last_msgchunk = mp;
2262 }
2263 mp->sb_next = NULL;
2264 }
2265 }
2266 else if (finish && last_msgchunk != NULL)
2267 last_msgchunk->sb_eol = TRUE;
2268
2269 *sb_str = s;
2270 *sb_col = 0;
2271}
2272
2273/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002274 * Finished showing messages, clear the scroll-back text on the next message.
2275 */
2276 void
2277may_clear_sb_text()
2278{
2279 do_clear_sb_text = TRUE;
2280}
2281
2282/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002283 * Clear any text remembered for scrolling back.
2284 * Called when redrawing the screen.
2285 */
2286 void
2287clear_sb_text()
2288{
2289 msgchunk_T *mp;
2290
2291 while (last_msgchunk != NULL)
2292 {
2293 mp = last_msgchunk->sb_prev;
2294 vim_free(last_msgchunk);
2295 last_msgchunk = mp;
2296 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002297}
2298
2299/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002300 * "g<" command.
2301 */
2302 void
2303show_sb_text()
2304{
2305 msgchunk_T *mp;
2306
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002307 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002308 * weird, typing a command without output results in one line. */
2309 mp = msg_sb_start(last_msgchunk);
2310 if (mp == NULL || mp->sb_prev == NULL)
2311 vim_beep();
2312 else
2313 {
2314 do_more_prompt('G');
2315 wait_return(FALSE);
2316 }
2317}
2318
2319/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002320 * Move to the start of screen line in already displayed text.
2321 */
2322 static msgchunk_T *
2323msg_sb_start(mps)
2324 msgchunk_T *mps;
2325{
2326 msgchunk_T *mp = mps;
2327
2328 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2329 mp = mp->sb_prev;
2330 return mp;
2331}
2332
2333/*
2334 * Display a screen line from previously displayed text at row "row".
2335 * Returns a pointer to the text for the next line (can be NULL).
2336 */
2337 static msgchunk_T *
2338disp_sb_line(row, smp)
2339 int row;
2340 msgchunk_T *smp;
2341{
2342 msgchunk_T *mp = smp;
2343 char_u *p;
2344
2345 for (;;)
2346 {
2347 msg_row = row;
2348 msg_col = mp->sb_msg_col;
2349 p = mp->sb_text;
2350 if (*p == '\n') /* don't display the line break */
2351 ++p;
2352 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2353 if (mp->sb_eol || mp->sb_next == NULL)
2354 break;
2355 mp = mp->sb_next;
2356 }
2357 return mp->sb_next;
2358}
2359
2360/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 * Output any postponed text for msg_puts_attr_len().
2362 */
2363 static void
2364t_puts(t_col, t_s, s, attr)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002365 int *t_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 char_u *t_s;
2367 char_u *s;
2368 int attr;
2369{
2370 /* output postponed text */
2371 msg_didout = TRUE; /* remember that line is not empty */
2372 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002373 msg_col += *t_col;
2374 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375#ifdef FEAT_MBYTE
2376 /* If the string starts with a composing character don't increment the
2377 * column position for it. */
2378 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2379 --msg_col;
2380#endif
2381 if (msg_col >= Columns)
2382 {
2383 msg_col = 0;
2384 ++msg_row;
2385 }
2386}
2387
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388/*
2389 * Returns TRUE when messages should be printed with mch_errmsg().
2390 * This is used when there is no valid screen, so we can see error messages.
2391 * If termcap is not active, we may be writing in an alternate console
2392 * window, cursor positioning may not work correctly (window size may be
2393 * different, e.g. for Win32 console) or we just don't know where the
2394 * cursor is.
2395 */
2396 int
2397msg_use_printf()
2398{
2399 return (!msg_check_screen()
2400#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2401 || !termcap_active
2402#endif
2403 || (swapping_screen() && !termcap_active)
2404 );
2405}
2406
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002407/*
2408 * Print a message when there is no valid screen.
2409 */
2410 static void
2411msg_puts_printf(str, maxlen)
2412 char_u *str;
2413 int maxlen;
2414{
2415 char_u *s = str;
2416 char_u buf[4];
2417 char_u *p;
2418
2419#ifdef WIN3264
2420 if (!(silent_mode && p_verbose == 0))
2421 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2422#endif
2423 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2424 {
2425 if (!(silent_mode && p_verbose == 0))
2426 {
2427 /* NL --> CR NL translation (for Unix, not for "--version") */
2428 /* NL --> CR translation (for Mac) */
2429 p = &buf[0];
2430 if (*s == '\n' && !info_message)
2431 *p++ = '\r';
2432#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2433 else
2434#endif
2435 *p++ = *s;
2436 *p = '\0';
2437 if (info_message) /* informative message, not an error */
2438 mch_msg((char *)buf);
2439 else
2440 mch_errmsg((char *)buf);
2441 }
2442
2443 /* primitive way to compute the current column */
2444#ifdef FEAT_RIGHTLEFT
2445 if (cmdmsg_rl)
2446 {
2447 if (*s == '\r' || *s == '\n')
2448 msg_col = Columns - 1;
2449 else
2450 --msg_col;
2451 }
2452 else
2453#endif
2454 {
2455 if (*s == '\r' || *s == '\n')
2456 msg_col = 0;
2457 else
2458 ++msg_col;
2459 }
2460 ++s;
2461 }
2462 msg_didout = TRUE; /* assume that line is not empty */
2463
2464#ifdef WIN3264
2465 if (!(silent_mode && p_verbose == 0))
2466 mch_settmode(TMODE_RAW);
2467#endif
2468}
2469
2470/*
2471 * Show the more-prompt and handle the user response.
2472 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002473 * When at hit-enter prompt "typed_char" is the already typed character,
2474 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002475 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2476 */
2477 static int
2478do_more_prompt(typed_char)
2479 int typed_char;
2480{
2481 int used_typed_char = typed_char;
2482 int oldState = State;
2483 int c;
2484#ifdef FEAT_CON_DIALOG
2485 int retval = FALSE;
2486#endif
2487 int scroll;
2488 msgchunk_T *mp_last = NULL;
2489 msgchunk_T *mp;
2490 int i;
2491
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002492 if (typed_char == 'G')
2493 {
2494 /* "g<": Find first line on the last page. */
2495 mp_last = msg_sb_start(last_msgchunk);
2496 for (i = 0; i < Rows - 2 && mp_last != NULL
2497 && mp_last->sb_prev != NULL; ++i)
2498 mp_last = msg_sb_start(mp_last->sb_prev);
2499 }
2500
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002501 State = ASKMORE;
2502#ifdef FEAT_MOUSE
2503 setmouse();
2504#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002505 if (typed_char == NUL)
2506 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002507 for (;;)
2508 {
2509 /*
2510 * Get a typed character directly from the user.
2511 */
2512 if (used_typed_char != NUL)
2513 {
2514 c = used_typed_char; /* was typed at hit-enter prompt */
2515 used_typed_char = NUL;
2516 }
2517 else
2518 c = get_keystroke();
2519
2520#if defined(FEAT_MENU) && defined(FEAT_GUI)
2521 if (c == K_MENU)
2522 {
2523 int idx = get_menu_index(current_menu, ASKMORE);
2524
2525 /* Used a menu. If it starts with CTRL-Y, it must
2526 * be a "Copy" for the clipboard. Otherwise
2527 * assume that we end */
2528 if (idx == MENU_INDEX_INVALID)
2529 continue;
2530 c = *current_menu->strings[idx];
2531 if (c != NUL && current_menu->strings[idx][1] != NUL)
2532 ins_typebuf(current_menu->strings[idx] + 1,
2533 current_menu->noremap[idx], 0, TRUE,
2534 current_menu->silent[idx]);
2535 }
2536#endif
2537
2538 scroll = 0;
2539 switch (c)
2540 {
2541 case BS: /* scroll one line back */
2542 case K_BS:
2543 case 'k':
2544 case K_UP:
2545 scroll = -1;
2546 break;
2547
2548 case CAR: /* one extra line */
2549 case NL:
2550 case 'j':
2551 case K_DOWN:
2552 scroll = 1;
2553 break;
2554
2555 case 'u': /* Up half a page */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002556 scroll = -(Rows / 2);
2557 break;
2558
2559 case 'd': /* Down half a page */
2560 scroll = Rows / 2;
2561 break;
2562
2563 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002564 case K_PAGEUP:
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002565 scroll = -(Rows - 1);
2566 break;
2567
2568 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002569 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002570 case K_PAGEDOWN:
2571 case K_LEFTMOUSE:
2572 scroll = Rows - 1;
2573 break;
2574
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002575 case 'g': /* all the way back to the start */
2576 scroll = -999999;
2577 break;
2578
2579 case 'G': /* all the way to the end */
2580 scroll = 999999;
2581 lines_left = 999999;
2582 break;
2583
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002584 case ':': /* start new command line */
2585#ifdef FEAT_CON_DIALOG
2586 if (!confirm_msg_used)
2587#endif
2588 {
2589 /* Since got_int is set all typeahead will be flushed, but we
2590 * want to keep this ':', remember that in a special way. */
2591 typeahead_noflush(':');
2592 cmdline_row = Rows - 1; /* put ':' on this line */
2593 skip_redraw = TRUE; /* skip redraw once */
2594 need_wait_return = FALSE; /* don't wait in main() */
2595 }
2596 /*FALLTHROUGH*/
2597 case 'q': /* quit */
2598 case Ctrl_C:
2599 case ESC:
2600#ifdef FEAT_CON_DIALOG
2601 if (confirm_msg_used)
2602 {
2603 /* Jump to the choices of the dialog. */
2604 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002605 }
2606 else
2607#endif
2608 {
2609 got_int = TRUE;
2610 quit_more = TRUE;
2611 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002612 /* When there is some more output (wrapping line) display that
2613 * without another prompt. */
2614 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002615 break;
2616
2617#ifdef FEAT_CLIPBOARD
2618 case Ctrl_Y:
2619 /* Strange way to allow copying (yanking) a modeless
2620 * selection at the more prompt. Use CTRL-Y,
2621 * because the same is used in Cmdline-mode and at the
2622 * hit-enter prompt. However, scrolling one line up
2623 * might be expected... */
2624 if (clip_star.state == SELECT_DONE)
2625 clip_copy_modeless_selection(TRUE);
2626 continue;
2627#endif
2628 default: /* no valid response */
2629 msg_moremsg(TRUE);
2630 continue;
2631 }
2632
2633 if (scroll != 0)
2634 {
2635 if (scroll < 0)
2636 {
2637 /* go to start of last line */
2638 if (mp_last == NULL)
2639 mp = msg_sb_start(last_msgchunk);
2640 else if (mp_last->sb_prev != NULL)
2641 mp = msg_sb_start(mp_last->sb_prev);
2642 else
2643 mp = NULL;
2644
2645 /* go to start of line at top of the screen */
2646 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2647 ++i)
2648 mp = msg_sb_start(mp->sb_prev);
2649
2650 if (mp != NULL && mp->sb_prev != NULL)
2651 {
2652 /* Find line to be displayed at top. */
2653 for (i = 0; i > scroll; --i)
2654 {
2655 if (mp == NULL || mp->sb_prev == NULL)
2656 break;
2657 mp = msg_sb_start(mp->sb_prev);
2658 if (mp_last == NULL)
2659 mp_last = msg_sb_start(last_msgchunk);
2660 else
2661 mp_last = msg_sb_start(mp_last->sb_prev);
2662 }
2663
2664 if (scroll == -1 && screen_ins_lines(0, 0, 1,
2665 (int)Rows, NULL) == OK)
2666 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002667 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002668 (void)disp_sb_line(0, mp);
2669 }
2670 else
2671 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002672 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002673 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002674 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2675 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002676 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002677 ++msg_scrolled;
2678 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002679 }
2680 scroll = 0;
2681 }
2682 }
2683 else
2684 {
2685 /* First display any text that we scrolled back. */
2686 while (scroll > 0 && mp_last != NULL)
2687 {
2688 /* scroll up, display line at bottom */
2689 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002690 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002691 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2692 (int)Columns, ' ', ' ', 0);
2693 mp_last = disp_sb_line((int)Rows - 2, mp_last);
2694 --scroll;
2695 }
2696 }
2697
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002698 if (scroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002699 {
2700 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002701 screen_fill((int)Rows - 1, (int)Rows, 0,
2702 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002703 msg_moremsg(FALSE);
2704 continue;
2705 }
2706
2707 /* display more text, return to caller */
2708 lines_left = scroll;
2709 }
2710
2711 break;
2712 }
2713
2714 /* clear the --more-- message */
2715 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2716 State = oldState;
2717#ifdef FEAT_MOUSE
2718 setmouse();
2719#endif
2720 if (quit_more)
2721 {
2722 msg_row = Rows - 1;
2723 msg_col = 0;
2724 }
2725#ifdef FEAT_RIGHTLEFT
2726 else if (cmdmsg_rl)
2727 msg_col = Columns - 1;
2728#endif
2729
2730#ifdef FEAT_CON_DIALOG
2731 return retval;
2732#else
2733 return FALSE;
2734#endif
2735}
2736
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2738
2739#ifdef mch_errmsg
2740# undef mch_errmsg
2741#endif
2742#ifdef mch_msg
2743# undef mch_msg
2744#endif
2745
2746/*
2747 * Give an error message. To be used when the screen hasn't been initialized
2748 * yet. When stderr can't be used, collect error messages until the GUI has
2749 * started and they can be displayed in a message box.
2750 */
2751 void
2752mch_errmsg(str)
2753 char *str;
2754{
2755 int len;
2756
2757#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2758 /* On Unix use stderr if it's a tty.
2759 * When not going to start the GUI also use stderr.
2760 * On Mac, when started from Finder, stderr is the console. */
2761 if (
2762# ifdef UNIX
2763# ifdef MACOS_X_UNIX
2764 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2765# else
2766 isatty(2)
2767# endif
2768# ifdef FEAT_GUI
2769 ||
2770# endif
2771# endif
2772# ifdef FEAT_GUI
2773 !(gui.in_use || gui.starting)
2774# endif
2775 )
2776 {
2777 fprintf(stderr, "%s", str);
2778 return;
2779 }
2780#endif
2781
2782 /* avoid a delay for a message that isn't there */
2783 emsg_on_display = FALSE;
2784
2785 len = (int)STRLEN(str) + 1;
2786 if (error_ga.ga_growsize == 0)
2787 {
2788 error_ga.ga_growsize = 80;
2789 error_ga.ga_itemsize = 1;
2790 }
2791 if (ga_grow(&error_ga, len) == OK)
2792 {
2793 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2794 (char_u *)str, len);
2795#ifdef UNIX
2796 /* remove CR characters, they are displayed */
2797 {
2798 char_u *p;
2799
2800 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2801 for (;;)
2802 {
2803 p = vim_strchr(p, '\r');
2804 if (p == NULL)
2805 break;
2806 *p = ' ';
2807 }
2808 }
2809#endif
2810 --len; /* don't count the NUL at the end */
2811 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 }
2813}
2814
2815/*
2816 * Give a message. To be used when the screen hasn't been initialized yet.
2817 * When there is no tty, collect messages until the GUI has started and they
2818 * can be displayed in a message box.
2819 */
2820 void
2821mch_msg(str)
2822 char *str;
2823{
2824#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2825 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2826 * uses mch_errmsg() when started from the desktop.
2827 * When not going to start the GUI also use stdout.
2828 * On Mac, when started from Finder, stderr is the console. */
2829 if (
2830# ifdef UNIX
2831# ifdef MACOS_X_UNIX
2832 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2833# else
2834 isatty(2)
2835# endif
2836# ifdef FEAT_GUI
2837 ||
2838# endif
2839# endif
2840# ifdef FEAT_GUI
2841 !(gui.in_use || gui.starting)
2842# endif
2843 )
2844 {
2845 printf("%s", str);
2846 return;
2847 }
2848# endif
2849 mch_errmsg(str);
2850}
2851#endif /* USE_MCH_ERRMSG */
2852
2853/*
2854 * Put a character on the screen at the current message position and advance
2855 * to the next position. Only for printable ASCII!
2856 */
2857 static void
2858msg_screen_putchar(c, attr)
2859 int c;
2860 int attr;
2861{
2862 msg_didout = TRUE; /* remember that line is not empty */
2863 screen_putchar(c, msg_row, msg_col, attr);
2864#ifdef FEAT_RIGHTLEFT
2865 if (cmdmsg_rl)
2866 {
2867 if (--msg_col == 0)
2868 {
2869 msg_col = Columns;
2870 ++msg_row;
2871 }
2872 }
2873 else
2874#endif
2875 {
2876 if (++msg_col >= Columns)
2877 {
2878 msg_col = 0;
2879 ++msg_row;
2880 }
2881 }
2882}
2883
2884 void
2885msg_moremsg(full)
2886 int full;
2887{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002888 int attr;
2889 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890
2891 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002892 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002894 screen_puts((char_u *)
2895 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2896 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897}
2898
2899/*
2900 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2901 * exmode_active.
2902 */
2903 void
2904repeat_message()
2905{
2906 if (State == ASKMORE)
2907 {
2908 msg_moremsg(TRUE); /* display --more-- message again */
2909 msg_row = Rows - 1;
2910 }
2911#ifdef FEAT_CON_DIALOG
2912 else if (State == CONFIRM)
2913 {
2914 display_confirm_msg(); /* display ":confirm" message again */
2915 msg_row = Rows - 1;
2916 }
2917#endif
2918 else if (State == EXTERNCMD)
2919 {
2920 windgoto(msg_row, msg_col); /* put cursor back */
2921 }
2922 else if (State == HITRETURN || State == SETWSIZE)
2923 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002924 if (msg_row == Rows - 1)
2925 {
2926 /* Avoid drawing the "hit-enter" prompt below the previous one,
2927 * overwrite it. Esp. useful when regaining focus and a
2928 * FocusGained autocmd exists but didn't draw anything. */
2929 msg_didout = FALSE;
2930 msg_col = 0;
2931 msg_clr_eos();
2932 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 hit_return_msg();
2934 msg_row = Rows - 1;
2935 }
2936}
2937
2938/*
2939 * msg_check_screen - check if the screen is initialized.
2940 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2941 * While starting the GUI the terminal codes will be set for the GUI, but the
2942 * output goes to the terminal. Don't use the terminal codes then.
2943 */
2944 static int
2945msg_check_screen()
2946{
2947 if (!full_screen || !screen_valid(FALSE))
2948 return FALSE;
2949
2950 if (msg_row >= Rows)
2951 msg_row = Rows - 1;
2952 if (msg_col >= Columns)
2953 msg_col = Columns - 1;
2954 return TRUE;
2955}
2956
2957/*
2958 * Clear from current message position to end of screen.
2959 * Skip this when ":silent" was used, no need to clear for redirection.
2960 */
2961 void
2962msg_clr_eos()
2963{
2964 if (msg_silent == 0)
2965 msg_clr_eos_force();
2966}
2967
2968/*
2969 * Clear from current message position to end of screen.
2970 * Note: msg_col is not updated, so we remember the end of the message
2971 * for msg_check().
2972 */
2973 void
2974msg_clr_eos_force()
2975{
2976 if (msg_use_printf())
2977 {
2978 if (full_screen) /* only when termcap codes are valid */
2979 {
2980 if (*T_CD)
2981 out_str(T_CD); /* clear to end of display */
2982 else if (*T_CE)
2983 out_str(T_CE); /* clear to end of line */
2984 }
2985 }
2986 else
2987 {
2988#ifdef FEAT_RIGHTLEFT
2989 if (cmdmsg_rl)
2990 {
2991 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2992 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2993 }
2994 else
2995#endif
2996 {
2997 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2998 ' ', ' ', 0);
2999 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3000 }
3001 }
3002}
3003
3004/*
3005 * Clear the command line.
3006 */
3007 void
3008msg_clr_cmdline()
3009{
3010 msg_row = cmdline_row;
3011 msg_col = 0;
3012 msg_clr_eos_force();
3013}
3014
3015/*
3016 * end putting a message on the screen
3017 * call wait_return if the message does not fit in the available space
3018 * return TRUE if wait_return not called.
3019 */
3020 int
3021msg_end()
3022{
3023 /*
3024 * if the string is larger than the window,
3025 * or the ruler option is set and we run into it,
3026 * we have to redraw the window.
3027 * Do not do this if we are abandoning the file or editing the command line.
3028 */
3029 if (!exiting && need_wait_return && !(State & CMDLINE))
3030 {
3031 wait_return(FALSE);
3032 return FALSE;
3033 }
3034 out_flush();
3035 return TRUE;
3036}
3037
3038/*
3039 * If the written message runs into the shown command or ruler, we have to
3040 * wait for hit-return and redraw the window later.
3041 */
3042 void
3043msg_check()
3044{
3045 if (msg_row == Rows - 1 && msg_col >= sc_col)
3046 {
3047 need_wait_return = TRUE;
3048 redraw_cmdline = TRUE;
3049 }
3050}
3051
3052/*
3053 * May write a string to the redirection file.
3054 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3055 */
3056 static void
3057redir_write(str, maxlen)
3058 char_u *str;
3059 int maxlen;
3060{
3061 char_u *s = str;
3062 static int cur_col = 0;
3063
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003064 /* Don't do anything for displaying prompts and the like. */
3065 if (redir_off)
3066 return;
3067
3068 /*
3069 * If 'verbosefile' is set write message in that file.
3070 * Must come before the rest because of updating "msg_col".
3071 */
3072 if (*p_vfile != NUL)
3073 verbose_write(s, maxlen);
3074
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003075 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 {
3077 /* If the string doesn't start with CR or NL, go to msg_col */
3078 if (*s != '\n' && *s != '\r')
3079 {
3080 while (cur_col < msg_col)
3081 {
3082#ifdef FEAT_EVAL
3083 if (redir_reg)
3084 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003085 else if (redir_vname)
3086 var_redir_str((char_u *)" ", -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 else if (redir_fd)
3088#endif
3089 fputs(" ", redir_fd);
3090 ++cur_col;
3091 }
3092 }
3093
3094#ifdef FEAT_EVAL
3095 if (redir_reg)
3096 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003097 if (redir_vname)
3098 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099#endif
3100
3101 /* Adjust the current column */
3102 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3103 {
3104#ifdef FEAT_EVAL
Bram Moolenaardf177f62005-02-22 08:39:57 +00003105 if (!redir_reg && !redir_vname && redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106#endif
3107 putc(*s, redir_fd);
3108 if (*s == '\r' || *s == '\n')
3109 cur_col = 0;
3110 else if (*s == '\t')
3111 cur_col += (8 - cur_col % 8);
3112 else
3113 ++cur_col;
3114 ++s;
3115 }
3116
3117 if (msg_silent != 0) /* should update msg_col */
3118 msg_col = cur_col;
3119 }
3120}
3121
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003122 int
3123redirecting()
3124{
3125 return redir_fd != NULL
3126#ifdef FEAT_EVAL
3127 || redir_reg || redir_vname
3128#endif
3129 ;
3130}
3131
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003133 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003134 * Must always be called paired with verbose_leave()!
3135 */
3136 void
3137verbose_enter()
3138{
3139 if (*p_vfile != NUL)
3140 ++msg_silent;
3141}
3142
3143/*
3144 * After giving verbose message.
3145 * Must always be called paired with verbose_enter()!
3146 */
3147 void
3148verbose_leave()
3149{
3150 if (*p_vfile != NUL)
3151 if (--msg_silent < 0)
3152 msg_silent = 0;
3153}
3154
3155/*
3156 * Like verbose_enter() and set msg_scroll when displaying the message.
3157 */
3158 void
3159verbose_enter_scroll()
3160{
3161 if (*p_vfile != NUL)
3162 ++msg_silent;
3163 else
3164 /* always scroll up, don't overwrite */
3165 msg_scroll = TRUE;
3166}
3167
3168/*
3169 * Like verbose_leave() and set cmdline_row when displaying the message.
3170 */
3171 void
3172verbose_leave_scroll()
3173{
3174 if (*p_vfile != NUL)
3175 {
3176 if (--msg_silent < 0)
3177 msg_silent = 0;
3178 }
3179 else
3180 cmdline_row = msg_row;
3181}
3182
3183static FILE *verbose_fd = NULL;
3184static int verbose_did_open = FALSE;
3185
3186/*
3187 * Called when 'verbosefile' is set: stop writing to the file.
3188 */
3189 void
3190verbose_stop()
3191{
3192 if (verbose_fd != NULL)
3193 {
3194 fclose(verbose_fd);
3195 verbose_fd = NULL;
3196 }
3197 verbose_did_open = FALSE;
3198}
3199
3200/*
3201 * Open the file 'verbosefile'.
3202 * Return FAIL or OK.
3203 */
3204 int
3205verbose_open()
3206{
3207 if (verbose_fd == NULL && !verbose_did_open)
3208 {
3209 /* Only give the error message once. */
3210 verbose_did_open = TRUE;
3211
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003212 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003213 if (verbose_fd == NULL)
3214 {
3215 EMSG2(_(e_notopen), p_vfile);
3216 return FAIL;
3217 }
3218 }
3219 return OK;
3220}
3221
3222/*
3223 * Write a string to 'verbosefile'.
3224 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3225 */
3226 static void
3227verbose_write(str, maxlen)
3228 char_u *str;
3229 int maxlen;
3230{
3231 char_u *s = str;
3232 static int cur_col = 0;
3233
3234 /* Open the file when called the first time. */
3235 if (verbose_fd == NULL)
3236 verbose_open();
3237
3238 if (verbose_fd != NULL)
3239 {
3240 /* If the string doesn't start with CR or NL, go to msg_col */
3241 if (*s != '\n' && *s != '\r')
3242 {
3243 while (cur_col < msg_col)
3244 {
3245 fputs(" ", verbose_fd);
3246 ++cur_col;
3247 }
3248 }
3249
3250 /* Adjust the current column */
3251 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3252 {
3253 putc(*s, verbose_fd);
3254 if (*s == '\r' || *s == '\n')
3255 cur_col = 0;
3256 else if (*s == '\t')
3257 cur_col += (8 - cur_col % 8);
3258 else
3259 ++cur_col;
3260 ++s;
3261 }
3262 }
3263}
3264
3265/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 * Give a warning message (for searching).
3267 * Use 'w' highlighting and may repeat the message after redrawing
3268 */
3269 void
3270give_warning(message, hl)
3271 char_u *message;
3272 int hl;
3273{
3274 /* Don't do this for ":silent". */
3275 if (msg_silent != 0)
3276 return;
3277
3278 /* Don't want a hit-enter prompt here. */
3279 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003280
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281#ifdef FEAT_EVAL
3282 set_vim_var_string(VV_WARNINGMSG, message, -1);
3283#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 vim_free(keep_msg);
3285 keep_msg = NULL;
3286 if (hl)
3287 keep_msg_attr = hl_attr(HLF_W);
3288 else
3289 keep_msg_attr = 0;
3290 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003291 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 msg_didout = FALSE; /* overwrite this message */
3293 msg_nowait = TRUE; /* don't wait for this message */
3294 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003295
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 --no_wait_return;
3297}
3298
3299/*
3300 * Advance msg cursor to column "col".
3301 */
3302 void
3303msg_advance(col)
3304 int col;
3305{
3306 if (msg_silent != 0) /* nothing to advance to */
3307 {
3308 msg_col = col; /* for redirection, may fill it up later */
3309 return;
3310 }
3311 if (col >= Columns) /* not enough room */
3312 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003313#ifdef FEAT_RIGHTLEFT
3314 if (cmdmsg_rl)
3315 while (msg_col > Columns - col)
3316 msg_putchar(' ');
3317 else
3318#endif
3319 while (msg_col < col)
3320 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321}
3322
3323#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3324/*
3325 * Used for "confirm()" function, and the :confirm command prefix.
3326 * Versions which haven't got flexible dialogs yet, and console
3327 * versions, get this generic handler which uses the command line.
3328 *
3329 * type = one of:
3330 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3331 * title = title string (can be NULL for default)
3332 * (neither used in console dialogs at the moment)
3333 *
3334 * Format of the "buttons" string:
3335 * "Button1Name\nButton2Name\nButton3Name"
3336 * The first button should normally be the default/accept
3337 * The second button should be the 'Cancel' button
3338 * Other buttons- use your imagination!
3339 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3340 * different letter.
3341 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 int
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003343do_dialog(type, title, message, buttons, dfltbutton, textfield, ex_cmd)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003344 int type UNUSED;
3345 char_u *title UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 char_u *message;
3347 char_u *buttons;
3348 int dfltbutton;
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003349 char_u *textfield UNUSED; /* IObuff for inputdialog(), NULL
3350 otherwise */
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003351 int ex_cmd; /* when TRUE pressing : accepts default and starts
3352 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353{
3354 int oldState;
3355 int retval = 0;
3356 char_u *hotkeys;
3357 int c;
3358 int i;
3359
3360#ifndef NO_CONSOLE
3361 /* Don't output anything in silent mode ("ex -s") */
3362 if (silent_mode)
3363 return dfltbutton; /* return default option */
3364#endif
3365
3366#ifdef FEAT_GUI_DIALOG
3367 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3368 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3369 {
3370 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003371 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003372 /* avoid a hit-enter prompt without clearing the cmdline */
3373 need_wait_return = FALSE;
3374 emsg_on_display = FALSE;
3375 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
3377 /* Flush output to avoid that further messages and redrawing is done
3378 * in the wrong order. */
3379 out_flush();
3380 gui_mch_update();
3381
3382 return c;
3383 }
3384#endif
3385
3386 oldState = State;
3387 State = CONFIRM;
3388#ifdef FEAT_MOUSE
3389 setmouse();
3390#endif
3391
3392 /*
3393 * Since we wait for a keypress, don't make the
3394 * user press RETURN as well afterwards.
3395 */
3396 ++no_wait_return;
3397 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3398
3399 if (hotkeys != NULL)
3400 {
3401 for (;;)
3402 {
3403 /* Get a typed character directly from the user. */
3404 c = get_keystroke();
3405 switch (c)
3406 {
3407 case CAR: /* User accepts default option */
3408 case NL:
3409 retval = dfltbutton;
3410 break;
3411 case Ctrl_C: /* User aborts/cancels */
3412 case ESC:
3413 retval = 0;
3414 break;
3415 default: /* Could be a hotkey? */
3416 if (c < 0) /* special keys are ignored here */
3417 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003418 if (c == ':' && ex_cmd)
3419 {
3420 retval = dfltbutton;
3421 ins_char_typebuf(':');
3422 break;
3423 }
3424
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 /* Make the character lowercase, as chars in "hotkeys" are. */
3426 c = MB_TOLOWER(c);
3427 retval = 1;
3428 for (i = 0; hotkeys[i]; ++i)
3429 {
3430#ifdef FEAT_MBYTE
3431 if (has_mbyte)
3432 {
3433 if ((*mb_ptr2char)(hotkeys + i) == c)
3434 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003435 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 }
3437 else
3438#endif
3439 if (hotkeys[i] == c)
3440 break;
3441 ++retval;
3442 }
3443 if (hotkeys[i])
3444 break;
3445 /* No hotkey match, so keep waiting */
3446 continue;
3447 }
3448 break;
3449 }
3450
3451 vim_free(hotkeys);
3452 }
3453
3454 State = oldState;
3455#ifdef FEAT_MOUSE
3456 setmouse();
3457#endif
3458 --no_wait_return;
3459 msg_end_prompt();
3460
3461 return retval;
3462}
3463
3464static int copy_char __ARGS((char_u *from, char_u *to, int lowercase));
3465
3466/*
3467 * Copy one character from "*from" to "*to", taking care of multi-byte
3468 * characters. Return the length of the character in bytes.
3469 */
3470 static int
3471copy_char(from, to, lowercase)
3472 char_u *from;
3473 char_u *to;
3474 int lowercase; /* make character lower case */
3475{
3476#ifdef FEAT_MBYTE
3477 int len;
3478 int c;
3479
3480 if (has_mbyte)
3481 {
3482 if (lowercase)
3483 {
3484 c = MB_TOLOWER((*mb_ptr2char)(from));
3485 return (*mb_char2bytes)(c, to);
3486 }
3487 else
3488 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003489 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 mch_memmove(to, from, (size_t)len);
3491 return len;
3492 }
3493 }
3494 else
3495#endif
3496 {
3497 if (lowercase)
3498 *to = (char_u)TOLOWER_LOC(*from);
3499 else
3500 *to = *from;
3501 return 1;
3502 }
3503}
3504
3505/*
3506 * Format the dialog string, and display it at the bottom of
3507 * the screen. Return a string of hotkey chars (if defined) for
3508 * each 'button'. If a button has no hotkey defined, the first character of
3509 * the button is used.
3510 * The hotkeys can be multi-byte characters, but without combining chars.
3511 *
3512 * Returns an allocated string with hotkeys, or NULL for error.
3513 */
3514 static char_u *
3515msg_show_console_dialog(message, buttons, dfltbutton)
3516 char_u *message;
3517 char_u *buttons;
3518 int dfltbutton;
3519{
3520 int len = 0;
3521#ifdef FEAT_MBYTE
3522# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3523#else
3524# define HOTK_LEN 1
3525#endif
3526 int lenhotkey = HOTK_LEN; /* count first button */
3527 char_u *hotk = NULL;
3528 char_u *msgp = NULL;
3529 char_u *hotkp = NULL;
3530 char_u *r;
3531 int copy;
3532#define HAS_HOTKEY_LEN 30
3533 char_u has_hotkey[HAS_HOTKEY_LEN];
3534 int first_hotkey = FALSE; /* first char of button is hotkey */
3535 int idx;
3536
3537 has_hotkey[0] = FALSE;
3538
3539 /*
3540 * First loop: compute the size of memory to allocate.
3541 * Second loop: copy to the allocated memory.
3542 */
3543 for (copy = 0; copy <= 1; ++copy)
3544 {
3545 r = buttons;
3546 idx = 0;
3547 while (*r)
3548 {
3549 if (*r == DLG_BUTTON_SEP)
3550 {
3551 if (copy)
3552 {
3553 *msgp++ = ',';
3554 *msgp++ = ' '; /* '\n' -> ', ' */
3555
3556 /* advance to next hotkey and set default hotkey */
3557#ifdef FEAT_MBYTE
3558 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003559 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 else
3561#endif
3562 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003563 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 if (dfltbutton)
3565 --dfltbutton;
3566
3567 /* If no hotkey is specified first char is used. */
3568 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3569 first_hotkey = TRUE;
3570 }
3571 else
3572 {
3573 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3574 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3575 if (idx < HAS_HOTKEY_LEN - 1)
3576 has_hotkey[++idx] = FALSE;
3577 }
3578 }
3579 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3580 {
3581 if (*r == DLG_HOTKEY_CHAR)
3582 ++r;
3583 first_hotkey = FALSE;
3584 if (copy)
3585 {
3586 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3587 *msgp++ = *r;
3588 else
3589 {
3590 /* '&a' -> '[a]' */
3591 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3592 msgp += copy_char(r, msgp, FALSE);
3593 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3594
3595 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003596 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 }
3598 }
3599 else
3600 {
3601 ++len; /* '&a' -> '[a]' */
3602 if (idx < HAS_HOTKEY_LEN - 1)
3603 has_hotkey[idx] = TRUE;
3604 }
3605 }
3606 else
3607 {
3608 /* everything else copy literally */
3609 if (copy)
3610 msgp += copy_char(r, msgp, FALSE);
3611 }
3612
3613 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003614 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 }
3616
3617 if (copy)
3618 {
3619 *msgp++ = ':';
3620 *msgp++ = ' ';
3621 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 }
3623 else
3624 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003625 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003626 + 2 /* for the NL's */
3627 + STRLEN(buttons)
3628 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003629 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630
3631 /* If no hotkey is specified first char is used. */
3632 if (!has_hotkey[0])
3633 {
3634 first_hotkey = TRUE;
3635 len += 2; /* "x" -> "[x]" */
3636 }
3637
3638 /*
3639 * Now allocate and load the strings
3640 */
3641 vim_free(confirm_msg);
3642 confirm_msg = alloc(len);
3643 if (confirm_msg == NULL)
3644 return NULL;
3645 *confirm_msg = NUL;
3646 hotk = alloc(lenhotkey);
3647 if (hotk == NULL)
3648 return NULL;
3649
3650 *confirm_msg = '\n';
3651 STRCPY(confirm_msg + 1, message);
3652
3653 msgp = confirm_msg + 1 + STRLEN(message);
3654 hotkp = hotk;
3655
Bram Moolenaar6a516062007-07-05 08:11:42 +00003656 /* Define first default hotkey. Keep the hotkey string NUL
3657 * terminated to avoid reading past the end. */
3658 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659
3660 /* Remember where the choices start, displaying starts here when
3661 * "hotkp" typed at the more prompt. */
3662 confirm_msg_tail = msgp;
3663 *msgp++ = '\n';
3664 }
3665 }
3666
3667 display_confirm_msg();
3668 return hotk;
3669}
3670
3671/*
3672 * Display the ":confirm" message. Also called when screen resized.
3673 */
3674 void
3675display_confirm_msg()
3676{
3677 /* avoid that 'q' at the more prompt truncates the message here */
3678 ++confirm_msg_used;
3679 if (confirm_msg != NULL)
3680 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3681 --confirm_msg_used;
3682}
3683
3684#endif /* FEAT_CON_DIALOG */
3685
3686#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3687
3688 int
3689vim_dialog_yesno(type, title, message, dflt)
3690 int type;
3691 char_u *title;
3692 char_u *message;
3693 int dflt;
3694{
3695 if (do_dialog(type,
3696 title == NULL ? (char_u *)_("Question") : title,
3697 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003698 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 return VIM_YES;
3700 return VIM_NO;
3701}
3702
3703 int
3704vim_dialog_yesnocancel(type, title, message, dflt)
3705 int type;
3706 char_u *title;
3707 char_u *message;
3708 int dflt;
3709{
3710 switch (do_dialog(type,
3711 title == NULL ? (char_u *)_("Question") : title,
3712 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003713 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 {
3715 case 1: return VIM_YES;
3716 case 2: return VIM_NO;
3717 }
3718 return VIM_CANCEL;
3719}
3720
3721 int
3722vim_dialog_yesnoallcancel(type, title, message, dflt)
3723 int type;
3724 char_u *title;
3725 char_u *message;
3726 int dflt;
3727{
3728 switch (do_dialog(type,
3729 title == NULL ? (char_u *)"Question" : title,
3730 message,
3731 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003732 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 {
3734 case 1: return VIM_YES;
3735 case 2: return VIM_NO;
3736 case 3: return VIM_ALL;
3737 case 4: return VIM_DISCARDALL;
3738 }
3739 return VIM_CANCEL;
3740}
3741
3742#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3743
3744#if defined(FEAT_BROWSE) || defined(PROTO)
3745/*
3746 * Generic browse function. Calls gui_mch_browse() when possible.
3747 * Later this may pop-up a non-GUI file selector (external command?).
3748 */
3749 char_u *
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003750do_browse(flags, title, dflt, ext, initdir, filter, buf)
3751 int flags; /* BROWSE_SAVE and BROWSE_DIR */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 char_u *title; /* title for the window */
3753 char_u *dflt; /* default file name (may include directory) */
3754 char_u *ext; /* extension added */
3755 char_u *initdir; /* initial directory, NULL for current dir or
3756 when using path from "dflt" */
3757 char_u *filter; /* file name filter */
3758 buf_T *buf; /* buffer to read/write for */
3759{
3760 char_u *fname;
3761 static char_u *last_dir = NULL; /* last used directory */
3762 char_u *tofree = NULL;
3763 int save_browse = cmdmod.browse;
3764
3765 /* Must turn off browse to avoid that autocommands will get the
3766 * flag too! */
3767 cmdmod.browse = FALSE;
3768
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003769 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003771 if (flags & BROWSE_DIR)
3772 title = (char_u *)_("Select Directory dialog");
3773 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 title = (char_u *)_("Save File dialog");
3775 else
3776 title = (char_u *)_("Open File dialog");
3777 }
3778
3779 /* When no directory specified, use default file name, default dir, buffer
3780 * dir, last dir or current dir */
3781 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3782 {
3783 if (mch_isdir(dflt)) /* default file name is a directory */
3784 {
3785 initdir = dflt;
3786 dflt = NULL;
3787 }
3788 else if (gettail(dflt) != dflt) /* default file name includes a path */
3789 {
3790 tofree = vim_strsave(dflt);
3791 if (tofree != NULL)
3792 {
3793 initdir = tofree;
3794 *gettail(initdir) = NUL;
3795 dflt = gettail(dflt);
3796 }
3797 }
3798 }
3799
3800 if (initdir == NULL || *initdir == NUL)
3801 {
3802 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003803 if (STRCMP(p_bsdir, "last") != 0
3804 && STRCMP(p_bsdir, "buffer") != 0
3805 && STRCMP(p_bsdir, "current") != 0
3806 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 initdir = p_bsdir;
3808 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003809 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 && buf != NULL && buf->b_ffname != NULL)
3811 {
3812 if (dflt == NULL || *dflt == NUL)
3813 dflt = gettail(curbuf->b_ffname);
3814 tofree = vim_strsave(curbuf->b_ffname);
3815 if (tofree != NULL)
3816 {
3817 initdir = tofree;
3818 *gettail(initdir) = NUL;
3819 }
3820 }
3821 /* When 'browsedir' is "last", use dir from last browse */
3822 else if (*p_bsdir == 'l')
3823 initdir = last_dir;
3824 /* When 'browsedir is "current", use current directory. This is the
3825 * default already, leave initdir empty. */
3826 }
3827
3828# ifdef FEAT_GUI
3829 if (gui.in_use) /* when this changes, also adjust f_has()! */
3830 {
3831 if (filter == NULL
3832# ifdef FEAT_EVAL
3833 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3834 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3835# endif
3836 )
3837 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003838 if (flags & BROWSE_DIR)
3839 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003840# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003841 /* For systems that have a directory dialog. */
3842 fname = gui_mch_browsedir(title, initdir);
3843# else
3844 /* Generic solution for selecting a directory: select a file and
3845 * remove the file name. */
3846 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3847# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003848# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003849 /* Win32 adds a dummy file name, others return an arbitrary file
3850 * name. GTK+ 2 returns only the directory, */
3851 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3852 {
3853 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003854 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003855
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003856 if (tail == fname)
3857 *tail++ = '.'; /* use current dir */
3858 *tail = NUL;
3859 }
3860# endif
3861 }
3862 else
3863 fname = gui_mch_browse(flags & BROWSE_SAVE,
3864 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865
3866 /* We hang around in the dialog for a while, the user might do some
3867 * things to our files. The Win32 dialog allows deleting or renaming
3868 * a file, check timestamps. */
3869 need_check_timestamps = TRUE;
3870 did_check_timestamps = FALSE;
3871 }
3872 else
3873# endif
3874 {
3875 /* TODO: non-GUI file selector here */
3876 EMSG(_("E338: Sorry, no file browser in console mode"));
3877 fname = NULL;
3878 }
3879
3880 /* keep the directory for next time */
3881 if (fname != NULL)
3882 {
3883 vim_free(last_dir);
3884 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003885 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 {
3887 *gettail(last_dir) = NUL;
3888 if (*last_dir == NUL)
3889 {
3890 /* filename only returned, must be in current dir */
3891 vim_free(last_dir);
3892 last_dir = alloc(MAXPATHL);
3893 if (last_dir != NULL)
3894 mch_dirname(last_dir, MAXPATHL);
3895 }
3896 }
3897 }
3898
3899 vim_free(tofree);
3900 cmdmod.browse = save_browse;
3901
3902 return fname;
3903}
3904#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003905
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003906#if defined(HAVE_STDARG_H) && defined(FEAT_EVAL)
3907static char *e_printf = N_("E766: Insufficient arguments for printf()");
3908
3909static long tv_nr __ARGS((typval_T *tvs, int *idxp));
3910static char *tv_str __ARGS((typval_T *tvs, int *idxp));
Bram Moolenaara7241f52008-06-24 20:39:31 +00003911# ifdef FEAT_FLOAT
3912static double tv_float __ARGS((typval_T *tvs, int *idxp));
3913# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003914
3915/*
3916 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3917 */
3918 static long
3919tv_nr(tvs, idxp)
3920 typval_T *tvs;
3921 int *idxp;
3922{
3923 int idx = *idxp - 1;
3924 long n = 0;
3925 int err = FALSE;
3926
3927 if (tvs[idx].v_type == VAR_UNKNOWN)
3928 EMSG(_(e_printf));
3929 else
3930 {
3931 ++*idxp;
3932 n = get_tv_number_chk(&tvs[idx], &err);
3933 if (err)
3934 n = 0;
3935 }
3936 return n;
3937}
3938
3939/*
3940 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003941 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003942 */
3943 static char *
3944tv_str(tvs, idxp)
3945 typval_T *tvs;
3946 int *idxp;
3947{
3948 int idx = *idxp - 1;
3949 char *s = NULL;
3950
3951 if (tvs[idx].v_type == VAR_UNKNOWN)
3952 EMSG(_(e_printf));
3953 else
3954 {
3955 ++*idxp;
3956 s = (char *)get_tv_string_chk(&tvs[idx]);
3957 }
3958 return s;
3959}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003960
3961# ifdef FEAT_FLOAT
3962/*
3963 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3964 */
3965 static double
3966tv_float(tvs, idxp)
3967 typval_T *tvs;
3968 int *idxp;
3969{
3970 int idx = *idxp - 1;
3971 double f = 0;
3972
3973 if (tvs[idx].v_type == VAR_UNKNOWN)
3974 EMSG(_(e_printf));
3975 else
3976 {
3977 ++*idxp;
3978 if (tvs[idx].v_type == VAR_FLOAT)
3979 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003980 else if (tvs[idx].v_type == VAR_NUMBER)
3981 f = tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003982 else
3983 EMSG(_("E807: Expected Float argument for printf()"));
3984 }
3985 return f;
3986}
3987# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003988#endif
3989
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003990/*
3991 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003992 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003993 * consistency.
3994 *
3995 * This code is based on snprintf.c - a portable implementation of snprintf
3996 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003997 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003998 * The original code, including useful comments, can be found here:
3999 * http://www.ijs.si/software/snprintf/
4000 *
4001 * This snprintf() only supports the following conversion specifiers:
4002 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4003 * with flags: '-', '+', ' ', '0' and '#'.
4004 * An asterisk is supported for field width as well as precision.
4005 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00004006 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
4007 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004008 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
4009 * 'll' (long long int) is not supported.
4010 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004011 * The locale is not used, the string is used as a byte string. This is only
4012 * relevant for double-byte encodings where the second byte may be '%'.
4013 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004014 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4015 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004016 *
4017 * The return value is the number of characters which would be generated
4018 * for the given input, excluding the trailing null. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004019 * is greater or equal to "str_m", not all characters from the result
4020 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4021 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004022 * the resulting string will be null-terminated.
4023 */
4024
4025/*
4026 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004027 *
4028 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004029 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004030 */
4031
4032/* When generating prototypes all of this is skipped, cproto doesn't
4033 * understand this. */
4034#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004035
4036# ifdef HAVE_STDARG_H
4037/* Like vim_vsnprintf() but append to the string. */
4038 int
4039vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4040{
4041 va_list ap;
4042 int str_l;
4043 size_t len = STRLEN(str);
4044 size_t space;
4045
4046 if (str_m <= len)
4047 space = 0;
4048 else
4049 space = str_m - len;
4050 va_start(ap, fmt);
4051 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
4052 va_end(ap);
4053 return str_l;
4054}
4055# else
4056/* Like vim_vsnprintf() but append to the string. */
4057 int
4058vim_snprintf_add(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4059 char *str;
4060 size_t str_m;
4061 char *fmt;
4062 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4063{
4064 size_t len = STRLEN(str);
4065 size_t space;
4066
4067 if (str_m <= len)
4068 space = 0;
4069 else
4070 space = str_m - len;
4071 return vim_vsnprintf(str + len, space, fmt,
4072 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10);
4073}
4074# endif
4075
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004076# ifdef HAVE_STDARG_H
4077 int
4078vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4079{
4080 va_list ap;
4081 int str_l;
4082
4083 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004084 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004085 va_end(ap);
4086 return str_l;
4087}
4088
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004089 int
4090vim_vsnprintf(str, str_m, fmt, ap, tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004091# else
4092 /* clumsy way to work around missing va_list */
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004093# 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 +00004094
4095/* VARARGS */
4096 int
4097#ifdef __BORLANDC__
4098_RTLENTRYF
4099#endif
4100vim_snprintf(str, str_m, fmt, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
4101# endif
4102 char *str;
4103 size_t str_m;
4104 char *fmt;
4105# ifdef HAVE_STDARG_H
4106 va_list ap;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004107 typval_T *tvs;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004108# else
4109 long a1, a2, a3, a4, a5, a6, a7, a8, a9, a10;
4110# endif
4111{
4112 size_t str_l = 0;
4113 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004114 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004115
4116 if (p == NULL)
4117 p = "";
4118 while (*p != NUL)
4119 {
4120 if (*p != '%')
4121 {
4122 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004123 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004124
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004125 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004126 if (str_l < str_m)
4127 {
4128 size_t avail = str_m - str_l;
4129
4130 mch_memmove(str + str_l, p, n > avail ? avail : n);
4131 }
4132 p += n;
4133 str_l += n;
4134 }
4135 else
4136 {
4137 size_t min_field_width = 0, precision = 0;
4138 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4139 int alternate_form = 0, force_sign = 0;
4140
4141 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4142 * ignored. */
4143 int space_for_positive = 1;
4144
4145 /* allowed values: \0, h, l, L */
4146 char length_modifier = '\0';
4147
4148 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004149#ifdef FEAT_FLOAT
4150# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
4151 * That sounds reasonable to use as the maximum
4152 * printable. */
4153#else
4154# define TMP_LEN 32
4155#endif
4156 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004157
4158 /* string address in case of string argument */
4159 char *str_arg;
4160
4161 /* natural field width of arg without padding and sign */
4162 size_t str_arg_l;
4163
4164 /* unsigned char argument value - only defined for c conversion.
4165 * N.B. standard explicitly states the char argument for the c
4166 * conversion is unsigned */
4167 unsigned char uchar_arg;
4168
4169 /* number of zeros to be inserted for numeric conversions as
4170 * required by the precision or minimal field width */
4171 size_t number_of_zeros_to_pad = 0;
4172
4173 /* index into tmp where zero padding is to be inserted */
4174 size_t zero_padding_insertion_ind = 0;
4175
4176 /* current conversion specifier character */
4177 char fmt_spec = '\0';
4178
4179 str_arg = NULL;
4180 p++; /* skip '%' */
4181
4182 /* parse flags */
4183 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4184 || *p == '#' || *p == '\'')
4185 {
4186 switch (*p)
4187 {
4188 case '0': zero_padding = 1; break;
4189 case '-': justify_left = 1; break;
4190 case '+': force_sign = 1; space_for_positive = 0; break;
4191 case ' ': force_sign = 1;
4192 /* If both the ' ' and '+' flags appear, the ' '
4193 * flag should be ignored */
4194 break;
4195 case '#': alternate_form = 1; break;
4196 case '\'': break;
4197 }
4198 p++;
4199 }
4200 /* If the '0' and '-' flags both appear, the '0' flag should be
4201 * ignored. */
4202
4203 /* parse field width */
4204 if (*p == '*')
4205 {
4206 int j;
4207
4208 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004209 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004210#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004211 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004212#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004213# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004214 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004215# endif
4216 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004217#endif
4218 if (j >= 0)
4219 min_field_width = j;
4220 else
4221 {
4222 min_field_width = -j;
4223 justify_left = 1;
4224 }
4225 }
4226 else if (VIM_ISDIGIT((int)(*p)))
4227 {
4228 /* size_t could be wider than unsigned int; make sure we treat
4229 * argument like common implementations do */
4230 unsigned int uj = *p++ - '0';
4231
4232 while (VIM_ISDIGIT((int)(*p)))
4233 uj = 10 * uj + (unsigned int)(*p++ - '0');
4234 min_field_width = uj;
4235 }
4236
4237 /* parse precision */
4238 if (*p == '.')
4239 {
4240 p++;
4241 precision_specified = 1;
4242 if (*p == '*')
4243 {
4244 int j;
4245
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004246 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004247#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004248 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004249#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004250# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004251 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004252# endif
4253 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004254#endif
4255 p++;
4256 if (j >= 0)
4257 precision = j;
4258 else
4259 {
4260 precision_specified = 0;
4261 precision = 0;
4262 }
4263 }
4264 else if (VIM_ISDIGIT((int)(*p)))
4265 {
4266 /* size_t could be wider than unsigned int; make sure we
4267 * treat argument like common implementations do */
4268 unsigned int uj = *p++ - '0';
4269
4270 while (VIM_ISDIGIT((int)(*p)))
4271 uj = 10 * uj + (unsigned int)(*p++ - '0');
4272 precision = uj;
4273 }
4274 }
4275
4276 /* parse 'h', 'l' and 'll' length modifiers */
4277 if (*p == 'h' || *p == 'l')
4278 {
4279 length_modifier = *p;
4280 p++;
4281 if (length_modifier == 'l' && *p == 'l')
4282 {
4283 /* double l = long long */
4284 length_modifier = 'l'; /* treat it as a single 'l' */
4285 p++;
4286 }
4287 }
4288 fmt_spec = *p;
4289
4290 /* common synonyms: */
4291 switch (fmt_spec)
4292 {
4293 case 'i': fmt_spec = 'd'; break;
4294 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4295 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4296 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004297 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004298 default: break;
4299 }
4300
4301 /* get parameter value, do initial processing */
4302 switch (fmt_spec)
4303 {
4304 /* '%' and 'c' behave similar to 's' regarding flags and field
4305 * widths */
4306 case '%':
4307 case 'c':
4308 case 's':
4309 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004310 str_arg_l = 1;
4311 switch (fmt_spec)
4312 {
4313 case '%':
4314 str_arg = p;
4315 break;
4316
4317 case 'c':
4318 {
4319 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004320
4321 j =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004322#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004323 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004325# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004326 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004327# endif
4328 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004329#endif
4330 /* standard demands unsigned char */
4331 uchar_arg = (unsigned char)j;
4332 str_arg = (char *)&uchar_arg;
4333 break;
4334 }
4335
4336 case 's':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004337 str_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004338#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004339 (char *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004340#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004341# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004342 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004343# endif
4344 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004345#endif
4346 if (str_arg == NULL)
4347 {
4348 str_arg = "[NULL]";
4349 str_arg_l = 6;
4350 }
4351 /* make sure not to address string beyond the specified
4352 * precision !!! */
4353 else if (!precision_specified)
4354 str_arg_l = strlen(str_arg);
4355 /* truncate string if necessary as requested by precision */
4356 else if (precision == 0)
4357 str_arg_l = 0;
4358 else
4359 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004360 /* Don't put the #if inside memchr(), it can be a
4361 * macro. */
4362#if SIZEOF_INT <= 2
4363 char *q = memchr(str_arg, '\0', precision);
4364#else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004365 /* memchr on HP does not like n > 2^31 !!! */
4366 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004367 precision <= (size_t)0x7fffffffL ? precision
4368 : (size_t)0x7fffffffL);
Bram Moolenaar3991dab2006-03-27 17:01:56 +00004369#endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004370 str_arg_l = (q == NULL) ? precision
4371 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004372 }
4373 break;
4374
4375 default:
4376 break;
4377 }
4378 break;
4379
4380 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4381 {
4382 /* NOTE: the u, o, x, X and p conversion specifiers
4383 * imply the value is unsigned; d implies a signed
4384 * value */
4385
4386 /* 0 if numeric argument is zero (or if pointer is
4387 * NULL for 'p'), +1 if greater than zero (or nonzero
4388 * for unsigned arguments), -1 if negative (unsigned
4389 * argument is never negative) */
4390 int arg_sign = 0;
4391
4392 /* only defined for length modifier h, or for no
4393 * length modifiers */
4394 int int_arg = 0;
4395 unsigned int uint_arg = 0;
4396
4397 /* only defined for length modifier l */
4398 long int long_arg = 0;
4399 unsigned long int ulong_arg = 0;
4400
4401 /* pointer argument value -only defined for p
4402 * conversion */
4403 void *ptr_arg = NULL;
4404
4405 if (fmt_spec == 'p')
4406 {
4407 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004408 ptr_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004409#ifndef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004410 (void *)get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004411#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004412# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004413 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004414# endif
4415 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004416#endif
4417 if (ptr_arg != NULL)
4418 arg_sign = 1;
4419 }
4420 else if (fmt_spec == 'd')
4421 {
4422 /* signed */
4423 switch (length_modifier)
4424 {
4425 case '\0':
4426 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004427 /* char and short arguments are passed as int. */
4428 int_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004429#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004430 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004431#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004432# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004433 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004434# endif
4435 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004436#endif
4437 if (int_arg > 0)
4438 arg_sign = 1;
4439 else if (int_arg < 0)
4440 arg_sign = -1;
4441 break;
4442 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004443 long_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004444#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004445 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004446#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004447# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004448 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004449# endif
4450 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004451#endif
4452 if (long_arg > 0)
4453 arg_sign = 1;
4454 else if (long_arg < 0)
4455 arg_sign = -1;
4456 break;
4457 }
4458 }
4459 else
4460 {
4461 /* unsigned */
4462 switch (length_modifier)
4463 {
4464 case '\0':
4465 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004466 uint_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004467#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004468 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004469#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004470# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004471 tvs != NULL ? (unsigned)
4472 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004473# endif
4474 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004475#endif
4476 if (uint_arg != 0)
4477 arg_sign = 1;
4478 break;
4479 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004480 ulong_arg =
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004481#ifndef HAVE_STDARG_H
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004482 get_a_arg(arg_idx);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004483#else
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004484# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004485 tvs != NULL ? (unsigned long)
4486 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004487# endif
4488 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004489#endif
4490 if (ulong_arg != 0)
4491 arg_sign = 1;
4492 break;
4493 }
4494 }
4495
4496 str_arg = tmp;
4497 str_arg_l = 0;
4498
4499 /* NOTE:
4500 * For d, i, u, o, x, and X conversions, if precision is
4501 * specified, the '0' flag should be ignored. This is so
4502 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4503 * FreeBSD, NetBSD; but not with Perl.
4504 */
4505 if (precision_specified)
4506 zero_padding = 0;
4507 if (fmt_spec == 'd')
4508 {
4509 if (force_sign && arg_sign >= 0)
4510 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4511 /* leave negative numbers for sprintf to handle, to
4512 * avoid handling tricky cases like (short int)-32768 */
4513 }
4514 else if (alternate_form)
4515 {
4516 if (arg_sign != 0
4517 && (fmt_spec == 'x' || fmt_spec == 'X') )
4518 {
4519 tmp[str_arg_l++] = '0';
4520 tmp[str_arg_l++] = fmt_spec;
4521 }
4522 /* alternate form should have no effect for p
4523 * conversion, but ... */
4524 }
4525
4526 zero_padding_insertion_ind = str_arg_l;
4527 if (!precision_specified)
4528 precision = 1; /* default precision is 1 */
4529 if (precision == 0 && arg_sign == 0)
4530 {
4531 /* When zero value is formatted with an explicit
4532 * precision 0, the resulting formatted string is
4533 * empty (d, i, u, o, x, X, p). */
4534 }
4535 else
4536 {
4537 char f[5];
4538 int f_l = 0;
4539
4540 /* construct a simple format string for sprintf */
4541 f[f_l++] = '%';
4542 if (!length_modifier)
4543 ;
4544 else if (length_modifier == '2')
4545 {
4546 f[f_l++] = 'l';
4547 f[f_l++] = 'l';
4548 }
4549 else
4550 f[f_l++] = length_modifier;
4551 f[f_l++] = fmt_spec;
4552 f[f_l++] = '\0';
4553
4554 if (fmt_spec == 'p')
4555 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4556 else if (fmt_spec == 'd')
4557 {
4558 /* signed */
4559 switch (length_modifier)
4560 {
4561 case '\0':
4562 case 'h': str_arg_l += sprintf(
4563 tmp + str_arg_l, f, int_arg);
4564 break;
4565 case 'l': str_arg_l += sprintf(
4566 tmp + str_arg_l, f, long_arg);
4567 break;
4568 }
4569 }
4570 else
4571 {
4572 /* unsigned */
4573 switch (length_modifier)
4574 {
4575 case '\0':
4576 case 'h': str_arg_l += sprintf(
4577 tmp + str_arg_l, f, uint_arg);
4578 break;
4579 case 'l': str_arg_l += sprintf(
4580 tmp + str_arg_l, f, ulong_arg);
4581 break;
4582 }
4583 }
4584
4585 /* include the optional minus sign and possible
4586 * "0x" in the region before the zero padding
4587 * insertion point */
4588 if (zero_padding_insertion_ind < str_arg_l
4589 && tmp[zero_padding_insertion_ind] == '-')
4590 zero_padding_insertion_ind++;
4591 if (zero_padding_insertion_ind + 1 < str_arg_l
4592 && tmp[zero_padding_insertion_ind] == '0'
4593 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4594 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4595 zero_padding_insertion_ind += 2;
4596 }
4597
4598 {
4599 size_t num_of_digits = str_arg_l
4600 - zero_padding_insertion_ind;
4601
4602 if (alternate_form && fmt_spec == 'o'
4603 /* unless zero is already the first
4604 * character */
4605 && !(zero_padding_insertion_ind < str_arg_l
4606 && tmp[zero_padding_insertion_ind] == '0'))
4607 {
4608 /* assure leading zero for alternate-form
4609 * octal numbers */
4610 if (!precision_specified
4611 || precision < num_of_digits + 1)
4612 {
4613 /* precision is increased to force the
4614 * first character to be zero, except if a
4615 * zero value is formatted with an
4616 * explicit precision of zero */
4617 precision = num_of_digits + 1;
4618 precision_specified = 1;
4619 }
4620 }
4621 /* zero padding to specified precision? */
4622 if (num_of_digits < precision)
4623 number_of_zeros_to_pad = precision - num_of_digits;
4624 }
4625 /* zero padding to specified minimal field width? */
4626 if (!justify_left && zero_padding)
4627 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004628 int n = (int)(min_field_width - (str_arg_l
4629 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004630 if (n > 0)
4631 number_of_zeros_to_pad += n;
4632 }
4633 break;
4634 }
4635
Bram Moolenaara7241f52008-06-24 20:39:31 +00004636#ifdef FEAT_FLOAT
4637 case 'f':
4638 case 'e':
4639 case 'E':
4640 case 'g':
4641 case 'G':
4642 {
4643 /* Floating point. */
4644 double f;
4645 double abs_f;
4646 char format[40];
4647 int l;
4648 int remove_trailing_zeroes = FALSE;
4649
4650 f =
4651# ifndef HAVE_STDARG_H
4652 get_a_arg(arg_idx);
4653# else
4654# if defined(FEAT_EVAL)
4655 tvs != NULL ? tv_float(tvs, &arg_idx) :
4656# endif
4657 va_arg(ap, double);
4658# endif
4659 abs_f = f < 0 ? -f : f;
4660
4661 if (fmt_spec == 'g' || fmt_spec == 'G')
4662 {
4663 /* Would be nice to use %g directly, but it prints
4664 * "1.0" as "1", we don't want that. */
4665 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4666 || abs_f == 0.0)
4667 fmt_spec = 'f';
4668 else
4669 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4670 remove_trailing_zeroes = TRUE;
4671 }
4672
Bram Moolenaarc9372132009-01-13 15:38:37 +00004673 if (fmt_spec == 'f' &&
4674#ifdef VAX
4675 abs_f > 1.0e38
4676#else
4677 abs_f > 1.0e307
4678#endif
4679 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004680 {
4681 /* Avoid a buffer overflow */
4682 strcpy(tmp, "inf");
4683 str_arg_l = 3;
4684 }
4685 else
4686 {
4687 format[0] = '%';
4688 l = 1;
4689 if (precision_specified)
4690 {
4691 size_t max_prec = TMP_LEN - 10;
4692
4693 /* Make sure we don't get more digits than we
4694 * have room for. */
4695 if (fmt_spec == 'f' && abs_f > 1.0)
4696 max_prec -= (size_t)log10(abs_f);
4697 if (precision > max_prec)
4698 precision = max_prec;
4699 l += sprintf(format + 1, ".%d", (int)precision);
4700 }
4701 format[l] = fmt_spec;
4702 format[l + 1] = NUL;
4703 str_arg_l = sprintf(tmp, format, f);
4704
4705 if (remove_trailing_zeroes)
4706 {
4707 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004708 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004709
4710 /* Using %g or %G: remove superfluous zeroes. */
4711 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004712 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004713 else
4714 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004715 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004716 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004717 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004718 {
4719 /* Remove superfluous '+' and leading
4720 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004721 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004722 {
4723 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004724 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004725 --str_arg_l;
4726 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004727 i = (tp[1] == '-') ? 2 : 1;
4728 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004729 {
4730 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004731 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004732 --str_arg_l;
4733 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004734 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004735 }
4736 }
4737
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004738 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004739 /* Remove trailing zeroes, but keep the one
4740 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004741 while (tp > tmp + 2 && *tp == '0'
4742 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004743 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004744 STRMOVE(tp, tp + 1);
4745 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004746 --str_arg_l;
4747 }
4748 }
4749 else
4750 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004751 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004752
4753 /* Be consistent: some printf("%e") use 1.0e+12
4754 * and some 1.0e+012. Remove one zero in the last
4755 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004756 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004757 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004758 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4759 && tp[2] == '0'
4760 && vim_isdigit(tp[3])
4761 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004762 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004763 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004764 --str_arg_l;
4765 }
4766 }
4767 }
4768 str_arg = tmp;
4769 break;
4770 }
4771#endif
4772
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004773 default:
4774 /* unrecognized conversion specifier, keep format string
4775 * as-is */
4776 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004777 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004778 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004779 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004780
4781 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004782 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004783 str_arg = p;
4784 str_arg_l = 0;
4785 if (*p != NUL)
4786 str_arg_l++; /* include invalid conversion specifier
4787 unchanged if not at end-of-string */
4788 break;
4789 }
4790
4791 if (*p != NUL)
4792 p++; /* step over the just processed conversion specifier */
4793
4794 /* insert padding to the left as requested by min_field_width;
4795 * this does not include the zero padding in case of numerical
4796 * conversions*/
4797 if (!justify_left)
4798 {
4799 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004800 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004801
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004802 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004803 {
4804 if (str_l < str_m)
4805 {
4806 size_t avail = str_m - str_l;
4807
4808 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004809 (size_t)pn > avail ? avail
4810 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004811 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004812 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004813 }
4814 }
4815
4816 /* zero padding as requested by the precision or by the minimal
4817 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004818 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004819 {
4820 /* will not copy first part of numeric right now, *
4821 * force it to be copied later in its entirety */
4822 zero_padding_insertion_ind = 0;
4823 }
4824 else
4825 {
4826 /* insert first part of numerics (sign or '0x') before zero
4827 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004828 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004829
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004830 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004831 {
4832 if (str_l < str_m)
4833 {
4834 size_t avail = str_m - str_l;
4835
4836 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004837 (size_t)zn > avail ? avail
4838 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004839 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004840 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004841 }
4842
4843 /* insert zero padding as requested by the precision or min
4844 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004845 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004846 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004847 {
4848 if (str_l < str_m)
4849 {
4850 size_t avail = str_m-str_l;
4851
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004852 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004853 (size_t)zn > avail ? avail
4854 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004855 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004856 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004857 }
4858 }
4859
4860 /* insert formatted string
4861 * (or as-is conversion specifier for unknown conversions) */
4862 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004863 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004864
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004865 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004866 {
4867 if (str_l < str_m)
4868 {
4869 size_t avail = str_m - str_l;
4870
4871 mch_memmove(str + str_l,
4872 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004873 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004874 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004875 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004876 }
4877 }
4878
4879 /* insert right padding */
4880 if (justify_left)
4881 {
4882 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004883 int pn = (int)(min_field_width
4884 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004885
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004886 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004887 {
4888 if (str_l < str_m)
4889 {
4890 size_t avail = str_m - str_l;
4891
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004892 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004893 (size_t)pn > avail ? avail
4894 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004895 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004896 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004897 }
4898 }
4899 }
4900 }
4901
4902 if (str_m > 0)
4903 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004904 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004905 * overwriting the last character (shouldn't happen, but just in case)
4906 * */
4907 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4908 }
4909
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004910#ifdef HAVE_STDARG_H
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004911 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004912 EMSG(_("E767: Too many arguments to printf()"));
4913#endif
4914
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004915 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004916 * character), that is, the number of characters that would have been
4917 * written to the buffer if it were large enough. */
4918 return (int)str_l;
4919}
4920
4921#endif /* PROTO */