blob: 0b690bb5d3a7e207b2242e9eb4fab15801972986 [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 void add_msg_hist(char_u *s, int len, int attr);
20static void hit_return_msg(void);
21static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +010022static void msg_puts_attr_len(char *str, int maxlen, int attr);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010023static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
24static void msg_scroll_up(void);
25static void inc_msg_scrolled(void);
26static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
27static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
28static void msg_puts_printf(char_u *str, int maxlen);
29static int do_more_prompt(int typed_char);
30static void msg_screen_putchar(int c, int attr);
Bram Moolenaar5843f5f2019-08-20 20:13:45 +020031static void msg_moremsg(int full);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010032static int msg_check_screen(void);
33static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000034#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010035static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000036static int confirm_msg_used = FALSE; /* displaying confirm_msg */
37static char_u *confirm_msg = NULL; /* ":confirm" message */
38static char_u *confirm_msg_tail; /* tail of confirm_msg */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +020039static void display_confirm_msg(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040#endif
Bram Moolenaar958dc692016-12-01 15:34:12 +010041#ifdef FEAT_JOB_CHANNEL
42static int emsg_to_channel_log = FALSE;
43#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
45struct msg_hist
46{
47 struct msg_hist *next;
48 char_u *msg;
49 int attr;
50};
51
52static struct msg_hist *first_msg_hist = NULL;
53static struct msg_hist *last_msg_hist = NULL;
54static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020056static FILE *verbose_fd = NULL;
57static int verbose_did_open = FALSE;
58
Bram Moolenaar071d4272004-06-13 20:20:40 +000059/*
60 * When writing messages to the screen, there are many different situations.
61 * A number of variables is used to remember the current state:
62 * msg_didany TRUE when messages were written since the last time the
63 * user reacted to a prompt.
64 * Reset: After hitting a key for the hit-return prompt,
65 * hitting <CR> for the command line or input().
66 * Set: When any message is written to the screen.
67 * msg_didout TRUE when something was written to the current line.
68 * Reset: When advancing to the next line, when the current
69 * text can be overwritten.
70 * Set: When any message is written to the screen.
71 * msg_nowait No extra delay for the last drawn message.
72 * Used in normal_cmd() before the mode message is drawn.
73 * emsg_on_display There was an error message recently. Indicates that there
74 * should be a delay before redrawing.
75 * msg_scroll The next message should not overwrite the current one.
76 * msg_scrolled How many lines the screen has been scrolled (because of
77 * messages). Used in update_screen() to scroll the screen
78 * back. Incremented each time the screen scrolls a line.
79 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
80 * writes something without scrolling should not make
81 * need_wait_return to be set. This is a hack to make ":ts"
82 * work without an extra prompt.
83 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010084 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 * need_wait_return TRUE when the hit-return prompt is needed.
86 * Reset: After giving the hit-return prompt, when the user
87 * has answered some other prompt.
88 * Set: When the ruler or typeahead display is overwritten,
89 * scrolling the screen for some message.
90 * keep_msg Message to be displayed after redrawing the screen, in
91 * main_loop().
92 * This is an allocated string or NULL when not used.
93 */
94
95/*
96 * msg(s) - displays the string 's' on the status line
97 * When terminal not initialized (yet) mch_errmsg(..) is used.
98 * return TRUE if wait_return not called
99 */
100 int
Bram Moolenaar32526b32019-01-19 17:43:09 +0100101msg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102{
103 return msg_attr_keep(s, 0, FALSE);
104}
105
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000106/*
107 * Like msg() but keep it silent when 'verbosefile' is set.
108 */
109 int
Bram Moolenaar32526b32019-01-19 17:43:09 +0100110verb_msg(char *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000111{
112 int n;
113
114 verbose_enter();
115 n = msg_attr_keep(s, 0, FALSE);
116 verbose_leave();
117
118 return n;
119}
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000120
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 int
Bram Moolenaar32526b32019-01-19 17:43:09 +0100122msg_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123{
124 return msg_attr_keep(s, attr, FALSE);
125}
126
127 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100128msg_attr_keep(
Bram Moolenaar32526b32019-01-19 17:43:09 +0100129 char *s,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100130 int attr,
131 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132{
133 static int entered = 0;
134 int retval;
135 char_u *buf = NULL;
136
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200137 /* Skip messages not matching ":filter pattern".
138 * Don't filter when there is an error. */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100139 if (!emsg_on_display && message_filtered((char_u *)s))
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200140 return TRUE;
141
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142#ifdef FEAT_EVAL
143 if (attr == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100144 set_vim_var_string(VV_STATUSMSG, (char_u *)s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145#endif
146
147 /*
148 * It is possible that displaying a messages causes a problem (e.g.,
149 * when redrawing the window), which causes another message, etc.. To
150 * break this loop, limit the recursiveness to 3 levels.
151 */
152 if (entered >= 3)
153 return TRUE;
154 ++entered;
155
156 /* Add message to history (unless it's a repeated kept message or a
157 * truncated message) */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100158 if ((char_u *)s != keep_msg
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 || (*s != '<'
160 && last_msg_hist != NULL
161 && last_msg_hist->msg != NULL
162 && STRCMP(s, last_msg_hist->msg)))
Bram Moolenaar32526b32019-01-19 17:43:09 +0100163 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164
Bram Moolenaar958dc692016-12-01 15:34:12 +0100165#ifdef FEAT_JOB_CHANNEL
166 if (emsg_to_channel_log)
Bram Moolenaar958dc692016-12-01 15:34:12 +0100167 /* Write message in the channel log. */
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200168 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100169#endif
170
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000172 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +0100173 buf = msg_strtrunc((char_u *)s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 if (buf != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100175 s = (char *)buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176
Bram Moolenaar32526b32019-01-19 17:43:09 +0100177 msg_outtrans_attr((char_u *)s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 msg_clr_eos();
179 retval = msg_end();
180
Bram Moolenaar32526b32019-01-19 17:43:09 +0100181 if (keep && retval && vim_strsize((char_u *)s)
182 < (int)(Rows - cmdline_row - 1) * Columns + sc_col)
183 set_keep_msg((char_u *)s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184
185 vim_free(buf);
186 --entered;
187 return retval;
188}
189
190/*
191 * Truncate a string such that it can be printed without causing a scroll.
192 * Returns an allocated string or NULL when no truncating is done.
193 */
194 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100195msg_strtrunc(
196 char_u *s,
197 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198{
199 char_u *buf = NULL;
200 int len;
201 int room;
202
203 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000204 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
205 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 {
207 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000208 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000209 /* Use all the columns. */
210 room = (int)(Rows - msg_row) * Columns - 1;
211 else
212 /* Use up to 'showcmd' column. */
213 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 if (len > room && room > 0)
215 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216 if (enc_utf8)
217 /* may have up to 18 bytes per cell (6 per char, up to two
218 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100219 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 else if (enc_dbcs == DBCS_JPNU)
221 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100222 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223 else
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100224 len = room + 2;
225 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100227 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228 }
229 }
230 return buf;
231}
232
233/*
234 * Truncate a string "s" to "buf" with cell width "room".
235 * "s" and "buf" may be equal.
236 */
237 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100238trunc_string(
239 char_u *s,
240 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200241 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100242 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200244 size_t room = room_in - 3; /* "..." takes 3 chars */
245 size_t half;
246 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247 int e;
248 int i;
249 int n;
250
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200251 if (room_in < 3)
252 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254
255 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100256 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257 {
258 if (s[e] == NUL)
259 {
260 /* text fits without truncating! */
261 buf[e] = NUL;
262 return;
263 }
264 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200265 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266 break;
267 len += n;
268 buf[e] = s[e];
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000270 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100272 if (++e == buflen)
273 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 buf[e] = s[e];
275 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 }
277
278 /* Last part: End of the string. */
279 i = e;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 if (enc_dbcs != 0)
281 {
282 /* For DBCS going backwards in a string is slow, but
283 * computing the cell width isn't too slow: go forward
284 * until the rest fits. */
285 n = vim_strsize(s + i);
286 while (len + n > room)
287 {
288 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000289 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000290 }
291 }
292 else if (enc_utf8)
293 {
294 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000295 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 for (;;)
297 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000298 do
Bram Moolenaarace95982017-03-29 17:30:27 +0200299 half = half - utf_head_off(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200300 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200302 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 break;
304 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200305 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 }
307 }
308 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 {
310 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
311 len += n;
312 }
313
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200314
315 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100316 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200317 /* text fits without truncating */
318 if (s != buf)
319 {
320 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200321 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200322 len = buflen - 1;
323 len = len - e + 1;
324 if (len < 1)
325 buf[e - 1] = NUL;
326 else
327 mch_memmove(buf + e, s + e, len);
328 }
329 }
330 else if (e + 3 < buflen)
331 {
332 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100333 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200334 len = STRLEN(s + i) + 1;
335 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100336 len = buflen - e - 3 - 1;
337 mch_memmove(buf + e + 3, s + i, len);
338 buf[e + 3 + len - 1] = NUL;
339 }
340 else
341 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200342 /* can't fit in the "...", just truncate it */
343 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100344 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345}
346
347/*
348 * Automatic prototype generation does not understand this function.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100349 * Note: Caller of smsg() and smsg_attr() must check the resulting string is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 * shorter than IOSIZE!!!
351 */
352#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100354int vim_snprintf(char *str, size_t str_m, const char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000355
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100357smsg(const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200359 if (IObuff == NULL)
360 {
361 // Very early in initialisation and already something wrong, just
362 // give the raw message so the user at least gets a hint.
363 return msg((char *)s);
364 }
365 else
366 {
367 va_list arglist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200369 va_start(arglist, s);
370 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
371 va_end(arglist);
372 return msg((char *)IObuff);
373 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374}
375
376 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100377smsg_attr(int attr, const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200379 if (IObuff == NULL)
380 {
381 // Very early in initialisation and already something wrong, just
382 // give the raw message so the user at least gets a hint.
383 return msg_attr((char *)s, attr);
384 }
385 else
386 {
387 va_list arglist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200389 va_start(arglist, s);
390 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
391 va_end(arglist);
392 return msg_attr((char *)IObuff, attr);
393 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394}
395
Bram Moolenaare0429682018-07-01 16:44:03 +0200396 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100397smsg_attr_keep(int attr, const char *s, ...)
Bram Moolenaare0429682018-07-01 16:44:03 +0200398{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200399 if (IObuff == NULL)
400 {
401 // Very early in initialisation and already something wrong, just
402 // give the raw message so the user at least gets a hint.
403 return msg_attr_keep((char *)s, attr, TRUE);
404 }
405 else
406 {
407 va_list arglist;
Bram Moolenaare0429682018-07-01 16:44:03 +0200408
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200409 va_start(arglist, s);
410 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
411 va_end(arglist);
412 return msg_attr_keep((char *)IObuff, attr, TRUE);
413 }
Bram Moolenaare0429682018-07-01 16:44:03 +0200414}
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416#endif
417
418/*
419 * Remember the last sourcing name/lnum used in an error message, so that it
420 * isn't printed each time when it didn't change.
421 */
422static int last_sourcing_lnum = 0;
423static char_u *last_sourcing_name = NULL;
424
425/*
426 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
427 * for the next error message;
428 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000429 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100430reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100432 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433 last_sourcing_lnum = 0;
434}
435
436/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000437 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
438 */
439 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100440other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000441{
442 if (sourcing_name != NULL)
443 {
444 if (last_sourcing_name != NULL)
445 return STRCMP(sourcing_name, last_sourcing_name) != 0;
446 return TRUE;
447 }
448 return FALSE;
449}
450
451/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452 * Get the message about the source, as used for an error message.
453 * Returns an allocated string with room for one more character.
454 * Returns NULL when no message is to be given.
455 */
456 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100457get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458{
459 char_u *Buf, *p;
460
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000461 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462 {
463 p = (char_u *)_("Error detected while processing %s:");
Bram Moolenaar964b3742019-05-24 18:54:09 +0200464 Buf = alloc(STRLEN(sourcing_name) + STRLEN(p));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465 if (Buf != NULL)
466 sprintf((char *)Buf, (char *)p, sourcing_name);
467 return Buf;
468 }
469 return NULL;
470}
471
472/*
473 * Get the message about the source lnum, as used for an error message.
474 * Returns an allocated string with room for one more character.
475 * Returns NULL when no message is to be given.
476 */
477 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100478get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479{
480 char_u *Buf, *p;
481
482 /* lnum is 0 when executing a command from the command line
483 * argument, we don't want a line number then */
484 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000485 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486 && sourcing_lnum != 0)
487 {
488 p = (char_u *)_("line %4ld:");
Bram Moolenaar964b3742019-05-24 18:54:09 +0200489 Buf = alloc(STRLEN(p) + 20);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490 if (Buf != NULL)
491 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
492 return Buf;
493 }
494 return NULL;
495}
496
497/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000498 * Display name and line number for the source of an error.
499 * Remember the file name and line number, so that for the next error the info
500 * is only displayed if it changed.
501 */
502 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100503msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000504{
505 char_u *p;
506
507 ++no_wait_return;
508 p = get_emsg_source();
509 if (p != NULL)
510 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100511 msg_attr((char *)p, attr);
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000512 vim_free(p);
513 }
514 p = get_emsg_lnum();
515 if (p != NULL)
516 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100517 msg_attr((char *)p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000518 vim_free(p);
519 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
520 }
521
522 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000523 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000524 {
525 vim_free(last_sourcing_name);
526 if (sourcing_name == NULL)
527 last_sourcing_name = NULL;
528 else
529 last_sourcing_name = vim_strsave(sourcing_name);
530 }
531 --no_wait_return;
532}
533
534/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000535 * Return TRUE if not giving error messages right now:
536 * If "emsg_off" is set: no error messages at the moment.
537 * If "msg" is in 'debug': do error message but without side effects.
538 * If "emsg_skip" is set: never do error messages.
539 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200540 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100541emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000542{
543 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
544 && vim_strchr(p_debug, 't') == NULL)
545#ifdef FEAT_EVAL
546 || emsg_skip > 0
547#endif
548 )
549 return TRUE;
550 return FALSE;
551}
552
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100553#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100554static garray_T ignore_error_list = GA_EMPTY;
555
556 void
557ignore_error_for_testing(char_u *error)
558{
559 if (ignore_error_list.ga_itemsize == 0)
560 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
561
Bram Moolenaar461a7fc2018-12-22 13:28:07 +0100562 if (STRCMP("RESET", error) == 0)
563 ga_clear_strings(&ignore_error_list);
564 else
565 ga_add_string(&ignore_error_list, error);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100566}
567
568 static int
569ignore_error(char_u *msg)
570{
571 int i;
572
573 for (i = 0; i < ignore_error_list.ga_len; ++i)
574 if (strstr((char *)msg,
575 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
576 return TRUE;
577 return FALSE;
578}
579#endif
580
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200581#if !defined(HAVE_STRERROR) || defined(PROTO)
582/*
583 * Replacement for perror() that behaves more or less like emsg() was called.
584 * v:errmsg will be set and called_emsg will be set.
585 */
586 void
587do_perror(char *msg)
588{
589 perror(msg);
590 ++emsg_silent;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100591 emsg(msg);
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200592 --emsg_silent;
593}
594#endif
595
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000596/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100597 * emsg_core() - display an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 *
599 * Rings the bell, if appropriate, and calls message() to do the real work
600 * When terminal not initialized (yet) mch_errmsg(..) is used.
601 *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100602 * Return TRUE if wait_return not called.
603 * Note: caller must check 'emsg_not_now()' before calling this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100605 static int
606emsg_core(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607{
608 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100610 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611#ifdef FEAT_EVAL
612 int ignore = FALSE;
613 int severe;
614#endif
615
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100616#ifdef FEAT_EVAL
617 /* When testing some errors are turned into a normal message. */
618 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100619 /* don't call msg() if it results in a dialog */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100620 return msg_use_printf() ? FALSE : msg((char *)s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100621#endif
622
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623 called_emsg = TRUE;
624
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625#ifdef FEAT_EVAL
Bram Moolenaare723c422017-09-06 23:40:10 +0200626 /* If "emsg_severe" is TRUE: When an error exception is to be thrown,
627 * prefer this message over previous messages for the same command. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 severe = emsg_severe;
629 emsg_severe = FALSE;
630#endif
631
Bram Moolenaar57657d82006-04-21 22:12:41 +0000632 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 {
634#ifdef FEAT_EVAL
635 /*
636 * Cause a throw of an error exception if appropriate. Don't display
637 * the error message in this case. (If no matching catch clause will
638 * be found, the message will be displayed later on.) "ignore" is set
639 * when the message should be ignored completely (used for the
640 * interrupt message).
641 */
642 if (cause_errthrow(s, severe, &ignore) == TRUE)
643 {
644 if (!ignore)
Bram Moolenaar76a63452018-11-28 20:38:37 +0100645 ++did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 return TRUE;
647 }
648
649 /* set "v:errmsg", also when using ":silent! cmd" */
650 set_vim_var_string(VV_ERRMSG, s, -1);
651#endif
652
653 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000654 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655 * But do write it to the redirection file.
656 */
657 if (emsg_silent != 0)
658 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200659 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200661 msg_start();
662 p = get_emsg_source();
663 if (p != NULL)
664 {
665 STRCAT(p, "\n");
666 redir_write(p, -1);
667 vim_free(p);
668 }
669 p = get_emsg_lnum();
670 if (p != NULL)
671 {
672 STRCAT(p, "\n");
673 redir_write(p, -1);
674 vim_free(p);
675 }
676 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100678#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare809a4e2019-07-04 17:35:05 +0200679 ch_log(NULL, "ERROR silent: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100680#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 return TRUE;
682 }
683
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100684 ex_exitval = 1;
685
Bram Moolenaar2f40d122017-10-24 21:49:36 +0200686 /* Reset msg_silent, an error causes messages to be switched back on.
687 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 msg_silent = 0;
689 cmd_silent = FALSE;
690
691 if (global_busy) /* break :global command */
692 ++global_busy;
693
694 if (p_eb)
695 beep_flush(); /* also includes flush_buffers() */
696 else
Bram Moolenaar6a2633b2018-10-07 23:16:36 +0200697 flush_buffers(FLUSH_MINIMAL); // flush internal buffers
Bram Moolenaar76a63452018-11-28 20:38:37 +0100698 ++did_emsg; // flag for DoOneCmd()
Bram Moolenaare723c422017-09-06 23:40:10 +0200699#ifdef FEAT_EVAL
700 did_uncaught_emsg = TRUE;
701#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 }
703
704 emsg_on_display = TRUE; /* remember there is an error message */
705 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100706 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000707 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 need_wait_return = TRUE; /* needed in case emsg() is called after
709 * wait_return has reset need_wait_return
710 * and a redraw is expected because
711 * msg_scrolled is non-zero */
712
Bram Moolenaar958dc692016-12-01 15:34:12 +0100713#ifdef FEAT_JOB_CHANNEL
714 emsg_to_channel_log = TRUE;
715#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 /*
717 * Display name and line number for the source of the error.
718 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000719 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
721 /*
722 * Display the error message itself.
723 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000724 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100725 r = msg_attr((char *)s, attr);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100726
727#ifdef FEAT_JOB_CHANNEL
728 emsg_to_channel_log = FALSE;
729#endif
730 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731}
732
733/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100734 * Print an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 */
736 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100737emsg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100739 /* Skip this if not giving error messages at the moment. */
740 if (!emsg_not_now())
741 return emsg_core((char_u *)s);
742 return TRUE; /* no error messages at the moment */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743}
744
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100745#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100746/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100747 * Print an error message with format string and variable arguments.
748 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100749 */
750 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100751semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100752{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200753 // Skip this if not giving error messages at the moment.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100754 if (!emsg_not_now())
755 {
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200756 if (IObuff == NULL)
757 {
758 // Very early in initialisation and already something wrong, just
759 // give the raw message so the user at least gets a hint.
760 return emsg_core((char_u *)s);
761 }
762 else
763 {
764 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100765
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200766 va_start(ap, s);
767 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
768 va_end(ap);
769 return emsg_core(IObuff);
770 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100771 }
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200772 return TRUE; // no error messages at the moment
Bram Moolenaar95f09602016-11-10 20:01:45 +0100773}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100774#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100775
776/*
777 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
778 * defined. It is used for internal errors only, so that they can be
779 * detected when fuzzing vim.
780 */
781 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100782iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100783{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100784 if (!emsg_not_now())
785 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100786#ifdef ABORT_ON_INTERNAL_ERROR
787 abort();
788#endif
789}
790
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100791#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100792/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100793 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100794 * defined. It is used for internal errors only, so that they can be
795 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100796 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100797 */
798 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100799siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100800{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100801 if (!emsg_not_now())
802 {
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200803 if (IObuff == NULL)
804 {
805 // Very early in initialisation and already something wrong, just
806 // give the raw message so the user at least gets a hint.
807 emsg_core((char_u *)s);
808 }
809 else
810 {
811 va_list ap;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100812
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200813 va_start(ap, s);
814 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
815 va_end(ap);
816 emsg_core(IObuff);
817 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100818 }
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100819# ifdef ABORT_ON_INTERNAL_ERROR
Bram Moolenaar95f09602016-11-10 20:01:45 +0100820 abort();
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100821# endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100822}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100823#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100824
825/*
826 * Give an "Internal error" message.
827 */
828 void
829internal_error(char *where)
830{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100831 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100832}
833
Bram Moolenaarea424162005-06-16 21:51:00 +0000834/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835
Bram Moolenaardf177f62005-02-22 08:39:57 +0000836 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100837emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000838{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100839 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000840}
841
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842/*
843 * Like msg(), but truncate to a single line if p_shm contains 't', or when
844 * "force" is TRUE. This truncates in another way as for normal messages.
845 * Careful: The string may be changed by msg_may_trunc()!
846 * Returns a pointer to the printed message, if wait_return() not called.
847 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100848 char *
849msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850{
851 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100852 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853
854 /* Add message to history before truncating */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100855 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
Bram Moolenaar32526b32019-01-19 17:43:09 +0100857 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
859 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100860 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 msg_hist_off = FALSE;
862
863 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100864 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 return NULL;
866}
867
868/*
869 * Check if message "s" should be truncated at the start (for filenames).
870 * Return a pointer to where the truncated message starts.
871 * Note: May change the message by replacing a character with '<'.
872 */
873 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100874msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875{
876 int n;
877 int room;
878
879 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
880 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
881 && (n = (int)STRLEN(s) - room) > 0)
882 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 if (has_mbyte)
884 {
885 int size = vim_strsize(s);
886
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000887 /* There may be room anyway when there are multibyte chars. */
888 if (size <= room)
889 return s;
890
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 for (n = 0; size >= room; )
892 {
893 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000894 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 }
896 --n;
897 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 s += n;
899 *s = '<';
900 }
901 return s;
902}
903
904 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100905add_msg_hist(
906 char_u *s,
907 int len, /* -1 for undetermined length */
908 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909{
910 struct msg_hist *p;
911
912 if (msg_hist_off || msg_silent != 0)
913 return;
914
915 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000916 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000917 (void)delete_first_msg();
918
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919 /* allocate an entry and add the message at the end of the history */
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200920 p = ALLOC_ONE(struct msg_hist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 if (p != NULL)
922 {
923 if (len < 0)
924 len = (int)STRLEN(s);
925 /* remove leading and trailing newlines */
926 while (len > 0 && *s == '\n')
927 {
928 ++s;
929 --len;
930 }
931 while (len > 0 && s[len - 1] == '\n')
932 --len;
933 p->msg = vim_strnsave(s, len);
934 p->next = NULL;
935 p->attr = attr;
936 if (last_msg_hist != NULL)
937 last_msg_hist->next = p;
938 last_msg_hist = p;
939 if (first_msg_hist == NULL)
940 first_msg_hist = last_msg_hist;
941 ++msg_hist_len;
942 }
943}
944
945/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000946 * Delete the first (oldest) message from the history.
947 * Returns FAIL if there are no messages.
948 */
949 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100950delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000951{
952 struct msg_hist *p;
953
954 if (msg_hist_len <= 0)
955 return FAIL;
956 p = first_msg_hist;
957 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000958 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200959 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000960 vim_free(p->msg);
961 vim_free(p);
962 --msg_hist_len;
963 return OK;
964}
965
966/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 * ":messages" command.
968 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200970ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971{
972 struct msg_hist *p;
973 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200974 int c = 0;
975
976 if (STRCMP(eap->arg, "clear") == 0)
977 {
978 int keep = eap->addr_count == 0 ? 0 : eap->line2;
979
980 while (msg_hist_len > keep)
981 (void)delete_first_msg();
982 return;
983 }
984
985 if (*eap->arg != NUL)
986 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100987 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200988 return;
989 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990
991 msg_hist_off = TRUE;
992
Bram Moolenaar451f8492016-04-14 17:16:22 +0200993 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200994 if (eap->addr_count != 0)
995 {
996 /* Count total messages */
997 for (; p != NULL && !got_int; p = p->next)
998 c++;
999
1000 c -= eap->line2;
1001
1002 /* Skip without number of messages specified */
1003 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
1004 p = p->next, c--);
1005 }
1006
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001007 if (p == first_msg_hist)
1008 {
1009 s = mch_getenv((char_u *)"LANG");
1010 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +02001011 // The next comment is extracted by xgettext and put in po file for
1012 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +01001013 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +02001014 // Translator: Please replace the name and email address
1015 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001016 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +01001017 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001018 }
1019
Bram Moolenaar451f8492016-04-14 17:16:22 +02001020 /* Display what was not skipped. */
1021 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001023 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 msg_hist_off = FALSE;
1026}
1027
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001028#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029/*
1030 * Call this after prompting the user. This will avoid a hit-return message
1031 * and a delay.
1032 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001033 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001034msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035{
1036 need_wait_return = FALSE;
1037 emsg_on_display = FALSE;
1038 cmdline_row = msg_row;
1039 msg_col = 0;
1040 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001041 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042}
1043#endif
1044
1045/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001046 * Wait for the user to hit a key (normally Enter).
1047 * If "redraw" is TRUE, clear and redraw the screen.
1048 * If "redraw" is FALSE, just redraw the screen.
1049 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 */
1051 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001052wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053{
1054 int c;
1055 int oldState;
1056 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001058 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001059 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060
1061 if (redraw == TRUE)
1062 must_redraw = CLEAR;
1063
1064 /* If using ":silent cmd", don't wait for a return. Also don't set
1065 * need_wait_return to do it later. */
1066 if (msg_silent != 0)
1067 return;
1068
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001069 /*
1070 * When inside vgetc(), we can't wait for a typed character at all.
1071 * With the global command (and some others) we only need one return at
1072 * the end. Adjust cmdline_row to avoid the next message overwriting the
1073 * last one.
1074 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001075 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001077 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 if (no_wait_return)
1079 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 if (!exmode_active)
1081 cmdline_row = msg_row;
1082 return;
1083 }
1084
1085 redir_off = TRUE; /* don't redirect this message */
1086 oldState = State;
1087 if (quit_more)
1088 {
1089 c = CAR; /* just pretend CR was hit */
1090 quit_more = FALSE;
1091 got_int = FALSE;
1092 }
1093 else if (exmode_active)
1094 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001095 msg_puts(" "); /* make sure the cursor is on the right line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 c = CAR; /* no need for a return in ex mode */
1097 got_int = FALSE;
1098 }
1099 else
1100 {
1101 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1102 * just changed. */
1103 screenalloc(FALSE);
1104
1105 State = HITRETURN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107#ifdef USE_ON_FLY_SCROLL
1108 dont_scroll = TRUE; /* disallow scrolling here */
1109#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001110 cmdline_row = msg_row;
1111
Bram Moolenaarec38d692013-04-24 15:12:32 +02001112 /* Avoid the sequence that the user types ":" at the hit-return prompt
1113 * to start an Ex command, but the file-changed dialog gets in the
1114 * way. */
1115 if (need_check_timestamps)
1116 check_timestamps(FALSE);
1117
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118 hit_return_msg();
1119
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 do
1121 {
1122 /* Remember "got_int", if it is set vgetc() probably returns a
1123 * CTRL-C, but we need to loop then. */
1124 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001125
1126 /* Don't do mappings here, we put the character back in the
1127 * typeahead buffer. */
1128 ++no_mapping;
1129 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001130
1131 /* Temporarily disable Recording. If Recording is active, the
1132 * character will be recorded later, since it will be added to the
1133 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001134 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001135 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001136 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001137 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001139 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001141 --no_mapping;
1142 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001143 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001144 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001145
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146#ifdef FEAT_CLIPBOARD
1147 /* Strange way to allow copying (yanking) a modeless selection at
1148 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1149 * Cmdline-mode and it's harmless when there is no selection. */
1150 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1151 {
1152 clip_copy_modeless_selection(TRUE);
1153 c = K_IGNORE;
1154 }
1155#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001156
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001157 /*
1158 * Allow scrolling back in the messages.
1159 * Also accept scroll-down commands when messages fill the screen,
1160 * to avoid that typing one 'j' too many makes the messages
1161 * disappear.
1162 */
1163 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001164 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001165 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1166 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001167 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001168 if (msg_scrolled > Rows)
1169 /* scroll back to show older messages */
1170 do_more_prompt(c);
1171 else
1172 {
1173 msg_didout = FALSE;
1174 c = K_IGNORE;
1175 msg_col =
1176#ifdef FEAT_RIGHTLEFT
1177 cmdmsg_rl ? Columns - 1 :
1178#endif
1179 0;
1180 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001181 if (quit_more)
1182 {
1183 c = CAR; /* just pretend CR was hit */
1184 quit_more = FALSE;
1185 got_int = FALSE;
1186 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001187 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001188 {
1189 c = K_IGNORE;
1190 hit_return_msg();
1191 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001192 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001193 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001194 && (c == 'j' || c == 'd' || c == 'f'
1195 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001196 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001197 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 } while ((had_got_int && c == Ctrl_C)
1199 || c == K_IGNORE
1200#ifdef FEAT_GUI
1201 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1202#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1204 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1205 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001206 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001208 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 || (!mouse_has(MOUSE_RETURN)
1210 && mouse_row < msg_row
1211 && (c == K_LEFTMOUSE
1212 || c == K_MIDDLEMOUSE
1213 || c == K_RIGHTMOUSE
1214 || c == K_X1MOUSE
1215 || c == K_X2MOUSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 );
1217 ui_breakcheck();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 /*
1219 * Avoid that the mouse-up event causes visual mode to start.
1220 */
1221 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1222 || c == K_X1MOUSE || c == K_X2MOUSE)
1223 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001224 else if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001226 /* Put the character back in the typeahead buffer. Don't use the
1227 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001228 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001230 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 }
1233 redir_off = FALSE;
1234
1235 /*
1236 * If the user hits ':', '?' or '/' we get a command line from the next
1237 * line.
1238 */
1239 if (c == ':' || c == '?' || c == '/')
1240 {
1241 if (!exmode_active)
1242 cmdline_row = msg_row;
1243 skip_redraw = TRUE; /* skip redraw once */
1244 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001245#ifdef FEAT_TERMINAL
1246 skip_term_loop = TRUE;
1247#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 }
1249
1250 /*
1251 * If the window size changed set_shellsize() will redraw the screen.
1252 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1253 * typed.
1254 */
1255 tmpState = State;
1256 State = oldState; /* restore State before set_shellsize */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 msg_check();
1259
1260#if defined(UNIX) || defined(VMS)
1261 /*
1262 * When switching screens, we need to output an extra newline on exit.
1263 */
1264 if (swapping_screen() && !termcap_active)
1265 newline_on_exit = TRUE;
1266#endif
1267
1268 need_wait_return = FALSE;
1269 did_wait_return = TRUE;
1270 emsg_on_display = FALSE; /* can delete error message now */
1271 lines_left = -1; /* reset lines_left at next msg_start() */
1272 reset_last_sourcing();
1273 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1274 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001275 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276
1277 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1278 {
1279 starttermcap(); /* start termcap before redrawing */
1280 shell_resized();
1281 }
1282 else if (!skip_redraw
1283 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1284 {
1285 starttermcap(); /* start termcap before redrawing */
1286 redraw_later(VALID);
1287 }
1288}
1289
1290/*
1291 * Write the hit-return prompt.
1292 */
1293 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001294hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001296 int save_p_more = p_more;
1297
1298 p_more = FALSE; /* don't want see this message when scrolling back */
1299 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 msg_putchar('\n');
1301 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001302 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303
Bram Moolenaar32526b32019-01-19 17:43:09 +01001304 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 if (!msg_use_printf())
1306 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001307 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308}
1309
1310/*
1311 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1312 */
1313 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001314set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315{
1316 vim_free(keep_msg);
1317 if (s != NULL && msg_silent == 0)
1318 keep_msg = vim_strsave(s);
1319 else
1320 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001321 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001322 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323}
1324
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001325#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1326/*
1327 * If there currently is a message being displayed, set "keep_msg" to it, so
1328 * that it will be displayed again after redraw.
1329 */
1330 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001331set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001332{
1333 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1334 && (State & NORMAL))
1335 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1336}
1337#endif
1338
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339/*
1340 * Prepare for outputting characters in the command line.
1341 */
1342 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001343msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344{
1345 int did_return = FALSE;
1346
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001347 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001348 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001349
1350#ifdef FEAT_EVAL
1351 if (need_clr_eos)
1352 {
1353 /* Halfway an ":echo" command and getting an (error) message: clear
1354 * any text from the command. */
1355 need_clr_eos = FALSE;
1356 msg_clr_eos();
1357 }
1358#endif
1359
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 if (!msg_scroll && full_screen) /* overwrite last message */
1361 {
1362 msg_row = cmdline_row;
1363 msg_col =
1364#ifdef FEAT_RIGHTLEFT
1365 cmdmsg_rl ? Columns - 1 :
1366#endif
1367 0;
1368 }
1369 else if (msg_didout) /* start message on next line */
1370 {
1371 msg_putchar('\n');
1372 did_return = TRUE;
1373 if (exmode_active != EXMODE_NORMAL)
1374 cmdline_row = msg_row;
1375 }
1376 if (!msg_didany || lines_left < 0)
1377 msg_starthere();
1378 if (msg_silent == 0)
1379 {
1380 msg_didout = FALSE; /* no output on current line yet */
1381 cursor_off();
1382 }
1383
1384 /* when redirecting, may need to start a new line. */
1385 if (!did_return)
1386 redir_write((char_u *)"\n", -1);
1387}
1388
1389/*
1390 * Note that the current msg position is where messages start.
1391 */
1392 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001393msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394{
1395 lines_left = cmdline_row;
1396 msg_didany = FALSE;
1397}
1398
1399 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001400msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401{
1402 msg_putchar_attr(c, 0);
1403}
1404
1405 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001406msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001408 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409
1410 if (IS_SPECIAL(c))
1411 {
1412 buf[0] = K_SPECIAL;
1413 buf[1] = K_SECOND(c);
1414 buf[2] = K_THIRD(c);
1415 buf[3] = NUL;
1416 }
1417 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001418 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001419 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420}
1421
1422 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001423msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001425 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
Bram Moolenaar32526b32019-01-19 17:43:09 +01001427 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 msg_puts(buf);
1429}
1430
1431 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001432msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433{
1434 msg_home_replace_attr(fname, 0);
1435}
1436
1437#if defined(FEAT_FIND_ID) || defined(PROTO)
1438 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001439msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001441 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442}
1443#endif
1444
1445 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001446msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447{
1448 char_u *name;
1449
1450 name = home_replace_save(NULL, fname);
1451 if (name != NULL)
1452 msg_outtrans_attr(name, attr);
1453 vim_free(name);
1454}
1455
1456/*
1457 * Output 'len' characters in 'str' (including NULs) with translation
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001458 * if 'len' is -1, output up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 * Use attributes 'attr'.
1460 * Return the number of characters it takes on the screen.
1461 */
1462 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001463msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464{
1465 return msg_outtrans_attr(str, 0);
1466}
1467
1468 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001469msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470{
1471 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1472}
1473
1474 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001475msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476{
1477 return msg_outtrans_len_attr(str, len, 0);
1478}
1479
1480/*
1481 * Output one character at "p". Return pointer to the next character.
1482 * Handles multi-byte characters.
1483 */
1484 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001485msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 int l;
1488
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001489 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 {
1491 msg_outtrans_len_attr(p, l, attr);
1492 return p + l;
1493 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001494 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 return p + 1;
1496}
1497
1498 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001499msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500{
1501 int retval = 0;
1502 char_u *str = msgstr;
1503 char_u *plain_start = msgstr;
1504 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 int mb_l;
1506 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507
1508 /* if MSG_HIST flag set, add message to history */
1509 if (attr & MSG_HIST)
1510 {
1511 add_msg_hist(str, len, attr);
1512 attr &= ~MSG_HIST;
1513 }
1514
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 /* If the string starts with a composing character first draw a space on
1516 * which the composing char can be drawn. */
1517 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001518 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519
1520 /*
1521 * Go over the string. Special characters are translated and printed.
1522 * Normal characters are printed several at a time.
1523 */
1524 while (--len >= 0)
1525 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 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)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001544 msg_puts_attr_len((char *)plain_start,
1545 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001547 msg_puts_attr((char *)transchar(c),
1548 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 retval += char2cells(c);
1550 }
1551 len -= mb_l - 1;
1552 str += mb_l;
1553 }
1554 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 {
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)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001562 msg_puts_attr_len((char *)plain_start,
1563 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001565 msg_puts_attr((char *)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 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001576 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
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/*
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001602 * Output the string 'str' up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 * 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,
Bram Moolenaar725310d2019-04-24 23:08:23 +02001618 int from, // TRUE for lhs of a mapping
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001619 int maxlen) // screen columns, 0 for unlimited
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620{
1621 char_u *str = strstart;
1622 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001623 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 int attr;
1625 int len;
1626
Bram Moolenaar8820b482017-03-16 17:23:31 +01001627 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 while (*str != NUL)
1629 {
1630 /* Leading and trailing spaces need to be displayed in <> form. */
1631 if ((str == strstart || str[1] == NUL) && *str == ' ')
1632 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001633 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 ++str;
1635 }
1636 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001637 text = (char *)str2special(&str, from);
1638 len = vim_strsize((char_u *)text);
Bram Moolenaar725310d2019-04-24 23:08:23 +02001639 if (maxlen > 0 && retval + len >= maxlen)
1640 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 /* Highlight special keys */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001642 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001643 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 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
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 if (has_mbyte)
1687 {
1688 char_u *p;
1689
1690 /* Try to un-escape a multi-byte character. Return the un-escaped
1691 * string if it is a multi-byte character. */
1692 p = mb_unescape(sp);
1693 if (p != NULL)
1694 return p;
1695 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696
1697 c = *str;
1698 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1699 {
1700 if (str[1] == KS_MODIFIER)
1701 {
1702 modifiers = str[2];
1703 str += 3;
1704 c = *str;
1705 }
1706 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1707 {
1708 c = TO_SPECIAL(str[1], str[2]);
1709 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 }
1711 if (IS_SPECIAL(c) || modifiers) /* special key */
1712 special = TRUE;
1713 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001715 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001717 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001718
1719 /* For multi-byte characters check for an illegal byte. */
1720 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1721 {
1722 transchar_nonprint(buf, c);
1723 *sp = str + 1;
1724 return buf;
1725 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001726 /* Since 'special' is TRUE the multi-byte character 'c' will be
1727 * processed by get_special_key_name() */
1728 c = (*mb_ptr2char)(str);
1729 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001731 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001732 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733
1734 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1735 * Use <Space> only for lhs of a mapping. */
1736 if (special || char2cells(c) > 1 || (from && c == ' '))
1737 return get_special_key_name(c, modifiers);
1738 buf[0] = c;
1739 buf[1] = NUL;
1740 return buf;
1741}
1742
1743/*
1744 * Translate a key sequence into special key names.
1745 */
1746 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001747str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748{
1749 char_u *s;
1750
1751 *buf = NUL;
1752 while (*sp)
1753 {
1754 s = str2special(&sp, FALSE);
1755 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1756 STRCAT(buf, s);
1757 }
1758}
1759
1760/*
1761 * print line for :print or :list command
1762 */
1763 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001764msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765{
1766 int c;
1767 int col = 0;
1768 int n_extra = 0;
1769 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001770 int c_final = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 char_u *p_extra = NULL; /* init to make SASC shut up */
1772 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001773 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 int l;
1776 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
Bram Moolenaardf177f62005-02-22 08:39:57 +00001778 if (curwin->w_p_list)
1779 list = TRUE;
1780
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001782 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 {
1784 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001785 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 --trail;
1787 }
1788
1789 /* output a space for an empty line, otherwise the line will be
1790 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001791 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 msg_putchar(' ');
1793
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001794 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001796 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 {
1798 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001799 if (n_extra == 0 && c_final)
1800 c = c_final;
1801 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 c = c_extra;
1803 else
1804 c = *p_extra++;
1805 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001806 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 {
1808 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001809 if (lcs_nbsp != NUL && list
1810 && (mb_ptr2char(s) == 160
1811 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001812 {
1813 mb_char2bytes(lcs_nbsp, buf);
1814 buf[(*mb_ptr2len)(buf)] = NUL;
1815 }
1816 else
1817 {
1818 mch_memmove(buf, s, (size_t)l);
1819 buf[l] = NUL;
1820 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001821 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 s += l;
1823 continue;
1824 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 else
1826 {
1827 attr = 0;
1828 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001829 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 {
1831 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001832#ifdef FEAT_VARTABS
1833 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1834 curbuf->b_p_vts_array) - 1;
1835#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001837#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001838 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 {
1840 c = ' ';
1841 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001842 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 }
1844 else
1845 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001846 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001848 c_final = lcs_tab3;
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;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001861 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 n_extra = 1;
1863 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001864 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 --s;
1866 }
1867 else if (c != NUL && (n = byte2cells(c)) > 1)
1868 {
1869 n_extra = n - 1;
1870 p_extra = transchar_byte(c);
1871 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001872 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001874 /* Use special coloring to be able to distinguish <hex> from
1875 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001876 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 }
1878 else if (c == ' ' && trail != NULL && s > trail)
1879 {
1880 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001881 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001883 else if (c == ' ' && list && lcs_space != NUL)
1884 {
1885 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001886 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 }
1889
1890 if (c == NUL)
1891 break;
1892
1893 msg_putchar_attr(c, attr);
1894 col++;
1895 }
1896 msg_clr_eos();
1897}
1898
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899/*
1900 * Use screen_puts() to output one multi-byte character.
1901 * Return the pointer "s" advanced to the next character.
1902 */
1903 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001904screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905{
1906 int cw;
1907
1908 msg_didout = TRUE; /* remember that line is not empty */
1909 cw = (*mb_ptr2cells)(s);
1910 if (cw > 1 && (
1911#ifdef FEAT_RIGHTLEFT
1912 cmdmsg_rl ? msg_col <= 1 :
1913#endif
1914 msg_col == Columns - 1))
1915 {
1916 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001917 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 return s;
1919 }
1920
1921 screen_puts_len(s, l, msg_row, msg_col, attr);
1922#ifdef FEAT_RIGHTLEFT
1923 if (cmdmsg_rl)
1924 {
1925 msg_col -= cw;
1926 if (msg_col == 0)
1927 {
1928 msg_col = Columns;
1929 ++msg_row;
1930 }
1931 }
1932 else
1933#endif
1934 {
1935 msg_col += cw;
1936 if (msg_col >= Columns)
1937 {
1938 msg_col = 0;
1939 ++msg_row;
1940 }
1941 }
1942 return s + l;
1943}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944
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 Moolenaar32526b32019-01-19 17:43:09 +01001950msg_puts(char *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 Moolenaar32526b32019-01-19 17:43:09 +01001956msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001958 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959}
1960
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961/*
1962 * Show a message in such a way that it always fits in the line. Cut out a
1963 * part in the middle and replace it with "..." when necessary.
1964 * Does not handle multi-byte characters!
1965 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001966 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001967msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968{
1969 int slen = len;
1970 int room;
1971
1972 room = Columns - msg_col;
1973 if (len > room && room >= 20)
1974 {
1975 slen = (room - 3) / 2;
1976 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001977 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 }
1979 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1980}
1981
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001982 void
1983msg_outtrans_long_attr(char_u *longstr, int attr)
1984{
1985 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1986}
1987
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988/*
1989 * Basic function for writing a message with highlight attributes.
1990 */
1991 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001992msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993{
1994 msg_puts_attr_len(s, -1, attr);
1995}
1996
1997/*
1998 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1999 * When "maxlen" is -1 there is no maximum length.
2000 * When "maxlen" is >= 0 the message is not put in the history.
2001 */
2002 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01002003msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 /*
2006 * If redirection is on, also write to the redirection file.
2007 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01002008 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009
2010 /*
2011 * Don't print anything when using ":silent cmd".
2012 */
2013 if (msg_silent != 0)
2014 return;
2015
2016 /* if MSG_HIST flag set, add message to history */
2017 if ((attr & MSG_HIST) && maxlen < 0)
2018 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002019 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 attr &= ~MSG_HIST;
2021 }
2022
Bram Moolenaare8070982019-10-12 17:07:06 +02002023 // When writing something to the screen after it has scrolled, requires a
2024 // wait-return prompt later. Needed when scrolling, resetting
2025 // need_wait_return after some prompt, and then outputting something
2026 // without scrolling
2027 // Not needed when only using CR to move the cursor.
2028 if (msg_scrolled != 0 && !msg_scrolled_ign && STRCMP(str, "\r") != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 need_wait_return = TRUE;
Bram Moolenaare8070982019-10-12 17:07:06 +02002030 msg_didany = TRUE; // remember that something was outputted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
2032 /*
2033 * If there is no valid screen, use fprintf so we can see error messages.
2034 * If termcap is not active, we may be writing in an alternate console
2035 * window, cursor positioning may not work correctly (window size may be
2036 * different, e.g. for Win32 console) or we just don't know where the
2037 * cursor is.
2038 */
2039 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002040 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002041 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002042 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002043}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002045/*
2046 * The display part of msg_puts_attr_len().
2047 * May be called recursively to display scroll-back text.
2048 */
2049 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002050msg_puts_display(
2051 char_u *str,
2052 int maxlen,
2053 int attr,
2054 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002055{
2056 char_u *s = str;
2057 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2058 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002059 int l;
2060 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002061 char_u *sb_str = str;
2062 int sb_col = msg_col;
2063 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002064 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065
2066 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002067 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 {
2069 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002070 * We are at the end of the screen line when:
2071 * - When outputting a newline.
2072 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002074 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075#ifdef FEAT_RIGHTLEFT
2076 cmdmsg_rl
2077 ? (
2078 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002079 || (*s == TAB && msg_col <= 7)
2080 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 :
2082#endif
Bram Moolenaar0efd1bd2019-12-11 19:00:04 +01002083 ((*s != '\r' && msg_col + t_col >= Columns - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002086 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 /*
2089 * The screen is scrolled up when at the last row (some terminals
2090 * scroll automatically, some don't. To avoid problems we scroll
2091 * ourselves).
2092 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002095 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002097 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 if (msg_no_more && lines_left == 0)
2099 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002101 /* Scroll the screen up one line. */
2102 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103
2104 msg_row = Rows - 2;
2105 if (msg_col >= Columns) /* can happen after screen resize */
2106 msg_col = Columns - 1;
2107
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002108 /* Display char in last column before showing more-prompt. */
2109 if (*s >= ' '
2110#ifdef FEAT_RIGHTLEFT
2111 && !cmdmsg_rl
2112#endif
2113 )
2114 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002115 if (has_mbyte)
2116 {
2117 if (enc_utf8 && maxlen >= 0)
2118 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002119 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002120 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002121 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002122 s = screen_puts_mbyte(s, l, attr);
2123 }
2124 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002125 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002126 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002127 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002128 else
2129 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002130
2131 if (p_more)
2132 /* store text for scrolling back */
2133 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2134
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002135 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002136 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 redraw_cmdline = TRUE;
2138 if (cmdline_row > 0 && !exmode_active)
2139 --cmdline_row;
2140
2141 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002142 * If screen is completely filled and 'more' is set then wait
2143 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002145 if (lines_left > 0)
2146 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002147 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 && !msg_no_more && !exmode_active)
2149 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002151 if (do_more_prompt(NUL))
2152 s = confirm_msg_tail;
2153#else
2154 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155#endif
2156 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002157 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002159
2160 /* When we displayed a char in last column need to check if there
2161 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002162 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002163 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 }
2165
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002166 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002169 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002170 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2171 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002173 t_puts(&t_col, t_s, s, attr);
2174
2175 if (wrap && p_more && !recurse)
2176 /* store text for scrolling back */
2177 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
2179 if (*s == '\n') /* go to next line */
2180 {
2181 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002182#ifdef FEAT_RIGHTLEFT
2183 if (cmdmsg_rl)
2184 msg_col = Columns - 1;
2185 else
2186#endif
2187 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 if (++msg_row >= Rows) /* safety check */
2189 msg_row = Rows - 1;
2190 }
2191 else if (*s == '\r') /* go to column 0 */
2192 {
2193 msg_col = 0;
2194 }
2195 else if (*s == '\b') /* go to previous char */
2196 {
2197 if (msg_col)
2198 --msg_col;
2199 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002200 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 {
2202 do
2203 msg_screen_putchar(' ', attr);
2204 while (msg_col & 7);
2205 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002206 else if (*s == BELL) /* beep (from ":sh") */
2207 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 else
2209 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 if (has_mbyte)
2211 {
2212 cw = (*mb_ptr2cells)(s);
2213 if (enc_utf8 && maxlen >= 0)
2214 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002215 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002217 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 }
2219 else
2220 {
2221 cw = 1;
2222 l = 1;
2223 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002224
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 /* When drawing from right to left or when a double-wide character
2226 * doesn't fit, draw a single character here. Otherwise collect
2227 * characters and draw them all at once later. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 if (
2229# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002230 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002232 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 if (l > 1)
2235 s = screen_puts_mbyte(s, l, attr) - 1;
2236 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 msg_screen_putchar(*s, attr);
2238 }
2239 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 {
2241 /* postpone this character until later */
2242 if (t_col == 0)
2243 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 t_col += cw;
2245 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 }
2247 }
2248 ++s;
2249 }
2250
2251 /* output any postponed text */
2252 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002253 t_puts(&t_col, t_s, s, attr);
2254 if (p_more && !recurse)
2255 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256
2257 msg_check();
2258}
2259
2260/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002261 * Return TRUE when ":filter pattern" was used and "msg" does not match
2262 * "pattern".
2263 */
2264 int
2265message_filtered(char_u *msg)
2266{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002267 int match;
2268
2269 if (cmdmod.filter_regmatch.regprog == NULL)
2270 return FALSE;
2271 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2272 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002273}
2274
2275/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002276 * Scroll the screen up one line for displaying the next message line.
2277 */
2278 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002279msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002280{
2281#ifdef FEAT_GUI
2282 /* Remove the cursor before scrolling, ScreenLines[] is going
2283 * to become invalid. */
2284 if (gui.in_use)
2285 gui_undraw_cursor();
2286#endif
2287 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002288 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002289 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002290 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002291
2292 if (!can_clear((char_u *)" "))
2293 {
2294 /* Scrolling up doesn't result in the right background. Set the
2295 * background here. It's not efficient, but avoids that we have to do
2296 * it all over the code. */
2297 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2298
2299 /* Also clear the last char of the last but one line if it was not
2300 * cleared before to avoid a scroll-up. */
2301 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2302 screen_fill((int)Rows - 2, (int)Rows - 1,
2303 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2304 }
2305}
2306
2307/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002308 * Increment "msg_scrolled".
2309 */
2310 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002311inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002312{
2313#ifdef FEAT_EVAL
2314 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2315 {
2316 char_u *p = sourcing_name;
2317 char_u *tofree = NULL;
2318 int len;
2319
2320 /* v:scrollstart is empty, set it to the script/function name and line
2321 * number */
2322 if (p == NULL)
2323 p = (char_u *)_("Unknown");
2324 else
2325 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002326 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002327 tofree = alloc(len);
2328 if (tofree != NULL)
2329 {
2330 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2331 p, (long)sourcing_lnum);
2332 p = tofree;
2333 }
2334 }
2335 set_vim_var_string(VV_SCROLLSTART, p, -1);
2336 vim_free(tofree);
2337 }
2338#endif
2339 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002340 if (must_redraw < VALID)
2341 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002342}
2343
2344/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002345 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2346 * store the displayed text and remember where screen lines start.
2347 */
2348typedef struct msgchunk_S msgchunk_T;
2349struct msgchunk_S
2350{
2351 msgchunk_T *sb_next;
2352 msgchunk_T *sb_prev;
2353 char sb_eol; /* TRUE when line ends after this text */
2354 int sb_msg_col; /* column in which text starts */
2355 int sb_attr; /* text attributes */
2356 char_u sb_text[1]; /* text to be displayed, actually longer */
2357};
2358
2359static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2360
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002361static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002362
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002363typedef enum {
2364 SB_CLEAR_NONE = 0,
2365 SB_CLEAR_ALL,
2366 SB_CLEAR_CMDLINE_BUSY,
2367 SB_CLEAR_CMDLINE_DONE
2368} sb_clear_T;
2369
2370/* When to clear text on next msg. */
2371static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002372
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002373/*
2374 * Store part of a printed message for displaying when scrolling back.
2375 */
2376 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002377store_sb_text(
2378 char_u **sb_str, /* start of string */
2379 char_u *s, /* just after string */
2380 int attr,
2381 int *sb_col,
2382 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002383{
2384 msgchunk_T *mp;
2385
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002386 if (do_clear_sb_text == SB_CLEAR_ALL
2387 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002388 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002389 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2390 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002391 }
2392
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002393 if (s > *sb_str)
2394 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002395 mp = alloc(sizeof(msgchunk_T) + (s - *sb_str));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002396 if (mp != NULL)
2397 {
2398 mp->sb_eol = finish;
2399 mp->sb_msg_col = *sb_col;
2400 mp->sb_attr = attr;
2401 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2402
2403 if (last_msgchunk == NULL)
2404 {
2405 last_msgchunk = mp;
2406 mp->sb_prev = NULL;
2407 }
2408 else
2409 {
2410 mp->sb_prev = last_msgchunk;
2411 last_msgchunk->sb_next = mp;
2412 last_msgchunk = mp;
2413 }
2414 mp->sb_next = NULL;
2415 }
2416 }
2417 else if (finish && last_msgchunk != NULL)
2418 last_msgchunk->sb_eol = TRUE;
2419
2420 *sb_str = s;
2421 *sb_col = 0;
2422}
2423
2424/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002425 * Finished showing messages, clear the scroll-back text on the next message.
2426 */
2427 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002428may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002429{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002430 do_clear_sb_text = SB_CLEAR_ALL;
2431}
2432
2433/*
2434 * Starting to edit the command line, do not clear messages now.
2435 */
2436 void
2437sb_text_start_cmdline(void)
2438{
2439 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2440 msg_sb_eol();
2441}
2442
2443/*
2444 * Ending to edit the command line. Clear old lines but the last one later.
2445 */
2446 void
2447sb_text_end_cmdline(void)
2448{
2449 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002450}
2451
2452/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002453 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002454 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002455 * Called when redrawing the screen.
2456 */
2457 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002458clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002459{
2460 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002461 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002462
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002463 if (all)
2464 lastp = &last_msgchunk;
2465 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002466 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002467 if (last_msgchunk == NULL)
2468 return;
2469 lastp = &last_msgchunk->sb_prev;
2470 }
2471
2472 while (*lastp != NULL)
2473 {
2474 mp = (*lastp)->sb_prev;
2475 vim_free(*lastp);
2476 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002477 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002478}
2479
2480/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002481 * "g<" command.
2482 */
2483 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002484show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002485{
2486 msgchunk_T *mp;
2487
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002488 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002489 * weird, typing a command without output results in one line. */
2490 mp = msg_sb_start(last_msgchunk);
2491 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002492 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002493 else
2494 {
2495 do_more_prompt('G');
2496 wait_return(FALSE);
2497 }
2498}
2499
2500/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002501 * Move to the start of screen line in already displayed text.
2502 */
2503 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002504msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002505{
2506 msgchunk_T *mp = mps;
2507
2508 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2509 mp = mp->sb_prev;
2510 return mp;
2511}
2512
2513/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002514 * Mark the last message chunk as finishing the line.
2515 */
2516 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002517msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002518{
2519 if (last_msgchunk != NULL)
2520 last_msgchunk->sb_eol = TRUE;
2521}
2522
2523/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002524 * Display a screen line from previously displayed text at row "row".
2525 * Returns a pointer to the text for the next line (can be NULL).
2526 */
2527 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002528disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002529{
2530 msgchunk_T *mp = smp;
2531 char_u *p;
2532
2533 for (;;)
2534 {
2535 msg_row = row;
2536 msg_col = mp->sb_msg_col;
2537 p = mp->sb_text;
2538 if (*p == '\n') /* don't display the line break */
2539 ++p;
2540 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2541 if (mp->sb_eol || mp->sb_next == NULL)
2542 break;
2543 mp = mp->sb_next;
2544 }
2545 return mp->sb_next;
2546}
2547
2548/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 * Output any postponed text for msg_puts_attr_len().
2550 */
2551 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002552t_puts(
2553 int *t_col,
2554 char_u *t_s,
2555 char_u *s,
2556 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557{
2558 /* output postponed text */
2559 msg_didout = TRUE; /* remember that line is not empty */
2560 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002561 msg_col += *t_col;
2562 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 /* If the string starts with a composing character don't increment the
2564 * column position for it. */
2565 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2566 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 if (msg_col >= Columns)
2568 {
2569 msg_col = 0;
2570 ++msg_row;
2571 }
2572}
2573
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574/*
2575 * Returns TRUE when messages should be printed with mch_errmsg().
2576 * This is used when there is no valid screen, so we can see error messages.
2577 * If termcap is not active, we may be writing in an alternate console
2578 * window, cursor positioning may not work correctly (window size may be
2579 * different, e.g. for Win32 console) or we just don't know where the
2580 * cursor is.
2581 */
2582 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002583msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584{
2585 return (!msg_check_screen()
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002586#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2587# ifdef VIMDLL
2588 || (!gui.in_use && !termcap_active)
2589# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 || !termcap_active
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002591# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592#endif
2593 || (swapping_screen() && !termcap_active)
2594 );
2595}
2596
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002597/*
2598 * Print a message when there is no valid screen.
2599 */
2600 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002601msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002602{
2603 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002604 char_u *buf = NULL;
2605 char_u *p = s;
2606
Bram Moolenaar4f974752019-02-17 17:44:42 +01002607#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002608 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002609 mch_settmode(TMODE_COOK); /* handle CR and NL correctly */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002610#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002611 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002612 {
2613 if (!(silent_mode && p_verbose == 0))
2614 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002615 // NL --> CR NL translation (for Unix, not for "--version")
2616 if (*s == NL)
2617 {
2618 int n = (int)(s - p);
2619
2620 buf = alloc(n + 3);
Bram Moolenaar6f10c702019-08-20 22:58:37 +02002621 if (buf != NULL)
2622 {
2623 memcpy(buf, p, n);
2624 if (!info_message)
2625 buf[n++] = CAR;
2626 buf[n++] = NL;
2627 buf[n++] = NUL;
2628 if (info_message) // informative message, not an error
2629 mch_msg((char *)buf);
2630 else
2631 mch_errmsg((char *)buf);
2632 vim_free(buf);
2633 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002634 p = s + 1;
2635 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002636 }
2637
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002638 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639#ifdef FEAT_RIGHTLEFT
2640 if (cmdmsg_rl)
2641 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002642 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002643 msg_col = Columns - 1;
2644 else
2645 --msg_col;
2646 }
2647 else
2648#endif
2649 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002650 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002651 msg_col = 0;
2652 else
2653 ++msg_col;
2654 }
2655 ++s;
2656 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002657
2658 if (*p != NUL && !(silent_mode && p_verbose == 0))
2659 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002660 int c = -1;
2661
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002662 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002663 {
2664 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002665 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002666 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002667 if (info_message)
2668 mch_msg((char *)p);
2669 else
2670 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002671 if (c != -1)
2672 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002673 }
2674
2675 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002676
Bram Moolenaar4f974752019-02-17 17:44:42 +01002677#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002678 if (!(silent_mode && p_verbose == 0))
2679 mch_settmode(TMODE_RAW);
2680#endif
2681}
2682
2683/*
2684 * Show the more-prompt and handle the user response.
2685 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002686 * When at hit-enter prompt "typed_char" is the already typed character,
2687 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002688 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2689 */
2690 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002691do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002692{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002693 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002694 int used_typed_char = typed_char;
2695 int oldState = State;
2696 int c;
2697#ifdef FEAT_CON_DIALOG
2698 int retval = FALSE;
2699#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002700 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002701 msgchunk_T *mp_last = NULL;
2702 msgchunk_T *mp;
2703 int i;
2704
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002705 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002706 * that case don't show another prompt. Also when at the hit-Enter prompt
2707 * and nothing was typed. */
2708 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002709 return FALSE;
2710 entered = TRUE;
2711
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002712 if (typed_char == 'G')
2713 {
2714 /* "g<": Find first line on the last page. */
2715 mp_last = msg_sb_start(last_msgchunk);
2716 for (i = 0; i < Rows - 2 && mp_last != NULL
2717 && mp_last->sb_prev != NULL; ++i)
2718 mp_last = msg_sb_start(mp_last->sb_prev);
2719 }
2720
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002721 State = ASKMORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002722 setmouse();
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002723 if (typed_char == NUL)
2724 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002725 for (;;)
2726 {
2727 /*
2728 * Get a typed character directly from the user.
2729 */
2730 if (used_typed_char != NUL)
2731 {
2732 c = used_typed_char; /* was typed at hit-enter prompt */
2733 used_typed_char = NUL;
2734 }
2735 else
2736 c = get_keystroke();
2737
2738#if defined(FEAT_MENU) && defined(FEAT_GUI)
2739 if (c == K_MENU)
2740 {
2741 int idx = get_menu_index(current_menu, ASKMORE);
2742
2743 /* Used a menu. If it starts with CTRL-Y, it must
2744 * be a "Copy" for the clipboard. Otherwise
2745 * assume that we end */
2746 if (idx == MENU_INDEX_INVALID)
2747 continue;
2748 c = *current_menu->strings[idx];
2749 if (c != NUL && current_menu->strings[idx][1] != NUL)
2750 ins_typebuf(current_menu->strings[idx] + 1,
2751 current_menu->noremap[idx], 0, TRUE,
2752 current_menu->silent[idx]);
2753 }
2754#endif
2755
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002756 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002757 switch (c)
2758 {
2759 case BS: /* scroll one line back */
2760 case K_BS:
2761 case 'k':
2762 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002763 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002764 break;
2765
2766 case CAR: /* one extra line */
2767 case NL:
2768 case 'j':
2769 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002770 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002771 break;
2772
2773 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002774 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002775 break;
2776
2777 case 'd': /* Down 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 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002782 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002783 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002784 break;
2785
2786 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002787 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002788 case K_PAGEDOWN:
2789 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002790 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002791 break;
2792
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002793 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002794 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002795 break;
2796
2797 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002798 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002799 lines_left = 999999;
2800 break;
2801
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002802 case ':': /* start new command line */
2803#ifdef FEAT_CON_DIALOG
2804 if (!confirm_msg_used)
2805#endif
2806 {
2807 /* Since got_int is set all typeahead will be flushed, but we
2808 * want to keep this ':', remember that in a special way. */
2809 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002810#ifdef FEAT_TERMINAL
2811 skip_term_loop = TRUE;
2812#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002813 cmdline_row = Rows - 1; /* put ':' on this line */
2814 skip_redraw = TRUE; /* skip redraw once */
2815 need_wait_return = FALSE; /* don't wait in main() */
2816 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002817 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002818 case 'q': /* quit */
2819 case Ctrl_C:
2820 case ESC:
2821#ifdef FEAT_CON_DIALOG
2822 if (confirm_msg_used)
2823 {
2824 /* Jump to the choices of the dialog. */
2825 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002826 }
2827 else
2828#endif
2829 {
2830 got_int = TRUE;
2831 quit_more = TRUE;
2832 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002833 /* When there is some more output (wrapping line) display that
2834 * without another prompt. */
2835 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002836 break;
2837
2838#ifdef FEAT_CLIPBOARD
2839 case Ctrl_Y:
2840 /* Strange way to allow copying (yanking) a modeless
2841 * selection at the more prompt. Use CTRL-Y,
2842 * because the same is used in Cmdline-mode and at the
2843 * hit-enter prompt. However, scrolling one line up
2844 * might be expected... */
2845 if (clip_star.state == SELECT_DONE)
2846 clip_copy_modeless_selection(TRUE);
2847 continue;
2848#endif
2849 default: /* no valid response */
2850 msg_moremsg(TRUE);
2851 continue;
2852 }
2853
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002854 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002855 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002856 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002857 {
2858 /* go to start of last line */
2859 if (mp_last == NULL)
2860 mp = msg_sb_start(last_msgchunk);
2861 else if (mp_last->sb_prev != NULL)
2862 mp = msg_sb_start(mp_last->sb_prev);
2863 else
2864 mp = NULL;
2865
2866 /* go to start of line at top of the screen */
2867 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2868 ++i)
2869 mp = msg_sb_start(mp->sb_prev);
2870
2871 if (mp != NULL && mp->sb_prev != NULL)
2872 {
2873 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002874 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002875 {
2876 if (mp == NULL || mp->sb_prev == NULL)
2877 break;
2878 mp = msg_sb_start(mp->sb_prev);
2879 if (mp_last == NULL)
2880 mp_last = msg_sb_start(last_msgchunk);
2881 else
2882 mp_last = msg_sb_start(mp_last->sb_prev);
2883 }
2884
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002885 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002886 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002887 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002888 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002889 (void)disp_sb_line(0, mp);
2890 }
2891 else
2892 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002893 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002894 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002895 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2896 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002897 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002898 ++msg_scrolled;
2899 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002900 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002901 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002902 }
2903 }
2904 else
2905 {
2906 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002907 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002908 {
2909 /* scroll up, display line at bottom */
2910 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002911 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002912 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2913 (int)Columns, ' ', ' ', 0);
2914 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002915 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002916 }
2917 }
2918
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002919 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002920 {
2921 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002922 screen_fill((int)Rows - 1, (int)Rows, 0,
2923 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002924 msg_moremsg(FALSE);
2925 continue;
2926 }
2927
2928 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002929 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002930 }
2931
2932 break;
2933 }
2934
2935 /* clear the --more-- message */
2936 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2937 State = oldState;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002938 setmouse();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002939 if (quit_more)
2940 {
2941 msg_row = Rows - 1;
2942 msg_col = 0;
2943 }
2944#ifdef FEAT_RIGHTLEFT
2945 else if (cmdmsg_rl)
2946 msg_col = Columns - 1;
2947#endif
2948
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002949 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002950#ifdef FEAT_CON_DIALOG
2951 return retval;
2952#else
2953 return FALSE;
2954#endif
2955}
2956
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2958
2959#ifdef mch_errmsg
2960# undef mch_errmsg
2961#endif
2962#ifdef mch_msg
2963# undef mch_msg
2964#endif
2965
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002966#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2967 static void
2968mch_errmsg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002970 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002971 DWORD nwrite = 0;
2972 DWORD mode = 0;
2973 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
2974
2975 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
2976 && (int)GetConsoleCP() != enc_codepage)
2977 {
2978 WCHAR *w = enc_to_utf16((char_u *)str, &len);
2979
2980 WriteConsoleW(h, w, len, &nwrite, NULL);
2981 vim_free(w);
2982 }
2983 else
2984 {
2985 fprintf(stderr, "%s", str);
2986 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002987}
2988#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002990/*
2991 * Give an error message. To be used when the screen hasn't been initialized
2992 * yet. When stderr can't be used, collect error messages until the GUI has
2993 * started and they can be displayed in a message box.
2994 */
2995 void
2996mch_errmsg(char *str)
2997{
2998#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
2999 int len;
3000#endif
3001
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003002#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 /* On Unix use stderr if it's a tty.
3004 * When not going to start the GUI also use stderr.
3005 * On Mac, when started from Finder, stderr is the console. */
3006 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003007# ifdef UNIX
3008# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003010# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 isatty(2)
3012# endif
3013# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003014 ||
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003015# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003016# endif
3017# ifdef FEAT_GUI
3018 !(gui.in_use || gui.starting)
3019# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 )
3021 {
3022 fprintf(stderr, "%s", str);
3023 return;
3024 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003025#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003027#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3028# ifdef VIMDLL
3029 if (!(gui.in_use || gui.starting))
3030# endif
3031 {
3032 mch_errmsg_c(str);
3033 return;
3034 }
3035#endif
3036
3037#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 /* avoid a delay for a message that isn't there */
3039 emsg_on_display = FALSE;
3040
3041 len = (int)STRLEN(str) + 1;
3042 if (error_ga.ga_growsize == 0)
3043 {
3044 error_ga.ga_growsize = 80;
3045 error_ga.ga_itemsize = 1;
3046 }
3047 if (ga_grow(&error_ga, len) == OK)
3048 {
3049 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3050 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003051# ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 /* remove CR characters, they are displayed */
3053 {
3054 char_u *p;
3055
3056 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3057 for (;;)
3058 {
3059 p = vim_strchr(p, '\r');
3060 if (p == NULL)
3061 break;
3062 *p = ' ';
3063 }
3064 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003065# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 --len; /* don't count the NUL at the end */
3067 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003069#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070}
3071
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003072#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3073 static void
3074mch_msg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003076 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003077 DWORD nwrite = 0;
3078 DWORD mode;
3079 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3080
3081
3082 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3083 && (int)GetConsoleCP() != enc_codepage)
3084 {
3085 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3086
3087 WriteConsoleW(h, w, len, &nwrite, NULL);
3088 vim_free(w);
3089 }
3090 else
3091 {
3092 printf("%s", str);
3093 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003094}
3095#endif
3096
3097/*
3098 * Give a message. To be used when the screen hasn't been initialized yet.
3099 * When there is no tty, collect messages until the GUI has started and they
3100 * can be displayed in a message box.
3101 */
3102 void
3103mch_msg(char *str)
3104{
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003105#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3107 * uses mch_errmsg() when started from the desktop.
3108 * When not going to start the GUI also use stdout.
3109 * On Mac, when started from Finder, stderr is the console. */
3110 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003111# ifdef UNIX
3112# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003114# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 isatty(2)
Bram Moolenaareae1b912019-05-09 15:12:55 +02003116# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003118 ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003120# endif
3121# ifdef FEAT_GUI
3122 !(gui.in_use || gui.starting)
3123# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 )
3125 {
3126 printf("%s", str);
3127 return;
3128 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003129#endif
3130
3131#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3132# ifdef VIMDLL
3133 if (!(gui.in_use || gui.starting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003135 {
3136 mch_msg_c(str);
3137 return;
3138 }
3139#endif
3140#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003142#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143}
3144#endif /* USE_MCH_ERRMSG */
3145
3146/*
3147 * Put a character on the screen at the current message position and advance
3148 * to the next position. Only for printable ASCII!
3149 */
3150 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003151msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152{
3153 msg_didout = TRUE; /* remember that line is not empty */
3154 screen_putchar(c, msg_row, msg_col, attr);
3155#ifdef FEAT_RIGHTLEFT
3156 if (cmdmsg_rl)
3157 {
3158 if (--msg_col == 0)
3159 {
3160 msg_col = Columns;
3161 ++msg_row;
3162 }
3163 }
3164 else
3165#endif
3166 {
3167 if (++msg_col >= Columns)
3168 {
3169 msg_col = 0;
3170 ++msg_row;
3171 }
3172 }
3173}
3174
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003175 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003176msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003178 int attr;
3179 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180
Bram Moolenaar8820b482017-03-16 17:23:31 +01003181 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003182 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003184 screen_puts((char_u *)
3185 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3186 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187}
3188
3189/*
3190 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3191 * exmode_active.
3192 */
3193 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003194repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195{
3196 if (State == ASKMORE)
3197 {
3198 msg_moremsg(TRUE); /* display --more-- message again */
3199 msg_row = Rows - 1;
3200 }
3201#ifdef FEAT_CON_DIALOG
3202 else if (State == CONFIRM)
3203 {
3204 display_confirm_msg(); /* display ":confirm" message again */
3205 msg_row = Rows - 1;
3206 }
3207#endif
3208 else if (State == EXTERNCMD)
3209 {
3210 windgoto(msg_row, msg_col); /* put cursor back */
3211 }
3212 else if (State == HITRETURN || State == SETWSIZE)
3213 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003214 if (msg_row == Rows - 1)
3215 {
3216 /* Avoid drawing the "hit-enter" prompt below the previous one,
3217 * overwrite it. Esp. useful when regaining focus and a
3218 * FocusGained autocmd exists but didn't draw anything. */
3219 msg_didout = FALSE;
3220 msg_col = 0;
3221 msg_clr_eos();
3222 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 hit_return_msg();
3224 msg_row = Rows - 1;
3225 }
3226}
3227
3228/*
3229 * msg_check_screen - check if the screen is initialized.
3230 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3231 * While starting the GUI the terminal codes will be set for the GUI, but the
3232 * output goes to the terminal. Don't use the terminal codes then.
3233 */
3234 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003235msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236{
3237 if (!full_screen || !screen_valid(FALSE))
3238 return FALSE;
3239
3240 if (msg_row >= Rows)
3241 msg_row = Rows - 1;
3242 if (msg_col >= Columns)
3243 msg_col = Columns - 1;
3244 return TRUE;
3245}
3246
3247/*
3248 * Clear from current message position to end of screen.
3249 * Skip this when ":silent" was used, no need to clear for redirection.
3250 */
3251 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003252msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253{
3254 if (msg_silent == 0)
3255 msg_clr_eos_force();
3256}
3257
3258/*
3259 * Clear from current message position to end of screen.
3260 * Note: msg_col is not updated, so we remember the end of the message
3261 * for msg_check().
3262 */
3263 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003264msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265{
3266 if (msg_use_printf())
3267 {
3268 if (full_screen) /* only when termcap codes are valid */
3269 {
3270 if (*T_CD)
3271 out_str(T_CD); /* clear to end of display */
3272 else if (*T_CE)
3273 out_str(T_CE); /* clear to end of line */
3274 }
3275 }
3276 else
3277 {
3278#ifdef FEAT_RIGHTLEFT
3279 if (cmdmsg_rl)
3280 {
3281 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3282 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3283 }
3284 else
3285#endif
3286 {
3287 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3288 ' ', ' ', 0);
3289 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3290 }
3291 }
3292}
3293
3294/*
3295 * Clear the command line.
3296 */
3297 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003298msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299{
3300 msg_row = cmdline_row;
3301 msg_col = 0;
3302 msg_clr_eos_force();
3303}
3304
3305/*
3306 * end putting a message on the screen
3307 * call wait_return if the message does not fit in the available space
3308 * return TRUE if wait_return not called.
3309 */
3310 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003311msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312{
3313 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003314 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 * or the ruler option is set and we run into it,
3316 * we have to redraw the window.
3317 * Do not do this if we are abandoning the file or editing the command line.
3318 */
3319 if (!exiting && need_wait_return && !(State & CMDLINE))
3320 {
3321 wait_return(FALSE);
3322 return FALSE;
3323 }
3324 out_flush();
3325 return TRUE;
3326}
3327
3328/*
3329 * If the written message runs into the shown command or ruler, we have to
3330 * wait for hit-return and redraw the window later.
3331 */
3332 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003333msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334{
3335 if (msg_row == Rows - 1 && msg_col >= sc_col)
3336 {
3337 need_wait_return = TRUE;
3338 redraw_cmdline = TRUE;
3339 }
3340}
3341
3342/*
3343 * May write a string to the redirection file.
3344 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3345 */
3346 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003347redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348{
3349 char_u *s = str;
3350 static int cur_col = 0;
3351
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003352 /* Don't do anything for displaying prompts and the like. */
3353 if (redir_off)
3354 return;
3355
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003356 /* If 'verbosefile' is set prepare for writing in that file. */
3357 if (*p_vfile != NUL && verbose_fd == NULL)
3358 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003359
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003360 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {
3362 /* If the string doesn't start with CR or NL, go to msg_col */
3363 if (*s != '\n' && *s != '\r')
3364 {
3365 while (cur_col < msg_col)
3366 {
3367#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003368 if (redir_execute)
3369 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003370 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003372 else if (redir_vname)
3373 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003374 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003376 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003378 if (verbose_fd != NULL)
3379 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 ++cur_col;
3381 }
3382 }
3383
3384#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003385 if (redir_execute)
3386 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003387 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003389 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003390 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391#endif
3392
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003393 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3395 {
3396#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003397 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003399 if (redir_fd != NULL)
3400 putc(*s, redir_fd);
3401 if (verbose_fd != NULL)
3402 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 if (*s == '\r' || *s == '\n')
3404 cur_col = 0;
3405 else if (*s == '\t')
3406 cur_col += (8 - cur_col % 8);
3407 else
3408 ++cur_col;
3409 ++s;
3410 }
3411
3412 if (msg_silent != 0) /* should update msg_col */
3413 msg_col = cur_col;
3414 }
3415}
3416
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003417 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003418redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003419{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003420 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003421#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003422 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003423#endif
3424 ;
3425}
3426
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003428 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003429 * Must always be called paired with verbose_leave()!
3430 */
3431 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003432verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003433{
3434 if (*p_vfile != NUL)
3435 ++msg_silent;
3436}
3437
3438/*
3439 * After giving verbose message.
3440 * Must always be called paired with verbose_enter()!
3441 */
3442 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003443verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003444{
3445 if (*p_vfile != NUL)
3446 if (--msg_silent < 0)
3447 msg_silent = 0;
3448}
3449
3450/*
3451 * Like verbose_enter() and set msg_scroll when displaying the message.
3452 */
3453 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003454verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003455{
3456 if (*p_vfile != NUL)
3457 ++msg_silent;
3458 else
3459 /* always scroll up, don't overwrite */
3460 msg_scroll = TRUE;
3461}
3462
3463/*
3464 * Like verbose_leave() and set cmdline_row when displaying the message.
3465 */
3466 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003467verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003468{
3469 if (*p_vfile != NUL)
3470 {
3471 if (--msg_silent < 0)
3472 msg_silent = 0;
3473 }
3474 else
3475 cmdline_row = msg_row;
3476}
3477
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003478/*
3479 * Called when 'verbosefile' is set: stop writing to the file.
3480 */
3481 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003482verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003483{
3484 if (verbose_fd != NULL)
3485 {
3486 fclose(verbose_fd);
3487 verbose_fd = NULL;
3488 }
3489 verbose_did_open = FALSE;
3490}
3491
3492/*
3493 * Open the file 'verbosefile'.
3494 * Return FAIL or OK.
3495 */
3496 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003497verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003498{
3499 if (verbose_fd == NULL && !verbose_did_open)
3500 {
3501 /* Only give the error message once. */
3502 verbose_did_open = TRUE;
3503
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003504 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003505 if (verbose_fd == NULL)
3506 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003507 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003508 return FAIL;
3509 }
3510 }
3511 return OK;
3512}
3513
3514/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 * Give a warning message (for searching).
3516 * Use 'w' highlighting and may repeat the message after redrawing
3517 */
3518 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003519give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520{
3521 /* Don't do this for ":silent". */
3522 if (msg_silent != 0)
3523 return;
3524
3525 /* Don't want a hit-enter prompt here. */
3526 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003527
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528#ifdef FEAT_EVAL
3529 set_vim_var_string(VV_WARNINGMSG, message, -1);
3530#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003531 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003533 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 else
3535 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003536 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003537 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 msg_didout = FALSE; /* overwrite this message */
3539 msg_nowait = TRUE; /* don't wait for this message */
3540 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 --no_wait_return;
3543}
3544
Bram Moolenaar113e1072019-01-20 15:30:40 +01003545#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003546 void
3547give_warning2(char_u *message, char_u *a1, int hl)
3548{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +02003549 if (IObuff == NULL)
3550 {
3551 // Very early in initialisation and already something wrong, just give
3552 // the raw message so the user at least gets a hint.
3553 give_warning((char_u *)message, hl);
3554 }
3555 else
3556 {
3557 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3558 give_warning(IObuff, hl);
3559 }
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003560}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003561#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003562
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563/*
3564 * Advance msg cursor to column "col".
3565 */
3566 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003567msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568{
3569 if (msg_silent != 0) /* nothing to advance to */
3570 {
3571 msg_col = col; /* for redirection, may fill it up later */
3572 return;
3573 }
3574 if (col >= Columns) /* not enough room */
3575 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003576#ifdef FEAT_RIGHTLEFT
3577 if (cmdmsg_rl)
3578 while (msg_col > Columns - col)
3579 msg_putchar(' ');
3580 else
3581#endif
3582 while (msg_col < col)
3583 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584}
3585
3586#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3587/*
3588 * Used for "confirm()" function, and the :confirm command prefix.
3589 * Versions which haven't got flexible dialogs yet, and console
3590 * versions, get this generic handler which uses the command line.
3591 *
3592 * type = one of:
3593 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3594 * title = title string (can be NULL for default)
3595 * (neither used in console dialogs at the moment)
3596 *
3597 * Format of the "buttons" string:
3598 * "Button1Name\nButton2Name\nButton3Name"
3599 * The first button should normally be the default/accept
3600 * The second button should be the 'Cancel' button
3601 * Other buttons- use your imagination!
3602 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3603 * different letter.
3604 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003606do_dialog(
3607 int type UNUSED,
3608 char_u *title UNUSED,
3609 char_u *message,
3610 char_u *buttons,
3611 int dfltbutton,
3612 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003613 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003614 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003615 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616{
3617 int oldState;
3618 int retval = 0;
3619 char_u *hotkeys;
3620 int c;
3621 int i;
3622
3623#ifndef NO_CONSOLE
3624 /* Don't output anything in silent mode ("ex -s") */
3625 if (silent_mode)
3626 return dfltbutton; /* return default option */
3627#endif
3628
3629#ifdef FEAT_GUI_DIALOG
3630 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3631 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3632 {
3633 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003634 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003635 /* avoid a hit-enter prompt without clearing the cmdline */
3636 need_wait_return = FALSE;
3637 emsg_on_display = FALSE;
3638 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639
3640 /* Flush output to avoid that further messages and redrawing is done
3641 * in the wrong order. */
3642 out_flush();
3643 gui_mch_update();
3644
3645 return c;
3646 }
3647#endif
3648
3649 oldState = State;
3650 State = CONFIRM;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652
3653 /*
3654 * Since we wait for a keypress, don't make the
3655 * user press RETURN as well afterwards.
3656 */
3657 ++no_wait_return;
3658 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3659
3660 if (hotkeys != NULL)
3661 {
3662 for (;;)
3663 {
3664 /* Get a typed character directly from the user. */
3665 c = get_keystroke();
3666 switch (c)
3667 {
3668 case CAR: /* User accepts default option */
3669 case NL:
3670 retval = dfltbutton;
3671 break;
3672 case Ctrl_C: /* User aborts/cancels */
3673 case ESC:
3674 retval = 0;
3675 break;
3676 default: /* Could be a hotkey? */
3677 if (c < 0) /* special keys are ignored here */
3678 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003679 if (c == ':' && ex_cmd)
3680 {
3681 retval = dfltbutton;
3682 ins_char_typebuf(':');
3683 break;
3684 }
3685
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 /* Make the character lowercase, as chars in "hotkeys" are. */
3687 c = MB_TOLOWER(c);
3688 retval = 1;
3689 for (i = 0; hotkeys[i]; ++i)
3690 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 if (has_mbyte)
3692 {
3693 if ((*mb_ptr2char)(hotkeys + i) == c)
3694 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003695 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 }
3697 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 if (hotkeys[i] == c)
3699 break;
3700 ++retval;
3701 }
3702 if (hotkeys[i])
3703 break;
3704 /* No hotkey match, so keep waiting */
3705 continue;
3706 }
3707 break;
3708 }
3709
3710 vim_free(hotkeys);
3711 }
3712
3713 State = oldState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 --no_wait_return;
3716 msg_end_prompt();
3717
3718 return retval;
3719}
3720
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721/*
3722 * Copy one character from "*from" to "*to", taking care of multi-byte
3723 * characters. Return the length of the character in bytes.
3724 */
3725 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003726copy_char(
3727 char_u *from,
3728 char_u *to,
3729 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 int len;
3732 int c;
3733
3734 if (has_mbyte)
3735 {
3736 if (lowercase)
3737 {
3738 c = MB_TOLOWER((*mb_ptr2char)(from));
3739 return (*mb_char2bytes)(c, to);
3740 }
3741 else
3742 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003743 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 mch_memmove(to, from, (size_t)len);
3745 return len;
3746 }
3747 }
3748 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 {
3750 if (lowercase)
3751 *to = (char_u)TOLOWER_LOC(*from);
3752 else
3753 *to = *from;
3754 return 1;
3755 }
3756}
3757
3758/*
3759 * Format the dialog string, and display it at the bottom of
3760 * the screen. Return a string of hotkey chars (if defined) for
3761 * each 'button'. If a button has no hotkey defined, the first character of
3762 * the button is used.
3763 * The hotkeys can be multi-byte characters, but without combining chars.
3764 *
3765 * Returns an allocated string with hotkeys, or NULL for error.
3766 */
3767 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003768msg_show_console_dialog(
3769 char_u *message,
3770 char_u *buttons,
3771 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772{
3773 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003774#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 int lenhotkey = HOTK_LEN; /* count first button */
3776 char_u *hotk = NULL;
3777 char_u *msgp = NULL;
3778 char_u *hotkp = NULL;
3779 char_u *r;
3780 int copy;
3781#define HAS_HOTKEY_LEN 30
3782 char_u has_hotkey[HAS_HOTKEY_LEN];
3783 int first_hotkey = FALSE; /* first char of button is hotkey */
3784 int idx;
3785
3786 has_hotkey[0] = FALSE;
3787
3788 /*
3789 * First loop: compute the size of memory to allocate.
3790 * Second loop: copy to the allocated memory.
3791 */
3792 for (copy = 0; copy <= 1; ++copy)
3793 {
3794 r = buttons;
3795 idx = 0;
3796 while (*r)
3797 {
3798 if (*r == DLG_BUTTON_SEP)
3799 {
3800 if (copy)
3801 {
3802 *msgp++ = ',';
3803 *msgp++ = ' '; /* '\n' -> ', ' */
3804
3805 /* advance to next hotkey and set default hotkey */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003807 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003810 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 if (dfltbutton)
3812 --dfltbutton;
3813
3814 /* If no hotkey is specified first char is used. */
3815 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3816 first_hotkey = TRUE;
3817 }
3818 else
3819 {
3820 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3821 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3822 if (idx < HAS_HOTKEY_LEN - 1)
3823 has_hotkey[++idx] = FALSE;
3824 }
3825 }
3826 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3827 {
3828 if (*r == DLG_HOTKEY_CHAR)
3829 ++r;
3830 first_hotkey = FALSE;
3831 if (copy)
3832 {
3833 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3834 *msgp++ = *r;
3835 else
3836 {
3837 /* '&a' -> '[a]' */
3838 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3839 msgp += copy_char(r, msgp, FALSE);
3840 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3841
3842 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003843 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 }
3845 }
3846 else
3847 {
3848 ++len; /* '&a' -> '[a]' */
3849 if (idx < HAS_HOTKEY_LEN - 1)
3850 has_hotkey[idx] = TRUE;
3851 }
3852 }
3853 else
3854 {
3855 /* everything else copy literally */
3856 if (copy)
3857 msgp += copy_char(r, msgp, FALSE);
3858 }
3859
3860 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003861 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 }
3863
3864 if (copy)
3865 {
3866 *msgp++ = ':';
3867 *msgp++ = ' ';
3868 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 }
3870 else
3871 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003872 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003873 + 2 /* for the NL's */
3874 + STRLEN(buttons)
3875 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003876 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877
3878 /* If no hotkey is specified first char is used. */
3879 if (!has_hotkey[0])
3880 {
3881 first_hotkey = TRUE;
3882 len += 2; /* "x" -> "[x]" */
3883 }
3884
3885 /*
3886 * Now allocate and load the strings
3887 */
3888 vim_free(confirm_msg);
3889 confirm_msg = alloc(len);
3890 if (confirm_msg == NULL)
3891 return NULL;
3892 *confirm_msg = NUL;
3893 hotk = alloc(lenhotkey);
3894 if (hotk == NULL)
3895 return NULL;
3896
3897 *confirm_msg = '\n';
3898 STRCPY(confirm_msg + 1, message);
3899
3900 msgp = confirm_msg + 1 + STRLEN(message);
3901 hotkp = hotk;
3902
Bram Moolenaar6a516062007-07-05 08:11:42 +00003903 /* Define first default hotkey. Keep the hotkey string NUL
3904 * terminated to avoid reading past the end. */
3905 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906
3907 /* Remember where the choices start, displaying starts here when
3908 * "hotkp" typed at the more prompt. */
3909 confirm_msg_tail = msgp;
3910 *msgp++ = '\n';
3911 }
3912 }
3913
3914 display_confirm_msg();
3915 return hotk;
3916}
3917
3918/*
3919 * Display the ":confirm" message. Also called when screen resized.
3920 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003921 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003922display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923{
3924 /* avoid that 'q' at the more prompt truncates the message here */
3925 ++confirm_msg_used;
3926 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003927 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 --confirm_msg_used;
3929}
3930
3931#endif /* FEAT_CON_DIALOG */
3932
3933#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3934
3935 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003936vim_dialog_yesno(
3937 int type,
3938 char_u *title,
3939 char_u *message,
3940 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941{
3942 if (do_dialog(type,
3943 title == NULL ? (char_u *)_("Question") : title,
3944 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003945 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 return VIM_YES;
3947 return VIM_NO;
3948}
3949
3950 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003951vim_dialog_yesnocancel(
3952 int type,
3953 char_u *title,
3954 char_u *message,
3955 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956{
3957 switch (do_dialog(type,
3958 title == NULL ? (char_u *)_("Question") : title,
3959 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003960 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 {
3962 case 1: return VIM_YES;
3963 case 2: return VIM_NO;
3964 }
3965 return VIM_CANCEL;
3966}
3967
3968 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003969vim_dialog_yesnoallcancel(
3970 int type,
3971 char_u *title,
3972 char_u *message,
3973 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974{
3975 switch (do_dialog(type,
3976 title == NULL ? (char_u *)"Question" : title,
3977 message,
3978 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003979 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 {
3981 case 1: return VIM_YES;
3982 case 2: return VIM_NO;
3983 case 3: return VIM_ALL;
3984 case 4: return VIM_DISCARDALL;
3985 }
3986 return VIM_CANCEL;
3987}
3988
3989#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3990
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003991#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003992static char *e_printf = N_("E766: Insufficient arguments for printf()");
3993
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003994/*
3995 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3996 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003997 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003998tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003999{
4000 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004001 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004002 int err = FALSE;
4003
4004 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004005 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004006 else
4007 {
4008 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004009 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004010 if (err)
4011 n = 0;
4012 }
4013 return n;
4014}
4015
4016/*
4017 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004018 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004019 * are not converted to a string.
4020 * If "tofree" is not NULL echo_string() is used. All types are converted to
4021 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004022 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004023 */
4024 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004025tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004026{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004027 int idx = *idxp - 1;
4028 char *s = NULL;
4029 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004030
4031 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004032 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004033 else
4034 {
4035 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004036 if (tofree != NULL)
4037 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4038 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004039 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004040 }
4041 return s;
4042}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004043
4044# ifdef FEAT_FLOAT
4045/*
4046 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4047 */
4048 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004049tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004050{
4051 int idx = *idxp - 1;
4052 double f = 0;
4053
4054 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004055 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004056 else
4057 {
4058 ++*idxp;
4059 if (tvs[idx].v_type == VAR_FLOAT)
4060 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004061 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004062 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004063 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004064 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004065 }
4066 return f;
4067}
4068# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004069#endif
4070
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004071#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004072/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004073 * Return the representation of infinity for printf() function:
4074 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4075 */
4076 static const char *
4077infinity_str(int positive,
4078 char fmt_spec,
4079 int force_sign,
4080 int space_for_positive)
4081{
4082 static const char *table[] =
4083 {
4084 "-inf", "inf", "+inf", " inf",
4085 "-INF", "INF", "+INF", " INF"
4086 };
4087 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4088
4089 if (ASCII_ISUPPER(fmt_spec))
4090 idx += 4;
4091 return table[idx];
4092}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004093#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004094
4095/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004096 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004097 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004098 * consistency.
4099 *
4100 * This code is based on snprintf.c - a portable implementation of snprintf
4101 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004102 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004103 * The original code, including useful comments, can be found here:
4104 * http://www.ijs.si/software/snprintf/
4105 *
4106 * This snprintf() only supports the following conversion specifiers:
4107 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4108 * with flags: '-', '+', ' ', '0' and '#'.
4109 * An asterisk is supported for field width as well as precision.
4110 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004111 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004112 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004113 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4114 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004115 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004116 * The locale is not used, the string is used as a byte string. This is only
4117 * relevant for double-byte encodings where the second byte may be '%'.
4118 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004119 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4120 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004121 *
4122 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004123 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004124 * is greater or equal to "str_m", not all characters from the result
4125 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4126 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004127 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004128 */
4129
4130/*
4131 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004132 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004133 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004134 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004135 */
4136
4137/* When generating prototypes all of this is skipped, cproto doesn't
4138 * understand this. */
4139#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004140
Bram Moolenaara800b422010-06-27 01:15:55 +02004141/* Like vim_vsnprintf() but append to the string. */
4142 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004143vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004144{
4145 va_list ap;
4146 int str_l;
4147 size_t len = STRLEN(str);
4148 size_t space;
4149
4150 if (str_m <= len)
4151 space = 0;
4152 else
4153 space = str_m - len;
4154 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004155 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004156 va_end(ap);
4157 return str_l;
4158}
Bram Moolenaara800b422010-06-27 01:15:55 +02004159
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004160 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004161vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004162{
4163 va_list ap;
4164 int str_l;
4165
4166 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004167 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004168 va_end(ap);
4169 return str_l;
4170}
4171
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004172 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004173vim_vsnprintf(
4174 char *str,
4175 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004176 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004177 va_list ap)
4178{
4179 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4180}
4181
4182 int
4183vim_vsnprintf_typval(
4184 char *str,
4185 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004186 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004187 va_list ap,
4188 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004189{
4190 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004191 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004192 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004193
4194 if (p == NULL)
4195 p = "";
4196 while (*p != NUL)
4197 {
4198 if (*p != '%')
4199 {
4200 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004201 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004202
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004203 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004204 if (str_l < str_m)
4205 {
4206 size_t avail = str_m - str_l;
4207
4208 mch_memmove(str + str_l, p, n > avail ? avail : n);
4209 }
4210 p += n;
4211 str_l += n;
4212 }
4213 else
4214 {
4215 size_t min_field_width = 0, precision = 0;
4216 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4217 int alternate_form = 0, force_sign = 0;
4218
4219 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4220 * ignored. */
4221 int space_for_positive = 1;
4222
4223 /* allowed values: \0, h, l, L */
4224 char length_modifier = '\0';
4225
4226 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004227# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004228# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004229 * That sounds reasonable to use as the maximum
4230 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004231# elif defined(FEAT_NUM64)
4232# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004233# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004234# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004235# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004236 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004237
4238 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004239 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004240
4241 /* natural field width of arg without padding and sign */
4242 size_t str_arg_l;
4243
4244 /* unsigned char argument value - only defined for c conversion.
4245 * N.B. standard explicitly states the char argument for the c
4246 * conversion is unsigned */
4247 unsigned char uchar_arg;
4248
4249 /* number of zeros to be inserted for numeric conversions as
4250 * required by the precision or minimal field width */
4251 size_t number_of_zeros_to_pad = 0;
4252
4253 /* index into tmp where zero padding is to be inserted */
4254 size_t zero_padding_insertion_ind = 0;
4255
4256 /* current conversion specifier character */
4257 char fmt_spec = '\0';
4258
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004259 /* buffer for 's' and 'S' specs */
4260 char_u *tofree = NULL;
4261
4262
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004263 p++; /* skip '%' */
4264
4265 /* parse flags */
4266 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4267 || *p == '#' || *p == '\'')
4268 {
4269 switch (*p)
4270 {
4271 case '0': zero_padding = 1; break;
4272 case '-': justify_left = 1; break;
4273 case '+': force_sign = 1; space_for_positive = 0; break;
4274 case ' ': force_sign = 1;
4275 /* If both the ' ' and '+' flags appear, the ' '
4276 * flag should be ignored */
4277 break;
4278 case '#': alternate_form = 1; break;
4279 case '\'': break;
4280 }
4281 p++;
4282 }
4283 /* If the '0' and '-' flags both appear, the '0' flag should be
4284 * ignored. */
4285
4286 /* parse field width */
4287 if (*p == '*')
4288 {
4289 int j;
4290
4291 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004292 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004293# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004294 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004295# endif
4296 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004297 if (j >= 0)
4298 min_field_width = j;
4299 else
4300 {
4301 min_field_width = -j;
4302 justify_left = 1;
4303 }
4304 }
4305 else if (VIM_ISDIGIT((int)(*p)))
4306 {
4307 /* size_t could be wider than unsigned int; make sure we treat
4308 * argument like common implementations do */
4309 unsigned int uj = *p++ - '0';
4310
4311 while (VIM_ISDIGIT((int)(*p)))
4312 uj = 10 * uj + (unsigned int)(*p++ - '0');
4313 min_field_width = uj;
4314 }
4315
4316 /* parse precision */
4317 if (*p == '.')
4318 {
4319 p++;
4320 precision_specified = 1;
4321 if (*p == '*')
4322 {
4323 int j;
4324
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004325 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004326# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004327 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004328# endif
4329 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004330 p++;
4331 if (j >= 0)
4332 precision = j;
4333 else
4334 {
4335 precision_specified = 0;
4336 precision = 0;
4337 }
4338 }
4339 else if (VIM_ISDIGIT((int)(*p)))
4340 {
4341 /* size_t could be wider than unsigned int; make sure we
4342 * treat argument like common implementations do */
4343 unsigned int uj = *p++ - '0';
4344
4345 while (VIM_ISDIGIT((int)(*p)))
4346 uj = 10 * uj + (unsigned int)(*p++ - '0');
4347 precision = uj;
4348 }
4349 }
4350
4351 /* parse 'h', 'l' and 'll' length modifiers */
4352 if (*p == 'h' || *p == 'l')
4353 {
4354 length_modifier = *p;
4355 p++;
4356 if (length_modifier == 'l' && *p == 'l')
4357 {
4358 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004359# ifdef FEAT_NUM64
4360 length_modifier = 'L';
4361# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004362 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004363# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004364 p++;
4365 }
4366 }
4367 fmt_spec = *p;
4368
4369 /* common synonyms: */
4370 switch (fmt_spec)
4371 {
4372 case 'i': fmt_spec = 'd'; break;
4373 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4374 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4375 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4376 default: break;
4377 }
4378
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004379# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4380 switch (fmt_spec)
4381 {
4382 case 'd': case 'u': case 'o': case 'x': case 'X':
4383 if (tvs != NULL && length_modifier == '\0')
4384 length_modifier = 'L';
4385 }
4386# endif
4387
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004388 /* get parameter value, do initial processing */
4389 switch (fmt_spec)
4390 {
4391 /* '%' and 'c' behave similar to 's' regarding flags and field
4392 * widths */
4393 case '%':
4394 case 'c':
4395 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004396 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004397 str_arg_l = 1;
4398 switch (fmt_spec)
4399 {
4400 case '%':
4401 str_arg = p;
4402 break;
4403
4404 case 'c':
4405 {
4406 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004407
4408 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004409# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004410 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004411# endif
4412 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004413 /* standard demands unsigned char */
4414 uchar_arg = (unsigned char)j;
4415 str_arg = (char *)&uchar_arg;
4416 break;
4417 }
4418
4419 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004420 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004421 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004422# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004423 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004424# endif
4425 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004426 if (str_arg == NULL)
4427 {
4428 str_arg = "[NULL]";
4429 str_arg_l = 6;
4430 }
4431 /* make sure not to address string beyond the specified
4432 * precision !!! */
4433 else if (!precision_specified)
4434 str_arg_l = strlen(str_arg);
4435 /* truncate string if necessary as requested by precision */
4436 else if (precision == 0)
4437 str_arg_l = 0;
4438 else
4439 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004440 /* Don't put the #if inside memchr(), it can be a
4441 * macro. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004442 /* memchr on HP does not like n > 2^31 !!! */
4443 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004444 precision <= (size_t)0x7fffffffL ? precision
4445 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004446 str_arg_l = (q == NULL) ? precision
4447 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004448 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004449 if (fmt_spec == 'S')
4450 {
4451 if (min_field_width != 0)
4452 min_field_width += STRLEN(str_arg)
4453 - mb_string2cells((char_u *)str_arg, -1);
4454 if (precision)
4455 {
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004456 char_u *p1;
4457 size_t i = 0;
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004458
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004459 for (p1 = (char_u *)str_arg; *p1;
4460 p1 += mb_ptr2len(p1))
4461 {
4462 i += (size_t)mb_ptr2cells(p1);
4463 if (i > precision)
4464 break;
4465 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004466 str_arg_l = precision = p1 - (char_u *)str_arg;
4467 }
4468 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004469 break;
4470
4471 default:
4472 break;
4473 }
4474 break;
4475
Bram Moolenaar91984b92016-08-16 21:58:41 +02004476 case 'd': case 'u':
4477 case 'b': case 'B':
4478 case 'o':
4479 case 'x': case 'X':
4480 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004481 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004482 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004483 * imply the value is unsigned; d implies a signed
4484 * value */
4485
4486 /* 0 if numeric argument is zero (or if pointer is
4487 * NULL for 'p'), +1 if greater than zero (or nonzero
4488 * for unsigned arguments), -1 if negative (unsigned
4489 * argument is never negative) */
4490 int arg_sign = 0;
4491
4492 /* only defined for length modifier h, or for no
4493 * length modifiers */
4494 int int_arg = 0;
4495 unsigned int uint_arg = 0;
4496
4497 /* only defined for length modifier l */
4498 long int long_arg = 0;
4499 unsigned long int ulong_arg = 0;
4500
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004501# ifdef FEAT_NUM64
4502 /* only defined for length modifier ll */
4503 varnumber_T llong_arg = 0;
4504 uvarnumber_T ullong_arg = 0;
4505# endif
4506
Bram Moolenaare9997822016-08-28 16:03:38 +02004507 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004508 uvarnumber_T bin_arg = 0;
4509
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004510 /* pointer argument value -only defined for p
4511 * conversion */
4512 void *ptr_arg = NULL;
4513
4514 if (fmt_spec == 'p')
4515 {
4516 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004517 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004518# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004519 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4520 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004521# endif
4522 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004523 if (ptr_arg != NULL)
4524 arg_sign = 1;
4525 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004526 else if (fmt_spec == 'b' || fmt_spec == 'B')
4527 {
4528 bin_arg =
4529# if defined(FEAT_EVAL)
4530 tvs != NULL ?
4531 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4532# endif
4533 va_arg(ap, uvarnumber_T);
4534 if (bin_arg != 0)
4535 arg_sign = 1;
4536 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004537 else if (fmt_spec == 'd')
4538 {
4539 /* signed */
4540 switch (length_modifier)
4541 {
4542 case '\0':
4543 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004544 /* char and short arguments are passed as int. */
4545 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004546# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004547 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004548# endif
4549 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004550 if (int_arg > 0)
4551 arg_sign = 1;
4552 else if (int_arg < 0)
4553 arg_sign = -1;
4554 break;
4555 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004556 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004557# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004558 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004559# endif
4560 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004561 if (long_arg > 0)
4562 arg_sign = 1;
4563 else if (long_arg < 0)
4564 arg_sign = -1;
4565 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004566# ifdef FEAT_NUM64
4567 case 'L':
4568 llong_arg =
4569# if defined(FEAT_EVAL)
4570 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4571# endif
4572 va_arg(ap, varnumber_T);
4573 if (llong_arg > 0)
4574 arg_sign = 1;
4575 else if (llong_arg < 0)
4576 arg_sign = -1;
4577 break;
4578# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004579 }
4580 }
4581 else
4582 {
4583 /* unsigned */
4584 switch (length_modifier)
4585 {
4586 case '\0':
4587 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004588 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004589# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004590 tvs != NULL ? (unsigned)
4591 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004592# endif
4593 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004594 if (uint_arg != 0)
4595 arg_sign = 1;
4596 break;
4597 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004598 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004599# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004600 tvs != NULL ? (unsigned long)
4601 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004602# endif
4603 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004604 if (ulong_arg != 0)
4605 arg_sign = 1;
4606 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004607# ifdef FEAT_NUM64
4608 case 'L':
4609 ullong_arg =
4610# if defined(FEAT_EVAL)
4611 tvs != NULL ? (uvarnumber_T)
4612 tv_nr(tvs, &arg_idx) :
4613# endif
4614 va_arg(ap, uvarnumber_T);
4615 if (ullong_arg != 0)
4616 arg_sign = 1;
4617 break;
4618# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004619 }
4620 }
4621
4622 str_arg = tmp;
4623 str_arg_l = 0;
4624
4625 /* NOTE:
4626 * For d, i, u, o, x, and X conversions, if precision is
4627 * specified, the '0' flag should be ignored. This is so
4628 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4629 * FreeBSD, NetBSD; but not with Perl.
4630 */
4631 if (precision_specified)
4632 zero_padding = 0;
4633 if (fmt_spec == 'd')
4634 {
4635 if (force_sign && arg_sign >= 0)
4636 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4637 /* leave negative numbers for sprintf to handle, to
4638 * avoid handling tricky cases like (short int)-32768 */
4639 }
4640 else if (alternate_form)
4641 {
4642 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004643 && (fmt_spec == 'b' || fmt_spec == 'B'
4644 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004645 {
4646 tmp[str_arg_l++] = '0';
4647 tmp[str_arg_l++] = fmt_spec;
4648 }
4649 /* alternate form should have no effect for p
4650 * conversion, but ... */
4651 }
4652
4653 zero_padding_insertion_ind = str_arg_l;
4654 if (!precision_specified)
4655 precision = 1; /* default precision is 1 */
4656 if (precision == 0 && arg_sign == 0)
4657 {
4658 /* When zero value is formatted with an explicit
4659 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004660 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004661 }
4662 else
4663 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004664 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004665 int f_l = 0;
4666
4667 /* construct a simple format string for sprintf */
4668 f[f_l++] = '%';
4669 if (!length_modifier)
4670 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004671 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004672 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004673# ifdef FEAT_NUM64
Bram Moolenaar4f974752019-02-17 17:44:42 +01004674# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004675 f[f_l++] = 'I';
4676 f[f_l++] = '6';
4677 f[f_l++] = '4';
4678# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004679 f[f_l++] = 'l';
4680 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004681# endif
4682# else
4683 f[f_l++] = 'l';
4684# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004685 }
4686 else
4687 f[f_l++] = length_modifier;
4688 f[f_l++] = fmt_spec;
4689 f[f_l++] = '\0';
4690
4691 if (fmt_spec == 'p')
4692 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004693 else if (fmt_spec == 'b' || fmt_spec == 'B')
4694 {
4695 char b[8 * sizeof(uvarnumber_T)];
4696 size_t b_l = 0;
4697 uvarnumber_T bn = bin_arg;
4698
4699 do
4700 {
4701 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4702 bn >>= 1;
4703 }
4704 while (bn != 0);
4705
4706 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4707 str_arg_l += b_l;
4708 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004709 else if (fmt_spec == 'd')
4710 {
4711 /* signed */
4712 switch (length_modifier)
4713 {
4714 case '\0':
4715 case 'h': str_arg_l += sprintf(
4716 tmp + str_arg_l, f, int_arg);
4717 break;
4718 case 'l': str_arg_l += sprintf(
4719 tmp + str_arg_l, f, long_arg);
4720 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004721# ifdef FEAT_NUM64
4722 case 'L': str_arg_l += sprintf(
4723 tmp + str_arg_l, f, llong_arg);
4724 break;
4725# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004726 }
4727 }
4728 else
4729 {
4730 /* unsigned */
4731 switch (length_modifier)
4732 {
4733 case '\0':
4734 case 'h': str_arg_l += sprintf(
4735 tmp + str_arg_l, f, uint_arg);
4736 break;
4737 case 'l': str_arg_l += sprintf(
4738 tmp + str_arg_l, f, ulong_arg);
4739 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004740# ifdef FEAT_NUM64
4741 case 'L': str_arg_l += sprintf(
4742 tmp + str_arg_l, f, ullong_arg);
4743 break;
4744# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004745 }
4746 }
4747
4748 /* include the optional minus sign and possible
4749 * "0x" in the region before the zero padding
4750 * insertion point */
4751 if (zero_padding_insertion_ind < str_arg_l
4752 && tmp[zero_padding_insertion_ind] == '-')
4753 zero_padding_insertion_ind++;
4754 if (zero_padding_insertion_ind + 1 < str_arg_l
4755 && tmp[zero_padding_insertion_ind] == '0'
4756 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4757 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4758 zero_padding_insertion_ind += 2;
4759 }
4760
4761 {
4762 size_t num_of_digits = str_arg_l
4763 - zero_padding_insertion_ind;
4764
4765 if (alternate_form && fmt_spec == 'o'
4766 /* unless zero is already the first
4767 * character */
4768 && !(zero_padding_insertion_ind < str_arg_l
4769 && tmp[zero_padding_insertion_ind] == '0'))
4770 {
4771 /* assure leading zero for alternate-form
4772 * octal numbers */
4773 if (!precision_specified
4774 || precision < num_of_digits + 1)
4775 {
4776 /* precision is increased to force the
4777 * first character to be zero, except if a
4778 * zero value is formatted with an
4779 * explicit precision of zero */
4780 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004781 }
4782 }
4783 /* zero padding to specified precision? */
4784 if (num_of_digits < precision)
4785 number_of_zeros_to_pad = precision - num_of_digits;
4786 }
4787 /* zero padding to specified minimal field width? */
4788 if (!justify_left && zero_padding)
4789 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004790 int n = (int)(min_field_width - (str_arg_l
4791 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004792 if (n > 0)
4793 number_of_zeros_to_pad += n;
4794 }
4795 break;
4796 }
4797
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004798# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004799 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004800 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004801 case 'e':
4802 case 'E':
4803 case 'g':
4804 case 'G':
4805 {
4806 /* Floating point. */
4807 double f;
4808 double abs_f;
4809 char format[40];
4810 int l;
4811 int remove_trailing_zeroes = FALSE;
4812
4813 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004814# if defined(FEAT_EVAL)
4815 tvs != NULL ? tv_float(tvs, &arg_idx) :
4816# endif
4817 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004818 abs_f = f < 0 ? -f : f;
4819
4820 if (fmt_spec == 'g' || fmt_spec == 'G')
4821 {
4822 /* Would be nice to use %g directly, but it prints
4823 * "1.0" as "1", we don't want that. */
4824 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4825 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004826 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004827 else
4828 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4829 remove_trailing_zeroes = TRUE;
4830 }
4831
Bram Moolenaar04186092016-08-29 21:55:35 +02004832 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004833# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004834 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004835# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004836 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004837# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004838 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004839 {
4840 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004841 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4842 force_sign, space_for_positive));
4843 str_arg_l = STRLEN(tmp);
4844 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004845 }
4846 else
4847 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004848 if (isnan(f))
4849 {
4850 /* Not a number: nan or NAN */
4851 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4852 : "nan");
4853 str_arg_l = 3;
4854 zero_padding = 0;
4855 }
4856 else if (isinf(f))
4857 {
4858 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4859 force_sign, space_for_positive));
4860 str_arg_l = STRLEN(tmp);
4861 zero_padding = 0;
4862 }
4863 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004864 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004865 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004866 format[0] = '%';
4867 l = 1;
4868 if (force_sign)
4869 format[l++] = space_for_positive ? ' ' : '+';
4870 if (precision_specified)
4871 {
4872 size_t max_prec = TMP_LEN - 10;
4873
4874 /* Make sure we don't get more digits than we
4875 * have room for. */
4876 if ((fmt_spec == 'f' || fmt_spec == 'F')
4877 && abs_f > 1.0)
4878 max_prec -= (size_t)log10(abs_f);
4879 if (precision > max_prec)
4880 precision = max_prec;
4881 l += sprintf(format + l, ".%d", (int)precision);
4882 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004883 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004884 format[l + 1] = NUL;
4885
Bram Moolenaare9997822016-08-28 16:03:38 +02004886 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004887 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004888
Bram Moolenaara7241f52008-06-24 20:39:31 +00004889 if (remove_trailing_zeroes)
4890 {
4891 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004892 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004893
4894 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02004895 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004896 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004897 else
4898 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004899 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004900 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004901 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004902 {
4903 /* Remove superfluous '+' and leading
4904 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004905 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004906 {
4907 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004908 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004909 --str_arg_l;
4910 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004911 i = (tp[1] == '-') ? 2 : 1;
4912 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004913 {
4914 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004915 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004916 --str_arg_l;
4917 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004918 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004919 }
4920 }
4921
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004922 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004923 /* Remove trailing zeroes, but keep the one
4924 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004925 while (tp > tmp + 2 && *tp == '0'
4926 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004927 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004928 STRMOVE(tp, tp + 1);
4929 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004930 --str_arg_l;
4931 }
4932 }
4933 else
4934 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004935 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004936
4937 /* Be consistent: some printf("%e") use 1.0e+12
4938 * and some 1.0e+012. Remove one zero in the last
4939 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004940 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004941 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004942 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4943 && tp[2] == '0'
4944 && vim_isdigit(tp[3])
4945 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004946 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004947 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004948 --str_arg_l;
4949 }
4950 }
4951 }
Bram Moolenaar04186092016-08-29 21:55:35 +02004952 if (zero_padding && min_field_width > str_arg_l
4953 && (tmp[0] == '-' || force_sign))
4954 {
4955 /* padding 0's should be inserted after the sign */
4956 number_of_zeros_to_pad = min_field_width - str_arg_l;
4957 zero_padding_insertion_ind = 1;
4958 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00004959 str_arg = tmp;
4960 break;
4961 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004962# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004963
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004964 default:
4965 /* unrecognized conversion specifier, keep format string
4966 * as-is */
4967 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004968 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004969 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004970 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004971
4972 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004973 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004974 str_arg = p;
4975 str_arg_l = 0;
4976 if (*p != NUL)
4977 str_arg_l++; /* include invalid conversion specifier
4978 unchanged if not at end-of-string */
4979 break;
4980 }
4981
4982 if (*p != NUL)
4983 p++; /* step over the just processed conversion specifier */
4984
4985 /* insert padding to the left as requested by min_field_width;
4986 * this does not include the zero padding in case of numerical
4987 * conversions*/
4988 if (!justify_left)
4989 {
4990 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004991 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004992
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004993 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004994 {
4995 if (str_l < str_m)
4996 {
4997 size_t avail = str_m - str_l;
4998
4999 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005000 (size_t)pn > avail ? avail
5001 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005002 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005003 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005004 }
5005 }
5006
5007 /* zero padding as requested by the precision or by the minimal
5008 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005009 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005010 {
5011 /* will not copy first part of numeric right now, *
5012 * force it to be copied later in its entirety */
5013 zero_padding_insertion_ind = 0;
5014 }
5015 else
5016 {
5017 /* insert first part of numerics (sign or '0x') before zero
5018 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005019 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005020
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005021 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005022 {
5023 if (str_l < str_m)
5024 {
5025 size_t avail = str_m - str_l;
5026
5027 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005028 (size_t)zn > avail ? avail
5029 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005030 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005031 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005032 }
5033
5034 /* insert zero padding as requested by the precision or min
5035 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005036 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005037 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005038 {
5039 if (str_l < str_m)
5040 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005041 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005042
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005043 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005044 (size_t)zn > avail ? avail
5045 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005046 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005047 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005048 }
5049 }
5050
5051 /* insert formatted string
5052 * (or as-is conversion specifier for unknown conversions) */
5053 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005054 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005055
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005056 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005057 {
5058 if (str_l < str_m)
5059 {
5060 size_t avail = str_m - str_l;
5061
5062 mch_memmove(str + str_l,
5063 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005064 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005065 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005066 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005067 }
5068 }
5069
5070 /* insert right padding */
5071 if (justify_left)
5072 {
5073 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005074 int pn = (int)(min_field_width
5075 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005076
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005077 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005078 {
5079 if (str_l < str_m)
5080 {
5081 size_t avail = str_m - str_l;
5082
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005083 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005084 (size_t)pn > avail ? avail
5085 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005086 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005087 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005088 }
5089 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005090 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005091 }
5092 }
5093
5094 if (str_m > 0)
5095 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005096 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097 * overwriting the last character (shouldn't happen, but just in case)
5098 * */
5099 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5100 }
5101
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005102 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005103 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005104
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005105 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005106 * character), that is, the number of characters that would have been
5107 * written to the buffer if it were large enough. */
5108 return (int)str_l;
5109}
5110
5111#endif /* PROTO */