blob: a4dd746d0a54f8d8422203b17edc3d61005cdf89 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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() */
Bram Moolenaar44ca54a2016-08-27 15:41:32 +020015#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
17#include "vim.h"
18
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010019static int other_sourcing_name(void);
20static char_u *get_emsg_source(void);
21static char_u *get_emsg_lnum(void);
22static void add_msg_hist(char_u *s, int len, int attr);
23static void hit_return_msg(void);
24static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000025#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010026static char_u *screen_puts_mbyte(char_u *s, int l, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000027#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010028static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
29static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
30static void msg_scroll_up(void);
31static void inc_msg_scrolled(void);
32static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
33static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
34static void msg_puts_printf(char_u *str, int maxlen);
35static int do_more_prompt(int typed_char);
36static void msg_screen_putchar(int c, int attr);
37static int msg_check_screen(void);
38static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000039#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010040static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000041static int confirm_msg_used = FALSE; /* displaying confirm_msg */
42static char_u *confirm_msg = NULL; /* ":confirm" message */
43static char_u *confirm_msg_tail; /* tail of confirm_msg */
44#endif
Bram Moolenaar958dc692016-12-01 15:34:12 +010045#ifdef FEAT_JOB_CHANNEL
46static int emsg_to_channel_log = FALSE;
47#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000048
49struct msg_hist
50{
51 struct msg_hist *next;
52 char_u *msg;
53 int attr;
54};
55
56static struct msg_hist *first_msg_hist = NULL;
57static struct msg_hist *last_msg_hist = NULL;
58static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020060static FILE *verbose_fd = NULL;
61static int verbose_did_open = FALSE;
62
Bram Moolenaar071d4272004-06-13 20:20:40 +000063/*
64 * When writing messages to the screen, there are many different situations.
65 * A number of variables is used to remember the current state:
66 * msg_didany TRUE when messages were written since the last time the
67 * user reacted to a prompt.
68 * Reset: After hitting a key for the hit-return prompt,
69 * hitting <CR> for the command line or input().
70 * Set: When any message is written to the screen.
71 * msg_didout TRUE when something was written to the current line.
72 * Reset: When advancing to the next line, when the current
73 * text can be overwritten.
74 * Set: When any message is written to the screen.
75 * msg_nowait No extra delay for the last drawn message.
76 * Used in normal_cmd() before the mode message is drawn.
77 * emsg_on_display There was an error message recently. Indicates that there
78 * should be a delay before redrawing.
79 * msg_scroll The next message should not overwrite the current one.
80 * msg_scrolled How many lines the screen has been scrolled (because of
81 * messages). Used in update_screen() to scroll the screen
82 * back. Incremented each time the screen scrolls a line.
83 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
84 * writes something without scrolling should not make
85 * need_wait_return to be set. This is a hack to make ":ts"
86 * work without an extra prompt.
87 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010088 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000089 * need_wait_return TRUE when the hit-return prompt is needed.
90 * Reset: After giving the hit-return prompt, when the user
91 * has answered some other prompt.
92 * Set: When the ruler or typeahead display is overwritten,
93 * scrolling the screen for some message.
94 * keep_msg Message to be displayed after redrawing the screen, in
95 * main_loop().
96 * This is an allocated string or NULL when not used.
97 */
98
99/*
100 * msg(s) - displays the string 's' on the status line
101 * When terminal not initialized (yet) mch_errmsg(..) is used.
102 * return TRUE if wait_return not called
103 */
104 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100105msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106{
107 return msg_attr_keep(s, 0, FALSE);
108}
109
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000110#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000111 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000112/*
113 * Like msg() but keep it silent when 'verbosefile' is set.
114 */
115 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100116verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000117{
118 int n;
119
120 verbose_enter();
121 n = msg_attr_keep(s, 0, FALSE);
122 verbose_leave();
123
124 return n;
125}
126#endif
127
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100129msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130{
131 return msg_attr_keep(s, attr, FALSE);
132}
133
134 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100135msg_attr_keep(
136 char_u *s,
137 int attr,
138 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139{
140 static int entered = 0;
141 int retval;
142 char_u *buf = NULL;
143
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200144 /* Skip messages not matching ":filter pattern".
145 * Don't filter when there is an error. */
146 if (!emsg_on_display && message_filtered(s))
147 return TRUE;
148
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149#ifdef FEAT_EVAL
150 if (attr == 0)
151 set_vim_var_string(VV_STATUSMSG, s, -1);
152#endif
153
154 /*
155 * It is possible that displaying a messages causes a problem (e.g.,
156 * when redrawing the window), which causes another message, etc.. To
157 * break this loop, limit the recursiveness to 3 levels.
158 */
159 if (entered >= 3)
160 return TRUE;
161 ++entered;
162
163 /* Add message to history (unless it's a repeated kept message or a
164 * truncated message) */
165 if (s != keep_msg
166 || (*s != '<'
167 && last_msg_hist != NULL
168 && last_msg_hist->msg != NULL
169 && STRCMP(s, last_msg_hist->msg)))
170 add_msg_hist(s, -1, attr);
171
Bram Moolenaar958dc692016-12-01 15:34:12 +0100172#ifdef FEAT_JOB_CHANNEL
173 if (emsg_to_channel_log)
174 {
175 /* Write message in the channel log. */
176 ch_logs(NULL, "ERROR: %s", (char *)s);
177 }
178#endif
179
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 /* When displaying keep_msg, don't let msg_start() free it, caller must do
181 * that. */
182 if (s == keep_msg)
183 keep_msg = NULL;
184
185 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000186 msg_start();
187 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188 if (buf != NULL)
189 s = buf;
190
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 msg_outtrans_attr(s, attr);
192 msg_clr_eos();
193 retval = msg_end();
194
195 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
196 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000197 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
199 vim_free(buf);
200 --entered;
201 return retval;
202}
203
204/*
205 * Truncate a string such that it can be printed without causing a scroll.
206 * Returns an allocated string or NULL when no truncating is done.
207 */
208 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100209msg_strtrunc(
210 char_u *s,
211 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212{
213 char_u *buf = NULL;
214 int len;
215 int room;
216
217 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000218 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
219 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 {
221 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000222 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000223 /* Use all the columns. */
224 room = (int)(Rows - msg_row) * Columns - 1;
225 else
226 /* Use up to 'showcmd' column. */
227 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228 if (len > room && room > 0)
229 {
230#ifdef FEAT_MBYTE
231 if (enc_utf8)
232 /* may have up to 18 bytes per cell (6 per char, up to two
233 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100234 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 else if (enc_dbcs == DBCS_JPNU)
236 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100237 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238 else
239#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100240 len = room + 2;
241 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100243 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244 }
245 }
246 return buf;
247}
248
249/*
250 * Truncate a string "s" to "buf" with cell width "room".
251 * "s" and "buf" may be equal.
252 */
253 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100254trunc_string(
255 char_u *s,
256 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200257 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100258 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200260 size_t room = room_in - 3; /* "..." takes 3 chars */
261 size_t half;
262 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 int e;
264 int i;
265 int n;
266
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200267 if (room_in < 3)
268 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100272 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 {
274 if (s[e] == NUL)
275 {
276 /* text fits without truncating! */
277 buf[e] = NUL;
278 return;
279 }
280 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200281 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282 break;
283 len += n;
284 buf[e] = s[e];
285#ifdef FEAT_MBYTE
286 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000287 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100289 if (++e == buflen)
290 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291 buf[e] = s[e];
292 }
293#endif
294 }
295
296 /* Last part: End of the string. */
297 i = e;
298#ifdef FEAT_MBYTE
299 if (enc_dbcs != 0)
300 {
301 /* For DBCS going backwards in a string is slow, but
302 * computing the cell width isn't too slow: go forward
303 * until the rest fits. */
304 n = vim_strsize(s + i);
305 while (len + n > room)
306 {
307 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000308 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 }
310 }
311 else if (enc_utf8)
312 {
313 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000314 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315 for (;;)
316 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000317 do
318 half = half - (*mb_head_off)(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200319 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200321 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322 break;
323 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200324 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325 }
326 }
327 else
328#endif
329 {
330 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
331 len += n;
332 }
333
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200334
335 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100336 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200337 /* text fits without truncating */
338 if (s != buf)
339 {
340 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200341 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200342 len = buflen - 1;
343 len = len - e + 1;
344 if (len < 1)
345 buf[e - 1] = NUL;
346 else
347 mch_memmove(buf + e, s + e, len);
348 }
349 }
350 else if (e + 3 < buflen)
351 {
352 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100353 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200354 len = STRLEN(s + i) + 1;
355 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100356 len = buflen - e - 3 - 1;
357 mch_memmove(buf + e + 3, s + i, len);
358 buf[e + 3 + len - 1] = NUL;
359 }
360 else
361 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200362 /* can't fit in the "...", just truncate it */
363 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100364 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365}
366
367/*
368 * Automatic prototype generation does not understand this function.
369 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
370 * shorter than IOSIZE!!!
371 */
372#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000374int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000375
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100377# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100379# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380smsg(char_u *s, ...)
381{
382 va_list arglist;
383
384 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000385 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386 va_end(arglist);
387 return msg(IObuff);
388}
389
390 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100391# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100393# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394smsg_attr(int attr, char_u *s, ...)
395{
396 va_list arglist;
397
398 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000399 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400 va_end(arglist);
401 return msg_attr(IObuff, attr);
402}
403
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404#endif
405
406/*
407 * Remember the last sourcing name/lnum used in an error message, so that it
408 * isn't printed each time when it didn't change.
409 */
410static int last_sourcing_lnum = 0;
411static char_u *last_sourcing_name = NULL;
412
413/*
414 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
415 * for the next error message;
416 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000417 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100418reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419{
420 vim_free(last_sourcing_name);
421 last_sourcing_name = NULL;
422 last_sourcing_lnum = 0;
423}
424
425/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000426 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
427 */
428 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100429other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000430{
431 if (sourcing_name != NULL)
432 {
433 if (last_sourcing_name != NULL)
434 return STRCMP(sourcing_name, last_sourcing_name) != 0;
435 return TRUE;
436 }
437 return FALSE;
438}
439
440/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441 * Get the message about the source, as used for an error message.
442 * Returns an allocated string with room for one more character.
443 * Returns NULL when no message is to be given.
444 */
445 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100446get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447{
448 char_u *Buf, *p;
449
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000450 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451 {
452 p = (char_u *)_("Error detected while processing %s:");
453 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
454 if (Buf != NULL)
455 sprintf((char *)Buf, (char *)p, sourcing_name);
456 return Buf;
457 }
458 return NULL;
459}
460
461/*
462 * Get the message about the source lnum, as used for an error message.
463 * Returns an allocated string with room for one more character.
464 * Returns NULL when no message is to be given.
465 */
466 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100467get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468{
469 char_u *Buf, *p;
470
471 /* lnum is 0 when executing a command from the command line
472 * argument, we don't want a line number then */
473 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000474 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475 && sourcing_lnum != 0)
476 {
477 p = (char_u *)_("line %4ld:");
478 Buf = alloc((unsigned)(STRLEN(p) + 20));
479 if (Buf != NULL)
480 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
481 return Buf;
482 }
483 return NULL;
484}
485
486/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000487 * Display name and line number for the source of an error.
488 * Remember the file name and line number, so that for the next error the info
489 * is only displayed if it changed.
490 */
491 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100492msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000493{
494 char_u *p;
495
496 ++no_wait_return;
497 p = get_emsg_source();
498 if (p != NULL)
499 {
500 msg_attr(p, attr);
501 vim_free(p);
502 }
503 p = get_emsg_lnum();
504 if (p != NULL)
505 {
Bram Moolenaar8820b482017-03-16 17:23:31 +0100506 msg_attr(p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000507 vim_free(p);
508 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
509 }
510
511 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000512 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000513 {
514 vim_free(last_sourcing_name);
515 if (sourcing_name == NULL)
516 last_sourcing_name = NULL;
517 else
518 last_sourcing_name = vim_strsave(sourcing_name);
519 }
520 --no_wait_return;
521}
522
523/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000524 * Return TRUE if not giving error messages right now:
525 * If "emsg_off" is set: no error messages at the moment.
526 * If "msg" is in 'debug': do error message but without side effects.
527 * If "emsg_skip" is set: never do error messages.
528 */
529 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100530emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000531{
532 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
533 && vim_strchr(p_debug, 't') == NULL)
534#ifdef FEAT_EVAL
535 || emsg_skip > 0
536#endif
537 )
538 return TRUE;
539 return FALSE;
540}
541
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100542#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100543static garray_T ignore_error_list = GA_EMPTY;
544
545 void
546ignore_error_for_testing(char_u *error)
547{
548 if (ignore_error_list.ga_itemsize == 0)
549 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
550
551 ga_add_string(&ignore_error_list, error);
552}
553
554 static int
555ignore_error(char_u *msg)
556{
557 int i;
558
559 for (i = 0; i < ignore_error_list.ga_len; ++i)
560 if (strstr((char *)msg,
561 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
562 return TRUE;
563 return FALSE;
564}
565#endif
566
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200567#if !defined(HAVE_STRERROR) || defined(PROTO)
568/*
569 * Replacement for perror() that behaves more or less like emsg() was called.
570 * v:errmsg will be set and called_emsg will be set.
571 */
572 void
573do_perror(char *msg)
574{
575 perror(msg);
576 ++emsg_silent;
577 emsg((char_u *)msg);
578 --emsg_silent;
579}
580#endif
581
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000582/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583 * emsg() - display an error message
584 *
585 * Rings the bell, if appropriate, and calls message() to do the real work
586 * When terminal not initialized (yet) mch_errmsg(..) is used.
587 *
588 * return TRUE if wait_return not called
589 */
590 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100591emsg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592{
593 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100595 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596#ifdef FEAT_EVAL
597 int ignore = FALSE;
598 int severe;
599#endif
600
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100601 /* Skip this if not giving error messages at the moment. */
602 if (emsg_not_now())
603 return TRUE;
604
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100605#ifdef FEAT_EVAL
606 /* When testing some errors are turned into a normal message. */
607 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100608 /* don't call msg() if it results in a dialog */
609 return msg_use_printf() ? FALSE : msg(s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100610#endif
611
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 called_emsg = TRUE;
613
614 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000615 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
616 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 */
618#ifdef FEAT_EVAL
619 severe = emsg_severe;
620 emsg_severe = FALSE;
621#endif
622
Bram Moolenaar57657d82006-04-21 22:12:41 +0000623 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 {
625#ifdef FEAT_EVAL
626 /*
627 * Cause a throw of an error exception if appropriate. Don't display
628 * the error message in this case. (If no matching catch clause will
629 * be found, the message will be displayed later on.) "ignore" is set
630 * when the message should be ignored completely (used for the
631 * interrupt message).
632 */
633 if (cause_errthrow(s, severe, &ignore) == TRUE)
634 {
635 if (!ignore)
636 did_emsg = TRUE;
637 return TRUE;
638 }
639
640 /* set "v:errmsg", also when using ":silent! cmd" */
641 set_vim_var_string(VV_ERRMSG, s, -1);
642#endif
643
644 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000645 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 * But do write it to the redirection file.
647 */
648 if (emsg_silent != 0)
649 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200650 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200652 msg_start();
653 p = get_emsg_source();
654 if (p != NULL)
655 {
656 STRCAT(p, "\n");
657 redir_write(p, -1);
658 vim_free(p);
659 }
660 p = get_emsg_lnum();
661 if (p != NULL)
662 {
663 STRCAT(p, "\n");
664 redir_write(p, -1);
665 vim_free(p);
666 }
667 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100669#ifdef FEAT_JOB_CHANNEL
670 ch_logs(NULL, "ERROR: %s", (char *)s);
671#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 return TRUE;
673 }
674
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100675 ex_exitval = 1;
676
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 /* Reset msg_silent, an error causes messages to be switched back on. */
678 msg_silent = 0;
679 cmd_silent = FALSE;
680
681 if (global_busy) /* break :global command */
682 ++global_busy;
683
684 if (p_eb)
685 beep_flush(); /* also includes flush_buffers() */
686 else
687 flush_buffers(FALSE); /* flush internal buffers */
688 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 }
690
691 emsg_on_display = TRUE; /* remember there is an error message */
692 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100693 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000694 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 need_wait_return = TRUE; /* needed in case emsg() is called after
696 * wait_return has reset need_wait_return
697 * and a redraw is expected because
698 * msg_scrolled is non-zero */
699
Bram Moolenaar958dc692016-12-01 15:34:12 +0100700#ifdef FEAT_JOB_CHANNEL
701 emsg_to_channel_log = TRUE;
702#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 /*
704 * Display name and line number for the source of the error.
705 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000706 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707
708 /*
709 * Display the error message itself.
710 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000711 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar958dc692016-12-01 15:34:12 +0100712 r = msg_attr(s, attr);
713
714#ifdef FEAT_JOB_CHANNEL
715 emsg_to_channel_log = FALSE;
716#endif
717 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718}
719
Bram Moolenaar95f09602016-11-10 20:01:45 +0100720
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721/*
722 * Print an error message with one "%s" and one string argument.
723 */
724 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100725emsg2(char_u *s, char_u *a1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726{
727 return emsg3(s, a1, NULL);
728}
729
Bram Moolenaar95f09602016-11-10 20:01:45 +0100730/*
731 * Print an error message with one or two "%s" and one or two string arguments.
732 * This is not in message.c to avoid a warning for prototypes.
733 */
734 int
735emsg3(char_u *s, char_u *a1, char_u *a2)
736{
737 if (emsg_not_now())
738 return TRUE; /* no error messages at the moment */
739 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, a1, a2);
740 return emsg(IObuff);
741}
742
743/*
744 * Print an error message with one "%ld" and one long int argument.
745 * This is not in message.c to avoid a warning for prototypes.
746 */
747 int
748emsgn(char_u *s, long n)
749{
750 if (emsg_not_now())
751 return TRUE; /* no error messages at the moment */
752 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, n);
753 return emsg(IObuff);
754}
755
756/*
757 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
758 * defined. It is used for internal errors only, so that they can be
759 * detected when fuzzing vim.
760 */
761 void
762iemsg(char_u *s)
763{
764 msg(s);
765#ifdef ABORT_ON_INTERNAL_ERROR
766 abort();
767#endif
768}
769
770
771/*
772 * Same as emsg2(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
773 * defined. It is used for internal errors only, so that they can be
774 * detected when fuzzing vim.
775 */
776 void
777iemsg2(char_u *s, char_u *a1)
778{
779 emsg2(s, a1);
780#ifdef ABORT_ON_INTERNAL_ERROR
781 abort();
782#endif
783}
784
785/*
786 * Same as emsgn(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
787 * defined. It is used for internal errors only, so that they can be
788 * detected when fuzzing vim.
789 */
790 void
791iemsgn(char_u *s, long n)
792{
793 emsgn(s, n);
794#ifdef ABORT_ON_INTERNAL_ERROR
795 abort();
796#endif
797}
798
799/*
800 * Give an "Internal error" message.
801 */
802 void
803internal_error(char *where)
804{
805 IEMSG2(_(e_intern2), where);
806}
807
Bram Moolenaarea424162005-06-16 21:51:00 +0000808/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809
Bram Moolenaardf177f62005-02-22 08:39:57 +0000810 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100811emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000812{
813 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
814}
815
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816/*
817 * Like msg(), but truncate to a single line if p_shm contains 't', or when
818 * "force" is TRUE. This truncates in another way as for normal messages.
819 * Careful: The string may be changed by msg_may_trunc()!
820 * Returns a pointer to the printed message, if wait_return() not called.
821 */
822 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100823msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824{
825 int n;
826
827 /* Add message to history before truncating */
828 add_msg_hist(s, -1, attr);
829
830 s = msg_may_trunc(force, s);
831
832 msg_hist_off = TRUE;
833 n = msg_attr(s, attr);
834 msg_hist_off = FALSE;
835
836 if (n)
837 return s;
838 return NULL;
839}
840
841/*
842 * Check if message "s" should be truncated at the start (for filenames).
843 * Return a pointer to where the truncated message starts.
844 * Note: May change the message by replacing a character with '<'.
845 */
846 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100847msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848{
849 int n;
850 int room;
851
852 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
853 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
854 && (n = (int)STRLEN(s) - room) > 0)
855 {
856#ifdef FEAT_MBYTE
857 if (has_mbyte)
858 {
859 int size = vim_strsize(s);
860
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000861 /* There may be room anyway when there are multibyte chars. */
862 if (size <= room)
863 return s;
864
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 for (n = 0; size >= room; )
866 {
867 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000868 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 }
870 --n;
871 }
872#endif
873 s += n;
874 *s = '<';
875 }
876 return s;
877}
878
879 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100880add_msg_hist(
881 char_u *s,
882 int len, /* -1 for undetermined length */
883 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884{
885 struct msg_hist *p;
886
887 if (msg_hist_off || msg_silent != 0)
888 return;
889
890 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000891 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000892 (void)delete_first_msg();
893
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 /* allocate an entry and add the message at the end of the history */
895 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
896 if (p != NULL)
897 {
898 if (len < 0)
899 len = (int)STRLEN(s);
900 /* remove leading and trailing newlines */
901 while (len > 0 && *s == '\n')
902 {
903 ++s;
904 --len;
905 }
906 while (len > 0 && s[len - 1] == '\n')
907 --len;
908 p->msg = vim_strnsave(s, len);
909 p->next = NULL;
910 p->attr = attr;
911 if (last_msg_hist != NULL)
912 last_msg_hist->next = p;
913 last_msg_hist = p;
914 if (first_msg_hist == NULL)
915 first_msg_hist = last_msg_hist;
916 ++msg_hist_len;
917 }
918}
919
920/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000921 * Delete the first (oldest) message from the history.
922 * Returns FAIL if there are no messages.
923 */
924 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100925delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000926{
927 struct msg_hist *p;
928
929 if (msg_hist_len <= 0)
930 return FAIL;
931 p = first_msg_hist;
932 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000933 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200934 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000935 vim_free(p->msg);
936 vim_free(p);
937 --msg_hist_len;
938 return OK;
939}
940
941/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 * ":messages" command.
943 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200945ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946{
947 struct msg_hist *p;
948 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200949 int c = 0;
950
951 if (STRCMP(eap->arg, "clear") == 0)
952 {
953 int keep = eap->addr_count == 0 ? 0 : eap->line2;
954
955 while (msg_hist_len > keep)
956 (void)delete_first_msg();
957 return;
958 }
959
960 if (*eap->arg != NUL)
961 {
962 EMSG(_(e_invarg));
963 return;
964 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965
966 msg_hist_off = TRUE;
967
Bram Moolenaar451f8492016-04-14 17:16:22 +0200968 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200969 if (eap->addr_count != 0)
970 {
971 /* Count total messages */
972 for (; p != NULL && !got_int; p = p->next)
973 c++;
974
975 c -= eap->line2;
976
977 /* Skip without number of messages specified */
978 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
979 p = p->next, c--);
980 }
981
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200982 if (p == first_msg_hist)
983 {
984 s = mch_getenv((char_u *)"LANG");
985 if (s != NULL && *s != NUL)
986 msg_attr((char_u *)
987 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100988 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200989 }
990
Bram Moolenaar451f8492016-04-14 17:16:22 +0200991 /* Display what was not skipped. */
992 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 if (p->msg != NULL)
994 msg_attr(p->msg, p->attr);
995
996 msg_hist_off = FALSE;
997}
998
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000999#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000/*
1001 * Call this after prompting the user. This will avoid a hit-return message
1002 * and a delay.
1003 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001004 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001005msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006{
1007 need_wait_return = FALSE;
1008 emsg_on_display = FALSE;
1009 cmdline_row = msg_row;
1010 msg_col = 0;
1011 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001012 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013}
1014#endif
1015
1016/*
1017 * wait for the user to hit a key (normally a return)
1018 * if 'redraw' is TRUE, clear and redraw the screen
1019 * if 'redraw' is FALSE, just redraw the screen
1020 * if 'redraw' is -1, don't redraw at all
1021 */
1022 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001023wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024{
1025 int c;
1026 int oldState;
1027 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 int had_got_int;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001029 int save_Recording;
1030 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
1032 if (redraw == TRUE)
1033 must_redraw = CLEAR;
1034
1035 /* If using ":silent cmd", don't wait for a return. Also don't set
1036 * need_wait_return to do it later. */
1037 if (msg_silent != 0)
1038 return;
1039
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001040 /*
1041 * When inside vgetc(), we can't wait for a typed character at all.
1042 * With the global command (and some others) we only need one return at
1043 * the end. Adjust cmdline_row to avoid the next message overwriting the
1044 * last one.
1045 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001046 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001048 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 if (no_wait_return)
1050 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 if (!exmode_active)
1052 cmdline_row = msg_row;
1053 return;
1054 }
1055
1056 redir_off = TRUE; /* don't redirect this message */
1057 oldState = State;
1058 if (quit_more)
1059 {
1060 c = CAR; /* just pretend CR was hit */
1061 quit_more = FALSE;
1062 got_int = FALSE;
1063 }
1064 else if (exmode_active)
1065 {
1066 MSG_PUTS(" "); /* make sure the cursor is on the right line */
1067 c = CAR; /* no need for a return in ex mode */
1068 got_int = FALSE;
1069 }
1070 else
1071 {
1072 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1073 * just changed. */
1074 screenalloc(FALSE);
1075
1076 State = HITRETURN;
1077#ifdef FEAT_MOUSE
1078 setmouse();
1079#endif
1080#ifdef USE_ON_FLY_SCROLL
1081 dont_scroll = TRUE; /* disallow scrolling here */
1082#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001083 cmdline_row = msg_row;
1084
Bram Moolenaarec38d692013-04-24 15:12:32 +02001085 /* Avoid the sequence that the user types ":" at the hit-return prompt
1086 * to start an Ex command, but the file-changed dialog gets in the
1087 * way. */
1088 if (need_check_timestamps)
1089 check_timestamps(FALSE);
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 hit_return_msg();
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 do
1094 {
1095 /* Remember "got_int", if it is set vgetc() probably returns a
1096 * CTRL-C, but we need to loop then. */
1097 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001098
1099 /* Don't do mappings here, we put the character back in the
1100 * typeahead buffer. */
1101 ++no_mapping;
1102 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001103
1104 /* Temporarily disable Recording. If Recording is active, the
1105 * character will be recorded later, since it will be added to the
1106 * typebuf after the loop */
1107 save_Recording = Recording;
1108 save_scriptout = scriptout;
1109 Recording = FALSE;
1110 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001112 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001114 --no_mapping;
1115 --allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001116 Recording = save_Recording;
1117 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001118
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119#ifdef FEAT_CLIPBOARD
1120 /* Strange way to allow copying (yanking) a modeless selection at
1121 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1122 * Cmdline-mode and it's harmless when there is no selection. */
1123 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1124 {
1125 clip_copy_modeless_selection(TRUE);
1126 c = K_IGNORE;
1127 }
1128#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001129
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001130 /*
1131 * Allow scrolling back in the messages.
1132 * Also accept scroll-down commands when messages fill the screen,
1133 * to avoid that typing one 'j' too many makes the messages
1134 * disappear.
1135 */
1136 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001137 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001138 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1139 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001140 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001141 if (msg_scrolled > Rows)
1142 /* scroll back to show older messages */
1143 do_more_prompt(c);
1144 else
1145 {
1146 msg_didout = FALSE;
1147 c = K_IGNORE;
1148 msg_col =
1149#ifdef FEAT_RIGHTLEFT
1150 cmdmsg_rl ? Columns - 1 :
1151#endif
1152 0;
1153 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001154 if (quit_more)
1155 {
1156 c = CAR; /* just pretend CR was hit */
1157 quit_more = FALSE;
1158 got_int = FALSE;
1159 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001160 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001161 {
1162 c = K_IGNORE;
1163 hit_return_msg();
1164 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001165 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001166 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001167 && (c == 'j' || c == 'd' || c == 'f'
1168 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001169 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001170 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 } while ((had_got_int && c == Ctrl_C)
1172 || c == K_IGNORE
1173#ifdef FEAT_GUI
1174 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1175#endif
1176#ifdef FEAT_MOUSE
1177 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1178 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1179 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001180 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 || c == K_MOUSEDOWN || c == K_MOUSEUP
1182 || (!mouse_has(MOUSE_RETURN)
1183 && mouse_row < msg_row
1184 && (c == K_LEFTMOUSE
1185 || c == K_MIDDLEMOUSE
1186 || c == K_RIGHTMOUSE
1187 || c == K_X1MOUSE
1188 || c == K_X2MOUSE))
1189#endif
1190 );
1191 ui_breakcheck();
1192#ifdef FEAT_MOUSE
1193 /*
1194 * Avoid that the mouse-up event causes visual mode to start.
1195 */
1196 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1197 || c == K_X1MOUSE || c == K_X2MOUSE)
1198 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1199 else
1200#endif
1201 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1202 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001203 /* Put the character back in the typeahead buffer. Don't use the
1204 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001205 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001207 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 }
1210 redir_off = FALSE;
1211
1212 /*
1213 * If the user hits ':', '?' or '/' we get a command line from the next
1214 * line.
1215 */
1216 if (c == ':' || c == '?' || c == '/')
1217 {
1218 if (!exmode_active)
1219 cmdline_row = msg_row;
1220 skip_redraw = TRUE; /* skip redraw once */
1221 do_redraw = FALSE;
1222 }
1223
1224 /*
1225 * If the window size changed set_shellsize() will redraw the screen.
1226 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1227 * typed.
1228 */
1229 tmpState = State;
1230 State = oldState; /* restore State before set_shellsize */
1231#ifdef FEAT_MOUSE
1232 setmouse();
1233#endif
1234 msg_check();
1235
1236#if defined(UNIX) || defined(VMS)
1237 /*
1238 * When switching screens, we need to output an extra newline on exit.
1239 */
1240 if (swapping_screen() && !termcap_active)
1241 newline_on_exit = TRUE;
1242#endif
1243
1244 need_wait_return = FALSE;
1245 did_wait_return = TRUE;
1246 emsg_on_display = FALSE; /* can delete error message now */
1247 lines_left = -1; /* reset lines_left at next msg_start() */
1248 reset_last_sourcing();
1249 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1250 (Rows - cmdline_row - 1) * Columns + sc_col)
1251 {
1252 vim_free(keep_msg);
1253 keep_msg = NULL; /* don't redisplay message, it's too long */
1254 }
1255
1256 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1257 {
1258 starttermcap(); /* start termcap before redrawing */
1259 shell_resized();
1260 }
1261 else if (!skip_redraw
1262 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1263 {
1264 starttermcap(); /* start termcap before redrawing */
1265 redraw_later(VALID);
1266 }
1267}
1268
1269/*
1270 * Write the hit-return prompt.
1271 */
1272 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001273hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001275 int save_p_more = p_more;
1276
1277 p_more = FALSE; /* don't want see this message when scrolling back */
1278 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 msg_putchar('\n');
1280 if (got_int)
1281 MSG_PUTS(_("Interrupt: "));
1282
Bram Moolenaar8820b482017-03-16 17:23:31 +01001283 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 if (!msg_use_printf())
1285 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001286 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287}
1288
1289/*
1290 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1291 */
1292 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001293set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294{
1295 vim_free(keep_msg);
1296 if (s != NULL && msg_silent == 0)
1297 keep_msg = vim_strsave(s);
1298 else
1299 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001300 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001301 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302}
1303
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001304#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1305/*
1306 * If there currently is a message being displayed, set "keep_msg" to it, so
1307 * that it will be displayed again after redraw.
1308 */
1309 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001310set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001311{
1312 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1313 && (State & NORMAL))
1314 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1315}
1316#endif
1317
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318/*
1319 * Prepare for outputting characters in the command line.
1320 */
1321 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001322msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323{
1324 int did_return = FALSE;
1325
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001326 if (!msg_silent)
1327 {
1328 vim_free(keep_msg);
1329 keep_msg = NULL; /* don't display old message now */
1330 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001331
1332#ifdef FEAT_EVAL
1333 if (need_clr_eos)
1334 {
1335 /* Halfway an ":echo" command and getting an (error) message: clear
1336 * any text from the command. */
1337 need_clr_eos = FALSE;
1338 msg_clr_eos();
1339 }
1340#endif
1341
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 if (!msg_scroll && full_screen) /* overwrite last message */
1343 {
1344 msg_row = cmdline_row;
1345 msg_col =
1346#ifdef FEAT_RIGHTLEFT
1347 cmdmsg_rl ? Columns - 1 :
1348#endif
1349 0;
1350 }
1351 else if (msg_didout) /* start message on next line */
1352 {
1353 msg_putchar('\n');
1354 did_return = TRUE;
1355 if (exmode_active != EXMODE_NORMAL)
1356 cmdline_row = msg_row;
1357 }
1358 if (!msg_didany || lines_left < 0)
1359 msg_starthere();
1360 if (msg_silent == 0)
1361 {
1362 msg_didout = FALSE; /* no output on current line yet */
1363 cursor_off();
1364 }
1365
1366 /* when redirecting, may need to start a new line. */
1367 if (!did_return)
1368 redir_write((char_u *)"\n", -1);
1369}
1370
1371/*
1372 * Note that the current msg position is where messages start.
1373 */
1374 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001375msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376{
1377 lines_left = cmdline_row;
1378 msg_didany = FALSE;
1379}
1380
1381 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001382msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383{
1384 msg_putchar_attr(c, 0);
1385}
1386
1387 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001388msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389{
1390#ifdef FEAT_MBYTE
1391 char_u buf[MB_MAXBYTES + 1];
1392#else
1393 char_u buf[4];
1394#endif
1395
1396 if (IS_SPECIAL(c))
1397 {
1398 buf[0] = K_SPECIAL;
1399 buf[1] = K_SECOND(c);
1400 buf[2] = K_THIRD(c);
1401 buf[3] = NUL;
1402 }
1403 else
1404 {
1405#ifdef FEAT_MBYTE
1406 buf[(*mb_char2bytes)(c, buf)] = NUL;
1407#else
1408 buf[0] = c;
1409 buf[1] = NUL;
1410#endif
1411 }
1412 msg_puts_attr(buf, attr);
1413}
1414
1415 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001416msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417{
1418 char_u buf[20];
1419
1420 sprintf((char *)buf, "%ld", n);
1421 msg_puts(buf);
1422}
1423
1424 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001425msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426{
1427 msg_home_replace_attr(fname, 0);
1428}
1429
1430#if defined(FEAT_FIND_ID) || defined(PROTO)
1431 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001432msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001434 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435}
1436#endif
1437
1438 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001439msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440{
1441 char_u *name;
1442
1443 name = home_replace_save(NULL, fname);
1444 if (name != NULL)
1445 msg_outtrans_attr(name, attr);
1446 vim_free(name);
1447}
1448
1449/*
1450 * Output 'len' characters in 'str' (including NULs) with translation
1451 * if 'len' is -1, output upto a NUL character.
1452 * Use attributes 'attr'.
1453 * Return the number of characters it takes on the screen.
1454 */
1455 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001456msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457{
1458 return msg_outtrans_attr(str, 0);
1459}
1460
1461 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001462msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463{
1464 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1465}
1466
1467 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001468msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469{
1470 return msg_outtrans_len_attr(str, len, 0);
1471}
1472
1473/*
1474 * Output one character at "p". Return pointer to the next character.
1475 * Handles multi-byte characters.
1476 */
1477 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001478msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479{
1480#ifdef FEAT_MBYTE
1481 int l;
1482
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001483 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 {
1485 msg_outtrans_len_attr(p, l, attr);
1486 return p + l;
1487 }
1488#endif
1489 msg_puts_attr(transchar_byte(*p), attr);
1490 return p + 1;
1491}
1492
1493 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001494msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495{
1496 int retval = 0;
1497 char_u *str = msgstr;
1498 char_u *plain_start = msgstr;
1499 char_u *s;
1500#ifdef FEAT_MBYTE
1501 int mb_l;
1502 int c;
1503#endif
1504
1505 /* if MSG_HIST flag set, add message to history */
1506 if (attr & MSG_HIST)
1507 {
1508 add_msg_hist(str, len, attr);
1509 attr &= ~MSG_HIST;
1510 }
1511
1512#ifdef FEAT_MBYTE
1513 /* If the string starts with a composing character first draw a space on
1514 * which the composing char can be drawn. */
1515 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1516 msg_puts_attr((char_u *)" ", attr);
1517#endif
1518
1519 /*
1520 * Go over the string. Special characters are translated and printed.
1521 * Normal characters are printed several at a time.
1522 */
1523 while (--len >= 0)
1524 {
1525#ifdef FEAT_MBYTE
1526 if (enc_utf8)
1527 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001528 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001530 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 else
1532 mb_l = 1;
1533 if (has_mbyte && mb_l > 1)
1534 {
1535 c = (*mb_ptr2char)(str);
1536 if (vim_isprintc(c))
1537 /* printable multi-byte char: count the cells. */
1538 retval += (*mb_ptr2cells)(str);
1539 else
1540 {
1541 /* unprintable multi-byte char: print the printable chars so
1542 * far and the translation of the unprintable char. */
1543 if (str > plain_start)
1544 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1545 attr);
1546 plain_start = str + mb_l;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001547 msg_puts_attr(transchar(c), attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 retval += char2cells(c);
1549 }
1550 len -= mb_l - 1;
1551 str += mb_l;
1552 }
1553 else
1554#endif
1555 {
1556 s = transchar_byte(*str);
1557 if (s[1] != NUL)
1558 {
1559 /* unprintable char: print the printable chars so far and the
1560 * translation of the unprintable char. */
1561 if (str > plain_start)
1562 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1563 attr);
1564 plain_start = str + 1;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001565 msg_puts_attr(s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001566 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001568 else
1569 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 ++str;
1571 }
1572 }
1573
1574 if (str > plain_start)
1575 /* print the printable chars at the end */
1576 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1577
1578 return retval;
1579}
1580
1581#if defined(FEAT_QUICKFIX) || defined(PROTO)
1582 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001583msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584{
1585 int i;
1586 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1587
1588 arg = skipwhite(arg);
1589 for (i = 5; *arg && i >= 0; --i)
1590 if (*arg++ != str[i])
1591 break;
1592 if (i < 0)
1593 {
1594 msg_putchar('\n');
1595 for (i = 0; rs[i]; ++i)
1596 msg_putchar(rs[i] - 3);
1597 }
1598}
1599#endif
1600
1601/*
1602 * Output the string 'str' upto a NUL character.
1603 * Return the number of characters it takes on the screen.
1604 *
1605 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1606 * following character and shown as <F1>, <S-Up> etc. Any other character
1607 * which is not printable shown in <> form.
1608 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1609 * If a character is displayed in one of these special ways, is also
1610 * highlighted (its highlight name is '8' in the p_hl variable).
1611 * Otherwise characters are not highlighted.
1612 * This function is used to show mappings, where we want to see how to type
1613 * the character/string -- webb
1614 */
1615 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001616msg_outtrans_special(
1617 char_u *strstart,
1618 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619{
1620 char_u *str = strstart;
1621 int retval = 0;
1622 char_u *string;
1623 int attr;
1624 int len;
1625
Bram Moolenaar8820b482017-03-16 17:23:31 +01001626 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 while (*str != NUL)
1628 {
1629 /* Leading and trailing spaces need to be displayed in <> form. */
1630 if ((str == strstart || str[1] == NUL) && *str == ' ')
1631 {
1632 string = (char_u *)"<Space>";
1633 ++str;
1634 }
1635 else
1636 string = str2special(&str, from);
1637 len = vim_strsize(string);
1638 /* Highlight special keys */
1639 msg_puts_attr(string, len > 1
1640#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001641 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642#endif
1643 ? attr : 0);
1644 retval += len;
1645 }
1646 return retval;
1647}
1648
Bram Moolenaarbd743252010-10-20 21:23:33 +02001649#if defined(FEAT_EVAL) || defined(PROTO)
1650/*
1651 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1652 * strings, in an allocated string.
1653 */
1654 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001655str2special_save(
1656 char_u *str,
1657 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001658{
1659 garray_T ga;
1660 char_u *p = str;
1661
1662 ga_init2(&ga, 1, 40);
1663 while (*p != NUL)
1664 ga_concat(&ga, str2special(&p, is_lhs));
1665 ga_append(&ga, NUL);
1666 return (char_u *)ga.ga_data;
1667}
1668#endif
1669
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670/*
1671 * Return the printable string for the key codes at "*sp".
1672 * Used for translating the lhs or rhs of a mapping to printable chars.
1673 * Advances "sp" to the next code.
1674 */
1675 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001676str2special(
1677 char_u **sp,
1678 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679{
1680 int c;
1681 static char_u buf[7];
1682 char_u *str = *sp;
1683 int modifiers = 0;
1684 int special = FALSE;
1685
1686#ifdef FEAT_MBYTE
1687 if (has_mbyte)
1688 {
1689 char_u *p;
1690
1691 /* Try to un-escape a multi-byte character. Return the un-escaped
1692 * string if it is a multi-byte character. */
1693 p = mb_unescape(sp);
1694 if (p != NULL)
1695 return p;
1696 }
1697#endif
1698
1699 c = *str;
1700 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1701 {
1702 if (str[1] == KS_MODIFIER)
1703 {
1704 modifiers = str[2];
1705 str += 3;
1706 c = *str;
1707 }
1708 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1709 {
1710 c = TO_SPECIAL(str[1], str[2]);
1711 str += 2;
Bram Moolenaar37985192013-06-07 19:53:10 +02001712 if (c == KS_ZERO) /* display <Nul> as ^@ or <Nul> */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 c = NUL;
1714 }
1715 if (IS_SPECIAL(c) || modifiers) /* special key */
1716 special = TRUE;
1717 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718
1719#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001720 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001722 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001723
1724 /* For multi-byte characters check for an illegal byte. */
1725 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1726 {
1727 transchar_nonprint(buf, c);
1728 *sp = str + 1;
1729 return buf;
1730 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001731 /* Since 'special' is TRUE the multi-byte character 'c' will be
1732 * processed by get_special_key_name() */
1733 c = (*mb_ptr2char)(str);
1734 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001736 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001738 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739
1740 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1741 * Use <Space> only for lhs of a mapping. */
1742 if (special || char2cells(c) > 1 || (from && c == ' '))
1743 return get_special_key_name(c, modifiers);
1744 buf[0] = c;
1745 buf[1] = NUL;
1746 return buf;
1747}
1748
1749/*
1750 * Translate a key sequence into special key names.
1751 */
1752 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001753str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754{
1755 char_u *s;
1756
1757 *buf = NUL;
1758 while (*sp)
1759 {
1760 s = str2special(&sp, FALSE);
1761 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1762 STRCAT(buf, s);
1763 }
1764}
1765
1766/*
1767 * print line for :print or :list command
1768 */
1769 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001770msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771{
1772 int c;
1773 int col = 0;
1774 int n_extra = 0;
1775 int c_extra = 0;
1776 char_u *p_extra = NULL; /* init to make SASC shut up */
1777 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001778 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 char_u *trail = NULL;
1780#ifdef FEAT_MBYTE
1781 int l;
1782 char_u buf[MB_MAXBYTES + 1];
1783#endif
1784
Bram Moolenaardf177f62005-02-22 08:39:57 +00001785 if (curwin->w_p_list)
1786 list = TRUE;
1787
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001789 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 {
1791 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001792 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 --trail;
1794 }
1795
1796 /* output a space for an empty line, otherwise the line will be
1797 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001798 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 msg_putchar(' ');
1800
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001801 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001803 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 {
1805 --n_extra;
1806 if (c_extra)
1807 c = c_extra;
1808 else
1809 c = *p_extra++;
1810 }
1811#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001812 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 {
1814 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001815 if (lcs_nbsp != NUL && list
1816 && (mb_ptr2char(s) == 160
1817 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001818 {
1819 mb_char2bytes(lcs_nbsp, buf);
1820 buf[(*mb_ptr2len)(buf)] = NUL;
1821 }
1822 else
1823 {
1824 mch_memmove(buf, s, (size_t)l);
1825 buf[l] = NUL;
1826 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001827 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 s += l;
1829 continue;
1830 }
1831#endif
1832 else
1833 {
1834 attr = 0;
1835 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001836 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 {
1838 /* tab amount depends on current column */
1839 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001840 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 {
1842 c = ' ';
1843 c_extra = ' ';
1844 }
1845 else
1846 {
1847 c = lcs_tab1;
1848 c_extra = lcs_tab2;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001849 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 }
1851 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001852 else if (c == 160 && list && lcs_nbsp != NUL)
1853 {
1854 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001855 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001856 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001857 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 {
1859 p_extra = (char_u *)"";
1860 c_extra = NUL;
1861 n_extra = 1;
1862 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001863 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 --s;
1865 }
1866 else if (c != NUL && (n = byte2cells(c)) > 1)
1867 {
1868 n_extra = n - 1;
1869 p_extra = transchar_byte(c);
1870 c_extra = NUL;
1871 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001872 /* Use special coloring to be able to distinguish <hex> from
1873 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001874 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 }
1876 else if (c == ' ' && trail != NULL && s > trail)
1877 {
1878 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001879 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001881 else if (c == ' ' && list && lcs_space != NUL)
1882 {
1883 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001884 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001885 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 }
1887
1888 if (c == NUL)
1889 break;
1890
1891 msg_putchar_attr(c, attr);
1892 col++;
1893 }
1894 msg_clr_eos();
1895}
1896
1897#ifdef FEAT_MBYTE
1898/*
1899 * Use screen_puts() to output one multi-byte character.
1900 * Return the pointer "s" advanced to the next character.
1901 */
1902 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001903screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904{
1905 int cw;
1906
1907 msg_didout = TRUE; /* remember that line is not empty */
1908 cw = (*mb_ptr2cells)(s);
1909 if (cw > 1 && (
1910#ifdef FEAT_RIGHTLEFT
1911 cmdmsg_rl ? msg_col <= 1 :
1912#endif
1913 msg_col == Columns - 1))
1914 {
1915 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001916 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 return s;
1918 }
1919
1920 screen_puts_len(s, l, msg_row, msg_col, attr);
1921#ifdef FEAT_RIGHTLEFT
1922 if (cmdmsg_rl)
1923 {
1924 msg_col -= cw;
1925 if (msg_col == 0)
1926 {
1927 msg_col = Columns;
1928 ++msg_row;
1929 }
1930 }
1931 else
1932#endif
1933 {
1934 msg_col += cw;
1935 if (msg_col >= Columns)
1936 {
1937 msg_col = 0;
1938 ++msg_row;
1939 }
1940 }
1941 return s + l;
1942}
1943#endif
1944
1945/*
1946 * Output a string to the screen at position msg_row, msg_col.
1947 * Update msg_row and msg_col for the next message.
1948 */
1949 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001950msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001952 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953}
1954
1955 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001956msg_puts_title(
1957 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001959 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960}
1961
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962/*
1963 * Show a message in such a way that it always fits in the line. Cut out a
1964 * part in the middle and replace it with "..." when necessary.
1965 * Does not handle multi-byte characters!
1966 */
1967 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001968msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001970 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971}
1972
1973 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001974msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975{
1976 int slen = len;
1977 int room;
1978
1979 room = Columns - msg_col;
1980 if (len > room && room >= 20)
1981 {
1982 slen = (room - 3) / 2;
1983 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001984 msg_puts_attr((char_u *)"...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 }
1986 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1987}
1988
1989/*
1990 * Basic function for writing a message with highlight attributes.
1991 */
1992 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001993msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994{
1995 msg_puts_attr_len(s, -1, attr);
1996}
1997
1998/*
1999 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
2000 * When "maxlen" is -1 there is no maximum length.
2001 * When "maxlen" is >= 0 the message is not put in the history.
2002 */
2003 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002004msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 /*
2007 * If redirection is on, also write to the redirection file.
2008 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002009 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010
2011 /*
2012 * Don't print anything when using ":silent cmd".
2013 */
2014 if (msg_silent != 0)
2015 return;
2016
2017 /* if MSG_HIST flag set, add message to history */
2018 if ((attr & MSG_HIST) && maxlen < 0)
2019 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002020 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 attr &= ~MSG_HIST;
2022 }
2023
2024 /*
2025 * When writing something to the screen after it has scrolled, requires a
2026 * wait-return prompt later. Needed when scrolling, resetting
2027 * need_wait_return after some prompt, and then outputting something
2028 * without scrolling
2029 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002030 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 need_wait_return = TRUE;
2032 msg_didany = TRUE; /* remember that something was outputted */
2033
2034 /*
2035 * If there is no valid screen, use fprintf so we can see error messages.
2036 * If termcap is not active, we may be writing in an alternate console
2037 * window, cursor positioning may not work correctly (window size may be
2038 * different, e.g. for Win32 console) or we just don't know where the
2039 * cursor is.
2040 */
2041 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002042 msg_puts_printf(str, maxlen);
2043 else
2044 msg_puts_display(str, maxlen, attr, FALSE);
2045}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002047/*
2048 * The display part of msg_puts_attr_len().
2049 * May be called recursively to display scroll-back text.
2050 */
2051 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002052msg_puts_display(
2053 char_u *str,
2054 int maxlen,
2055 int attr,
2056 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002057{
2058 char_u *s = str;
2059 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2060 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
2061#ifdef FEAT_MBYTE
2062 int l;
2063 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002065 char_u *sb_str = str;
2066 int sb_col = msg_col;
2067 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002068 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069
2070 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002071 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 {
2073 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002074 * We are at the end of the screen line when:
2075 * - When outputting a newline.
2076 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002078 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079#ifdef FEAT_RIGHTLEFT
2080 cmdmsg_rl
2081 ? (
2082 msg_col <= 1
2083 || (*s == TAB && msg_col <= 7)
2084# ifdef FEAT_MBYTE
2085 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
2086# endif
2087 )
2088 :
2089#endif
2090 (msg_col + t_col >= Columns - 1
2091 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
2092# ifdef FEAT_MBYTE
2093 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2094 && msg_col + t_col >= Columns - 2)
2095# endif
2096 ))))
2097 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002098 /*
2099 * The screen is scrolled up when at the last row (some terminals
2100 * scroll automatically, some don't. To avoid problems we scroll
2101 * ourselves).
2102 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002105 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002107 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 if (msg_no_more && lines_left == 0)
2109 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002111 /* Scroll the screen up one line. */
2112 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113
2114 msg_row = Rows - 2;
2115 if (msg_col >= Columns) /* can happen after screen resize */
2116 msg_col = Columns - 1;
2117
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002118 /* Display char in last column before showing more-prompt. */
2119 if (*s >= ' '
2120#ifdef FEAT_RIGHTLEFT
2121 && !cmdmsg_rl
2122#endif
2123 )
2124 {
2125#ifdef FEAT_MBYTE
2126 if (has_mbyte)
2127 {
2128 if (enc_utf8 && maxlen >= 0)
2129 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002130 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002131 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002132 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002133 s = screen_puts_mbyte(s, l, attr);
2134 }
2135 else
2136#endif
2137 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002138 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002139 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002140 else
2141 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002142
2143 if (p_more)
2144 /* store text for scrolling back */
2145 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2146
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002147 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002148 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 redraw_cmdline = TRUE;
2150 if (cmdline_row > 0 && !exmode_active)
2151 --cmdline_row;
2152
2153 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002154 * If screen is completely filled and 'more' is set then wait
2155 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002157 if (lines_left > 0)
2158 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002159 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 && !msg_no_more && !exmode_active)
2161 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002163 if (do_more_prompt(NUL))
2164 s = confirm_msg_tail;
2165#else
2166 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167#endif
2168 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002169 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002171
2172 /* When we displayed a char in last column need to check if there
2173 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002174 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002175 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 }
2177
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002178 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 || msg_col + t_col >= Columns
2180#ifdef FEAT_MBYTE
2181 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2182 && msg_col + t_col >= Columns - 1)
2183#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002184 ;
2185 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2186 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002188 t_puts(&t_col, t_s, s, attr);
2189
2190 if (wrap && p_more && !recurse)
2191 /* store text for scrolling back */
2192 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193
2194 if (*s == '\n') /* go to next line */
2195 {
2196 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002197#ifdef FEAT_RIGHTLEFT
2198 if (cmdmsg_rl)
2199 msg_col = Columns - 1;
2200 else
2201#endif
2202 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 if (++msg_row >= Rows) /* safety check */
2204 msg_row = Rows - 1;
2205 }
2206 else if (*s == '\r') /* go to column 0 */
2207 {
2208 msg_col = 0;
2209 }
2210 else if (*s == '\b') /* go to previous char */
2211 {
2212 if (msg_col)
2213 --msg_col;
2214 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002215 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 {
2217 do
2218 msg_screen_putchar(' ', attr);
2219 while (msg_col & 7);
2220 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002221 else if (*s == BELL) /* beep (from ":sh") */
2222 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 else
2224 {
2225#ifdef FEAT_MBYTE
2226 if (has_mbyte)
2227 {
2228 cw = (*mb_ptr2cells)(s);
2229 if (enc_utf8 && maxlen >= 0)
2230 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002231 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002233 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 }
2235 else
2236 {
2237 cw = 1;
2238 l = 1;
2239 }
2240#endif
2241 /* When drawing from right to left or when a double-wide character
2242 * doesn't fit, draw a single character here. Otherwise collect
2243 * characters and draw them all at once later. */
2244#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2245 if (
2246# ifdef FEAT_RIGHTLEFT
2247 cmdmsg_rl
2248# ifdef FEAT_MBYTE
2249 ||
2250# endif
2251# endif
2252# ifdef FEAT_MBYTE
2253 (cw > 1 && msg_col + t_col >= Columns - 1)
2254# endif
2255 )
2256 {
2257# ifdef FEAT_MBYTE
2258 if (l > 1)
2259 s = screen_puts_mbyte(s, l, attr) - 1;
2260 else
2261# endif
2262 msg_screen_putchar(*s, attr);
2263 }
2264 else
2265#endif
2266 {
2267 /* postpone this character until later */
2268 if (t_col == 0)
2269 t_s = s;
2270#ifdef FEAT_MBYTE
2271 t_col += cw;
2272 s += l - 1;
2273#else
2274 ++t_col;
2275#endif
2276 }
2277 }
2278 ++s;
2279 }
2280
2281 /* output any postponed text */
2282 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002283 t_puts(&t_col, t_s, s, attr);
2284 if (p_more && !recurse)
2285 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286
2287 msg_check();
2288}
2289
2290/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002291 * Return TRUE when ":filter pattern" was used and "msg" does not match
2292 * "pattern".
2293 */
2294 int
2295message_filtered(char_u *msg)
2296{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002297 int match;
2298
2299 if (cmdmod.filter_regmatch.regprog == NULL)
2300 return FALSE;
2301 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2302 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002303}
2304
2305/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002306 * Scroll the screen up one line for displaying the next message line.
2307 */
2308 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002309msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002310{
2311#ifdef FEAT_GUI
2312 /* Remove the cursor before scrolling, ScreenLines[] is going
2313 * to become invalid. */
2314 if (gui.in_use)
2315 gui_undraw_cursor();
2316#endif
2317 /* scrolling up always works */
2318 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2319
2320 if (!can_clear((char_u *)" "))
2321 {
2322 /* Scrolling up doesn't result in the right background. Set the
2323 * background here. It's not efficient, but avoids that we have to do
2324 * it all over the code. */
2325 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2326
2327 /* Also clear the last char of the last but one line if it was not
2328 * cleared before to avoid a scroll-up. */
2329 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2330 screen_fill((int)Rows - 2, (int)Rows - 1,
2331 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2332 }
2333}
2334
2335/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002336 * Increment "msg_scrolled".
2337 */
2338 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002339inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002340{
2341#ifdef FEAT_EVAL
2342 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2343 {
2344 char_u *p = sourcing_name;
2345 char_u *tofree = NULL;
2346 int len;
2347
2348 /* v:scrollstart is empty, set it to the script/function name and line
2349 * number */
2350 if (p == NULL)
2351 p = (char_u *)_("Unknown");
2352 else
2353 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002354 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002355 tofree = alloc(len);
2356 if (tofree != NULL)
2357 {
2358 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2359 p, (long)sourcing_lnum);
2360 p = tofree;
2361 }
2362 }
2363 set_vim_var_string(VV_SCROLLSTART, p, -1);
2364 vim_free(tofree);
2365 }
2366#endif
2367 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002368 if (must_redraw < VALID)
2369 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002370}
2371
2372/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002373 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2374 * store the displayed text and remember where screen lines start.
2375 */
2376typedef struct msgchunk_S msgchunk_T;
2377struct msgchunk_S
2378{
2379 msgchunk_T *sb_next;
2380 msgchunk_T *sb_prev;
2381 char sb_eol; /* TRUE when line ends after this text */
2382 int sb_msg_col; /* column in which text starts */
2383 int sb_attr; /* text attributes */
2384 char_u sb_text[1]; /* text to be displayed, actually longer */
2385};
2386
2387static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2388
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002389static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2390static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002391
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002392typedef enum {
2393 SB_CLEAR_NONE = 0,
2394 SB_CLEAR_ALL,
2395 SB_CLEAR_CMDLINE_BUSY,
2396 SB_CLEAR_CMDLINE_DONE
2397} sb_clear_T;
2398
2399/* When to clear text on next msg. */
2400static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002401
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002402/*
2403 * Store part of a printed message for displaying when scrolling back.
2404 */
2405 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002406store_sb_text(
2407 char_u **sb_str, /* start of string */
2408 char_u *s, /* just after string */
2409 int attr,
2410 int *sb_col,
2411 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002412{
2413 msgchunk_T *mp;
2414
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002415 if (do_clear_sb_text == SB_CLEAR_ALL
2416 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002417 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002418 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2419 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002420 }
2421
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002422 if (s > *sb_str)
2423 {
2424 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2425 if (mp != NULL)
2426 {
2427 mp->sb_eol = finish;
2428 mp->sb_msg_col = *sb_col;
2429 mp->sb_attr = attr;
2430 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2431
2432 if (last_msgchunk == NULL)
2433 {
2434 last_msgchunk = mp;
2435 mp->sb_prev = NULL;
2436 }
2437 else
2438 {
2439 mp->sb_prev = last_msgchunk;
2440 last_msgchunk->sb_next = mp;
2441 last_msgchunk = mp;
2442 }
2443 mp->sb_next = NULL;
2444 }
2445 }
2446 else if (finish && last_msgchunk != NULL)
2447 last_msgchunk->sb_eol = TRUE;
2448
2449 *sb_str = s;
2450 *sb_col = 0;
2451}
2452
2453/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002454 * Finished showing messages, clear the scroll-back text on the next message.
2455 */
2456 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002457may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002459 do_clear_sb_text = SB_CLEAR_ALL;
2460}
2461
2462/*
2463 * Starting to edit the command line, do not clear messages now.
2464 */
2465 void
2466sb_text_start_cmdline(void)
2467{
2468 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2469 msg_sb_eol();
2470}
2471
2472/*
2473 * Ending to edit the command line. Clear old lines but the last one later.
2474 */
2475 void
2476sb_text_end_cmdline(void)
2477{
2478 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002479}
2480
2481/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002482 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002483 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002484 * Called when redrawing the screen.
2485 */
2486 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002487clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002488{
2489 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002490 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002491
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002492 if (all)
2493 lastp = &last_msgchunk;
2494 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002495 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002496 if (last_msgchunk == NULL)
2497 return;
2498 lastp = &last_msgchunk->sb_prev;
2499 }
2500
2501 while (*lastp != NULL)
2502 {
2503 mp = (*lastp)->sb_prev;
2504 vim_free(*lastp);
2505 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002506 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002507}
2508
2509/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002510 * "g<" command.
2511 */
2512 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002513show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002514{
2515 msgchunk_T *mp;
2516
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002517 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002518 * weird, typing a command without output results in one line. */
2519 mp = msg_sb_start(last_msgchunk);
2520 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002521 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002522 else
2523 {
2524 do_more_prompt('G');
2525 wait_return(FALSE);
2526 }
2527}
2528
2529/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002530 * Move to the start of screen line in already displayed text.
2531 */
2532 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002533msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002534{
2535 msgchunk_T *mp = mps;
2536
2537 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2538 mp = mp->sb_prev;
2539 return mp;
2540}
2541
2542/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002543 * Mark the last message chunk as finishing the line.
2544 */
2545 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002546msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002547{
2548 if (last_msgchunk != NULL)
2549 last_msgchunk->sb_eol = TRUE;
2550}
2551
2552/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002553 * Display a screen line from previously displayed text at row "row".
2554 * Returns a pointer to the text for the next line (can be NULL).
2555 */
2556 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002557disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002558{
2559 msgchunk_T *mp = smp;
2560 char_u *p;
2561
2562 for (;;)
2563 {
2564 msg_row = row;
2565 msg_col = mp->sb_msg_col;
2566 p = mp->sb_text;
2567 if (*p == '\n') /* don't display the line break */
2568 ++p;
2569 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2570 if (mp->sb_eol || mp->sb_next == NULL)
2571 break;
2572 mp = mp->sb_next;
2573 }
2574 return mp->sb_next;
2575}
2576
2577/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 * Output any postponed text for msg_puts_attr_len().
2579 */
2580 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002581t_puts(
2582 int *t_col,
2583 char_u *t_s,
2584 char_u *s,
2585 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586{
2587 /* output postponed text */
2588 msg_didout = TRUE; /* remember that line is not empty */
2589 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002590 msg_col += *t_col;
2591 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592#ifdef FEAT_MBYTE
2593 /* If the string starts with a composing character don't increment the
2594 * column position for it. */
2595 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2596 --msg_col;
2597#endif
2598 if (msg_col >= Columns)
2599 {
2600 msg_col = 0;
2601 ++msg_row;
2602 }
2603}
2604
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605/*
2606 * Returns TRUE when messages should be printed with mch_errmsg().
2607 * This is used when there is no valid screen, so we can see error messages.
2608 * If termcap is not active, we may be writing in an alternate console
2609 * window, cursor positioning may not work correctly (window size may be
2610 * different, e.g. for Win32 console) or we just don't know where the
2611 * cursor is.
2612 */
2613 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002614msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615{
2616 return (!msg_check_screen()
2617#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2618 || !termcap_active
2619#endif
2620 || (swapping_screen() && !termcap_active)
2621 );
2622}
2623
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002624/*
2625 * Print a message when there is no valid screen.
2626 */
2627 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002628msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002629{
2630 char_u *s = str;
2631 char_u buf[4];
2632 char_u *p;
2633
2634#ifdef WIN3264
2635 if (!(silent_mode && p_verbose == 0))
2636 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2637#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002638 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639 {
2640 if (!(silent_mode && p_verbose == 0))
2641 {
2642 /* NL --> CR NL translation (for Unix, not for "--version") */
2643 /* NL --> CR translation (for Mac) */
2644 p = &buf[0];
2645 if (*s == '\n' && !info_message)
2646 *p++ = '\r';
2647#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2648 else
2649#endif
2650 *p++ = *s;
2651 *p = '\0';
2652 if (info_message) /* informative message, not an error */
2653 mch_msg((char *)buf);
2654 else
2655 mch_errmsg((char *)buf);
2656 }
2657
2658 /* primitive way to compute the current column */
2659#ifdef FEAT_RIGHTLEFT
2660 if (cmdmsg_rl)
2661 {
2662 if (*s == '\r' || *s == '\n')
2663 msg_col = Columns - 1;
2664 else
2665 --msg_col;
2666 }
2667 else
2668#endif
2669 {
2670 if (*s == '\r' || *s == '\n')
2671 msg_col = 0;
2672 else
2673 ++msg_col;
2674 }
2675 ++s;
2676 }
2677 msg_didout = TRUE; /* assume that line is not empty */
2678
2679#ifdef WIN3264
2680 if (!(silent_mode && p_verbose == 0))
2681 mch_settmode(TMODE_RAW);
2682#endif
2683}
2684
2685/*
2686 * Show the more-prompt and handle the user response.
2687 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002688 * When at hit-enter prompt "typed_char" is the already typed character,
2689 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002690 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2691 */
2692 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002693do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002694{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002695 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002696 int used_typed_char = typed_char;
2697 int oldState = State;
2698 int c;
2699#ifdef FEAT_CON_DIALOG
2700 int retval = FALSE;
2701#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002702 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002703 msgchunk_T *mp_last = NULL;
2704 msgchunk_T *mp;
2705 int i;
2706
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002707 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002708 * that case don't show another prompt. Also when at the hit-Enter prompt
2709 * and nothing was typed. */
2710 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002711 return FALSE;
2712 entered = TRUE;
2713
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002714 if (typed_char == 'G')
2715 {
2716 /* "g<": Find first line on the last page. */
2717 mp_last = msg_sb_start(last_msgchunk);
2718 for (i = 0; i < Rows - 2 && mp_last != NULL
2719 && mp_last->sb_prev != NULL; ++i)
2720 mp_last = msg_sb_start(mp_last->sb_prev);
2721 }
2722
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002723 State = ASKMORE;
2724#ifdef FEAT_MOUSE
2725 setmouse();
2726#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002727 if (typed_char == NUL)
2728 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002729 for (;;)
2730 {
2731 /*
2732 * Get a typed character directly from the user.
2733 */
2734 if (used_typed_char != NUL)
2735 {
2736 c = used_typed_char; /* was typed at hit-enter prompt */
2737 used_typed_char = NUL;
2738 }
2739 else
2740 c = get_keystroke();
2741
2742#if defined(FEAT_MENU) && defined(FEAT_GUI)
2743 if (c == K_MENU)
2744 {
2745 int idx = get_menu_index(current_menu, ASKMORE);
2746
2747 /* Used a menu. If it starts with CTRL-Y, it must
2748 * be a "Copy" for the clipboard. Otherwise
2749 * assume that we end */
2750 if (idx == MENU_INDEX_INVALID)
2751 continue;
2752 c = *current_menu->strings[idx];
2753 if (c != NUL && current_menu->strings[idx][1] != NUL)
2754 ins_typebuf(current_menu->strings[idx] + 1,
2755 current_menu->noremap[idx], 0, TRUE,
2756 current_menu->silent[idx]);
2757 }
2758#endif
2759
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002760 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002761 switch (c)
2762 {
2763 case BS: /* scroll one line back */
2764 case K_BS:
2765 case 'k':
2766 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002767 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002768 break;
2769
2770 case CAR: /* one extra line */
2771 case NL:
2772 case 'j':
2773 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002774 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002775 break;
2776
2777 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002778 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002779 break;
2780
2781 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002782 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002783 break;
2784
2785 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002786 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002787 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002788 break;
2789
2790 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002791 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002792 case K_PAGEDOWN:
2793 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002794 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002795 break;
2796
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002797 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002798 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002799 break;
2800
2801 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002802 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002803 lines_left = 999999;
2804 break;
2805
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002806 case ':': /* start new command line */
2807#ifdef FEAT_CON_DIALOG
2808 if (!confirm_msg_used)
2809#endif
2810 {
2811 /* Since got_int is set all typeahead will be flushed, but we
2812 * want to keep this ':', remember that in a special way. */
2813 typeahead_noflush(':');
2814 cmdline_row = Rows - 1; /* put ':' on this line */
2815 skip_redraw = TRUE; /* skip redraw once */
2816 need_wait_return = FALSE; /* don't wait in main() */
2817 }
2818 /*FALLTHROUGH*/
2819 case 'q': /* quit */
2820 case Ctrl_C:
2821 case ESC:
2822#ifdef FEAT_CON_DIALOG
2823 if (confirm_msg_used)
2824 {
2825 /* Jump to the choices of the dialog. */
2826 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002827 }
2828 else
2829#endif
2830 {
2831 got_int = TRUE;
2832 quit_more = TRUE;
2833 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002834 /* When there is some more output (wrapping line) display that
2835 * without another prompt. */
2836 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002837 break;
2838
2839#ifdef FEAT_CLIPBOARD
2840 case Ctrl_Y:
2841 /* Strange way to allow copying (yanking) a modeless
2842 * selection at the more prompt. Use CTRL-Y,
2843 * because the same is used in Cmdline-mode and at the
2844 * hit-enter prompt. However, scrolling one line up
2845 * might be expected... */
2846 if (clip_star.state == SELECT_DONE)
2847 clip_copy_modeless_selection(TRUE);
2848 continue;
2849#endif
2850 default: /* no valid response */
2851 msg_moremsg(TRUE);
2852 continue;
2853 }
2854
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002855 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002856 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002857 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002858 {
2859 /* go to start of last line */
2860 if (mp_last == NULL)
2861 mp = msg_sb_start(last_msgchunk);
2862 else if (mp_last->sb_prev != NULL)
2863 mp = msg_sb_start(mp_last->sb_prev);
2864 else
2865 mp = NULL;
2866
2867 /* go to start of line at top of the screen */
2868 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2869 ++i)
2870 mp = msg_sb_start(mp->sb_prev);
2871
2872 if (mp != NULL && mp->sb_prev != NULL)
2873 {
2874 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002875 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002876 {
2877 if (mp == NULL || mp->sb_prev == NULL)
2878 break;
2879 mp = msg_sb_start(mp->sb_prev);
2880 if (mp_last == NULL)
2881 mp_last = msg_sb_start(last_msgchunk);
2882 else
2883 mp_last = msg_sb_start(mp_last->sb_prev);
2884 }
2885
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002886 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002887 (int)Rows, NULL) == OK)
2888 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002889 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002890 (void)disp_sb_line(0, mp);
2891 }
2892 else
2893 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002894 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002895 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002896 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2897 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002898 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002899 ++msg_scrolled;
2900 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002901 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002902 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002903 }
2904 }
2905 else
2906 {
2907 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002908 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002909 {
2910 /* scroll up, display line at bottom */
2911 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002912 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002913 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2914 (int)Columns, ' ', ' ', 0);
2915 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002916 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002917 }
2918 }
2919
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002920 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002921 {
2922 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002923 screen_fill((int)Rows - 1, (int)Rows, 0,
2924 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002925 msg_moremsg(FALSE);
2926 continue;
2927 }
2928
2929 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002930 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002931 }
2932
2933 break;
2934 }
2935
2936 /* clear the --more-- message */
2937 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2938 State = oldState;
2939#ifdef FEAT_MOUSE
2940 setmouse();
2941#endif
2942 if (quit_more)
2943 {
2944 msg_row = Rows - 1;
2945 msg_col = 0;
2946 }
2947#ifdef FEAT_RIGHTLEFT
2948 else if (cmdmsg_rl)
2949 msg_col = Columns - 1;
2950#endif
2951
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002952 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002953#ifdef FEAT_CON_DIALOG
2954 return retval;
2955#else
2956 return FALSE;
2957#endif
2958}
2959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2961
2962#ifdef mch_errmsg
2963# undef mch_errmsg
2964#endif
2965#ifdef mch_msg
2966# undef mch_msg
2967#endif
2968
2969/*
2970 * Give an error message. To be used when the screen hasn't been initialized
2971 * yet. When stderr can't be used, collect error messages until the GUI has
2972 * started and they can be displayed in a message box.
2973 */
2974 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002975mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
2977 int len;
2978
2979#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2980 /* On Unix use stderr if it's a tty.
2981 * When not going to start the GUI also use stderr.
2982 * On Mac, when started from Finder, stderr is the console. */
2983 if (
2984# ifdef UNIX
2985# ifdef MACOS_X_UNIX
2986 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2987# else
2988 isatty(2)
2989# endif
2990# ifdef FEAT_GUI
2991 ||
2992# endif
2993# endif
2994# ifdef FEAT_GUI
2995 !(gui.in_use || gui.starting)
2996# endif
2997 )
2998 {
2999 fprintf(stderr, "%s", str);
3000 return;
3001 }
3002#endif
3003
3004 /* avoid a delay for a message that isn't there */
3005 emsg_on_display = FALSE;
3006
3007 len = (int)STRLEN(str) + 1;
3008 if (error_ga.ga_growsize == 0)
3009 {
3010 error_ga.ga_growsize = 80;
3011 error_ga.ga_itemsize = 1;
3012 }
3013 if (ga_grow(&error_ga, len) == OK)
3014 {
3015 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3016 (char_u *)str, len);
3017#ifdef UNIX
3018 /* remove CR characters, they are displayed */
3019 {
3020 char_u *p;
3021
3022 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3023 for (;;)
3024 {
3025 p = vim_strchr(p, '\r');
3026 if (p == NULL)
3027 break;
3028 *p = ' ';
3029 }
3030 }
3031#endif
3032 --len; /* don't count the NUL at the end */
3033 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 }
3035}
3036
3037/*
3038 * Give a message. To be used when the screen hasn't been initialized yet.
3039 * When there is no tty, collect messages until the GUI has started and they
3040 * can be displayed in a message box.
3041 */
3042 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003043mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044{
3045#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3046 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3047 * uses mch_errmsg() when started from the desktop.
3048 * When not going to start the GUI also use stdout.
3049 * On Mac, when started from Finder, stderr is the console. */
3050 if (
3051# ifdef UNIX
3052# ifdef MACOS_X_UNIX
3053 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3054# else
3055 isatty(2)
3056# endif
3057# ifdef FEAT_GUI
3058 ||
3059# endif
3060# endif
3061# ifdef FEAT_GUI
3062 !(gui.in_use || gui.starting)
3063# endif
3064 )
3065 {
3066 printf("%s", str);
3067 return;
3068 }
3069# endif
3070 mch_errmsg(str);
3071}
3072#endif /* USE_MCH_ERRMSG */
3073
3074/*
3075 * Put a character on the screen at the current message position and advance
3076 * to the next position. Only for printable ASCII!
3077 */
3078 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003079msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080{
3081 msg_didout = TRUE; /* remember that line is not empty */
3082 screen_putchar(c, msg_row, msg_col, attr);
3083#ifdef FEAT_RIGHTLEFT
3084 if (cmdmsg_rl)
3085 {
3086 if (--msg_col == 0)
3087 {
3088 msg_col = Columns;
3089 ++msg_row;
3090 }
3091 }
3092 else
3093#endif
3094 {
3095 if (++msg_col >= Columns)
3096 {
3097 msg_col = 0;
3098 ++msg_row;
3099 }
3100 }
3101}
3102
3103 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003104msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003106 int attr;
3107 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108
Bram Moolenaar8820b482017-03-16 17:23:31 +01003109 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003110 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003112 screen_puts((char_u *)
3113 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3114 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115}
3116
3117/*
3118 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3119 * exmode_active.
3120 */
3121 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003122repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123{
3124 if (State == ASKMORE)
3125 {
3126 msg_moremsg(TRUE); /* display --more-- message again */
3127 msg_row = Rows - 1;
3128 }
3129#ifdef FEAT_CON_DIALOG
3130 else if (State == CONFIRM)
3131 {
3132 display_confirm_msg(); /* display ":confirm" message again */
3133 msg_row = Rows - 1;
3134 }
3135#endif
3136 else if (State == EXTERNCMD)
3137 {
3138 windgoto(msg_row, msg_col); /* put cursor back */
3139 }
3140 else if (State == HITRETURN || State == SETWSIZE)
3141 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003142 if (msg_row == Rows - 1)
3143 {
3144 /* Avoid drawing the "hit-enter" prompt below the previous one,
3145 * overwrite it. Esp. useful when regaining focus and a
3146 * FocusGained autocmd exists but didn't draw anything. */
3147 msg_didout = FALSE;
3148 msg_col = 0;
3149 msg_clr_eos();
3150 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 hit_return_msg();
3152 msg_row = Rows - 1;
3153 }
3154}
3155
3156/*
3157 * msg_check_screen - check if the screen is initialized.
3158 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3159 * While starting the GUI the terminal codes will be set for the GUI, but the
3160 * output goes to the terminal. Don't use the terminal codes then.
3161 */
3162 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003163msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164{
3165 if (!full_screen || !screen_valid(FALSE))
3166 return FALSE;
3167
3168 if (msg_row >= Rows)
3169 msg_row = Rows - 1;
3170 if (msg_col >= Columns)
3171 msg_col = Columns - 1;
3172 return TRUE;
3173}
3174
3175/*
3176 * Clear from current message position to end of screen.
3177 * Skip this when ":silent" was used, no need to clear for redirection.
3178 */
3179 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003180msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181{
3182 if (msg_silent == 0)
3183 msg_clr_eos_force();
3184}
3185
3186/*
3187 * Clear from current message position to end of screen.
3188 * Note: msg_col is not updated, so we remember the end of the message
3189 * for msg_check().
3190 */
3191 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003192msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193{
3194 if (msg_use_printf())
3195 {
3196 if (full_screen) /* only when termcap codes are valid */
3197 {
3198 if (*T_CD)
3199 out_str(T_CD); /* clear to end of display */
3200 else if (*T_CE)
3201 out_str(T_CE); /* clear to end of line */
3202 }
3203 }
3204 else
3205 {
3206#ifdef FEAT_RIGHTLEFT
3207 if (cmdmsg_rl)
3208 {
3209 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3210 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3211 }
3212 else
3213#endif
3214 {
3215 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3216 ' ', ' ', 0);
3217 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3218 }
3219 }
3220}
3221
3222/*
3223 * Clear the command line.
3224 */
3225 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003226msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227{
3228 msg_row = cmdline_row;
3229 msg_col = 0;
3230 msg_clr_eos_force();
3231}
3232
3233/*
3234 * end putting a message on the screen
3235 * call wait_return if the message does not fit in the available space
3236 * return TRUE if wait_return not called.
3237 */
3238 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003239msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240{
3241 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003242 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 * or the ruler option is set and we run into it,
3244 * we have to redraw the window.
3245 * Do not do this if we are abandoning the file or editing the command line.
3246 */
3247 if (!exiting && need_wait_return && !(State & CMDLINE))
3248 {
3249 wait_return(FALSE);
3250 return FALSE;
3251 }
3252 out_flush();
3253 return TRUE;
3254}
3255
3256/*
3257 * If the written message runs into the shown command or ruler, we have to
3258 * wait for hit-return and redraw the window later.
3259 */
3260 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003261msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262{
3263 if (msg_row == Rows - 1 && msg_col >= sc_col)
3264 {
3265 need_wait_return = TRUE;
3266 redraw_cmdline = TRUE;
3267 }
3268}
3269
3270/*
3271 * May write a string to the redirection file.
3272 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3273 */
3274 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003275redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276{
3277 char_u *s = str;
3278 static int cur_col = 0;
3279
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003280 /* Don't do anything for displaying prompts and the like. */
3281 if (redir_off)
3282 return;
3283
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003284 /* If 'verbosefile' is set prepare for writing in that file. */
3285 if (*p_vfile != NUL && verbose_fd == NULL)
3286 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003287
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003288 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 {
3290 /* If the string doesn't start with CR or NL, go to msg_col */
3291 if (*s != '\n' && *s != '\r')
3292 {
3293 while (cur_col < msg_col)
3294 {
3295#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003296 if (redir_execute)
3297 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003298 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003300 else if (redir_vname)
3301 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003302 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003304 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003306 if (verbose_fd != NULL)
3307 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 ++cur_col;
3309 }
3310 }
3311
3312#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003313 if (redir_execute)
3314 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003315 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003317 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003318 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319#endif
3320
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003321 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3323 {
3324#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003325 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003327 if (redir_fd != NULL)
3328 putc(*s, redir_fd);
3329 if (verbose_fd != NULL)
3330 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 if (*s == '\r' || *s == '\n')
3332 cur_col = 0;
3333 else if (*s == '\t')
3334 cur_col += (8 - cur_col % 8);
3335 else
3336 ++cur_col;
3337 ++s;
3338 }
3339
3340 if (msg_silent != 0) /* should update msg_col */
3341 msg_col = cur_col;
3342 }
3343}
3344
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003345 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003346redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003347{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003348 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003349#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003350 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003351#endif
3352 ;
3353}
3354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003356 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003357 * Must always be called paired with verbose_leave()!
3358 */
3359 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003360verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003361{
3362 if (*p_vfile != NUL)
3363 ++msg_silent;
3364}
3365
3366/*
3367 * After giving verbose message.
3368 * Must always be called paired with verbose_enter()!
3369 */
3370 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003371verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003372{
3373 if (*p_vfile != NUL)
3374 if (--msg_silent < 0)
3375 msg_silent = 0;
3376}
3377
3378/*
3379 * Like verbose_enter() and set msg_scroll when displaying the message.
3380 */
3381 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003382verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003383{
3384 if (*p_vfile != NUL)
3385 ++msg_silent;
3386 else
3387 /* always scroll up, don't overwrite */
3388 msg_scroll = TRUE;
3389}
3390
3391/*
3392 * Like verbose_leave() and set cmdline_row when displaying the message.
3393 */
3394 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003395verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003396{
3397 if (*p_vfile != NUL)
3398 {
3399 if (--msg_silent < 0)
3400 msg_silent = 0;
3401 }
3402 else
3403 cmdline_row = msg_row;
3404}
3405
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003406/*
3407 * Called when 'verbosefile' is set: stop writing to the file.
3408 */
3409 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003410verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003411{
3412 if (verbose_fd != NULL)
3413 {
3414 fclose(verbose_fd);
3415 verbose_fd = NULL;
3416 }
3417 verbose_did_open = FALSE;
3418}
3419
3420/*
3421 * Open the file 'verbosefile'.
3422 * Return FAIL or OK.
3423 */
3424 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003425verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003426{
3427 if (verbose_fd == NULL && !verbose_did_open)
3428 {
3429 /* Only give the error message once. */
3430 verbose_did_open = TRUE;
3431
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003432 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003433 if (verbose_fd == NULL)
3434 {
3435 EMSG2(_(e_notopen), p_vfile);
3436 return FAIL;
3437 }
3438 }
3439 return OK;
3440}
3441
3442/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 * Give a warning message (for searching).
3444 * Use 'w' highlighting and may repeat the message after redrawing
3445 */
3446 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003447give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448{
3449 /* Don't do this for ":silent". */
3450 if (msg_silent != 0)
3451 return;
3452
3453 /* Don't want a hit-enter prompt here. */
3454 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456#ifdef FEAT_EVAL
3457 set_vim_var_string(VV_WARNINGMSG, message, -1);
3458#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 vim_free(keep_msg);
3460 keep_msg = NULL;
3461 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003462 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 else
3464 keep_msg_attr = 0;
3465 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003466 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 msg_didout = FALSE; /* overwrite this message */
3468 msg_nowait = TRUE; /* don't wait for this message */
3469 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003470
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 --no_wait_return;
3472}
3473
3474/*
3475 * Advance msg cursor to column "col".
3476 */
3477 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003478msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479{
3480 if (msg_silent != 0) /* nothing to advance to */
3481 {
3482 msg_col = col; /* for redirection, may fill it up later */
3483 return;
3484 }
3485 if (col >= Columns) /* not enough room */
3486 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003487#ifdef FEAT_RIGHTLEFT
3488 if (cmdmsg_rl)
3489 while (msg_col > Columns - col)
3490 msg_putchar(' ');
3491 else
3492#endif
3493 while (msg_col < col)
3494 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495}
3496
3497#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3498/*
3499 * Used for "confirm()" function, and the :confirm command prefix.
3500 * Versions which haven't got flexible dialogs yet, and console
3501 * versions, get this generic handler which uses the command line.
3502 *
3503 * type = one of:
3504 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3505 * title = title string (can be NULL for default)
3506 * (neither used in console dialogs at the moment)
3507 *
3508 * Format of the "buttons" string:
3509 * "Button1Name\nButton2Name\nButton3Name"
3510 * The first button should normally be the default/accept
3511 * The second button should be the 'Cancel' button
3512 * Other buttons- use your imagination!
3513 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3514 * different letter.
3515 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003517do_dialog(
3518 int type UNUSED,
3519 char_u *title UNUSED,
3520 char_u *message,
3521 char_u *buttons,
3522 int dfltbutton,
3523 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003524 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003525 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003526 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527{
3528 int oldState;
3529 int retval = 0;
3530 char_u *hotkeys;
3531 int c;
3532 int i;
3533
3534#ifndef NO_CONSOLE
3535 /* Don't output anything in silent mode ("ex -s") */
3536 if (silent_mode)
3537 return dfltbutton; /* return default option */
3538#endif
3539
3540#ifdef FEAT_GUI_DIALOG
3541 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3542 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3543 {
3544 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003545 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003546 /* avoid a hit-enter prompt without clearing the cmdline */
3547 need_wait_return = FALSE;
3548 emsg_on_display = FALSE;
3549 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550
3551 /* Flush output to avoid that further messages and redrawing is done
3552 * in the wrong order. */
3553 out_flush();
3554 gui_mch_update();
3555
3556 return c;
3557 }
3558#endif
3559
3560 oldState = State;
3561 State = CONFIRM;
3562#ifdef FEAT_MOUSE
3563 setmouse();
3564#endif
3565
3566 /*
3567 * Since we wait for a keypress, don't make the
3568 * user press RETURN as well afterwards.
3569 */
3570 ++no_wait_return;
3571 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3572
3573 if (hotkeys != NULL)
3574 {
3575 for (;;)
3576 {
3577 /* Get a typed character directly from the user. */
3578 c = get_keystroke();
3579 switch (c)
3580 {
3581 case CAR: /* User accepts default option */
3582 case NL:
3583 retval = dfltbutton;
3584 break;
3585 case Ctrl_C: /* User aborts/cancels */
3586 case ESC:
3587 retval = 0;
3588 break;
3589 default: /* Could be a hotkey? */
3590 if (c < 0) /* special keys are ignored here */
3591 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003592 if (c == ':' && ex_cmd)
3593 {
3594 retval = dfltbutton;
3595 ins_char_typebuf(':');
3596 break;
3597 }
3598
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 /* Make the character lowercase, as chars in "hotkeys" are. */
3600 c = MB_TOLOWER(c);
3601 retval = 1;
3602 for (i = 0; hotkeys[i]; ++i)
3603 {
3604#ifdef FEAT_MBYTE
3605 if (has_mbyte)
3606 {
3607 if ((*mb_ptr2char)(hotkeys + i) == c)
3608 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003609 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 }
3611 else
3612#endif
3613 if (hotkeys[i] == c)
3614 break;
3615 ++retval;
3616 }
3617 if (hotkeys[i])
3618 break;
3619 /* No hotkey match, so keep waiting */
3620 continue;
3621 }
3622 break;
3623 }
3624
3625 vim_free(hotkeys);
3626 }
3627
3628 State = oldState;
3629#ifdef FEAT_MOUSE
3630 setmouse();
3631#endif
3632 --no_wait_return;
3633 msg_end_prompt();
3634
3635 return retval;
3636}
3637
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003638static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639
3640/*
3641 * Copy one character from "*from" to "*to", taking care of multi-byte
3642 * characters. Return the length of the character in bytes.
3643 */
3644 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003645copy_char(
3646 char_u *from,
3647 char_u *to,
3648 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649{
3650#ifdef FEAT_MBYTE
3651 int len;
3652 int c;
3653
3654 if (has_mbyte)
3655 {
3656 if (lowercase)
3657 {
3658 c = MB_TOLOWER((*mb_ptr2char)(from));
3659 return (*mb_char2bytes)(c, to);
3660 }
3661 else
3662 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003663 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 mch_memmove(to, from, (size_t)len);
3665 return len;
3666 }
3667 }
3668 else
3669#endif
3670 {
3671 if (lowercase)
3672 *to = (char_u)TOLOWER_LOC(*from);
3673 else
3674 *to = *from;
3675 return 1;
3676 }
3677}
3678
3679/*
3680 * Format the dialog string, and display it at the bottom of
3681 * the screen. Return a string of hotkey chars (if defined) for
3682 * each 'button'. If a button has no hotkey defined, the first character of
3683 * the button is used.
3684 * The hotkeys can be multi-byte characters, but without combining chars.
3685 *
3686 * Returns an allocated string with hotkeys, or NULL for error.
3687 */
3688 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003689msg_show_console_dialog(
3690 char_u *message,
3691 char_u *buttons,
3692 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693{
3694 int len = 0;
3695#ifdef FEAT_MBYTE
3696# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3697#else
3698# define HOTK_LEN 1
3699#endif
3700 int lenhotkey = HOTK_LEN; /* count first button */
3701 char_u *hotk = NULL;
3702 char_u *msgp = NULL;
3703 char_u *hotkp = NULL;
3704 char_u *r;
3705 int copy;
3706#define HAS_HOTKEY_LEN 30
3707 char_u has_hotkey[HAS_HOTKEY_LEN];
3708 int first_hotkey = FALSE; /* first char of button is hotkey */
3709 int idx;
3710
3711 has_hotkey[0] = FALSE;
3712
3713 /*
3714 * First loop: compute the size of memory to allocate.
3715 * Second loop: copy to the allocated memory.
3716 */
3717 for (copy = 0; copy <= 1; ++copy)
3718 {
3719 r = buttons;
3720 idx = 0;
3721 while (*r)
3722 {
3723 if (*r == DLG_BUTTON_SEP)
3724 {
3725 if (copy)
3726 {
3727 *msgp++ = ',';
3728 *msgp++ = ' '; /* '\n' -> ', ' */
3729
3730 /* advance to next hotkey and set default hotkey */
3731#ifdef FEAT_MBYTE
3732 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003733 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 else
3735#endif
3736 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003737 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 if (dfltbutton)
3739 --dfltbutton;
3740
3741 /* If no hotkey is specified first char is used. */
3742 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3743 first_hotkey = TRUE;
3744 }
3745 else
3746 {
3747 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3748 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3749 if (idx < HAS_HOTKEY_LEN - 1)
3750 has_hotkey[++idx] = FALSE;
3751 }
3752 }
3753 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3754 {
3755 if (*r == DLG_HOTKEY_CHAR)
3756 ++r;
3757 first_hotkey = FALSE;
3758 if (copy)
3759 {
3760 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3761 *msgp++ = *r;
3762 else
3763 {
3764 /* '&a' -> '[a]' */
3765 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3766 msgp += copy_char(r, msgp, FALSE);
3767 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3768
3769 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003770 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 }
3772 }
3773 else
3774 {
3775 ++len; /* '&a' -> '[a]' */
3776 if (idx < HAS_HOTKEY_LEN - 1)
3777 has_hotkey[idx] = TRUE;
3778 }
3779 }
3780 else
3781 {
3782 /* everything else copy literally */
3783 if (copy)
3784 msgp += copy_char(r, msgp, FALSE);
3785 }
3786
3787 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003788 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 }
3790
3791 if (copy)
3792 {
3793 *msgp++ = ':';
3794 *msgp++ = ' ';
3795 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 }
3797 else
3798 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003799 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003800 + 2 /* for the NL's */
3801 + STRLEN(buttons)
3802 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003803 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804
3805 /* If no hotkey is specified first char is used. */
3806 if (!has_hotkey[0])
3807 {
3808 first_hotkey = TRUE;
3809 len += 2; /* "x" -> "[x]" */
3810 }
3811
3812 /*
3813 * Now allocate and load the strings
3814 */
3815 vim_free(confirm_msg);
3816 confirm_msg = alloc(len);
3817 if (confirm_msg == NULL)
3818 return NULL;
3819 *confirm_msg = NUL;
3820 hotk = alloc(lenhotkey);
3821 if (hotk == NULL)
3822 return NULL;
3823
3824 *confirm_msg = '\n';
3825 STRCPY(confirm_msg + 1, message);
3826
3827 msgp = confirm_msg + 1 + STRLEN(message);
3828 hotkp = hotk;
3829
Bram Moolenaar6a516062007-07-05 08:11:42 +00003830 /* Define first default hotkey. Keep the hotkey string NUL
3831 * terminated to avoid reading past the end. */
3832 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833
3834 /* Remember where the choices start, displaying starts here when
3835 * "hotkp" typed at the more prompt. */
3836 confirm_msg_tail = msgp;
3837 *msgp++ = '\n';
3838 }
3839 }
3840
3841 display_confirm_msg();
3842 return hotk;
3843}
3844
3845/*
3846 * Display the ":confirm" message. Also called when screen resized.
3847 */
3848 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003849display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850{
3851 /* avoid that 'q' at the more prompt truncates the message here */
3852 ++confirm_msg_used;
3853 if (confirm_msg != NULL)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003854 msg_puts_attr(confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 --confirm_msg_used;
3856}
3857
3858#endif /* FEAT_CON_DIALOG */
3859
3860#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3861
3862 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003863vim_dialog_yesno(
3864 int type,
3865 char_u *title,
3866 char_u *message,
3867 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868{
3869 if (do_dialog(type,
3870 title == NULL ? (char_u *)_("Question") : title,
3871 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003872 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 return VIM_YES;
3874 return VIM_NO;
3875}
3876
3877 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003878vim_dialog_yesnocancel(
3879 int type,
3880 char_u *title,
3881 char_u *message,
3882 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883{
3884 switch (do_dialog(type,
3885 title == NULL ? (char_u *)_("Question") : title,
3886 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003887 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 {
3889 case 1: return VIM_YES;
3890 case 2: return VIM_NO;
3891 }
3892 return VIM_CANCEL;
3893}
3894
3895 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003896vim_dialog_yesnoallcancel(
3897 int type,
3898 char_u *title,
3899 char_u *message,
3900 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901{
3902 switch (do_dialog(type,
3903 title == NULL ? (char_u *)"Question" : title,
3904 message,
3905 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003906 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 {
3908 case 1: return VIM_YES;
3909 case 2: return VIM_NO;
3910 case 3: return VIM_ALL;
3911 case 4: return VIM_DISCARDALL;
3912 }
3913 return VIM_CANCEL;
3914}
3915
3916#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3917
3918#if defined(FEAT_BROWSE) || defined(PROTO)
3919/*
3920 * Generic browse function. Calls gui_mch_browse() when possible.
3921 * Later this may pop-up a non-GUI file selector (external command?).
3922 */
3923 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003924do_browse(
3925 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3926 char_u *title, /* title for the window */
3927 char_u *dflt, /* default file name (may include directory) */
3928 char_u *ext, /* extension added */
3929 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003931 char_u *filter, /* file name filter */
3932 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933{
3934 char_u *fname;
3935 static char_u *last_dir = NULL; /* last used directory */
3936 char_u *tofree = NULL;
3937 int save_browse = cmdmod.browse;
3938
3939 /* Must turn off browse to avoid that autocommands will get the
3940 * flag too! */
3941 cmdmod.browse = FALSE;
3942
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003943 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003945 if (flags & BROWSE_DIR)
3946 title = (char_u *)_("Select Directory dialog");
3947 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 title = (char_u *)_("Save File dialog");
3949 else
3950 title = (char_u *)_("Open File dialog");
3951 }
3952
3953 /* When no directory specified, use default file name, default dir, buffer
3954 * dir, last dir or current dir */
3955 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3956 {
3957 if (mch_isdir(dflt)) /* default file name is a directory */
3958 {
3959 initdir = dflt;
3960 dflt = NULL;
3961 }
3962 else if (gettail(dflt) != dflt) /* default file name includes a path */
3963 {
3964 tofree = vim_strsave(dflt);
3965 if (tofree != NULL)
3966 {
3967 initdir = tofree;
3968 *gettail(initdir) = NUL;
3969 dflt = gettail(dflt);
3970 }
3971 }
3972 }
3973
3974 if (initdir == NULL || *initdir == NUL)
3975 {
3976 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003977 if (STRCMP(p_bsdir, "last") != 0
3978 && STRCMP(p_bsdir, "buffer") != 0
3979 && STRCMP(p_bsdir, "current") != 0
3980 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 initdir = p_bsdir;
3982 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003983 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 && buf != NULL && buf->b_ffname != NULL)
3985 {
3986 if (dflt == NULL || *dflt == NUL)
3987 dflt = gettail(curbuf->b_ffname);
3988 tofree = vim_strsave(curbuf->b_ffname);
3989 if (tofree != NULL)
3990 {
3991 initdir = tofree;
3992 *gettail(initdir) = NUL;
3993 }
3994 }
3995 /* When 'browsedir' is "last", use dir from last browse */
3996 else if (*p_bsdir == 'l')
3997 initdir = last_dir;
3998 /* When 'browsedir is "current", use current directory. This is the
3999 * default already, leave initdir empty. */
4000 }
4001
4002# ifdef FEAT_GUI
4003 if (gui.in_use) /* when this changes, also adjust f_has()! */
4004 {
4005 if (filter == NULL
4006# ifdef FEAT_EVAL
4007 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4008 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4009# endif
4010 )
4011 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004012 if (flags & BROWSE_DIR)
4013 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004014# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004015 /* For systems that have a directory dialog. */
4016 fname = gui_mch_browsedir(title, initdir);
4017# else
4018 /* Generic solution for selecting a directory: select a file and
4019 * remove the file name. */
4020 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4021# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004022# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004023 /* Win32 adds a dummy file name, others return an arbitrary file
4024 * name. GTK+ 2 returns only the directory, */
4025 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4026 {
4027 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004028 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004029
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004030 if (tail == fname)
4031 *tail++ = '.'; /* use current dir */
4032 *tail = NUL;
4033 }
4034# endif
4035 }
4036 else
4037 fname = gui_mch_browse(flags & BROWSE_SAVE,
4038 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039
4040 /* We hang around in the dialog for a while, the user might do some
4041 * things to our files. The Win32 dialog allows deleting or renaming
4042 * a file, check timestamps. */
4043 need_check_timestamps = TRUE;
4044 did_check_timestamps = FALSE;
4045 }
4046 else
4047# endif
4048 {
4049 /* TODO: non-GUI file selector here */
4050 EMSG(_("E338: Sorry, no file browser in console mode"));
4051 fname = NULL;
4052 }
4053
4054 /* keep the directory for next time */
4055 if (fname != NULL)
4056 {
4057 vim_free(last_dir);
4058 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004059 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 {
4061 *gettail(last_dir) = NUL;
4062 if (*last_dir == NUL)
4063 {
4064 /* filename only returned, must be in current dir */
4065 vim_free(last_dir);
4066 last_dir = alloc(MAXPATHL);
4067 if (last_dir != NULL)
4068 mch_dirname(last_dir, MAXPATHL);
4069 }
4070 }
4071 }
4072
4073 vim_free(tofree);
4074 cmdmod.browse = save_browse;
4075
4076 return fname;
4077}
4078#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004079
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004080#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004081static char *e_printf = N_("E766: Insufficient arguments for printf()");
4082
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004083static varnumber_T tv_nr(typval_T *tvs, int *idxp);
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004084static char *tv_str(typval_T *tvs, int *idxp, char_u **tofree);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004085# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004086static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004087# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004088
4089/*
4090 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4091 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004092 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004093tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004094{
4095 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004096 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004097 int err = FALSE;
4098
4099 if (tvs[idx].v_type == VAR_UNKNOWN)
4100 EMSG(_(e_printf));
4101 else
4102 {
4103 ++*idxp;
4104 n = get_tv_number_chk(&tvs[idx], &err);
4105 if (err)
4106 n = 0;
4107 }
4108 return n;
4109}
4110
4111/*
4112 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004113 * If "tofree" is NULL get_tv_string_chk() is used. Some types (e.g. List)
4114 * are not converted to a string.
4115 * If "tofree" is not NULL echo_string() is used. All types are converted to
4116 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004117 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004118 */
4119 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004120tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004121{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004122 int idx = *idxp - 1;
4123 char *s = NULL;
4124 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004125
4126 if (tvs[idx].v_type == VAR_UNKNOWN)
4127 EMSG(_(e_printf));
4128 else
4129 {
4130 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004131 if (tofree != NULL)
4132 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4133 else
4134 s = (char *)get_tv_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004135 }
4136 return s;
4137}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004138
4139# ifdef FEAT_FLOAT
4140/*
4141 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4142 */
4143 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004144tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004145{
4146 int idx = *idxp - 1;
4147 double f = 0;
4148
4149 if (tvs[idx].v_type == VAR_UNKNOWN)
4150 EMSG(_(e_printf));
4151 else
4152 {
4153 ++*idxp;
4154 if (tvs[idx].v_type == VAR_FLOAT)
4155 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004156 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004157 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004158 else
4159 EMSG(_("E807: Expected Float argument for printf()"));
4160 }
4161 return f;
4162}
4163# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004164#endif
4165
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004166#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004167/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004168 * Return the representation of infinity for printf() function:
4169 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4170 */
4171 static const char *
4172infinity_str(int positive,
4173 char fmt_spec,
4174 int force_sign,
4175 int space_for_positive)
4176{
4177 static const char *table[] =
4178 {
4179 "-inf", "inf", "+inf", " inf",
4180 "-INF", "INF", "+INF", " INF"
4181 };
4182 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4183
4184 if (ASCII_ISUPPER(fmt_spec))
4185 idx += 4;
4186 return table[idx];
4187}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004188#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004189
4190/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004191 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004192 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004193 * consistency.
4194 *
4195 * This code is based on snprintf.c - a portable implementation of snprintf
4196 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004197 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004198 * The original code, including useful comments, can be found here:
4199 * http://www.ijs.si/software/snprintf/
4200 *
4201 * This snprintf() only supports the following conversion specifiers:
4202 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4203 * with flags: '-', '+', ' ', '0' and '#'.
4204 * An asterisk is supported for field width as well as precision.
4205 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004206 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004207 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004208 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4209 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004210 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004211 * The locale is not used, the string is used as a byte string. This is only
4212 * relevant for double-byte encodings where the second byte may be '%'.
4213 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004214 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4215 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004216 *
4217 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004218 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004219 * is greater or equal to "str_m", not all characters from the result
4220 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4221 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004222 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004223 */
4224
4225/*
4226 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004227 *
4228 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004229 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004230 */
4231
4232/* When generating prototypes all of this is skipped, cproto doesn't
4233 * understand this. */
4234#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004235
Bram Moolenaara800b422010-06-27 01:15:55 +02004236/* Like vim_vsnprintf() but append to the string. */
4237 int
4238vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4239{
4240 va_list ap;
4241 int str_l;
4242 size_t len = STRLEN(str);
4243 size_t space;
4244
4245 if (str_m <= len)
4246 space = 0;
4247 else
4248 space = str_m - len;
4249 va_start(ap, fmt);
4250 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
4251 va_end(ap);
4252 return str_l;
4253}
Bram Moolenaara800b422010-06-27 01:15:55 +02004254
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004255 int
4256vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4257{
4258 va_list ap;
4259 int str_l;
4260
4261 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004262 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004263 va_end(ap);
4264 return str_l;
4265}
4266
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004267 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004268vim_vsnprintf(
4269 char *str,
4270 size_t str_m,
4271 char *fmt,
4272 va_list ap,
4273 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004274{
4275 size_t str_l = 0;
4276 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004277 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004278
4279 if (p == NULL)
4280 p = "";
4281 while (*p != NUL)
4282 {
4283 if (*p != '%')
4284 {
4285 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004286 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004287
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004288 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004289 if (str_l < str_m)
4290 {
4291 size_t avail = str_m - str_l;
4292
4293 mch_memmove(str + str_l, p, n > avail ? avail : n);
4294 }
4295 p += n;
4296 str_l += n;
4297 }
4298 else
4299 {
4300 size_t min_field_width = 0, precision = 0;
4301 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4302 int alternate_form = 0, force_sign = 0;
4303
4304 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4305 * ignored. */
4306 int space_for_positive = 1;
4307
4308 /* allowed values: \0, h, l, L */
4309 char length_modifier = '\0';
4310
4311 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004312# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004313# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004314 * That sounds reasonable to use as the maximum
4315 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004316# elif defined(FEAT_NUM64)
4317# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004318# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004319# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004320# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004321 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004322
4323 /* string address in case of string argument */
4324 char *str_arg;
4325
4326 /* natural field width of arg without padding and sign */
4327 size_t str_arg_l;
4328
4329 /* unsigned char argument value - only defined for c conversion.
4330 * N.B. standard explicitly states the char argument for the c
4331 * conversion is unsigned */
4332 unsigned char uchar_arg;
4333
4334 /* number of zeros to be inserted for numeric conversions as
4335 * required by the precision or minimal field width */
4336 size_t number_of_zeros_to_pad = 0;
4337
4338 /* index into tmp where zero padding is to be inserted */
4339 size_t zero_padding_insertion_ind = 0;
4340
4341 /* current conversion specifier character */
4342 char fmt_spec = '\0';
4343
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004344 /* buffer for 's' and 'S' specs */
4345 char_u *tofree = NULL;
4346
4347
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004348 str_arg = NULL;
4349 p++; /* skip '%' */
4350
4351 /* parse flags */
4352 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4353 || *p == '#' || *p == '\'')
4354 {
4355 switch (*p)
4356 {
4357 case '0': zero_padding = 1; break;
4358 case '-': justify_left = 1; break;
4359 case '+': force_sign = 1; space_for_positive = 0; break;
4360 case ' ': force_sign = 1;
4361 /* If both the ' ' and '+' flags appear, the ' '
4362 * flag should be ignored */
4363 break;
4364 case '#': alternate_form = 1; break;
4365 case '\'': break;
4366 }
4367 p++;
4368 }
4369 /* If the '0' and '-' flags both appear, the '0' flag should be
4370 * ignored. */
4371
4372 /* parse field width */
4373 if (*p == '*')
4374 {
4375 int j;
4376
4377 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004378 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004379# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004380 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004381# endif
4382 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004383 if (j >= 0)
4384 min_field_width = j;
4385 else
4386 {
4387 min_field_width = -j;
4388 justify_left = 1;
4389 }
4390 }
4391 else if (VIM_ISDIGIT((int)(*p)))
4392 {
4393 /* size_t could be wider than unsigned int; make sure we treat
4394 * argument like common implementations do */
4395 unsigned int uj = *p++ - '0';
4396
4397 while (VIM_ISDIGIT((int)(*p)))
4398 uj = 10 * uj + (unsigned int)(*p++ - '0');
4399 min_field_width = uj;
4400 }
4401
4402 /* parse precision */
4403 if (*p == '.')
4404 {
4405 p++;
4406 precision_specified = 1;
4407 if (*p == '*')
4408 {
4409 int j;
4410
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004411 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004412# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004413 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004414# endif
4415 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004416 p++;
4417 if (j >= 0)
4418 precision = j;
4419 else
4420 {
4421 precision_specified = 0;
4422 precision = 0;
4423 }
4424 }
4425 else if (VIM_ISDIGIT((int)(*p)))
4426 {
4427 /* size_t could be wider than unsigned int; make sure we
4428 * treat argument like common implementations do */
4429 unsigned int uj = *p++ - '0';
4430
4431 while (VIM_ISDIGIT((int)(*p)))
4432 uj = 10 * uj + (unsigned int)(*p++ - '0');
4433 precision = uj;
4434 }
4435 }
4436
4437 /* parse 'h', 'l' and 'll' length modifiers */
4438 if (*p == 'h' || *p == 'l')
4439 {
4440 length_modifier = *p;
4441 p++;
4442 if (length_modifier == 'l' && *p == 'l')
4443 {
4444 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004445# ifdef FEAT_NUM64
4446 length_modifier = 'L';
4447# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004448 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004449# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004450 p++;
4451 }
4452 }
4453 fmt_spec = *p;
4454
4455 /* common synonyms: */
4456 switch (fmt_spec)
4457 {
4458 case 'i': fmt_spec = 'd'; break;
4459 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4460 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4461 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4462 default: break;
4463 }
4464
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004465# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4466 switch (fmt_spec)
4467 {
4468 case 'd': case 'u': case 'o': case 'x': case 'X':
4469 if (tvs != NULL && length_modifier == '\0')
4470 length_modifier = 'L';
4471 }
4472# endif
4473
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004474 /* get parameter value, do initial processing */
4475 switch (fmt_spec)
4476 {
4477 /* '%' and 'c' behave similar to 's' regarding flags and field
4478 * widths */
4479 case '%':
4480 case 'c':
4481 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004482 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004483 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004484 str_arg_l = 1;
4485 switch (fmt_spec)
4486 {
4487 case '%':
4488 str_arg = p;
4489 break;
4490
4491 case 'c':
4492 {
4493 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004494
4495 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004496# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004497 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004498# endif
4499 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004500 /* standard demands unsigned char */
4501 uchar_arg = (unsigned char)j;
4502 str_arg = (char *)&uchar_arg;
4503 break;
4504 }
4505
4506 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004507 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004508 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004509# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004510 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004511# endif
4512 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004513 if (str_arg == NULL)
4514 {
4515 str_arg = "[NULL]";
4516 str_arg_l = 6;
4517 }
4518 /* make sure not to address string beyond the specified
4519 * precision !!! */
4520 else if (!precision_specified)
4521 str_arg_l = strlen(str_arg);
4522 /* truncate string if necessary as requested by precision */
4523 else if (precision == 0)
4524 str_arg_l = 0;
4525 else
4526 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004527 /* Don't put the #if inside memchr(), it can be a
4528 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004529# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004530 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004531# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004532 /* memchr on HP does not like n > 2^31 !!! */
4533 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004534 precision <= (size_t)0x7fffffffL ? precision
4535 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004536# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004537 str_arg_l = (q == NULL) ? precision
4538 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004539 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004540# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004541 if (fmt_spec == 'S')
4542 {
4543 if (min_field_width != 0)
4544 min_field_width += STRLEN(str_arg)
4545 - mb_string2cells((char_u *)str_arg, -1);
4546 if (precision)
4547 {
4548 char_u *p1 = (char_u *)str_arg;
4549 size_t i;
4550
4551 for (i = 0; i < precision && *p1; i++)
4552 p1 += mb_ptr2len(p1);
4553
4554 str_arg_l = precision = p1 - (char_u *)str_arg;
4555 }
4556 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004557# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004558 break;
4559
4560 default:
4561 break;
4562 }
4563 break;
4564
Bram Moolenaar91984b92016-08-16 21:58:41 +02004565 case 'd': case 'u':
4566 case 'b': case 'B':
4567 case 'o':
4568 case 'x': case 'X':
4569 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004570 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004571 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004572 * imply the value is unsigned; d implies a signed
4573 * value */
4574
4575 /* 0 if numeric argument is zero (or if pointer is
4576 * NULL for 'p'), +1 if greater than zero (or nonzero
4577 * for unsigned arguments), -1 if negative (unsigned
4578 * argument is never negative) */
4579 int arg_sign = 0;
4580
4581 /* only defined for length modifier h, or for no
4582 * length modifiers */
4583 int int_arg = 0;
4584 unsigned int uint_arg = 0;
4585
4586 /* only defined for length modifier l */
4587 long int long_arg = 0;
4588 unsigned long int ulong_arg = 0;
4589
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004590# ifdef FEAT_NUM64
4591 /* only defined for length modifier ll */
4592 varnumber_T llong_arg = 0;
4593 uvarnumber_T ullong_arg = 0;
4594# endif
4595
Bram Moolenaare9997822016-08-28 16:03:38 +02004596 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004597 uvarnumber_T bin_arg = 0;
4598
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004599 /* pointer argument value -only defined for p
4600 * conversion */
4601 void *ptr_arg = NULL;
4602
4603 if (fmt_spec == 'p')
4604 {
4605 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004606 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004607# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004608 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4609 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004610# endif
4611 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004612 if (ptr_arg != NULL)
4613 arg_sign = 1;
4614 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004615 else if (fmt_spec == 'b' || fmt_spec == 'B')
4616 {
4617 bin_arg =
4618# if defined(FEAT_EVAL)
4619 tvs != NULL ?
4620 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4621# endif
4622 va_arg(ap, uvarnumber_T);
4623 if (bin_arg != 0)
4624 arg_sign = 1;
4625 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004626 else if (fmt_spec == 'd')
4627 {
4628 /* signed */
4629 switch (length_modifier)
4630 {
4631 case '\0':
4632 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004633 /* char and short arguments are passed as int. */
4634 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004635# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004636 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004637# endif
4638 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004639 if (int_arg > 0)
4640 arg_sign = 1;
4641 else if (int_arg < 0)
4642 arg_sign = -1;
4643 break;
4644 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004645 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004646# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004647 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004648# endif
4649 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004650 if (long_arg > 0)
4651 arg_sign = 1;
4652 else if (long_arg < 0)
4653 arg_sign = -1;
4654 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004655# ifdef FEAT_NUM64
4656 case 'L':
4657 llong_arg =
4658# if defined(FEAT_EVAL)
4659 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4660# endif
4661 va_arg(ap, varnumber_T);
4662 if (llong_arg > 0)
4663 arg_sign = 1;
4664 else if (llong_arg < 0)
4665 arg_sign = -1;
4666 break;
4667# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004668 }
4669 }
4670 else
4671 {
4672 /* unsigned */
4673 switch (length_modifier)
4674 {
4675 case '\0':
4676 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004677 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004678# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004679 tvs != NULL ? (unsigned)
4680 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004681# endif
4682 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004683 if (uint_arg != 0)
4684 arg_sign = 1;
4685 break;
4686 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004687 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004688# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004689 tvs != NULL ? (unsigned long)
4690 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004691# endif
4692 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004693 if (ulong_arg != 0)
4694 arg_sign = 1;
4695 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004696# ifdef FEAT_NUM64
4697 case 'L':
4698 ullong_arg =
4699# if defined(FEAT_EVAL)
4700 tvs != NULL ? (uvarnumber_T)
4701 tv_nr(tvs, &arg_idx) :
4702# endif
4703 va_arg(ap, uvarnumber_T);
4704 if (ullong_arg != 0)
4705 arg_sign = 1;
4706 break;
4707# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004708 }
4709 }
4710
4711 str_arg = tmp;
4712 str_arg_l = 0;
4713
4714 /* NOTE:
4715 * For d, i, u, o, x, and X conversions, if precision is
4716 * specified, the '0' flag should be ignored. This is so
4717 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4718 * FreeBSD, NetBSD; but not with Perl.
4719 */
4720 if (precision_specified)
4721 zero_padding = 0;
4722 if (fmt_spec == 'd')
4723 {
4724 if (force_sign && arg_sign >= 0)
4725 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4726 /* leave negative numbers for sprintf to handle, to
4727 * avoid handling tricky cases like (short int)-32768 */
4728 }
4729 else if (alternate_form)
4730 {
4731 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004732 && (fmt_spec == 'b' || fmt_spec == 'B'
4733 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004734 {
4735 tmp[str_arg_l++] = '0';
4736 tmp[str_arg_l++] = fmt_spec;
4737 }
4738 /* alternate form should have no effect for p
4739 * conversion, but ... */
4740 }
4741
4742 zero_padding_insertion_ind = str_arg_l;
4743 if (!precision_specified)
4744 precision = 1; /* default precision is 1 */
4745 if (precision == 0 && arg_sign == 0)
4746 {
4747 /* When zero value is formatted with an explicit
4748 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004749 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004750 }
4751 else
4752 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004753 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004754 int f_l = 0;
4755
4756 /* construct a simple format string for sprintf */
4757 f[f_l++] = '%';
4758 if (!length_modifier)
4759 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004760 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004761 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004762# ifdef FEAT_NUM64
4763# ifdef WIN3264
4764 f[f_l++] = 'I';
4765 f[f_l++] = '6';
4766 f[f_l++] = '4';
4767# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004768 f[f_l++] = 'l';
4769 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004770# endif
4771# else
4772 f[f_l++] = 'l';
4773# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004774 }
4775 else
4776 f[f_l++] = length_modifier;
4777 f[f_l++] = fmt_spec;
4778 f[f_l++] = '\0';
4779
4780 if (fmt_spec == 'p')
4781 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004782 else if (fmt_spec == 'b' || fmt_spec == 'B')
4783 {
4784 char b[8 * sizeof(uvarnumber_T)];
4785 size_t b_l = 0;
4786 uvarnumber_T bn = bin_arg;
4787
4788 do
4789 {
4790 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4791 bn >>= 1;
4792 }
4793 while (bn != 0);
4794
4795 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4796 str_arg_l += b_l;
4797 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004798 else if (fmt_spec == 'd')
4799 {
4800 /* signed */
4801 switch (length_modifier)
4802 {
4803 case '\0':
4804 case 'h': str_arg_l += sprintf(
4805 tmp + str_arg_l, f, int_arg);
4806 break;
4807 case 'l': str_arg_l += sprintf(
4808 tmp + str_arg_l, f, long_arg);
4809 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004810# ifdef FEAT_NUM64
4811 case 'L': str_arg_l += sprintf(
4812 tmp + str_arg_l, f, llong_arg);
4813 break;
4814# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004815 }
4816 }
4817 else
4818 {
4819 /* unsigned */
4820 switch (length_modifier)
4821 {
4822 case '\0':
4823 case 'h': str_arg_l += sprintf(
4824 tmp + str_arg_l, f, uint_arg);
4825 break;
4826 case 'l': str_arg_l += sprintf(
4827 tmp + str_arg_l, f, ulong_arg);
4828 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004829# ifdef FEAT_NUM64
4830 case 'L': str_arg_l += sprintf(
4831 tmp + str_arg_l, f, ullong_arg);
4832 break;
4833# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004834 }
4835 }
4836
4837 /* include the optional minus sign and possible
4838 * "0x" in the region before the zero padding
4839 * insertion point */
4840 if (zero_padding_insertion_ind < str_arg_l
4841 && tmp[zero_padding_insertion_ind] == '-')
4842 zero_padding_insertion_ind++;
4843 if (zero_padding_insertion_ind + 1 < str_arg_l
4844 && tmp[zero_padding_insertion_ind] == '0'
4845 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4846 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4847 zero_padding_insertion_ind += 2;
4848 }
4849
4850 {
4851 size_t num_of_digits = str_arg_l
4852 - zero_padding_insertion_ind;
4853
4854 if (alternate_form && fmt_spec == 'o'
4855 /* unless zero is already the first
4856 * character */
4857 && !(zero_padding_insertion_ind < str_arg_l
4858 && tmp[zero_padding_insertion_ind] == '0'))
4859 {
4860 /* assure leading zero for alternate-form
4861 * octal numbers */
4862 if (!precision_specified
4863 || precision < num_of_digits + 1)
4864 {
4865 /* precision is increased to force the
4866 * first character to be zero, except if a
4867 * zero value is formatted with an
4868 * explicit precision of zero */
4869 precision = num_of_digits + 1;
4870 precision_specified = 1;
4871 }
4872 }
4873 /* zero padding to specified precision? */
4874 if (num_of_digits < precision)
4875 number_of_zeros_to_pad = precision - num_of_digits;
4876 }
4877 /* zero padding to specified minimal field width? */
4878 if (!justify_left && zero_padding)
4879 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004880 int n = (int)(min_field_width - (str_arg_l
4881 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004882 if (n > 0)
4883 number_of_zeros_to_pad += n;
4884 }
4885 break;
4886 }
4887
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004888# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004889 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004890 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004891 case 'e':
4892 case 'E':
4893 case 'g':
4894 case 'G':
4895 {
4896 /* Floating point. */
4897 double f;
4898 double abs_f;
4899 char format[40];
4900 int l;
4901 int remove_trailing_zeroes = FALSE;
4902
4903 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004904# if defined(FEAT_EVAL)
4905 tvs != NULL ? tv_float(tvs, &arg_idx) :
4906# endif
4907 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004908 abs_f = f < 0 ? -f : f;
4909
4910 if (fmt_spec == 'g' || fmt_spec == 'G')
4911 {
4912 /* Would be nice to use %g directly, but it prints
4913 * "1.0" as "1", we don't want that. */
4914 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4915 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004916 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004917 else
4918 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4919 remove_trailing_zeroes = TRUE;
4920 }
4921
Bram Moolenaar04186092016-08-29 21:55:35 +02004922 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004923# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004924 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004925# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004926 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004927# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004928 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004929 {
4930 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004931 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4932 force_sign, space_for_positive));
4933 str_arg_l = STRLEN(tmp);
4934 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004935 }
4936 else
4937 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004938 if (isnan(f))
4939 {
4940 /* Not a number: nan or NAN */
4941 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4942 : "nan");
4943 str_arg_l = 3;
4944 zero_padding = 0;
4945 }
4946 else if (isinf(f))
4947 {
4948 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4949 force_sign, space_for_positive));
4950 str_arg_l = STRLEN(tmp);
4951 zero_padding = 0;
4952 }
4953 else
Bram Moolenaar04186092016-08-29 21:55:35 +02004954 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004955 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004956 format[0] = '%';
4957 l = 1;
4958 if (force_sign)
4959 format[l++] = space_for_positive ? ' ' : '+';
4960 if (precision_specified)
4961 {
4962 size_t max_prec = TMP_LEN - 10;
4963
4964 /* Make sure we don't get more digits than we
4965 * have room for. */
4966 if ((fmt_spec == 'f' || fmt_spec == 'F')
4967 && abs_f > 1.0)
4968 max_prec -= (size_t)log10(abs_f);
4969 if (precision > max_prec)
4970 precision = max_prec;
4971 l += sprintf(format + l, ".%d", (int)precision);
4972 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004973 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004974 format[l + 1] = NUL;
4975
Bram Moolenaare9997822016-08-28 16:03:38 +02004976 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar04186092016-08-29 21:55:35 +02004977 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004978
Bram Moolenaara7241f52008-06-24 20:39:31 +00004979 if (remove_trailing_zeroes)
4980 {
4981 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004982 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004983
4984 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02004985 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004986 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004987 else
4988 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004989 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004990 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004991 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004992 {
4993 /* Remove superfluous '+' and leading
4994 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004995 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004996 {
4997 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004998 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004999 --str_arg_l;
5000 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005001 i = (tp[1] == '-') ? 2 : 1;
5002 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005003 {
5004 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005005 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005006 --str_arg_l;
5007 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005008 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005009 }
5010 }
5011
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005012 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005013 /* Remove trailing zeroes, but keep the one
5014 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005015 while (tp > tmp + 2 && *tp == '0'
5016 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005017 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005018 STRMOVE(tp, tp + 1);
5019 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005020 --str_arg_l;
5021 }
5022 }
5023 else
5024 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005025 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005026
5027 /* Be consistent: some printf("%e") use 1.0e+12
5028 * and some 1.0e+012. Remove one zero in the last
5029 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005030 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005031 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005032 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5033 && tp[2] == '0'
5034 && vim_isdigit(tp[3])
5035 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005036 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005037 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005038 --str_arg_l;
5039 }
5040 }
5041 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005042 if (zero_padding && min_field_width > str_arg_l
5043 && (tmp[0] == '-' || force_sign))
5044 {
5045 /* padding 0's should be inserted after the sign */
5046 number_of_zeros_to_pad = min_field_width - str_arg_l;
5047 zero_padding_insertion_ind = 1;
5048 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005049 str_arg = tmp;
5050 break;
5051 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005052# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005053
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005054 default:
5055 /* unrecognized conversion specifier, keep format string
5056 * as-is */
5057 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005058 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005059 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005060 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005061
5062 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005063 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005064 str_arg = p;
5065 str_arg_l = 0;
5066 if (*p != NUL)
5067 str_arg_l++; /* include invalid conversion specifier
5068 unchanged if not at end-of-string */
5069 break;
5070 }
5071
5072 if (*p != NUL)
5073 p++; /* step over the just processed conversion specifier */
5074
5075 /* insert padding to the left as requested by min_field_width;
5076 * this does not include the zero padding in case of numerical
5077 * conversions*/
5078 if (!justify_left)
5079 {
5080 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005081 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005082
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005083 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005084 {
5085 if (str_l < str_m)
5086 {
5087 size_t avail = str_m - str_l;
5088
5089 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005090 (size_t)pn > avail ? avail
5091 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005093 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005094 }
5095 }
5096
5097 /* zero padding as requested by the precision or by the minimal
5098 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005099 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005100 {
5101 /* will not copy first part of numeric right now, *
5102 * force it to be copied later in its entirety */
5103 zero_padding_insertion_ind = 0;
5104 }
5105 else
5106 {
5107 /* insert first part of numerics (sign or '0x') before zero
5108 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005109 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005110
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005111 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005112 {
5113 if (str_l < str_m)
5114 {
5115 size_t avail = str_m - str_l;
5116
5117 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005118 (size_t)zn > avail ? avail
5119 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005120 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005121 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005122 }
5123
5124 /* insert zero padding as requested by the precision or min
5125 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005126 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005127 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005128 {
5129 if (str_l < str_m)
5130 {
5131 size_t avail = str_m-str_l;
5132
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005133 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005134 (size_t)zn > avail ? avail
5135 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005136 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005137 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005138 }
5139 }
5140
5141 /* insert formatted string
5142 * (or as-is conversion specifier for unknown conversions) */
5143 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005144 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005145
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005146 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005147 {
5148 if (str_l < str_m)
5149 {
5150 size_t avail = str_m - str_l;
5151
5152 mch_memmove(str + str_l,
5153 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005154 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005155 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005156 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005157 }
5158 }
5159
5160 /* insert right padding */
5161 if (justify_left)
5162 {
5163 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005164 int pn = (int)(min_field_width
5165 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005166
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005167 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005168 {
5169 if (str_l < str_m)
5170 {
5171 size_t avail = str_m - str_l;
5172
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005173 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005174 (size_t)pn > avail ? avail
5175 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005176 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005177 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005178 }
5179 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005180 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005181 }
5182 }
5183
5184 if (str_m > 0)
5185 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005186 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005187 * overwriting the last character (shouldn't happen, but just in case)
5188 * */
5189 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5190 }
5191
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005192 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005193 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005194
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005195 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005196 * character), that is, the number of characters that would have been
5197 * written to the buffer if it were large enough. */
5198 return (int)str_l;
5199}
5200
5201#endif /* PROTO */