blob: dd5f3f519b18de03ee0baebd2d8df80e72054910 [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{
359 va_list arglist;
360
361 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100362 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100364 return msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365}
366
367 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100368smsg_attr(int attr, const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369{
370 va_list arglist;
371
372 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100373 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100375 return msg_attr((char *)IObuff, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376}
377
Bram Moolenaare0429682018-07-01 16:44:03 +0200378 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100379smsg_attr_keep(int attr, const char *s, ...)
Bram Moolenaare0429682018-07-01 16:44:03 +0200380{
381 va_list arglist;
382
383 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100384 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaare0429682018-07-01 16:44:03 +0200385 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100386 return msg_attr_keep((char *)IObuff, attr, TRUE);
Bram Moolenaare0429682018-07-01 16:44:03 +0200387}
388
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389#endif
390
391/*
392 * Remember the last sourcing name/lnum used in an error message, so that it
393 * isn't printed each time when it didn't change.
394 */
395static int last_sourcing_lnum = 0;
396static char_u *last_sourcing_name = NULL;
397
398/*
399 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
400 * for the next error message;
401 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000402 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100403reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100405 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 last_sourcing_lnum = 0;
407}
408
409/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000410 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
411 */
412 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100413other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000414{
415 if (sourcing_name != NULL)
416 {
417 if (last_sourcing_name != NULL)
418 return STRCMP(sourcing_name, last_sourcing_name) != 0;
419 return TRUE;
420 }
421 return FALSE;
422}
423
424/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 * Get the message about the source, as used for an error message.
426 * Returns an allocated string with room for one more character.
427 * Returns NULL when no message is to be given.
428 */
429 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100430get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431{
432 char_u *Buf, *p;
433
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000434 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 {
436 p = (char_u *)_("Error detected while processing %s:");
Bram Moolenaar964b3742019-05-24 18:54:09 +0200437 Buf = alloc(STRLEN(sourcing_name) + STRLEN(p));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 if (Buf != NULL)
439 sprintf((char *)Buf, (char *)p, sourcing_name);
440 return Buf;
441 }
442 return NULL;
443}
444
445/*
446 * Get the message about the source lnum, as used for an error message.
447 * Returns an allocated string with room for one more character.
448 * Returns NULL when no message is to be given.
449 */
450 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100451get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452{
453 char_u *Buf, *p;
454
455 /* lnum is 0 when executing a command from the command line
456 * argument, we don't want a line number then */
457 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000458 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459 && sourcing_lnum != 0)
460 {
461 p = (char_u *)_("line %4ld:");
Bram Moolenaar964b3742019-05-24 18:54:09 +0200462 Buf = alloc(STRLEN(p) + 20);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463 if (Buf != NULL)
464 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
465 return Buf;
466 }
467 return NULL;
468}
469
470/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000471 * Display name and line number for the source of an error.
472 * Remember the file name and line number, so that for the next error the info
473 * is only displayed if it changed.
474 */
475 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100476msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000477{
478 char_u *p;
479
480 ++no_wait_return;
481 p = get_emsg_source();
482 if (p != NULL)
483 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100484 msg_attr((char *)p, attr);
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000485 vim_free(p);
486 }
487 p = get_emsg_lnum();
488 if (p != NULL)
489 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100490 msg_attr((char *)p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000491 vim_free(p);
492 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
493 }
494
495 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000496 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000497 {
498 vim_free(last_sourcing_name);
499 if (sourcing_name == NULL)
500 last_sourcing_name = NULL;
501 else
502 last_sourcing_name = vim_strsave(sourcing_name);
503 }
504 --no_wait_return;
505}
506
507/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000508 * Return TRUE if not giving error messages right now:
509 * If "emsg_off" is set: no error messages at the moment.
510 * If "msg" is in 'debug': do error message but without side effects.
511 * If "emsg_skip" is set: never do error messages.
512 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200513 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100514emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000515{
516 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
517 && vim_strchr(p_debug, 't') == NULL)
518#ifdef FEAT_EVAL
519 || emsg_skip > 0
520#endif
521 )
522 return TRUE;
523 return FALSE;
524}
525
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100526#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100527static garray_T ignore_error_list = GA_EMPTY;
528
529 void
530ignore_error_for_testing(char_u *error)
531{
532 if (ignore_error_list.ga_itemsize == 0)
533 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
534
Bram Moolenaar461a7fc2018-12-22 13:28:07 +0100535 if (STRCMP("RESET", error) == 0)
536 ga_clear_strings(&ignore_error_list);
537 else
538 ga_add_string(&ignore_error_list, error);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100539}
540
541 static int
542ignore_error(char_u *msg)
543{
544 int i;
545
546 for (i = 0; i < ignore_error_list.ga_len; ++i)
547 if (strstr((char *)msg,
548 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
549 return TRUE;
550 return FALSE;
551}
552#endif
553
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200554#if !defined(HAVE_STRERROR) || defined(PROTO)
555/*
556 * Replacement for perror() that behaves more or less like emsg() was called.
557 * v:errmsg will be set and called_emsg will be set.
558 */
559 void
560do_perror(char *msg)
561{
562 perror(msg);
563 ++emsg_silent;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100564 emsg(msg);
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200565 --emsg_silent;
566}
567#endif
568
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000569/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100570 * emsg_core() - display an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 *
572 * Rings the bell, if appropriate, and calls message() to do the real work
573 * When terminal not initialized (yet) mch_errmsg(..) is used.
574 *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100575 * Return TRUE if wait_return not called.
576 * Note: caller must check 'emsg_not_now()' before calling this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100578 static int
579emsg_core(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580{
581 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100583 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584#ifdef FEAT_EVAL
585 int ignore = FALSE;
586 int severe;
587#endif
588
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100589#ifdef FEAT_EVAL
590 /* When testing some errors are turned into a normal message. */
591 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100592 /* don't call msg() if it results in a dialog */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100593 return msg_use_printf() ? FALSE : msg((char *)s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100594#endif
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 called_emsg = TRUE;
597
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598#ifdef FEAT_EVAL
Bram Moolenaare723c422017-09-06 23:40:10 +0200599 /* If "emsg_severe" is TRUE: When an error exception is to be thrown,
600 * prefer this message over previous messages for the same command. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 severe = emsg_severe;
602 emsg_severe = FALSE;
603#endif
604
Bram Moolenaar57657d82006-04-21 22:12:41 +0000605 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606 {
607#ifdef FEAT_EVAL
608 /*
609 * Cause a throw of an error exception if appropriate. Don't display
610 * the error message in this case. (If no matching catch clause will
611 * be found, the message will be displayed later on.) "ignore" is set
612 * when the message should be ignored completely (used for the
613 * interrupt message).
614 */
615 if (cause_errthrow(s, severe, &ignore) == TRUE)
616 {
617 if (!ignore)
Bram Moolenaar76a63452018-11-28 20:38:37 +0100618 ++did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619 return TRUE;
620 }
621
622 /* set "v:errmsg", also when using ":silent! cmd" */
623 set_vim_var_string(VV_ERRMSG, s, -1);
624#endif
625
626 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000627 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 * But do write it to the redirection file.
629 */
630 if (emsg_silent != 0)
631 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200632 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200634 msg_start();
635 p = get_emsg_source();
636 if (p != NULL)
637 {
638 STRCAT(p, "\n");
639 redir_write(p, -1);
640 vim_free(p);
641 }
642 p = get_emsg_lnum();
643 if (p != NULL)
644 {
645 STRCAT(p, "\n");
646 redir_write(p, -1);
647 vim_free(p);
648 }
649 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100651#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare809a4e2019-07-04 17:35:05 +0200652 ch_log(NULL, "ERROR silent: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100653#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 return TRUE;
655 }
656
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100657 ex_exitval = 1;
658
Bram Moolenaar2f40d122017-10-24 21:49:36 +0200659 /* Reset msg_silent, an error causes messages to be switched back on.
660 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 msg_silent = 0;
662 cmd_silent = FALSE;
663
664 if (global_busy) /* break :global command */
665 ++global_busy;
666
667 if (p_eb)
668 beep_flush(); /* also includes flush_buffers() */
669 else
Bram Moolenaar6a2633b2018-10-07 23:16:36 +0200670 flush_buffers(FLUSH_MINIMAL); // flush internal buffers
Bram Moolenaar76a63452018-11-28 20:38:37 +0100671 ++did_emsg; // flag for DoOneCmd()
Bram Moolenaare723c422017-09-06 23:40:10 +0200672#ifdef FEAT_EVAL
673 did_uncaught_emsg = TRUE;
674#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 }
676
677 emsg_on_display = TRUE; /* remember there is an error message */
678 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100679 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000680 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 need_wait_return = TRUE; /* needed in case emsg() is called after
682 * wait_return has reset need_wait_return
683 * and a redraw is expected because
684 * msg_scrolled is non-zero */
685
Bram Moolenaar958dc692016-12-01 15:34:12 +0100686#ifdef FEAT_JOB_CHANNEL
687 emsg_to_channel_log = TRUE;
688#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 /*
690 * Display name and line number for the source of the error.
691 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000692 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693
694 /*
695 * Display the error message itself.
696 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000697 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100698 r = msg_attr((char *)s, attr);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100699
700#ifdef FEAT_JOB_CHANNEL
701 emsg_to_channel_log = FALSE;
702#endif
703 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704}
705
706/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100707 * Print an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 */
709 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100710emsg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100712 /* Skip this if not giving error messages at the moment. */
713 if (!emsg_not_now())
714 return emsg_core((char_u *)s);
715 return TRUE; /* no error messages at the moment */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716}
717
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100718#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100719/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100720 * Print an error message with format string and variable arguments.
721 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100722 */
723 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100724semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100725{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100726 /* Skip this if not giving error messages at the moment. */
727 if (!emsg_not_now())
728 {
729 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100730
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100731 va_start(ap, s);
732 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
733 va_end(ap);
734 return emsg_core(IObuff);
735 }
736 return TRUE; /* no error messages at the moment */
Bram Moolenaar95f09602016-11-10 20:01:45 +0100737}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100738#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100739
740/*
741 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
742 * defined. It is used for internal errors only, so that they can be
743 * detected when fuzzing vim.
744 */
745 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100746iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100747{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100748 if (!emsg_not_now())
749 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100750#ifdef ABORT_ON_INTERNAL_ERROR
751 abort();
752#endif
753}
754
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100755#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100756/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100757 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100758 * defined. It is used for internal errors only, so that they can be
759 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100760 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100761 */
762 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100763siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100764{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100765 if (!emsg_not_now())
766 {
767 va_list ap;
768
769 va_start(ap, s);
770 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
771 va_end(ap);
772 emsg_core(IObuff);
773 }
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100774# ifdef ABORT_ON_INTERNAL_ERROR
Bram Moolenaar95f09602016-11-10 20:01:45 +0100775 abort();
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100776# endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100777}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100778#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100779
780/*
781 * Give an "Internal error" message.
782 */
783 void
784internal_error(char *where)
785{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100786 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100787}
788
Bram Moolenaarea424162005-06-16 21:51:00 +0000789/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
Bram Moolenaardf177f62005-02-22 08:39:57 +0000791 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100792emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000793{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100794 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000795}
796
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797/*
798 * Like msg(), but truncate to a single line if p_shm contains 't', or when
799 * "force" is TRUE. This truncates in another way as for normal messages.
800 * Careful: The string may be changed by msg_may_trunc()!
801 * Returns a pointer to the printed message, if wait_return() not called.
802 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100803 char *
804msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805{
806 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100807 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808
809 /* Add message to history before truncating */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100810 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
Bram Moolenaar32526b32019-01-19 17:43:09 +0100812 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
814 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100815 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 msg_hist_off = FALSE;
817
818 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100819 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 return NULL;
821}
822
823/*
824 * Check if message "s" should be truncated at the start (for filenames).
825 * Return a pointer to where the truncated message starts.
826 * Note: May change the message by replacing a character with '<'.
827 */
828 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100829msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830{
831 int n;
832 int room;
833
834 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
835 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
836 && (n = (int)STRLEN(s) - room) > 0)
837 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 if (has_mbyte)
839 {
840 int size = vim_strsize(s);
841
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000842 /* There may be room anyway when there are multibyte chars. */
843 if (size <= room)
844 return s;
845
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 for (n = 0; size >= room; )
847 {
848 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000849 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 }
851 --n;
852 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 s += n;
854 *s = '<';
855 }
856 return s;
857}
858
859 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100860add_msg_hist(
861 char_u *s,
862 int len, /* -1 for undetermined length */
863 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864{
865 struct msg_hist *p;
866
867 if (msg_hist_off || msg_silent != 0)
868 return;
869
870 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000871 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000872 (void)delete_first_msg();
873
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 /* allocate an entry and add the message at the end of the history */
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200875 p = ALLOC_ONE(struct msg_hist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 if (p != NULL)
877 {
878 if (len < 0)
879 len = (int)STRLEN(s);
880 /* remove leading and trailing newlines */
881 while (len > 0 && *s == '\n')
882 {
883 ++s;
884 --len;
885 }
886 while (len > 0 && s[len - 1] == '\n')
887 --len;
888 p->msg = vim_strnsave(s, len);
889 p->next = NULL;
890 p->attr = attr;
891 if (last_msg_hist != NULL)
892 last_msg_hist->next = p;
893 last_msg_hist = p;
894 if (first_msg_hist == NULL)
895 first_msg_hist = last_msg_hist;
896 ++msg_hist_len;
897 }
898}
899
900/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000901 * Delete the first (oldest) message from the history.
902 * Returns FAIL if there are no messages.
903 */
904 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100905delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000906{
907 struct msg_hist *p;
908
909 if (msg_hist_len <= 0)
910 return FAIL;
911 p = first_msg_hist;
912 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000913 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200914 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000915 vim_free(p->msg);
916 vim_free(p);
917 --msg_hist_len;
918 return OK;
919}
920
921/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 * ":messages" command.
923 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200925ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926{
927 struct msg_hist *p;
928 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200929 int c = 0;
930
931 if (STRCMP(eap->arg, "clear") == 0)
932 {
933 int keep = eap->addr_count == 0 ? 0 : eap->line2;
934
935 while (msg_hist_len > keep)
936 (void)delete_first_msg();
937 return;
938 }
939
940 if (*eap->arg != NUL)
941 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100942 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200943 return;
944 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946 msg_hist_off = TRUE;
947
Bram Moolenaar451f8492016-04-14 17:16:22 +0200948 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200949 if (eap->addr_count != 0)
950 {
951 /* Count total messages */
952 for (; p != NULL && !got_int; p = p->next)
953 c++;
954
955 c -= eap->line2;
956
957 /* Skip without number of messages specified */
958 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
959 p = p->next, c--);
960 }
961
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200962 if (p == first_msg_hist)
963 {
964 s = mch_getenv((char_u *)"LANG");
965 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +0200966 // The next comment is extracted by xgettext and put in po file for
967 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +0100968 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +0200969 // Translator: Please replace the name and email address
970 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200971 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100972 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200973 }
974
Bram Moolenaar451f8492016-04-14 17:16:22 +0200975 /* Display what was not skipped. */
976 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100978 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979
980 msg_hist_off = FALSE;
981}
982
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000983#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984/*
985 * Call this after prompting the user. This will avoid a hit-return message
986 * and a delay.
987 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000988 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100989msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990{
991 need_wait_return = FALSE;
992 emsg_on_display = FALSE;
993 cmdline_row = msg_row;
994 msg_col = 0;
995 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +0100996 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997}
998#endif
999
1000/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001001 * Wait for the user to hit a key (normally Enter).
1002 * If "redraw" is TRUE, clear and redraw the screen.
1003 * If "redraw" is FALSE, just redraw the screen.
1004 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 */
1006 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001007wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008{
1009 int c;
1010 int oldState;
1011 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001013 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001014 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
1016 if (redraw == TRUE)
1017 must_redraw = CLEAR;
1018
1019 /* If using ":silent cmd", don't wait for a return. Also don't set
1020 * need_wait_return to do it later. */
1021 if (msg_silent != 0)
1022 return;
1023
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001024 /*
1025 * When inside vgetc(), we can't wait for a typed character at all.
1026 * With the global command (and some others) we only need one return at
1027 * the end. Adjust cmdline_row to avoid the next message overwriting the
1028 * last one.
1029 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001030 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001032 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033 if (no_wait_return)
1034 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 if (!exmode_active)
1036 cmdline_row = msg_row;
1037 return;
1038 }
1039
1040 redir_off = TRUE; /* don't redirect this message */
1041 oldState = State;
1042 if (quit_more)
1043 {
1044 c = CAR; /* just pretend CR was hit */
1045 quit_more = FALSE;
1046 got_int = FALSE;
1047 }
1048 else if (exmode_active)
1049 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001050 msg_puts(" "); /* make sure the cursor is on the right line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 c = CAR; /* no need for a return in ex mode */
1052 got_int = FALSE;
1053 }
1054 else
1055 {
1056 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1057 * just changed. */
1058 screenalloc(FALSE);
1059
1060 State = HITRETURN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062#ifdef USE_ON_FLY_SCROLL
1063 dont_scroll = TRUE; /* disallow scrolling here */
1064#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001065 cmdline_row = msg_row;
1066
Bram Moolenaarec38d692013-04-24 15:12:32 +02001067 /* Avoid the sequence that the user types ":" at the hit-return prompt
1068 * to start an Ex command, but the file-changed dialog gets in the
1069 * way. */
1070 if (need_check_timestamps)
1071 check_timestamps(FALSE);
1072
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 hit_return_msg();
1074
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 do
1076 {
1077 /* Remember "got_int", if it is set vgetc() probably returns a
1078 * CTRL-C, but we need to loop then. */
1079 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001080
1081 /* Don't do mappings here, we put the character back in the
1082 * typeahead buffer. */
1083 ++no_mapping;
1084 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001085
1086 /* Temporarily disable Recording. If Recording is active, the
1087 * character will be recorded later, since it will be added to the
1088 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001089 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001090 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001091 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001092 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001094 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001096 --no_mapping;
1097 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001098 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001099 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001100
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101#ifdef FEAT_CLIPBOARD
1102 /* Strange way to allow copying (yanking) a modeless selection at
1103 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1104 * Cmdline-mode and it's harmless when there is no selection. */
1105 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1106 {
1107 clip_copy_modeless_selection(TRUE);
1108 c = K_IGNORE;
1109 }
1110#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001111
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001112 /*
1113 * Allow scrolling back in the messages.
1114 * Also accept scroll-down commands when messages fill the screen,
1115 * to avoid that typing one 'j' too many makes the messages
1116 * disappear.
1117 */
1118 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001119 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001120 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1121 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001122 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001123 if (msg_scrolled > Rows)
1124 /* scroll back to show older messages */
1125 do_more_prompt(c);
1126 else
1127 {
1128 msg_didout = FALSE;
1129 c = K_IGNORE;
1130 msg_col =
1131#ifdef FEAT_RIGHTLEFT
1132 cmdmsg_rl ? Columns - 1 :
1133#endif
1134 0;
1135 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001136 if (quit_more)
1137 {
1138 c = CAR; /* just pretend CR was hit */
1139 quit_more = FALSE;
1140 got_int = FALSE;
1141 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001142 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001143 {
1144 c = K_IGNORE;
1145 hit_return_msg();
1146 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001147 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001148 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001149 && (c == 'j' || c == 'd' || c == 'f'
1150 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001151 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001152 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 } while ((had_got_int && c == Ctrl_C)
1154 || c == K_IGNORE
1155#ifdef FEAT_GUI
1156 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1157#endif
1158#ifdef FEAT_MOUSE
1159 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1160 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1161 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001162 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001164 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 || (!mouse_has(MOUSE_RETURN)
1166 && mouse_row < msg_row
1167 && (c == K_LEFTMOUSE
1168 || c == K_MIDDLEMOUSE
1169 || c == K_RIGHTMOUSE
1170 || c == K_X1MOUSE
1171 || c == K_X2MOUSE))
1172#endif
1173 );
1174 ui_breakcheck();
1175#ifdef FEAT_MOUSE
1176 /*
1177 * Avoid that the mouse-up event causes visual mode to start.
1178 */
1179 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1180 || c == K_X1MOUSE || c == K_X2MOUSE)
1181 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1182 else
1183#endif
1184 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1185 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001186 /* Put the character back in the typeahead buffer. Don't use the
1187 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001188 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001190 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 }
1193 redir_off = FALSE;
1194
1195 /*
1196 * If the user hits ':', '?' or '/' we get a command line from the next
1197 * line.
1198 */
1199 if (c == ':' || c == '?' || c == '/')
1200 {
1201 if (!exmode_active)
1202 cmdline_row = msg_row;
1203 skip_redraw = TRUE; /* skip redraw once */
1204 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001205#ifdef FEAT_TERMINAL
1206 skip_term_loop = TRUE;
1207#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 }
1209
1210 /*
1211 * If the window size changed set_shellsize() will redraw the screen.
1212 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1213 * typed.
1214 */
1215 tmpState = State;
1216 State = oldState; /* restore State before set_shellsize */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 msg_check();
1219
1220#if defined(UNIX) || defined(VMS)
1221 /*
1222 * When switching screens, we need to output an extra newline on exit.
1223 */
1224 if (swapping_screen() && !termcap_active)
1225 newline_on_exit = TRUE;
1226#endif
1227
1228 need_wait_return = FALSE;
1229 did_wait_return = TRUE;
1230 emsg_on_display = FALSE; /* can delete error message now */
1231 lines_left = -1; /* reset lines_left at next msg_start() */
1232 reset_last_sourcing();
1233 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1234 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001235 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236
1237 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1238 {
1239 starttermcap(); /* start termcap before redrawing */
1240 shell_resized();
1241 }
1242 else if (!skip_redraw
1243 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1244 {
1245 starttermcap(); /* start termcap before redrawing */
1246 redraw_later(VALID);
1247 }
1248}
1249
1250/*
1251 * Write the hit-return prompt.
1252 */
1253 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001254hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001256 int save_p_more = p_more;
1257
1258 p_more = FALSE; /* don't want see this message when scrolling back */
1259 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 msg_putchar('\n');
1261 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001262 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263
Bram Moolenaar32526b32019-01-19 17:43:09 +01001264 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 if (!msg_use_printf())
1266 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001267 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268}
1269
1270/*
1271 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1272 */
1273 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001274set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275{
1276 vim_free(keep_msg);
1277 if (s != NULL && msg_silent == 0)
1278 keep_msg = vim_strsave(s);
1279 else
1280 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001281 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001282 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283}
1284
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001285#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1286/*
1287 * If there currently is a message being displayed, set "keep_msg" to it, so
1288 * that it will be displayed again after redraw.
1289 */
1290 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001291set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001292{
1293 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1294 && (State & NORMAL))
1295 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1296}
1297#endif
1298
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299/*
1300 * Prepare for outputting characters in the command line.
1301 */
1302 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001303msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304{
1305 int did_return = FALSE;
1306
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001307 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001308 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001309
1310#ifdef FEAT_EVAL
1311 if (need_clr_eos)
1312 {
1313 /* Halfway an ":echo" command and getting an (error) message: clear
1314 * any text from the command. */
1315 need_clr_eos = FALSE;
1316 msg_clr_eos();
1317 }
1318#endif
1319
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 if (!msg_scroll && full_screen) /* overwrite last message */
1321 {
1322 msg_row = cmdline_row;
1323 msg_col =
1324#ifdef FEAT_RIGHTLEFT
1325 cmdmsg_rl ? Columns - 1 :
1326#endif
1327 0;
1328 }
1329 else if (msg_didout) /* start message on next line */
1330 {
1331 msg_putchar('\n');
1332 did_return = TRUE;
1333 if (exmode_active != EXMODE_NORMAL)
1334 cmdline_row = msg_row;
1335 }
1336 if (!msg_didany || lines_left < 0)
1337 msg_starthere();
1338 if (msg_silent == 0)
1339 {
1340 msg_didout = FALSE; /* no output on current line yet */
1341 cursor_off();
1342 }
1343
1344 /* when redirecting, may need to start a new line. */
1345 if (!did_return)
1346 redir_write((char_u *)"\n", -1);
1347}
1348
1349/*
1350 * Note that the current msg position is where messages start.
1351 */
1352 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001353msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354{
1355 lines_left = cmdline_row;
1356 msg_didany = FALSE;
1357}
1358
1359 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001360msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361{
1362 msg_putchar_attr(c, 0);
1363}
1364
1365 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001366msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001368 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369
1370 if (IS_SPECIAL(c))
1371 {
1372 buf[0] = K_SPECIAL;
1373 buf[1] = K_SECOND(c);
1374 buf[2] = K_THIRD(c);
1375 buf[3] = NUL;
1376 }
1377 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001378 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001379 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380}
1381
1382 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001383msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001385 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386
Bram Moolenaar32526b32019-01-19 17:43:09 +01001387 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 msg_puts(buf);
1389}
1390
1391 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001392msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393{
1394 msg_home_replace_attr(fname, 0);
1395}
1396
1397#if defined(FEAT_FIND_ID) || defined(PROTO)
1398 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001399msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001401 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402}
1403#endif
1404
1405 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001406msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407{
1408 char_u *name;
1409
1410 name = home_replace_save(NULL, fname);
1411 if (name != NULL)
1412 msg_outtrans_attr(name, attr);
1413 vim_free(name);
1414}
1415
1416/*
1417 * Output 'len' characters in 'str' (including NULs) with translation
1418 * if 'len' is -1, output upto a NUL character.
1419 * Use attributes 'attr'.
1420 * Return the number of characters it takes on the screen.
1421 */
1422 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001423msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424{
1425 return msg_outtrans_attr(str, 0);
1426}
1427
1428 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001429msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430{
1431 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1432}
1433
1434 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001435msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436{
1437 return msg_outtrans_len_attr(str, len, 0);
1438}
1439
1440/*
1441 * Output one character at "p". Return pointer to the next character.
1442 * Handles multi-byte characters.
1443 */
1444 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001445msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 int l;
1448
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001449 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 {
1451 msg_outtrans_len_attr(p, l, attr);
1452 return p + l;
1453 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001454 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 return p + 1;
1456}
1457
1458 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001459msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460{
1461 int retval = 0;
1462 char_u *str = msgstr;
1463 char_u *plain_start = msgstr;
1464 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 int mb_l;
1466 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467
1468 /* if MSG_HIST flag set, add message to history */
1469 if (attr & MSG_HIST)
1470 {
1471 add_msg_hist(str, len, attr);
1472 attr &= ~MSG_HIST;
1473 }
1474
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 /* If the string starts with a composing character first draw a space on
1476 * which the composing char can be drawn. */
1477 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001478 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479
1480 /*
1481 * Go over the string. Special characters are translated and printed.
1482 * Normal characters are printed several at a time.
1483 */
1484 while (--len >= 0)
1485 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 if (enc_utf8)
1487 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001488 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001490 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 else
1492 mb_l = 1;
1493 if (has_mbyte && mb_l > 1)
1494 {
1495 c = (*mb_ptr2char)(str);
1496 if (vim_isprintc(c))
1497 /* printable multi-byte char: count the cells. */
1498 retval += (*mb_ptr2cells)(str);
1499 else
1500 {
1501 /* unprintable multi-byte char: print the printable chars so
1502 * far and the translation of the unprintable char. */
1503 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001504 msg_puts_attr_len((char *)plain_start,
1505 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001507 msg_puts_attr((char *)transchar(c),
1508 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 retval += char2cells(c);
1510 }
1511 len -= mb_l - 1;
1512 str += mb_l;
1513 }
1514 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 {
1516 s = transchar_byte(*str);
1517 if (s[1] != NUL)
1518 {
1519 /* unprintable char: print the printable chars so far and the
1520 * translation of the unprintable char. */
1521 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001522 msg_puts_attr_len((char *)plain_start,
1523 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001525 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001526 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001528 else
1529 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 ++str;
1531 }
1532 }
1533
1534 if (str > plain_start)
1535 /* print the printable chars at the end */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001536 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537
1538 return retval;
1539}
1540
1541#if defined(FEAT_QUICKFIX) || defined(PROTO)
1542 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001543msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544{
1545 int i;
1546 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1547
1548 arg = skipwhite(arg);
1549 for (i = 5; *arg && i >= 0; --i)
1550 if (*arg++ != str[i])
1551 break;
1552 if (i < 0)
1553 {
1554 msg_putchar('\n');
1555 for (i = 0; rs[i]; ++i)
1556 msg_putchar(rs[i] - 3);
1557 }
1558}
1559#endif
1560
1561/*
1562 * Output the string 'str' upto a NUL character.
1563 * Return the number of characters it takes on the screen.
1564 *
1565 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1566 * following character and shown as <F1>, <S-Up> etc. Any other character
1567 * which is not printable shown in <> form.
1568 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1569 * If a character is displayed in one of these special ways, is also
1570 * highlighted (its highlight name is '8' in the p_hl variable).
1571 * Otherwise characters are not highlighted.
1572 * This function is used to show mappings, where we want to see how to type
1573 * the character/string -- webb
1574 */
1575 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001576msg_outtrans_special(
1577 char_u *strstart,
Bram Moolenaar725310d2019-04-24 23:08:23 +02001578 int from, // TRUE for lhs of a mapping
1579 int maxlen) // screen columns, 0 for unlimeted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580{
1581 char_u *str = strstart;
1582 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001583 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 int attr;
1585 int len;
1586
Bram Moolenaar8820b482017-03-16 17:23:31 +01001587 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 while (*str != NUL)
1589 {
1590 /* Leading and trailing spaces need to be displayed in <> form. */
1591 if ((str == strstart || str[1] == NUL) && *str == ' ')
1592 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001593 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 ++str;
1595 }
1596 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001597 text = (char *)str2special(&str, from);
1598 len = vim_strsize((char_u *)text);
Bram Moolenaar725310d2019-04-24 23:08:23 +02001599 if (maxlen > 0 && retval + len >= maxlen)
1600 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 /* Highlight special keys */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001602 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001603 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 retval += len;
1605 }
1606 return retval;
1607}
1608
Bram Moolenaarbd743252010-10-20 21:23:33 +02001609#if defined(FEAT_EVAL) || defined(PROTO)
1610/*
1611 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1612 * strings, in an allocated string.
1613 */
1614 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001615str2special_save(
1616 char_u *str,
1617 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001618{
1619 garray_T ga;
1620 char_u *p = str;
1621
1622 ga_init2(&ga, 1, 40);
1623 while (*p != NUL)
1624 ga_concat(&ga, str2special(&p, is_lhs));
1625 ga_append(&ga, NUL);
1626 return (char_u *)ga.ga_data;
1627}
1628#endif
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630/*
1631 * Return the printable string for the key codes at "*sp".
1632 * Used for translating the lhs or rhs of a mapping to printable chars.
1633 * Advances "sp" to the next code.
1634 */
1635 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001636str2special(
1637 char_u **sp,
1638 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639{
1640 int c;
1641 static char_u buf[7];
1642 char_u *str = *sp;
1643 int modifiers = 0;
1644 int special = FALSE;
1645
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 if (has_mbyte)
1647 {
1648 char_u *p;
1649
1650 /* Try to un-escape a multi-byte character. Return the un-escaped
1651 * string if it is a multi-byte character. */
1652 p = mb_unescape(sp);
1653 if (p != NULL)
1654 return p;
1655 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
1657 c = *str;
1658 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1659 {
1660 if (str[1] == KS_MODIFIER)
1661 {
1662 modifiers = str[2];
1663 str += 3;
1664 c = *str;
1665 }
1666 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1667 {
1668 c = TO_SPECIAL(str[1], str[2]);
1669 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 }
1671 if (IS_SPECIAL(c) || modifiers) /* special key */
1672 special = TRUE;
1673 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001675 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001677 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001678
1679 /* For multi-byte characters check for an illegal byte. */
1680 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1681 {
1682 transchar_nonprint(buf, c);
1683 *sp = str + 1;
1684 return buf;
1685 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001686 /* Since 'special' is TRUE the multi-byte character 'c' will be
1687 * processed by get_special_key_name() */
1688 c = (*mb_ptr2char)(str);
1689 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001691 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001692 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
1694 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1695 * Use <Space> only for lhs of a mapping. */
1696 if (special || char2cells(c) > 1 || (from && c == ' '))
1697 return get_special_key_name(c, modifiers);
1698 buf[0] = c;
1699 buf[1] = NUL;
1700 return buf;
1701}
1702
1703/*
1704 * Translate a key sequence into special key names.
1705 */
1706 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001707str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708{
1709 char_u *s;
1710
1711 *buf = NUL;
1712 while (*sp)
1713 {
1714 s = str2special(&sp, FALSE);
1715 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1716 STRCAT(buf, s);
1717 }
1718}
1719
1720/*
1721 * print line for :print or :list command
1722 */
1723 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001724msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725{
1726 int c;
1727 int col = 0;
1728 int n_extra = 0;
1729 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001730 int c_final = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 char_u *p_extra = NULL; /* init to make SASC shut up */
1732 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001733 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 int l;
1736 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
Bram Moolenaardf177f62005-02-22 08:39:57 +00001738 if (curwin->w_p_list)
1739 list = TRUE;
1740
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001742 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 {
1744 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001745 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 --trail;
1747 }
1748
1749 /* output a space for an empty line, otherwise the line will be
1750 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001751 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 msg_putchar(' ');
1753
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001754 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001756 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 {
1758 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001759 if (n_extra == 0 && c_final)
1760 c = c_final;
1761 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 c = c_extra;
1763 else
1764 c = *p_extra++;
1765 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001766 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 {
1768 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001769 if (lcs_nbsp != NUL && list
1770 && (mb_ptr2char(s) == 160
1771 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001772 {
1773 mb_char2bytes(lcs_nbsp, buf);
1774 buf[(*mb_ptr2len)(buf)] = NUL;
1775 }
1776 else
1777 {
1778 mch_memmove(buf, s, (size_t)l);
1779 buf[l] = NUL;
1780 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001781 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 s += l;
1783 continue;
1784 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 else
1786 {
1787 attr = 0;
1788 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001789 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 {
1791 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001792#ifdef FEAT_VARTABS
1793 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1794 curbuf->b_p_vts_array) - 1;
1795#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001797#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001798 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 {
1800 c = ' ';
1801 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001802 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 }
1804 else
1805 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001806 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001808 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001809 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 }
1811 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001812 else if (c == 160 && list && lcs_nbsp != NUL)
1813 {
1814 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001815 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001816 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001817 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 {
1819 p_extra = (char_u *)"";
1820 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001821 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 n_extra = 1;
1823 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001824 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 --s;
1826 }
1827 else if (c != NUL && (n = byte2cells(c)) > 1)
1828 {
1829 n_extra = n - 1;
1830 p_extra = transchar_byte(c);
1831 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001832 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001834 /* Use special coloring to be able to distinguish <hex> from
1835 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001836 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 }
1838 else if (c == ' ' && trail != NULL && s > trail)
1839 {
1840 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001841 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001843 else if (c == ' ' && list && lcs_space != NUL)
1844 {
1845 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001846 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001847 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 }
1849
1850 if (c == NUL)
1851 break;
1852
1853 msg_putchar_attr(c, attr);
1854 col++;
1855 }
1856 msg_clr_eos();
1857}
1858
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859/*
1860 * Use screen_puts() to output one multi-byte character.
1861 * Return the pointer "s" advanced to the next character.
1862 */
1863 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001864screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865{
1866 int cw;
1867
1868 msg_didout = TRUE; /* remember that line is not empty */
1869 cw = (*mb_ptr2cells)(s);
1870 if (cw > 1 && (
1871#ifdef FEAT_RIGHTLEFT
1872 cmdmsg_rl ? msg_col <= 1 :
1873#endif
1874 msg_col == Columns - 1))
1875 {
1876 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001877 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 return s;
1879 }
1880
1881 screen_puts_len(s, l, msg_row, msg_col, attr);
1882#ifdef FEAT_RIGHTLEFT
1883 if (cmdmsg_rl)
1884 {
1885 msg_col -= cw;
1886 if (msg_col == 0)
1887 {
1888 msg_col = Columns;
1889 ++msg_row;
1890 }
1891 }
1892 else
1893#endif
1894 {
1895 msg_col += cw;
1896 if (msg_col >= Columns)
1897 {
1898 msg_col = 0;
1899 ++msg_row;
1900 }
1901 }
1902 return s + l;
1903}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
1905/*
1906 * Output a string to the screen at position msg_row, msg_col.
1907 * Update msg_row and msg_col for the next message.
1908 */
1909 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001910msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001912 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913}
1914
1915 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001916msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001918 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919}
1920
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921/*
1922 * Show a message in such a way that it always fits in the line. Cut out a
1923 * part in the middle and replace it with "..." when necessary.
1924 * Does not handle multi-byte characters!
1925 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001926 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001927msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928{
1929 int slen = len;
1930 int room;
1931
1932 room = Columns - msg_col;
1933 if (len > room && room >= 20)
1934 {
1935 slen = (room - 3) / 2;
1936 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001937 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 }
1939 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1940}
1941
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001942 void
1943msg_outtrans_long_attr(char_u *longstr, int attr)
1944{
1945 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1946}
1947
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948/*
1949 * Basic function for writing a message with highlight attributes.
1950 */
1951 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001952msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953{
1954 msg_puts_attr_len(s, -1, attr);
1955}
1956
1957/*
1958 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1959 * When "maxlen" is -1 there is no maximum length.
1960 * When "maxlen" is >= 0 the message is not put in the history.
1961 */
1962 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001963msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 /*
1966 * If redirection is on, also write to the redirection file.
1967 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001968 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
1970 /*
1971 * Don't print anything when using ":silent cmd".
1972 */
1973 if (msg_silent != 0)
1974 return;
1975
1976 /* if MSG_HIST flag set, add message to history */
1977 if ((attr & MSG_HIST) && maxlen < 0)
1978 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001979 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 attr &= ~MSG_HIST;
1981 }
1982
1983 /*
1984 * When writing something to the screen after it has scrolled, requires a
1985 * wait-return prompt later. Needed when scrolling, resetting
1986 * need_wait_return after some prompt, and then outputting something
1987 * without scrolling
1988 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001989 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 need_wait_return = TRUE;
1991 msg_didany = TRUE; /* remember that something was outputted */
1992
1993 /*
1994 * If there is no valid screen, use fprintf so we can see error messages.
1995 * If termcap is not active, we may be writing in an alternate console
1996 * window, cursor positioning may not work correctly (window size may be
1997 * different, e.g. for Win32 console) or we just don't know where the
1998 * cursor is.
1999 */
2000 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002001 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002002 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002003 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002004}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002006/*
2007 * The display part of msg_puts_attr_len().
2008 * May be called recursively to display scroll-back text.
2009 */
2010 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002011msg_puts_display(
2012 char_u *str,
2013 int maxlen,
2014 int attr,
2015 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002016{
2017 char_u *s = str;
2018 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2019 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002020 int l;
2021 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002022 char_u *sb_str = str;
2023 int sb_col = msg_col;
2024 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002025 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026
2027 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002028 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 {
2030 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002031 * We are at the end of the screen line when:
2032 * - When outputting a newline.
2033 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002035 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036#ifdef FEAT_RIGHTLEFT
2037 cmdmsg_rl
2038 ? (
2039 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002040 || (*s == TAB && msg_col <= 7)
2041 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 :
2043#endif
2044 (msg_col + t_col >= Columns - 1
2045 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002047 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002049 /*
2050 * The screen is scrolled up when at the last row (some terminals
2051 * scroll automatically, some don't. To avoid problems we scroll
2052 * ourselves).
2053 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002056 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002058 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 if (msg_no_more && lines_left == 0)
2060 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002062 /* Scroll the screen up one line. */
2063 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064
2065 msg_row = Rows - 2;
2066 if (msg_col >= Columns) /* can happen after screen resize */
2067 msg_col = Columns - 1;
2068
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002069 /* Display char in last column before showing more-prompt. */
2070 if (*s >= ' '
2071#ifdef FEAT_RIGHTLEFT
2072 && !cmdmsg_rl
2073#endif
2074 )
2075 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002076 if (has_mbyte)
2077 {
2078 if (enc_utf8 && maxlen >= 0)
2079 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002080 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002082 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002083 s = screen_puts_mbyte(s, l, attr);
2084 }
2085 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002086 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002087 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002089 else
2090 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002091
2092 if (p_more)
2093 /* store text for scrolling back */
2094 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2095
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002096 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002097 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 redraw_cmdline = TRUE;
2099 if (cmdline_row > 0 && !exmode_active)
2100 --cmdline_row;
2101
2102 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002103 * If screen is completely filled and 'more' is set then wait
2104 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002106 if (lines_left > 0)
2107 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002108 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 && !msg_no_more && !exmode_active)
2110 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002112 if (do_more_prompt(NUL))
2113 s = confirm_msg_tail;
2114#else
2115 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116#endif
2117 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002118 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002120
2121 /* When we displayed a char in last column need to check if there
2122 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002123 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002124 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 }
2126
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002127 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002130 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002131 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2132 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002134 t_puts(&t_col, t_s, s, attr);
2135
2136 if (wrap && p_more && !recurse)
2137 /* store text for scrolling back */
2138 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139
2140 if (*s == '\n') /* go to next line */
2141 {
2142 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002143#ifdef FEAT_RIGHTLEFT
2144 if (cmdmsg_rl)
2145 msg_col = Columns - 1;
2146 else
2147#endif
2148 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 if (++msg_row >= Rows) /* safety check */
2150 msg_row = Rows - 1;
2151 }
2152 else if (*s == '\r') /* go to column 0 */
2153 {
2154 msg_col = 0;
2155 }
2156 else if (*s == '\b') /* go to previous char */
2157 {
2158 if (msg_col)
2159 --msg_col;
2160 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002161 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 {
2163 do
2164 msg_screen_putchar(' ', attr);
2165 while (msg_col & 7);
2166 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002167 else if (*s == BELL) /* beep (from ":sh") */
2168 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 else
2170 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 if (has_mbyte)
2172 {
2173 cw = (*mb_ptr2cells)(s);
2174 if (enc_utf8 && maxlen >= 0)
2175 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002176 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002178 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 }
2180 else
2181 {
2182 cw = 1;
2183 l = 1;
2184 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002185
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 /* When drawing from right to left or when a double-wide character
2187 * doesn't fit, draw a single character here. Otherwise collect
2188 * characters and draw them all at once later. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 if (
2190# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002191 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002193 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 if (l > 1)
2196 s = screen_puts_mbyte(s, l, attr) - 1;
2197 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 msg_screen_putchar(*s, attr);
2199 }
2200 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 {
2202 /* postpone this character until later */
2203 if (t_col == 0)
2204 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 t_col += cw;
2206 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 }
2208 }
2209 ++s;
2210 }
2211
2212 /* output any postponed text */
2213 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002214 t_puts(&t_col, t_s, s, attr);
2215 if (p_more && !recurse)
2216 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 msg_check();
2219}
2220
2221/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002222 * Return TRUE when ":filter pattern" was used and "msg" does not match
2223 * "pattern".
2224 */
2225 int
2226message_filtered(char_u *msg)
2227{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002228 int match;
2229
2230 if (cmdmod.filter_regmatch.regprog == NULL)
2231 return FALSE;
2232 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2233 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002234}
2235
2236/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002237 * Scroll the screen up one line for displaying the next message line.
2238 */
2239 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002240msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002241{
2242#ifdef FEAT_GUI
2243 /* Remove the cursor before scrolling, ScreenLines[] is going
2244 * to become invalid. */
2245 if (gui.in_use)
2246 gui_undraw_cursor();
2247#endif
2248 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002249 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002250 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002251 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002252
2253 if (!can_clear((char_u *)" "))
2254 {
2255 /* Scrolling up doesn't result in the right background. Set the
2256 * background here. It's not efficient, but avoids that we have to do
2257 * it all over the code. */
2258 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2259
2260 /* Also clear the last char of the last but one line if it was not
2261 * cleared before to avoid a scroll-up. */
2262 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2263 screen_fill((int)Rows - 2, (int)Rows - 1,
2264 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2265 }
2266}
2267
2268/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002269 * Increment "msg_scrolled".
2270 */
2271 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002272inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002273{
2274#ifdef FEAT_EVAL
2275 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2276 {
2277 char_u *p = sourcing_name;
2278 char_u *tofree = NULL;
2279 int len;
2280
2281 /* v:scrollstart is empty, set it to the script/function name and line
2282 * number */
2283 if (p == NULL)
2284 p = (char_u *)_("Unknown");
2285 else
2286 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002287 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002288 tofree = alloc(len);
2289 if (tofree != NULL)
2290 {
2291 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2292 p, (long)sourcing_lnum);
2293 p = tofree;
2294 }
2295 }
2296 set_vim_var_string(VV_SCROLLSTART, p, -1);
2297 vim_free(tofree);
2298 }
2299#endif
2300 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002301 if (must_redraw < VALID)
2302 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002303}
2304
2305/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002306 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2307 * store the displayed text and remember where screen lines start.
2308 */
2309typedef struct msgchunk_S msgchunk_T;
2310struct msgchunk_S
2311{
2312 msgchunk_T *sb_next;
2313 msgchunk_T *sb_prev;
2314 char sb_eol; /* TRUE when line ends after this text */
2315 int sb_msg_col; /* column in which text starts */
2316 int sb_attr; /* text attributes */
2317 char_u sb_text[1]; /* text to be displayed, actually longer */
2318};
2319
2320static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2321
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002322static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002323
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002324typedef enum {
2325 SB_CLEAR_NONE = 0,
2326 SB_CLEAR_ALL,
2327 SB_CLEAR_CMDLINE_BUSY,
2328 SB_CLEAR_CMDLINE_DONE
2329} sb_clear_T;
2330
2331/* When to clear text on next msg. */
2332static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002333
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002334/*
2335 * Store part of a printed message for displaying when scrolling back.
2336 */
2337 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002338store_sb_text(
2339 char_u **sb_str, /* start of string */
2340 char_u *s, /* just after string */
2341 int attr,
2342 int *sb_col,
2343 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002344{
2345 msgchunk_T *mp;
2346
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002347 if (do_clear_sb_text == SB_CLEAR_ALL
2348 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002349 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002350 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2351 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002352 }
2353
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002354 if (s > *sb_str)
2355 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002356 mp = alloc(sizeof(msgchunk_T) + (s - *sb_str));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002357 if (mp != NULL)
2358 {
2359 mp->sb_eol = finish;
2360 mp->sb_msg_col = *sb_col;
2361 mp->sb_attr = attr;
2362 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2363
2364 if (last_msgchunk == NULL)
2365 {
2366 last_msgchunk = mp;
2367 mp->sb_prev = NULL;
2368 }
2369 else
2370 {
2371 mp->sb_prev = last_msgchunk;
2372 last_msgchunk->sb_next = mp;
2373 last_msgchunk = mp;
2374 }
2375 mp->sb_next = NULL;
2376 }
2377 }
2378 else if (finish && last_msgchunk != NULL)
2379 last_msgchunk->sb_eol = TRUE;
2380
2381 *sb_str = s;
2382 *sb_col = 0;
2383}
2384
2385/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002386 * Finished showing messages, clear the scroll-back text on the next message.
2387 */
2388 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002389may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002390{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002391 do_clear_sb_text = SB_CLEAR_ALL;
2392}
2393
2394/*
2395 * Starting to edit the command line, do not clear messages now.
2396 */
2397 void
2398sb_text_start_cmdline(void)
2399{
2400 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2401 msg_sb_eol();
2402}
2403
2404/*
2405 * Ending to edit the command line. Clear old lines but the last one later.
2406 */
2407 void
2408sb_text_end_cmdline(void)
2409{
2410 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002411}
2412
2413/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002414 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002415 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002416 * Called when redrawing the screen.
2417 */
2418 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002419clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002420{
2421 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002422 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002423
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002424 if (all)
2425 lastp = &last_msgchunk;
2426 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002427 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002428 if (last_msgchunk == NULL)
2429 return;
2430 lastp = &last_msgchunk->sb_prev;
2431 }
2432
2433 while (*lastp != NULL)
2434 {
2435 mp = (*lastp)->sb_prev;
2436 vim_free(*lastp);
2437 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002438 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002439}
2440
2441/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002442 * "g<" command.
2443 */
2444 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002445show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002446{
2447 msgchunk_T *mp;
2448
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002449 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002450 * weird, typing a command without output results in one line. */
2451 mp = msg_sb_start(last_msgchunk);
2452 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002453 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002454 else
2455 {
2456 do_more_prompt('G');
2457 wait_return(FALSE);
2458 }
2459}
2460
2461/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002462 * Move to the start of screen line in already displayed text.
2463 */
2464 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002465msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002466{
2467 msgchunk_T *mp = mps;
2468
2469 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2470 mp = mp->sb_prev;
2471 return mp;
2472}
2473
2474/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002475 * Mark the last message chunk as finishing the line.
2476 */
2477 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002478msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002479{
2480 if (last_msgchunk != NULL)
2481 last_msgchunk->sb_eol = TRUE;
2482}
2483
2484/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002485 * Display a screen line from previously displayed text at row "row".
2486 * Returns a pointer to the text for the next line (can be NULL).
2487 */
2488 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002489disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002490{
2491 msgchunk_T *mp = smp;
2492 char_u *p;
2493
2494 for (;;)
2495 {
2496 msg_row = row;
2497 msg_col = mp->sb_msg_col;
2498 p = mp->sb_text;
2499 if (*p == '\n') /* don't display the line break */
2500 ++p;
2501 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2502 if (mp->sb_eol || mp->sb_next == NULL)
2503 break;
2504 mp = mp->sb_next;
2505 }
2506 return mp->sb_next;
2507}
2508
2509/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 * Output any postponed text for msg_puts_attr_len().
2511 */
2512 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002513t_puts(
2514 int *t_col,
2515 char_u *t_s,
2516 char_u *s,
2517 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518{
2519 /* output postponed text */
2520 msg_didout = TRUE; /* remember that line is not empty */
2521 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002522 msg_col += *t_col;
2523 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 /* If the string starts with a composing character don't increment the
2525 * column position for it. */
2526 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2527 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 if (msg_col >= Columns)
2529 {
2530 msg_col = 0;
2531 ++msg_row;
2532 }
2533}
2534
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535/*
2536 * Returns TRUE when messages should be printed with mch_errmsg().
2537 * This is used when there is no valid screen, so we can see error messages.
2538 * If termcap is not active, we may be writing in an alternate console
2539 * window, cursor positioning may not work correctly (window size may be
2540 * different, e.g. for Win32 console) or we just don't know where the
2541 * cursor is.
2542 */
2543 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002544msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545{
2546 return (!msg_check_screen()
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002547#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2548# ifdef VIMDLL
2549 || (!gui.in_use && !termcap_active)
2550# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 || !termcap_active
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002552# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553#endif
2554 || (swapping_screen() && !termcap_active)
2555 );
2556}
2557
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002558/*
2559 * Print a message when there is no valid screen.
2560 */
2561 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002562msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002563{
2564 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002565 char_u *buf = NULL;
2566 char_u *p = s;
2567
Bram Moolenaar4f974752019-02-17 17:44:42 +01002568#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002569 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002570 mch_settmode(TMODE_COOK); /* handle CR and NL correctly */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002571#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002572 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002573 {
2574 if (!(silent_mode && p_verbose == 0))
2575 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002576 // NL --> CR NL translation (for Unix, not for "--version")
2577 if (*s == NL)
2578 {
2579 int n = (int)(s - p);
2580
2581 buf = alloc(n + 3);
Bram Moolenaar6f10c702019-08-20 22:58:37 +02002582 if (buf != NULL)
2583 {
2584 memcpy(buf, p, n);
2585 if (!info_message)
2586 buf[n++] = CAR;
2587 buf[n++] = NL;
2588 buf[n++] = NUL;
2589 if (info_message) // informative message, not an error
2590 mch_msg((char *)buf);
2591 else
2592 mch_errmsg((char *)buf);
2593 vim_free(buf);
2594 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002595 p = s + 1;
2596 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002597 }
2598
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002599 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002600#ifdef FEAT_RIGHTLEFT
2601 if (cmdmsg_rl)
2602 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002603 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002604 msg_col = Columns - 1;
2605 else
2606 --msg_col;
2607 }
2608 else
2609#endif
2610 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002611 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002612 msg_col = 0;
2613 else
2614 ++msg_col;
2615 }
2616 ++s;
2617 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002618
2619 if (*p != NUL && !(silent_mode && p_verbose == 0))
2620 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002621 int c = -1;
2622
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002623 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002624 {
2625 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002626 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002627 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002628 if (info_message)
2629 mch_msg((char *)p);
2630 else
2631 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002632 if (c != -1)
2633 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002634 }
2635
2636 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002637
Bram Moolenaar4f974752019-02-17 17:44:42 +01002638#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639 if (!(silent_mode && p_verbose == 0))
2640 mch_settmode(TMODE_RAW);
2641#endif
2642}
2643
2644/*
2645 * Show the more-prompt and handle the user response.
2646 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002647 * When at hit-enter prompt "typed_char" is the already typed character,
2648 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002649 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2650 */
2651 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002652do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002653{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002654 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002655 int used_typed_char = typed_char;
2656 int oldState = State;
2657 int c;
2658#ifdef FEAT_CON_DIALOG
2659 int retval = FALSE;
2660#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002661 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002662 msgchunk_T *mp_last = NULL;
2663 msgchunk_T *mp;
2664 int i;
2665
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002666 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002667 * that case don't show another prompt. Also when at the hit-Enter prompt
2668 * and nothing was typed. */
2669 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002670 return FALSE;
2671 entered = TRUE;
2672
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002673 if (typed_char == 'G')
2674 {
2675 /* "g<": Find first line on the last page. */
2676 mp_last = msg_sb_start(last_msgchunk);
2677 for (i = 0; i < Rows - 2 && mp_last != NULL
2678 && mp_last->sb_prev != NULL; ++i)
2679 mp_last = msg_sb_start(mp_last->sb_prev);
2680 }
2681
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002682 State = ASKMORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002683 setmouse();
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002684 if (typed_char == NUL)
2685 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002686 for (;;)
2687 {
2688 /*
2689 * Get a typed character directly from the user.
2690 */
2691 if (used_typed_char != NUL)
2692 {
2693 c = used_typed_char; /* was typed at hit-enter prompt */
2694 used_typed_char = NUL;
2695 }
2696 else
2697 c = get_keystroke();
2698
2699#if defined(FEAT_MENU) && defined(FEAT_GUI)
2700 if (c == K_MENU)
2701 {
2702 int idx = get_menu_index(current_menu, ASKMORE);
2703
2704 /* Used a menu. If it starts with CTRL-Y, it must
2705 * be a "Copy" for the clipboard. Otherwise
2706 * assume that we end */
2707 if (idx == MENU_INDEX_INVALID)
2708 continue;
2709 c = *current_menu->strings[idx];
2710 if (c != NUL && current_menu->strings[idx][1] != NUL)
2711 ins_typebuf(current_menu->strings[idx] + 1,
2712 current_menu->noremap[idx], 0, TRUE,
2713 current_menu->silent[idx]);
2714 }
2715#endif
2716
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002717 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002718 switch (c)
2719 {
2720 case BS: /* scroll one line back */
2721 case K_BS:
2722 case 'k':
2723 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002724 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002725 break;
2726
2727 case CAR: /* one extra line */
2728 case NL:
2729 case 'j':
2730 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002731 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002732 break;
2733
2734 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002735 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002736 break;
2737
2738 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002739 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002740 break;
2741
2742 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002743 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002744 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002745 break;
2746
2747 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002748 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002749 case K_PAGEDOWN:
2750 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002751 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002752 break;
2753
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002754 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002755 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002756 break;
2757
2758 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002759 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002760 lines_left = 999999;
2761 break;
2762
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002763 case ':': /* start new command line */
2764#ifdef FEAT_CON_DIALOG
2765 if (!confirm_msg_used)
2766#endif
2767 {
2768 /* Since got_int is set all typeahead will be flushed, but we
2769 * want to keep this ':', remember that in a special way. */
2770 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002771#ifdef FEAT_TERMINAL
2772 skip_term_loop = TRUE;
2773#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002774 cmdline_row = Rows - 1; /* put ':' on this line */
2775 skip_redraw = TRUE; /* skip redraw once */
2776 need_wait_return = FALSE; /* don't wait in main() */
2777 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002778 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002779 case 'q': /* quit */
2780 case Ctrl_C:
2781 case ESC:
2782#ifdef FEAT_CON_DIALOG
2783 if (confirm_msg_used)
2784 {
2785 /* Jump to the choices of the dialog. */
2786 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002787 }
2788 else
2789#endif
2790 {
2791 got_int = TRUE;
2792 quit_more = TRUE;
2793 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002794 /* When there is some more output (wrapping line) display that
2795 * without another prompt. */
2796 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002797 break;
2798
2799#ifdef FEAT_CLIPBOARD
2800 case Ctrl_Y:
2801 /* Strange way to allow copying (yanking) a modeless
2802 * selection at the more prompt. Use CTRL-Y,
2803 * because the same is used in Cmdline-mode and at the
2804 * hit-enter prompt. However, scrolling one line up
2805 * might be expected... */
2806 if (clip_star.state == SELECT_DONE)
2807 clip_copy_modeless_selection(TRUE);
2808 continue;
2809#endif
2810 default: /* no valid response */
2811 msg_moremsg(TRUE);
2812 continue;
2813 }
2814
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002815 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002816 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002817 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002818 {
2819 /* go to start of last line */
2820 if (mp_last == NULL)
2821 mp = msg_sb_start(last_msgchunk);
2822 else if (mp_last->sb_prev != NULL)
2823 mp = msg_sb_start(mp_last->sb_prev);
2824 else
2825 mp = NULL;
2826
2827 /* go to start of line at top of the screen */
2828 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2829 ++i)
2830 mp = msg_sb_start(mp->sb_prev);
2831
2832 if (mp != NULL && mp->sb_prev != NULL)
2833 {
2834 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002835 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002836 {
2837 if (mp == NULL || mp->sb_prev == NULL)
2838 break;
2839 mp = msg_sb_start(mp->sb_prev);
2840 if (mp_last == NULL)
2841 mp_last = msg_sb_start(last_msgchunk);
2842 else
2843 mp_last = msg_sb_start(mp_last->sb_prev);
2844 }
2845
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002846 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002847 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002848 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002849 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002850 (void)disp_sb_line(0, mp);
2851 }
2852 else
2853 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002854 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002855 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002856 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2857 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002858 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002859 ++msg_scrolled;
2860 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002861 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002862 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002863 }
2864 }
2865 else
2866 {
2867 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002868 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002869 {
2870 /* scroll up, display line at bottom */
2871 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002872 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002873 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2874 (int)Columns, ' ', ' ', 0);
2875 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002876 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002877 }
2878 }
2879
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002880 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002881 {
2882 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002883 screen_fill((int)Rows - 1, (int)Rows, 0,
2884 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002885 msg_moremsg(FALSE);
2886 continue;
2887 }
2888
2889 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002890 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002891 }
2892
2893 break;
2894 }
2895
2896 /* clear the --more-- message */
2897 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2898 State = oldState;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002899 setmouse();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002900 if (quit_more)
2901 {
2902 msg_row = Rows - 1;
2903 msg_col = 0;
2904 }
2905#ifdef FEAT_RIGHTLEFT
2906 else if (cmdmsg_rl)
2907 msg_col = Columns - 1;
2908#endif
2909
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002910 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002911#ifdef FEAT_CON_DIALOG
2912 return retval;
2913#else
2914 return FALSE;
2915#endif
2916}
2917
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2919
2920#ifdef mch_errmsg
2921# undef mch_errmsg
2922#endif
2923#ifdef mch_msg
2924# undef mch_msg
2925#endif
2926
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002927#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2928 static void
2929mch_errmsg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002931 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002932 DWORD nwrite = 0;
2933 DWORD mode = 0;
2934 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
2935
2936 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
2937 && (int)GetConsoleCP() != enc_codepage)
2938 {
2939 WCHAR *w = enc_to_utf16((char_u *)str, &len);
2940
2941 WriteConsoleW(h, w, len, &nwrite, NULL);
2942 vim_free(w);
2943 }
2944 else
2945 {
2946 fprintf(stderr, "%s", str);
2947 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002948}
2949#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002951/*
2952 * Give an error message. To be used when the screen hasn't been initialized
2953 * yet. When stderr can't be used, collect error messages until the GUI has
2954 * started and they can be displayed in a message box.
2955 */
2956 void
2957mch_errmsg(char *str)
2958{
2959#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
2960 int len;
2961#endif
2962
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02002963#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 /* On Unix use stderr if it's a tty.
2965 * When not going to start the GUI also use stderr.
2966 * On Mac, when started from Finder, stderr is the console. */
2967 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002968# ifdef UNIX
2969# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002971# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 isatty(2)
2973# endif
2974# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002975 ||
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002976# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002977# endif
2978# ifdef FEAT_GUI
2979 !(gui.in_use || gui.starting)
2980# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 )
2982 {
2983 fprintf(stderr, "%s", str);
2984 return;
2985 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002986#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002988#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2989# ifdef VIMDLL
2990 if (!(gui.in_use || gui.starting))
2991# endif
2992 {
2993 mch_errmsg_c(str);
2994 return;
2995 }
2996#endif
2997
2998#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 /* avoid a delay for a message that isn't there */
3000 emsg_on_display = FALSE;
3001
3002 len = (int)STRLEN(str) + 1;
3003 if (error_ga.ga_growsize == 0)
3004 {
3005 error_ga.ga_growsize = 80;
3006 error_ga.ga_itemsize = 1;
3007 }
3008 if (ga_grow(&error_ga, len) == OK)
3009 {
3010 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3011 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003012# ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 /* remove CR characters, they are displayed */
3014 {
3015 char_u *p;
3016
3017 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3018 for (;;)
3019 {
3020 p = vim_strchr(p, '\r');
3021 if (p == NULL)
3022 break;
3023 *p = ' ';
3024 }
3025 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003026# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 --len; /* don't count the NUL at the end */
3028 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003030#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031}
3032
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003033#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3034 static void
3035mch_msg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003037 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003038 DWORD nwrite = 0;
3039 DWORD mode;
3040 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3041
3042
3043 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3044 && (int)GetConsoleCP() != enc_codepage)
3045 {
3046 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3047
3048 WriteConsoleW(h, w, len, &nwrite, NULL);
3049 vim_free(w);
3050 }
3051 else
3052 {
3053 printf("%s", str);
3054 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003055}
3056#endif
3057
3058/*
3059 * Give a message. To be used when the screen hasn't been initialized yet.
3060 * When there is no tty, collect messages until the GUI has started and they
3061 * can be displayed in a message box.
3062 */
3063 void
3064mch_msg(char *str)
3065{
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003066#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3068 * uses mch_errmsg() when started from the desktop.
3069 * When not going to start the GUI also use stdout.
3070 * On Mac, when started from Finder, stderr is the console. */
3071 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003072# ifdef UNIX
3073# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003075# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 isatty(2)
Bram Moolenaareae1b912019-05-09 15:12:55 +02003077# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003079 ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003081# endif
3082# ifdef FEAT_GUI
3083 !(gui.in_use || gui.starting)
3084# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 )
3086 {
3087 printf("%s", str);
3088 return;
3089 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003090#endif
3091
3092#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3093# ifdef VIMDLL
3094 if (!(gui.in_use || gui.starting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003096 {
3097 mch_msg_c(str);
3098 return;
3099 }
3100#endif
3101#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003103#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104}
3105#endif /* USE_MCH_ERRMSG */
3106
3107/*
3108 * Put a character on the screen at the current message position and advance
3109 * to the next position. Only for printable ASCII!
3110 */
3111 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003112msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113{
3114 msg_didout = TRUE; /* remember that line is not empty */
3115 screen_putchar(c, msg_row, msg_col, attr);
3116#ifdef FEAT_RIGHTLEFT
3117 if (cmdmsg_rl)
3118 {
3119 if (--msg_col == 0)
3120 {
3121 msg_col = Columns;
3122 ++msg_row;
3123 }
3124 }
3125 else
3126#endif
3127 {
3128 if (++msg_col >= Columns)
3129 {
3130 msg_col = 0;
3131 ++msg_row;
3132 }
3133 }
3134}
3135
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003136 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003137msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003139 int attr;
3140 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141
Bram Moolenaar8820b482017-03-16 17:23:31 +01003142 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003143 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003145 screen_puts((char_u *)
3146 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3147 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148}
3149
3150/*
3151 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3152 * exmode_active.
3153 */
3154 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003155repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156{
3157 if (State == ASKMORE)
3158 {
3159 msg_moremsg(TRUE); /* display --more-- message again */
3160 msg_row = Rows - 1;
3161 }
3162#ifdef FEAT_CON_DIALOG
3163 else if (State == CONFIRM)
3164 {
3165 display_confirm_msg(); /* display ":confirm" message again */
3166 msg_row = Rows - 1;
3167 }
3168#endif
3169 else if (State == EXTERNCMD)
3170 {
3171 windgoto(msg_row, msg_col); /* put cursor back */
3172 }
3173 else if (State == HITRETURN || State == SETWSIZE)
3174 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003175 if (msg_row == Rows - 1)
3176 {
3177 /* Avoid drawing the "hit-enter" prompt below the previous one,
3178 * overwrite it. Esp. useful when regaining focus and a
3179 * FocusGained autocmd exists but didn't draw anything. */
3180 msg_didout = FALSE;
3181 msg_col = 0;
3182 msg_clr_eos();
3183 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 hit_return_msg();
3185 msg_row = Rows - 1;
3186 }
3187}
3188
3189/*
3190 * msg_check_screen - check if the screen is initialized.
3191 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3192 * While starting the GUI the terminal codes will be set for the GUI, but the
3193 * output goes to the terminal. Don't use the terminal codes then.
3194 */
3195 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003196msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197{
3198 if (!full_screen || !screen_valid(FALSE))
3199 return FALSE;
3200
3201 if (msg_row >= Rows)
3202 msg_row = Rows - 1;
3203 if (msg_col >= Columns)
3204 msg_col = Columns - 1;
3205 return TRUE;
3206}
3207
3208/*
3209 * Clear from current message position to end of screen.
3210 * Skip this when ":silent" was used, no need to clear for redirection.
3211 */
3212 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003213msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214{
3215 if (msg_silent == 0)
3216 msg_clr_eos_force();
3217}
3218
3219/*
3220 * Clear from current message position to end of screen.
3221 * Note: msg_col is not updated, so we remember the end of the message
3222 * for msg_check().
3223 */
3224 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003225msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226{
3227 if (msg_use_printf())
3228 {
3229 if (full_screen) /* only when termcap codes are valid */
3230 {
3231 if (*T_CD)
3232 out_str(T_CD); /* clear to end of display */
3233 else if (*T_CE)
3234 out_str(T_CE); /* clear to end of line */
3235 }
3236 }
3237 else
3238 {
3239#ifdef FEAT_RIGHTLEFT
3240 if (cmdmsg_rl)
3241 {
3242 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3243 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3244 }
3245 else
3246#endif
3247 {
3248 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3249 ' ', ' ', 0);
3250 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3251 }
3252 }
3253}
3254
3255/*
3256 * Clear the command line.
3257 */
3258 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003259msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260{
3261 msg_row = cmdline_row;
3262 msg_col = 0;
3263 msg_clr_eos_force();
3264}
3265
3266/*
3267 * end putting a message on the screen
3268 * call wait_return if the message does not fit in the available space
3269 * return TRUE if wait_return not called.
3270 */
3271 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003272msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273{
3274 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003275 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 * or the ruler option is set and we run into it,
3277 * we have to redraw the window.
3278 * Do not do this if we are abandoning the file or editing the command line.
3279 */
3280 if (!exiting && need_wait_return && !(State & CMDLINE))
3281 {
3282 wait_return(FALSE);
3283 return FALSE;
3284 }
3285 out_flush();
3286 return TRUE;
3287}
3288
3289/*
3290 * If the written message runs into the shown command or ruler, we have to
3291 * wait for hit-return and redraw the window later.
3292 */
3293 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003294msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295{
3296 if (msg_row == Rows - 1 && msg_col >= sc_col)
3297 {
3298 need_wait_return = TRUE;
3299 redraw_cmdline = TRUE;
3300 }
3301}
3302
3303/*
3304 * May write a string to the redirection file.
3305 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3306 */
3307 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003308redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309{
3310 char_u *s = str;
3311 static int cur_col = 0;
3312
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003313 /* Don't do anything for displaying prompts and the like. */
3314 if (redir_off)
3315 return;
3316
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003317 /* If 'verbosefile' is set prepare for writing in that file. */
3318 if (*p_vfile != NUL && verbose_fd == NULL)
3319 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003320
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003321 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 {
3323 /* If the string doesn't start with CR or NL, go to msg_col */
3324 if (*s != '\n' && *s != '\r')
3325 {
3326 while (cur_col < msg_col)
3327 {
3328#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003329 if (redir_execute)
3330 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003331 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003333 else if (redir_vname)
3334 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003335 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003337 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003339 if (verbose_fd != NULL)
3340 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 ++cur_col;
3342 }
3343 }
3344
3345#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003346 if (redir_execute)
3347 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003348 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003350 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003351 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352#endif
3353
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003354 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3356 {
3357#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003358 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003360 if (redir_fd != NULL)
3361 putc(*s, redir_fd);
3362 if (verbose_fd != NULL)
3363 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 if (*s == '\r' || *s == '\n')
3365 cur_col = 0;
3366 else if (*s == '\t')
3367 cur_col += (8 - cur_col % 8);
3368 else
3369 ++cur_col;
3370 ++s;
3371 }
3372
3373 if (msg_silent != 0) /* should update msg_col */
3374 msg_col = cur_col;
3375 }
3376}
3377
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003378 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003379redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003380{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003381 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003382#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003383 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003384#endif
3385 ;
3386}
3387
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003389 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003390 * Must always be called paired with verbose_leave()!
3391 */
3392 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003393verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003394{
3395 if (*p_vfile != NUL)
3396 ++msg_silent;
3397}
3398
3399/*
3400 * After giving verbose message.
3401 * Must always be called paired with verbose_enter()!
3402 */
3403 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003404verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003405{
3406 if (*p_vfile != NUL)
3407 if (--msg_silent < 0)
3408 msg_silent = 0;
3409}
3410
3411/*
3412 * Like verbose_enter() and set msg_scroll when displaying the message.
3413 */
3414 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003415verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003416{
3417 if (*p_vfile != NUL)
3418 ++msg_silent;
3419 else
3420 /* always scroll up, don't overwrite */
3421 msg_scroll = TRUE;
3422}
3423
3424/*
3425 * Like verbose_leave() and set cmdline_row when displaying the message.
3426 */
3427 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003428verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003429{
3430 if (*p_vfile != NUL)
3431 {
3432 if (--msg_silent < 0)
3433 msg_silent = 0;
3434 }
3435 else
3436 cmdline_row = msg_row;
3437}
3438
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003439/*
3440 * Called when 'verbosefile' is set: stop writing to the file.
3441 */
3442 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003443verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003444{
3445 if (verbose_fd != NULL)
3446 {
3447 fclose(verbose_fd);
3448 verbose_fd = NULL;
3449 }
3450 verbose_did_open = FALSE;
3451}
3452
3453/*
3454 * Open the file 'verbosefile'.
3455 * Return FAIL or OK.
3456 */
3457 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003458verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003459{
3460 if (verbose_fd == NULL && !verbose_did_open)
3461 {
3462 /* Only give the error message once. */
3463 verbose_did_open = TRUE;
3464
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003465 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003466 if (verbose_fd == NULL)
3467 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003468 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003469 return FAIL;
3470 }
3471 }
3472 return OK;
3473}
3474
3475/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 * Give a warning message (for searching).
3477 * Use 'w' highlighting and may repeat the message after redrawing
3478 */
3479 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003480give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481{
3482 /* Don't do this for ":silent". */
3483 if (msg_silent != 0)
3484 return;
3485
3486 /* Don't want a hit-enter prompt here. */
3487 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003488
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489#ifdef FEAT_EVAL
3490 set_vim_var_string(VV_WARNINGMSG, message, -1);
3491#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003492 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003494 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 else
3496 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003497 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003498 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 msg_didout = FALSE; /* overwrite this message */
3500 msg_nowait = TRUE; /* don't wait for this message */
3501 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003502
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 --no_wait_return;
3504}
3505
Bram Moolenaar113e1072019-01-20 15:30:40 +01003506#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003507 void
3508give_warning2(char_u *message, char_u *a1, int hl)
3509{
3510 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3511 give_warning(IObuff, hl);
3512}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003513#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003514
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515/*
3516 * Advance msg cursor to column "col".
3517 */
3518 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003519msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520{
3521 if (msg_silent != 0) /* nothing to advance to */
3522 {
3523 msg_col = col; /* for redirection, may fill it up later */
3524 return;
3525 }
3526 if (col >= Columns) /* not enough room */
3527 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003528#ifdef FEAT_RIGHTLEFT
3529 if (cmdmsg_rl)
3530 while (msg_col > Columns - col)
3531 msg_putchar(' ');
3532 else
3533#endif
3534 while (msg_col < col)
3535 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536}
3537
3538#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3539/*
3540 * Used for "confirm()" function, and the :confirm command prefix.
3541 * Versions which haven't got flexible dialogs yet, and console
3542 * versions, get this generic handler which uses the command line.
3543 *
3544 * type = one of:
3545 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3546 * title = title string (can be NULL for default)
3547 * (neither used in console dialogs at the moment)
3548 *
3549 * Format of the "buttons" string:
3550 * "Button1Name\nButton2Name\nButton3Name"
3551 * The first button should normally be the default/accept
3552 * The second button should be the 'Cancel' button
3553 * Other buttons- use your imagination!
3554 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3555 * different letter.
3556 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003558do_dialog(
3559 int type UNUSED,
3560 char_u *title UNUSED,
3561 char_u *message,
3562 char_u *buttons,
3563 int dfltbutton,
3564 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003565 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003566 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003567 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568{
3569 int oldState;
3570 int retval = 0;
3571 char_u *hotkeys;
3572 int c;
3573 int i;
3574
3575#ifndef NO_CONSOLE
3576 /* Don't output anything in silent mode ("ex -s") */
3577 if (silent_mode)
3578 return dfltbutton; /* return default option */
3579#endif
3580
3581#ifdef FEAT_GUI_DIALOG
3582 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3583 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3584 {
3585 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003586 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003587 /* avoid a hit-enter prompt without clearing the cmdline */
3588 need_wait_return = FALSE;
3589 emsg_on_display = FALSE;
3590 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591
3592 /* Flush output to avoid that further messages and redrawing is done
3593 * in the wrong order. */
3594 out_flush();
3595 gui_mch_update();
3596
3597 return c;
3598 }
3599#endif
3600
3601 oldState = State;
3602 State = CONFIRM;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604
3605 /*
3606 * Since we wait for a keypress, don't make the
3607 * user press RETURN as well afterwards.
3608 */
3609 ++no_wait_return;
3610 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3611
3612 if (hotkeys != NULL)
3613 {
3614 for (;;)
3615 {
3616 /* Get a typed character directly from the user. */
3617 c = get_keystroke();
3618 switch (c)
3619 {
3620 case CAR: /* User accepts default option */
3621 case NL:
3622 retval = dfltbutton;
3623 break;
3624 case Ctrl_C: /* User aborts/cancels */
3625 case ESC:
3626 retval = 0;
3627 break;
3628 default: /* Could be a hotkey? */
3629 if (c < 0) /* special keys are ignored here */
3630 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003631 if (c == ':' && ex_cmd)
3632 {
3633 retval = dfltbutton;
3634 ins_char_typebuf(':');
3635 break;
3636 }
3637
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 /* Make the character lowercase, as chars in "hotkeys" are. */
3639 c = MB_TOLOWER(c);
3640 retval = 1;
3641 for (i = 0; hotkeys[i]; ++i)
3642 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 if (has_mbyte)
3644 {
3645 if ((*mb_ptr2char)(hotkeys + i) == c)
3646 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003647 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 }
3649 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 if (hotkeys[i] == c)
3651 break;
3652 ++retval;
3653 }
3654 if (hotkeys[i])
3655 break;
3656 /* No hotkey match, so keep waiting */
3657 continue;
3658 }
3659 break;
3660 }
3661
3662 vim_free(hotkeys);
3663 }
3664
3665 State = oldState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 --no_wait_return;
3668 msg_end_prompt();
3669
3670 return retval;
3671}
3672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673/*
3674 * Copy one character from "*from" to "*to", taking care of multi-byte
3675 * characters. Return the length of the character in bytes.
3676 */
3677 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003678copy_char(
3679 char_u *from,
3680 char_u *to,
3681 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 int len;
3684 int c;
3685
3686 if (has_mbyte)
3687 {
3688 if (lowercase)
3689 {
3690 c = MB_TOLOWER((*mb_ptr2char)(from));
3691 return (*mb_char2bytes)(c, to);
3692 }
3693 else
3694 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003695 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 mch_memmove(to, from, (size_t)len);
3697 return len;
3698 }
3699 }
3700 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 {
3702 if (lowercase)
3703 *to = (char_u)TOLOWER_LOC(*from);
3704 else
3705 *to = *from;
3706 return 1;
3707 }
3708}
3709
3710/*
3711 * Format the dialog string, and display it at the bottom of
3712 * the screen. Return a string of hotkey chars (if defined) for
3713 * each 'button'. If a button has no hotkey defined, the first character of
3714 * the button is used.
3715 * The hotkeys can be multi-byte characters, but without combining chars.
3716 *
3717 * Returns an allocated string with hotkeys, or NULL for error.
3718 */
3719 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003720msg_show_console_dialog(
3721 char_u *message,
3722 char_u *buttons,
3723 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724{
3725 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003726#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 int lenhotkey = HOTK_LEN; /* count first button */
3728 char_u *hotk = NULL;
3729 char_u *msgp = NULL;
3730 char_u *hotkp = NULL;
3731 char_u *r;
3732 int copy;
3733#define HAS_HOTKEY_LEN 30
3734 char_u has_hotkey[HAS_HOTKEY_LEN];
3735 int first_hotkey = FALSE; /* first char of button is hotkey */
3736 int idx;
3737
3738 has_hotkey[0] = FALSE;
3739
3740 /*
3741 * First loop: compute the size of memory to allocate.
3742 * Second loop: copy to the allocated memory.
3743 */
3744 for (copy = 0; copy <= 1; ++copy)
3745 {
3746 r = buttons;
3747 idx = 0;
3748 while (*r)
3749 {
3750 if (*r == DLG_BUTTON_SEP)
3751 {
3752 if (copy)
3753 {
3754 *msgp++ = ',';
3755 *msgp++ = ' '; /* '\n' -> ', ' */
3756
3757 /* advance to next hotkey and set default hotkey */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003759 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003762 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 if (dfltbutton)
3764 --dfltbutton;
3765
3766 /* If no hotkey is specified first char is used. */
3767 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3768 first_hotkey = TRUE;
3769 }
3770 else
3771 {
3772 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3773 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3774 if (idx < HAS_HOTKEY_LEN - 1)
3775 has_hotkey[++idx] = FALSE;
3776 }
3777 }
3778 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3779 {
3780 if (*r == DLG_HOTKEY_CHAR)
3781 ++r;
3782 first_hotkey = FALSE;
3783 if (copy)
3784 {
3785 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3786 *msgp++ = *r;
3787 else
3788 {
3789 /* '&a' -> '[a]' */
3790 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3791 msgp += copy_char(r, msgp, FALSE);
3792 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3793
3794 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003795 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 }
3797 }
3798 else
3799 {
3800 ++len; /* '&a' -> '[a]' */
3801 if (idx < HAS_HOTKEY_LEN - 1)
3802 has_hotkey[idx] = TRUE;
3803 }
3804 }
3805 else
3806 {
3807 /* everything else copy literally */
3808 if (copy)
3809 msgp += copy_char(r, msgp, FALSE);
3810 }
3811
3812 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003813 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 }
3815
3816 if (copy)
3817 {
3818 *msgp++ = ':';
3819 *msgp++ = ' ';
3820 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 }
3822 else
3823 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003824 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003825 + 2 /* for the NL's */
3826 + STRLEN(buttons)
3827 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003828 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829
3830 /* If no hotkey is specified first char is used. */
3831 if (!has_hotkey[0])
3832 {
3833 first_hotkey = TRUE;
3834 len += 2; /* "x" -> "[x]" */
3835 }
3836
3837 /*
3838 * Now allocate and load the strings
3839 */
3840 vim_free(confirm_msg);
3841 confirm_msg = alloc(len);
3842 if (confirm_msg == NULL)
3843 return NULL;
3844 *confirm_msg = NUL;
3845 hotk = alloc(lenhotkey);
3846 if (hotk == NULL)
3847 return NULL;
3848
3849 *confirm_msg = '\n';
3850 STRCPY(confirm_msg + 1, message);
3851
3852 msgp = confirm_msg + 1 + STRLEN(message);
3853 hotkp = hotk;
3854
Bram Moolenaar6a516062007-07-05 08:11:42 +00003855 /* Define first default hotkey. Keep the hotkey string NUL
3856 * terminated to avoid reading past the end. */
3857 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858
3859 /* Remember where the choices start, displaying starts here when
3860 * "hotkp" typed at the more prompt. */
3861 confirm_msg_tail = msgp;
3862 *msgp++ = '\n';
3863 }
3864 }
3865
3866 display_confirm_msg();
3867 return hotk;
3868}
3869
3870/*
3871 * Display the ":confirm" message. Also called when screen resized.
3872 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003873 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003874display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875{
3876 /* avoid that 'q' at the more prompt truncates the message here */
3877 ++confirm_msg_used;
3878 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003879 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 --confirm_msg_used;
3881}
3882
3883#endif /* FEAT_CON_DIALOG */
3884
3885#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3886
3887 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003888vim_dialog_yesno(
3889 int type,
3890 char_u *title,
3891 char_u *message,
3892 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893{
3894 if (do_dialog(type,
3895 title == NULL ? (char_u *)_("Question") : title,
3896 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003897 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 return VIM_YES;
3899 return VIM_NO;
3900}
3901
3902 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003903vim_dialog_yesnocancel(
3904 int type,
3905 char_u *title,
3906 char_u *message,
3907 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908{
3909 switch (do_dialog(type,
3910 title == NULL ? (char_u *)_("Question") : title,
3911 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003912 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 {
3914 case 1: return VIM_YES;
3915 case 2: return VIM_NO;
3916 }
3917 return VIM_CANCEL;
3918}
3919
3920 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003921vim_dialog_yesnoallcancel(
3922 int type,
3923 char_u *title,
3924 char_u *message,
3925 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926{
3927 switch (do_dialog(type,
3928 title == NULL ? (char_u *)"Question" : title,
3929 message,
3930 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003931 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 {
3933 case 1: return VIM_YES;
3934 case 2: return VIM_NO;
3935 case 3: return VIM_ALL;
3936 case 4: return VIM_DISCARDALL;
3937 }
3938 return VIM_CANCEL;
3939}
3940
3941#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3942
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003943#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003944static char *e_printf = N_("E766: Insufficient arguments for printf()");
3945
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003946/*
3947 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3948 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003949 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003950tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003951{
3952 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003953 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003954 int err = FALSE;
3955
3956 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003957 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003958 else
3959 {
3960 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003961 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003962 if (err)
3963 n = 0;
3964 }
3965 return n;
3966}
3967
3968/*
3969 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003970 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02003971 * are not converted to a string.
3972 * If "tofree" is not NULL echo_string() is used. All types are converted to
3973 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00003974 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003975 */
3976 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02003977tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003978{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02003979 int idx = *idxp - 1;
3980 char *s = NULL;
3981 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003982
3983 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003984 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003985 else
3986 {
3987 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02003988 if (tofree != NULL)
3989 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
3990 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003991 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003992 }
3993 return s;
3994}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003995
3996# ifdef FEAT_FLOAT
3997/*
3998 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3999 */
4000 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004001tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004002{
4003 int idx = *idxp - 1;
4004 double f = 0;
4005
4006 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004007 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004008 else
4009 {
4010 ++*idxp;
4011 if (tvs[idx].v_type == VAR_FLOAT)
4012 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004013 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004014 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004015 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004016 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004017 }
4018 return f;
4019}
4020# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004021#endif
4022
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004023#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004024/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004025 * Return the representation of infinity for printf() function:
4026 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4027 */
4028 static const char *
4029infinity_str(int positive,
4030 char fmt_spec,
4031 int force_sign,
4032 int space_for_positive)
4033{
4034 static const char *table[] =
4035 {
4036 "-inf", "inf", "+inf", " inf",
4037 "-INF", "INF", "+INF", " INF"
4038 };
4039 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4040
4041 if (ASCII_ISUPPER(fmt_spec))
4042 idx += 4;
4043 return table[idx];
4044}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004045#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004046
4047/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004048 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004049 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004050 * consistency.
4051 *
4052 * This code is based on snprintf.c - a portable implementation of snprintf
4053 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004054 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004055 * The original code, including useful comments, can be found here:
4056 * http://www.ijs.si/software/snprintf/
4057 *
4058 * This snprintf() only supports the following conversion specifiers:
4059 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4060 * with flags: '-', '+', ' ', '0' and '#'.
4061 * An asterisk is supported for field width as well as precision.
4062 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004063 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004064 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004065 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4066 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004067 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004068 * The locale is not used, the string is used as a byte string. This is only
4069 * relevant for double-byte encodings where the second byte may be '%'.
4070 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004071 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4072 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004073 *
4074 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004075 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004076 * is greater or equal to "str_m", not all characters from the result
4077 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4078 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004079 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004080 */
4081
4082/*
4083 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004084 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004085 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004086 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004087 */
4088
4089/* When generating prototypes all of this is skipped, cproto doesn't
4090 * understand this. */
4091#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004092
Bram Moolenaara800b422010-06-27 01:15:55 +02004093/* Like vim_vsnprintf() but append to the string. */
4094 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004095vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004096{
4097 va_list ap;
4098 int str_l;
4099 size_t len = STRLEN(str);
4100 size_t space;
4101
4102 if (str_m <= len)
4103 space = 0;
4104 else
4105 space = str_m - len;
4106 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004107 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004108 va_end(ap);
4109 return str_l;
4110}
Bram Moolenaara800b422010-06-27 01:15:55 +02004111
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004112 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004113vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004114{
4115 va_list ap;
4116 int str_l;
4117
4118 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004119 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004120 va_end(ap);
4121 return str_l;
4122}
4123
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004124 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004125vim_vsnprintf(
4126 char *str,
4127 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004128 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004129 va_list ap)
4130{
4131 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4132}
4133
4134 int
4135vim_vsnprintf_typval(
4136 char *str,
4137 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004138 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004139 va_list ap,
4140 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004141{
4142 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004143 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004144 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004145
4146 if (p == NULL)
4147 p = "";
4148 while (*p != NUL)
4149 {
4150 if (*p != '%')
4151 {
4152 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004153 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004154
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004155 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004156 if (str_l < str_m)
4157 {
4158 size_t avail = str_m - str_l;
4159
4160 mch_memmove(str + str_l, p, n > avail ? avail : n);
4161 }
4162 p += n;
4163 str_l += n;
4164 }
4165 else
4166 {
4167 size_t min_field_width = 0, precision = 0;
4168 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4169 int alternate_form = 0, force_sign = 0;
4170
4171 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4172 * ignored. */
4173 int space_for_positive = 1;
4174
4175 /* allowed values: \0, h, l, L */
4176 char length_modifier = '\0';
4177
4178 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004179# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004180# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004181 * That sounds reasonable to use as the maximum
4182 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004183# elif defined(FEAT_NUM64)
4184# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004185# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004186# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004187# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004188 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004189
4190 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004191 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004192
4193 /* natural field width of arg without padding and sign */
4194 size_t str_arg_l;
4195
4196 /* unsigned char argument value - only defined for c conversion.
4197 * N.B. standard explicitly states the char argument for the c
4198 * conversion is unsigned */
4199 unsigned char uchar_arg;
4200
4201 /* number of zeros to be inserted for numeric conversions as
4202 * required by the precision or minimal field width */
4203 size_t number_of_zeros_to_pad = 0;
4204
4205 /* index into tmp where zero padding is to be inserted */
4206 size_t zero_padding_insertion_ind = 0;
4207
4208 /* current conversion specifier character */
4209 char fmt_spec = '\0';
4210
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004211 /* buffer for 's' and 'S' specs */
4212 char_u *tofree = NULL;
4213
4214
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004215 p++; /* skip '%' */
4216
4217 /* parse flags */
4218 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4219 || *p == '#' || *p == '\'')
4220 {
4221 switch (*p)
4222 {
4223 case '0': zero_padding = 1; break;
4224 case '-': justify_left = 1; break;
4225 case '+': force_sign = 1; space_for_positive = 0; break;
4226 case ' ': force_sign = 1;
4227 /* If both the ' ' and '+' flags appear, the ' '
4228 * flag should be ignored */
4229 break;
4230 case '#': alternate_form = 1; break;
4231 case '\'': break;
4232 }
4233 p++;
4234 }
4235 /* If the '0' and '-' flags both appear, the '0' flag should be
4236 * ignored. */
4237
4238 /* parse field width */
4239 if (*p == '*')
4240 {
4241 int j;
4242
4243 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004244 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004245# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004246 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004247# endif
4248 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004249 if (j >= 0)
4250 min_field_width = j;
4251 else
4252 {
4253 min_field_width = -j;
4254 justify_left = 1;
4255 }
4256 }
4257 else if (VIM_ISDIGIT((int)(*p)))
4258 {
4259 /* size_t could be wider than unsigned int; make sure we treat
4260 * argument like common implementations do */
4261 unsigned int uj = *p++ - '0';
4262
4263 while (VIM_ISDIGIT((int)(*p)))
4264 uj = 10 * uj + (unsigned int)(*p++ - '0');
4265 min_field_width = uj;
4266 }
4267
4268 /* parse precision */
4269 if (*p == '.')
4270 {
4271 p++;
4272 precision_specified = 1;
4273 if (*p == '*')
4274 {
4275 int j;
4276
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004277 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004278# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004279 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004280# endif
4281 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004282 p++;
4283 if (j >= 0)
4284 precision = j;
4285 else
4286 {
4287 precision_specified = 0;
4288 precision = 0;
4289 }
4290 }
4291 else if (VIM_ISDIGIT((int)(*p)))
4292 {
4293 /* size_t could be wider than unsigned int; make sure we
4294 * treat argument like common implementations do */
4295 unsigned int uj = *p++ - '0';
4296
4297 while (VIM_ISDIGIT((int)(*p)))
4298 uj = 10 * uj + (unsigned int)(*p++ - '0');
4299 precision = uj;
4300 }
4301 }
4302
4303 /* parse 'h', 'l' and 'll' length modifiers */
4304 if (*p == 'h' || *p == 'l')
4305 {
4306 length_modifier = *p;
4307 p++;
4308 if (length_modifier == 'l' && *p == 'l')
4309 {
4310 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004311# ifdef FEAT_NUM64
4312 length_modifier = 'L';
4313# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004314 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004315# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004316 p++;
4317 }
4318 }
4319 fmt_spec = *p;
4320
4321 /* common synonyms: */
4322 switch (fmt_spec)
4323 {
4324 case 'i': fmt_spec = 'd'; break;
4325 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4326 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4327 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4328 default: break;
4329 }
4330
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004331# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4332 switch (fmt_spec)
4333 {
4334 case 'd': case 'u': case 'o': case 'x': case 'X':
4335 if (tvs != NULL && length_modifier == '\0')
4336 length_modifier = 'L';
4337 }
4338# endif
4339
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004340 /* get parameter value, do initial processing */
4341 switch (fmt_spec)
4342 {
4343 /* '%' and 'c' behave similar to 's' regarding flags and field
4344 * widths */
4345 case '%':
4346 case 'c':
4347 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004348 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004349 str_arg_l = 1;
4350 switch (fmt_spec)
4351 {
4352 case '%':
4353 str_arg = p;
4354 break;
4355
4356 case 'c':
4357 {
4358 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004359
4360 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004361# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004362 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004363# endif
4364 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004365 /* standard demands unsigned char */
4366 uchar_arg = (unsigned char)j;
4367 str_arg = (char *)&uchar_arg;
4368 break;
4369 }
4370
4371 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004372 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004373 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004374# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004375 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004376# endif
4377 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004378 if (str_arg == NULL)
4379 {
4380 str_arg = "[NULL]";
4381 str_arg_l = 6;
4382 }
4383 /* make sure not to address string beyond the specified
4384 * precision !!! */
4385 else if (!precision_specified)
4386 str_arg_l = strlen(str_arg);
4387 /* truncate string if necessary as requested by precision */
4388 else if (precision == 0)
4389 str_arg_l = 0;
4390 else
4391 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004392 /* Don't put the #if inside memchr(), it can be a
4393 * macro. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004394 /* memchr on HP does not like n > 2^31 !!! */
4395 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004396 precision <= (size_t)0x7fffffffL ? precision
4397 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004398 str_arg_l = (q == NULL) ? precision
4399 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004400 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004401 if (fmt_spec == 'S')
4402 {
4403 if (min_field_width != 0)
4404 min_field_width += STRLEN(str_arg)
4405 - mb_string2cells((char_u *)str_arg, -1);
4406 if (precision)
4407 {
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004408 char_u *p1;
4409 size_t i = 0;
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004410
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004411 for (p1 = (char_u *)str_arg; *p1;
4412 p1 += mb_ptr2len(p1))
4413 {
4414 i += (size_t)mb_ptr2cells(p1);
4415 if (i > precision)
4416 break;
4417 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004418 str_arg_l = precision = p1 - (char_u *)str_arg;
4419 }
4420 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004421 break;
4422
4423 default:
4424 break;
4425 }
4426 break;
4427
Bram Moolenaar91984b92016-08-16 21:58:41 +02004428 case 'd': case 'u':
4429 case 'b': case 'B':
4430 case 'o':
4431 case 'x': case 'X':
4432 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004433 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004434 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004435 * imply the value is unsigned; d implies a signed
4436 * value */
4437
4438 /* 0 if numeric argument is zero (or if pointer is
4439 * NULL for 'p'), +1 if greater than zero (or nonzero
4440 * for unsigned arguments), -1 if negative (unsigned
4441 * argument is never negative) */
4442 int arg_sign = 0;
4443
4444 /* only defined for length modifier h, or for no
4445 * length modifiers */
4446 int int_arg = 0;
4447 unsigned int uint_arg = 0;
4448
4449 /* only defined for length modifier l */
4450 long int long_arg = 0;
4451 unsigned long int ulong_arg = 0;
4452
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004453# ifdef FEAT_NUM64
4454 /* only defined for length modifier ll */
4455 varnumber_T llong_arg = 0;
4456 uvarnumber_T ullong_arg = 0;
4457# endif
4458
Bram Moolenaare9997822016-08-28 16:03:38 +02004459 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004460 uvarnumber_T bin_arg = 0;
4461
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004462 /* pointer argument value -only defined for p
4463 * conversion */
4464 void *ptr_arg = NULL;
4465
4466 if (fmt_spec == 'p')
4467 {
4468 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004469 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004470# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004471 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4472 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004473# endif
4474 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004475 if (ptr_arg != NULL)
4476 arg_sign = 1;
4477 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004478 else if (fmt_spec == 'b' || fmt_spec == 'B')
4479 {
4480 bin_arg =
4481# if defined(FEAT_EVAL)
4482 tvs != NULL ?
4483 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4484# endif
4485 va_arg(ap, uvarnumber_T);
4486 if (bin_arg != 0)
4487 arg_sign = 1;
4488 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004489 else if (fmt_spec == 'd')
4490 {
4491 /* signed */
4492 switch (length_modifier)
4493 {
4494 case '\0':
4495 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004496 /* char and short arguments are passed as int. */
4497 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004498# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004499 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004500# endif
4501 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004502 if (int_arg > 0)
4503 arg_sign = 1;
4504 else if (int_arg < 0)
4505 arg_sign = -1;
4506 break;
4507 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004508 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004509# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004510 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004511# endif
4512 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004513 if (long_arg > 0)
4514 arg_sign = 1;
4515 else if (long_arg < 0)
4516 arg_sign = -1;
4517 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004518# ifdef FEAT_NUM64
4519 case 'L':
4520 llong_arg =
4521# if defined(FEAT_EVAL)
4522 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4523# endif
4524 va_arg(ap, varnumber_T);
4525 if (llong_arg > 0)
4526 arg_sign = 1;
4527 else if (llong_arg < 0)
4528 arg_sign = -1;
4529 break;
4530# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004531 }
4532 }
4533 else
4534 {
4535 /* unsigned */
4536 switch (length_modifier)
4537 {
4538 case '\0':
4539 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004540 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004541# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004542 tvs != NULL ? (unsigned)
4543 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004544# endif
4545 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004546 if (uint_arg != 0)
4547 arg_sign = 1;
4548 break;
4549 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004550 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004551# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004552 tvs != NULL ? (unsigned long)
4553 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004554# endif
4555 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004556 if (ulong_arg != 0)
4557 arg_sign = 1;
4558 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004559# ifdef FEAT_NUM64
4560 case 'L':
4561 ullong_arg =
4562# if defined(FEAT_EVAL)
4563 tvs != NULL ? (uvarnumber_T)
4564 tv_nr(tvs, &arg_idx) :
4565# endif
4566 va_arg(ap, uvarnumber_T);
4567 if (ullong_arg != 0)
4568 arg_sign = 1;
4569 break;
4570# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004571 }
4572 }
4573
4574 str_arg = tmp;
4575 str_arg_l = 0;
4576
4577 /* NOTE:
4578 * For d, i, u, o, x, and X conversions, if precision is
4579 * specified, the '0' flag should be ignored. This is so
4580 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4581 * FreeBSD, NetBSD; but not with Perl.
4582 */
4583 if (precision_specified)
4584 zero_padding = 0;
4585 if (fmt_spec == 'd')
4586 {
4587 if (force_sign && arg_sign >= 0)
4588 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4589 /* leave negative numbers for sprintf to handle, to
4590 * avoid handling tricky cases like (short int)-32768 */
4591 }
4592 else if (alternate_form)
4593 {
4594 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004595 && (fmt_spec == 'b' || fmt_spec == 'B'
4596 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004597 {
4598 tmp[str_arg_l++] = '0';
4599 tmp[str_arg_l++] = fmt_spec;
4600 }
4601 /* alternate form should have no effect for p
4602 * conversion, but ... */
4603 }
4604
4605 zero_padding_insertion_ind = str_arg_l;
4606 if (!precision_specified)
4607 precision = 1; /* default precision is 1 */
4608 if (precision == 0 && arg_sign == 0)
4609 {
4610 /* When zero value is formatted with an explicit
4611 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004612 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004613 }
4614 else
4615 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004616 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004617 int f_l = 0;
4618
4619 /* construct a simple format string for sprintf */
4620 f[f_l++] = '%';
4621 if (!length_modifier)
4622 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004623 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004624 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004625# ifdef FEAT_NUM64
Bram Moolenaar4f974752019-02-17 17:44:42 +01004626# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004627 f[f_l++] = 'I';
4628 f[f_l++] = '6';
4629 f[f_l++] = '4';
4630# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004631 f[f_l++] = 'l';
4632 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004633# endif
4634# else
4635 f[f_l++] = 'l';
4636# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004637 }
4638 else
4639 f[f_l++] = length_modifier;
4640 f[f_l++] = fmt_spec;
4641 f[f_l++] = '\0';
4642
4643 if (fmt_spec == 'p')
4644 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004645 else if (fmt_spec == 'b' || fmt_spec == 'B')
4646 {
4647 char b[8 * sizeof(uvarnumber_T)];
4648 size_t b_l = 0;
4649 uvarnumber_T bn = bin_arg;
4650
4651 do
4652 {
4653 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4654 bn >>= 1;
4655 }
4656 while (bn != 0);
4657
4658 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4659 str_arg_l += b_l;
4660 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004661 else if (fmt_spec == 'd')
4662 {
4663 /* signed */
4664 switch (length_modifier)
4665 {
4666 case '\0':
4667 case 'h': str_arg_l += sprintf(
4668 tmp + str_arg_l, f, int_arg);
4669 break;
4670 case 'l': str_arg_l += sprintf(
4671 tmp + str_arg_l, f, long_arg);
4672 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004673# ifdef FEAT_NUM64
4674 case 'L': str_arg_l += sprintf(
4675 tmp + str_arg_l, f, llong_arg);
4676 break;
4677# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004678 }
4679 }
4680 else
4681 {
4682 /* unsigned */
4683 switch (length_modifier)
4684 {
4685 case '\0':
4686 case 'h': str_arg_l += sprintf(
4687 tmp + str_arg_l, f, uint_arg);
4688 break;
4689 case 'l': str_arg_l += sprintf(
4690 tmp + str_arg_l, f, ulong_arg);
4691 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004692# ifdef FEAT_NUM64
4693 case 'L': str_arg_l += sprintf(
4694 tmp + str_arg_l, f, ullong_arg);
4695 break;
4696# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004697 }
4698 }
4699
4700 /* include the optional minus sign and possible
4701 * "0x" in the region before the zero padding
4702 * insertion point */
4703 if (zero_padding_insertion_ind < str_arg_l
4704 && tmp[zero_padding_insertion_ind] == '-')
4705 zero_padding_insertion_ind++;
4706 if (zero_padding_insertion_ind + 1 < str_arg_l
4707 && tmp[zero_padding_insertion_ind] == '0'
4708 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4709 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4710 zero_padding_insertion_ind += 2;
4711 }
4712
4713 {
4714 size_t num_of_digits = str_arg_l
4715 - zero_padding_insertion_ind;
4716
4717 if (alternate_form && fmt_spec == 'o'
4718 /* unless zero is already the first
4719 * character */
4720 && !(zero_padding_insertion_ind < str_arg_l
4721 && tmp[zero_padding_insertion_ind] == '0'))
4722 {
4723 /* assure leading zero for alternate-form
4724 * octal numbers */
4725 if (!precision_specified
4726 || precision < num_of_digits + 1)
4727 {
4728 /* precision is increased to force the
4729 * first character to be zero, except if a
4730 * zero value is formatted with an
4731 * explicit precision of zero */
4732 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004733 }
4734 }
4735 /* zero padding to specified precision? */
4736 if (num_of_digits < precision)
4737 number_of_zeros_to_pad = precision - num_of_digits;
4738 }
4739 /* zero padding to specified minimal field width? */
4740 if (!justify_left && zero_padding)
4741 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004742 int n = (int)(min_field_width - (str_arg_l
4743 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004744 if (n > 0)
4745 number_of_zeros_to_pad += n;
4746 }
4747 break;
4748 }
4749
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004750# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004751 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004752 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004753 case 'e':
4754 case 'E':
4755 case 'g':
4756 case 'G':
4757 {
4758 /* Floating point. */
4759 double f;
4760 double abs_f;
4761 char format[40];
4762 int l;
4763 int remove_trailing_zeroes = FALSE;
4764
4765 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004766# if defined(FEAT_EVAL)
4767 tvs != NULL ? tv_float(tvs, &arg_idx) :
4768# endif
4769 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004770 abs_f = f < 0 ? -f : f;
4771
4772 if (fmt_spec == 'g' || fmt_spec == 'G')
4773 {
4774 /* Would be nice to use %g directly, but it prints
4775 * "1.0" as "1", we don't want that. */
4776 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4777 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004778 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004779 else
4780 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4781 remove_trailing_zeroes = TRUE;
4782 }
4783
Bram Moolenaar04186092016-08-29 21:55:35 +02004784 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004785# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004786 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004787# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004788 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004789# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004790 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004791 {
4792 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004793 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4794 force_sign, space_for_positive));
4795 str_arg_l = STRLEN(tmp);
4796 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004797 }
4798 else
4799 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004800 if (isnan(f))
4801 {
4802 /* Not a number: nan or NAN */
4803 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4804 : "nan");
4805 str_arg_l = 3;
4806 zero_padding = 0;
4807 }
4808 else if (isinf(f))
4809 {
4810 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4811 force_sign, space_for_positive));
4812 str_arg_l = STRLEN(tmp);
4813 zero_padding = 0;
4814 }
4815 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004816 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004817 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004818 format[0] = '%';
4819 l = 1;
4820 if (force_sign)
4821 format[l++] = space_for_positive ? ' ' : '+';
4822 if (precision_specified)
4823 {
4824 size_t max_prec = TMP_LEN - 10;
4825
4826 /* Make sure we don't get more digits than we
4827 * have room for. */
4828 if ((fmt_spec == 'f' || fmt_spec == 'F')
4829 && abs_f > 1.0)
4830 max_prec -= (size_t)log10(abs_f);
4831 if (precision > max_prec)
4832 precision = max_prec;
4833 l += sprintf(format + l, ".%d", (int)precision);
4834 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004835 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004836 format[l + 1] = NUL;
4837
Bram Moolenaare9997822016-08-28 16:03:38 +02004838 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004839 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004840
Bram Moolenaara7241f52008-06-24 20:39:31 +00004841 if (remove_trailing_zeroes)
4842 {
4843 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004844 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004845
4846 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02004847 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004848 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004849 else
4850 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004851 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004852 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004853 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004854 {
4855 /* Remove superfluous '+' and leading
4856 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004857 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004858 {
4859 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004860 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004861 --str_arg_l;
4862 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004863 i = (tp[1] == '-') ? 2 : 1;
4864 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004865 {
4866 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004867 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004868 --str_arg_l;
4869 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004870 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004871 }
4872 }
4873
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004874 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004875 /* Remove trailing zeroes, but keep the one
4876 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004877 while (tp > tmp + 2 && *tp == '0'
4878 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004879 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004880 STRMOVE(tp, tp + 1);
4881 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004882 --str_arg_l;
4883 }
4884 }
4885 else
4886 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004887 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004888
4889 /* Be consistent: some printf("%e") use 1.0e+12
4890 * and some 1.0e+012. Remove one zero in the last
4891 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004892 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004893 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004894 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4895 && tp[2] == '0'
4896 && vim_isdigit(tp[3])
4897 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004898 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004899 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004900 --str_arg_l;
4901 }
4902 }
4903 }
Bram Moolenaar04186092016-08-29 21:55:35 +02004904 if (zero_padding && min_field_width > str_arg_l
4905 && (tmp[0] == '-' || force_sign))
4906 {
4907 /* padding 0's should be inserted after the sign */
4908 number_of_zeros_to_pad = min_field_width - str_arg_l;
4909 zero_padding_insertion_ind = 1;
4910 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00004911 str_arg = tmp;
4912 break;
4913 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004914# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004915
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004916 default:
4917 /* unrecognized conversion specifier, keep format string
4918 * as-is */
4919 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004920 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004921 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004922 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004923
4924 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004925 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004926 str_arg = p;
4927 str_arg_l = 0;
4928 if (*p != NUL)
4929 str_arg_l++; /* include invalid conversion specifier
4930 unchanged if not at end-of-string */
4931 break;
4932 }
4933
4934 if (*p != NUL)
4935 p++; /* step over the just processed conversion specifier */
4936
4937 /* insert padding to the left as requested by min_field_width;
4938 * this does not include the zero padding in case of numerical
4939 * conversions*/
4940 if (!justify_left)
4941 {
4942 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004943 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004944
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004945 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004946 {
4947 if (str_l < str_m)
4948 {
4949 size_t avail = str_m - str_l;
4950
4951 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004952 (size_t)pn > avail ? avail
4953 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004954 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004955 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004956 }
4957 }
4958
4959 /* zero padding as requested by the precision or by the minimal
4960 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004961 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004962 {
4963 /* will not copy first part of numeric right now, *
4964 * force it to be copied later in its entirety */
4965 zero_padding_insertion_ind = 0;
4966 }
4967 else
4968 {
4969 /* insert first part of numerics (sign or '0x') before zero
4970 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004971 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004972
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004973 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004974 {
4975 if (str_l < str_m)
4976 {
4977 size_t avail = str_m - str_l;
4978
4979 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004980 (size_t)zn > avail ? avail
4981 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004982 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004983 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004984 }
4985
4986 /* insert zero padding as requested by the precision or min
4987 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004988 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004989 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004990 {
4991 if (str_l < str_m)
4992 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02004993 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004994
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004995 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004996 (size_t)zn > avail ? avail
4997 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004998 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004999 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005000 }
5001 }
5002
5003 /* insert formatted string
5004 * (or as-is conversion specifier for unknown conversions) */
5005 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005006 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005007
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005008 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005009 {
5010 if (str_l < str_m)
5011 {
5012 size_t avail = str_m - str_l;
5013
5014 mch_memmove(str + str_l,
5015 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005016 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005017 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005018 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005019 }
5020 }
5021
5022 /* insert right padding */
5023 if (justify_left)
5024 {
5025 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005026 int pn = (int)(min_field_width
5027 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005028
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005029 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005030 {
5031 if (str_l < str_m)
5032 {
5033 size_t avail = str_m - str_l;
5034
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005035 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005036 (size_t)pn > avail ? avail
5037 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005038 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005039 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005040 }
5041 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005042 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005043 }
5044 }
5045
5046 if (str_m > 0)
5047 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005048 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005049 * overwriting the last character (shouldn't happen, but just in case)
5050 * */
5051 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5052 }
5053
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005054 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005055 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005056
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005057 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005058 * character), that is, the number of characters that would have been
5059 * written to the buffer if it were large enough. */
5060 return (int)str_l;
5061}
5062
5063#endif /* PROTO */