blob: 7a6e346096e4162e198ff3d1a87723234e995a6b [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
Bram Moolenaar85a20022019-12-21 18:25:54 +010014#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 Moolenaar85a20022019-12-21 18:25:54 +010036static 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,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100131 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 Moolenaar85a20022019-12-21 18:25:54 +0100137 // 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
Bram Moolenaar85a20022019-12-21 18:25:54 +0100156 // 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 Moolenaar85a20022019-12-21 18:25:54 +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 Moolenaar85a20022019-12-21 18:25:54 +0100171 // 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,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100197 int force) // always truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198{
199 char_u *buf = NULL;
200 int len;
201 int room;
202
Bram Moolenaar85a20022019-12-21 18:25:54 +0100203 // 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 Moolenaar85a20022019-12-21 18:25:54 +0100209 // Use all the columns.
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000210 room = (int)(Rows - msg_row) * Columns - 1;
211 else
Bram Moolenaar85a20022019-12-21 18:25:54 +0100212 // Use up to 'showcmd' column.
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000213 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)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100217 // 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)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100221 // 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 Moolenaar85a20022019-12-21 18:25:54 +0100244 size_t room = room_in - 3; // "..." takes 3 chars
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200245 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
Bram Moolenaar85a20022019-12-21 18:25:54 +0100255 // 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 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100260 // text fits without truncating!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 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
Bram Moolenaar85a20022019-12-21 18:25:54 +0100278 // Last part: End of the string.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 i = e;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 if (enc_dbcs != 0)
281 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100282 // 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 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 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100294 // 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 {
Bram Moolenaard0337e32019-12-30 17:55:34 +0100310 for (i = (int)STRLEN(s);
311 i - 1 >= 0 && len + (n = ptr2cells(s + i - 1)) <= room; --i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312 len += n;
313 }
314
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200315
316 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100317 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100318 // text fits without truncating
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200319 if (s != buf)
320 {
321 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200322 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200323 len = buflen - 1;
324 len = len - e + 1;
325 if (len < 1)
326 buf[e - 1] = NUL;
327 else
328 mch_memmove(buf + e, s + e, len);
329 }
330 }
331 else if (e + 3 < buflen)
332 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100333 // set the middle and copy the last part
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100334 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200335 len = STRLEN(s + i) + 1;
336 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100337 len = buflen - e - 3 - 1;
338 mch_memmove(buf + e + 3, s + i, len);
339 buf[e + 3 + len - 1] = NUL;
340 }
341 else
342 {
Bram Moolenaar85a20022019-12-21 18:25:54 +0100343 // can't fit in the "...", just truncate it
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200344 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100345 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346}
347
348/*
349 * Automatic prototype generation does not understand this function.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100350 * Note: Caller of smsg() and smsg_attr() must check the resulting string is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 * shorter than IOSIZE!!!
352 */
353#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100355int vim_snprintf(char *str, size_t str_m, const char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000356
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100358smsg(const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200360 if (IObuff == NULL)
361 {
362 // Very early in initialisation and already something wrong, just
363 // give the raw message so the user at least gets a hint.
364 return msg((char *)s);
365 }
366 else
367 {
368 va_list arglist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200370 va_start(arglist, s);
371 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
372 va_end(arglist);
373 return msg((char *)IObuff);
374 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375}
376
377 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100378smsg_attr(int attr, const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200380 if (IObuff == NULL)
381 {
382 // Very early in initialisation and already something wrong, just
383 // give the raw message so the user at least gets a hint.
384 return msg_attr((char *)s, attr);
385 }
386 else
387 {
388 va_list arglist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200390 va_start(arglist, s);
391 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
392 va_end(arglist);
393 return msg_attr((char *)IObuff, attr);
394 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395}
396
Bram Moolenaare0429682018-07-01 16:44:03 +0200397 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100398smsg_attr_keep(int attr, const char *s, ...)
Bram Moolenaare0429682018-07-01 16:44:03 +0200399{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200400 if (IObuff == NULL)
401 {
402 // Very early in initialisation and already something wrong, just
403 // give the raw message so the user at least gets a hint.
404 return msg_attr_keep((char *)s, attr, TRUE);
405 }
406 else
407 {
408 va_list arglist;
Bram Moolenaare0429682018-07-01 16:44:03 +0200409
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200410 va_start(arglist, s);
411 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
412 va_end(arglist);
413 return msg_attr_keep((char *)IObuff, attr, TRUE);
414 }
Bram Moolenaare0429682018-07-01 16:44:03 +0200415}
416
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417#endif
418
419/*
420 * Remember the last sourcing name/lnum used in an error message, so that it
421 * isn't printed each time when it didn't change.
422 */
423static int last_sourcing_lnum = 0;
424static char_u *last_sourcing_name = NULL;
425
426/*
427 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
428 * for the next error message;
429 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000430 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100431reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100433 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434 last_sourcing_lnum = 0;
435}
436
437/*
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100438 * Return TRUE if "SOURCING_NAME" differs from "last_sourcing_name".
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000439 */
440 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100441other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000442{
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100443 if (SOURCING_NAME != NULL)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000444 {
445 if (last_sourcing_name != NULL)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100446 return STRCMP(SOURCING_NAME, last_sourcing_name) != 0;
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000447 return TRUE;
448 }
449 return FALSE;
450}
451
452/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453 * Get the message about the source, as used for an error message.
454 * Returns an allocated string with room for one more character.
455 * Returns NULL when no message is to be given.
456 */
457 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100458get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459{
460 char_u *Buf, *p;
461
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100462 if (SOURCING_NAME != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100464 char_u *sname = estack_sfile();
465 char_u *tofree = sname;
466
467 if (sname == NULL)
468 sname = SOURCING_NAME;
469
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470 p = (char_u *)_("Error detected while processing %s:");
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100471 Buf = alloc(STRLEN(sname) + STRLEN(p));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 if (Buf != NULL)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100473 sprintf((char *)Buf, (char *)p, sname);
474 vim_free(tofree);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475 return Buf;
476 }
477 return NULL;
478}
479
480/*
481 * Get the message about the source lnum, as used for an error message.
482 * Returns an allocated string with room for one more character.
483 * Returns NULL when no message is to be given.
484 */
485 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100486get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000487{
488 char_u *Buf, *p;
489
Bram Moolenaar85a20022019-12-21 18:25:54 +0100490 // lnum is 0 when executing a command from the command line
491 // argument, we don't want a line number then
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100492 if (SOURCING_NAME != NULL
493 && (other_sourcing_name() || SOURCING_LNUM != last_sourcing_lnum)
494 && SOURCING_LNUM != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495 {
496 p = (char_u *)_("line %4ld:");
Bram Moolenaar964b3742019-05-24 18:54:09 +0200497 Buf = alloc(STRLEN(p) + 20);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 if (Buf != NULL)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100499 sprintf((char *)Buf, (char *)p, (long)SOURCING_LNUM);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500 return Buf;
501 }
502 return NULL;
503}
504
505/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000506 * Display name and line number for the source of an error.
507 * Remember the file name and line number, so that for the next error the info
508 * is only displayed if it changed.
509 */
510 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100511msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000512{
513 char_u *p;
514
515 ++no_wait_return;
516 p = get_emsg_source();
517 if (p != NULL)
518 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100519 msg_attr((char *)p, attr);
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000520 vim_free(p);
521 }
522 p = get_emsg_lnum();
523 if (p != NULL)
524 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100525 msg_attr((char *)p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000526 vim_free(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100527 last_sourcing_lnum = SOURCING_LNUM; // only once for each line
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000528 }
529
Bram Moolenaar85a20022019-12-21 18:25:54 +0100530 // remember the last sourcing name printed, also when it's empty
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100531 if (SOURCING_NAME == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000532 {
533 vim_free(last_sourcing_name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100534 if (SOURCING_NAME == NULL)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000535 last_sourcing_name = NULL;
536 else
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100537 last_sourcing_name = vim_strsave(SOURCING_NAME);
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000538 }
539 --no_wait_return;
540}
541
542/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000543 * Return TRUE if not giving error messages right now:
544 * If "emsg_off" is set: no error messages at the moment.
545 * If "msg" is in 'debug': do error message but without side effects.
546 * If "emsg_skip" is set: never do error messages.
547 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200548 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100549emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000550{
551 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
552 && vim_strchr(p_debug, 't') == NULL)
553#ifdef FEAT_EVAL
554 || emsg_skip > 0
555#endif
556 )
557 return TRUE;
558 return FALSE;
559}
560
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100561#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100562static garray_T ignore_error_list = GA_EMPTY;
563
564 void
565ignore_error_for_testing(char_u *error)
566{
567 if (ignore_error_list.ga_itemsize == 0)
568 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
569
Bram Moolenaar461a7fc2018-12-22 13:28:07 +0100570 if (STRCMP("RESET", error) == 0)
571 ga_clear_strings(&ignore_error_list);
572 else
573 ga_add_string(&ignore_error_list, error);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100574}
575
576 static int
577ignore_error(char_u *msg)
578{
579 int i;
580
581 for (i = 0; i < ignore_error_list.ga_len; ++i)
582 if (strstr((char *)msg,
583 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
584 return TRUE;
585 return FALSE;
586}
587#endif
588
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200589#if !defined(HAVE_STRERROR) || defined(PROTO)
590/*
591 * Replacement for perror() that behaves more or less like emsg() was called.
Bram Moolenaar53989552019-12-23 22:59:18 +0100592 * v:errmsg will be set and called_emsg will be incremented.
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200593 */
594 void
595do_perror(char *msg)
596{
597 perror(msg);
598 ++emsg_silent;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100599 emsg(msg);
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200600 --emsg_silent;
601}
602#endif
603
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000604/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100605 * emsg_core() - display an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606 *
607 * Rings the bell, if appropriate, and calls message() to do the real work
608 * When terminal not initialized (yet) mch_errmsg(..) is used.
609 *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100610 * Return TRUE if wait_return not called.
611 * Note: caller must check 'emsg_not_now()' before calling this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100613 static int
614emsg_core(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615{
616 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100618 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619#ifdef FEAT_EVAL
620 int ignore = FALSE;
621 int severe;
622#endif
623
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100624#ifdef FEAT_EVAL
Bram Moolenaar85a20022019-12-21 18:25:54 +0100625 // When testing some errors are turned into a normal message.
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100626 if (ignore_error(s))
Bram Moolenaar85a20022019-12-21 18:25:54 +0100627 // don't call msg() if it results in a dialog
Bram Moolenaar32526b32019-01-19 17:43:09 +0100628 return msg_use_printf() ? FALSE : msg((char *)s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100629#endif
630
Bram Moolenaar53989552019-12-23 22:59:18 +0100631 ++called_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633#ifdef FEAT_EVAL
Bram Moolenaar85a20022019-12-21 18:25:54 +0100634 // If "emsg_severe" is TRUE: When an error exception is to be thrown,
635 // prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 severe = emsg_severe;
637 emsg_severe = FALSE;
638#endif
639
Bram Moolenaar57657d82006-04-21 22:12:41 +0000640 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 {
642#ifdef FEAT_EVAL
643 /*
644 * Cause a throw of an error exception if appropriate. Don't display
645 * the error message in this case. (If no matching catch clause will
646 * be found, the message will be displayed later on.) "ignore" is set
647 * when the message should be ignored completely (used for the
648 * interrupt message).
649 */
650 if (cause_errthrow(s, severe, &ignore) == TRUE)
651 {
652 if (!ignore)
Bram Moolenaar76a63452018-11-28 20:38:37 +0100653 ++did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 return TRUE;
655 }
656
Bram Moolenaar85a20022019-12-21 18:25:54 +0100657 // set "v:errmsg", also when using ":silent! cmd"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 set_vim_var_string(VV_ERRMSG, s, -1);
659#endif
660
661 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000662 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 * But do write it to the redirection file.
664 */
665 if (emsg_silent != 0)
666 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200667 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200669 msg_start();
670 p = get_emsg_source();
671 if (p != NULL)
672 {
673 STRCAT(p, "\n");
674 redir_write(p, -1);
675 vim_free(p);
676 }
677 p = get_emsg_lnum();
678 if (p != NULL)
679 {
680 STRCAT(p, "\n");
681 redir_write(p, -1);
682 vim_free(p);
683 }
684 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100686#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare809a4e2019-07-04 17:35:05 +0200687 ch_log(NULL, "ERROR silent: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100688#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 return TRUE;
690 }
691
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100692 ex_exitval = 1;
693
Bram Moolenaar85a20022019-12-21 18:25:54 +0100694 // Reset msg_silent, an error causes messages to be switched back on.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 msg_silent = 0;
696 cmd_silent = FALSE;
697
Bram Moolenaar85a20022019-12-21 18:25:54 +0100698 if (global_busy) // break :global command
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 ++global_busy;
700
701 if (p_eb)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100702 beep_flush(); // also includes flush_buffers()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 else
Bram Moolenaar6a2633b2018-10-07 23:16:36 +0200704 flush_buffers(FLUSH_MINIMAL); // flush internal buffers
Bram Moolenaar76a63452018-11-28 20:38:37 +0100705 ++did_emsg; // flag for DoOneCmd()
Bram Moolenaare723c422017-09-06 23:40:10 +0200706#ifdef FEAT_EVAL
707 did_uncaught_emsg = TRUE;
708#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 }
710
Bram Moolenaar85a20022019-12-21 18:25:54 +0100711 emsg_on_display = TRUE; // remember there is an error message
712 ++msg_scroll; // don't overwrite a previous message
713 attr = HL_ATTR(HLF_E); // set highlight mode for error messages
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000714 if (msg_scrolled != 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100715 need_wait_return = TRUE; // needed in case emsg() is called after
716 // wait_return has reset need_wait_return
717 // and a redraw is expected because
718 // msg_scrolled is non-zero
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719
Bram Moolenaar958dc692016-12-01 15:34:12 +0100720#ifdef FEAT_JOB_CHANNEL
721 emsg_to_channel_log = TRUE;
722#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 /*
724 * Display name and line number for the source of the error.
725 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000726 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 /*
729 * Display the error message itself.
730 */
Bram Moolenaar85a20022019-12-21 18:25:54 +0100731 msg_nowait = FALSE; // wait for this msg
Bram Moolenaar32526b32019-01-19 17:43:09 +0100732 r = msg_attr((char *)s, attr);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100733
734#ifdef FEAT_JOB_CHANNEL
735 emsg_to_channel_log = FALSE;
736#endif
737 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738}
739
740/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100741 * Print an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 */
743 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100744emsg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745{
Bram Moolenaar85a20022019-12-21 18:25:54 +0100746 // Skip this if not giving error messages at the moment.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100747 if (!emsg_not_now())
748 return emsg_core((char_u *)s);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100749 return TRUE; // no error messages at the moment
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750}
751
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100752#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100753/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100754 * Print an error message with format string and variable arguments.
755 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100756 */
757 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100758semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100759{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200760 // Skip this if not giving error messages at the moment.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100761 if (!emsg_not_now())
762 {
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200763 if (IObuff == NULL)
764 {
765 // Very early in initialisation and already something wrong, just
766 // give the raw message so the user at least gets a hint.
767 return emsg_core((char_u *)s);
768 }
769 else
770 {
771 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100772
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200773 va_start(ap, s);
774 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
775 va_end(ap);
776 return emsg_core(IObuff);
777 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778 }
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200779 return TRUE; // no error messages at the moment
Bram Moolenaar95f09602016-11-10 20:01:45 +0100780}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100781#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100782
783/*
784 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
785 * defined. It is used for internal errors only, so that they can be
786 * detected when fuzzing vim.
787 */
788 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100789iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100790{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100791 if (!emsg_not_now())
792 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100793#ifdef ABORT_ON_INTERNAL_ERROR
794 abort();
795#endif
796}
797
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100798#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100799/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100800 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100801 * defined. It is used for internal errors only, so that they can be
802 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100803 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100804 */
805 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100806siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100807{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100808 if (!emsg_not_now())
809 {
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200810 if (IObuff == NULL)
811 {
812 // Very early in initialisation and already something wrong, just
813 // give the raw message so the user at least gets a hint.
814 emsg_core((char_u *)s);
815 }
816 else
817 {
818 va_list ap;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100819
Bram Moolenaare3a22cb2019-10-14 22:01:57 +0200820 va_start(ap, s);
821 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
822 va_end(ap);
823 emsg_core(IObuff);
824 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100825 }
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100826# ifdef ABORT_ON_INTERNAL_ERROR
Bram Moolenaar95f09602016-11-10 20:01:45 +0100827 abort();
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100828# endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100829}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100830#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100831
832/*
833 * Give an "Internal error" message.
834 */
835 void
836internal_error(char *where)
837{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100838 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100839}
840
Bram Moolenaar85a20022019-12-21 18:25:54 +0100841// emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaardf177f62005-02-22 08:39:57 +0000843 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100844emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000845{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100846 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000847}
848
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849/*
850 * Like msg(), but truncate to a single line if p_shm contains 't', or when
851 * "force" is TRUE. This truncates in another way as for normal messages.
852 * Careful: The string may be changed by msg_may_trunc()!
853 * Returns a pointer to the printed message, if wait_return() not called.
854 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100855 char *
856msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857{
858 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100859 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
Bram Moolenaar85a20022019-12-21 18:25:54 +0100861 // Add message to history before truncating
Bram Moolenaar32526b32019-01-19 17:43:09 +0100862 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863
Bram Moolenaar32526b32019-01-19 17:43:09 +0100864 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865
866 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100867 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 msg_hist_off = FALSE;
869
870 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100871 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 return NULL;
873}
874
875/*
876 * Check if message "s" should be truncated at the start (for filenames).
877 * Return a pointer to where the truncated message starts.
878 * Note: May change the message by replacing a character with '<'.
879 */
880 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100881msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882{
883 int n;
884 int room;
885
886 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
887 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
888 && (n = (int)STRLEN(s) - room) > 0)
889 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 if (has_mbyte)
891 {
892 int size = vim_strsize(s);
893
Bram Moolenaar85a20022019-12-21 18:25:54 +0100894 // There may be room anyway when there are multibyte chars.
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000895 if (size <= room)
896 return s;
897
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 for (n = 0; size >= room; )
899 {
900 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000901 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 }
903 --n;
904 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 s += n;
906 *s = '<';
907 }
908 return s;
909}
910
911 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100912add_msg_hist(
913 char_u *s,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100914 int len, // -1 for undetermined length
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100915 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916{
917 struct msg_hist *p;
918
919 if (msg_hist_off || msg_silent != 0)
920 return;
921
Bram Moolenaar85a20022019-12-21 18:25:54 +0100922 // Don't let the message history get too big
Bram Moolenaar4770d092006-01-12 23:22:24 +0000923 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000924 (void)delete_first_msg();
925
Bram Moolenaar85a20022019-12-21 18:25:54 +0100926 // allocate an entry and add the message at the end of the history
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200927 p = ALLOC_ONE(struct msg_hist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 if (p != NULL)
929 {
930 if (len < 0)
931 len = (int)STRLEN(s);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100932 // remove leading and trailing newlines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 while (len > 0 && *s == '\n')
934 {
935 ++s;
936 --len;
937 }
938 while (len > 0 && s[len - 1] == '\n')
939 --len;
940 p->msg = vim_strnsave(s, len);
941 p->next = NULL;
942 p->attr = attr;
943 if (last_msg_hist != NULL)
944 last_msg_hist->next = p;
945 last_msg_hist = p;
946 if (first_msg_hist == NULL)
947 first_msg_hist = last_msg_hist;
948 ++msg_hist_len;
949 }
950}
951
952/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000953 * Delete the first (oldest) message from the history.
954 * Returns FAIL if there are no messages.
955 */
956 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100957delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000958{
959 struct msg_hist *p;
960
961 if (msg_hist_len <= 0)
962 return FAIL;
963 p = first_msg_hist;
964 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000965 if (first_msg_hist == NULL)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100966 last_msg_hist = NULL; // history is empty
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000967 vim_free(p->msg);
968 vim_free(p);
969 --msg_hist_len;
970 return OK;
971}
972
973/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 * ":messages" command.
975 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200977ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978{
979 struct msg_hist *p;
980 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200981 int c = 0;
982
983 if (STRCMP(eap->arg, "clear") == 0)
984 {
985 int keep = eap->addr_count == 0 ? 0 : eap->line2;
986
987 while (msg_hist_len > keep)
988 (void)delete_first_msg();
989 return;
990 }
991
992 if (*eap->arg != NUL)
993 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100994 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200995 return;
996 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
998 msg_hist_off = TRUE;
999
Bram Moolenaar451f8492016-04-14 17:16:22 +02001000 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +02001001 if (eap->addr_count != 0)
1002 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001003 // Count total messages
Bram Moolenaar451f8492016-04-14 17:16:22 +02001004 for (; p != NULL && !got_int; p = p->next)
1005 c++;
1006
1007 c -= eap->line2;
1008
Bram Moolenaar85a20022019-12-21 18:25:54 +01001009 // Skip without number of messages specified
Bram Moolenaar451f8492016-04-14 17:16:22 +02001010 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
1011 p = p->next, c--);
1012 }
1013
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001014 if (p == first_msg_hist)
1015 {
1016 s = mch_getenv((char_u *)"LANG");
1017 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +02001018 // The next comment is extracted by xgettext and put in po file for
1019 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +01001020 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +02001021 // Translator: Please replace the name and email address
1022 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001023 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +01001024 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001025 }
1026
Bram Moolenaar85a20022019-12-21 18:25:54 +01001027 // Display what was not skipped.
Bram Moolenaar451f8492016-04-14 17:16:22 +02001028 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001030 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
1032 msg_hist_off = FALSE;
1033}
1034
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001035#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036/*
1037 * Call this after prompting the user. This will avoid a hit-return message
1038 * and a delay.
1039 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001040 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001041msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042{
1043 need_wait_return = FALSE;
1044 emsg_on_display = FALSE;
1045 cmdline_row = msg_row;
1046 msg_col = 0;
1047 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001048 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049}
1050#endif
1051
1052/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001053 * Wait for the user to hit a key (normally Enter).
1054 * If "redraw" is TRUE, clear and redraw the screen.
1055 * If "redraw" is FALSE, just redraw the screen.
1056 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 */
1058 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001059wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060{
1061 int c;
1062 int oldState;
1063 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001065 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001066 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
1068 if (redraw == TRUE)
1069 must_redraw = CLEAR;
1070
Bram Moolenaar85a20022019-12-21 18:25:54 +01001071 // If using ":silent cmd", don't wait for a return. Also don't set
1072 // need_wait_return to do it later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 if (msg_silent != 0)
1074 return;
1075
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001076 /*
1077 * When inside vgetc(), we can't wait for a typed character at all.
1078 * With the global command (and some others) we only need one return at
1079 * the end. Adjust cmdline_row to avoid the next message overwriting the
1080 * last one.
1081 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001082 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001084 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 if (no_wait_return)
1086 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 if (!exmode_active)
1088 cmdline_row = msg_row;
1089 return;
1090 }
1091
Bram Moolenaar85a20022019-12-21 18:25:54 +01001092 redir_off = TRUE; // don't redirect this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 oldState = State;
1094 if (quit_more)
1095 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001096 c = CAR; // just pretend CR was hit
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 quit_more = FALSE;
1098 got_int = FALSE;
1099 }
1100 else if (exmode_active)
1101 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001102 msg_puts(" "); // make sure the cursor is on the right line
1103 c = CAR; // no need for a return in ex mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 got_int = FALSE;
1105 }
1106 else
1107 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001108 // Make sure the hit-return prompt is on screen when 'guioptions' was
1109 // just changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 screenalloc(FALSE);
1111
1112 State = HITRETURN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar85a20022019-12-21 18:25:54 +01001115 dont_scroll = TRUE; // disallow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001117 cmdline_row = msg_row;
1118
Bram Moolenaar85a20022019-12-21 18:25:54 +01001119 // Avoid the sequence that the user types ":" at the hit-return prompt
1120 // to start an Ex command, but the file-changed dialog gets in the
1121 // way.
Bram Moolenaarec38d692013-04-24 15:12:32 +02001122 if (need_check_timestamps)
1123 check_timestamps(FALSE);
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 hit_return_msg();
1126
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 do
1128 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001129 // Remember "got_int", if it is set vgetc() probably returns a
1130 // CTRL-C, but we need to loop then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001132
Bram Moolenaar85a20022019-12-21 18:25:54 +01001133 // Don't do mappings here, we put the character back in the
1134 // typeahead buffer.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001135 ++no_mapping;
1136 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001137
Bram Moolenaar85a20022019-12-21 18:25:54 +01001138 // Temporarily disable Recording. If Recording is active, the
1139 // character will be recorded later, since it will be added to the
1140 // typebuf after the loop
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001141 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001142 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001143 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001144 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001146 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001148 --no_mapping;
1149 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001150 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001151 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001152
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153#ifdef FEAT_CLIPBOARD
Bram Moolenaar85a20022019-12-21 18:25:54 +01001154 // Strange way to allow copying (yanking) a modeless selection at
1155 // the hit-enter prompt. Use CTRL-Y, because the same is used in
1156 // Cmdline-mode and it's harmless when there is no selection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1158 {
1159 clip_copy_modeless_selection(TRUE);
1160 c = K_IGNORE;
1161 }
1162#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001163
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001164 /*
1165 * Allow scrolling back in the messages.
1166 * Also accept scroll-down commands when messages fill the screen,
1167 * to avoid that typing one 'j' too many makes the messages
1168 * disappear.
1169 */
1170 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001171 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001172 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1173 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001174 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001175 if (msg_scrolled > Rows)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001176 // scroll back to show older messages
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001177 do_more_prompt(c);
1178 else
1179 {
1180 msg_didout = FALSE;
1181 c = K_IGNORE;
1182 msg_col =
1183#ifdef FEAT_RIGHTLEFT
1184 cmdmsg_rl ? Columns - 1 :
1185#endif
1186 0;
1187 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001188 if (quit_more)
1189 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001190 c = CAR; // just pretend CR was hit
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001191 quit_more = FALSE;
1192 got_int = FALSE;
1193 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001194 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001195 {
1196 c = K_IGNORE;
1197 hit_return_msg();
1198 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001199 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001200 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001201 && (c == 'j' || c == 'd' || c == 'f'
1202 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001203 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001204 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 } while ((had_got_int && c == Ctrl_C)
1206 || c == K_IGNORE
1207#ifdef FEAT_GUI
1208 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1209#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1211 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1212 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001213 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 || (!mouse_has(MOUSE_RETURN)
1217 && mouse_row < msg_row
1218 && (c == K_LEFTMOUSE
1219 || c == K_MIDDLEMOUSE
1220 || c == K_RIGHTMOUSE
1221 || c == K_X1MOUSE
1222 || c == K_X2MOUSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223 );
1224 ui_breakcheck();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 /*
1226 * Avoid that the mouse-up event causes visual mode to start.
1227 */
1228 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1229 || c == K_X1MOUSE || c == K_X2MOUSE)
1230 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001231 else if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001233 // Put the character back in the typeahead buffer. Don't use the
1234 // stuff buffer, because lmaps wouldn't work.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001235 ins_char_typebuf(c);
Bram Moolenaar85a20022019-12-21 18:25:54 +01001236 do_redraw = TRUE; // need a redraw even though there is
1237 // typeahead
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 }
1240 redir_off = FALSE;
1241
1242 /*
1243 * If the user hits ':', '?' or '/' we get a command line from the next
1244 * line.
1245 */
1246 if (c == ':' || c == '?' || c == '/')
1247 {
1248 if (!exmode_active)
1249 cmdline_row = msg_row;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001250 skip_redraw = TRUE; // skip redraw once
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001252#ifdef FEAT_TERMINAL
1253 skip_term_loop = TRUE;
1254#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 }
1256
1257 /*
1258 * If the window size changed set_shellsize() will redraw the screen.
1259 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1260 * typed.
1261 */
1262 tmpState = State;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001263 State = oldState; // restore State before set_shellsize
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 msg_check();
1266
1267#if defined(UNIX) || defined(VMS)
1268 /*
1269 * When switching screens, we need to output an extra newline on exit.
1270 */
1271 if (swapping_screen() && !termcap_active)
1272 newline_on_exit = TRUE;
1273#endif
1274
1275 need_wait_return = FALSE;
1276 did_wait_return = TRUE;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001277 emsg_on_display = FALSE; // can delete error message now
1278 lines_left = -1; // reset lines_left at next msg_start()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 reset_last_sourcing();
1280 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1281 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001282 VIM_CLEAR(keep_msg); // don't redisplay message, it's too long
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283
Bram Moolenaar85a20022019-12-21 18:25:54 +01001284 if (tmpState == SETWSIZE) // got resize event while in vgetc()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001286 starttermcap(); // start termcap before redrawing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 shell_resized();
1288 }
1289 else if (!skip_redraw
1290 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1291 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001292 starttermcap(); // start termcap before redrawing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 redraw_later(VALID);
1294 }
1295}
1296
1297/*
1298 * Write the hit-return prompt.
1299 */
1300 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001301hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001303 int save_p_more = p_more;
1304
Bram Moolenaar85a20022019-12-21 18:25:54 +01001305 p_more = FALSE; // don't want see this message when scrolling back
1306 if (msg_didout) // start on a new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 msg_putchar('\n');
1308 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001309 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310
Bram Moolenaar32526b32019-01-19 17:43:09 +01001311 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 if (!msg_use_printf())
1313 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001314 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315}
1316
1317/*
1318 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1319 */
1320 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001321set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322{
1323 vim_free(keep_msg);
1324 if (s != NULL && msg_silent == 0)
1325 keep_msg = vim_strsave(s);
1326 else
1327 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001328 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001329 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330}
1331
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001332#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1333/*
1334 * If there currently is a message being displayed, set "keep_msg" to it, so
1335 * that it will be displayed again after redraw.
1336 */
1337 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001338set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001339{
1340 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1341 && (State & NORMAL))
1342 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1343}
1344#endif
1345
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346/*
1347 * Prepare for outputting characters in the command line.
1348 */
1349 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001350msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351{
1352 int did_return = FALSE;
1353
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001354 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001355 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001356
1357#ifdef FEAT_EVAL
1358 if (need_clr_eos)
1359 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001360 // Halfway an ":echo" command and getting an (error) message: clear
1361 // any text from the command.
Bram Moolenaara7241f52008-06-24 20:39:31 +00001362 need_clr_eos = FALSE;
1363 msg_clr_eos();
1364 }
1365#endif
1366
Bram Moolenaar85a20022019-12-21 18:25:54 +01001367 if (!msg_scroll && full_screen) // overwrite last message
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 {
1369 msg_row = cmdline_row;
1370 msg_col =
1371#ifdef FEAT_RIGHTLEFT
1372 cmdmsg_rl ? Columns - 1 :
1373#endif
1374 0;
1375 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001376 else if (msg_didout) // start message on next line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 {
1378 msg_putchar('\n');
1379 did_return = TRUE;
1380 if (exmode_active != EXMODE_NORMAL)
1381 cmdline_row = msg_row;
1382 }
1383 if (!msg_didany || lines_left < 0)
1384 msg_starthere();
1385 if (msg_silent == 0)
1386 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001387 msg_didout = FALSE; // no output on current line yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 cursor_off();
1389 }
1390
Bram Moolenaar85a20022019-12-21 18:25:54 +01001391 // when redirecting, may need to start a new line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 if (!did_return)
1393 redir_write((char_u *)"\n", -1);
1394}
1395
1396/*
1397 * Note that the current msg position is where messages start.
1398 */
1399 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001400msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401{
1402 lines_left = cmdline_row;
1403 msg_didany = FALSE;
1404}
1405
1406 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001407msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408{
1409 msg_putchar_attr(c, 0);
1410}
1411
1412 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001413msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001415 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416
1417 if (IS_SPECIAL(c))
1418 {
1419 buf[0] = K_SPECIAL;
1420 buf[1] = K_SECOND(c);
1421 buf[2] = K_THIRD(c);
1422 buf[3] = NUL;
1423 }
1424 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001425 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001426 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427}
1428
1429 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001430msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001432 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
Bram Moolenaar32526b32019-01-19 17:43:09 +01001434 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 msg_puts(buf);
1436}
1437
1438 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001439msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440{
1441 msg_home_replace_attr(fname, 0);
1442}
1443
1444#if defined(FEAT_FIND_ID) || defined(PROTO)
1445 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001446msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001448 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449}
1450#endif
1451
1452 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001453msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454{
1455 char_u *name;
1456
1457 name = home_replace_save(NULL, fname);
1458 if (name != NULL)
1459 msg_outtrans_attr(name, attr);
1460 vim_free(name);
1461}
1462
1463/*
1464 * Output 'len' characters in 'str' (including NULs) with translation
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001465 * if 'len' is -1, output up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 * Use attributes 'attr'.
1467 * Return the number of characters it takes on the screen.
1468 */
1469 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001470msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471{
1472 return msg_outtrans_attr(str, 0);
1473}
1474
1475 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001476msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477{
1478 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1479}
1480
1481 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001482msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483{
1484 return msg_outtrans_len_attr(str, len, 0);
1485}
1486
1487/*
1488 * Output one character at "p". Return pointer to the next character.
1489 * Handles multi-byte characters.
1490 */
1491 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001492msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 int l;
1495
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001496 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 {
1498 msg_outtrans_len_attr(p, l, attr);
1499 return p + l;
1500 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001501 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 return p + 1;
1503}
1504
1505 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001506msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507{
1508 int retval = 0;
1509 char_u *str = msgstr;
1510 char_u *plain_start = msgstr;
1511 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 int mb_l;
1513 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514
Bram Moolenaar85a20022019-12-21 18:25:54 +01001515 // if MSG_HIST flag set, add message to history
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 if (attr & MSG_HIST)
1517 {
1518 add_msg_hist(str, len, attr);
1519 attr &= ~MSG_HIST;
1520 }
1521
Bram Moolenaar85a20022019-12-21 18:25:54 +01001522 // If the string starts with a composing character first draw a space on
1523 // which the composing char can be drawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001525 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526
1527 /*
1528 * Go over the string. Special characters are translated and printed.
1529 * Normal characters are printed several at a time.
1530 */
1531 while (--len >= 0)
1532 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 if (enc_utf8)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001534 // Don't include composing chars after the end.
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001535 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001537 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 else
1539 mb_l = 1;
1540 if (has_mbyte && mb_l > 1)
1541 {
1542 c = (*mb_ptr2char)(str);
1543 if (vim_isprintc(c))
Bram Moolenaar85a20022019-12-21 18:25:54 +01001544 // printable multi-byte char: count the cells.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 retval += (*mb_ptr2cells)(str);
1546 else
1547 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001548 // unprintable multi-byte char: print the printable chars so
1549 // far and the translation of the unprintable char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001551 msg_puts_attr_len((char *)plain_start,
1552 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001554 msg_puts_attr((char *)transchar(c),
1555 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 retval += char2cells(c);
1557 }
1558 len -= mb_l - 1;
1559 str += mb_l;
1560 }
1561 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 {
1563 s = transchar_byte(*str);
1564 if (s[1] != NUL)
1565 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001566 // unprintable char: print the printable chars so far and the
1567 // translation of the unprintable char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001569 msg_puts_attr_len((char *)plain_start,
1570 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001572 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001573 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001575 else
1576 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 ++str;
1578 }
1579 }
1580
1581 if (str > plain_start)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001582 // print the printable chars at the end
Bram Moolenaar32526b32019-01-19 17:43:09 +01001583 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584
1585 return retval;
1586}
1587
1588#if defined(FEAT_QUICKFIX) || defined(PROTO)
1589 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001590msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591{
1592 int i;
1593 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1594
1595 arg = skipwhite(arg);
1596 for (i = 5; *arg && i >= 0; --i)
1597 if (*arg++ != str[i])
1598 break;
1599 if (i < 0)
1600 {
1601 msg_putchar('\n');
1602 for (i = 0; rs[i]; ++i)
1603 msg_putchar(rs[i] - 3);
1604 }
1605}
1606#endif
1607
1608/*
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001609 * Output the string 'str' up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 * Return the number of characters it takes on the screen.
1611 *
1612 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1613 * following character and shown as <F1>, <S-Up> etc. Any other character
1614 * which is not printable shown in <> form.
1615 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1616 * If a character is displayed in one of these special ways, is also
1617 * highlighted (its highlight name is '8' in the p_hl variable).
1618 * Otherwise characters are not highlighted.
1619 * This function is used to show mappings, where we want to see how to type
1620 * the character/string -- webb
1621 */
1622 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001623msg_outtrans_special(
1624 char_u *strstart,
Bram Moolenaar725310d2019-04-24 23:08:23 +02001625 int from, // TRUE for lhs of a mapping
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001626 int maxlen) // screen columns, 0 for unlimited
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627{
1628 char_u *str = strstart;
1629 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001630 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 int attr;
1632 int len;
1633
Bram Moolenaar8820b482017-03-16 17:23:31 +01001634 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 while (*str != NUL)
1636 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001637 // Leading and trailing spaces need to be displayed in <> form.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 if ((str == strstart || str[1] == NUL) && *str == ' ')
1639 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001640 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 ++str;
1642 }
1643 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001644 text = (char *)str2special(&str, from);
1645 len = vim_strsize((char_u *)text);
Bram Moolenaar725310d2019-04-24 23:08:23 +02001646 if (maxlen > 0 && retval + len >= maxlen)
1647 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001648 // Highlight special keys
Bram Moolenaar32526b32019-01-19 17:43:09 +01001649 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001650 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 retval += len;
1652 }
1653 return retval;
1654}
1655
Bram Moolenaarbd743252010-10-20 21:23:33 +02001656#if defined(FEAT_EVAL) || defined(PROTO)
1657/*
1658 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1659 * strings, in an allocated string.
1660 */
1661 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001662str2special_save(
1663 char_u *str,
Bram Moolenaar85a20022019-12-21 18:25:54 +01001664 int is_lhs) // TRUE for lhs, FALSE for rhs
Bram Moolenaarbd743252010-10-20 21:23:33 +02001665{
1666 garray_T ga;
1667 char_u *p = str;
1668
1669 ga_init2(&ga, 1, 40);
1670 while (*p != NUL)
1671 ga_concat(&ga, str2special(&p, is_lhs));
1672 ga_append(&ga, NUL);
1673 return (char_u *)ga.ga_data;
1674}
1675#endif
1676
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677/*
1678 * Return the printable string for the key codes at "*sp".
1679 * Used for translating the lhs or rhs of a mapping to printable chars.
1680 * Advances "sp" to the next code.
1681 */
1682 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001683str2special(
1684 char_u **sp,
Bram Moolenaar85a20022019-12-21 18:25:54 +01001685 int from) // TRUE for lhs of mapping
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686{
1687 int c;
1688 static char_u buf[7];
1689 char_u *str = *sp;
1690 int modifiers = 0;
1691 int special = FALSE;
1692
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 if (has_mbyte)
1694 {
1695 char_u *p;
1696
Bram Moolenaar85a20022019-12-21 18:25:54 +01001697 // Try to un-escape a multi-byte character. Return the un-escaped
1698 // string if it is a multi-byte character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 p = mb_unescape(sp);
1700 if (p != NULL)
1701 return p;
1702 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703
1704 c = *str;
1705 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1706 {
1707 if (str[1] == KS_MODIFIER)
1708 {
1709 modifiers = str[2];
1710 str += 3;
1711 c = *str;
1712 }
1713 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1714 {
1715 c = TO_SPECIAL(str[1], str[2]);
1716 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001718 if (IS_SPECIAL(c) || modifiers) // special key
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 special = TRUE;
1720 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001722 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001724 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001725
Bram Moolenaar85a20022019-12-21 18:25:54 +01001726 // For multi-byte characters check for an illegal byte.
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001727 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1728 {
1729 transchar_nonprint(buf, c);
1730 *sp = str + 1;
1731 return buf;
1732 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001733 // Since 'special' is TRUE the multi-byte character 'c' will be
1734 // processed by get_special_key_name()
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001735 c = (*mb_ptr2char)(str);
1736 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001738 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001739 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740
Bram Moolenaar85a20022019-12-21 18:25:54 +01001741 // Make unprintable characters in <> form, also <M-Space> and <Tab>.
1742 // Use <Space> only for lhs of a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 if (special || char2cells(c) > 1 || (from && c == ' '))
1744 return get_special_key_name(c, modifiers);
1745 buf[0] = c;
1746 buf[1] = NUL;
1747 return buf;
1748}
1749
1750/*
1751 * Translate a key sequence into special key names.
1752 */
1753 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001754str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755{
1756 char_u *s;
1757
1758 *buf = NUL;
1759 while (*sp)
1760 {
1761 s = str2special(&sp, FALSE);
1762 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1763 STRCAT(buf, s);
1764 }
1765}
1766
1767/*
1768 * print line for :print or :list command
1769 */
1770 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001771msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772{
1773 int c;
1774 int col = 0;
1775 int n_extra = 0;
1776 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001777 int c_final = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001778 char_u *p_extra = NULL; // init to make SASC shut up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001780 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 int l;
1783 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784
Bram Moolenaardf177f62005-02-22 08:39:57 +00001785 if (curwin->w_p_list)
1786 list = TRUE;
1787
Bram Moolenaar85a20022019-12-21 18:25:54 +01001788 // find start of trailing whitespace
Bram Moolenaardf177f62005-02-22 08:39:57 +00001789 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 {
1791 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001792 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 --trail;
1794 }
1795
Bram Moolenaar85a20022019-12-21 18:25:54 +01001796 // output a space for an empty line, otherwise the line will be
1797 // overwritten
Bram Moolenaardf177f62005-02-22 08:39:57 +00001798 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 msg_putchar(' ');
1800
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001801 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001803 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 {
1805 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001806 if (n_extra == 0 && c_final)
1807 c = c_final;
1808 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 c = c_extra;
1810 else
1811 c = *p_extra++;
1812 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001813 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 {
1815 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001816 if (lcs_nbsp != NUL && list
1817 && (mb_ptr2char(s) == 160
1818 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001819 {
1820 mb_char2bytes(lcs_nbsp, buf);
1821 buf[(*mb_ptr2len)(buf)] = NUL;
1822 }
1823 else
1824 {
1825 mch_memmove(buf, s, (size_t)l);
1826 buf[l] = NUL;
1827 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001828 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 s += l;
1830 continue;
1831 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 else
1833 {
1834 attr = 0;
1835 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001836 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001838 // tab amount depends on current column
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001839#ifdef FEAT_VARTABS
1840 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1841 curbuf->b_p_vts_array) - 1;
1842#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001844#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001845 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 {
1847 c = ' ';
1848 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001849 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 }
1851 else
1852 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001853 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001855 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001856 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 }
1858 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001859 else if (c == 160 && list && lcs_nbsp != NUL)
1860 {
1861 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001862 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001863 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001864 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 {
1866 p_extra = (char_u *)"";
1867 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001868 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 n_extra = 1;
1870 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001871 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 --s;
1873 }
1874 else if (c != NUL && (n = byte2cells(c)) > 1)
1875 {
1876 n_extra = n - 1;
1877 p_extra = transchar_byte(c);
1878 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001879 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 c = *p_extra++;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001881 // Use special coloring to be able to distinguish <hex> from
1882 // the same in plain text.
Bram Moolenaar8820b482017-03-16 17:23:31 +01001883 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 }
1885 else if (c == ' ' && trail != NULL && s > trail)
1886 {
1887 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001888 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001890 else if (c == ' ' && list && lcs_space != NUL)
1891 {
1892 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001893 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001894 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 }
1896
1897 if (c == NUL)
1898 break;
1899
1900 msg_putchar_attr(c, attr);
1901 col++;
1902 }
1903 msg_clr_eos();
1904}
1905
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906/*
1907 * Use screen_puts() to output one multi-byte character.
1908 * Return the pointer "s" advanced to the next character.
1909 */
1910 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001911screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912{
1913 int cw;
1914
Bram Moolenaar85a20022019-12-21 18:25:54 +01001915 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 cw = (*mb_ptr2cells)(s);
1917 if (cw > 1 && (
1918#ifdef FEAT_RIGHTLEFT
1919 cmdmsg_rl ? msg_col <= 1 :
1920#endif
1921 msg_col == Columns - 1))
1922 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001923 // Doesn't fit, print a highlighted '>' to fill it up.
Bram Moolenaar8820b482017-03-16 17:23:31 +01001924 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 return s;
1926 }
1927
1928 screen_puts_len(s, l, msg_row, msg_col, attr);
1929#ifdef FEAT_RIGHTLEFT
1930 if (cmdmsg_rl)
1931 {
1932 msg_col -= cw;
1933 if (msg_col == 0)
1934 {
1935 msg_col = Columns;
1936 ++msg_row;
1937 }
1938 }
1939 else
1940#endif
1941 {
1942 msg_col += cw;
1943 if (msg_col >= Columns)
1944 {
1945 msg_col = 0;
1946 ++msg_row;
1947 }
1948 }
1949 return s + l;
1950}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951
1952/*
1953 * Output a string to the screen at position msg_row, msg_col.
1954 * Update msg_row and msg_col for the next message.
1955 */
1956 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001957msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001959 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960}
1961
1962 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001963msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001965 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966}
1967
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968/*
1969 * Show a message in such a way that it always fits in the line. Cut out a
1970 * part in the middle and replace it with "..." when necessary.
1971 * Does not handle multi-byte characters!
1972 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001973 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001974msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975{
1976 int slen = len;
1977 int room;
1978
1979 room = Columns - msg_col;
1980 if (len > room && room >= 20)
1981 {
1982 slen = (room - 3) / 2;
1983 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001984 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 }
1986 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1987}
1988
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001989 void
1990msg_outtrans_long_attr(char_u *longstr, int attr)
1991{
1992 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
1993}
1994
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995/*
1996 * Basic function for writing a message with highlight attributes.
1997 */
1998 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001999msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000{
2001 msg_puts_attr_len(s, -1, attr);
2002}
2003
2004/*
2005 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
2006 * When "maxlen" is -1 there is no maximum length.
2007 * When "maxlen" is >= 0 the message is not put in the history.
2008 */
2009 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01002010msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 /*
2013 * If redirection is on, also write to the redirection file.
2014 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01002015 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016
2017 /*
2018 * Don't print anything when using ":silent cmd".
2019 */
2020 if (msg_silent != 0)
2021 return;
2022
Bram Moolenaar85a20022019-12-21 18:25:54 +01002023 // if MSG_HIST flag set, add message to history
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 if ((attr & MSG_HIST) && maxlen < 0)
2025 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002026 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 attr &= ~MSG_HIST;
2028 }
2029
Bram Moolenaare8070982019-10-12 17:07:06 +02002030 // When writing something to the screen after it has scrolled, requires a
2031 // wait-return prompt later. Needed when scrolling, resetting
2032 // need_wait_return after some prompt, and then outputting something
2033 // without scrolling
2034 // Not needed when only using CR to move the cursor.
2035 if (msg_scrolled != 0 && !msg_scrolled_ign && STRCMP(str, "\r") != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 need_wait_return = TRUE;
Bram Moolenaare8070982019-10-12 17:07:06 +02002037 msg_didany = TRUE; // remember that something was outputted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038
2039 /*
2040 * If there is no valid screen, use fprintf so we can see error messages.
2041 * If termcap is not active, we may be writing in an alternate console
2042 * window, cursor positioning may not work correctly (window size may be
2043 * different, e.g. for Win32 console) or we just don't know where the
2044 * cursor is.
2045 */
2046 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002047 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002048 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002049 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002050}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002052/*
2053 * The display part of msg_puts_attr_len().
2054 * May be called recursively to display scroll-back text.
2055 */
2056 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002057msg_puts_display(
2058 char_u *str,
2059 int maxlen,
2060 int attr,
2061 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002062{
2063 char_u *s = str;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002064 char_u *t_s = str; // string from "t_s" to "s" is still todo
2065 int t_col = 0; // screen cells todo, 0 when "t_s" not used
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002066 int l;
2067 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002068 char_u *sb_str = str;
2069 int sb_col = msg_col;
2070 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002071 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
2073 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002074 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 {
2076 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002077 * We are at the end of the screen line when:
2078 * - When outputting a newline.
2079 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082#ifdef FEAT_RIGHTLEFT
2083 cmdmsg_rl
2084 ? (
2085 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002086 || (*s == TAB && msg_col <= 7)
2087 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 :
2089#endif
Bram Moolenaar0efd1bd2019-12-11 19:00:04 +01002090 ((*s != '\r' && msg_col + t_col >= Columns - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002093 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002095 /*
2096 * The screen is scrolled up when at the last row (some terminals
2097 * scroll automatically, some don't. To avoid problems we scroll
2098 * ourselves).
2099 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 if (t_col > 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002101 // output postponed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002102 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103
Bram Moolenaar85a20022019-12-21 18:25:54 +01002104 // When no more prompt and no more room, truncate here
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 if (msg_no_more && lines_left == 0)
2106 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107
Bram Moolenaar85a20022019-12-21 18:25:54 +01002108 // Scroll the screen up one line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002109 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 msg_row = Rows - 2;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002112 if (msg_col >= Columns) // can happen after screen resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 msg_col = Columns - 1;
2114
Bram Moolenaar85a20022019-12-21 18:25:54 +01002115 // Display char in last column before showing more-prompt.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002116 if (*s >= ' '
2117#ifdef FEAT_RIGHTLEFT
2118 && !cmdmsg_rl
2119#endif
2120 )
2121 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002122 if (has_mbyte)
2123 {
2124 if (enc_utf8 && maxlen >= 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002125 // avoid including composing chars after the end
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002126 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002127 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002128 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002129 s = screen_puts_mbyte(s, l, attr);
2130 }
2131 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002132 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002133 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002134 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002135 else
2136 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002137
2138 if (p_more)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002139 // store text for scrolling back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002140 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2141
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002142 inc_msg_scrolled();
Bram Moolenaar85a20022019-12-21 18:25:54 +01002143 need_wait_return = TRUE; // may need wait_return in main()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 redraw_cmdline = TRUE;
2145 if (cmdline_row > 0 && !exmode_active)
2146 --cmdline_row;
2147
2148 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002149 * If screen is completely filled and 'more' is set then wait
2150 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002152 if (lines_left > 0)
2153 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002154 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 && !msg_no_more && !exmode_active)
2156 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002158 if (do_more_prompt(NUL))
2159 s = confirm_msg_tail;
2160#else
2161 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162#endif
2163 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002164 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002166
Bram Moolenaar85a20022019-12-21 18:25:54 +01002167 // When we displayed a char in last column need to check if there
2168 // is still more.
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002169 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002170 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 }
2172
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002173 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002176 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002177 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2178 || *s == '\t' || *s == BELL))
Bram Moolenaar85a20022019-12-21 18:25:54 +01002179 // output any postponed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002180 t_puts(&t_col, t_s, s, attr);
2181
2182 if (wrap && p_more && !recurse)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002183 // store text for scrolling back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002184 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185
Bram Moolenaar85a20022019-12-21 18:25:54 +01002186 if (*s == '\n') // go to next line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002188 msg_didout = FALSE; // remember that line is empty
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002189#ifdef FEAT_RIGHTLEFT
2190 if (cmdmsg_rl)
2191 msg_col = Columns - 1;
2192 else
2193#endif
2194 msg_col = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002195 if (++msg_row >= Rows) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 msg_row = Rows - 1;
2197 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002198 else if (*s == '\r') // go to column 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 {
2200 msg_col = 0;
2201 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002202 else if (*s == '\b') // go to previous char
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 {
2204 if (msg_col)
2205 --msg_col;
2206 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002207 else if (*s == TAB) // translate Tab into spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 {
2209 do
2210 msg_screen_putchar(' ', attr);
2211 while (msg_col & 7);
2212 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002213 else if (*s == BELL) // beep (from ":sh")
Bram Moolenaar165bc692015-07-21 17:53:25 +02002214 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 else
2216 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 if (has_mbyte)
2218 {
2219 cw = (*mb_ptr2cells)(s);
2220 if (enc_utf8 && maxlen >= 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002221 // avoid including composing chars after the end
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002222 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002224 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 }
2226 else
2227 {
2228 cw = 1;
2229 l = 1;
2230 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002231
Bram Moolenaar85a20022019-12-21 18:25:54 +01002232 // When drawing from right to left or when a double-wide character
2233 // doesn't fit, draw a single character here. Otherwise collect
2234 // characters and draw them all at once later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 if (
2236# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002237 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002239 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 if (l > 1)
2242 s = screen_puts_mbyte(s, l, attr) - 1;
2243 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 msg_screen_putchar(*s, attr);
2245 }
2246 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002248 // postpone this character until later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 if (t_col == 0)
2250 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 t_col += cw;
2252 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 }
2254 }
2255 ++s;
2256 }
2257
Bram Moolenaar85a20022019-12-21 18:25:54 +01002258 // output any postponed text
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002260 t_puts(&t_col, t_s, s, attr);
2261 if (p_more && !recurse)
2262 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263
2264 msg_check();
2265}
2266
2267/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002268 * Return TRUE when ":filter pattern" was used and "msg" does not match
2269 * "pattern".
2270 */
2271 int
2272message_filtered(char_u *msg)
2273{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002274 int match;
2275
2276 if (cmdmod.filter_regmatch.regprog == NULL)
2277 return FALSE;
2278 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2279 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002280}
2281
2282/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002283 * Scroll the screen up one line for displaying the next message line.
2284 */
2285 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002286msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002287{
2288#ifdef FEAT_GUI
Bram Moolenaar85a20022019-12-21 18:25:54 +01002289 // Remove the cursor before scrolling, ScreenLines[] is going
2290 // to become invalid.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002291 if (gui.in_use)
2292 gui_undraw_cursor();
2293#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002294 // scrolling up always works
Bram Moolenaara338adc2018-01-31 20:51:47 +01002295 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002296 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002297 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002298
2299 if (!can_clear((char_u *)" "))
2300 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002301 // Scrolling up doesn't result in the right background. Set the
2302 // background here. It's not efficient, but avoids that we have to do
2303 // it all over the code.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002304 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2305
Bram Moolenaar85a20022019-12-21 18:25:54 +01002306 // Also clear the last char of the last but one line if it was not
2307 // cleared before to avoid a scroll-up.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002308 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2309 screen_fill((int)Rows - 2, (int)Rows - 1,
2310 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2311 }
2312}
2313
2314/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002315 * Increment "msg_scrolled".
2316 */
2317 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002318inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002319{
2320#ifdef FEAT_EVAL
2321 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2322 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002323 char_u *p = SOURCING_NAME;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002324 char_u *tofree = NULL;
2325 int len;
2326
Bram Moolenaar85a20022019-12-21 18:25:54 +01002327 // v:scrollstart is empty, set it to the script/function name and line
2328 // number
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002329 if (p == NULL)
2330 p = (char_u *)_("Unknown");
2331 else
2332 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002333 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002334 tofree = alloc(len);
2335 if (tofree != NULL)
2336 {
2337 vim_snprintf((char *)tofree, len, _("%s line %ld"),
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002338 p, (long)SOURCING_LNUM);
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002339 p = tofree;
2340 }
2341 }
2342 set_vim_var_string(VV_SCROLLSTART, p, -1);
2343 vim_free(tofree);
2344 }
2345#endif
2346 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002347 if (must_redraw < VALID)
2348 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002349}
2350
2351/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002352 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2353 * store the displayed text and remember where screen lines start.
2354 */
2355typedef struct msgchunk_S msgchunk_T;
2356struct msgchunk_S
2357{
2358 msgchunk_T *sb_next;
2359 msgchunk_T *sb_prev;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002360 char sb_eol; // TRUE when line ends after this text
2361 int sb_msg_col; // column in which text starts
2362 int sb_attr; // text attributes
2363 char_u sb_text[1]; // text to be displayed, actually longer
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002364};
2365
Bram Moolenaar85a20022019-12-21 18:25:54 +01002366static msgchunk_T *last_msgchunk = NULL; // last displayed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002367
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002368static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002369
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002370typedef enum {
2371 SB_CLEAR_NONE = 0,
2372 SB_CLEAR_ALL,
2373 SB_CLEAR_CMDLINE_BUSY,
2374 SB_CLEAR_CMDLINE_DONE
2375} sb_clear_T;
2376
Bram Moolenaar85a20022019-12-21 18:25:54 +01002377// When to clear text on next msg.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002378static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002379
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002380/*
2381 * Store part of a printed message for displaying when scrolling back.
2382 */
2383 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002384store_sb_text(
Bram Moolenaar85a20022019-12-21 18:25:54 +01002385 char_u **sb_str, // start of string
2386 char_u *s, // just after string
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002387 int attr,
2388 int *sb_col,
Bram Moolenaar85a20022019-12-21 18:25:54 +01002389 int finish) // line ends
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002390{
2391 msgchunk_T *mp;
2392
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002393 if (do_clear_sb_text == SB_CLEAR_ALL
2394 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002395 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002396 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2397 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002398 }
2399
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002400 if (s > *sb_str)
2401 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002402 mp = alloc(sizeof(msgchunk_T) + (s - *sb_str));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002403 if (mp != NULL)
2404 {
2405 mp->sb_eol = finish;
2406 mp->sb_msg_col = *sb_col;
2407 mp->sb_attr = attr;
2408 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2409
2410 if (last_msgchunk == NULL)
2411 {
2412 last_msgchunk = mp;
2413 mp->sb_prev = NULL;
2414 }
2415 else
2416 {
2417 mp->sb_prev = last_msgchunk;
2418 last_msgchunk->sb_next = mp;
2419 last_msgchunk = mp;
2420 }
2421 mp->sb_next = NULL;
2422 }
2423 }
2424 else if (finish && last_msgchunk != NULL)
2425 last_msgchunk->sb_eol = TRUE;
2426
2427 *sb_str = s;
2428 *sb_col = 0;
2429}
2430
2431/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002432 * Finished showing messages, clear the scroll-back text on the next message.
2433 */
2434 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002435may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002436{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002437 do_clear_sb_text = SB_CLEAR_ALL;
2438}
2439
2440/*
2441 * Starting to edit the command line, do not clear messages now.
2442 */
2443 void
2444sb_text_start_cmdline(void)
2445{
2446 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2447 msg_sb_eol();
2448}
2449
2450/*
2451 * Ending to edit the command line. Clear old lines but the last one later.
2452 */
2453 void
2454sb_text_end_cmdline(void)
2455{
2456 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002457}
2458
2459/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002460 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002461 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002462 * Called when redrawing the screen.
2463 */
2464 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002465clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002466{
2467 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002468 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002469
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002470 if (all)
2471 lastp = &last_msgchunk;
2472 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002473 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002474 if (last_msgchunk == NULL)
2475 return;
2476 lastp = &last_msgchunk->sb_prev;
2477 }
2478
2479 while (*lastp != NULL)
2480 {
2481 mp = (*lastp)->sb_prev;
2482 vim_free(*lastp);
2483 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002484 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002485}
2486
2487/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002488 * "g<" command.
2489 */
2490 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002491show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002492{
2493 msgchunk_T *mp;
2494
Bram Moolenaar85a20022019-12-21 18:25:54 +01002495 // Only show something if there is more than one line, otherwise it looks
2496 // weird, typing a command without output results in one line.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002497 mp = msg_sb_start(last_msgchunk);
2498 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002499 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002500 else
2501 {
2502 do_more_prompt('G');
2503 wait_return(FALSE);
2504 }
2505}
2506
2507/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002508 * Move to the start of screen line in already displayed text.
2509 */
2510 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002511msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002512{
2513 msgchunk_T *mp = mps;
2514
2515 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2516 mp = mp->sb_prev;
2517 return mp;
2518}
2519
2520/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002521 * Mark the last message chunk as finishing the line.
2522 */
2523 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002524msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002525{
2526 if (last_msgchunk != NULL)
2527 last_msgchunk->sb_eol = TRUE;
2528}
2529
2530/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002531 * Display a screen line from previously displayed text at row "row".
2532 * Returns a pointer to the text for the next line (can be NULL).
2533 */
2534 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002535disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002536{
2537 msgchunk_T *mp = smp;
2538 char_u *p;
2539
2540 for (;;)
2541 {
2542 msg_row = row;
2543 msg_col = mp->sb_msg_col;
2544 p = mp->sb_text;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002545 if (*p == '\n') // don't display the line break
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002546 ++p;
2547 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2548 if (mp->sb_eol || mp->sb_next == NULL)
2549 break;
2550 mp = mp->sb_next;
2551 }
2552 return mp->sb_next;
2553}
2554
2555/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 * Output any postponed text for msg_puts_attr_len().
2557 */
2558 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002559t_puts(
2560 int *t_col,
2561 char_u *t_s,
2562 char_u *s,
2563 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564{
Bram Moolenaar85a20022019-12-21 18:25:54 +01002565 // output postponed text
2566 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002568 msg_col += *t_col;
2569 *t_col = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002570 // If the string starts with a composing character don't increment the
2571 // column position for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2573 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 if (msg_col >= Columns)
2575 {
2576 msg_col = 0;
2577 ++msg_row;
2578 }
2579}
2580
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581/*
2582 * Returns TRUE when messages should be printed with mch_errmsg().
2583 * This is used when there is no valid screen, so we can see error messages.
2584 * If termcap is not active, we may be writing in an alternate console
2585 * window, cursor positioning may not work correctly (window size may be
2586 * different, e.g. for Win32 console) or we just don't know where the
2587 * cursor is.
2588 */
2589 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002590msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591{
2592 return (!msg_check_screen()
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002593#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2594# ifdef VIMDLL
2595 || (!gui.in_use && !termcap_active)
2596# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 || !termcap_active
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002598# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599#endif
2600 || (swapping_screen() && !termcap_active)
2601 );
2602}
2603
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002604/*
2605 * Print a message when there is no valid screen.
2606 */
2607 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002608msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002609{
2610 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002611 char_u *buf = NULL;
2612 char_u *p = s;
2613
Bram Moolenaar4f974752019-02-17 17:44:42 +01002614#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002615 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar85a20022019-12-21 18:25:54 +01002616 mch_settmode(TMODE_COOK); // handle CR and NL correctly
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002617#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002618 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002619 {
2620 if (!(silent_mode && p_verbose == 0))
2621 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002622 // NL --> CR NL translation (for Unix, not for "--version")
2623 if (*s == NL)
2624 {
2625 int n = (int)(s - p);
2626
2627 buf = alloc(n + 3);
Bram Moolenaar6f10c702019-08-20 22:58:37 +02002628 if (buf != NULL)
2629 {
2630 memcpy(buf, p, n);
2631 if (!info_message)
2632 buf[n++] = CAR;
2633 buf[n++] = NL;
2634 buf[n++] = NUL;
2635 if (info_message) // informative message, not an error
2636 mch_msg((char *)buf);
2637 else
2638 mch_errmsg((char *)buf);
2639 vim_free(buf);
2640 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002641 p = s + 1;
2642 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002643 }
2644
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002645 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002646#ifdef FEAT_RIGHTLEFT
2647 if (cmdmsg_rl)
2648 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002649 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002650 msg_col = Columns - 1;
2651 else
2652 --msg_col;
2653 }
2654 else
2655#endif
2656 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002657 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002658 msg_col = 0;
2659 else
2660 ++msg_col;
2661 }
2662 ++s;
2663 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002664
2665 if (*p != NUL && !(silent_mode && p_verbose == 0))
2666 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002667 int c = -1;
2668
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002669 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002670 {
2671 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002672 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002673 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002674 if (info_message)
2675 mch_msg((char *)p);
2676 else
2677 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002678 if (c != -1)
2679 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002680 }
2681
2682 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002683
Bram Moolenaar4f974752019-02-17 17:44:42 +01002684#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002685 if (!(silent_mode && p_verbose == 0))
2686 mch_settmode(TMODE_RAW);
2687#endif
2688}
2689
2690/*
2691 * Show the more-prompt and handle the user response.
2692 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002693 * When at hit-enter prompt "typed_char" is the already typed character,
2694 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002695 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2696 */
2697 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002698do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002699{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002700 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002701 int used_typed_char = typed_char;
2702 int oldState = State;
2703 int c;
2704#ifdef FEAT_CON_DIALOG
2705 int retval = FALSE;
2706#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002707 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002708 msgchunk_T *mp_last = NULL;
2709 msgchunk_T *mp;
2710 int i;
2711
Bram Moolenaar85a20022019-12-21 18:25:54 +01002712 // We get called recursively when a timer callback outputs a message. In
2713 // that case don't show another prompt. Also when at the hit-Enter prompt
2714 // and nothing was typed.
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002715 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002716 return FALSE;
2717 entered = TRUE;
2718
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002719 if (typed_char == 'G')
2720 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002721 // "g<": Find first line on the last page.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002722 mp_last = msg_sb_start(last_msgchunk);
2723 for (i = 0; i < Rows - 2 && mp_last != NULL
2724 && mp_last->sb_prev != NULL; ++i)
2725 mp_last = msg_sb_start(mp_last->sb_prev);
2726 }
2727
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002728 State = ASKMORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002729 setmouse();
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002730 if (typed_char == NUL)
2731 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002732 for (;;)
2733 {
2734 /*
2735 * Get a typed character directly from the user.
2736 */
2737 if (used_typed_char != NUL)
2738 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002739 c = used_typed_char; // was typed at hit-enter prompt
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002740 used_typed_char = NUL;
2741 }
2742 else
2743 c = get_keystroke();
2744
2745#if defined(FEAT_MENU) && defined(FEAT_GUI)
2746 if (c == K_MENU)
2747 {
2748 int idx = get_menu_index(current_menu, ASKMORE);
2749
Bram Moolenaar85a20022019-12-21 18:25:54 +01002750 // Used a menu. If it starts with CTRL-Y, it must
2751 // be a "Copy" for the clipboard. Otherwise
2752 // assume that we end
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002753 if (idx == MENU_INDEX_INVALID)
2754 continue;
2755 c = *current_menu->strings[idx];
2756 if (c != NUL && current_menu->strings[idx][1] != NUL)
2757 ins_typebuf(current_menu->strings[idx] + 1,
2758 current_menu->noremap[idx], 0, TRUE,
2759 current_menu->silent[idx]);
2760 }
2761#endif
2762
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002763 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002764 switch (c)
2765 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002766 case BS: // scroll one line back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002767 case K_BS:
2768 case 'k':
2769 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002770 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002771 break;
2772
Bram Moolenaar85a20022019-12-21 18:25:54 +01002773 case CAR: // one extra line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002774 case NL:
2775 case 'j':
2776 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002777 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002778 break;
2779
Bram Moolenaar85a20022019-12-21 18:25:54 +01002780 case 'u': // Up half a page
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002781 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002782 break;
2783
Bram Moolenaar85a20022019-12-21 18:25:54 +01002784 case 'd': // Down half a page
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002785 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002786 break;
2787
Bram Moolenaar85a20022019-12-21 18:25:54 +01002788 case 'b': // one page back
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002789 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002790 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002791 break;
2792
Bram Moolenaar85a20022019-12-21 18:25:54 +01002793 case ' ': // one extra page
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002794 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002795 case K_PAGEDOWN:
2796 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002797 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002798 break;
2799
Bram Moolenaar85a20022019-12-21 18:25:54 +01002800 case 'g': // all the way back to the start
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002801 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002802 break;
2803
Bram Moolenaar85a20022019-12-21 18:25:54 +01002804 case 'G': // all the way to the end
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002805 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002806 lines_left = 999999;
2807 break;
2808
Bram Moolenaar85a20022019-12-21 18:25:54 +01002809 case ':': // start new command line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002810#ifdef FEAT_CON_DIALOG
2811 if (!confirm_msg_used)
2812#endif
2813 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002814 // Since got_int is set all typeahead will be flushed, but we
2815 // want to keep this ':', remember that in a special way.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002816 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002817#ifdef FEAT_TERMINAL
2818 skip_term_loop = TRUE;
2819#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002820 cmdline_row = Rows - 1; // put ':' on this line
2821 skip_redraw = TRUE; // skip redraw once
2822 need_wait_return = FALSE; // don't wait in main()
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002823 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002824 // FALLTHROUGH
2825 case 'q': // quit
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002826 case Ctrl_C:
2827 case ESC:
2828#ifdef FEAT_CON_DIALOG
2829 if (confirm_msg_used)
2830 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002831 // Jump to the choices of the dialog.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002832 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002833 }
2834 else
2835#endif
2836 {
2837 got_int = TRUE;
2838 quit_more = TRUE;
2839 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002840 // When there is some more output (wrapping line) display that
2841 // without another prompt.
Bram Moolenaar51306d22009-02-24 03:38:04 +00002842 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002843 break;
2844
2845#ifdef FEAT_CLIPBOARD
2846 case Ctrl_Y:
Bram Moolenaar85a20022019-12-21 18:25:54 +01002847 // Strange way to allow copying (yanking) a modeless
2848 // selection at the more prompt. Use CTRL-Y,
2849 // because the same is used in Cmdline-mode and at the
2850 // hit-enter prompt. However, scrolling one line up
2851 // might be expected...
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002852 if (clip_star.state == SELECT_DONE)
2853 clip_copy_modeless_selection(TRUE);
2854 continue;
2855#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002856 default: // no valid response
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002857 msg_moremsg(TRUE);
2858 continue;
2859 }
2860
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002861 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002862 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002863 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002864 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002865 // go to start of last line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002866 if (mp_last == NULL)
2867 mp = msg_sb_start(last_msgchunk);
2868 else if (mp_last->sb_prev != NULL)
2869 mp = msg_sb_start(mp_last->sb_prev);
2870 else
2871 mp = NULL;
2872
Bram Moolenaar85a20022019-12-21 18:25:54 +01002873 // go to start of line at top of the screen
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002874 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2875 ++i)
2876 mp = msg_sb_start(mp->sb_prev);
2877
2878 if (mp != NULL && mp->sb_prev != NULL)
2879 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002880 // Find line to be displayed at top.
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002881 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002882 {
2883 if (mp == NULL || mp->sb_prev == NULL)
2884 break;
2885 mp = msg_sb_start(mp->sb_prev);
2886 if (mp_last == NULL)
2887 mp_last = msg_sb_start(last_msgchunk);
2888 else
2889 mp_last = msg_sb_start(mp_last->sb_prev);
2890 }
2891
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002892 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002893 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002894 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002895 // display line at top
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002896 (void)disp_sb_line(0, mp);
2897 }
2898 else
2899 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002900 // redisplay all lines
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002901 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002902 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2903 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002904 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002905 ++msg_scrolled;
2906 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002907 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002908 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002909 }
2910 }
2911 else
2912 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002913 // First display any text that we scrolled back.
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002914 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002915 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002916 // scroll up, display line at bottom
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002917 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002918 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002919 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2920 (int)Columns, ' ', ' ', 0);
2921 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002922 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002923 }
2924 }
2925
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002926 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002927 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002928 // displayed the requested text, more prompt again
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002929 screen_fill((int)Rows - 1, (int)Rows, 0,
2930 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002931 msg_moremsg(FALSE);
2932 continue;
2933 }
2934
Bram Moolenaar85a20022019-12-21 18:25:54 +01002935 // display more text, return to caller
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002936 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002937 }
2938
2939 break;
2940 }
2941
Bram Moolenaar85a20022019-12-21 18:25:54 +01002942 // clear the --more-- message
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002943 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2944 State = oldState;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002945 setmouse();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002946 if (quit_more)
2947 {
2948 msg_row = Rows - 1;
2949 msg_col = 0;
2950 }
2951#ifdef FEAT_RIGHTLEFT
2952 else if (cmdmsg_rl)
2953 msg_col = Columns - 1;
2954#endif
2955
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002956 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002957#ifdef FEAT_CON_DIALOG
2958 return retval;
2959#else
2960 return FALSE;
2961#endif
2962}
2963
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2965
2966#ifdef mch_errmsg
2967# undef mch_errmsg
2968#endif
2969#ifdef mch_msg
2970# undef mch_msg
2971#endif
2972
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002973#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2974 static void
2975mch_errmsg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002977 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002978 DWORD nwrite = 0;
2979 DWORD mode = 0;
2980 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
2981
2982 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
2983 && (int)GetConsoleCP() != enc_codepage)
2984 {
2985 WCHAR *w = enc_to_utf16((char_u *)str, &len);
2986
2987 WriteConsoleW(h, w, len, &nwrite, NULL);
2988 vim_free(w);
2989 }
2990 else
2991 {
2992 fprintf(stderr, "%s", str);
2993 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002994}
2995#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002997/*
2998 * Give an error message. To be used when the screen hasn't been initialized
2999 * yet. When stderr can't be used, collect error messages until the GUI has
3000 * started and they can be displayed in a message box.
3001 */
3002 void
3003mch_errmsg(char *str)
3004{
3005#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
3006 int len;
3007#endif
3008
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003009#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003010 // On Unix use stderr if it's a tty.
3011 // When not going to start the GUI also use stderr.
3012 // On Mac, when started from Finder, stderr is the console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003014# ifdef UNIX
3015# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003017# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 isatty(2)
3019# endif
3020# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003021 ||
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003022# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003023# endif
3024# ifdef FEAT_GUI
3025 !(gui.in_use || gui.starting)
3026# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 )
3028 {
3029 fprintf(stderr, "%s", str);
3030 return;
3031 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003032#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003034#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3035# ifdef VIMDLL
3036 if (!(gui.in_use || gui.starting))
3037# endif
3038 {
3039 mch_errmsg_c(str);
3040 return;
3041 }
3042#endif
3043
3044#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003045 // avoid a delay for a message that isn't there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 emsg_on_display = FALSE;
3047
3048 len = (int)STRLEN(str) + 1;
3049 if (error_ga.ga_growsize == 0)
3050 {
3051 error_ga.ga_growsize = 80;
3052 error_ga.ga_itemsize = 1;
3053 }
3054 if (ga_grow(&error_ga, len) == OK)
3055 {
3056 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3057 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003058# ifdef UNIX
Bram Moolenaar85a20022019-12-21 18:25:54 +01003059 // remove CR characters, they are displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 {
3061 char_u *p;
3062
3063 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3064 for (;;)
3065 {
3066 p = vim_strchr(p, '\r');
3067 if (p == NULL)
3068 break;
3069 *p = ' ';
3070 }
3071 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003072# endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01003073 --len; // don't count the NUL at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003076#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077}
3078
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003079#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3080 static void
3081mch_msg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003083 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003084 DWORD nwrite = 0;
3085 DWORD mode;
3086 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3087
3088
3089 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3090 && (int)GetConsoleCP() != enc_codepage)
3091 {
3092 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3093
3094 WriteConsoleW(h, w, len, &nwrite, NULL);
3095 vim_free(w);
3096 }
3097 else
3098 {
3099 printf("%s", str);
3100 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003101}
3102#endif
3103
3104/*
3105 * Give a message. To be used when the screen hasn't been initialized yet.
3106 * When there is no tty, collect messages until the GUI has started and they
3107 * can be displayed in a message box.
3108 */
3109 void
3110mch_msg(char *str)
3111{
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003112#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003113 // On Unix use stdout if we have a tty. This allows "vim -h | more" and
3114 // uses mch_errmsg() when started from the desktop.
3115 // When not going to start the GUI also use stdout.
3116 // On Mac, when started from Finder, stderr is the console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003118# ifdef UNIX
3119# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003121# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 isatty(2)
Bram Moolenaareae1b912019-05-09 15:12:55 +02003123# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003125 ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003127# endif
3128# ifdef FEAT_GUI
3129 !(gui.in_use || gui.starting)
3130# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 )
3132 {
3133 printf("%s", str);
3134 return;
3135 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003136#endif
3137
3138#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3139# ifdef VIMDLL
3140 if (!(gui.in_use || gui.starting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003142 {
3143 mch_msg_c(str);
3144 return;
3145 }
3146#endif
3147#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003149#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150}
Bram Moolenaar85a20022019-12-21 18:25:54 +01003151#endif // USE_MCH_ERRMSG
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152
3153/*
3154 * Put a character on the screen at the current message position and advance
3155 * to the next position. Only for printable ASCII!
3156 */
3157 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003158msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003160 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 screen_putchar(c, msg_row, msg_col, attr);
3162#ifdef FEAT_RIGHTLEFT
3163 if (cmdmsg_rl)
3164 {
3165 if (--msg_col == 0)
3166 {
3167 msg_col = Columns;
3168 ++msg_row;
3169 }
3170 }
3171 else
3172#endif
3173 {
3174 if (++msg_col >= Columns)
3175 {
3176 msg_col = 0;
3177 ++msg_row;
3178 }
3179 }
3180}
3181
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003182 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003183msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003185 int attr;
3186 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
Bram Moolenaar8820b482017-03-16 17:23:31 +01003188 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003189 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003191 screen_puts((char_u *)
3192 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3193 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194}
3195
3196/*
3197 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3198 * exmode_active.
3199 */
3200 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003201repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202{
3203 if (State == ASKMORE)
3204 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003205 msg_moremsg(TRUE); // display --more-- message again
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 msg_row = Rows - 1;
3207 }
3208#ifdef FEAT_CON_DIALOG
3209 else if (State == CONFIRM)
3210 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003211 display_confirm_msg(); // display ":confirm" message again
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 msg_row = Rows - 1;
3213 }
3214#endif
3215 else if (State == EXTERNCMD)
3216 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003217 windgoto(msg_row, msg_col); // put cursor back
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 }
3219 else if (State == HITRETURN || State == SETWSIZE)
3220 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003221 if (msg_row == Rows - 1)
3222 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003223 // Avoid drawing the "hit-enter" prompt below the previous one,
3224 // overwrite it. Esp. useful when regaining focus and a
3225 // FocusGained autocmd exists but didn't draw anything.
Bram Moolenaar9f108752007-11-24 14:44:58 +00003226 msg_didout = FALSE;
3227 msg_col = 0;
3228 msg_clr_eos();
3229 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 hit_return_msg();
3231 msg_row = Rows - 1;
3232 }
3233}
3234
3235/*
3236 * msg_check_screen - check if the screen is initialized.
3237 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3238 * While starting the GUI the terminal codes will be set for the GUI, but the
3239 * output goes to the terminal. Don't use the terminal codes then.
3240 */
3241 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003242msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243{
3244 if (!full_screen || !screen_valid(FALSE))
3245 return FALSE;
3246
3247 if (msg_row >= Rows)
3248 msg_row = Rows - 1;
3249 if (msg_col >= Columns)
3250 msg_col = Columns - 1;
3251 return TRUE;
3252}
3253
3254/*
3255 * Clear from current message position to end of screen.
3256 * Skip this when ":silent" was used, no need to clear for redirection.
3257 */
3258 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003259msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260{
3261 if (msg_silent == 0)
3262 msg_clr_eos_force();
3263}
3264
3265/*
3266 * Clear from current message position to end of screen.
3267 * Note: msg_col is not updated, so we remember the end of the message
3268 * for msg_check().
3269 */
3270 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003271msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272{
3273 if (msg_use_printf())
3274 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003275 if (full_screen) // only when termcap codes are valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 {
3277 if (*T_CD)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003278 out_str(T_CD); // clear to end of display
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 else if (*T_CE)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003280 out_str(T_CE); // clear to end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 }
3282 }
3283 else
3284 {
3285#ifdef FEAT_RIGHTLEFT
3286 if (cmdmsg_rl)
3287 {
3288 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3289 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3290 }
3291 else
3292#endif
3293 {
3294 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3295 ' ', ' ', 0);
3296 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3297 }
3298 }
3299}
3300
3301/*
3302 * Clear the command line.
3303 */
3304 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003305msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306{
3307 msg_row = cmdline_row;
3308 msg_col = 0;
3309 msg_clr_eos_force();
3310}
3311
3312/*
3313 * end putting a message on the screen
3314 * call wait_return if the message does not fit in the available space
3315 * return TRUE if wait_return not called.
3316 */
3317 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003318msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319{
3320 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003321 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 * or the ruler option is set and we run into it,
3323 * we have to redraw the window.
3324 * Do not do this if we are abandoning the file or editing the command line.
3325 */
3326 if (!exiting && need_wait_return && !(State & CMDLINE))
3327 {
3328 wait_return(FALSE);
3329 return FALSE;
3330 }
3331 out_flush();
3332 return TRUE;
3333}
3334
3335/*
3336 * If the written message runs into the shown command or ruler, we have to
3337 * wait for hit-return and redraw the window later.
3338 */
3339 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003340msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341{
3342 if (msg_row == Rows - 1 && msg_col >= sc_col)
3343 {
3344 need_wait_return = TRUE;
3345 redraw_cmdline = TRUE;
3346 }
3347}
3348
3349/*
3350 * May write a string to the redirection file.
3351 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3352 */
3353 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003354redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355{
3356 char_u *s = str;
3357 static int cur_col = 0;
3358
Bram Moolenaar85a20022019-12-21 18:25:54 +01003359 // Don't do anything for displaying prompts and the like.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003360 if (redir_off)
3361 return;
3362
Bram Moolenaar85a20022019-12-21 18:25:54 +01003363 // If 'verbosefile' is set prepare for writing in that file.
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003364 if (*p_vfile != NUL && verbose_fd == NULL)
3365 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003366
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003367 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003369 // If the string doesn't start with CR or NL, go to msg_col
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 if (*s != '\n' && *s != '\r')
3371 {
3372 while (cur_col < msg_col)
3373 {
3374#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003375 if (redir_execute)
3376 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003377 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003379 else if (redir_vname)
3380 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003381 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003383 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003385 if (verbose_fd != NULL)
3386 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 ++cur_col;
3388 }
3389 }
3390
3391#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003392 if (redir_execute)
3393 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003394 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003396 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003397 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398#endif
3399
Bram Moolenaar85a20022019-12-21 18:25:54 +01003400 // Write and adjust the current column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3402 {
3403#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003404 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003406 if (redir_fd != NULL)
3407 putc(*s, redir_fd);
3408 if (verbose_fd != NULL)
3409 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 if (*s == '\r' || *s == '\n')
3411 cur_col = 0;
3412 else if (*s == '\t')
3413 cur_col += (8 - cur_col % 8);
3414 else
3415 ++cur_col;
3416 ++s;
3417 }
3418
Bram Moolenaar85a20022019-12-21 18:25:54 +01003419 if (msg_silent != 0) // should update msg_col
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 msg_col = cur_col;
3421 }
3422}
3423
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003424 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003425redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003426{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003427 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003428#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003429 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003430#endif
3431 ;
3432}
3433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003435 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003436 * Must always be called paired with verbose_leave()!
3437 */
3438 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003439verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003440{
3441 if (*p_vfile != NUL)
3442 ++msg_silent;
3443}
3444
3445/*
3446 * After giving verbose message.
3447 * Must always be called paired with verbose_enter()!
3448 */
3449 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003450verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003451{
3452 if (*p_vfile != NUL)
3453 if (--msg_silent < 0)
3454 msg_silent = 0;
3455}
3456
3457/*
3458 * Like verbose_enter() and set msg_scroll when displaying the message.
3459 */
3460 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003461verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003462{
3463 if (*p_vfile != NUL)
3464 ++msg_silent;
3465 else
Bram Moolenaar85a20022019-12-21 18:25:54 +01003466 // always scroll up, don't overwrite
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003467 msg_scroll = TRUE;
3468}
3469
3470/*
3471 * Like verbose_leave() and set cmdline_row when displaying the message.
3472 */
3473 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003474verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003475{
3476 if (*p_vfile != NUL)
3477 {
3478 if (--msg_silent < 0)
3479 msg_silent = 0;
3480 }
3481 else
3482 cmdline_row = msg_row;
3483}
3484
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003485/*
3486 * Called when 'verbosefile' is set: stop writing to the file.
3487 */
3488 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003489verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003490{
3491 if (verbose_fd != NULL)
3492 {
3493 fclose(verbose_fd);
3494 verbose_fd = NULL;
3495 }
3496 verbose_did_open = FALSE;
3497}
3498
3499/*
3500 * Open the file 'verbosefile'.
3501 * Return FAIL or OK.
3502 */
3503 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003504verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003505{
3506 if (verbose_fd == NULL && !verbose_did_open)
3507 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003508 // Only give the error message once.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003509 verbose_did_open = TRUE;
3510
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003511 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003512 if (verbose_fd == NULL)
3513 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003514 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003515 return FAIL;
3516 }
3517 }
3518 return OK;
3519}
3520
3521/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 * Give a warning message (for searching).
3523 * Use 'w' highlighting and may repeat the message after redrawing
3524 */
3525 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003526give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003528 // Don't do this for ":silent".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 if (msg_silent != 0)
3530 return;
3531
Bram Moolenaar85a20022019-12-21 18:25:54 +01003532 // Don't want a hit-enter prompt here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535#ifdef FEAT_EVAL
3536 set_vim_var_string(VV_WARNINGMSG, message, -1);
3537#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003538 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003540 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 else
3542 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003543 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003544 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar85a20022019-12-21 18:25:54 +01003545 msg_didout = FALSE; // overwrite this message
3546 msg_nowait = TRUE; // don't wait for this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003548
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 --no_wait_return;
3550}
3551
Bram Moolenaar113e1072019-01-20 15:30:40 +01003552#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003553 void
3554give_warning2(char_u *message, char_u *a1, int hl)
3555{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +02003556 if (IObuff == NULL)
3557 {
3558 // Very early in initialisation and already something wrong, just give
3559 // the raw message so the user at least gets a hint.
3560 give_warning((char_u *)message, hl);
3561 }
3562 else
3563 {
3564 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3565 give_warning(IObuff, hl);
3566 }
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003567}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003568#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003569
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570/*
3571 * Advance msg cursor to column "col".
3572 */
3573 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003574msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003576 if (msg_silent != 0) // nothing to advance to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003578 msg_col = col; // for redirection, may fill it up later
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 return;
3580 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01003581 if (col >= Columns) // not enough room
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003583#ifdef FEAT_RIGHTLEFT
3584 if (cmdmsg_rl)
3585 while (msg_col > Columns - col)
3586 msg_putchar(' ');
3587 else
3588#endif
3589 while (msg_col < col)
3590 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591}
3592
3593#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3594/*
3595 * Used for "confirm()" function, and the :confirm command prefix.
3596 * Versions which haven't got flexible dialogs yet, and console
3597 * versions, get this generic handler which uses the command line.
3598 *
3599 * type = one of:
3600 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3601 * title = title string (can be NULL for default)
3602 * (neither used in console dialogs at the moment)
3603 *
3604 * Format of the "buttons" string:
3605 * "Button1Name\nButton2Name\nButton3Name"
3606 * The first button should normally be the default/accept
3607 * The second button should be the 'Cancel' button
3608 * Other buttons- use your imagination!
3609 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3610 * different letter.
3611 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003613do_dialog(
3614 int type UNUSED,
3615 char_u *title UNUSED,
3616 char_u *message,
3617 char_u *buttons,
3618 int dfltbutton,
Bram Moolenaar85a20022019-12-21 18:25:54 +01003619 char_u *textfield UNUSED, // IObuff for inputdialog(), NULL
3620 // otherwise
3621 int ex_cmd) // when TRUE pressing : accepts default and starts
3622 // Ex command
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623{
3624 int oldState;
3625 int retval = 0;
3626 char_u *hotkeys;
3627 int c;
3628 int i;
3629
3630#ifndef NO_CONSOLE
Bram Moolenaar85a20022019-12-21 18:25:54 +01003631 // Don't output anything in silent mode ("ex -s")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 if (silent_mode)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003633 return dfltbutton; // return default option
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634#endif
3635
3636#ifdef FEAT_GUI_DIALOG
Bram Moolenaar85a20022019-12-21 18:25:54 +01003637 // When GUI is running and 'c' not in 'guioptions', use the GUI dialog
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3639 {
3640 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003641 textfield, ex_cmd);
Bram Moolenaar85a20022019-12-21 18:25:54 +01003642 // avoid a hit-enter prompt without clearing the cmdline
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003643 need_wait_return = FALSE;
3644 emsg_on_display = FALSE;
3645 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646
Bram Moolenaar85a20022019-12-21 18:25:54 +01003647 // Flush output to avoid that further messages and redrawing is done
3648 // in the wrong order.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 out_flush();
3650 gui_mch_update();
3651
3652 return c;
3653 }
3654#endif
3655
3656 oldState = State;
3657 State = CONFIRM;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659
3660 /*
3661 * Since we wait for a keypress, don't make the
3662 * user press RETURN as well afterwards.
3663 */
3664 ++no_wait_return;
3665 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3666
3667 if (hotkeys != NULL)
3668 {
3669 for (;;)
3670 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003671 // Get a typed character directly from the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 c = get_keystroke();
3673 switch (c)
3674 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003675 case CAR: // User accepts default option
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 case NL:
3677 retval = dfltbutton;
3678 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003679 case Ctrl_C: // User aborts/cancels
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 case ESC:
3681 retval = 0;
3682 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003683 default: // Could be a hotkey?
3684 if (c < 0) // special keys are ignored here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003686 if (c == ':' && ex_cmd)
3687 {
3688 retval = dfltbutton;
3689 ins_char_typebuf(':');
3690 break;
3691 }
3692
Bram Moolenaar85a20022019-12-21 18:25:54 +01003693 // Make the character lowercase, as chars in "hotkeys" are.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 c = MB_TOLOWER(c);
3695 retval = 1;
3696 for (i = 0; hotkeys[i]; ++i)
3697 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 if (has_mbyte)
3699 {
3700 if ((*mb_ptr2char)(hotkeys + i) == c)
3701 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003702 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 }
3704 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 if (hotkeys[i] == c)
3706 break;
3707 ++retval;
3708 }
3709 if (hotkeys[i])
3710 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003711 // No hotkey match, so keep waiting
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 continue;
3713 }
3714 break;
3715 }
3716
3717 vim_free(hotkeys);
3718 }
3719
3720 State = oldState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 --no_wait_return;
3723 msg_end_prompt();
3724
3725 return retval;
3726}
3727
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728/*
3729 * Copy one character from "*from" to "*to", taking care of multi-byte
3730 * characters. Return the length of the character in bytes.
3731 */
3732 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003733copy_char(
3734 char_u *from,
3735 char_u *to,
Bram Moolenaar85a20022019-12-21 18:25:54 +01003736 int lowercase) // make character lower case
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 int len;
3739 int c;
3740
3741 if (has_mbyte)
3742 {
3743 if (lowercase)
3744 {
3745 c = MB_TOLOWER((*mb_ptr2char)(from));
3746 return (*mb_char2bytes)(c, to);
3747 }
3748 else
3749 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003750 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 mch_memmove(to, from, (size_t)len);
3752 return len;
3753 }
3754 }
3755 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 {
3757 if (lowercase)
3758 *to = (char_u)TOLOWER_LOC(*from);
3759 else
3760 *to = *from;
3761 return 1;
3762 }
3763}
3764
3765/*
3766 * Format the dialog string, and display it at the bottom of
3767 * the screen. Return a string of hotkey chars (if defined) for
3768 * each 'button'. If a button has no hotkey defined, the first character of
3769 * the button is used.
3770 * The hotkeys can be multi-byte characters, but without combining chars.
3771 *
3772 * Returns an allocated string with hotkeys, or NULL for error.
3773 */
3774 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003775msg_show_console_dialog(
3776 char_u *message,
3777 char_u *buttons,
3778 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779{
3780 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003781#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003782 int lenhotkey = HOTK_LEN; // count first button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 char_u *hotk = NULL;
3784 char_u *msgp = NULL;
3785 char_u *hotkp = NULL;
3786 char_u *r;
3787 int copy;
3788#define HAS_HOTKEY_LEN 30
3789 char_u has_hotkey[HAS_HOTKEY_LEN];
Bram Moolenaar85a20022019-12-21 18:25:54 +01003790 int first_hotkey = FALSE; // first char of button is hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 int idx;
3792
3793 has_hotkey[0] = FALSE;
3794
3795 /*
3796 * First loop: compute the size of memory to allocate.
3797 * Second loop: copy to the allocated memory.
3798 */
3799 for (copy = 0; copy <= 1; ++copy)
3800 {
3801 r = buttons;
3802 idx = 0;
3803 while (*r)
3804 {
3805 if (*r == DLG_BUTTON_SEP)
3806 {
3807 if (copy)
3808 {
3809 *msgp++ = ',';
Bram Moolenaar85a20022019-12-21 18:25:54 +01003810 *msgp++ = ' '; // '\n' -> ', '
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811
Bram Moolenaar85a20022019-12-21 18:25:54 +01003812 // advance to next hotkey and set default hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003814 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003817 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 if (dfltbutton)
3819 --dfltbutton;
3820
Bram Moolenaar85a20022019-12-21 18:25:54 +01003821 // If no hotkey is specified first char is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3823 first_hotkey = TRUE;
3824 }
3825 else
3826 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003827 len += 3; // '\n' -> ', '; 'x' -> '(x)'
3828 lenhotkey += HOTK_LEN; // each button needs a hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 if (idx < HAS_HOTKEY_LEN - 1)
3830 has_hotkey[++idx] = FALSE;
3831 }
3832 }
3833 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3834 {
3835 if (*r == DLG_HOTKEY_CHAR)
3836 ++r;
3837 first_hotkey = FALSE;
3838 if (copy)
3839 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003840 if (*r == DLG_HOTKEY_CHAR) // '&&a' -> '&a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 *msgp++ = *r;
3842 else
3843 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003844 // '&a' -> '[a]'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3846 msgp += copy_char(r, msgp, FALSE);
3847 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3848
Bram Moolenaar85a20022019-12-21 18:25:54 +01003849 // redefine hotkey
Bram Moolenaar6a516062007-07-05 08:11:42 +00003850 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 }
3852 }
3853 else
3854 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003855 ++len; // '&a' -> '[a]'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 if (idx < HAS_HOTKEY_LEN - 1)
3857 has_hotkey[idx] = TRUE;
3858 }
3859 }
3860 else
3861 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003862 // everything else copy literally
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 if (copy)
3864 msgp += copy_char(r, msgp, FALSE);
3865 }
3866
Bram Moolenaar85a20022019-12-21 18:25:54 +01003867 // advance to the next character
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003868 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 }
3870
3871 if (copy)
3872 {
3873 *msgp++ = ':';
3874 *msgp++ = ' ';
3875 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 }
3877 else
3878 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003879 len += (int)(STRLEN(message)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003880 + 2 // for the NL's
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003881 + STRLEN(buttons)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003882 + 3); // for the ": " and NUL
3883 lenhotkey++; // for the NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884
Bram Moolenaar85a20022019-12-21 18:25:54 +01003885 // If no hotkey is specified first char is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 if (!has_hotkey[0])
3887 {
3888 first_hotkey = TRUE;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003889 len += 2; // "x" -> "[x]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 }
3891
3892 /*
3893 * Now allocate and load the strings
3894 */
3895 vim_free(confirm_msg);
3896 confirm_msg = alloc(len);
3897 if (confirm_msg == NULL)
3898 return NULL;
3899 *confirm_msg = NUL;
3900 hotk = alloc(lenhotkey);
3901 if (hotk == NULL)
3902 return NULL;
3903
3904 *confirm_msg = '\n';
3905 STRCPY(confirm_msg + 1, message);
3906
3907 msgp = confirm_msg + 1 + STRLEN(message);
3908 hotkp = hotk;
3909
Bram Moolenaar85a20022019-12-21 18:25:54 +01003910 // Define first default hotkey. Keep the hotkey string NUL
3911 // terminated to avoid reading past the end.
Bram Moolenaar6a516062007-07-05 08:11:42 +00003912 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913
Bram Moolenaar85a20022019-12-21 18:25:54 +01003914 // Remember where the choices start, displaying starts here when
3915 // "hotkp" typed at the more prompt.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 confirm_msg_tail = msgp;
3917 *msgp++ = '\n';
3918 }
3919 }
3920
3921 display_confirm_msg();
3922 return hotk;
3923}
3924
3925/*
3926 * Display the ":confirm" message. Also called when screen resized.
3927 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003928 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003929display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003931 // avoid that 'q' at the more prompt truncates the message here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 ++confirm_msg_used;
3933 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003934 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 --confirm_msg_used;
3936}
3937
Bram Moolenaar85a20022019-12-21 18:25:54 +01003938#endif // FEAT_CON_DIALOG
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939
3940#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3941
3942 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003943vim_dialog_yesno(
3944 int type,
3945 char_u *title,
3946 char_u *message,
3947 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948{
3949 if (do_dialog(type,
3950 title == NULL ? (char_u *)_("Question") : title,
3951 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003952 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 return VIM_YES;
3954 return VIM_NO;
3955}
3956
3957 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003958vim_dialog_yesnocancel(
3959 int type,
3960 char_u *title,
3961 char_u *message,
3962 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963{
3964 switch (do_dialog(type,
3965 title == NULL ? (char_u *)_("Question") : title,
3966 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003967 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 {
3969 case 1: return VIM_YES;
3970 case 2: return VIM_NO;
3971 }
3972 return VIM_CANCEL;
3973}
3974
3975 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003976vim_dialog_yesnoallcancel(
3977 int type,
3978 char_u *title,
3979 char_u *message,
3980 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981{
3982 switch (do_dialog(type,
3983 title == NULL ? (char_u *)"Question" : title,
3984 message,
3985 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003986 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {
3988 case 1: return VIM_YES;
3989 case 2: return VIM_NO;
3990 case 3: return VIM_ALL;
3991 case 4: return VIM_DISCARDALL;
3992 }
3993 return VIM_CANCEL;
3994}
3995
Bram Moolenaar85a20022019-12-21 18:25:54 +01003996#endif // FEAT_GUI_DIALOG || FEAT_CON_DIALOG
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003998#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003999static char *e_printf = N_("E766: Insufficient arguments for printf()");
4000
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004001/*
4002 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4003 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004004 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004005tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004006{
4007 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004008 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004009 int err = FALSE;
4010
4011 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004012 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004013 else
4014 {
4015 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004016 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004017 if (err)
4018 n = 0;
4019 }
4020 return n;
4021}
4022
4023/*
4024 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004025 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004026 * are not converted to a string.
4027 * If "tofree" is not NULL echo_string() is used. All types are converted to
4028 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004029 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004030 */
4031 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004032tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004033{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004034 int idx = *idxp - 1;
4035 char *s = NULL;
4036 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004037
4038 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004039 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004040 else
4041 {
4042 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004043 if (tofree != NULL)
4044 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4045 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004046 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004047 }
4048 return s;
4049}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004050
4051# ifdef FEAT_FLOAT
4052/*
4053 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4054 */
4055 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004056tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004057{
4058 int idx = *idxp - 1;
4059 double f = 0;
4060
4061 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004062 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004063 else
4064 {
4065 ++*idxp;
4066 if (tvs[idx].v_type == VAR_FLOAT)
4067 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004068 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004069 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004070 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004071 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004072 }
4073 return f;
4074}
4075# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004076#endif
4077
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004078#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004079/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004080 * Return the representation of infinity for printf() function:
4081 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4082 */
4083 static const char *
4084infinity_str(int positive,
4085 char fmt_spec,
4086 int force_sign,
4087 int space_for_positive)
4088{
4089 static const char *table[] =
4090 {
4091 "-inf", "inf", "+inf", " inf",
4092 "-INF", "INF", "+INF", " INF"
4093 };
4094 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4095
4096 if (ASCII_ISUPPER(fmt_spec))
4097 idx += 4;
4098 return table[idx];
4099}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004100#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004101
4102/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004103 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004104 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004105 * consistency.
4106 *
4107 * This code is based on snprintf.c - a portable implementation of snprintf
4108 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004109 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004110 * The original code, including useful comments, can be found here:
4111 * http://www.ijs.si/software/snprintf/
4112 *
4113 * This snprintf() only supports the following conversion specifiers:
4114 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4115 * with flags: '-', '+', ' ', '0' and '#'.
4116 * An asterisk is supported for field width as well as precision.
4117 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004118 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004119 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004120 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4121 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004122 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004123 * The locale is not used, the string is used as a byte string. This is only
4124 * relevant for double-byte encodings where the second byte may be '%'.
4125 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004126 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4127 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004128 *
4129 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004130 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004131 * is greater or equal to "str_m", not all characters from the result
4132 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4133 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004134 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004135 */
4136
4137/*
4138 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004139 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004140 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004141 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004142 */
4143
Bram Moolenaar85a20022019-12-21 18:25:54 +01004144// When generating prototypes all of this is skipped, cproto doesn't
4145// understand this.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004146#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004147
Bram Moolenaar85a20022019-12-21 18:25:54 +01004148// Like vim_vsnprintf() but append to the string.
Bram Moolenaara800b422010-06-27 01:15:55 +02004149 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004150vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004151{
4152 va_list ap;
4153 int str_l;
4154 size_t len = STRLEN(str);
4155 size_t space;
4156
4157 if (str_m <= len)
4158 space = 0;
4159 else
4160 space = str_m - len;
4161 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004162 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004163 va_end(ap);
4164 return str_l;
4165}
Bram Moolenaara800b422010-06-27 01:15:55 +02004166
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004167 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004168vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004169{
4170 va_list ap;
4171 int str_l;
4172
4173 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004174 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004175 va_end(ap);
4176 return str_l;
4177}
4178
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004179 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004180vim_vsnprintf(
4181 char *str,
4182 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004183 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004184 va_list ap)
4185{
4186 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4187}
4188
4189 int
4190vim_vsnprintf_typval(
4191 char *str,
4192 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004193 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004194 va_list ap,
4195 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004196{
4197 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004198 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004199 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004200
4201 if (p == NULL)
4202 p = "";
4203 while (*p != NUL)
4204 {
4205 if (*p != '%')
4206 {
4207 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004208 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004209
Bram Moolenaar85a20022019-12-21 18:25:54 +01004210 // Copy up to the next '%' or NUL without any changes.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004211 if (str_l < str_m)
4212 {
4213 size_t avail = str_m - str_l;
4214
4215 mch_memmove(str + str_l, p, n > avail ? avail : n);
4216 }
4217 p += n;
4218 str_l += n;
4219 }
4220 else
4221 {
4222 size_t min_field_width = 0, precision = 0;
4223 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4224 int alternate_form = 0, force_sign = 0;
4225
Bram Moolenaar85a20022019-12-21 18:25:54 +01004226 // If both the ' ' and '+' flags appear, the ' ' flag should be
4227 // ignored.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004228 int space_for_positive = 1;
4229
Bram Moolenaar85a20022019-12-21 18:25:54 +01004230 // allowed values: \0, h, l, L
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004231 char length_modifier = '\0';
4232
Bram Moolenaar85a20022019-12-21 18:25:54 +01004233 // temporary buffer for simple numeric->string conversion
Bram Moolenaar91984b92016-08-16 21:58:41 +02004234# if defined(FEAT_FLOAT)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004235# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
4236 // That sounds reasonable to use as the maximum
4237 // printable.
Bram Moolenaar91984b92016-08-16 21:58:41 +02004238# elif defined(FEAT_NUM64)
4239# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004240# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004241# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004242# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004243 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004244
Bram Moolenaar85a20022019-12-21 18:25:54 +01004245 // string address in case of string argument
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004246 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004247
Bram Moolenaar85a20022019-12-21 18:25:54 +01004248 // natural field width of arg without padding and sign
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004249 size_t str_arg_l;
4250
Bram Moolenaar85a20022019-12-21 18:25:54 +01004251 // unsigned char argument value - only defined for c conversion.
4252 // N.B. standard explicitly states the char argument for the c
4253 // conversion is unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004254 unsigned char uchar_arg;
4255
Bram Moolenaar85a20022019-12-21 18:25:54 +01004256 // number of zeros to be inserted for numeric conversions as
4257 // required by the precision or minimal field width
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004258 size_t number_of_zeros_to_pad = 0;
4259
Bram Moolenaar85a20022019-12-21 18:25:54 +01004260 // index into tmp where zero padding is to be inserted
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004261 size_t zero_padding_insertion_ind = 0;
4262
Bram Moolenaar85a20022019-12-21 18:25:54 +01004263 // current conversion specifier character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004264 char fmt_spec = '\0';
4265
Bram Moolenaar85a20022019-12-21 18:25:54 +01004266 // buffer for 's' and 'S' specs
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004267 char_u *tofree = NULL;
4268
4269
Bram Moolenaar85a20022019-12-21 18:25:54 +01004270 p++; // skip '%'
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004271
Bram Moolenaar85a20022019-12-21 18:25:54 +01004272 // parse flags
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004273 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4274 || *p == '#' || *p == '\'')
4275 {
4276 switch (*p)
4277 {
4278 case '0': zero_padding = 1; break;
4279 case '-': justify_left = 1; break;
4280 case '+': force_sign = 1; space_for_positive = 0; break;
4281 case ' ': force_sign = 1;
Bram Moolenaar85a20022019-12-21 18:25:54 +01004282 // If both the ' ' and '+' flags appear, the ' '
4283 // flag should be ignored
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004284 break;
4285 case '#': alternate_form = 1; break;
4286 case '\'': break;
4287 }
4288 p++;
4289 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004290 // If the '0' and '-' flags both appear, the '0' flag should be
4291 // ignored.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004292
Bram Moolenaar85a20022019-12-21 18:25:54 +01004293 // parse field width
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004294 if (*p == '*')
4295 {
4296 int j;
4297
4298 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004299 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004300# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004301 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004302# endif
4303 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004304 if (j >= 0)
4305 min_field_width = j;
4306 else
4307 {
4308 min_field_width = -j;
4309 justify_left = 1;
4310 }
4311 }
4312 else if (VIM_ISDIGIT((int)(*p)))
4313 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004314 // size_t could be wider than unsigned int; make sure we treat
4315 // argument like common implementations do
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004316 unsigned int uj = *p++ - '0';
4317
4318 while (VIM_ISDIGIT((int)(*p)))
4319 uj = 10 * uj + (unsigned int)(*p++ - '0');
4320 min_field_width = uj;
4321 }
4322
Bram Moolenaar85a20022019-12-21 18:25:54 +01004323 // parse precision
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324 if (*p == '.')
4325 {
4326 p++;
4327 precision_specified = 1;
4328 if (*p == '*')
4329 {
4330 int j;
4331
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004332 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004333# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004334 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004335# endif
4336 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004337 p++;
4338 if (j >= 0)
4339 precision = j;
4340 else
4341 {
4342 precision_specified = 0;
4343 precision = 0;
4344 }
4345 }
4346 else if (VIM_ISDIGIT((int)(*p)))
4347 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004348 // size_t could be wider than unsigned int; make sure we
4349 // treat argument like common implementations do
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004350 unsigned int uj = *p++ - '0';
4351
4352 while (VIM_ISDIGIT((int)(*p)))
4353 uj = 10 * uj + (unsigned int)(*p++ - '0');
4354 precision = uj;
4355 }
4356 }
4357
Bram Moolenaar85a20022019-12-21 18:25:54 +01004358 // parse 'h', 'l' and 'll' length modifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004359 if (*p == 'h' || *p == 'l')
4360 {
4361 length_modifier = *p;
4362 p++;
4363 if (length_modifier == 'l' && *p == 'l')
4364 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004365 // double l = long long
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004366# ifdef FEAT_NUM64
4367 length_modifier = 'L';
4368# else
Bram Moolenaar85a20022019-12-21 18:25:54 +01004369 length_modifier = 'l'; // treat it as a single 'l'
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004370# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004371 p++;
4372 }
4373 }
4374 fmt_spec = *p;
4375
Bram Moolenaar85a20022019-12-21 18:25:54 +01004376 // common synonyms:
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004377 switch (fmt_spec)
4378 {
4379 case 'i': fmt_spec = 'd'; break;
4380 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4381 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4382 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4383 default: break;
4384 }
4385
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004386# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4387 switch (fmt_spec)
4388 {
4389 case 'd': case 'u': case 'o': case 'x': case 'X':
4390 if (tvs != NULL && length_modifier == '\0')
4391 length_modifier = 'L';
4392 }
4393# endif
4394
Bram Moolenaar85a20022019-12-21 18:25:54 +01004395 // get parameter value, do initial processing
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004396 switch (fmt_spec)
4397 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004398 // '%' and 'c' behave similar to 's' regarding flags and field
4399 // widths
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004400 case '%':
4401 case 'c':
4402 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004403 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004404 str_arg_l = 1;
4405 switch (fmt_spec)
4406 {
4407 case '%':
4408 str_arg = p;
4409 break;
4410
4411 case 'c':
4412 {
4413 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004414
4415 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004416# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004417 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004418# endif
4419 va_arg(ap, int);
Bram Moolenaar85a20022019-12-21 18:25:54 +01004420 // standard demands unsigned char
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004421 uchar_arg = (unsigned char)j;
4422 str_arg = (char *)&uchar_arg;
4423 break;
4424 }
4425
4426 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004427 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004428 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004429# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004430 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004431# endif
4432 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004433 if (str_arg == NULL)
4434 {
4435 str_arg = "[NULL]";
4436 str_arg_l = 6;
4437 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004438 // make sure not to address string beyond the specified
4439 // precision !!!
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004440 else if (!precision_specified)
4441 str_arg_l = strlen(str_arg);
Bram Moolenaar85a20022019-12-21 18:25:54 +01004442 // truncate string if necessary as requested by precision
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004443 else if (precision == 0)
4444 str_arg_l = 0;
4445 else
4446 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004447 // Don't put the #if inside memchr(), it can be a
4448 // macro.
4449 // memchr on HP does not like n > 2^31 !!!
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004450 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004451 precision <= (size_t)0x7fffffffL ? precision
4452 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004453 str_arg_l = (q == NULL) ? precision
4454 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004455 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004456 if (fmt_spec == 'S')
4457 {
4458 if (min_field_width != 0)
4459 min_field_width += STRLEN(str_arg)
4460 - mb_string2cells((char_u *)str_arg, -1);
4461 if (precision)
4462 {
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004463 char_u *p1;
4464 size_t i = 0;
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004465
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004466 for (p1 = (char_u *)str_arg; *p1;
4467 p1 += mb_ptr2len(p1))
4468 {
4469 i += (size_t)mb_ptr2cells(p1);
4470 if (i > precision)
4471 break;
4472 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004473 str_arg_l = precision = p1 - (char_u *)str_arg;
4474 }
4475 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004476 break;
4477
4478 default:
4479 break;
4480 }
4481 break;
4482
Bram Moolenaar91984b92016-08-16 21:58:41 +02004483 case 'd': case 'u':
4484 case 'b': case 'B':
4485 case 'o':
4486 case 'x': case 'X':
4487 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004488 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004489 // NOTE: the u, b, o, x, X and p conversion specifiers
4490 // imply the value is unsigned; d implies a signed
4491 // value
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004492
Bram Moolenaar85a20022019-12-21 18:25:54 +01004493 // 0 if numeric argument is zero (or if pointer is
4494 // NULL for 'p'), +1 if greater than zero (or nonzero
4495 // for unsigned arguments), -1 if negative (unsigned
4496 // argument is never negative)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004497 int arg_sign = 0;
4498
Bram Moolenaar85a20022019-12-21 18:25:54 +01004499 // only defined for length modifier h, or for no
4500 // length modifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004501 int int_arg = 0;
4502 unsigned int uint_arg = 0;
4503
Bram Moolenaar85a20022019-12-21 18:25:54 +01004504 // only defined for length modifier l
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004505 long int long_arg = 0;
4506 unsigned long int ulong_arg = 0;
4507
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004508# ifdef FEAT_NUM64
Bram Moolenaar85a20022019-12-21 18:25:54 +01004509 // only defined for length modifier ll
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004510 varnumber_T llong_arg = 0;
4511 uvarnumber_T ullong_arg = 0;
4512# endif
4513
Bram Moolenaar85a20022019-12-21 18:25:54 +01004514 // only defined for b conversion
Bram Moolenaar91984b92016-08-16 21:58:41 +02004515 uvarnumber_T bin_arg = 0;
4516
Bram Moolenaar85a20022019-12-21 18:25:54 +01004517 // pointer argument value -only defined for p
4518 // conversion
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004519 void *ptr_arg = NULL;
4520
4521 if (fmt_spec == 'p')
4522 {
4523 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004524 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004525# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004526 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4527 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004528# endif
4529 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004530 if (ptr_arg != NULL)
4531 arg_sign = 1;
4532 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004533 else if (fmt_spec == 'b' || fmt_spec == 'B')
4534 {
4535 bin_arg =
4536# if defined(FEAT_EVAL)
4537 tvs != NULL ?
4538 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4539# endif
4540 va_arg(ap, uvarnumber_T);
4541 if (bin_arg != 0)
4542 arg_sign = 1;
4543 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004544 else if (fmt_spec == 'd')
4545 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004546 // signed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004547 switch (length_modifier)
4548 {
4549 case '\0':
4550 case 'h':
Bram Moolenaar85a20022019-12-21 18:25:54 +01004551 // char and short arguments are passed as int.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004552 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004553# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004554 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004555# endif
4556 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004557 if (int_arg > 0)
4558 arg_sign = 1;
4559 else if (int_arg < 0)
4560 arg_sign = -1;
4561 break;
4562 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004563 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004564# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004565 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004566# endif
4567 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004568 if (long_arg > 0)
4569 arg_sign = 1;
4570 else if (long_arg < 0)
4571 arg_sign = -1;
4572 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004573# ifdef FEAT_NUM64
4574 case 'L':
4575 llong_arg =
4576# if defined(FEAT_EVAL)
4577 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4578# endif
4579 va_arg(ap, varnumber_T);
4580 if (llong_arg > 0)
4581 arg_sign = 1;
4582 else if (llong_arg < 0)
4583 arg_sign = -1;
4584 break;
4585# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004586 }
4587 }
4588 else
4589 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004590 // unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004591 switch (length_modifier)
4592 {
4593 case '\0':
4594 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004595 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004596# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004597 tvs != NULL ? (unsigned)
4598 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004599# endif
4600 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004601 if (uint_arg != 0)
4602 arg_sign = 1;
4603 break;
4604 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004605 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004606# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004607 tvs != NULL ? (unsigned long)
4608 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004609# endif
4610 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004611 if (ulong_arg != 0)
4612 arg_sign = 1;
4613 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004614# ifdef FEAT_NUM64
4615 case 'L':
4616 ullong_arg =
4617# if defined(FEAT_EVAL)
4618 tvs != NULL ? (uvarnumber_T)
4619 tv_nr(tvs, &arg_idx) :
4620# endif
4621 va_arg(ap, uvarnumber_T);
4622 if (ullong_arg != 0)
4623 arg_sign = 1;
4624 break;
4625# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004626 }
4627 }
4628
4629 str_arg = tmp;
4630 str_arg_l = 0;
4631
Bram Moolenaar85a20022019-12-21 18:25:54 +01004632 // NOTE:
4633 // For d, i, u, o, x, and X conversions, if precision is
4634 // specified, the '0' flag should be ignored. This is so
4635 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4636 // FreeBSD, NetBSD; but not with Perl.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004637 if (precision_specified)
4638 zero_padding = 0;
4639 if (fmt_spec == 'd')
4640 {
4641 if (force_sign && arg_sign >= 0)
4642 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
Bram Moolenaar85a20022019-12-21 18:25:54 +01004643 // leave negative numbers for sprintf to handle, to
4644 // avoid handling tricky cases like (short int)-32768
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004645 }
4646 else if (alternate_form)
4647 {
4648 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004649 && (fmt_spec == 'b' || fmt_spec == 'B'
4650 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004651 {
4652 tmp[str_arg_l++] = '0';
4653 tmp[str_arg_l++] = fmt_spec;
4654 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004655 // alternate form should have no effect for p
4656 // conversion, but ...
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004657 }
4658
4659 zero_padding_insertion_ind = str_arg_l;
4660 if (!precision_specified)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004661 precision = 1; // default precision is 1
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004662 if (precision == 0 && arg_sign == 0)
4663 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004664 // When zero value is formatted with an explicit
4665 // precision 0, the resulting formatted string is
4666 // empty (d, i, u, b, B, o, x, X, p).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004667 }
4668 else
4669 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004670 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004671 int f_l = 0;
4672
Bram Moolenaar85a20022019-12-21 18:25:54 +01004673 // construct a simple format string for sprintf
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004674 f[f_l++] = '%';
4675 if (!length_modifier)
4676 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004677 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004678 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004679# ifdef FEAT_NUM64
Bram Moolenaar4f974752019-02-17 17:44:42 +01004680# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004681 f[f_l++] = 'I';
4682 f[f_l++] = '6';
4683 f[f_l++] = '4';
4684# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004685 f[f_l++] = 'l';
4686 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004687# endif
4688# else
4689 f[f_l++] = 'l';
4690# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004691 }
4692 else
4693 f[f_l++] = length_modifier;
4694 f[f_l++] = fmt_spec;
4695 f[f_l++] = '\0';
4696
4697 if (fmt_spec == 'p')
4698 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004699 else if (fmt_spec == 'b' || fmt_spec == 'B')
4700 {
4701 char b[8 * sizeof(uvarnumber_T)];
4702 size_t b_l = 0;
4703 uvarnumber_T bn = bin_arg;
4704
4705 do
4706 {
4707 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4708 bn >>= 1;
4709 }
4710 while (bn != 0);
4711
4712 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4713 str_arg_l += b_l;
4714 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004715 else if (fmt_spec == 'd')
4716 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004717 // signed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004718 switch (length_modifier)
4719 {
4720 case '\0':
4721 case 'h': str_arg_l += sprintf(
4722 tmp + str_arg_l, f, int_arg);
4723 break;
4724 case 'l': str_arg_l += sprintf(
4725 tmp + str_arg_l, f, long_arg);
4726 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004727# ifdef FEAT_NUM64
4728 case 'L': str_arg_l += sprintf(
4729 tmp + str_arg_l, f, llong_arg);
4730 break;
4731# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004732 }
4733 }
4734 else
4735 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004736 // unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004737 switch (length_modifier)
4738 {
4739 case '\0':
4740 case 'h': str_arg_l += sprintf(
4741 tmp + str_arg_l, f, uint_arg);
4742 break;
4743 case 'l': str_arg_l += sprintf(
4744 tmp + str_arg_l, f, ulong_arg);
4745 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004746# ifdef FEAT_NUM64
4747 case 'L': str_arg_l += sprintf(
4748 tmp + str_arg_l, f, ullong_arg);
4749 break;
4750# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004751 }
4752 }
4753
Bram Moolenaar85a20022019-12-21 18:25:54 +01004754 // include the optional minus sign and possible
4755 // "0x" in the region before the zero padding
4756 // insertion point
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004757 if (zero_padding_insertion_ind < str_arg_l
4758 && tmp[zero_padding_insertion_ind] == '-')
4759 zero_padding_insertion_ind++;
4760 if (zero_padding_insertion_ind + 1 < str_arg_l
4761 && tmp[zero_padding_insertion_ind] == '0'
4762 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4763 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4764 zero_padding_insertion_ind += 2;
4765 }
4766
4767 {
4768 size_t num_of_digits = str_arg_l
4769 - zero_padding_insertion_ind;
4770
4771 if (alternate_form && fmt_spec == 'o'
Bram Moolenaar85a20022019-12-21 18:25:54 +01004772 // unless zero is already the first
4773 // character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004774 && !(zero_padding_insertion_ind < str_arg_l
4775 && tmp[zero_padding_insertion_ind] == '0'))
4776 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004777 // assure leading zero for alternate-form
4778 // octal numbers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004779 if (!precision_specified
4780 || precision < num_of_digits + 1)
4781 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004782 // precision is increased to force the
4783 // first character to be zero, except if a
4784 // zero value is formatted with an
4785 // explicit precision of zero
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004786 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004787 }
4788 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004789 // zero padding to specified precision?
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004790 if (num_of_digits < precision)
4791 number_of_zeros_to_pad = precision - num_of_digits;
4792 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004793 // zero padding to specified minimal field width?
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004794 if (!justify_left && zero_padding)
4795 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004796 int n = (int)(min_field_width - (str_arg_l
4797 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004798 if (n > 0)
4799 number_of_zeros_to_pad += n;
4800 }
4801 break;
4802 }
4803
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004804# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004805 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004806 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004807 case 'e':
4808 case 'E':
4809 case 'g':
4810 case 'G':
4811 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004812 // Floating point.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004813 double f;
4814 double abs_f;
4815 char format[40];
4816 int l;
4817 int remove_trailing_zeroes = FALSE;
4818
4819 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004820# if defined(FEAT_EVAL)
4821 tvs != NULL ? tv_float(tvs, &arg_idx) :
4822# endif
4823 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004824 abs_f = f < 0 ? -f : f;
4825
4826 if (fmt_spec == 'g' || fmt_spec == 'G')
4827 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004828 // Would be nice to use %g directly, but it prints
4829 // "1.0" as "1", we don't want that.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004830 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4831 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004832 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004833 else
4834 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4835 remove_trailing_zeroes = TRUE;
4836 }
4837
Bram Moolenaar04186092016-08-29 21:55:35 +02004838 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004839# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004840 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004841# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004842 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004843# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004844 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004845 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004846 // Avoid a buffer overflow
Bram Moolenaare9997822016-08-28 16:03:38 +02004847 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4848 force_sign, space_for_positive));
4849 str_arg_l = STRLEN(tmp);
4850 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004851 }
4852 else
4853 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004854 if (isnan(f))
4855 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004856 // Not a number: nan or NAN
Bram Moolenaare9997822016-08-28 16:03:38 +02004857 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4858 : "nan");
4859 str_arg_l = 3;
4860 zero_padding = 0;
4861 }
4862 else if (isinf(f))
4863 {
4864 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4865 force_sign, space_for_positive));
4866 str_arg_l = STRLEN(tmp);
4867 zero_padding = 0;
4868 }
4869 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004870 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004871 // Regular float number
Bram Moolenaar04186092016-08-29 21:55:35 +02004872 format[0] = '%';
4873 l = 1;
4874 if (force_sign)
4875 format[l++] = space_for_positive ? ' ' : '+';
4876 if (precision_specified)
4877 {
4878 size_t max_prec = TMP_LEN - 10;
4879
Bram Moolenaar85a20022019-12-21 18:25:54 +01004880 // Make sure we don't get more digits than we
4881 // have room for.
Bram Moolenaar04186092016-08-29 21:55:35 +02004882 if ((fmt_spec == 'f' || fmt_spec == 'F')
4883 && abs_f > 1.0)
4884 max_prec -= (size_t)log10(abs_f);
4885 if (precision > max_prec)
4886 precision = max_prec;
4887 l += sprintf(format + l, ".%d", (int)precision);
4888 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004889 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004890 format[l + 1] = NUL;
4891
Bram Moolenaare9997822016-08-28 16:03:38 +02004892 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004893 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004894
Bram Moolenaara7241f52008-06-24 20:39:31 +00004895 if (remove_trailing_zeroes)
4896 {
4897 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004898 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004899
Bram Moolenaar85a20022019-12-21 18:25:54 +01004900 // Using %g or %G: remove superfluous zeroes.
Bram Moolenaar04186092016-08-29 21:55:35 +02004901 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004902 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004903 else
4904 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004905 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004906 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004907 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004908 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004909 // Remove superfluous '+' and leading
4910 // zeroes from the exponent.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004911 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004912 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004913 // Change "1.0e+07" to "1.0e07"
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004914 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004915 --str_arg_l;
4916 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004917 i = (tp[1] == '-') ? 2 : 1;
4918 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004919 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004920 // Change "1.0e07" to "1.0e7"
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004921 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004922 --str_arg_l;
4923 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004924 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004925 }
4926 }
4927
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004928 if (tp != NULL && !precision_specified)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004929 // Remove trailing zeroes, but keep the one
4930 // just after a dot.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004931 while (tp > tmp + 2 && *tp == '0'
4932 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004933 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004934 STRMOVE(tp, tp + 1);
4935 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004936 --str_arg_l;
4937 }
4938 }
4939 else
4940 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004941 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004942
Bram Moolenaar85a20022019-12-21 18:25:54 +01004943 // Be consistent: some printf("%e") use 1.0e+12
4944 // and some 1.0e+012. Remove one zero in the last
4945 // case.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004946 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004947 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004948 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4949 && tp[2] == '0'
4950 && vim_isdigit(tp[3])
4951 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004952 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004953 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004954 --str_arg_l;
4955 }
4956 }
4957 }
Bram Moolenaar04186092016-08-29 21:55:35 +02004958 if (zero_padding && min_field_width > str_arg_l
4959 && (tmp[0] == '-' || force_sign))
4960 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004961 // padding 0's should be inserted after the sign
Bram Moolenaar04186092016-08-29 21:55:35 +02004962 number_of_zeros_to_pad = min_field_width - str_arg_l;
4963 zero_padding_insertion_ind = 1;
4964 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00004965 str_arg = tmp;
4966 break;
4967 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004968# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004969
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004970 default:
Bram Moolenaar85a20022019-12-21 18:25:54 +01004971 // unrecognized conversion specifier, keep format string
4972 // as-is
4973 zero_padding = 0; // turn zero padding off for non-numeric
4974 // conversion
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004975 justify_left = 1;
Bram Moolenaar85a20022019-12-21 18:25:54 +01004976 min_field_width = 0; // reset flags
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004977
Bram Moolenaar85a20022019-12-21 18:25:54 +01004978 // discard the unrecognized conversion, just keep *
4979 // the unrecognized conversion character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004980 str_arg = p;
4981 str_arg_l = 0;
4982 if (*p != NUL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004983 str_arg_l++; // include invalid conversion specifier
4984 // unchanged if not at end-of-string
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004985 break;
4986 }
4987
4988 if (*p != NUL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004989 p++; // step over the just processed conversion specifier
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004990
Bram Moolenaar85a20022019-12-21 18:25:54 +01004991 // insert padding to the left as requested by min_field_width;
4992 // this does not include the zero padding in case of numerical
4993 // conversions
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004994 if (!justify_left)
4995 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004996 // left padding with blank or zero
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004997 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004998
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004999 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005000 {
5001 if (str_l < str_m)
5002 {
5003 size_t avail = str_m - str_l;
5004
5005 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005006 (size_t)pn > avail ? avail
5007 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005008 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005009 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005010 }
5011 }
5012
Bram Moolenaar85a20022019-12-21 18:25:54 +01005013 // zero padding as requested by the precision or by the minimal
5014 // field width for numeric conversions required?
Bram Moolenaarea424162005-06-16 21:51:00 +00005015 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005016 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005017 // will not copy first part of numeric right now, *
5018 // force it to be copied later in its entirety
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005019 zero_padding_insertion_ind = 0;
5020 }
5021 else
5022 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005023 // insert first part of numerics (sign or '0x') before zero
5024 // padding
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005025 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005026
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005027 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005028 {
5029 if (str_l < str_m)
5030 {
5031 size_t avail = str_m - str_l;
5032
5033 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005034 (size_t)zn > avail ? avail
5035 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005036 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005037 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005038 }
5039
Bram Moolenaar85a20022019-12-21 18:25:54 +01005040 // insert zero padding as requested by the precision or min
5041 // field width
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005042 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005043 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005044 {
5045 if (str_l < str_m)
5046 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005047 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005048
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005049 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005050 (size_t)zn > avail ? avail
5051 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005052 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005053 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005054 }
5055 }
5056
Bram Moolenaar85a20022019-12-21 18:25:54 +01005057 // insert formatted string
5058 // (or as-is conversion specifier for unknown conversions)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005059 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005060 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005061
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005062 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005063 {
5064 if (str_l < str_m)
5065 {
5066 size_t avail = str_m - str_l;
5067
5068 mch_memmove(str + str_l,
5069 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005070 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005071 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005072 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005073 }
5074 }
5075
Bram Moolenaar85a20022019-12-21 18:25:54 +01005076 // insert right padding
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005077 if (justify_left)
5078 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005079 // right blank padding to the field width
Bram Moolenaara7241f52008-06-24 20:39:31 +00005080 int pn = (int)(min_field_width
5081 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005082
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005083 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005084 {
5085 if (str_l < str_m)
5086 {
5087 size_t avail = str_m - str_l;
5088
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005089 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005090 (size_t)pn > avail ? avail
5091 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005093 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005094 }
5095 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005096 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097 }
5098 }
5099
5100 if (str_m > 0)
5101 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005102 // make sure the string is nul-terminated even at the expense of
5103 // overwriting the last character (shouldn't happen, but just in case)
5104 //
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005105 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5106 }
5107
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005108 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005109 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005110
Bram Moolenaar85a20022019-12-21 18:25:54 +01005111 // Return the number of characters formatted (excluding trailing nul
5112 // character), that is, the number of characters that would have been
5113 // written to the buffer if it were large enough.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005114 return (int)str_l;
5115}
5116
Bram Moolenaar85a20022019-12-21 18:25:54 +01005117#endif // PROTO