blob: b24013e41d2f5b647607493992021b4a66ebcbe7 [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 Moolenaar92b8b2d2016-01-29 22:36:45 +010018static int other_sourcing_name(void);
19static char_u *get_emsg_source(void);
20static char_u *get_emsg_lnum(void);
21static void add_msg_hist(char_u *s, int len, int attr);
22static void hit_return_msg(void);
23static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000024#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010025static char_u *screen_puts_mbyte(char_u *s, int l, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000026#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010027static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
28static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
29static void msg_scroll_up(void);
30static void inc_msg_scrolled(void);
31static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
32static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
33static void msg_puts_printf(char_u *str, int maxlen);
34static int do_more_prompt(int typed_char);
35static void msg_screen_putchar(int c, int attr);
36static int msg_check_screen(void);
37static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010039static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040static int confirm_msg_used = FALSE; /* displaying confirm_msg */
41static char_u *confirm_msg = NULL; /* ":confirm" message */
42static char_u *confirm_msg_tail; /* tail of confirm_msg */
43#endif
44
45struct msg_hist
46{
47 struct msg_hist *next;
48 char_u *msg;
49 int attr;
50};
51
52static struct msg_hist *first_msg_hist = NULL;
53static struct msg_hist *last_msg_hist = NULL;
54static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020056static FILE *verbose_fd = NULL;
57static int verbose_did_open = FALSE;
58
Bram Moolenaar071d4272004-06-13 20:20:40 +000059/*
60 * When writing messages to the screen, there are many different situations.
61 * A number of variables is used to remember the current state:
62 * msg_didany TRUE when messages were written since the last time the
63 * user reacted to a prompt.
64 * Reset: After hitting a key for the hit-return prompt,
65 * hitting <CR> for the command line or input().
66 * Set: When any message is written to the screen.
67 * msg_didout TRUE when something was written to the current line.
68 * Reset: When advancing to the next line, when the current
69 * text can be overwritten.
70 * Set: When any message is written to the screen.
71 * msg_nowait No extra delay for the last drawn message.
72 * Used in normal_cmd() before the mode message is drawn.
73 * emsg_on_display There was an error message recently. Indicates that there
74 * should be a delay before redrawing.
75 * msg_scroll The next message should not overwrite the current one.
76 * msg_scrolled How many lines the screen has been scrolled (because of
77 * messages). Used in update_screen() to scroll the screen
78 * back. Incremented each time the screen scrolls a line.
79 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
80 * writes something without scrolling should not make
81 * need_wait_return to be set. This is a hack to make ":ts"
82 * work without an extra prompt.
83 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010084 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 * need_wait_return TRUE when the hit-return prompt is needed.
86 * Reset: After giving the hit-return prompt, when the user
87 * has answered some other prompt.
88 * Set: When the ruler or typeahead display is overwritten,
89 * scrolling the screen for some message.
90 * keep_msg Message to be displayed after redrawing the screen, in
91 * main_loop().
92 * This is an allocated string or NULL when not used.
93 */
94
95/*
96 * msg(s) - displays the string 's' on the status line
97 * When terminal not initialized (yet) mch_errmsg(..) is used.
98 * return TRUE if wait_return not called
99 */
100 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100101msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102{
103 return msg_attr_keep(s, 0, FALSE);
104}
105
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000106#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000107 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000108/*
109 * Like msg() but keep it silent when 'verbosefile' is set.
110 */
111 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100112verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000113{
114 int n;
115
116 verbose_enter();
117 n = msg_attr_keep(s, 0, FALSE);
118 verbose_leave();
119
120 return n;
121}
122#endif
123
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100125msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126{
127 return msg_attr_keep(s, attr, FALSE);
128}
129
130 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100131msg_attr_keep(
132 char_u *s,
133 int attr,
134 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135{
136 static int entered = 0;
137 int retval;
138 char_u *buf = NULL;
139
140#ifdef FEAT_EVAL
141 if (attr == 0)
142 set_vim_var_string(VV_STATUSMSG, s, -1);
143#endif
144
145 /*
146 * It is possible that displaying a messages causes a problem (e.g.,
147 * when redrawing the window), which causes another message, etc.. To
148 * break this loop, limit the recursiveness to 3 levels.
149 */
150 if (entered >= 3)
151 return TRUE;
152 ++entered;
153
154 /* Add message to history (unless it's a repeated kept message or a
155 * truncated message) */
156 if (s != keep_msg
157 || (*s != '<'
158 && last_msg_hist != NULL
159 && last_msg_hist->msg != NULL
160 && STRCMP(s, last_msg_hist->msg)))
161 add_msg_hist(s, -1, attr);
162
163 /* When displaying keep_msg, don't let msg_start() free it, caller must do
164 * that. */
165 if (s == keep_msg)
166 keep_msg = NULL;
167
168 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000169 msg_start();
170 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 if (buf != NULL)
172 s = buf;
173
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 msg_outtrans_attr(s, attr);
175 msg_clr_eos();
176 retval = msg_end();
177
178 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
179 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000180 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181
182 vim_free(buf);
183 --entered;
184 return retval;
185}
186
187/*
188 * Truncate a string such that it can be printed without causing a scroll.
189 * Returns an allocated string or NULL when no truncating is done.
190 */
191 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100192msg_strtrunc(
193 char_u *s,
194 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195{
196 char_u *buf = NULL;
197 int len;
198 int room;
199
200 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000201 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
202 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 {
204 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000205 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000206 /* Use all the columns. */
207 room = (int)(Rows - msg_row) * Columns - 1;
208 else
209 /* Use up to 'showcmd' column. */
210 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 if (len > room && room > 0)
212 {
213#ifdef FEAT_MBYTE
214 if (enc_utf8)
215 /* may have up to 18 bytes per cell (6 per char, up to two
216 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100217 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 else if (enc_dbcs == DBCS_JPNU)
219 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100220 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 else
222#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100223 len = room + 2;
224 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100226 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 }
228 }
229 return buf;
230}
231
232/*
233 * Truncate a string "s" to "buf" with cell width "room".
234 * "s" and "buf" may be equal.
235 */
236 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100237trunc_string(
238 char_u *s,
239 char_u *buf,
240 int room,
241 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242{
243 int half;
244 int len;
245 int e;
246 int i;
247 int n;
248
249 room -= 3;
250 half = room / 2;
251 len = 0;
252
253 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100254 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 {
256 if (s[e] == NUL)
257 {
258 /* text fits without truncating! */
259 buf[e] = NUL;
260 return;
261 }
262 n = ptr2cells(s + e);
263 if (len + n >= half)
264 break;
265 len += n;
266 buf[e] = s[e];
267#ifdef FEAT_MBYTE
268 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000269 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100271 if (++e == buflen)
272 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 buf[e] = s[e];
274 }
275#endif
276 }
277
278 /* Last part: End of the string. */
279 i = e;
280#ifdef FEAT_MBYTE
281 if (enc_dbcs != 0)
282 {
283 /* For DBCS going backwards in a string is slow, but
284 * computing the cell width isn't too slow: go forward
285 * until the rest fits. */
286 n = vim_strsize(s + i);
287 while (len + n > room)
288 {
289 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000290 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291 }
292 }
293 else if (enc_utf8)
294 {
295 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000296 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 for (;;)
298 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000299 do
300 half = half - (*mb_head_off)(s, s + half - 1) - 1;
301 while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 n = ptr2cells(s + half);
303 if (len + n > room)
304 break;
305 len += n;
306 i = half;
307 }
308 }
309 else
310#endif
311 {
312 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
313 len += n;
314 }
315
316 /* Set the middle and copy the last part. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100317 if (e + 3 < buflen)
318 {
319 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaar38f5f952012-01-26 13:01:59 +0100320 len = (int)STRLEN(s + i) + 1;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100321 if (len >= buflen - e - 3)
322 len = buflen - e - 3 - 1;
323 mch_memmove(buf + e + 3, s + i, len);
324 buf[e + 3 + len - 1] = NUL;
325 }
326 else
327 {
Bram Moolenaar33c1b192012-01-23 20:48:40 +0100328 buf[e - 1] = NUL; /* make sure it is truncated */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100329 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330}
331
332/*
333 * Automatic prototype generation does not understand this function.
334 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
335 * shorter than IOSIZE!!!
336 */
337#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000339int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000340
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100342# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000343_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100344# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345smsg(char_u *s, ...)
346{
347 va_list arglist;
348
349 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000350 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 va_end(arglist);
352 return msg(IObuff);
353}
354
355 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100356# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100358# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359smsg_attr(int attr, char_u *s, ...)
360{
361 va_list arglist;
362
363 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000364 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365 va_end(arglist);
366 return msg_attr(IObuff, attr);
367}
368
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369#endif
370
371/*
372 * Remember the last sourcing name/lnum used in an error message, so that it
373 * isn't printed each time when it didn't change.
374 */
375static int last_sourcing_lnum = 0;
376static char_u *last_sourcing_name = NULL;
377
378/*
379 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
380 * for the next error message;
381 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000382 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100383reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384{
385 vim_free(last_sourcing_name);
386 last_sourcing_name = NULL;
387 last_sourcing_lnum = 0;
388}
389
390/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000391 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
392 */
393 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100394other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000395{
396 if (sourcing_name != NULL)
397 {
398 if (last_sourcing_name != NULL)
399 return STRCMP(sourcing_name, last_sourcing_name) != 0;
400 return TRUE;
401 }
402 return FALSE;
403}
404
405/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 * Get the message about the source, as used for an error message.
407 * Returns an allocated string with room for one more character.
408 * Returns NULL when no message is to be given.
409 */
410 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100411get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412{
413 char_u *Buf, *p;
414
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000415 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 {
417 p = (char_u *)_("Error detected while processing %s:");
418 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
419 if (Buf != NULL)
420 sprintf((char *)Buf, (char *)p, sourcing_name);
421 return Buf;
422 }
423 return NULL;
424}
425
426/*
427 * Get the message about the source lnum, as used for an error message.
428 * Returns an allocated string with room for one more character.
429 * Returns NULL when no message is to be given.
430 */
431 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100432get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433{
434 char_u *Buf, *p;
435
436 /* lnum is 0 when executing a command from the command line
437 * argument, we don't want a line number then */
438 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000439 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 && sourcing_lnum != 0)
441 {
442 p = (char_u *)_("line %4ld:");
443 Buf = alloc((unsigned)(STRLEN(p) + 20));
444 if (Buf != NULL)
445 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
446 return Buf;
447 }
448 return NULL;
449}
450
451/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000452 * Display name and line number for the source of an error.
453 * Remember the file name and line number, so that for the next error the info
454 * is only displayed if it changed.
455 */
456 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100457msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000458{
459 char_u *p;
460
461 ++no_wait_return;
462 p = get_emsg_source();
463 if (p != NULL)
464 {
465 msg_attr(p, attr);
466 vim_free(p);
467 }
468 p = get_emsg_lnum();
469 if (p != NULL)
470 {
471 msg_attr(p, hl_attr(HLF_N));
472 vim_free(p);
473 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
474 }
475
476 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000477 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000478 {
479 vim_free(last_sourcing_name);
480 if (sourcing_name == NULL)
481 last_sourcing_name = NULL;
482 else
483 last_sourcing_name = vim_strsave(sourcing_name);
484 }
485 --no_wait_return;
486}
487
488/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000489 * Return TRUE if not giving error messages right now:
490 * If "emsg_off" is set: no error messages at the moment.
491 * If "msg" is in 'debug': do error message but without side effects.
492 * If "emsg_skip" is set: never do error messages.
493 */
494 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100495emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000496{
497 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
498 && vim_strchr(p_debug, 't') == NULL)
499#ifdef FEAT_EVAL
500 || emsg_skip > 0
501#endif
502 )
503 return TRUE;
504 return FALSE;
505}
506
507/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508 * emsg() - display an error message
509 *
510 * Rings the bell, if appropriate, and calls message() to do the real work
511 * When terminal not initialized (yet) mch_errmsg(..) is used.
512 *
513 * return TRUE if wait_return not called
514 */
515 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100516emsg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517{
518 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 char_u *p;
520#ifdef FEAT_EVAL
521 int ignore = FALSE;
522 int severe;
523#endif
524
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100525 /* Skip this if not giving error messages at the moment. */
526 if (emsg_not_now())
527 return TRUE;
528
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 called_emsg = TRUE;
Bram Moolenaar8b778d52016-02-18 20:31:34 +0100530 if (emsg_silent == 0)
531 ex_exitval = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
533 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000534 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
535 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536 */
537#ifdef FEAT_EVAL
538 severe = emsg_severe;
539 emsg_severe = FALSE;
540#endif
541
Bram Moolenaar57657d82006-04-21 22:12:41 +0000542 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543 {
544#ifdef FEAT_EVAL
545 /*
546 * Cause a throw of an error exception if appropriate. Don't display
547 * the error message in this case. (If no matching catch clause will
548 * be found, the message will be displayed later on.) "ignore" is set
549 * when the message should be ignored completely (used for the
550 * interrupt message).
551 */
552 if (cause_errthrow(s, severe, &ignore) == TRUE)
553 {
554 if (!ignore)
555 did_emsg = TRUE;
556 return TRUE;
557 }
558
559 /* set "v:errmsg", also when using ":silent! cmd" */
560 set_vim_var_string(VV_ERRMSG, s, -1);
561#endif
562
563 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000564 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 * But do write it to the redirection file.
566 */
567 if (emsg_silent != 0)
568 {
569 msg_start();
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000570 p = get_emsg_source();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 if (p != NULL)
572 {
573 STRCAT(p, "\n");
574 redir_write(p, -1);
575 vim_free(p);
576 }
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000577 p = get_emsg_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 if (p != NULL)
579 {
580 STRCAT(p, "\n");
581 redir_write(p, -1);
582 vim_free(p);
583 }
584 redir_write(s, -1);
585 return TRUE;
586 }
587
588 /* Reset msg_silent, an error causes messages to be switched back on. */
589 msg_silent = 0;
590 cmd_silent = FALSE;
591
592 if (global_busy) /* break :global command */
593 ++global_busy;
594
595 if (p_eb)
596 beep_flush(); /* also includes flush_buffers() */
597 else
598 flush_buffers(FALSE); /* flush internal buffers */
599 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000600 }
601
602 emsg_on_display = TRUE; /* remember there is an error message */
603 ++msg_scroll; /* don't overwrite a previous message */
604 attr = hl_attr(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000605 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606 need_wait_return = TRUE; /* needed in case emsg() is called after
607 * wait_return has reset need_wait_return
608 * and a redraw is expected because
609 * msg_scrolled is non-zero */
610
611 /*
612 * Display name and line number for the source of the error.
613 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000614 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615
616 /*
617 * Display the error message itself.
618 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000619 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 return msg_attr(s, attr);
621}
622
623/*
624 * Print an error message with one "%s" and one string argument.
625 */
626 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100627emsg2(char_u *s, char_u *a1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628{
629 return emsg3(s, a1, NULL);
630}
631
Bram Moolenaarea424162005-06-16 21:51:00 +0000632/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
Bram Moolenaardf177f62005-02-22 08:39:57 +0000634 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100635emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000636{
637 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
638}
639
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640/*
641 * Like msg(), but truncate to a single line if p_shm contains 't', or when
642 * "force" is TRUE. This truncates in another way as for normal messages.
643 * Careful: The string may be changed by msg_may_trunc()!
644 * Returns a pointer to the printed message, if wait_return() not called.
645 */
646 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100647msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648{
649 int n;
650
651 /* Add message to history before truncating */
652 add_msg_hist(s, -1, attr);
653
654 s = msg_may_trunc(force, s);
655
656 msg_hist_off = TRUE;
657 n = msg_attr(s, attr);
658 msg_hist_off = FALSE;
659
660 if (n)
661 return s;
662 return NULL;
663}
664
665/*
666 * Check if message "s" should be truncated at the start (for filenames).
667 * Return a pointer to where the truncated message starts.
668 * Note: May change the message by replacing a character with '<'.
669 */
670 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100671msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672{
673 int n;
674 int room;
675
676 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
677 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
678 && (n = (int)STRLEN(s) - room) > 0)
679 {
680#ifdef FEAT_MBYTE
681 if (has_mbyte)
682 {
683 int size = vim_strsize(s);
684
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000685 /* There may be room anyway when there are multibyte chars. */
686 if (size <= room)
687 return s;
688
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 for (n = 0; size >= room; )
690 {
691 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000692 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 }
694 --n;
695 }
696#endif
697 s += n;
698 *s = '<';
699 }
700 return s;
701}
702
703 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100704add_msg_hist(
705 char_u *s,
706 int len, /* -1 for undetermined length */
707 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708{
709 struct msg_hist *p;
710
711 if (msg_hist_off || msg_silent != 0)
712 return;
713
714 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000715 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000716 (void)delete_first_msg();
717
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 /* allocate an entry and add the message at the end of the history */
719 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
720 if (p != NULL)
721 {
722 if (len < 0)
723 len = (int)STRLEN(s);
724 /* remove leading and trailing newlines */
725 while (len > 0 && *s == '\n')
726 {
727 ++s;
728 --len;
729 }
730 while (len > 0 && s[len - 1] == '\n')
731 --len;
732 p->msg = vim_strnsave(s, len);
733 p->next = NULL;
734 p->attr = attr;
735 if (last_msg_hist != NULL)
736 last_msg_hist->next = p;
737 last_msg_hist = p;
738 if (first_msg_hist == NULL)
739 first_msg_hist = last_msg_hist;
740 ++msg_hist_len;
741 }
742}
743
744/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000745 * Delete the first (oldest) message from the history.
746 * Returns FAIL if there are no messages.
747 */
748 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100749delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000750{
751 struct msg_hist *p;
752
753 if (msg_hist_len <= 0)
754 return FAIL;
755 p = first_msg_hist;
756 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000757 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200758 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000759 vim_free(p->msg);
760 vim_free(p);
761 --msg_hist_len;
762 return OK;
763}
764
765/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 * ":messages" command.
767 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100769ex_messages(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770{
771 struct msg_hist *p;
772 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200773 int c = 0;
774
775 if (STRCMP(eap->arg, "clear") == 0)
776 {
777 int keep = eap->addr_count == 0 ? 0 : eap->line2;
778
779 while (msg_hist_len > keep)
780 (void)delete_first_msg();
781 return;
782 }
783
784 if (*eap->arg != NUL)
785 {
786 EMSG(_(e_invarg));
787 return;
788 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790 msg_hist_off = TRUE;
791
792 s = mch_getenv((char_u *)"LANG");
793 if (s != NULL && *s != NUL)
794 msg_attr((char_u *)
795 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
796 hl_attr(HLF_T));
797
Bram Moolenaar451f8492016-04-14 17:16:22 +0200798 p = first_msg_hist;
799
800 if (eap->addr_count != 0)
801 {
802 /* Count total messages */
803 for (; p != NULL && !got_int; p = p->next)
804 c++;
805
806 c -= eap->line2;
807
808 /* Skip without number of messages specified */
809 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
810 p = p->next, c--);
811 }
812
813 /* Display what was not skipped. */
814 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 if (p->msg != NULL)
816 msg_attr(p->msg, p->attr);
817
818 msg_hist_off = FALSE;
819}
820
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000821#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822/*
823 * Call this after prompting the user. This will avoid a hit-return message
824 * and a delay.
825 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000826 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100827msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828{
829 need_wait_return = FALSE;
830 emsg_on_display = FALSE;
831 cmdline_row = msg_row;
832 msg_col = 0;
833 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +0100834 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835}
836#endif
837
838/*
839 * wait for the user to hit a key (normally a return)
840 * if 'redraw' is TRUE, clear and redraw the screen
841 * if 'redraw' is FALSE, just redraw the screen
842 * if 'redraw' is -1, don't redraw at all
843 */
844 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100845wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846{
847 int c;
848 int oldState;
849 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 int had_got_int;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100851 int save_Recording;
852 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853
854 if (redraw == TRUE)
855 must_redraw = CLEAR;
856
857 /* If using ":silent cmd", don't wait for a return. Also don't set
858 * need_wait_return to do it later. */
859 if (msg_silent != 0)
860 return;
861
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100862 /*
863 * When inside vgetc(), we can't wait for a typed character at all.
864 * With the global command (and some others) we only need one return at
865 * the end. Adjust cmdline_row to avoid the next message overwriting the
866 * last one.
867 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000868 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100870 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 if (no_wait_return)
872 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 if (!exmode_active)
874 cmdline_row = msg_row;
875 return;
876 }
877
878 redir_off = TRUE; /* don't redirect this message */
879 oldState = State;
880 if (quit_more)
881 {
882 c = CAR; /* just pretend CR was hit */
883 quit_more = FALSE;
884 got_int = FALSE;
885 }
886 else if (exmode_active)
887 {
888 MSG_PUTS(" "); /* make sure the cursor is on the right line */
889 c = CAR; /* no need for a return in ex mode */
890 got_int = FALSE;
891 }
892 else
893 {
894 /* Make sure the hit-return prompt is on screen when 'guioptions' was
895 * just changed. */
896 screenalloc(FALSE);
897
898 State = HITRETURN;
899#ifdef FEAT_MOUSE
900 setmouse();
901#endif
902#ifdef USE_ON_FLY_SCROLL
903 dont_scroll = TRUE; /* disallow scrolling here */
904#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +0100905 cmdline_row = msg_row;
906
Bram Moolenaarec38d692013-04-24 15:12:32 +0200907 /* Avoid the sequence that the user types ":" at the hit-return prompt
908 * to start an Ex command, but the file-changed dialog gets in the
909 * way. */
910 if (need_check_timestamps)
911 check_timestamps(FALSE);
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 hit_return_msg();
914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 do
916 {
917 /* Remember "got_int", if it is set vgetc() probably returns a
918 * CTRL-C, but we need to loop then. */
919 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000920
921 /* Don't do mappings here, we put the character back in the
922 * typeahead buffer. */
923 ++no_mapping;
924 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100925
926 /* Temporarily disable Recording. If Recording is active, the
927 * character will be recorded later, since it will be added to the
928 * typebuf after the loop */
929 save_Recording = Recording;
930 save_scriptout = scriptout;
931 Recording = FALSE;
932 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000934 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000936 --no_mapping;
937 --allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100938 Recording = save_Recording;
939 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000940
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941#ifdef FEAT_CLIPBOARD
942 /* Strange way to allow copying (yanking) a modeless selection at
943 * the hit-enter prompt. Use CTRL-Y, because the same is used in
944 * Cmdline-mode and it's harmless when there is no selection. */
945 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
946 {
947 clip_copy_modeless_selection(TRUE);
948 c = K_IGNORE;
949 }
950#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000951
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000952 /*
953 * Allow scrolling back in the messages.
954 * Also accept scroll-down commands when messages fill the screen,
955 * to avoid that typing one 'j' too many makes the messages
956 * disappear.
957 */
958 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000959 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100960 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
961 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000962 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100963 if (msg_scrolled > Rows)
964 /* scroll back to show older messages */
965 do_more_prompt(c);
966 else
967 {
968 msg_didout = FALSE;
969 c = K_IGNORE;
970 msg_col =
971#ifdef FEAT_RIGHTLEFT
972 cmdmsg_rl ? Columns - 1 :
973#endif
974 0;
975 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000976 if (quit_more)
977 {
978 c = CAR; /* just pretend CR was hit */
979 quit_more = FALSE;
980 got_int = FALSE;
981 }
Bram Moolenaarb0912962013-08-09 20:38:26 +0200982 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000983 {
984 c = K_IGNORE;
985 hit_return_msg();
986 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000987 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000988 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100989 && (c == 'j' || c == 'd' || c == 'f'
990 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000991 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000992 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 } while ((had_got_int && c == Ctrl_C)
994 || c == K_IGNORE
995#ifdef FEAT_GUI
996 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
997#endif
998#ifdef FEAT_MOUSE
999 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1000 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1001 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001002 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 || c == K_MOUSEDOWN || c == K_MOUSEUP
1004 || (!mouse_has(MOUSE_RETURN)
1005 && mouse_row < msg_row
1006 && (c == K_LEFTMOUSE
1007 || c == K_MIDDLEMOUSE
1008 || c == K_RIGHTMOUSE
1009 || c == K_X1MOUSE
1010 || c == K_X2MOUSE))
1011#endif
1012 );
1013 ui_breakcheck();
1014#ifdef FEAT_MOUSE
1015 /*
1016 * Avoid that the mouse-up event causes visual mode to start.
1017 */
1018 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1019 || c == K_X1MOUSE || c == K_X2MOUSE)
1020 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1021 else
1022#endif
1023 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1024 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001025 /* Put the character back in the typeahead buffer. Don't use the
1026 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001027 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001029 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 }
1032 redir_off = FALSE;
1033
1034 /*
1035 * If the user hits ':', '?' or '/' we get a command line from the next
1036 * line.
1037 */
1038 if (c == ':' || c == '?' || c == '/')
1039 {
1040 if (!exmode_active)
1041 cmdline_row = msg_row;
1042 skip_redraw = TRUE; /* skip redraw once */
1043 do_redraw = FALSE;
1044 }
1045
1046 /*
1047 * If the window size changed set_shellsize() will redraw the screen.
1048 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1049 * typed.
1050 */
1051 tmpState = State;
1052 State = oldState; /* restore State before set_shellsize */
1053#ifdef FEAT_MOUSE
1054 setmouse();
1055#endif
1056 msg_check();
1057
1058#if defined(UNIX) || defined(VMS)
1059 /*
1060 * When switching screens, we need to output an extra newline on exit.
1061 */
1062 if (swapping_screen() && !termcap_active)
1063 newline_on_exit = TRUE;
1064#endif
1065
1066 need_wait_return = FALSE;
1067 did_wait_return = TRUE;
1068 emsg_on_display = FALSE; /* can delete error message now */
1069 lines_left = -1; /* reset lines_left at next msg_start() */
1070 reset_last_sourcing();
1071 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1072 (Rows - cmdline_row - 1) * Columns + sc_col)
1073 {
1074 vim_free(keep_msg);
1075 keep_msg = NULL; /* don't redisplay message, it's too long */
1076 }
1077
1078 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1079 {
1080 starttermcap(); /* start termcap before redrawing */
1081 shell_resized();
1082 }
1083 else if (!skip_redraw
1084 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1085 {
1086 starttermcap(); /* start termcap before redrawing */
1087 redraw_later(VALID);
1088 }
1089}
1090
1091/*
1092 * Write the hit-return prompt.
1093 */
1094 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001095hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001097 int save_p_more = p_more;
1098
1099 p_more = FALSE; /* don't want see this message when scrolling back */
1100 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 msg_putchar('\n');
1102 if (got_int)
1103 MSG_PUTS(_("Interrupt: "));
1104
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001105 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 if (!msg_use_printf())
1107 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001108 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109}
1110
1111/*
1112 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1113 */
1114 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001115set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116{
1117 vim_free(keep_msg);
1118 if (s != NULL && msg_silent == 0)
1119 keep_msg = vim_strsave(s);
1120 else
1121 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001122 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001123 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124}
1125
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001126#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1127/*
1128 * If there currently is a message being displayed, set "keep_msg" to it, so
1129 * that it will be displayed again after redraw.
1130 */
1131 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001132set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001133{
1134 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1135 && (State & NORMAL))
1136 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1137}
1138#endif
1139
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140/*
1141 * Prepare for outputting characters in the command line.
1142 */
1143 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001144msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145{
1146 int did_return = FALSE;
1147
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001148 if (!msg_silent)
1149 {
1150 vim_free(keep_msg);
1151 keep_msg = NULL; /* don't display old message now */
1152 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001153
1154#ifdef FEAT_EVAL
1155 if (need_clr_eos)
1156 {
1157 /* Halfway an ":echo" command and getting an (error) message: clear
1158 * any text from the command. */
1159 need_clr_eos = FALSE;
1160 msg_clr_eos();
1161 }
1162#endif
1163
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 if (!msg_scroll && full_screen) /* overwrite last message */
1165 {
1166 msg_row = cmdline_row;
1167 msg_col =
1168#ifdef FEAT_RIGHTLEFT
1169 cmdmsg_rl ? Columns - 1 :
1170#endif
1171 0;
1172 }
1173 else if (msg_didout) /* start message on next line */
1174 {
1175 msg_putchar('\n');
1176 did_return = TRUE;
1177 if (exmode_active != EXMODE_NORMAL)
1178 cmdline_row = msg_row;
1179 }
1180 if (!msg_didany || lines_left < 0)
1181 msg_starthere();
1182 if (msg_silent == 0)
1183 {
1184 msg_didout = FALSE; /* no output on current line yet */
1185 cursor_off();
1186 }
1187
1188 /* when redirecting, may need to start a new line. */
1189 if (!did_return)
1190 redir_write((char_u *)"\n", -1);
1191}
1192
1193/*
1194 * Note that the current msg position is where messages start.
1195 */
1196 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001197msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198{
1199 lines_left = cmdline_row;
1200 msg_didany = FALSE;
1201}
1202
1203 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001204msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205{
1206 msg_putchar_attr(c, 0);
1207}
1208
1209 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001210msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211{
1212#ifdef FEAT_MBYTE
1213 char_u buf[MB_MAXBYTES + 1];
1214#else
1215 char_u buf[4];
1216#endif
1217
1218 if (IS_SPECIAL(c))
1219 {
1220 buf[0] = K_SPECIAL;
1221 buf[1] = K_SECOND(c);
1222 buf[2] = K_THIRD(c);
1223 buf[3] = NUL;
1224 }
1225 else
1226 {
1227#ifdef FEAT_MBYTE
1228 buf[(*mb_char2bytes)(c, buf)] = NUL;
1229#else
1230 buf[0] = c;
1231 buf[1] = NUL;
1232#endif
1233 }
1234 msg_puts_attr(buf, attr);
1235}
1236
1237 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001238msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239{
1240 char_u buf[20];
1241
1242 sprintf((char *)buf, "%ld", n);
1243 msg_puts(buf);
1244}
1245
1246 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001247msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248{
1249 msg_home_replace_attr(fname, 0);
1250}
1251
1252#if defined(FEAT_FIND_ID) || defined(PROTO)
1253 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001254msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255{
1256 msg_home_replace_attr(fname, hl_attr(HLF_D));
1257}
1258#endif
1259
1260 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001261msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262{
1263 char_u *name;
1264
1265 name = home_replace_save(NULL, fname);
1266 if (name != NULL)
1267 msg_outtrans_attr(name, attr);
1268 vim_free(name);
1269}
1270
1271/*
1272 * Output 'len' characters in 'str' (including NULs) with translation
1273 * if 'len' is -1, output upto a NUL character.
1274 * Use attributes 'attr'.
1275 * Return the number of characters it takes on the screen.
1276 */
1277 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001278msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279{
1280 return msg_outtrans_attr(str, 0);
1281}
1282
1283 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001284msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285{
1286 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1287}
1288
1289 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001290msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291{
1292 return msg_outtrans_len_attr(str, len, 0);
1293}
1294
1295/*
1296 * Output one character at "p". Return pointer to the next character.
1297 * Handles multi-byte characters.
1298 */
1299 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001300msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301{
1302#ifdef FEAT_MBYTE
1303 int l;
1304
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001305 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 {
1307 msg_outtrans_len_attr(p, l, attr);
1308 return p + l;
1309 }
1310#endif
1311 msg_puts_attr(transchar_byte(*p), attr);
1312 return p + 1;
1313}
1314
1315 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001316msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317{
1318 int retval = 0;
1319 char_u *str = msgstr;
1320 char_u *plain_start = msgstr;
1321 char_u *s;
1322#ifdef FEAT_MBYTE
1323 int mb_l;
1324 int c;
1325#endif
1326
1327 /* if MSG_HIST flag set, add message to history */
1328 if (attr & MSG_HIST)
1329 {
1330 add_msg_hist(str, len, attr);
1331 attr &= ~MSG_HIST;
1332 }
1333
1334#ifdef FEAT_MBYTE
1335 /* If the string starts with a composing character first draw a space on
1336 * which the composing char can be drawn. */
1337 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1338 msg_puts_attr((char_u *)" ", attr);
1339#endif
1340
1341 /*
1342 * Go over the string. Special characters are translated and printed.
1343 * Normal characters are printed several at a time.
1344 */
1345 while (--len >= 0)
1346 {
1347#ifdef FEAT_MBYTE
1348 if (enc_utf8)
1349 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001350 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001352 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 else
1354 mb_l = 1;
1355 if (has_mbyte && mb_l > 1)
1356 {
1357 c = (*mb_ptr2char)(str);
1358 if (vim_isprintc(c))
1359 /* printable multi-byte char: count the cells. */
1360 retval += (*mb_ptr2cells)(str);
1361 else
1362 {
1363 /* unprintable multi-byte char: print the printable chars so
1364 * far and the translation of the unprintable char. */
1365 if (str > plain_start)
1366 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1367 attr);
1368 plain_start = str + mb_l;
1369 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1370 retval += char2cells(c);
1371 }
1372 len -= mb_l - 1;
1373 str += mb_l;
1374 }
1375 else
1376#endif
1377 {
1378 s = transchar_byte(*str);
1379 if (s[1] != NUL)
1380 {
1381 /* unprintable char: print the printable chars so far and the
1382 * translation of the unprintable char. */
1383 if (str > plain_start)
1384 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1385 attr);
1386 plain_start = str + 1;
1387 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001388 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001390 else
1391 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 ++str;
1393 }
1394 }
1395
1396 if (str > plain_start)
1397 /* print the printable chars at the end */
1398 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1399
1400 return retval;
1401}
1402
1403#if defined(FEAT_QUICKFIX) || defined(PROTO)
1404 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001405msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406{
1407 int i;
1408 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1409
1410 arg = skipwhite(arg);
1411 for (i = 5; *arg && i >= 0; --i)
1412 if (*arg++ != str[i])
1413 break;
1414 if (i < 0)
1415 {
1416 msg_putchar('\n');
1417 for (i = 0; rs[i]; ++i)
1418 msg_putchar(rs[i] - 3);
1419 }
1420}
1421#endif
1422
1423/*
1424 * Output the string 'str' upto a NUL character.
1425 * Return the number of characters it takes on the screen.
1426 *
1427 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1428 * following character and shown as <F1>, <S-Up> etc. Any other character
1429 * which is not printable shown in <> form.
1430 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1431 * If a character is displayed in one of these special ways, is also
1432 * highlighted (its highlight name is '8' in the p_hl variable).
1433 * Otherwise characters are not highlighted.
1434 * This function is used to show mappings, where we want to see how to type
1435 * the character/string -- webb
1436 */
1437 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001438msg_outtrans_special(
1439 char_u *strstart,
1440 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441{
1442 char_u *str = strstart;
1443 int retval = 0;
1444 char_u *string;
1445 int attr;
1446 int len;
1447
1448 attr = hl_attr(HLF_8);
1449 while (*str != NUL)
1450 {
1451 /* Leading and trailing spaces need to be displayed in <> form. */
1452 if ((str == strstart || str[1] == NUL) && *str == ' ')
1453 {
1454 string = (char_u *)"<Space>";
1455 ++str;
1456 }
1457 else
1458 string = str2special(&str, from);
1459 len = vim_strsize(string);
1460 /* Highlight special keys */
1461 msg_puts_attr(string, len > 1
1462#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001463 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464#endif
1465 ? attr : 0);
1466 retval += len;
1467 }
1468 return retval;
1469}
1470
Bram Moolenaarbd743252010-10-20 21:23:33 +02001471#if defined(FEAT_EVAL) || defined(PROTO)
1472/*
1473 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1474 * strings, in an allocated string.
1475 */
1476 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001477str2special_save(
1478 char_u *str,
1479 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001480{
1481 garray_T ga;
1482 char_u *p = str;
1483
1484 ga_init2(&ga, 1, 40);
1485 while (*p != NUL)
1486 ga_concat(&ga, str2special(&p, is_lhs));
1487 ga_append(&ga, NUL);
1488 return (char_u *)ga.ga_data;
1489}
1490#endif
1491
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492/*
1493 * Return the printable string for the key codes at "*sp".
1494 * Used for translating the lhs or rhs of a mapping to printable chars.
1495 * Advances "sp" to the next code.
1496 */
1497 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001498str2special(
1499 char_u **sp,
1500 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501{
1502 int c;
1503 static char_u buf[7];
1504 char_u *str = *sp;
1505 int modifiers = 0;
1506 int special = FALSE;
1507
1508#ifdef FEAT_MBYTE
1509 if (has_mbyte)
1510 {
1511 char_u *p;
1512
1513 /* Try to un-escape a multi-byte character. Return the un-escaped
1514 * string if it is a multi-byte character. */
1515 p = mb_unescape(sp);
1516 if (p != NULL)
1517 return p;
1518 }
1519#endif
1520
1521 c = *str;
1522 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1523 {
1524 if (str[1] == KS_MODIFIER)
1525 {
1526 modifiers = str[2];
1527 str += 3;
1528 c = *str;
1529 }
1530 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1531 {
1532 c = TO_SPECIAL(str[1], str[2]);
1533 str += 2;
Bram Moolenaar37985192013-06-07 19:53:10 +02001534 if (c == KS_ZERO) /* display <Nul> as ^@ or <Nul> */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 c = NUL;
1536 }
1537 if (IS_SPECIAL(c) || modifiers) /* special key */
1538 special = TRUE;
1539 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540
1541#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001542 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001544 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001545
1546 /* For multi-byte characters check for an illegal byte. */
1547 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1548 {
1549 transchar_nonprint(buf, c);
1550 *sp = str + 1;
1551 return buf;
1552 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001553 /* Since 'special' is TRUE the multi-byte character 'c' will be
1554 * processed by get_special_key_name() */
1555 c = (*mb_ptr2char)(str);
1556 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001558 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001560 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561
1562 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1563 * Use <Space> only for lhs of a mapping. */
1564 if (special || char2cells(c) > 1 || (from && c == ' '))
1565 return get_special_key_name(c, modifiers);
1566 buf[0] = c;
1567 buf[1] = NUL;
1568 return buf;
1569}
1570
1571/*
1572 * Translate a key sequence into special key names.
1573 */
1574 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001575str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576{
1577 char_u *s;
1578
1579 *buf = NUL;
1580 while (*sp)
1581 {
1582 s = str2special(&sp, FALSE);
1583 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1584 STRCAT(buf, s);
1585 }
1586}
1587
1588/*
1589 * print line for :print or :list command
1590 */
1591 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001592msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593{
1594 int c;
1595 int col = 0;
1596 int n_extra = 0;
1597 int c_extra = 0;
1598 char_u *p_extra = NULL; /* init to make SASC shut up */
1599 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001600 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 char_u *trail = NULL;
1602#ifdef FEAT_MBYTE
1603 int l;
1604 char_u buf[MB_MAXBYTES + 1];
1605#endif
1606
Bram Moolenaardf177f62005-02-22 08:39:57 +00001607 if (curwin->w_p_list)
1608 list = TRUE;
1609
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001611 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 {
1613 trail = s + STRLEN(s);
1614 while (trail > s && vim_iswhite(trail[-1]))
1615 --trail;
1616 }
1617
1618 /* output a space for an empty line, otherwise the line will be
1619 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001620 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 msg_putchar(' ');
1622
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001623 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001625 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 {
1627 --n_extra;
1628 if (c_extra)
1629 c = c_extra;
1630 else
1631 c = *p_extra++;
1632 }
1633#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001634 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 {
1636 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001637 if (lcs_nbsp != NUL && list
1638 && (mb_ptr2char(s) == 160
1639 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001640 {
1641 mb_char2bytes(lcs_nbsp, buf);
1642 buf[(*mb_ptr2len)(buf)] = NUL;
1643 }
1644 else
1645 {
1646 mch_memmove(buf, s, (size_t)l);
1647 buf[l] = NUL;
1648 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001649 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 s += l;
1651 continue;
1652 }
1653#endif
1654 else
1655 {
1656 attr = 0;
1657 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001658 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 {
1660 /* tab amount depends on current column */
1661 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001662 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 {
1664 c = ' ';
1665 c_extra = ' ';
1666 }
1667 else
1668 {
1669 c = lcs_tab1;
1670 c_extra = lcs_tab2;
1671 attr = hl_attr(HLF_8);
1672 }
1673 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001674 else if (c == 160 && list && lcs_nbsp != NUL)
1675 {
1676 c = lcs_nbsp;
1677 attr = hl_attr(HLF_8);
1678 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001679 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 {
1681 p_extra = (char_u *)"";
1682 c_extra = NUL;
1683 n_extra = 1;
1684 c = lcs_eol;
1685 attr = hl_attr(HLF_AT);
1686 --s;
1687 }
1688 else if (c != NUL && (n = byte2cells(c)) > 1)
1689 {
1690 n_extra = n - 1;
1691 p_extra = transchar_byte(c);
1692 c_extra = NUL;
1693 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001694 /* Use special coloring to be able to distinguish <hex> from
1695 * the same in plain text. */
1696 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 }
1698 else if (c == ' ' && trail != NULL && s > trail)
1699 {
1700 c = lcs_trail;
1701 attr = hl_attr(HLF_8);
1702 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001703 else if (c == ' ' && list && lcs_space != NUL)
1704 {
1705 c = lcs_space;
1706 attr = hl_attr(HLF_8);
1707 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 }
1709
1710 if (c == NUL)
1711 break;
1712
1713 msg_putchar_attr(c, attr);
1714 col++;
1715 }
1716 msg_clr_eos();
1717}
1718
1719#ifdef FEAT_MBYTE
1720/*
1721 * Use screen_puts() to output one multi-byte character.
1722 * Return the pointer "s" advanced to the next character.
1723 */
1724 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001725screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726{
1727 int cw;
1728
1729 msg_didout = TRUE; /* remember that line is not empty */
1730 cw = (*mb_ptr2cells)(s);
1731 if (cw > 1 && (
1732#ifdef FEAT_RIGHTLEFT
1733 cmdmsg_rl ? msg_col <= 1 :
1734#endif
1735 msg_col == Columns - 1))
1736 {
1737 /* Doesn't fit, print a highlighted '>' to fill it up. */
1738 msg_screen_putchar('>', hl_attr(HLF_AT));
1739 return s;
1740 }
1741
1742 screen_puts_len(s, l, msg_row, msg_col, attr);
1743#ifdef FEAT_RIGHTLEFT
1744 if (cmdmsg_rl)
1745 {
1746 msg_col -= cw;
1747 if (msg_col == 0)
1748 {
1749 msg_col = Columns;
1750 ++msg_row;
1751 }
1752 }
1753 else
1754#endif
1755 {
1756 msg_col += cw;
1757 if (msg_col >= Columns)
1758 {
1759 msg_col = 0;
1760 ++msg_row;
1761 }
1762 }
1763 return s + l;
1764}
1765#endif
1766
1767/*
1768 * Output a string to the screen at position msg_row, msg_col.
1769 * Update msg_row and msg_col for the next message.
1770 */
1771 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001772msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773{
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001774 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775}
1776
1777 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001778msg_puts_title(
1779 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780{
1781 msg_puts_attr(s, hl_attr(HLF_T));
1782}
1783
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784/*
1785 * Show a message in such a way that it always fits in the line. Cut out a
1786 * part in the middle and replace it with "..." when necessary.
1787 * Does not handle multi-byte characters!
1788 */
1789 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001790msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001792 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793}
1794
1795 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001796msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797{
1798 int slen = len;
1799 int room;
1800
1801 room = Columns - msg_col;
1802 if (len > room && room >= 20)
1803 {
1804 slen = (room - 3) / 2;
1805 msg_outtrans_len_attr(longstr, slen, attr);
1806 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1807 }
1808 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1809}
1810
1811/*
1812 * Basic function for writing a message with highlight attributes.
1813 */
1814 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001815msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816{
1817 msg_puts_attr_len(s, -1, attr);
1818}
1819
1820/*
1821 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1822 * When "maxlen" is -1 there is no maximum length.
1823 * When "maxlen" is >= 0 the message is not put in the history.
1824 */
1825 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001826msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 /*
1829 * If redirection is on, also write to the redirection file.
1830 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001831 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
1833 /*
1834 * Don't print anything when using ":silent cmd".
1835 */
1836 if (msg_silent != 0)
1837 return;
1838
1839 /* if MSG_HIST flag set, add message to history */
1840 if ((attr & MSG_HIST) && maxlen < 0)
1841 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001842 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 attr &= ~MSG_HIST;
1844 }
1845
1846 /*
1847 * When writing something to the screen after it has scrolled, requires a
1848 * wait-return prompt later. Needed when scrolling, resetting
1849 * need_wait_return after some prompt, and then outputting something
1850 * without scrolling
1851 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001852 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 need_wait_return = TRUE;
1854 msg_didany = TRUE; /* remember that something was outputted */
1855
1856 /*
1857 * If there is no valid screen, use fprintf so we can see error messages.
1858 * If termcap is not active, we may be writing in an alternate console
1859 * window, cursor positioning may not work correctly (window size may be
1860 * different, e.g. for Win32 console) or we just don't know where the
1861 * cursor is.
1862 */
1863 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001864 msg_puts_printf(str, maxlen);
1865 else
1866 msg_puts_display(str, maxlen, attr, FALSE);
1867}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001869/*
1870 * The display part of msg_puts_attr_len().
1871 * May be called recursively to display scroll-back text.
1872 */
1873 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001874msg_puts_display(
1875 char_u *str,
1876 int maxlen,
1877 int attr,
1878 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001879{
1880 char_u *s = str;
1881 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1882 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1883#ifdef FEAT_MBYTE
1884 int l;
1885 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001887 char_u *sb_str = str;
1888 int sb_col = msg_col;
1889 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001890 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891
1892 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001893 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 {
1895 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001896 * We are at the end of the screen line when:
1897 * - When outputting a newline.
1898 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001900 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901#ifdef FEAT_RIGHTLEFT
1902 cmdmsg_rl
1903 ? (
1904 msg_col <= 1
1905 || (*s == TAB && msg_col <= 7)
1906# ifdef FEAT_MBYTE
1907 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1908# endif
1909 )
1910 :
1911#endif
1912 (msg_col + t_col >= Columns - 1
1913 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1914# ifdef FEAT_MBYTE
1915 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1916 && msg_col + t_col >= Columns - 2)
1917# endif
1918 ))))
1919 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001920 /*
1921 * The screen is scrolled up when at the last row (some terminals
1922 * scroll automatically, some don't. To avoid problems we scroll
1923 * ourselves).
1924 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001927 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001929 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 if (msg_no_more && lines_left == 0)
1931 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001933 /* Scroll the screen up one line. */
1934 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935
1936 msg_row = Rows - 2;
1937 if (msg_col >= Columns) /* can happen after screen resize */
1938 msg_col = Columns - 1;
1939
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001940 /* Display char in last column before showing more-prompt. */
1941 if (*s >= ' '
1942#ifdef FEAT_RIGHTLEFT
1943 && !cmdmsg_rl
1944#endif
1945 )
1946 {
1947#ifdef FEAT_MBYTE
1948 if (has_mbyte)
1949 {
1950 if (enc_utf8 && maxlen >= 0)
1951 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001952 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001953 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001954 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001955 s = screen_puts_mbyte(s, l, attr);
1956 }
1957 else
1958#endif
1959 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001960 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001961 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001962 else
1963 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001964
1965 if (p_more)
1966 /* store text for scrolling back */
1967 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1968
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001969 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001970 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 if (must_redraw < VALID)
1972 must_redraw = VALID;
1973 redraw_cmdline = TRUE;
1974 if (cmdline_row > 0 && !exmode_active)
1975 --cmdline_row;
1976
1977 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001978 * If screen is completely filled and 'more' is set then wait
1979 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001981 if (lines_left > 0)
1982 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001983 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 && !msg_no_more && !exmode_active)
1985 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001987 if (do_more_prompt(NUL))
1988 s = confirm_msg_tail;
1989#else
1990 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991#endif
1992 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001993 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001995
1996 /* When we displayed a char in last column need to check if there
1997 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001998 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001999 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 }
2001
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002002 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 || msg_col + t_col >= Columns
2004#ifdef FEAT_MBYTE
2005 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2006 && msg_col + t_col >= Columns - 1)
2007#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002008 ;
2009 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2010 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002012 t_puts(&t_col, t_s, s, attr);
2013
2014 if (wrap && p_more && !recurse)
2015 /* store text for scrolling back */
2016 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017
2018 if (*s == '\n') /* go to next line */
2019 {
2020 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002021#ifdef FEAT_RIGHTLEFT
2022 if (cmdmsg_rl)
2023 msg_col = Columns - 1;
2024 else
2025#endif
2026 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 if (++msg_row >= Rows) /* safety check */
2028 msg_row = Rows - 1;
2029 }
2030 else if (*s == '\r') /* go to column 0 */
2031 {
2032 msg_col = 0;
2033 }
2034 else if (*s == '\b') /* go to previous char */
2035 {
2036 if (msg_col)
2037 --msg_col;
2038 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002039 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 {
2041 do
2042 msg_screen_putchar(' ', attr);
2043 while (msg_col & 7);
2044 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002045 else if (*s == BELL) /* beep (from ":sh") */
2046 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 else
2048 {
2049#ifdef FEAT_MBYTE
2050 if (has_mbyte)
2051 {
2052 cw = (*mb_ptr2cells)(s);
2053 if (enc_utf8 && maxlen >= 0)
2054 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002055 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002057 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 }
2059 else
2060 {
2061 cw = 1;
2062 l = 1;
2063 }
2064#endif
2065 /* When drawing from right to left or when a double-wide character
2066 * doesn't fit, draw a single character here. Otherwise collect
2067 * characters and draw them all at once later. */
2068#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2069 if (
2070# ifdef FEAT_RIGHTLEFT
2071 cmdmsg_rl
2072# ifdef FEAT_MBYTE
2073 ||
2074# endif
2075# endif
2076# ifdef FEAT_MBYTE
2077 (cw > 1 && msg_col + t_col >= Columns - 1)
2078# endif
2079 )
2080 {
2081# ifdef FEAT_MBYTE
2082 if (l > 1)
2083 s = screen_puts_mbyte(s, l, attr) - 1;
2084 else
2085# endif
2086 msg_screen_putchar(*s, attr);
2087 }
2088 else
2089#endif
2090 {
2091 /* postpone this character until later */
2092 if (t_col == 0)
2093 t_s = s;
2094#ifdef FEAT_MBYTE
2095 t_col += cw;
2096 s += l - 1;
2097#else
2098 ++t_col;
2099#endif
2100 }
2101 }
2102 ++s;
2103 }
2104
2105 /* output any postponed text */
2106 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002107 t_puts(&t_col, t_s, s, attr);
2108 if (p_more && !recurse)
2109 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 msg_check();
2112}
2113
2114/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002115 * Scroll the screen up one line for displaying the next message line.
2116 */
2117 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002118msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002119{
2120#ifdef FEAT_GUI
2121 /* Remove the cursor before scrolling, ScreenLines[] is going
2122 * to become invalid. */
2123 if (gui.in_use)
2124 gui_undraw_cursor();
2125#endif
2126 /* scrolling up always works */
2127 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2128
2129 if (!can_clear((char_u *)" "))
2130 {
2131 /* Scrolling up doesn't result in the right background. Set the
2132 * background here. It's not efficient, but avoids that we have to do
2133 * it all over the code. */
2134 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2135
2136 /* Also clear the last char of the last but one line if it was not
2137 * cleared before to avoid a scroll-up. */
2138 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2139 screen_fill((int)Rows - 2, (int)Rows - 1,
2140 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2141 }
2142}
2143
2144/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002145 * Increment "msg_scrolled".
2146 */
2147 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002148inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002149{
2150#ifdef FEAT_EVAL
2151 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2152 {
2153 char_u *p = sourcing_name;
2154 char_u *tofree = NULL;
2155 int len;
2156
2157 /* v:scrollstart is empty, set it to the script/function name and line
2158 * number */
2159 if (p == NULL)
2160 p = (char_u *)_("Unknown");
2161 else
2162 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002163 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002164 tofree = alloc(len);
2165 if (tofree != NULL)
2166 {
2167 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2168 p, (long)sourcing_lnum);
2169 p = tofree;
2170 }
2171 }
2172 set_vim_var_string(VV_SCROLLSTART, p, -1);
2173 vim_free(tofree);
2174 }
2175#endif
2176 ++msg_scrolled;
2177}
2178
2179/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002180 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2181 * store the displayed text and remember where screen lines start.
2182 */
2183typedef struct msgchunk_S msgchunk_T;
2184struct msgchunk_S
2185{
2186 msgchunk_T *sb_next;
2187 msgchunk_T *sb_prev;
2188 char sb_eol; /* TRUE when line ends after this text */
2189 int sb_msg_col; /* column in which text starts */
2190 int sb_attr; /* text attributes */
2191 char_u sb_text[1]; /* text to be displayed, actually longer */
2192};
2193
2194static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2195
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002196static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2197static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002198
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002199static int do_clear_sb_text = FALSE; /* clear text on next msg */
2200
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002201/*
2202 * Store part of a printed message for displaying when scrolling back.
2203 */
2204 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002205store_sb_text(
2206 char_u **sb_str, /* start of string */
2207 char_u *s, /* just after string */
2208 int attr,
2209 int *sb_col,
2210 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002211{
2212 msgchunk_T *mp;
2213
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002214 if (do_clear_sb_text)
2215 {
2216 clear_sb_text();
2217 do_clear_sb_text = FALSE;
2218 }
2219
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002220 if (s > *sb_str)
2221 {
2222 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2223 if (mp != NULL)
2224 {
2225 mp->sb_eol = finish;
2226 mp->sb_msg_col = *sb_col;
2227 mp->sb_attr = attr;
2228 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2229
2230 if (last_msgchunk == NULL)
2231 {
2232 last_msgchunk = mp;
2233 mp->sb_prev = NULL;
2234 }
2235 else
2236 {
2237 mp->sb_prev = last_msgchunk;
2238 last_msgchunk->sb_next = mp;
2239 last_msgchunk = mp;
2240 }
2241 mp->sb_next = NULL;
2242 }
2243 }
2244 else if (finish && last_msgchunk != NULL)
2245 last_msgchunk->sb_eol = TRUE;
2246
2247 *sb_str = s;
2248 *sb_col = 0;
2249}
2250
2251/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002252 * Finished showing messages, clear the scroll-back text on the next message.
2253 */
2254 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002255may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002256{
2257 do_clear_sb_text = TRUE;
2258}
2259
2260/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002261 * Clear any text remembered for scrolling back.
2262 * Called when redrawing the screen.
2263 */
2264 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002265clear_sb_text(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002266{
2267 msgchunk_T *mp;
2268
2269 while (last_msgchunk != NULL)
2270 {
2271 mp = last_msgchunk->sb_prev;
2272 vim_free(last_msgchunk);
2273 last_msgchunk = mp;
2274 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002275}
2276
2277/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002278 * "g<" command.
2279 */
2280 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002281show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002282{
2283 msgchunk_T *mp;
2284
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002285 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002286 * weird, typing a command without output results in one line. */
2287 mp = msg_sb_start(last_msgchunk);
2288 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002289 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002290 else
2291 {
2292 do_more_prompt('G');
2293 wait_return(FALSE);
2294 }
2295}
2296
2297/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002298 * Move to the start of screen line in already displayed text.
2299 */
2300 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002301msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002302{
2303 msgchunk_T *mp = mps;
2304
2305 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2306 mp = mp->sb_prev;
2307 return mp;
2308}
2309
2310/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002311 * Mark the last message chunk as finishing the line.
2312 */
2313 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002314msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002315{
2316 if (last_msgchunk != NULL)
2317 last_msgchunk->sb_eol = TRUE;
2318}
2319
2320/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002321 * Display a screen line from previously displayed text at row "row".
2322 * Returns a pointer to the text for the next line (can be NULL).
2323 */
2324 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002325disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002326{
2327 msgchunk_T *mp = smp;
2328 char_u *p;
2329
2330 for (;;)
2331 {
2332 msg_row = row;
2333 msg_col = mp->sb_msg_col;
2334 p = mp->sb_text;
2335 if (*p == '\n') /* don't display the line break */
2336 ++p;
2337 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2338 if (mp->sb_eol || mp->sb_next == NULL)
2339 break;
2340 mp = mp->sb_next;
2341 }
2342 return mp->sb_next;
2343}
2344
2345/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 * Output any postponed text for msg_puts_attr_len().
2347 */
2348 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002349t_puts(
2350 int *t_col,
2351 char_u *t_s,
2352 char_u *s,
2353 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354{
2355 /* output postponed text */
2356 msg_didout = TRUE; /* remember that line is not empty */
2357 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002358 msg_col += *t_col;
2359 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360#ifdef FEAT_MBYTE
2361 /* If the string starts with a composing character don't increment the
2362 * column position for it. */
2363 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2364 --msg_col;
2365#endif
2366 if (msg_col >= Columns)
2367 {
2368 msg_col = 0;
2369 ++msg_row;
2370 }
2371}
2372
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373/*
2374 * Returns TRUE when messages should be printed with mch_errmsg().
2375 * This is used when there is no valid screen, so we can see error messages.
2376 * If termcap is not active, we may be writing in an alternate console
2377 * window, cursor positioning may not work correctly (window size may be
2378 * different, e.g. for Win32 console) or we just don't know where the
2379 * cursor is.
2380 */
2381 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002382msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383{
2384 return (!msg_check_screen()
2385#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2386 || !termcap_active
2387#endif
2388 || (swapping_screen() && !termcap_active)
2389 );
2390}
2391
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002392/*
2393 * Print a message when there is no valid screen.
2394 */
2395 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002396msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002397{
2398 char_u *s = str;
2399 char_u buf[4];
2400 char_u *p;
2401
2402#ifdef WIN3264
2403 if (!(silent_mode && p_verbose == 0))
2404 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2405#endif
2406 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2407 {
2408 if (!(silent_mode && p_verbose == 0))
2409 {
2410 /* NL --> CR NL translation (for Unix, not for "--version") */
2411 /* NL --> CR translation (for Mac) */
2412 p = &buf[0];
2413 if (*s == '\n' && !info_message)
2414 *p++ = '\r';
2415#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2416 else
2417#endif
2418 *p++ = *s;
2419 *p = '\0';
2420 if (info_message) /* informative message, not an error */
2421 mch_msg((char *)buf);
2422 else
2423 mch_errmsg((char *)buf);
2424 }
2425
2426 /* primitive way to compute the current column */
2427#ifdef FEAT_RIGHTLEFT
2428 if (cmdmsg_rl)
2429 {
2430 if (*s == '\r' || *s == '\n')
2431 msg_col = Columns - 1;
2432 else
2433 --msg_col;
2434 }
2435 else
2436#endif
2437 {
2438 if (*s == '\r' || *s == '\n')
2439 msg_col = 0;
2440 else
2441 ++msg_col;
2442 }
2443 ++s;
2444 }
2445 msg_didout = TRUE; /* assume that line is not empty */
2446
2447#ifdef WIN3264
2448 if (!(silent_mode && p_verbose == 0))
2449 mch_settmode(TMODE_RAW);
2450#endif
2451}
2452
2453/*
2454 * Show the more-prompt and handle the user response.
2455 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002456 * When at hit-enter prompt "typed_char" is the already typed character,
2457 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002458 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2459 */
2460 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002461do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002462{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002463 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002464 int used_typed_char = typed_char;
2465 int oldState = State;
2466 int c;
2467#ifdef FEAT_CON_DIALOG
2468 int retval = FALSE;
2469#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002470 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002471 msgchunk_T *mp_last = NULL;
2472 msgchunk_T *mp;
2473 int i;
2474
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002475 /* We get called recursively when a timer callback outputs a message. In
2476 * that case don't show another prompt. Also when at the hit-Enter prompt.
2477 */
2478 if (entered || State == HITRETURN)
2479 return FALSE;
2480 entered = TRUE;
2481
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002482 if (typed_char == 'G')
2483 {
2484 /* "g<": Find first line on the last page. */
2485 mp_last = msg_sb_start(last_msgchunk);
2486 for (i = 0; i < Rows - 2 && mp_last != NULL
2487 && mp_last->sb_prev != NULL; ++i)
2488 mp_last = msg_sb_start(mp_last->sb_prev);
2489 }
2490
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002491 State = ASKMORE;
2492#ifdef FEAT_MOUSE
2493 setmouse();
2494#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002495 if (typed_char == NUL)
2496 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002497 for (;;)
2498 {
2499 /*
2500 * Get a typed character directly from the user.
2501 */
2502 if (used_typed_char != NUL)
2503 {
2504 c = used_typed_char; /* was typed at hit-enter prompt */
2505 used_typed_char = NUL;
2506 }
2507 else
2508 c = get_keystroke();
2509
2510#if defined(FEAT_MENU) && defined(FEAT_GUI)
2511 if (c == K_MENU)
2512 {
2513 int idx = get_menu_index(current_menu, ASKMORE);
2514
2515 /* Used a menu. If it starts with CTRL-Y, it must
2516 * be a "Copy" for the clipboard. Otherwise
2517 * assume that we end */
2518 if (idx == MENU_INDEX_INVALID)
2519 continue;
2520 c = *current_menu->strings[idx];
2521 if (c != NUL && current_menu->strings[idx][1] != NUL)
2522 ins_typebuf(current_menu->strings[idx] + 1,
2523 current_menu->noremap[idx], 0, TRUE,
2524 current_menu->silent[idx]);
2525 }
2526#endif
2527
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002528 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002529 switch (c)
2530 {
2531 case BS: /* scroll one line back */
2532 case K_BS:
2533 case 'k':
2534 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002535 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002536 break;
2537
2538 case CAR: /* one extra line */
2539 case NL:
2540 case 'j':
2541 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002542 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002543 break;
2544
2545 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002546 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002547 break;
2548
2549 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002550 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002551 break;
2552
2553 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002554 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002555 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002556 break;
2557
2558 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002559 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002560 case K_PAGEDOWN:
2561 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002562 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002563 break;
2564
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002565 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002566 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002567 break;
2568
2569 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002570 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002571 lines_left = 999999;
2572 break;
2573
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002574 case ':': /* start new command line */
2575#ifdef FEAT_CON_DIALOG
2576 if (!confirm_msg_used)
2577#endif
2578 {
2579 /* Since got_int is set all typeahead will be flushed, but we
2580 * want to keep this ':', remember that in a special way. */
2581 typeahead_noflush(':');
2582 cmdline_row = Rows - 1; /* put ':' on this line */
2583 skip_redraw = TRUE; /* skip redraw once */
2584 need_wait_return = FALSE; /* don't wait in main() */
2585 }
2586 /*FALLTHROUGH*/
2587 case 'q': /* quit */
2588 case Ctrl_C:
2589 case ESC:
2590#ifdef FEAT_CON_DIALOG
2591 if (confirm_msg_used)
2592 {
2593 /* Jump to the choices of the dialog. */
2594 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002595 }
2596 else
2597#endif
2598 {
2599 got_int = TRUE;
2600 quit_more = TRUE;
2601 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002602 /* When there is some more output (wrapping line) display that
2603 * without another prompt. */
2604 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002605 break;
2606
2607#ifdef FEAT_CLIPBOARD
2608 case Ctrl_Y:
2609 /* Strange way to allow copying (yanking) a modeless
2610 * selection at the more prompt. Use CTRL-Y,
2611 * because the same is used in Cmdline-mode and at the
2612 * hit-enter prompt. However, scrolling one line up
2613 * might be expected... */
2614 if (clip_star.state == SELECT_DONE)
2615 clip_copy_modeless_selection(TRUE);
2616 continue;
2617#endif
2618 default: /* no valid response */
2619 msg_moremsg(TRUE);
2620 continue;
2621 }
2622
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002623 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002624 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002625 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002626 {
2627 /* go to start of last line */
2628 if (mp_last == NULL)
2629 mp = msg_sb_start(last_msgchunk);
2630 else if (mp_last->sb_prev != NULL)
2631 mp = msg_sb_start(mp_last->sb_prev);
2632 else
2633 mp = NULL;
2634
2635 /* go to start of line at top of the screen */
2636 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2637 ++i)
2638 mp = msg_sb_start(mp->sb_prev);
2639
2640 if (mp != NULL && mp->sb_prev != NULL)
2641 {
2642 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002643 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002644 {
2645 if (mp == NULL || mp->sb_prev == NULL)
2646 break;
2647 mp = msg_sb_start(mp->sb_prev);
2648 if (mp_last == NULL)
2649 mp_last = msg_sb_start(last_msgchunk);
2650 else
2651 mp_last = msg_sb_start(mp_last->sb_prev);
2652 }
2653
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002654 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002655 (int)Rows, NULL) == OK)
2656 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002657 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002658 (void)disp_sb_line(0, mp);
2659 }
2660 else
2661 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002662 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002663 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002664 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2665 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002666 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002667 ++msg_scrolled;
2668 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002669 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002670 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002671 }
2672 }
2673 else
2674 {
2675 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002676 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002677 {
2678 /* scroll up, display line at bottom */
2679 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002680 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002681 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2682 (int)Columns, ' ', ' ', 0);
2683 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002684 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002685 }
2686 }
2687
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002688 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002689 {
2690 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002691 screen_fill((int)Rows - 1, (int)Rows, 0,
2692 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002693 msg_moremsg(FALSE);
2694 continue;
2695 }
2696
2697 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002698 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002699 }
2700
2701 break;
2702 }
2703
2704 /* clear the --more-- message */
2705 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2706 State = oldState;
2707#ifdef FEAT_MOUSE
2708 setmouse();
2709#endif
2710 if (quit_more)
2711 {
2712 msg_row = Rows - 1;
2713 msg_col = 0;
2714 }
2715#ifdef FEAT_RIGHTLEFT
2716 else if (cmdmsg_rl)
2717 msg_col = Columns - 1;
2718#endif
2719
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002720 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002721#ifdef FEAT_CON_DIALOG
2722 return retval;
2723#else
2724 return FALSE;
2725#endif
2726}
2727
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2729
2730#ifdef mch_errmsg
2731# undef mch_errmsg
2732#endif
2733#ifdef mch_msg
2734# undef mch_msg
2735#endif
2736
2737/*
2738 * Give an error message. To be used when the screen hasn't been initialized
2739 * yet. When stderr can't be used, collect error messages until the GUI has
2740 * started and they can be displayed in a message box.
2741 */
2742 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002743mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744{
2745 int len;
2746
2747#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2748 /* On Unix use stderr if it's a tty.
2749 * When not going to start the GUI also use stderr.
2750 * On Mac, when started from Finder, stderr is the console. */
2751 if (
2752# ifdef UNIX
2753# ifdef MACOS_X_UNIX
2754 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2755# else
2756 isatty(2)
2757# endif
2758# ifdef FEAT_GUI
2759 ||
2760# endif
2761# endif
2762# ifdef FEAT_GUI
2763 !(gui.in_use || gui.starting)
2764# endif
2765 )
2766 {
2767 fprintf(stderr, "%s", str);
2768 return;
2769 }
2770#endif
2771
2772 /* avoid a delay for a message that isn't there */
2773 emsg_on_display = FALSE;
2774
2775 len = (int)STRLEN(str) + 1;
2776 if (error_ga.ga_growsize == 0)
2777 {
2778 error_ga.ga_growsize = 80;
2779 error_ga.ga_itemsize = 1;
2780 }
2781 if (ga_grow(&error_ga, len) == OK)
2782 {
2783 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2784 (char_u *)str, len);
2785#ifdef UNIX
2786 /* remove CR characters, they are displayed */
2787 {
2788 char_u *p;
2789
2790 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2791 for (;;)
2792 {
2793 p = vim_strchr(p, '\r');
2794 if (p == NULL)
2795 break;
2796 *p = ' ';
2797 }
2798 }
2799#endif
2800 --len; /* don't count the NUL at the end */
2801 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 }
2803}
2804
2805/*
2806 * Give a message. To be used when the screen hasn't been initialized yet.
2807 * When there is no tty, collect messages until the GUI has started and they
2808 * can be displayed in a message box.
2809 */
2810 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002811mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812{
2813#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2814 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2815 * uses mch_errmsg() when started from the desktop.
2816 * When not going to start the GUI also use stdout.
2817 * On Mac, when started from Finder, stderr is the console. */
2818 if (
2819# ifdef UNIX
2820# ifdef MACOS_X_UNIX
2821 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2822# else
2823 isatty(2)
2824# endif
2825# ifdef FEAT_GUI
2826 ||
2827# endif
2828# endif
2829# ifdef FEAT_GUI
2830 !(gui.in_use || gui.starting)
2831# endif
2832 )
2833 {
2834 printf("%s", str);
2835 return;
2836 }
2837# endif
2838 mch_errmsg(str);
2839}
2840#endif /* USE_MCH_ERRMSG */
2841
2842/*
2843 * Put a character on the screen at the current message position and advance
2844 * to the next position. Only for printable ASCII!
2845 */
2846 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002847msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848{
2849 msg_didout = TRUE; /* remember that line is not empty */
2850 screen_putchar(c, msg_row, msg_col, attr);
2851#ifdef FEAT_RIGHTLEFT
2852 if (cmdmsg_rl)
2853 {
2854 if (--msg_col == 0)
2855 {
2856 msg_col = Columns;
2857 ++msg_row;
2858 }
2859 }
2860 else
2861#endif
2862 {
2863 if (++msg_col >= Columns)
2864 {
2865 msg_col = 0;
2866 ++msg_row;
2867 }
2868 }
2869}
2870
2871 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002872msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002874 int attr;
2875 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876
2877 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002878 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002880 screen_puts((char_u *)
2881 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2882 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883}
2884
2885/*
2886 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2887 * exmode_active.
2888 */
2889 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002890repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891{
2892 if (State == ASKMORE)
2893 {
2894 msg_moremsg(TRUE); /* display --more-- message again */
2895 msg_row = Rows - 1;
2896 }
2897#ifdef FEAT_CON_DIALOG
2898 else if (State == CONFIRM)
2899 {
2900 display_confirm_msg(); /* display ":confirm" message again */
2901 msg_row = Rows - 1;
2902 }
2903#endif
2904 else if (State == EXTERNCMD)
2905 {
2906 windgoto(msg_row, msg_col); /* put cursor back */
2907 }
2908 else if (State == HITRETURN || State == SETWSIZE)
2909 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002910 if (msg_row == Rows - 1)
2911 {
2912 /* Avoid drawing the "hit-enter" prompt below the previous one,
2913 * overwrite it. Esp. useful when regaining focus and a
2914 * FocusGained autocmd exists but didn't draw anything. */
2915 msg_didout = FALSE;
2916 msg_col = 0;
2917 msg_clr_eos();
2918 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 hit_return_msg();
2920 msg_row = Rows - 1;
2921 }
2922}
2923
2924/*
2925 * msg_check_screen - check if the screen is initialized.
2926 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2927 * While starting the GUI the terminal codes will be set for the GUI, but the
2928 * output goes to the terminal. Don't use the terminal codes then.
2929 */
2930 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002931msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932{
2933 if (!full_screen || !screen_valid(FALSE))
2934 return FALSE;
2935
2936 if (msg_row >= Rows)
2937 msg_row = Rows - 1;
2938 if (msg_col >= Columns)
2939 msg_col = Columns - 1;
2940 return TRUE;
2941}
2942
2943/*
2944 * Clear from current message position to end of screen.
2945 * Skip this when ":silent" was used, no need to clear for redirection.
2946 */
2947 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002948msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949{
2950 if (msg_silent == 0)
2951 msg_clr_eos_force();
2952}
2953
2954/*
2955 * Clear from current message position to end of screen.
2956 * Note: msg_col is not updated, so we remember the end of the message
2957 * for msg_check().
2958 */
2959 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002960msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961{
2962 if (msg_use_printf())
2963 {
2964 if (full_screen) /* only when termcap codes are valid */
2965 {
2966 if (*T_CD)
2967 out_str(T_CD); /* clear to end of display */
2968 else if (*T_CE)
2969 out_str(T_CE); /* clear to end of line */
2970 }
2971 }
2972 else
2973 {
2974#ifdef FEAT_RIGHTLEFT
2975 if (cmdmsg_rl)
2976 {
2977 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2978 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2979 }
2980 else
2981#endif
2982 {
2983 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2984 ' ', ' ', 0);
2985 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2986 }
2987 }
2988}
2989
2990/*
2991 * Clear the command line.
2992 */
2993 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002994msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995{
2996 msg_row = cmdline_row;
2997 msg_col = 0;
2998 msg_clr_eos_force();
2999}
3000
3001/*
3002 * end putting a message on the screen
3003 * call wait_return if the message does not fit in the available space
3004 * return TRUE if wait_return not called.
3005 */
3006 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003007msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008{
3009 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003010 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 * or the ruler option is set and we run into it,
3012 * we have to redraw the window.
3013 * Do not do this if we are abandoning the file or editing the command line.
3014 */
3015 if (!exiting && need_wait_return && !(State & CMDLINE))
3016 {
3017 wait_return(FALSE);
3018 return FALSE;
3019 }
3020 out_flush();
3021 return TRUE;
3022}
3023
3024/*
3025 * If the written message runs into the shown command or ruler, we have to
3026 * wait for hit-return and redraw the window later.
3027 */
3028 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003029msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030{
3031 if (msg_row == Rows - 1 && msg_col >= sc_col)
3032 {
3033 need_wait_return = TRUE;
3034 redraw_cmdline = TRUE;
3035 }
3036}
3037
3038/*
3039 * May write a string to the redirection file.
3040 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3041 */
3042 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003043redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044{
3045 char_u *s = str;
3046 static int cur_col = 0;
3047
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003048 /* Don't do anything for displaying prompts and the like. */
3049 if (redir_off)
3050 return;
3051
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003052 /* If 'verbosefile' is set prepare for writing in that file. */
3053 if (*p_vfile != NUL && verbose_fd == NULL)
3054 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003055
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003056 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 {
3058 /* If the string doesn't start with CR or NL, go to msg_col */
3059 if (*s != '\n' && *s != '\r')
3060 {
3061 while (cur_col < msg_col)
3062 {
3063#ifdef FEAT_EVAL
3064 if (redir_reg)
3065 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003066 else if (redir_vname)
3067 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003068 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003070 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003072 if (verbose_fd != NULL)
3073 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 ++cur_col;
3075 }
3076 }
3077
3078#ifdef FEAT_EVAL
3079 if (redir_reg)
3080 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003081 if (redir_vname)
3082 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083#endif
3084
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003085 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3087 {
3088#ifdef FEAT_EVAL
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003089 if (!redir_reg && !redir_vname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003091 if (redir_fd != NULL)
3092 putc(*s, redir_fd);
3093 if (verbose_fd != NULL)
3094 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 if (*s == '\r' || *s == '\n')
3096 cur_col = 0;
3097 else if (*s == '\t')
3098 cur_col += (8 - cur_col % 8);
3099 else
3100 ++cur_col;
3101 ++s;
3102 }
3103
3104 if (msg_silent != 0) /* should update msg_col */
3105 msg_col = cur_col;
3106 }
3107}
3108
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003109 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003110redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003111{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003112 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003113#ifdef FEAT_EVAL
3114 || redir_reg || redir_vname
3115#endif
3116 ;
3117}
3118
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003120 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003121 * Must always be called paired with verbose_leave()!
3122 */
3123 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003124verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003125{
3126 if (*p_vfile != NUL)
3127 ++msg_silent;
3128}
3129
3130/*
3131 * After giving verbose message.
3132 * Must always be called paired with verbose_enter()!
3133 */
3134 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003135verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003136{
3137 if (*p_vfile != NUL)
3138 if (--msg_silent < 0)
3139 msg_silent = 0;
3140}
3141
3142/*
3143 * Like verbose_enter() and set msg_scroll when displaying the message.
3144 */
3145 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003146verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003147{
3148 if (*p_vfile != NUL)
3149 ++msg_silent;
3150 else
3151 /* always scroll up, don't overwrite */
3152 msg_scroll = TRUE;
3153}
3154
3155/*
3156 * Like verbose_leave() and set cmdline_row when displaying the message.
3157 */
3158 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003159verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003160{
3161 if (*p_vfile != NUL)
3162 {
3163 if (--msg_silent < 0)
3164 msg_silent = 0;
3165 }
3166 else
3167 cmdline_row = msg_row;
3168}
3169
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003170/*
3171 * Called when 'verbosefile' is set: stop writing to the file.
3172 */
3173 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003174verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003175{
3176 if (verbose_fd != NULL)
3177 {
3178 fclose(verbose_fd);
3179 verbose_fd = NULL;
3180 }
3181 verbose_did_open = FALSE;
3182}
3183
3184/*
3185 * Open the file 'verbosefile'.
3186 * Return FAIL or OK.
3187 */
3188 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003189verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003190{
3191 if (verbose_fd == NULL && !verbose_did_open)
3192 {
3193 /* Only give the error message once. */
3194 verbose_did_open = TRUE;
3195
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003196 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003197 if (verbose_fd == NULL)
3198 {
3199 EMSG2(_(e_notopen), p_vfile);
3200 return FAIL;
3201 }
3202 }
3203 return OK;
3204}
3205
3206/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 * Give a warning message (for searching).
3208 * Use 'w' highlighting and may repeat the message after redrawing
3209 */
3210 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003211give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212{
3213 /* Don't do this for ":silent". */
3214 if (msg_silent != 0)
3215 return;
3216
3217 /* Don't want a hit-enter prompt here. */
3218 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220#ifdef FEAT_EVAL
3221 set_vim_var_string(VV_WARNINGMSG, message, -1);
3222#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 vim_free(keep_msg);
3224 keep_msg = NULL;
3225 if (hl)
3226 keep_msg_attr = hl_attr(HLF_W);
3227 else
3228 keep_msg_attr = 0;
3229 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003230 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 msg_didout = FALSE; /* overwrite this message */
3232 msg_nowait = TRUE; /* don't wait for this message */
3233 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003234
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 --no_wait_return;
3236}
3237
3238/*
3239 * Advance msg cursor to column "col".
3240 */
3241 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003242msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243{
3244 if (msg_silent != 0) /* nothing to advance to */
3245 {
3246 msg_col = col; /* for redirection, may fill it up later */
3247 return;
3248 }
3249 if (col >= Columns) /* not enough room */
3250 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003251#ifdef FEAT_RIGHTLEFT
3252 if (cmdmsg_rl)
3253 while (msg_col > Columns - col)
3254 msg_putchar(' ');
3255 else
3256#endif
3257 while (msg_col < col)
3258 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259}
3260
3261#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3262/*
3263 * Used for "confirm()" function, and the :confirm command prefix.
3264 * Versions which haven't got flexible dialogs yet, and console
3265 * versions, get this generic handler which uses the command line.
3266 *
3267 * type = one of:
3268 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3269 * title = title string (can be NULL for default)
3270 * (neither used in console dialogs at the moment)
3271 *
3272 * Format of the "buttons" string:
3273 * "Button1Name\nButton2Name\nButton3Name"
3274 * The first button should normally be the default/accept
3275 * The second button should be the 'Cancel' button
3276 * Other buttons- use your imagination!
3277 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3278 * different letter.
3279 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003281do_dialog(
3282 int type UNUSED,
3283 char_u *title UNUSED,
3284 char_u *message,
3285 char_u *buttons,
3286 int dfltbutton,
3287 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003288 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003289 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003290 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291{
3292 int oldState;
3293 int retval = 0;
3294 char_u *hotkeys;
3295 int c;
3296 int i;
3297
3298#ifndef NO_CONSOLE
3299 /* Don't output anything in silent mode ("ex -s") */
3300 if (silent_mode)
3301 return dfltbutton; /* return default option */
3302#endif
3303
3304#ifdef FEAT_GUI_DIALOG
3305 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3306 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3307 {
3308 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003309 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003310 /* avoid a hit-enter prompt without clearing the cmdline */
3311 need_wait_return = FALSE;
3312 emsg_on_display = FALSE;
3313 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314
3315 /* Flush output to avoid that further messages and redrawing is done
3316 * in the wrong order. */
3317 out_flush();
3318 gui_mch_update();
3319
3320 return c;
3321 }
3322#endif
3323
3324 oldState = State;
3325 State = CONFIRM;
3326#ifdef FEAT_MOUSE
3327 setmouse();
3328#endif
3329
3330 /*
3331 * Since we wait for a keypress, don't make the
3332 * user press RETURN as well afterwards.
3333 */
3334 ++no_wait_return;
3335 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3336
3337 if (hotkeys != NULL)
3338 {
3339 for (;;)
3340 {
3341 /* Get a typed character directly from the user. */
3342 c = get_keystroke();
3343 switch (c)
3344 {
3345 case CAR: /* User accepts default option */
3346 case NL:
3347 retval = dfltbutton;
3348 break;
3349 case Ctrl_C: /* User aborts/cancels */
3350 case ESC:
3351 retval = 0;
3352 break;
3353 default: /* Could be a hotkey? */
3354 if (c < 0) /* special keys are ignored here */
3355 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003356 if (c == ':' && ex_cmd)
3357 {
3358 retval = dfltbutton;
3359 ins_char_typebuf(':');
3360 break;
3361 }
3362
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 /* Make the character lowercase, as chars in "hotkeys" are. */
3364 c = MB_TOLOWER(c);
3365 retval = 1;
3366 for (i = 0; hotkeys[i]; ++i)
3367 {
3368#ifdef FEAT_MBYTE
3369 if (has_mbyte)
3370 {
3371 if ((*mb_ptr2char)(hotkeys + i) == c)
3372 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003373 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 }
3375 else
3376#endif
3377 if (hotkeys[i] == c)
3378 break;
3379 ++retval;
3380 }
3381 if (hotkeys[i])
3382 break;
3383 /* No hotkey match, so keep waiting */
3384 continue;
3385 }
3386 break;
3387 }
3388
3389 vim_free(hotkeys);
3390 }
3391
3392 State = oldState;
3393#ifdef FEAT_MOUSE
3394 setmouse();
3395#endif
3396 --no_wait_return;
3397 msg_end_prompt();
3398
3399 return retval;
3400}
3401
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003402static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403
3404/*
3405 * Copy one character from "*from" to "*to", taking care of multi-byte
3406 * characters. Return the length of the character in bytes.
3407 */
3408 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003409copy_char(
3410 char_u *from,
3411 char_u *to,
3412 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413{
3414#ifdef FEAT_MBYTE
3415 int len;
3416 int c;
3417
3418 if (has_mbyte)
3419 {
3420 if (lowercase)
3421 {
3422 c = MB_TOLOWER((*mb_ptr2char)(from));
3423 return (*mb_char2bytes)(c, to);
3424 }
3425 else
3426 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003427 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 mch_memmove(to, from, (size_t)len);
3429 return len;
3430 }
3431 }
3432 else
3433#endif
3434 {
3435 if (lowercase)
3436 *to = (char_u)TOLOWER_LOC(*from);
3437 else
3438 *to = *from;
3439 return 1;
3440 }
3441}
3442
3443/*
3444 * Format the dialog string, and display it at the bottom of
3445 * the screen. Return a string of hotkey chars (if defined) for
3446 * each 'button'. If a button has no hotkey defined, the first character of
3447 * the button is used.
3448 * The hotkeys can be multi-byte characters, but without combining chars.
3449 *
3450 * Returns an allocated string with hotkeys, or NULL for error.
3451 */
3452 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003453msg_show_console_dialog(
3454 char_u *message,
3455 char_u *buttons,
3456 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457{
3458 int len = 0;
3459#ifdef FEAT_MBYTE
3460# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3461#else
3462# define HOTK_LEN 1
3463#endif
3464 int lenhotkey = HOTK_LEN; /* count first button */
3465 char_u *hotk = NULL;
3466 char_u *msgp = NULL;
3467 char_u *hotkp = NULL;
3468 char_u *r;
3469 int copy;
3470#define HAS_HOTKEY_LEN 30
3471 char_u has_hotkey[HAS_HOTKEY_LEN];
3472 int first_hotkey = FALSE; /* first char of button is hotkey */
3473 int idx;
3474
3475 has_hotkey[0] = FALSE;
3476
3477 /*
3478 * First loop: compute the size of memory to allocate.
3479 * Second loop: copy to the allocated memory.
3480 */
3481 for (copy = 0; copy <= 1; ++copy)
3482 {
3483 r = buttons;
3484 idx = 0;
3485 while (*r)
3486 {
3487 if (*r == DLG_BUTTON_SEP)
3488 {
3489 if (copy)
3490 {
3491 *msgp++ = ',';
3492 *msgp++ = ' '; /* '\n' -> ', ' */
3493
3494 /* advance to next hotkey and set default hotkey */
3495#ifdef FEAT_MBYTE
3496 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003497 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 else
3499#endif
3500 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003501 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 if (dfltbutton)
3503 --dfltbutton;
3504
3505 /* If no hotkey is specified first char is used. */
3506 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3507 first_hotkey = TRUE;
3508 }
3509 else
3510 {
3511 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3512 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3513 if (idx < HAS_HOTKEY_LEN - 1)
3514 has_hotkey[++idx] = FALSE;
3515 }
3516 }
3517 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3518 {
3519 if (*r == DLG_HOTKEY_CHAR)
3520 ++r;
3521 first_hotkey = FALSE;
3522 if (copy)
3523 {
3524 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3525 *msgp++ = *r;
3526 else
3527 {
3528 /* '&a' -> '[a]' */
3529 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3530 msgp += copy_char(r, msgp, FALSE);
3531 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3532
3533 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003534 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 }
3536 }
3537 else
3538 {
3539 ++len; /* '&a' -> '[a]' */
3540 if (idx < HAS_HOTKEY_LEN - 1)
3541 has_hotkey[idx] = TRUE;
3542 }
3543 }
3544 else
3545 {
3546 /* everything else copy literally */
3547 if (copy)
3548 msgp += copy_char(r, msgp, FALSE);
3549 }
3550
3551 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003552 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 }
3554
3555 if (copy)
3556 {
3557 *msgp++ = ':';
3558 *msgp++ = ' ';
3559 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 }
3561 else
3562 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003563 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003564 + 2 /* for the NL's */
3565 + STRLEN(buttons)
3566 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003567 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
3569 /* If no hotkey is specified first char is used. */
3570 if (!has_hotkey[0])
3571 {
3572 first_hotkey = TRUE;
3573 len += 2; /* "x" -> "[x]" */
3574 }
3575
3576 /*
3577 * Now allocate and load the strings
3578 */
3579 vim_free(confirm_msg);
3580 confirm_msg = alloc(len);
3581 if (confirm_msg == NULL)
3582 return NULL;
3583 *confirm_msg = NUL;
3584 hotk = alloc(lenhotkey);
3585 if (hotk == NULL)
3586 return NULL;
3587
3588 *confirm_msg = '\n';
3589 STRCPY(confirm_msg + 1, message);
3590
3591 msgp = confirm_msg + 1 + STRLEN(message);
3592 hotkp = hotk;
3593
Bram Moolenaar6a516062007-07-05 08:11:42 +00003594 /* Define first default hotkey. Keep the hotkey string NUL
3595 * terminated to avoid reading past the end. */
3596 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597
3598 /* Remember where the choices start, displaying starts here when
3599 * "hotkp" typed at the more prompt. */
3600 confirm_msg_tail = msgp;
3601 *msgp++ = '\n';
3602 }
3603 }
3604
3605 display_confirm_msg();
3606 return hotk;
3607}
3608
3609/*
3610 * Display the ":confirm" message. Also called when screen resized.
3611 */
3612 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003613display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614{
3615 /* avoid that 'q' at the more prompt truncates the message here */
3616 ++confirm_msg_used;
3617 if (confirm_msg != NULL)
3618 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3619 --confirm_msg_used;
3620}
3621
3622#endif /* FEAT_CON_DIALOG */
3623
3624#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3625
3626 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003627vim_dialog_yesno(
3628 int type,
3629 char_u *title,
3630 char_u *message,
3631 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632{
3633 if (do_dialog(type,
3634 title == NULL ? (char_u *)_("Question") : title,
3635 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003636 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 return VIM_YES;
3638 return VIM_NO;
3639}
3640
3641 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003642vim_dialog_yesnocancel(
3643 int type,
3644 char_u *title,
3645 char_u *message,
3646 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647{
3648 switch (do_dialog(type,
3649 title == NULL ? (char_u *)_("Question") : title,
3650 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003651 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 {
3653 case 1: return VIM_YES;
3654 case 2: return VIM_NO;
3655 }
3656 return VIM_CANCEL;
3657}
3658
3659 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003660vim_dialog_yesnoallcancel(
3661 int type,
3662 char_u *title,
3663 char_u *message,
3664 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665{
3666 switch (do_dialog(type,
3667 title == NULL ? (char_u *)"Question" : title,
3668 message,
3669 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003670 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 {
3672 case 1: return VIM_YES;
3673 case 2: return VIM_NO;
3674 case 3: return VIM_ALL;
3675 case 4: return VIM_DISCARDALL;
3676 }
3677 return VIM_CANCEL;
3678}
3679
3680#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3681
3682#if defined(FEAT_BROWSE) || defined(PROTO)
3683/*
3684 * Generic browse function. Calls gui_mch_browse() when possible.
3685 * Later this may pop-up a non-GUI file selector (external command?).
3686 */
3687 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003688do_browse(
3689 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3690 char_u *title, /* title for the window */
3691 char_u *dflt, /* default file name (may include directory) */
3692 char_u *ext, /* extension added */
3693 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003695 char_u *filter, /* file name filter */
3696 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697{
3698 char_u *fname;
3699 static char_u *last_dir = NULL; /* last used directory */
3700 char_u *tofree = NULL;
3701 int save_browse = cmdmod.browse;
3702
3703 /* Must turn off browse to avoid that autocommands will get the
3704 * flag too! */
3705 cmdmod.browse = FALSE;
3706
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003707 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003709 if (flags & BROWSE_DIR)
3710 title = (char_u *)_("Select Directory dialog");
3711 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 title = (char_u *)_("Save File dialog");
3713 else
3714 title = (char_u *)_("Open File dialog");
3715 }
3716
3717 /* When no directory specified, use default file name, default dir, buffer
3718 * dir, last dir or current dir */
3719 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3720 {
3721 if (mch_isdir(dflt)) /* default file name is a directory */
3722 {
3723 initdir = dflt;
3724 dflt = NULL;
3725 }
3726 else if (gettail(dflt) != dflt) /* default file name includes a path */
3727 {
3728 tofree = vim_strsave(dflt);
3729 if (tofree != NULL)
3730 {
3731 initdir = tofree;
3732 *gettail(initdir) = NUL;
3733 dflt = gettail(dflt);
3734 }
3735 }
3736 }
3737
3738 if (initdir == NULL || *initdir == NUL)
3739 {
3740 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003741 if (STRCMP(p_bsdir, "last") != 0
3742 && STRCMP(p_bsdir, "buffer") != 0
3743 && STRCMP(p_bsdir, "current") != 0
3744 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 initdir = p_bsdir;
3746 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003747 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 && buf != NULL && buf->b_ffname != NULL)
3749 {
3750 if (dflt == NULL || *dflt == NUL)
3751 dflt = gettail(curbuf->b_ffname);
3752 tofree = vim_strsave(curbuf->b_ffname);
3753 if (tofree != NULL)
3754 {
3755 initdir = tofree;
3756 *gettail(initdir) = NUL;
3757 }
3758 }
3759 /* When 'browsedir' is "last", use dir from last browse */
3760 else if (*p_bsdir == 'l')
3761 initdir = last_dir;
3762 /* When 'browsedir is "current", use current directory. This is the
3763 * default already, leave initdir empty. */
3764 }
3765
3766# ifdef FEAT_GUI
3767 if (gui.in_use) /* when this changes, also adjust f_has()! */
3768 {
3769 if (filter == NULL
3770# ifdef FEAT_EVAL
3771 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3772 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3773# endif
3774 )
3775 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003776 if (flags & BROWSE_DIR)
3777 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003778# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003779 /* For systems that have a directory dialog. */
3780 fname = gui_mch_browsedir(title, initdir);
3781# else
3782 /* Generic solution for selecting a directory: select a file and
3783 * remove the file name. */
3784 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3785# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003786# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003787 /* Win32 adds a dummy file name, others return an arbitrary file
3788 * name. GTK+ 2 returns only the directory, */
3789 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3790 {
3791 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003792 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003793
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003794 if (tail == fname)
3795 *tail++ = '.'; /* use current dir */
3796 *tail = NUL;
3797 }
3798# endif
3799 }
3800 else
3801 fname = gui_mch_browse(flags & BROWSE_SAVE,
3802 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803
3804 /* We hang around in the dialog for a while, the user might do some
3805 * things to our files. The Win32 dialog allows deleting or renaming
3806 * a file, check timestamps. */
3807 need_check_timestamps = TRUE;
3808 did_check_timestamps = FALSE;
3809 }
3810 else
3811# endif
3812 {
3813 /* TODO: non-GUI file selector here */
3814 EMSG(_("E338: Sorry, no file browser in console mode"));
3815 fname = NULL;
3816 }
3817
3818 /* keep the directory for next time */
3819 if (fname != NULL)
3820 {
3821 vim_free(last_dir);
3822 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003823 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 {
3825 *gettail(last_dir) = NUL;
3826 if (*last_dir == NUL)
3827 {
3828 /* filename only returned, must be in current dir */
3829 vim_free(last_dir);
3830 last_dir = alloc(MAXPATHL);
3831 if (last_dir != NULL)
3832 mch_dirname(last_dir, MAXPATHL);
3833 }
3834 }
3835 }
3836
3837 vim_free(tofree);
3838 cmdmod.browse = save_browse;
3839
3840 return fname;
3841}
3842#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003843
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003844#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003845static char *e_printf = N_("E766: Insufficient arguments for printf()");
3846
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003847static long tv_nr(typval_T *tvs, int *idxp);
3848static char *tv_str(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003849# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003850static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003851# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003852
3853/*
3854 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3855 */
3856 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003857tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003858{
3859 int idx = *idxp - 1;
3860 long n = 0;
3861 int err = FALSE;
3862
3863 if (tvs[idx].v_type == VAR_UNKNOWN)
3864 EMSG(_(e_printf));
3865 else
3866 {
3867 ++*idxp;
3868 n = get_tv_number_chk(&tvs[idx], &err);
3869 if (err)
3870 n = 0;
3871 }
3872 return n;
3873}
3874
3875/*
3876 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003877 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003878 */
3879 static char *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003880tv_str(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003881{
3882 int idx = *idxp - 1;
3883 char *s = NULL;
3884
3885 if (tvs[idx].v_type == VAR_UNKNOWN)
3886 EMSG(_(e_printf));
3887 else
3888 {
3889 ++*idxp;
3890 s = (char *)get_tv_string_chk(&tvs[idx]);
3891 }
3892 return s;
3893}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003894
3895# ifdef FEAT_FLOAT
3896/*
3897 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3898 */
3899 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003900tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00003901{
3902 int idx = *idxp - 1;
3903 double f = 0;
3904
3905 if (tvs[idx].v_type == VAR_UNKNOWN)
3906 EMSG(_(e_printf));
3907 else
3908 {
3909 ++*idxp;
3910 if (tvs[idx].v_type == VAR_FLOAT)
3911 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003912 else if (tvs[idx].v_type == VAR_NUMBER)
3913 f = tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003914 else
3915 EMSG(_("E807: Expected Float argument for printf()"));
3916 }
3917 return f;
3918}
3919# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003920#endif
3921
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003922/*
3923 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003924 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003925 * consistency.
3926 *
3927 * This code is based on snprintf.c - a portable implementation of snprintf
3928 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003929 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003930 * The original code, including useful comments, can be found here:
3931 * http://www.ijs.si/software/snprintf/
3932 *
3933 * This snprintf() only supports the following conversion specifiers:
3934 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3935 * with flags: '-', '+', ' ', '0' and '#'.
3936 * An asterisk is supported for field width as well as precision.
3937 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00003938 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3939 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003940 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3941 * 'll' (long long int) is not supported.
3942 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003943 * The locale is not used, the string is used as a byte string. This is only
3944 * relevant for double-byte encodings where the second byte may be '%'.
3945 *
Bram Moolenaara2031822006-03-07 22:29:51 +00003946 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3947 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003948 *
3949 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003950 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00003951 * is greater or equal to "str_m", not all characters from the result
3952 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3953 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003954 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003955 */
3956
3957/*
3958 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003959 *
3960 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003961 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003962 */
3963
3964/* When generating prototypes all of this is skipped, cproto doesn't
3965 * understand this. */
3966#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02003967
Bram Moolenaara800b422010-06-27 01:15:55 +02003968/* Like vim_vsnprintf() but append to the string. */
3969 int
3970vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
3971{
3972 va_list ap;
3973 int str_l;
3974 size_t len = STRLEN(str);
3975 size_t space;
3976
3977 if (str_m <= len)
3978 space = 0;
3979 else
3980 space = str_m - len;
3981 va_start(ap, fmt);
3982 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
3983 va_end(ap);
3984 return str_l;
3985}
Bram Moolenaara800b422010-06-27 01:15:55 +02003986
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003987 int
3988vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3989{
3990 va_list ap;
3991 int str_l;
3992
3993 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003994 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003995 va_end(ap);
3996 return str_l;
3997}
3998
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003999 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004000vim_vsnprintf(
4001 char *str,
4002 size_t str_m,
4003 char *fmt,
4004 va_list ap,
4005 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004006{
4007 size_t str_l = 0;
4008 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004009 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004010
4011 if (p == NULL)
4012 p = "";
4013 while (*p != NUL)
4014 {
4015 if (*p != '%')
4016 {
4017 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004018 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004019
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004020 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004021 if (str_l < str_m)
4022 {
4023 size_t avail = str_m - str_l;
4024
4025 mch_memmove(str + str_l, p, n > avail ? avail : n);
4026 }
4027 p += n;
4028 str_l += n;
4029 }
4030 else
4031 {
4032 size_t min_field_width = 0, precision = 0;
4033 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4034 int alternate_form = 0, force_sign = 0;
4035
4036 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4037 * ignored. */
4038 int space_for_positive = 1;
4039
4040 /* allowed values: \0, h, l, L */
4041 char length_modifier = '\0';
4042
4043 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004044# ifdef FEAT_FLOAT
4045# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004046 * That sounds reasonable to use as the maximum
4047 * printable. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004048# else
4049# define TMP_LEN 32
4050# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004051 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004052
4053 /* string address in case of string argument */
4054 char *str_arg;
4055
4056 /* natural field width of arg without padding and sign */
4057 size_t str_arg_l;
4058
4059 /* unsigned char argument value - only defined for c conversion.
4060 * N.B. standard explicitly states the char argument for the c
4061 * conversion is unsigned */
4062 unsigned char uchar_arg;
4063
4064 /* number of zeros to be inserted for numeric conversions as
4065 * required by the precision or minimal field width */
4066 size_t number_of_zeros_to_pad = 0;
4067
4068 /* index into tmp where zero padding is to be inserted */
4069 size_t zero_padding_insertion_ind = 0;
4070
4071 /* current conversion specifier character */
4072 char fmt_spec = '\0';
4073
4074 str_arg = NULL;
4075 p++; /* skip '%' */
4076
4077 /* parse flags */
4078 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4079 || *p == '#' || *p == '\'')
4080 {
4081 switch (*p)
4082 {
4083 case '0': zero_padding = 1; break;
4084 case '-': justify_left = 1; break;
4085 case '+': force_sign = 1; space_for_positive = 0; break;
4086 case ' ': force_sign = 1;
4087 /* If both the ' ' and '+' flags appear, the ' '
4088 * flag should be ignored */
4089 break;
4090 case '#': alternate_form = 1; break;
4091 case '\'': break;
4092 }
4093 p++;
4094 }
4095 /* If the '0' and '-' flags both appear, the '0' flag should be
4096 * ignored. */
4097
4098 /* parse field width */
4099 if (*p == '*')
4100 {
4101 int j;
4102
4103 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004104 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004105# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004106 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004107# endif
4108 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004109 if (j >= 0)
4110 min_field_width = j;
4111 else
4112 {
4113 min_field_width = -j;
4114 justify_left = 1;
4115 }
4116 }
4117 else if (VIM_ISDIGIT((int)(*p)))
4118 {
4119 /* size_t could be wider than unsigned int; make sure we treat
4120 * argument like common implementations do */
4121 unsigned int uj = *p++ - '0';
4122
4123 while (VIM_ISDIGIT((int)(*p)))
4124 uj = 10 * uj + (unsigned int)(*p++ - '0');
4125 min_field_width = uj;
4126 }
4127
4128 /* parse precision */
4129 if (*p == '.')
4130 {
4131 p++;
4132 precision_specified = 1;
4133 if (*p == '*')
4134 {
4135 int j;
4136
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004137 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004138# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004139 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004140# endif
4141 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004142 p++;
4143 if (j >= 0)
4144 precision = j;
4145 else
4146 {
4147 precision_specified = 0;
4148 precision = 0;
4149 }
4150 }
4151 else if (VIM_ISDIGIT((int)(*p)))
4152 {
4153 /* size_t could be wider than unsigned int; make sure we
4154 * treat argument like common implementations do */
4155 unsigned int uj = *p++ - '0';
4156
4157 while (VIM_ISDIGIT((int)(*p)))
4158 uj = 10 * uj + (unsigned int)(*p++ - '0');
4159 precision = uj;
4160 }
4161 }
4162
4163 /* parse 'h', 'l' and 'll' length modifiers */
4164 if (*p == 'h' || *p == 'l')
4165 {
4166 length_modifier = *p;
4167 p++;
4168 if (length_modifier == 'l' && *p == 'l')
4169 {
4170 /* double l = long long */
4171 length_modifier = 'l'; /* treat it as a single 'l' */
4172 p++;
4173 }
4174 }
4175 fmt_spec = *p;
4176
4177 /* common synonyms: */
4178 switch (fmt_spec)
4179 {
4180 case 'i': fmt_spec = 'd'; break;
4181 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4182 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4183 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004184 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004185 default: break;
4186 }
4187
4188 /* get parameter value, do initial processing */
4189 switch (fmt_spec)
4190 {
4191 /* '%' and 'c' behave similar to 's' regarding flags and field
4192 * widths */
4193 case '%':
4194 case 'c':
4195 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004196 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004197 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004198 str_arg_l = 1;
4199 switch (fmt_spec)
4200 {
4201 case '%':
4202 str_arg = p;
4203 break;
4204
4205 case 'c':
4206 {
4207 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004208
4209 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004210# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004211 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004212# endif
4213 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004214 /* standard demands unsigned char */
4215 uchar_arg = (unsigned char)j;
4216 str_arg = (char *)&uchar_arg;
4217 break;
4218 }
4219
4220 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004221 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004222 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004223# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004224 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004225# endif
4226 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004227 if (str_arg == NULL)
4228 {
4229 str_arg = "[NULL]";
4230 str_arg_l = 6;
4231 }
4232 /* make sure not to address string beyond the specified
4233 * precision !!! */
4234 else if (!precision_specified)
4235 str_arg_l = strlen(str_arg);
4236 /* truncate string if necessary as requested by precision */
4237 else if (precision == 0)
4238 str_arg_l = 0;
4239 else
4240 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004241 /* Don't put the #if inside memchr(), it can be a
4242 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004243# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004244 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004245# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004246 /* memchr on HP does not like n > 2^31 !!! */
4247 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004248 precision <= (size_t)0x7fffffffL ? precision
4249 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004250# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004251 str_arg_l = (q == NULL) ? precision
4252 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004253 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004254# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004255 if (fmt_spec == 'S')
4256 {
4257 if (min_field_width != 0)
4258 min_field_width += STRLEN(str_arg)
4259 - mb_string2cells((char_u *)str_arg, -1);
4260 if (precision)
4261 {
4262 char_u *p1 = (char_u *)str_arg;
4263 size_t i;
4264
4265 for (i = 0; i < precision && *p1; i++)
4266 p1 += mb_ptr2len(p1);
4267
4268 str_arg_l = precision = p1 - (char_u *)str_arg;
4269 }
4270 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004271# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004272 break;
4273
4274 default:
4275 break;
4276 }
4277 break;
4278
4279 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4280 {
4281 /* NOTE: the u, o, x, X and p conversion specifiers
4282 * imply the value is unsigned; d implies a signed
4283 * value */
4284
4285 /* 0 if numeric argument is zero (or if pointer is
4286 * NULL for 'p'), +1 if greater than zero (or nonzero
4287 * for unsigned arguments), -1 if negative (unsigned
4288 * argument is never negative) */
4289 int arg_sign = 0;
4290
4291 /* only defined for length modifier h, or for no
4292 * length modifiers */
4293 int int_arg = 0;
4294 unsigned int uint_arg = 0;
4295
4296 /* only defined for length modifier l */
4297 long int long_arg = 0;
4298 unsigned long int ulong_arg = 0;
4299
4300 /* pointer argument value -only defined for p
4301 * conversion */
4302 void *ptr_arg = NULL;
4303
4304 if (fmt_spec == 'p')
4305 {
4306 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004307 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004308# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004309 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004310# endif
4311 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004312 if (ptr_arg != NULL)
4313 arg_sign = 1;
4314 }
4315 else if (fmt_spec == 'd')
4316 {
4317 /* signed */
4318 switch (length_modifier)
4319 {
4320 case '\0':
4321 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004322 /* char and short arguments are passed as int. */
4323 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004324# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004325 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004326# endif
4327 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004328 if (int_arg > 0)
4329 arg_sign = 1;
4330 else if (int_arg < 0)
4331 arg_sign = -1;
4332 break;
4333 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004334 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004335# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004336 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004337# endif
4338 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004339 if (long_arg > 0)
4340 arg_sign = 1;
4341 else if (long_arg < 0)
4342 arg_sign = -1;
4343 break;
4344 }
4345 }
4346 else
4347 {
4348 /* unsigned */
4349 switch (length_modifier)
4350 {
4351 case '\0':
4352 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004353 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004354# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004355 tvs != NULL ? (unsigned)
4356 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004357# endif
4358 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004359 if (uint_arg != 0)
4360 arg_sign = 1;
4361 break;
4362 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004363 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004364# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004365 tvs != NULL ? (unsigned long)
4366 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004367# endif
4368 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004369 if (ulong_arg != 0)
4370 arg_sign = 1;
4371 break;
4372 }
4373 }
4374
4375 str_arg = tmp;
4376 str_arg_l = 0;
4377
4378 /* NOTE:
4379 * For d, i, u, o, x, and X conversions, if precision is
4380 * specified, the '0' flag should be ignored. This is so
4381 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4382 * FreeBSD, NetBSD; but not with Perl.
4383 */
4384 if (precision_specified)
4385 zero_padding = 0;
4386 if (fmt_spec == 'd')
4387 {
4388 if (force_sign && arg_sign >= 0)
4389 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4390 /* leave negative numbers for sprintf to handle, to
4391 * avoid handling tricky cases like (short int)-32768 */
4392 }
4393 else if (alternate_form)
4394 {
4395 if (arg_sign != 0
4396 && (fmt_spec == 'x' || fmt_spec == 'X') )
4397 {
4398 tmp[str_arg_l++] = '0';
4399 tmp[str_arg_l++] = fmt_spec;
4400 }
4401 /* alternate form should have no effect for p
4402 * conversion, but ... */
4403 }
4404
4405 zero_padding_insertion_ind = str_arg_l;
4406 if (!precision_specified)
4407 precision = 1; /* default precision is 1 */
4408 if (precision == 0 && arg_sign == 0)
4409 {
4410 /* When zero value is formatted with an explicit
4411 * precision 0, the resulting formatted string is
4412 * empty (d, i, u, o, x, X, p). */
4413 }
4414 else
4415 {
4416 char f[5];
4417 int f_l = 0;
4418
4419 /* construct a simple format string for sprintf */
4420 f[f_l++] = '%';
4421 if (!length_modifier)
4422 ;
4423 else if (length_modifier == '2')
4424 {
4425 f[f_l++] = 'l';
4426 f[f_l++] = 'l';
4427 }
4428 else
4429 f[f_l++] = length_modifier;
4430 f[f_l++] = fmt_spec;
4431 f[f_l++] = '\0';
4432
4433 if (fmt_spec == 'p')
4434 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4435 else if (fmt_spec == 'd')
4436 {
4437 /* signed */
4438 switch (length_modifier)
4439 {
4440 case '\0':
4441 case 'h': str_arg_l += sprintf(
4442 tmp + str_arg_l, f, int_arg);
4443 break;
4444 case 'l': str_arg_l += sprintf(
4445 tmp + str_arg_l, f, long_arg);
4446 break;
4447 }
4448 }
4449 else
4450 {
4451 /* unsigned */
4452 switch (length_modifier)
4453 {
4454 case '\0':
4455 case 'h': str_arg_l += sprintf(
4456 tmp + str_arg_l, f, uint_arg);
4457 break;
4458 case 'l': str_arg_l += sprintf(
4459 tmp + str_arg_l, f, ulong_arg);
4460 break;
4461 }
4462 }
4463
4464 /* include the optional minus sign and possible
4465 * "0x" in the region before the zero padding
4466 * insertion point */
4467 if (zero_padding_insertion_ind < str_arg_l
4468 && tmp[zero_padding_insertion_ind] == '-')
4469 zero_padding_insertion_ind++;
4470 if (zero_padding_insertion_ind + 1 < str_arg_l
4471 && tmp[zero_padding_insertion_ind] == '0'
4472 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4473 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4474 zero_padding_insertion_ind += 2;
4475 }
4476
4477 {
4478 size_t num_of_digits = str_arg_l
4479 - zero_padding_insertion_ind;
4480
4481 if (alternate_form && fmt_spec == 'o'
4482 /* unless zero is already the first
4483 * character */
4484 && !(zero_padding_insertion_ind < str_arg_l
4485 && tmp[zero_padding_insertion_ind] == '0'))
4486 {
4487 /* assure leading zero for alternate-form
4488 * octal numbers */
4489 if (!precision_specified
4490 || precision < num_of_digits + 1)
4491 {
4492 /* precision is increased to force the
4493 * first character to be zero, except if a
4494 * zero value is formatted with an
4495 * explicit precision of zero */
4496 precision = num_of_digits + 1;
4497 precision_specified = 1;
4498 }
4499 }
4500 /* zero padding to specified precision? */
4501 if (num_of_digits < precision)
4502 number_of_zeros_to_pad = precision - num_of_digits;
4503 }
4504 /* zero padding to specified minimal field width? */
4505 if (!justify_left && zero_padding)
4506 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004507 int n = (int)(min_field_width - (str_arg_l
4508 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004509 if (n > 0)
4510 number_of_zeros_to_pad += n;
4511 }
4512 break;
4513 }
4514
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004515# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004516 case 'f':
4517 case 'e':
4518 case 'E':
4519 case 'g':
4520 case 'G':
4521 {
4522 /* Floating point. */
4523 double f;
4524 double abs_f;
4525 char format[40];
4526 int l;
4527 int remove_trailing_zeroes = FALSE;
4528
4529 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004530# if defined(FEAT_EVAL)
4531 tvs != NULL ? tv_float(tvs, &arg_idx) :
4532# endif
4533 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004534 abs_f = f < 0 ? -f : f;
4535
4536 if (fmt_spec == 'g' || fmt_spec == 'G')
4537 {
4538 /* Would be nice to use %g directly, but it prints
4539 * "1.0" as "1", we don't want that. */
4540 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4541 || abs_f == 0.0)
4542 fmt_spec = 'f';
4543 else
4544 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4545 remove_trailing_zeroes = TRUE;
4546 }
4547
Bram Moolenaarc9372132009-01-13 15:38:37 +00004548 if (fmt_spec == 'f' &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004549# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004550 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004551# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004552 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004553# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004554 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004555 {
4556 /* Avoid a buffer overflow */
4557 strcpy(tmp, "inf");
4558 str_arg_l = 3;
4559 }
4560 else
4561 {
4562 format[0] = '%';
4563 l = 1;
4564 if (precision_specified)
4565 {
4566 size_t max_prec = TMP_LEN - 10;
4567
4568 /* Make sure we don't get more digits than we
4569 * have room for. */
4570 if (fmt_spec == 'f' && abs_f > 1.0)
4571 max_prec -= (size_t)log10(abs_f);
4572 if (precision > max_prec)
4573 precision = max_prec;
4574 l += sprintf(format + 1, ".%d", (int)precision);
4575 }
4576 format[l] = fmt_spec;
4577 format[l + 1] = NUL;
4578 str_arg_l = sprintf(tmp, format, f);
4579
4580 if (remove_trailing_zeroes)
4581 {
4582 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004583 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004584
4585 /* Using %g or %G: remove superfluous zeroes. */
4586 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004587 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004588 else
4589 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004590 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004591 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004592 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004593 {
4594 /* Remove superfluous '+' and leading
4595 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004596 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004597 {
4598 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004599 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004600 --str_arg_l;
4601 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004602 i = (tp[1] == '-') ? 2 : 1;
4603 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004604 {
4605 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004606 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004607 --str_arg_l;
4608 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004609 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004610 }
4611 }
4612
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004613 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004614 /* Remove trailing zeroes, but keep the one
4615 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004616 while (tp > tmp + 2 && *tp == '0'
4617 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004618 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004619 STRMOVE(tp, tp + 1);
4620 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004621 --str_arg_l;
4622 }
4623 }
4624 else
4625 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004626 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004627
4628 /* Be consistent: some printf("%e") use 1.0e+12
4629 * and some 1.0e+012. Remove one zero in the last
4630 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004631 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004632 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004633 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4634 && tp[2] == '0'
4635 && vim_isdigit(tp[3])
4636 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004637 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004638 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004639 --str_arg_l;
4640 }
4641 }
4642 }
4643 str_arg = tmp;
4644 break;
4645 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004646# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004647
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004648 default:
4649 /* unrecognized conversion specifier, keep format string
4650 * as-is */
4651 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004652 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004653 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004654 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004655
4656 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004657 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004658 str_arg = p;
4659 str_arg_l = 0;
4660 if (*p != NUL)
4661 str_arg_l++; /* include invalid conversion specifier
4662 unchanged if not at end-of-string */
4663 break;
4664 }
4665
4666 if (*p != NUL)
4667 p++; /* step over the just processed conversion specifier */
4668
4669 /* insert padding to the left as requested by min_field_width;
4670 * this does not include the zero padding in case of numerical
4671 * conversions*/
4672 if (!justify_left)
4673 {
4674 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004675 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004676
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004677 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004678 {
4679 if (str_l < str_m)
4680 {
4681 size_t avail = str_m - str_l;
4682
4683 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004684 (size_t)pn > avail ? avail
4685 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004686 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004687 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004688 }
4689 }
4690
4691 /* zero padding as requested by the precision or by the minimal
4692 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004693 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004694 {
4695 /* will not copy first part of numeric right now, *
4696 * force it to be copied later in its entirety */
4697 zero_padding_insertion_ind = 0;
4698 }
4699 else
4700 {
4701 /* insert first part of numerics (sign or '0x') before zero
4702 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004703 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004704
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004705 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004706 {
4707 if (str_l < str_m)
4708 {
4709 size_t avail = str_m - str_l;
4710
4711 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004712 (size_t)zn > avail ? avail
4713 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004714 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004715 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004716 }
4717
4718 /* insert zero padding as requested by the precision or min
4719 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004720 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004721 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004722 {
4723 if (str_l < str_m)
4724 {
4725 size_t avail = str_m-str_l;
4726
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004727 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004728 (size_t)zn > avail ? avail
4729 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004730 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004731 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004732 }
4733 }
4734
4735 /* insert formatted string
4736 * (or as-is conversion specifier for unknown conversions) */
4737 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004738 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004739
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004740 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004741 {
4742 if (str_l < str_m)
4743 {
4744 size_t avail = str_m - str_l;
4745
4746 mch_memmove(str + str_l,
4747 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004748 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004749 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004750 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004751 }
4752 }
4753
4754 /* insert right padding */
4755 if (justify_left)
4756 {
4757 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004758 int pn = (int)(min_field_width
4759 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004760
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004761 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004762 {
4763 if (str_l < str_m)
4764 {
4765 size_t avail = str_m - str_l;
4766
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004767 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004768 (size_t)pn > avail ? avail
4769 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004770 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004771 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004772 }
4773 }
4774 }
4775 }
4776
4777 if (str_m > 0)
4778 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004779 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004780 * overwriting the last character (shouldn't happen, but just in case)
4781 * */
4782 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4783 }
4784
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004785 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004786 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004787
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004788 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004789 * character), that is, the number of characters that would have been
4790 * written to the buffer if it were large enough. */
4791 return (int)str_l;
4792}
4793
4794#endif /* PROTO */