blob: fbddfadcbb5bad1390d11c378add6822d92ab73e [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 Moolenaardd589232020-02-29 17:38:12 +0100841/*
842 * Like internal_error() but do not call abort(), to avoid tests using
843 * test_unknown() and test_void() causing Vim to exit.
844 */
845 void
846internal_error_no_abort(char *where)
847{
848 semsg(_(e_intern2), where);
849}
850
Bram Moolenaar85a20022019-12-21 18:25:54 +0100851// emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852
Bram Moolenaardf177f62005-02-22 08:39:57 +0000853 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100854emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000855{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100856 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000857}
858
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100860 * Give an error message which contains %s for "name[len]".
861 */
862 void
863emsg_namelen(char *msg, char_u *name, int len)
864{
865 char_u *copy = vim_strnsave((char_u *)name, len);
866
867 semsg(msg, copy == NULL ? "NULL" : (char *)copy);
Bram Moolenaar292b90d2020-03-18 15:23:16 +0100868 vim_free(copy);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100869}
870
871/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 * Like msg(), but truncate to a single line if p_shm contains 't', or when
873 * "force" is TRUE. This truncates in another way as for normal messages.
874 * Careful: The string may be changed by msg_may_trunc()!
875 * Returns a pointer to the printed message, if wait_return() not called.
876 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100877 char *
878msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879{
880 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100881 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
Bram Moolenaar85a20022019-12-21 18:25:54 +0100883 // Add message to history before truncating
Bram Moolenaar32526b32019-01-19 17:43:09 +0100884 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885
Bram Moolenaar32526b32019-01-19 17:43:09 +0100886 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887
888 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100889 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 msg_hist_off = FALSE;
891
892 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100893 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 return NULL;
895}
896
897/*
898 * Check if message "s" should be truncated at the start (for filenames).
899 * Return a pointer to where the truncated message starts.
900 * Note: May change the message by replacing a character with '<'.
901 */
902 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100903msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904{
905 int n;
906 int room;
907
908 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
909 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
910 && (n = (int)STRLEN(s) - room) > 0)
911 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 if (has_mbyte)
913 {
914 int size = vim_strsize(s);
915
Bram Moolenaar85a20022019-12-21 18:25:54 +0100916 // There may be room anyway when there are multibyte chars.
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000917 if (size <= room)
918 return s;
919
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 for (n = 0; size >= room; )
921 {
922 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000923 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 }
925 --n;
926 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 s += n;
928 *s = '<';
929 }
930 return s;
931}
932
933 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100934add_msg_hist(
935 char_u *s,
Bram Moolenaar85a20022019-12-21 18:25:54 +0100936 int len, // -1 for undetermined length
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100937 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938{
939 struct msg_hist *p;
940
941 if (msg_hist_off || msg_silent != 0)
942 return;
943
Bram Moolenaar85a20022019-12-21 18:25:54 +0100944 // Don't let the message history get too big
Bram Moolenaar4770d092006-01-12 23:22:24 +0000945 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000946 (void)delete_first_msg();
947
Bram Moolenaar85a20022019-12-21 18:25:54 +0100948 // allocate an entry and add the message at the end of the history
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200949 p = ALLOC_ONE(struct msg_hist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 if (p != NULL)
951 {
952 if (len < 0)
953 len = (int)STRLEN(s);
Bram Moolenaar85a20022019-12-21 18:25:54 +0100954 // remove leading and trailing newlines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 while (len > 0 && *s == '\n')
956 {
957 ++s;
958 --len;
959 }
960 while (len > 0 && s[len - 1] == '\n')
961 --len;
962 p->msg = vim_strnsave(s, len);
963 p->next = NULL;
964 p->attr = attr;
965 if (last_msg_hist != NULL)
966 last_msg_hist->next = p;
967 last_msg_hist = p;
968 if (first_msg_hist == NULL)
969 first_msg_hist = last_msg_hist;
970 ++msg_hist_len;
971 }
972}
973
974/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000975 * Delete the first (oldest) message from the history.
976 * Returns FAIL if there are no messages.
977 */
978 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100979delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000980{
981 struct msg_hist *p;
982
983 if (msg_hist_len <= 0)
984 return FAIL;
985 p = first_msg_hist;
986 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000987 if (first_msg_hist == NULL)
Bram Moolenaar85a20022019-12-21 18:25:54 +0100988 last_msg_hist = NULL; // history is empty
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000989 vim_free(p->msg);
990 vim_free(p);
991 --msg_hist_len;
992 return OK;
993}
994
995/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 * ":messages" command.
997 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200999ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000{
1001 struct msg_hist *p;
1002 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +02001003 int c = 0;
1004
1005 if (STRCMP(eap->arg, "clear") == 0)
1006 {
1007 int keep = eap->addr_count == 0 ? 0 : eap->line2;
1008
1009 while (msg_hist_len > keep)
1010 (void)delete_first_msg();
1011 return;
1012 }
1013
1014 if (*eap->arg != NUL)
1015 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001016 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +02001017 return;
1018 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019
1020 msg_hist_off = TRUE;
1021
Bram Moolenaar451f8492016-04-14 17:16:22 +02001022 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +02001023 if (eap->addr_count != 0)
1024 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001025 // Count total messages
Bram Moolenaar451f8492016-04-14 17:16:22 +02001026 for (; p != NULL && !got_int; p = p->next)
1027 c++;
1028
1029 c -= eap->line2;
1030
Bram Moolenaar85a20022019-12-21 18:25:54 +01001031 // Skip without number of messages specified
Bram Moolenaar451f8492016-04-14 17:16:22 +02001032 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
1033 p = p->next, c--);
1034 }
1035
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001036 if (p == first_msg_hist)
1037 {
1038 s = mch_getenv((char_u *)"LANG");
1039 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +02001040 // The next comment is extracted by xgettext and put in po file for
1041 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +01001042 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +02001043 // Translator: Please replace the name and email address
1044 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001045 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +01001046 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +02001047 }
1048
Bram Moolenaar85a20022019-12-21 18:25:54 +01001049 // Display what was not skipped.
Bram Moolenaar451f8492016-04-14 17:16:22 +02001050 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001052 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
1054 msg_hist_off = FALSE;
1055}
1056
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001057#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058/*
1059 * Call this after prompting the user. This will avoid a hit-return message
1060 * and a delay.
1061 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001062 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001063msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064{
1065 need_wait_return = FALSE;
1066 emsg_on_display = FALSE;
1067 cmdline_row = msg_row;
1068 msg_col = 0;
1069 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001070 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071}
1072#endif
1073
1074/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001075 * Wait for the user to hit a key (normally Enter).
1076 * If "redraw" is TRUE, clear and redraw the screen.
1077 * If "redraw" is FALSE, just redraw the screen.
1078 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 */
1080 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001081wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082{
1083 int c;
1084 int oldState;
1085 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001087 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001088 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090 if (redraw == TRUE)
1091 must_redraw = CLEAR;
1092
Bram Moolenaar85a20022019-12-21 18:25:54 +01001093 // If using ":silent cmd", don't wait for a return. Also don't set
1094 // need_wait_return to do it later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 if (msg_silent != 0)
1096 return;
1097
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001098 /*
1099 * When inside vgetc(), we can't wait for a typed character at all.
1100 * With the global command (and some others) we only need one return at
1101 * the end. Adjust cmdline_row to avoid the next message overwriting the
1102 * last one.
1103 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001104 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001106 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 if (no_wait_return)
1108 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 if (!exmode_active)
1110 cmdline_row = msg_row;
1111 return;
1112 }
1113
Bram Moolenaar85a20022019-12-21 18:25:54 +01001114 redir_off = TRUE; // don't redirect this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 oldState = State;
1116 if (quit_more)
1117 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001118 c = CAR; // just pretend CR was hit
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 quit_more = FALSE;
1120 got_int = FALSE;
1121 }
1122 else if (exmode_active)
1123 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001124 msg_puts(" "); // make sure the cursor is on the right line
1125 c = CAR; // no need for a return in ex mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 got_int = FALSE;
1127 }
1128 else
1129 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001130 // Make sure the hit-return prompt is on screen when 'guioptions' was
1131 // just changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 screenalloc(FALSE);
1133
1134 State = HITRETURN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar85a20022019-12-21 18:25:54 +01001137 dont_scroll = TRUE; // disallow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001139 cmdline_row = msg_row;
1140
Bram Moolenaar85a20022019-12-21 18:25:54 +01001141 // Avoid the sequence that the user types ":" at the hit-return prompt
1142 // to start an Ex command, but the file-changed dialog gets in the
1143 // way.
Bram Moolenaarec38d692013-04-24 15:12:32 +02001144 if (need_check_timestamps)
1145 check_timestamps(FALSE);
1146
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 hit_return_msg();
1148
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 do
1150 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001151 // Remember "got_int", if it is set vgetc() probably returns a
1152 // CTRL-C, but we need to loop then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001154
Bram Moolenaar85a20022019-12-21 18:25:54 +01001155 // Don't do mappings here, we put the character back in the
1156 // typeahead buffer.
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001157 ++no_mapping;
1158 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001159
Bram Moolenaar85a20022019-12-21 18:25:54 +01001160 // Temporarily disable Recording. If Recording is active, the
1161 // character will be recorded later, since it will be added to the
1162 // typebuf after the loop
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001163 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001164 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001165 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001166 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001168 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001170 --no_mapping;
1171 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001172 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001173 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001174
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175#ifdef FEAT_CLIPBOARD
Bram Moolenaar85a20022019-12-21 18:25:54 +01001176 // Strange way to allow copying (yanking) a modeless selection at
1177 // the hit-enter prompt. Use CTRL-Y, because the same is used in
1178 // Cmdline-mode and it's harmless when there is no selection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1180 {
1181 clip_copy_modeless_selection(TRUE);
1182 c = K_IGNORE;
1183 }
1184#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001185
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001186 /*
1187 * Allow scrolling back in the messages.
1188 * Also accept scroll-down commands when messages fill the screen,
1189 * to avoid that typing one 'j' too many makes the messages
1190 * disappear.
1191 */
1192 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001193 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001194 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1195 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001196 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001197 if (msg_scrolled > Rows)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001198 // scroll back to show older messages
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001199 do_more_prompt(c);
1200 else
1201 {
1202 msg_didout = FALSE;
1203 c = K_IGNORE;
1204 msg_col =
1205#ifdef FEAT_RIGHTLEFT
1206 cmdmsg_rl ? Columns - 1 :
1207#endif
1208 0;
1209 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001210 if (quit_more)
1211 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001212 c = CAR; // just pretend CR was hit
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001213 quit_more = FALSE;
1214 got_int = FALSE;
1215 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001216 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001217 {
1218 c = K_IGNORE;
1219 hit_return_msg();
1220 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001221 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001222 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001223 && (c == 'j' || c == 'd' || c == 'f'
1224 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001225 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001226 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 } while ((had_got_int && c == Ctrl_C)
1228 || c == K_IGNORE
1229#ifdef FEAT_GUI
1230 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1231#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1233 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1234 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001235 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001237 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 || (!mouse_has(MOUSE_RETURN)
1239 && mouse_row < msg_row
1240 && (c == K_LEFTMOUSE
1241 || c == K_MIDDLEMOUSE
1242 || c == K_RIGHTMOUSE
1243 || c == K_X1MOUSE
1244 || c == K_X2MOUSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 );
1246 ui_breakcheck();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 /*
1248 * Avoid that the mouse-up event causes visual mode to start.
1249 */
1250 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1251 || c == K_X1MOUSE || c == K_X2MOUSE)
1252 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
Bram Moolenaara1cb1d12019-10-17 23:00:07 +02001253 else if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001255 // Put the character back in the typeahead buffer. Don't use the
1256 // stuff buffer, because lmaps wouldn't work.
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001257 ins_char_typebuf(c);
Bram Moolenaar85a20022019-12-21 18:25:54 +01001258 do_redraw = TRUE; // need a redraw even though there is
1259 // typeahead
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 }
1262 redir_off = FALSE;
1263
1264 /*
1265 * If the user hits ':', '?' or '/' we get a command line from the next
1266 * line.
1267 */
1268 if (c == ':' || c == '?' || c == '/')
1269 {
1270 if (!exmode_active)
1271 cmdline_row = msg_row;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001272 skip_redraw = TRUE; // skip redraw once
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001274#ifdef FEAT_TERMINAL
1275 skip_term_loop = TRUE;
1276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 }
1278
1279 /*
1280 * If the window size changed set_shellsize() will redraw the screen.
1281 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1282 * typed.
1283 */
1284 tmpState = State;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001285 State = oldState; // restore State before set_shellsize
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 msg_check();
1288
1289#if defined(UNIX) || defined(VMS)
1290 /*
1291 * When switching screens, we need to output an extra newline on exit.
1292 */
1293 if (swapping_screen() && !termcap_active)
1294 newline_on_exit = TRUE;
1295#endif
1296
1297 need_wait_return = FALSE;
1298 did_wait_return = TRUE;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001299 emsg_on_display = FALSE; // can delete error message now
1300 lines_left = -1; // reset lines_left at next msg_start()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 reset_last_sourcing();
1302 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1303 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001304 VIM_CLEAR(keep_msg); // don't redisplay message, it's too long
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305
Bram Moolenaar85a20022019-12-21 18:25:54 +01001306 if (tmpState == SETWSIZE) // got resize event while in vgetc()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001308 starttermcap(); // start termcap before redrawing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 shell_resized();
1310 }
1311 else if (!skip_redraw
1312 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1313 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001314 starttermcap(); // start termcap before redrawing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 redraw_later(VALID);
1316 }
1317}
1318
1319/*
1320 * Write the hit-return prompt.
1321 */
1322 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001323hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001325 int save_p_more = p_more;
1326
Bram Moolenaar85a20022019-12-21 18:25:54 +01001327 p_more = FALSE; // don't want see this message when scrolling back
1328 if (msg_didout) // start on a new line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 msg_putchar('\n');
1330 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001331 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332
Bram Moolenaar32526b32019-01-19 17:43:09 +01001333 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 if (!msg_use_printf())
1335 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001336 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337}
1338
1339/*
1340 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1341 */
1342 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001343set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344{
1345 vim_free(keep_msg);
1346 if (s != NULL && msg_silent == 0)
1347 keep_msg = vim_strsave(s);
1348 else
1349 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001350 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001351 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352}
1353
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001354#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1355/*
1356 * If there currently is a message being displayed, set "keep_msg" to it, so
1357 * that it will be displayed again after redraw.
1358 */
1359 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001360set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001361{
1362 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1363 && (State & NORMAL))
1364 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1365}
1366#endif
1367
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368/*
1369 * Prepare for outputting characters in the command line.
1370 */
1371 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001372msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373{
1374 int did_return = FALSE;
1375
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001376 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001377 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001378
1379#ifdef FEAT_EVAL
1380 if (need_clr_eos)
1381 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001382 // Halfway an ":echo" command and getting an (error) message: clear
1383 // any text from the command.
Bram Moolenaara7241f52008-06-24 20:39:31 +00001384 need_clr_eos = FALSE;
1385 msg_clr_eos();
1386 }
1387#endif
1388
Bram Moolenaar85a20022019-12-21 18:25:54 +01001389 if (!msg_scroll && full_screen) // overwrite last message
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 {
1391 msg_row = cmdline_row;
1392 msg_col =
1393#ifdef FEAT_RIGHTLEFT
1394 cmdmsg_rl ? Columns - 1 :
1395#endif
1396 0;
1397 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001398 else if (msg_didout) // start message on next line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 {
1400 msg_putchar('\n');
1401 did_return = TRUE;
1402 if (exmode_active != EXMODE_NORMAL)
1403 cmdline_row = msg_row;
1404 }
1405 if (!msg_didany || lines_left < 0)
1406 msg_starthere();
1407 if (msg_silent == 0)
1408 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001409 msg_didout = FALSE; // no output on current line yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 cursor_off();
1411 }
1412
Bram Moolenaar85a20022019-12-21 18:25:54 +01001413 // when redirecting, may need to start a new line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 if (!did_return)
1415 redir_write((char_u *)"\n", -1);
1416}
1417
1418/*
1419 * Note that the current msg position is where messages start.
1420 */
1421 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001422msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423{
1424 lines_left = cmdline_row;
1425 msg_didany = FALSE;
1426}
1427
1428 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001429msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430{
1431 msg_putchar_attr(c, 0);
1432}
1433
1434 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001435msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001437 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438
1439 if (IS_SPECIAL(c))
1440 {
1441 buf[0] = K_SPECIAL;
1442 buf[1] = K_SECOND(c);
1443 buf[2] = K_THIRD(c);
1444 buf[3] = NUL;
1445 }
1446 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001447 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001448 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449}
1450
1451 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001452msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001454 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455
Bram Moolenaar32526b32019-01-19 17:43:09 +01001456 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 msg_puts(buf);
1458}
1459
1460 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001461msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462{
1463 msg_home_replace_attr(fname, 0);
1464}
1465
1466#if defined(FEAT_FIND_ID) || defined(PROTO)
1467 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001468msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001470 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471}
1472#endif
1473
1474 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001475msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476{
1477 char_u *name;
1478
1479 name = home_replace_save(NULL, fname);
1480 if (name != NULL)
1481 msg_outtrans_attr(name, attr);
1482 vim_free(name);
1483}
1484
1485/*
1486 * Output 'len' characters in 'str' (including NULs) with translation
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001487 * if 'len' is -1, output up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 * Use attributes 'attr'.
1489 * Return the number of characters it takes on the screen.
1490 */
1491 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001492msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493{
1494 return msg_outtrans_attr(str, 0);
1495}
1496
1497 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001498msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499{
1500 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1501}
1502
1503 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001504msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505{
1506 return msg_outtrans_len_attr(str, len, 0);
1507}
1508
1509/*
1510 * Output one character at "p". Return pointer to the next character.
1511 * Handles multi-byte characters.
1512 */
1513 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001514msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 int l;
1517
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001518 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 {
1520 msg_outtrans_len_attr(p, l, attr);
1521 return p + l;
1522 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001523 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 return p + 1;
1525}
1526
1527 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001528msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529{
1530 int retval = 0;
1531 char_u *str = msgstr;
1532 char_u *plain_start = msgstr;
1533 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 int mb_l;
1535 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536
Bram Moolenaar85a20022019-12-21 18:25:54 +01001537 // if MSG_HIST flag set, add message to history
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 if (attr & MSG_HIST)
1539 {
1540 add_msg_hist(str, len, attr);
1541 attr &= ~MSG_HIST;
1542 }
1543
Bram Moolenaar85a20022019-12-21 18:25:54 +01001544 // If the string starts with a composing character first draw a space on
1545 // which the composing char can be drawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001547 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548
1549 /*
1550 * Go over the string. Special characters are translated and printed.
1551 * Normal characters are printed several at a time.
1552 */
1553 while (--len >= 0)
1554 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 if (enc_utf8)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001556 // Don't include composing chars after the end.
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001557 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001559 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 else
1561 mb_l = 1;
1562 if (has_mbyte && mb_l > 1)
1563 {
1564 c = (*mb_ptr2char)(str);
1565 if (vim_isprintc(c))
Bram Moolenaar85a20022019-12-21 18:25:54 +01001566 // printable multi-byte char: count the cells.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 retval += (*mb_ptr2cells)(str);
1568 else
1569 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001570 // unprintable multi-byte char: print the printable chars so
1571 // far and the translation of the unprintable char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001573 msg_puts_attr_len((char *)plain_start,
1574 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001576 msg_puts_attr((char *)transchar(c),
1577 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 retval += char2cells(c);
1579 }
1580 len -= mb_l - 1;
1581 str += mb_l;
1582 }
1583 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 {
1585 s = transchar_byte(*str);
1586 if (s[1] != NUL)
1587 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001588 // unprintable char: print the printable chars so far and the
1589 // translation of the unprintable char.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001591 msg_puts_attr_len((char *)plain_start,
1592 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001594 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001595 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001597 else
1598 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 ++str;
1600 }
1601 }
1602
1603 if (str > plain_start)
Bram Moolenaar85a20022019-12-21 18:25:54 +01001604 // print the printable chars at the end
Bram Moolenaar32526b32019-01-19 17:43:09 +01001605 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606
1607 return retval;
1608}
1609
1610#if defined(FEAT_QUICKFIX) || defined(PROTO)
1611 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001612msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613{
1614 int i;
1615 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1616
1617 arg = skipwhite(arg);
1618 for (i = 5; *arg && i >= 0; --i)
1619 if (*arg++ != str[i])
1620 break;
1621 if (i < 0)
1622 {
1623 msg_putchar('\n');
1624 for (i = 0; rs[i]; ++i)
1625 msg_putchar(rs[i] - 3);
1626 }
1627}
1628#endif
1629
1630/*
Bram Moolenaarf48ee3c2019-12-06 22:18:20 +01001631 * Output the string 'str' up to a NUL character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 * Return the number of characters it takes on the screen.
1633 *
1634 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1635 * following character and shown as <F1>, <S-Up> etc. Any other character
1636 * which is not printable shown in <> form.
1637 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1638 * If a character is displayed in one of these special ways, is also
1639 * highlighted (its highlight name is '8' in the p_hl variable).
1640 * Otherwise characters are not highlighted.
1641 * This function is used to show mappings, where we want to see how to type
1642 * the character/string -- webb
1643 */
1644 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001645msg_outtrans_special(
1646 char_u *strstart,
Bram Moolenaar725310d2019-04-24 23:08:23 +02001647 int from, // TRUE for lhs of a mapping
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001648 int maxlen) // screen columns, 0 for unlimited
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649{
1650 char_u *str = strstart;
1651 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001652 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 int attr;
1654 int len;
1655
Bram Moolenaar8820b482017-03-16 17:23:31 +01001656 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 while (*str != NUL)
1658 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001659 // Leading and trailing spaces need to be displayed in <> form.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 if ((str == strstart || str[1] == NUL) && *str == ' ')
1661 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001662 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 ++str;
1664 }
1665 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001666 text = (char *)str2special(&str, from);
1667 len = vim_strsize((char_u *)text);
Bram Moolenaar725310d2019-04-24 23:08:23 +02001668 if (maxlen > 0 && retval + len >= maxlen)
1669 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001670 // Highlight special keys
Bram Moolenaar32526b32019-01-19 17:43:09 +01001671 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001672 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 retval += len;
1674 }
1675 return retval;
1676}
1677
Bram Moolenaarbd743252010-10-20 21:23:33 +02001678#if defined(FEAT_EVAL) || defined(PROTO)
1679/*
1680 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1681 * strings, in an allocated string.
1682 */
1683 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001684str2special_save(
1685 char_u *str,
Bram Moolenaar85a20022019-12-21 18:25:54 +01001686 int is_lhs) // TRUE for lhs, FALSE for rhs
Bram Moolenaarbd743252010-10-20 21:23:33 +02001687{
1688 garray_T ga;
1689 char_u *p = str;
1690
1691 ga_init2(&ga, 1, 40);
1692 while (*p != NUL)
1693 ga_concat(&ga, str2special(&p, is_lhs));
1694 ga_append(&ga, NUL);
1695 return (char_u *)ga.ga_data;
1696}
1697#endif
1698
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699/*
1700 * Return the printable string for the key codes at "*sp".
1701 * Used for translating the lhs or rhs of a mapping to printable chars.
1702 * Advances "sp" to the next code.
1703 */
1704 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001705str2special(
1706 char_u **sp,
Bram Moolenaar85a20022019-12-21 18:25:54 +01001707 int from) // TRUE for lhs of mapping
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708{
1709 int c;
1710 static char_u buf[7];
1711 char_u *str = *sp;
1712 int modifiers = 0;
1713 int special = FALSE;
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 if (has_mbyte)
1716 {
1717 char_u *p;
1718
Bram Moolenaar85a20022019-12-21 18:25:54 +01001719 // Try to un-escape a multi-byte character. Return the un-escaped
1720 // string if it is a multi-byte character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 p = mb_unescape(sp);
1722 if (p != NULL)
1723 return p;
1724 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725
1726 c = *str;
1727 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1728 {
1729 if (str[1] == KS_MODIFIER)
1730 {
1731 modifiers = str[2];
1732 str += 3;
1733 c = *str;
1734 }
1735 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1736 {
1737 c = TO_SPECIAL(str[1], str[2]);
1738 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001740 if (IS_SPECIAL(c) || modifiers) // special key
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 special = TRUE;
1742 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001744 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001746 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001747
Bram Moolenaar85a20022019-12-21 18:25:54 +01001748 // For multi-byte characters check for an illegal byte.
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001749 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1750 {
1751 transchar_nonprint(buf, c);
1752 *sp = str + 1;
1753 return buf;
1754 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01001755 // Since 'special' is TRUE the multi-byte character 'c' will be
1756 // processed by get_special_key_name()
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001757 c = (*mb_ptr2char)(str);
1758 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001760 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001761 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762
Bram Moolenaar85a20022019-12-21 18:25:54 +01001763 // Make unprintable characters in <> form, also <M-Space> and <Tab>.
1764 // Use <Space> only for lhs of a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 if (special || char2cells(c) > 1 || (from && c == ' '))
1766 return get_special_key_name(c, modifiers);
1767 buf[0] = c;
1768 buf[1] = NUL;
1769 return buf;
1770}
1771
1772/*
1773 * Translate a key sequence into special key names.
1774 */
1775 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001776str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777{
1778 char_u *s;
1779
1780 *buf = NUL;
1781 while (*sp)
1782 {
1783 s = str2special(&sp, FALSE);
1784 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1785 STRCAT(buf, s);
1786 }
1787}
1788
1789/*
1790 * print line for :print or :list command
1791 */
1792 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001793msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794{
1795 int c;
1796 int col = 0;
1797 int n_extra = 0;
1798 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001799 int c_final = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001800 char_u *p_extra = NULL; // init to make SASC shut up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001802 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 int l;
1805 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
Bram Moolenaardf177f62005-02-22 08:39:57 +00001807 if (curwin->w_p_list)
1808 list = TRUE;
1809
Bram Moolenaar85a20022019-12-21 18:25:54 +01001810 // find start of trailing whitespace
Bram Moolenaardf177f62005-02-22 08:39:57 +00001811 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 {
1813 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001814 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 --trail;
1816 }
1817
Bram Moolenaar85a20022019-12-21 18:25:54 +01001818 // output a space for an empty line, otherwise the line will be
1819 // overwritten
Bram Moolenaardf177f62005-02-22 08:39:57 +00001820 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 msg_putchar(' ');
1822
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001823 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001825 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 {
1827 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001828 if (n_extra == 0 && c_final)
1829 c = c_final;
1830 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 c = c_extra;
1832 else
1833 c = *p_extra++;
1834 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001835 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 {
1837 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001838 if (lcs_nbsp != NUL && list
1839 && (mb_ptr2char(s) == 160
1840 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001841 {
1842 mb_char2bytes(lcs_nbsp, buf);
1843 buf[(*mb_ptr2len)(buf)] = NUL;
1844 }
1845 else
1846 {
1847 mch_memmove(buf, s, (size_t)l);
1848 buf[l] = NUL;
1849 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001850 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 s += l;
1852 continue;
1853 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 else
1855 {
1856 attr = 0;
1857 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001858 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001860 // tab amount depends on current column
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001861#ifdef FEAT_VARTABS
1862 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1863 curbuf->b_p_vts_array) - 1;
1864#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001866#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001867 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 {
1869 c = ' ';
1870 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001871 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 }
1873 else
1874 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001875 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001877 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001878 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 }
1880 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001881 else if (c == 160 && list && lcs_nbsp != NUL)
1882 {
1883 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001884 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001885 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001886 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887 {
1888 p_extra = (char_u *)"";
1889 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001890 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 n_extra = 1;
1892 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001893 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 --s;
1895 }
1896 else if (c != NUL && (n = byte2cells(c)) > 1)
1897 {
1898 n_extra = n - 1;
1899 p_extra = transchar_byte(c);
1900 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001901 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 c = *p_extra++;
Bram Moolenaar85a20022019-12-21 18:25:54 +01001903 // Use special coloring to be able to distinguish <hex> from
1904 // the same in plain text.
Bram Moolenaar8820b482017-03-16 17:23:31 +01001905 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 }
1907 else if (c == ' ' && trail != NULL && s > trail)
1908 {
1909 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001910 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001912 else if (c == ' ' && list && lcs_space != NUL)
1913 {
1914 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001915 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001916 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 }
1918
1919 if (c == NUL)
1920 break;
1921
1922 msg_putchar_attr(c, attr);
1923 col++;
1924 }
1925 msg_clr_eos();
1926}
1927
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928/*
1929 * Use screen_puts() to output one multi-byte character.
1930 * Return the pointer "s" advanced to the next character.
1931 */
1932 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001933screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934{
1935 int cw;
1936
Bram Moolenaar85a20022019-12-21 18:25:54 +01001937 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 cw = (*mb_ptr2cells)(s);
1939 if (cw > 1 && (
1940#ifdef FEAT_RIGHTLEFT
1941 cmdmsg_rl ? msg_col <= 1 :
1942#endif
1943 msg_col == Columns - 1))
1944 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01001945 // Doesn't fit, print a highlighted '>' to fill it up.
Bram Moolenaar8820b482017-03-16 17:23:31 +01001946 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 return s;
1948 }
1949
1950 screen_puts_len(s, l, msg_row, msg_col, attr);
1951#ifdef FEAT_RIGHTLEFT
1952 if (cmdmsg_rl)
1953 {
1954 msg_col -= cw;
1955 if (msg_col == 0)
1956 {
1957 msg_col = Columns;
1958 ++msg_row;
1959 }
1960 }
1961 else
1962#endif
1963 {
1964 msg_col += cw;
1965 if (msg_col >= Columns)
1966 {
1967 msg_col = 0;
1968 ++msg_row;
1969 }
1970 }
1971 return s + l;
1972}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973
1974/*
1975 * Output a string to the screen at position msg_row, msg_col.
1976 * Update msg_row and msg_col for the next message.
1977 */
1978 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001979msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001981 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982}
1983
1984 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001985msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001987 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988}
1989
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990/*
1991 * Show a message in such a way that it always fits in the line. Cut out a
1992 * part in the middle and replace it with "..." when necessary.
1993 * Does not handle multi-byte characters!
1994 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001995 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001996msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997{
1998 int slen = len;
1999 int room;
2000
2001 room = Columns - msg_col;
2002 if (len > room && room >= 20)
2003 {
2004 slen = (room - 3) / 2;
2005 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01002006 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 }
2008 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
2009}
2010
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02002011 void
2012msg_outtrans_long_attr(char_u *longstr, int attr)
2013{
2014 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
2015}
2016
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017/*
2018 * Basic function for writing a message with highlight attributes.
2019 */
2020 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01002021msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022{
2023 msg_puts_attr_len(s, -1, attr);
2024}
2025
2026/*
2027 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
2028 * When "maxlen" is -1 there is no maximum length.
2029 * When "maxlen" is >= 0 the message is not put in the history.
2030 */
2031 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01002032msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 /*
2035 * If redirection is on, also write to the redirection file.
2036 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01002037 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038
2039 /*
2040 * Don't print anything when using ":silent cmd".
2041 */
2042 if (msg_silent != 0)
2043 return;
2044
Bram Moolenaar85a20022019-12-21 18:25:54 +01002045 // if MSG_HIST flag set, add message to history
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 if ((attr & MSG_HIST) && maxlen < 0)
2047 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01002048 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 attr &= ~MSG_HIST;
2050 }
2051
Bram Moolenaare8070982019-10-12 17:07:06 +02002052 // When writing something to the screen after it has scrolled, requires a
2053 // wait-return prompt later. Needed when scrolling, resetting
2054 // need_wait_return after some prompt, and then outputting something
2055 // without scrolling
2056 // Not needed when only using CR to move the cursor.
2057 if (msg_scrolled != 0 && !msg_scrolled_ign && STRCMP(str, "\r") != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 need_wait_return = TRUE;
Bram Moolenaare8070982019-10-12 17:07:06 +02002059 msg_didany = TRUE; // remember that something was outputted
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060
2061 /*
2062 * If there is no valid screen, use fprintf so we can see error messages.
2063 * If termcap is not active, we may be writing in an alternate console
2064 * window, cursor positioning may not work correctly (window size may be
2065 * different, e.g. for Win32 console) or we just don't know where the
2066 * cursor is.
2067 */
2068 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002069 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002070 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002071 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002072}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002074/*
2075 * The display part of msg_puts_attr_len().
2076 * May be called recursively to display scroll-back text.
2077 */
2078 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002079msg_puts_display(
2080 char_u *str,
2081 int maxlen,
2082 int attr,
2083 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002084{
2085 char_u *s = str;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002086 char_u *t_s = str; // string from "t_s" to "s" is still todo
2087 int t_col = 0; // screen cells todo, 0 when "t_s" not used
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 int l;
2089 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002090 char_u *sb_str = str;
2091 int sb_col = msg_col;
2092 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002093 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094
2095 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002096 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 {
2098 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002099 * We are at the end of the screen line when:
2100 * - When outputting a newline.
2101 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002103 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104#ifdef FEAT_RIGHTLEFT
2105 cmdmsg_rl
2106 ? (
2107 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002108 || (*s == TAB && msg_col <= 7)
2109 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 :
2111#endif
Bram Moolenaar0efd1bd2019-12-11 19:00:04 +01002112 ((*s != '\r' && msg_col + t_col >= Columns - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002115 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002117 /*
2118 * The screen is scrolled up when at the last row (some terminals
2119 * scroll automatically, some don't. To avoid problems we scroll
2120 * ourselves).
2121 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 if (t_col > 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002123 // output postponed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002124 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125
Bram Moolenaar85a20022019-12-21 18:25:54 +01002126 // When no more prompt and no more room, truncate here
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 if (msg_no_more && lines_left == 0)
2128 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129
Bram Moolenaar85a20022019-12-21 18:25:54 +01002130 // Scroll the screen up one line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002131 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132
2133 msg_row = Rows - 2;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002134 if (msg_col >= Columns) // can happen after screen resize
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 msg_col = Columns - 1;
2136
Bram Moolenaar85a20022019-12-21 18:25:54 +01002137 // Display char in last column before showing more-prompt.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002138 if (*s >= ' '
2139#ifdef FEAT_RIGHTLEFT
2140 && !cmdmsg_rl
2141#endif
2142 )
2143 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002144 if (has_mbyte)
2145 {
2146 if (enc_utf8 && maxlen >= 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002147 // avoid including composing chars after the end
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002148 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002149 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002150 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002151 s = screen_puts_mbyte(s, l, attr);
2152 }
2153 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002154 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002155 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002156 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002157 else
2158 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002159
2160 if (p_more)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002161 // store text for scrolling back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002162 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2163
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002164 inc_msg_scrolled();
Bram Moolenaar85a20022019-12-21 18:25:54 +01002165 need_wait_return = TRUE; // may need wait_return in main()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 redraw_cmdline = TRUE;
2167 if (cmdline_row > 0 && !exmode_active)
2168 --cmdline_row;
2169
2170 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002171 * If screen is completely filled and 'more' is set then wait
2172 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002174 if (lines_left > 0)
2175 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002176 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 && !msg_no_more && !exmode_active)
2178 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002180 if (do_more_prompt(NUL))
2181 s = confirm_msg_tail;
2182#else
2183 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184#endif
2185 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002186 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002188
Bram Moolenaar85a20022019-12-21 18:25:54 +01002189 // When we displayed a char in last column need to check if there
2190 // is still more.
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002191 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002192 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 }
2194
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002195 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002198 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002199 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2200 || *s == '\t' || *s == BELL))
Bram Moolenaar85a20022019-12-21 18:25:54 +01002201 // output any postponed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002202 t_puts(&t_col, t_s, s, attr);
2203
2204 if (wrap && p_more && !recurse)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002205 // store text for scrolling back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002206 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207
Bram Moolenaar85a20022019-12-21 18:25:54 +01002208 if (*s == '\n') // go to next line
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002210 msg_didout = FALSE; // remember that line is empty
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002211#ifdef FEAT_RIGHTLEFT
2212 if (cmdmsg_rl)
2213 msg_col = Columns - 1;
2214 else
2215#endif
2216 msg_col = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002217 if (++msg_row >= Rows) // safety check
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 msg_row = Rows - 1;
2219 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002220 else if (*s == '\r') // go to column 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 {
2222 msg_col = 0;
2223 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002224 else if (*s == '\b') // go to previous char
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 {
2226 if (msg_col)
2227 --msg_col;
2228 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002229 else if (*s == TAB) // translate Tab into spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 {
2231 do
2232 msg_screen_putchar(' ', attr);
2233 while (msg_col & 7);
2234 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002235 else if (*s == BELL) // beep (from ":sh")
Bram Moolenaar165bc692015-07-21 17:53:25 +02002236 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 else
2238 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 if (has_mbyte)
2240 {
2241 cw = (*mb_ptr2cells)(s);
2242 if (enc_utf8 && maxlen >= 0)
Bram Moolenaar85a20022019-12-21 18:25:54 +01002243 // avoid including composing chars after the end
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002244 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002246 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 }
2248 else
2249 {
2250 cw = 1;
2251 l = 1;
2252 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002253
Bram Moolenaar85a20022019-12-21 18:25:54 +01002254 // When drawing from right to left or when a double-wide character
2255 // doesn't fit, draw a single character here. Otherwise collect
2256 // characters and draw them all at once later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 if (
2258# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002259 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002261 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 if (l > 1)
2264 s = screen_puts_mbyte(s, l, attr) - 1;
2265 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 msg_screen_putchar(*s, attr);
2267 }
2268 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002270 // postpone this character until later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 if (t_col == 0)
2272 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 t_col += cw;
2274 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 }
2276 }
2277 ++s;
2278 }
2279
Bram Moolenaar85a20022019-12-21 18:25:54 +01002280 // output any postponed text
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002282 t_puts(&t_col, t_s, s, attr);
2283 if (p_more && !recurse)
2284 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285
2286 msg_check();
2287}
2288
2289/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002290 * Return TRUE when ":filter pattern" was used and "msg" does not match
2291 * "pattern".
2292 */
2293 int
2294message_filtered(char_u *msg)
2295{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002296 int match;
2297
2298 if (cmdmod.filter_regmatch.regprog == NULL)
2299 return FALSE;
2300 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2301 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002302}
2303
2304/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002305 * Scroll the screen up one line for displaying the next message line.
2306 */
2307 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002308msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002309{
2310#ifdef FEAT_GUI
Bram Moolenaar85a20022019-12-21 18:25:54 +01002311 // Remove the cursor before scrolling, ScreenLines[] is going
2312 // to become invalid.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002313 if (gui.in_use)
2314 gui_undraw_cursor();
2315#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002316 // scrolling up always works
Bram Moolenaara338adc2018-01-31 20:51:47 +01002317 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002318 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002319 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002320
2321 if (!can_clear((char_u *)" "))
2322 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002323 // Scrolling up doesn't result in the right background. Set the
2324 // background here. It's not efficient, but avoids that we have to do
2325 // it all over the code.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002326 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2327
Bram Moolenaar85a20022019-12-21 18:25:54 +01002328 // Also clear the last char of the last but one line if it was not
2329 // cleared before to avoid a scroll-up.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002330 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2331 screen_fill((int)Rows - 2, (int)Rows - 1,
2332 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2333 }
2334}
2335
2336/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002337 * Increment "msg_scrolled".
2338 */
2339 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002340inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002341{
2342#ifdef FEAT_EVAL
2343 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2344 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002345 char_u *p = SOURCING_NAME;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002346 char_u *tofree = NULL;
2347 int len;
2348
Bram Moolenaar85a20022019-12-21 18:25:54 +01002349 // v:scrollstart is empty, set it to the script/function name and line
2350 // number
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002351 if (p == NULL)
2352 p = (char_u *)_("Unknown");
2353 else
2354 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002355 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002356 tofree = alloc(len);
2357 if (tofree != NULL)
2358 {
2359 vim_snprintf((char *)tofree, len, _("%s line %ld"),
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002360 p, (long)SOURCING_LNUM);
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002361 p = tofree;
2362 }
2363 }
2364 set_vim_var_string(VV_SCROLLSTART, p, -1);
2365 vim_free(tofree);
2366 }
2367#endif
2368 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002369 if (must_redraw < VALID)
2370 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002371}
2372
2373/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002374 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2375 * store the displayed text and remember where screen lines start.
2376 */
2377typedef struct msgchunk_S msgchunk_T;
2378struct msgchunk_S
2379{
2380 msgchunk_T *sb_next;
2381 msgchunk_T *sb_prev;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002382 char sb_eol; // TRUE when line ends after this text
2383 int sb_msg_col; // column in which text starts
2384 int sb_attr; // text attributes
2385 char_u sb_text[1]; // text to be displayed, actually longer
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002386};
2387
Bram Moolenaar85a20022019-12-21 18:25:54 +01002388static msgchunk_T *last_msgchunk = NULL; // last displayed text
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002389
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002390static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002391
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002392typedef enum {
2393 SB_CLEAR_NONE = 0,
2394 SB_CLEAR_ALL,
2395 SB_CLEAR_CMDLINE_BUSY,
2396 SB_CLEAR_CMDLINE_DONE
2397} sb_clear_T;
2398
Bram Moolenaar85a20022019-12-21 18:25:54 +01002399// When to clear text on next msg.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002400static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002401
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002402/*
2403 * Store part of a printed message for displaying when scrolling back.
2404 */
2405 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002406store_sb_text(
Bram Moolenaar85a20022019-12-21 18:25:54 +01002407 char_u **sb_str, // start of string
2408 char_u *s, // just after string
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002409 int attr,
2410 int *sb_col,
Bram Moolenaar85a20022019-12-21 18:25:54 +01002411 int finish) // line ends
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002412{
2413 msgchunk_T *mp;
2414
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002415 if (do_clear_sb_text == SB_CLEAR_ALL
2416 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002417 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002418 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2419 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002420 }
2421
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002422 if (s > *sb_str)
2423 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002424 mp = alloc(sizeof(msgchunk_T) + (s - *sb_str));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002425 if (mp != NULL)
2426 {
2427 mp->sb_eol = finish;
2428 mp->sb_msg_col = *sb_col;
2429 mp->sb_attr = attr;
2430 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2431
2432 if (last_msgchunk == NULL)
2433 {
2434 last_msgchunk = mp;
2435 mp->sb_prev = NULL;
2436 }
2437 else
2438 {
2439 mp->sb_prev = last_msgchunk;
2440 last_msgchunk->sb_next = mp;
2441 last_msgchunk = mp;
2442 }
2443 mp->sb_next = NULL;
2444 }
2445 }
2446 else if (finish && last_msgchunk != NULL)
2447 last_msgchunk->sb_eol = TRUE;
2448
2449 *sb_str = s;
2450 *sb_col = 0;
2451}
2452
2453/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002454 * Finished showing messages, clear the scroll-back text on the next message.
2455 */
2456 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002457may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002459 do_clear_sb_text = SB_CLEAR_ALL;
2460}
2461
2462/*
2463 * Starting to edit the command line, do not clear messages now.
2464 */
2465 void
2466sb_text_start_cmdline(void)
2467{
2468 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2469 msg_sb_eol();
2470}
2471
2472/*
2473 * Ending to edit the command line. Clear old lines but the last one later.
2474 */
2475 void
2476sb_text_end_cmdline(void)
2477{
2478 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002479}
2480
2481/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002482 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002483 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002484 * Called when redrawing the screen.
2485 */
2486 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002487clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002488{
2489 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002490 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002491
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002492 if (all)
2493 lastp = &last_msgchunk;
2494 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002495 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002496 if (last_msgchunk == NULL)
2497 return;
2498 lastp = &last_msgchunk->sb_prev;
2499 }
2500
2501 while (*lastp != NULL)
2502 {
2503 mp = (*lastp)->sb_prev;
2504 vim_free(*lastp);
2505 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002506 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002507}
2508
2509/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002510 * "g<" command.
2511 */
2512 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002513show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002514{
2515 msgchunk_T *mp;
2516
Bram Moolenaar85a20022019-12-21 18:25:54 +01002517 // Only show something if there is more than one line, otherwise it looks
2518 // weird, typing a command without output results in one line.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002519 mp = msg_sb_start(last_msgchunk);
2520 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002521 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002522 else
2523 {
2524 do_more_prompt('G');
2525 wait_return(FALSE);
2526 }
2527}
2528
2529/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002530 * Move to the start of screen line in already displayed text.
2531 */
2532 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002533msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002534{
2535 msgchunk_T *mp = mps;
2536
2537 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2538 mp = mp->sb_prev;
2539 return mp;
2540}
2541
2542/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002543 * Mark the last message chunk as finishing the line.
2544 */
2545 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002546msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002547{
2548 if (last_msgchunk != NULL)
2549 last_msgchunk->sb_eol = TRUE;
2550}
2551
2552/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002553 * Display a screen line from previously displayed text at row "row".
2554 * Returns a pointer to the text for the next line (can be NULL).
2555 */
2556 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002557disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002558{
2559 msgchunk_T *mp = smp;
2560 char_u *p;
2561
2562 for (;;)
2563 {
2564 msg_row = row;
2565 msg_col = mp->sb_msg_col;
2566 p = mp->sb_text;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002567 if (*p == '\n') // don't display the line break
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002568 ++p;
2569 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2570 if (mp->sb_eol || mp->sb_next == NULL)
2571 break;
2572 mp = mp->sb_next;
2573 }
2574 return mp->sb_next;
2575}
2576
2577/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 * Output any postponed text for msg_puts_attr_len().
2579 */
2580 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002581t_puts(
2582 int *t_col,
2583 char_u *t_s,
2584 char_u *s,
2585 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586{
Bram Moolenaar85a20022019-12-21 18:25:54 +01002587 // output postponed text
2588 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002590 msg_col += *t_col;
2591 *t_col = 0;
Bram Moolenaar85a20022019-12-21 18:25:54 +01002592 // If the string starts with a composing character don't increment the
2593 // column position for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2595 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 if (msg_col >= Columns)
2597 {
2598 msg_col = 0;
2599 ++msg_row;
2600 }
2601}
2602
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603/*
2604 * Returns TRUE when messages should be printed with mch_errmsg().
2605 * This is used when there is no valid screen, so we can see error messages.
2606 * If termcap is not active, we may be writing in an alternate console
2607 * window, cursor positioning may not work correctly (window size may be
2608 * different, e.g. for Win32 console) or we just don't know where the
2609 * cursor is.
2610 */
2611 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002612msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613{
2614 return (!msg_check_screen()
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002615#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2616# ifdef VIMDLL
2617 || (!gui.in_use && !termcap_active)
2618# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 || !termcap_active
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002620# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621#endif
2622 || (swapping_screen() && !termcap_active)
2623 );
2624}
2625
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002626/*
2627 * Print a message when there is no valid screen.
2628 */
2629 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002630msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002631{
2632 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002633 char_u *buf = NULL;
2634 char_u *p = s;
2635
Bram Moolenaar4f974752019-02-17 17:44:42 +01002636#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002637 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar85a20022019-12-21 18:25:54 +01002638 mch_settmode(TMODE_COOK); // handle CR and NL correctly
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002640 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002641 {
2642 if (!(silent_mode && p_verbose == 0))
2643 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002644 // NL --> CR NL translation (for Unix, not for "--version")
2645 if (*s == NL)
2646 {
2647 int n = (int)(s - p);
2648
2649 buf = alloc(n + 3);
Bram Moolenaar6f10c702019-08-20 22:58:37 +02002650 if (buf != NULL)
2651 {
2652 memcpy(buf, p, n);
2653 if (!info_message)
2654 buf[n++] = CAR;
2655 buf[n++] = NL;
2656 buf[n++] = NUL;
2657 if (info_message) // informative message, not an error
2658 mch_msg((char *)buf);
2659 else
2660 mch_errmsg((char *)buf);
2661 vim_free(buf);
2662 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002663 p = s + 1;
2664 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002665 }
2666
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002667 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002668#ifdef FEAT_RIGHTLEFT
2669 if (cmdmsg_rl)
2670 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002671 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002672 msg_col = Columns - 1;
2673 else
2674 --msg_col;
2675 }
2676 else
2677#endif
2678 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002679 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002680 msg_col = 0;
2681 else
2682 ++msg_col;
2683 }
2684 ++s;
2685 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002686
2687 if (*p != NUL && !(silent_mode && p_verbose == 0))
2688 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002689 int c = -1;
2690
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002691 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002692 {
2693 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002694 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002695 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002696 if (info_message)
2697 mch_msg((char *)p);
2698 else
2699 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002700 if (c != -1)
2701 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002702 }
2703
2704 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002705
Bram Moolenaar4f974752019-02-17 17:44:42 +01002706#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002707 if (!(silent_mode && p_verbose == 0))
2708 mch_settmode(TMODE_RAW);
2709#endif
2710}
2711
2712/*
2713 * Show the more-prompt and handle the user response.
2714 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002715 * When at hit-enter prompt "typed_char" is the already typed character,
2716 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002717 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2718 */
2719 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002720do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002721{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002722 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002723 int used_typed_char = typed_char;
2724 int oldState = State;
2725 int c;
2726#ifdef FEAT_CON_DIALOG
2727 int retval = FALSE;
2728#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002729 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002730 msgchunk_T *mp_last = NULL;
2731 msgchunk_T *mp;
2732 int i;
2733
Bram Moolenaar85a20022019-12-21 18:25:54 +01002734 // We get called recursively when a timer callback outputs a message. In
2735 // that case don't show another prompt. Also when at the hit-Enter prompt
2736 // and nothing was typed.
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002737 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002738 return FALSE;
2739 entered = TRUE;
2740
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002741 if (typed_char == 'G')
2742 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002743 // "g<": Find first line on the last page.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002744 mp_last = msg_sb_start(last_msgchunk);
2745 for (i = 0; i < Rows - 2 && mp_last != NULL
2746 && mp_last->sb_prev != NULL; ++i)
2747 mp_last = msg_sb_start(mp_last->sb_prev);
2748 }
2749
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002750 State = ASKMORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002751 setmouse();
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002752 if (typed_char == NUL)
2753 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002754 for (;;)
2755 {
2756 /*
2757 * Get a typed character directly from the user.
2758 */
2759 if (used_typed_char != NUL)
2760 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002761 c = used_typed_char; // was typed at hit-enter prompt
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002762 used_typed_char = NUL;
2763 }
2764 else
2765 c = get_keystroke();
2766
2767#if defined(FEAT_MENU) && defined(FEAT_GUI)
2768 if (c == K_MENU)
2769 {
2770 int idx = get_menu_index(current_menu, ASKMORE);
2771
Bram Moolenaar85a20022019-12-21 18:25:54 +01002772 // Used a menu. If it starts with CTRL-Y, it must
2773 // be a "Copy" for the clipboard. Otherwise
2774 // assume that we end
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002775 if (idx == MENU_INDEX_INVALID)
2776 continue;
2777 c = *current_menu->strings[idx];
2778 if (c != NUL && current_menu->strings[idx][1] != NUL)
2779 ins_typebuf(current_menu->strings[idx] + 1,
2780 current_menu->noremap[idx], 0, TRUE,
2781 current_menu->silent[idx]);
2782 }
2783#endif
2784
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002785 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002786 switch (c)
2787 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002788 case BS: // scroll one line back
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002789 case K_BS:
2790 case 'k':
2791 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002792 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002793 break;
2794
Bram Moolenaar85a20022019-12-21 18:25:54 +01002795 case CAR: // one extra line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002796 case NL:
2797 case 'j':
2798 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002799 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002800 break;
2801
Bram Moolenaar85a20022019-12-21 18:25:54 +01002802 case 'u': // Up half a page
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002803 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002804 break;
2805
Bram Moolenaar85a20022019-12-21 18:25:54 +01002806 case 'd': // Down half a page
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002807 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002808 break;
2809
Bram Moolenaar85a20022019-12-21 18:25:54 +01002810 case 'b': // one page back
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002811 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002812 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002813 break;
2814
Bram Moolenaar85a20022019-12-21 18:25:54 +01002815 case ' ': // one extra page
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002816 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002817 case K_PAGEDOWN:
2818 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002819 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002820 break;
2821
Bram Moolenaar85a20022019-12-21 18:25:54 +01002822 case 'g': // all the way back to the start
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002823 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002824 break;
2825
Bram Moolenaar85a20022019-12-21 18:25:54 +01002826 case 'G': // all the way to the end
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002827 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002828 lines_left = 999999;
2829 break;
2830
Bram Moolenaar85a20022019-12-21 18:25:54 +01002831 case ':': // start new command line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002832#ifdef FEAT_CON_DIALOG
2833 if (!confirm_msg_used)
2834#endif
2835 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002836 // Since got_int is set all typeahead will be flushed, but we
2837 // want to keep this ':', remember that in a special way.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002838 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002839#ifdef FEAT_TERMINAL
2840 skip_term_loop = TRUE;
2841#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002842 cmdline_row = Rows - 1; // put ':' on this line
2843 skip_redraw = TRUE; // skip redraw once
2844 need_wait_return = FALSE; // don't wait in main()
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002845 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002846 // FALLTHROUGH
2847 case 'q': // quit
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002848 case Ctrl_C:
2849 case ESC:
2850#ifdef FEAT_CON_DIALOG
2851 if (confirm_msg_used)
2852 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002853 // Jump to the choices of the dialog.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002854 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002855 }
2856 else
2857#endif
2858 {
2859 got_int = TRUE;
2860 quit_more = TRUE;
2861 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01002862 // When there is some more output (wrapping line) display that
2863 // without another prompt.
Bram Moolenaar51306d22009-02-24 03:38:04 +00002864 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002865 break;
2866
2867#ifdef FEAT_CLIPBOARD
2868 case Ctrl_Y:
Bram Moolenaar85a20022019-12-21 18:25:54 +01002869 // Strange way to allow copying (yanking) a modeless
2870 // selection at the more prompt. Use CTRL-Y,
2871 // because the same is used in Cmdline-mode and at the
2872 // hit-enter prompt. However, scrolling one line up
2873 // might be expected...
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002874 if (clip_star.state == SELECT_DONE)
2875 clip_copy_modeless_selection(TRUE);
2876 continue;
2877#endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01002878 default: // no valid response
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002879 msg_moremsg(TRUE);
2880 continue;
2881 }
2882
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002883 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002884 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002885 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002886 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002887 // go to start of last line
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002888 if (mp_last == NULL)
2889 mp = msg_sb_start(last_msgchunk);
2890 else if (mp_last->sb_prev != NULL)
2891 mp = msg_sb_start(mp_last->sb_prev);
2892 else
2893 mp = NULL;
2894
Bram Moolenaar85a20022019-12-21 18:25:54 +01002895 // go to start of line at top of the screen
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002896 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2897 ++i)
2898 mp = msg_sb_start(mp->sb_prev);
2899
2900 if (mp != NULL && mp->sb_prev != NULL)
2901 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002902 // Find line to be displayed at top.
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002903 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002904 {
2905 if (mp == NULL || mp->sb_prev == NULL)
2906 break;
2907 mp = msg_sb_start(mp->sb_prev);
2908 if (mp_last == NULL)
2909 mp_last = msg_sb_start(last_msgchunk);
2910 else
2911 mp_last = msg_sb_start(mp_last->sb_prev);
2912 }
2913
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002914 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002915 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002916 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002917 // display line at top
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002918 (void)disp_sb_line(0, mp);
2919 }
2920 else
2921 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002922 // redisplay all lines
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002923 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002924 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2925 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002926 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002927 ++msg_scrolled;
2928 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002929 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002930 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002931 }
2932 }
2933 else
2934 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002935 // First display any text that we scrolled back.
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002936 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002937 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002938 // scroll up, display line at bottom
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002939 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002940 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002941 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2942 (int)Columns, ' ', ' ', 0);
2943 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002944 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002945 }
2946 }
2947
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002948 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002949 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01002950 // displayed the requested text, more prompt again
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002951 screen_fill((int)Rows - 1, (int)Rows, 0,
2952 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002953 msg_moremsg(FALSE);
2954 continue;
2955 }
2956
Bram Moolenaar85a20022019-12-21 18:25:54 +01002957 // display more text, return to caller
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002958 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002959 }
2960
2961 break;
2962 }
2963
Bram Moolenaar85a20022019-12-21 18:25:54 +01002964 // clear the --more-- message
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002965 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2966 State = oldState;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002967 setmouse();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002968 if (quit_more)
2969 {
2970 msg_row = Rows - 1;
2971 msg_col = 0;
2972 }
2973#ifdef FEAT_RIGHTLEFT
2974 else if (cmdmsg_rl)
2975 msg_col = Columns - 1;
2976#endif
2977
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002978 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002979#ifdef FEAT_CON_DIALOG
2980 return retval;
2981#else
2982 return FALSE;
2983#endif
2984}
2985
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2987
2988#ifdef mch_errmsg
2989# undef mch_errmsg
2990#endif
2991#ifdef mch_msg
2992# undef mch_msg
2993#endif
2994
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002995#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2996 static void
2997mch_errmsg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002999 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003000 DWORD nwrite = 0;
3001 DWORD mode = 0;
3002 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
3003
3004 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3005 && (int)GetConsoleCP() != enc_codepage)
3006 {
3007 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3008
3009 WriteConsoleW(h, w, len, &nwrite, NULL);
3010 vim_free(w);
3011 }
3012 else
3013 {
3014 fprintf(stderr, "%s", str);
3015 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003016}
3017#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003019/*
3020 * Give an error message. To be used when the screen hasn't been initialized
3021 * yet. When stderr can't be used, collect error messages until the GUI has
3022 * started and they can be displayed in a message box.
3023 */
3024 void
3025mch_errmsg(char *str)
3026{
3027#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
3028 int len;
3029#endif
3030
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003031#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003032 // On Unix use stderr if it's a tty.
3033 // When not going to start the GUI also use stderr.
3034 // On Mac, when started from Finder, stderr is the console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003036# ifdef UNIX
3037# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003039# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 isatty(2)
3041# endif
3042# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003043 ||
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003044# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003045# endif
3046# ifdef FEAT_GUI
3047 !(gui.in_use || gui.starting)
3048# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 )
3050 {
3051 fprintf(stderr, "%s", str);
3052 return;
3053 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003054#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003056#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3057# ifdef VIMDLL
3058 if (!(gui.in_use || gui.starting))
3059# endif
3060 {
3061 mch_errmsg_c(str);
3062 return;
3063 }
3064#endif
3065
3066#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003067 // avoid a delay for a message that isn't there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 emsg_on_display = FALSE;
3069
3070 len = (int)STRLEN(str) + 1;
3071 if (error_ga.ga_growsize == 0)
3072 {
3073 error_ga.ga_growsize = 80;
3074 error_ga.ga_itemsize = 1;
3075 }
3076 if (ga_grow(&error_ga, len) == OK)
3077 {
3078 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3079 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003080# ifdef UNIX
Bram Moolenaar85a20022019-12-21 18:25:54 +01003081 // remove CR characters, they are displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 {
3083 char_u *p;
3084
3085 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3086 for (;;)
3087 {
3088 p = vim_strchr(p, '\r');
3089 if (p == NULL)
3090 break;
3091 *p = ' ';
3092 }
3093 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003094# endif
Bram Moolenaar85a20022019-12-21 18:25:54 +01003095 --len; // don't count the NUL at the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003098#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099}
3100
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003101#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3102 static void
3103mch_msg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003105 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003106 DWORD nwrite = 0;
3107 DWORD mode;
3108 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3109
3110
3111 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3112 && (int)GetConsoleCP() != enc_codepage)
3113 {
3114 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3115
3116 WriteConsoleW(h, w, len, &nwrite, NULL);
3117 vim_free(w);
3118 }
3119 else
3120 {
3121 printf("%s", str);
3122 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003123}
3124#endif
3125
3126/*
3127 * Give a message. To be used when the screen hasn't been initialized yet.
3128 * When there is no tty, collect messages until the GUI has started and they
3129 * can be displayed in a message box.
3130 */
3131 void
3132mch_msg(char *str)
3133{
Bram Moolenaar0b75f7c2019-05-08 22:28:46 +02003134#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) && !defined(VIMDLL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003135 // On Unix use stdout if we have a tty. This allows "vim -h | more" and
3136 // uses mch_errmsg() when started from the desktop.
3137 // When not going to start the GUI also use stdout.
3138 // On Mac, when started from Finder, stderr is the console.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003140# ifdef UNIX
3141# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003143# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 isatty(2)
Bram Moolenaareae1b912019-05-09 15:12:55 +02003145# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003147 ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003149# endif
3150# ifdef FEAT_GUI
3151 !(gui.in_use || gui.starting)
3152# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 )
3154 {
3155 printf("%s", str);
3156 return;
3157 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003158#endif
3159
3160#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3161# ifdef VIMDLL
3162 if (!(gui.in_use || gui.starting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003164 {
3165 mch_msg_c(str);
3166 return;
3167 }
3168#endif
3169#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003171#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172}
Bram Moolenaar85a20022019-12-21 18:25:54 +01003173#endif // USE_MCH_ERRMSG
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174
3175/*
3176 * Put a character on the screen at the current message position and advance
3177 * to the next position. Only for printable ASCII!
3178 */
3179 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003180msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003182 msg_didout = TRUE; // remember that line is not empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 screen_putchar(c, msg_row, msg_col, attr);
3184#ifdef FEAT_RIGHTLEFT
3185 if (cmdmsg_rl)
3186 {
3187 if (--msg_col == 0)
3188 {
3189 msg_col = Columns;
3190 ++msg_row;
3191 }
3192 }
3193 else
3194#endif
3195 {
3196 if (++msg_col >= Columns)
3197 {
3198 msg_col = 0;
3199 ++msg_row;
3200 }
3201 }
3202}
3203
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003204 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003205msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003207 int attr;
3208 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209
Bram Moolenaar8820b482017-03-16 17:23:31 +01003210 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003211 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003213 screen_puts((char_u *)
3214 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3215 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216}
3217
3218/*
3219 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3220 * exmode_active.
3221 */
3222 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003223repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224{
3225 if (State == ASKMORE)
3226 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003227 msg_moremsg(TRUE); // display --more-- message again
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 msg_row = Rows - 1;
3229 }
3230#ifdef FEAT_CON_DIALOG
3231 else if (State == CONFIRM)
3232 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003233 display_confirm_msg(); // display ":confirm" message again
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 msg_row = Rows - 1;
3235 }
3236#endif
3237 else if (State == EXTERNCMD)
3238 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003239 windgoto(msg_row, msg_col); // put cursor back
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 }
3241 else if (State == HITRETURN || State == SETWSIZE)
3242 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003243 if (msg_row == Rows - 1)
3244 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003245 // Avoid drawing the "hit-enter" prompt below the previous one,
3246 // overwrite it. Esp. useful when regaining focus and a
3247 // FocusGained autocmd exists but didn't draw anything.
Bram Moolenaar9f108752007-11-24 14:44:58 +00003248 msg_didout = FALSE;
3249 msg_col = 0;
3250 msg_clr_eos();
3251 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 hit_return_msg();
3253 msg_row = Rows - 1;
3254 }
3255}
3256
3257/*
3258 * msg_check_screen - check if the screen is initialized.
3259 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3260 * While starting the GUI the terminal codes will be set for the GUI, but the
3261 * output goes to the terminal. Don't use the terminal codes then.
3262 */
3263 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003264msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265{
3266 if (!full_screen || !screen_valid(FALSE))
3267 return FALSE;
3268
3269 if (msg_row >= Rows)
3270 msg_row = Rows - 1;
3271 if (msg_col >= Columns)
3272 msg_col = Columns - 1;
3273 return TRUE;
3274}
3275
3276/*
3277 * Clear from current message position to end of screen.
3278 * Skip this when ":silent" was used, no need to clear for redirection.
3279 */
3280 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003281msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282{
3283 if (msg_silent == 0)
3284 msg_clr_eos_force();
3285}
3286
3287/*
3288 * Clear from current message position to end of screen.
3289 * Note: msg_col is not updated, so we remember the end of the message
3290 * for msg_check().
3291 */
3292 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003293msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294{
3295 if (msg_use_printf())
3296 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003297 if (full_screen) // only when termcap codes are valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 {
3299 if (*T_CD)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003300 out_str(T_CD); // clear to end of display
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 else if (*T_CE)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003302 out_str(T_CE); // clear to end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 }
3304 }
3305 else
3306 {
3307#ifdef FEAT_RIGHTLEFT
3308 if (cmdmsg_rl)
3309 {
3310 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3311 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3312 }
3313 else
3314#endif
3315 {
3316 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3317 ' ', ' ', 0);
3318 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3319 }
3320 }
3321}
3322
3323/*
3324 * Clear the command line.
3325 */
3326 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003327msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328{
3329 msg_row = cmdline_row;
3330 msg_col = 0;
3331 msg_clr_eos_force();
3332}
3333
3334/*
3335 * end putting a message on the screen
3336 * call wait_return if the message does not fit in the available space
3337 * return TRUE if wait_return not called.
3338 */
3339 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003340msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341{
3342 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003343 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 * or the ruler option is set and we run into it,
3345 * we have to redraw the window.
3346 * Do not do this if we are abandoning the file or editing the command line.
3347 */
3348 if (!exiting && need_wait_return && !(State & CMDLINE))
3349 {
3350 wait_return(FALSE);
3351 return FALSE;
3352 }
3353 out_flush();
3354 return TRUE;
3355}
3356
3357/*
3358 * If the written message runs into the shown command or ruler, we have to
3359 * wait for hit-return and redraw the window later.
3360 */
3361 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003362msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363{
3364 if (msg_row == Rows - 1 && msg_col >= sc_col)
3365 {
3366 need_wait_return = TRUE;
3367 redraw_cmdline = TRUE;
3368 }
3369}
3370
3371/*
3372 * May write a string to the redirection file.
3373 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3374 */
3375 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003376redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377{
3378 char_u *s = str;
3379 static int cur_col = 0;
3380
Bram Moolenaar85a20022019-12-21 18:25:54 +01003381 // Don't do anything for displaying prompts and the like.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003382 if (redir_off)
3383 return;
3384
Bram Moolenaar85a20022019-12-21 18:25:54 +01003385 // If 'verbosefile' is set prepare for writing in that file.
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003386 if (*p_vfile != NUL && verbose_fd == NULL)
3387 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003388
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003389 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003391 // If the string doesn't start with CR or NL, go to msg_col
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 if (*s != '\n' && *s != '\r')
3393 {
3394 while (cur_col < msg_col)
3395 {
3396#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003397 if (redir_execute)
3398 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003399 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003401 else if (redir_vname)
3402 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003403 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003405 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003407 if (verbose_fd != NULL)
3408 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 ++cur_col;
3410 }
3411 }
3412
3413#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003414 if (redir_execute)
3415 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003416 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003418 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003419 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420#endif
3421
Bram Moolenaar85a20022019-12-21 18:25:54 +01003422 // Write and adjust the current column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3424 {
3425#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003426 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003428 if (redir_fd != NULL)
3429 putc(*s, redir_fd);
3430 if (verbose_fd != NULL)
3431 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 if (*s == '\r' || *s == '\n')
3433 cur_col = 0;
3434 else if (*s == '\t')
3435 cur_col += (8 - cur_col % 8);
3436 else
3437 ++cur_col;
3438 ++s;
3439 }
3440
Bram Moolenaar85a20022019-12-21 18:25:54 +01003441 if (msg_silent != 0) // should update msg_col
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 msg_col = cur_col;
3443 }
3444}
3445
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003446 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003447redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003448{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003449 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003450#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003451 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003452#endif
3453 ;
3454}
3455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003457 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003458 * Must always be called paired with verbose_leave()!
3459 */
3460 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003461verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003462{
3463 if (*p_vfile != NUL)
3464 ++msg_silent;
3465}
3466
3467/*
3468 * After giving verbose message.
3469 * Must always be called paired with verbose_enter()!
3470 */
3471 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003472verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003473{
3474 if (*p_vfile != NUL)
3475 if (--msg_silent < 0)
3476 msg_silent = 0;
3477}
3478
3479/*
3480 * Like verbose_enter() and set msg_scroll when displaying the message.
3481 */
3482 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003483verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003484{
3485 if (*p_vfile != NUL)
3486 ++msg_silent;
3487 else
Bram Moolenaar85a20022019-12-21 18:25:54 +01003488 // always scroll up, don't overwrite
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003489 msg_scroll = TRUE;
3490}
3491
3492/*
3493 * Like verbose_leave() and set cmdline_row when displaying the message.
3494 */
3495 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003496verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003497{
3498 if (*p_vfile != NUL)
3499 {
3500 if (--msg_silent < 0)
3501 msg_silent = 0;
3502 }
3503 else
3504 cmdline_row = msg_row;
3505}
3506
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003507/*
3508 * Called when 'verbosefile' is set: stop writing to the file.
3509 */
3510 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003511verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003512{
3513 if (verbose_fd != NULL)
3514 {
3515 fclose(verbose_fd);
3516 verbose_fd = NULL;
3517 }
3518 verbose_did_open = FALSE;
3519}
3520
3521/*
3522 * Open the file 'verbosefile'.
3523 * Return FAIL or OK.
3524 */
3525 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003526verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003527{
3528 if (verbose_fd == NULL && !verbose_did_open)
3529 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003530 // Only give the error message once.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003531 verbose_did_open = TRUE;
3532
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003533 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003534 if (verbose_fd == NULL)
3535 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003536 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003537 return FAIL;
3538 }
3539 }
3540 return OK;
3541}
3542
3543/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 * Give a warning message (for searching).
3545 * Use 'w' highlighting and may repeat the message after redrawing
3546 */
3547 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003548give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003550 // Don't do this for ":silent".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 if (msg_silent != 0)
3552 return;
3553
Bram Moolenaar85a20022019-12-21 18:25:54 +01003554 // Don't want a hit-enter prompt here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003556
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557#ifdef FEAT_EVAL
3558 set_vim_var_string(VV_WARNINGMSG, message, -1);
3559#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003560 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003562 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 else
3564 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003565 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003566 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar85a20022019-12-21 18:25:54 +01003567 msg_didout = FALSE; // overwrite this message
3568 msg_nowait = TRUE; // don't wait for this message
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003570
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 --no_wait_return;
3572}
3573
Bram Moolenaar113e1072019-01-20 15:30:40 +01003574#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003575 void
3576give_warning2(char_u *message, char_u *a1, int hl)
3577{
Bram Moolenaare3a22cb2019-10-14 22:01:57 +02003578 if (IObuff == NULL)
3579 {
3580 // Very early in initialisation and already something wrong, just give
3581 // the raw message so the user at least gets a hint.
3582 give_warning((char_u *)message, hl);
3583 }
3584 else
3585 {
3586 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3587 give_warning(IObuff, hl);
3588 }
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003589}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003590#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003591
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592/*
3593 * Advance msg cursor to column "col".
3594 */
3595 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003596msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003598 if (msg_silent != 0) // nothing to advance to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003600 msg_col = col; // for redirection, may fill it up later
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 return;
3602 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01003603 if (col >= Columns) // not enough room
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003605#ifdef FEAT_RIGHTLEFT
3606 if (cmdmsg_rl)
3607 while (msg_col > Columns - col)
3608 msg_putchar(' ');
3609 else
3610#endif
3611 while (msg_col < col)
3612 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613}
3614
3615#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3616/*
3617 * Used for "confirm()" function, and the :confirm command prefix.
3618 * Versions which haven't got flexible dialogs yet, and console
3619 * versions, get this generic handler which uses the command line.
3620 *
3621 * type = one of:
3622 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3623 * title = title string (can be NULL for default)
3624 * (neither used in console dialogs at the moment)
3625 *
3626 * Format of the "buttons" string:
3627 * "Button1Name\nButton2Name\nButton3Name"
3628 * The first button should normally be the default/accept
3629 * The second button should be the 'Cancel' button
3630 * Other buttons- use your imagination!
3631 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3632 * different letter.
3633 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003635do_dialog(
3636 int type UNUSED,
3637 char_u *title UNUSED,
3638 char_u *message,
3639 char_u *buttons,
3640 int dfltbutton,
Bram Moolenaar85a20022019-12-21 18:25:54 +01003641 char_u *textfield UNUSED, // IObuff for inputdialog(), NULL
3642 // otherwise
3643 int ex_cmd) // when TRUE pressing : accepts default and starts
3644 // Ex command
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645{
3646 int oldState;
3647 int retval = 0;
3648 char_u *hotkeys;
3649 int c;
3650 int i;
3651
3652#ifndef NO_CONSOLE
Bram Moolenaar85a20022019-12-21 18:25:54 +01003653 // Don't output anything in silent mode ("ex -s")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 if (silent_mode)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003655 return dfltbutton; // return default option
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656#endif
3657
3658#ifdef FEAT_GUI_DIALOG
Bram Moolenaar85a20022019-12-21 18:25:54 +01003659 // When GUI is running and 'c' not in 'guioptions', use the GUI dialog
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3661 {
3662 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003663 textfield, ex_cmd);
Bram Moolenaar85a20022019-12-21 18:25:54 +01003664 // avoid a hit-enter prompt without clearing the cmdline
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003665 need_wait_return = FALSE;
3666 emsg_on_display = FALSE;
3667 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668
Bram Moolenaar85a20022019-12-21 18:25:54 +01003669 // Flush output to avoid that further messages and redrawing is done
3670 // in the wrong order.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 out_flush();
3672 gui_mch_update();
3673
3674 return c;
3675 }
3676#endif
3677
3678 oldState = State;
3679 State = CONFIRM;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681
3682 /*
3683 * Since we wait for a keypress, don't make the
3684 * user press RETURN as well afterwards.
3685 */
3686 ++no_wait_return;
3687 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3688
3689 if (hotkeys != NULL)
3690 {
3691 for (;;)
3692 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003693 // Get a typed character directly from the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 c = get_keystroke();
3695 switch (c)
3696 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003697 case CAR: // User accepts default option
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 case NL:
3699 retval = dfltbutton;
3700 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003701 case Ctrl_C: // User aborts/cancels
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 case ESC:
3703 retval = 0;
3704 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003705 default: // Could be a hotkey?
3706 if (c < 0) // special keys are ignored here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003708 if (c == ':' && ex_cmd)
3709 {
3710 retval = dfltbutton;
3711 ins_char_typebuf(':');
3712 break;
3713 }
3714
Bram Moolenaar85a20022019-12-21 18:25:54 +01003715 // Make the character lowercase, as chars in "hotkeys" are.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 c = MB_TOLOWER(c);
3717 retval = 1;
3718 for (i = 0; hotkeys[i]; ++i)
3719 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 if (has_mbyte)
3721 {
3722 if ((*mb_ptr2char)(hotkeys + i) == c)
3723 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003724 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 }
3726 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 if (hotkeys[i] == c)
3728 break;
3729 ++retval;
3730 }
3731 if (hotkeys[i])
3732 break;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003733 // No hotkey match, so keep waiting
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 continue;
3735 }
3736 break;
3737 }
3738
3739 vim_free(hotkeys);
3740 }
3741
3742 State = oldState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 --no_wait_return;
3745 msg_end_prompt();
3746
3747 return retval;
3748}
3749
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750/*
3751 * Copy one character from "*from" to "*to", taking care of multi-byte
3752 * characters. Return the length of the character in bytes.
3753 */
3754 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003755copy_char(
3756 char_u *from,
3757 char_u *to,
Bram Moolenaar85a20022019-12-21 18:25:54 +01003758 int lowercase) // make character lower case
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 int len;
3761 int c;
3762
3763 if (has_mbyte)
3764 {
3765 if (lowercase)
3766 {
3767 c = MB_TOLOWER((*mb_ptr2char)(from));
3768 return (*mb_char2bytes)(c, to);
3769 }
3770 else
3771 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003772 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 mch_memmove(to, from, (size_t)len);
3774 return len;
3775 }
3776 }
3777 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 {
3779 if (lowercase)
3780 *to = (char_u)TOLOWER_LOC(*from);
3781 else
3782 *to = *from;
3783 return 1;
3784 }
3785}
3786
3787/*
3788 * Format the dialog string, and display it at the bottom of
3789 * the screen. Return a string of hotkey chars (if defined) for
3790 * each 'button'. If a button has no hotkey defined, the first character of
3791 * the button is used.
3792 * The hotkeys can be multi-byte characters, but without combining chars.
3793 *
3794 * Returns an allocated string with hotkeys, or NULL for error.
3795 */
3796 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003797msg_show_console_dialog(
3798 char_u *message,
3799 char_u *buttons,
3800 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801{
3802 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003803#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003804 int lenhotkey = HOTK_LEN; // count first button
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 char_u *hotk = NULL;
3806 char_u *msgp = NULL;
3807 char_u *hotkp = NULL;
3808 char_u *r;
3809 int copy;
3810#define HAS_HOTKEY_LEN 30
3811 char_u has_hotkey[HAS_HOTKEY_LEN];
Bram Moolenaar85a20022019-12-21 18:25:54 +01003812 int first_hotkey = FALSE; // first char of button is hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 int idx;
3814
3815 has_hotkey[0] = FALSE;
3816
3817 /*
3818 * First loop: compute the size of memory to allocate.
3819 * Second loop: copy to the allocated memory.
3820 */
3821 for (copy = 0; copy <= 1; ++copy)
3822 {
3823 r = buttons;
3824 idx = 0;
3825 while (*r)
3826 {
3827 if (*r == DLG_BUTTON_SEP)
3828 {
3829 if (copy)
3830 {
3831 *msgp++ = ',';
Bram Moolenaar85a20022019-12-21 18:25:54 +01003832 *msgp++ = ' '; // '\n' -> ', '
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833
Bram Moolenaar85a20022019-12-21 18:25:54 +01003834 // advance to next hotkey and set default hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003836 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003839 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 if (dfltbutton)
3841 --dfltbutton;
3842
Bram Moolenaar85a20022019-12-21 18:25:54 +01003843 // If no hotkey is specified first char is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3845 first_hotkey = TRUE;
3846 }
3847 else
3848 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003849 len += 3; // '\n' -> ', '; 'x' -> '(x)'
3850 lenhotkey += HOTK_LEN; // each button needs a hotkey
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 if (idx < HAS_HOTKEY_LEN - 1)
3852 has_hotkey[++idx] = FALSE;
3853 }
3854 }
3855 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3856 {
3857 if (*r == DLG_HOTKEY_CHAR)
3858 ++r;
3859 first_hotkey = FALSE;
3860 if (copy)
3861 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003862 if (*r == DLG_HOTKEY_CHAR) // '&&a' -> '&a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 *msgp++ = *r;
3864 else
3865 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003866 // '&a' -> '[a]'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3868 msgp += copy_char(r, msgp, FALSE);
3869 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3870
Bram Moolenaar85a20022019-12-21 18:25:54 +01003871 // redefine hotkey
Bram Moolenaar6a516062007-07-05 08:11:42 +00003872 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 }
3874 }
3875 else
3876 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003877 ++len; // '&a' -> '[a]'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 if (idx < HAS_HOTKEY_LEN - 1)
3879 has_hotkey[idx] = TRUE;
3880 }
3881 }
3882 else
3883 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01003884 // everything else copy literally
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 if (copy)
3886 msgp += copy_char(r, msgp, FALSE);
3887 }
3888
Bram Moolenaar85a20022019-12-21 18:25:54 +01003889 // advance to the next character
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003890 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 }
3892
3893 if (copy)
3894 {
3895 *msgp++ = ':';
3896 *msgp++ = ' ';
3897 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 }
3899 else
3900 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003901 len += (int)(STRLEN(message)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003902 + 2 // for the NL's
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003903 + STRLEN(buttons)
Bram Moolenaar85a20022019-12-21 18:25:54 +01003904 + 3); // for the ": " and NUL
3905 lenhotkey++; // for the NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906
Bram Moolenaar85a20022019-12-21 18:25:54 +01003907 // If no hotkey is specified first char is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 if (!has_hotkey[0])
3909 {
3910 first_hotkey = TRUE;
Bram Moolenaar85a20022019-12-21 18:25:54 +01003911 len += 2; // "x" -> "[x]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 }
3913
3914 /*
3915 * Now allocate and load the strings
3916 */
3917 vim_free(confirm_msg);
3918 confirm_msg = alloc(len);
3919 if (confirm_msg == NULL)
3920 return NULL;
3921 *confirm_msg = NUL;
3922 hotk = alloc(lenhotkey);
3923 if (hotk == NULL)
3924 return NULL;
3925
3926 *confirm_msg = '\n';
3927 STRCPY(confirm_msg + 1, message);
3928
3929 msgp = confirm_msg + 1 + STRLEN(message);
3930 hotkp = hotk;
3931
Bram Moolenaar85a20022019-12-21 18:25:54 +01003932 // Define first default hotkey. Keep the hotkey string NUL
3933 // terminated to avoid reading past the end.
Bram Moolenaar6a516062007-07-05 08:11:42 +00003934 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935
Bram Moolenaar85a20022019-12-21 18:25:54 +01003936 // Remember where the choices start, displaying starts here when
3937 // "hotkp" typed at the more prompt.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 confirm_msg_tail = msgp;
3939 *msgp++ = '\n';
3940 }
3941 }
3942
3943 display_confirm_msg();
3944 return hotk;
3945}
3946
3947/*
3948 * Display the ":confirm" message. Also called when screen resized.
3949 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003950 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003951display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952{
Bram Moolenaar85a20022019-12-21 18:25:54 +01003953 // avoid that 'q' at the more prompt truncates the message here
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 ++confirm_msg_used;
3955 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003956 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 --confirm_msg_used;
3958}
3959
Bram Moolenaar85a20022019-12-21 18:25:54 +01003960#endif // FEAT_CON_DIALOG
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961
3962#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3963
3964 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003965vim_dialog_yesno(
3966 int type,
3967 char_u *title,
3968 char_u *message,
3969 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970{
3971 if (do_dialog(type,
3972 title == NULL ? (char_u *)_("Question") : title,
3973 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003974 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 return VIM_YES;
3976 return VIM_NO;
3977}
3978
3979 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003980vim_dialog_yesnocancel(
3981 int type,
3982 char_u *title,
3983 char_u *message,
3984 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985{
3986 switch (do_dialog(type,
3987 title == NULL ? (char_u *)_("Question") : title,
3988 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003989 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 {
3991 case 1: return VIM_YES;
3992 case 2: return VIM_NO;
3993 }
3994 return VIM_CANCEL;
3995}
3996
3997 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003998vim_dialog_yesnoallcancel(
3999 int type,
4000 char_u *title,
4001 char_u *message,
4002 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003{
4004 switch (do_dialog(type,
4005 title == NULL ? (char_u *)"Question" : title,
4006 message,
4007 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01004008 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 {
4010 case 1: return VIM_YES;
4011 case 2: return VIM_NO;
4012 case 3: return VIM_ALL;
4013 case 4: return VIM_DISCARDALL;
4014 }
4015 return VIM_CANCEL;
4016}
4017
Bram Moolenaar85a20022019-12-21 18:25:54 +01004018#endif // FEAT_GUI_DIALOG || FEAT_CON_DIALOG
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004020#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004021static char *e_printf = N_("E766: Insufficient arguments for printf()");
4022
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004023/*
4024 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4025 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004026 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004027tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004028{
4029 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004030 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004031 int err = FALSE;
4032
4033 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004034 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004035 else
4036 {
4037 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004038 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004039 if (err)
4040 n = 0;
4041 }
4042 return n;
4043}
4044
4045/*
4046 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004047 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004048 * are not converted to a string.
4049 * If "tofree" is not NULL echo_string() is used. All types are converted to
4050 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004051 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004052 */
4053 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004054tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004055{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004056 int idx = *idxp - 1;
4057 char *s = NULL;
4058 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004059
4060 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004061 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004062 else
4063 {
4064 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004065 if (tofree != NULL)
4066 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4067 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004068 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004069 }
4070 return s;
4071}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004072
4073# ifdef FEAT_FLOAT
4074/*
4075 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4076 */
4077 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004078tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004079{
4080 int idx = *idxp - 1;
4081 double f = 0;
4082
4083 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004084 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004085 else
4086 {
4087 ++*idxp;
4088 if (tvs[idx].v_type == VAR_FLOAT)
4089 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004090 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004091 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004092 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004093 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004094 }
4095 return f;
4096}
4097# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004098#endif
4099
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004100#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004101/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004102 * Return the representation of infinity for printf() function:
4103 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4104 */
4105 static const char *
4106infinity_str(int positive,
4107 char fmt_spec,
4108 int force_sign,
4109 int space_for_positive)
4110{
4111 static const char *table[] =
4112 {
4113 "-inf", "inf", "+inf", " inf",
4114 "-INF", "INF", "+INF", " INF"
4115 };
4116 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4117
4118 if (ASCII_ISUPPER(fmt_spec))
4119 idx += 4;
4120 return table[idx];
4121}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004122#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004123
4124/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004125 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004126 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004127 * consistency.
4128 *
4129 * This code is based on snprintf.c - a portable implementation of snprintf
4130 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004131 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004132 * The original code, including useful comments, can be found here:
4133 * http://www.ijs.si/software/snprintf/
4134 *
4135 * This snprintf() only supports the following conversion specifiers:
4136 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4137 * with flags: '-', '+', ' ', '0' and '#'.
4138 * An asterisk is supported for field width as well as precision.
4139 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004140 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004141 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004142 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004143 * are supported. NOTE: for 'll' the argument is varnumber_T or uvarnumber_T.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004144 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004145 * The locale is not used, the string is used as a byte string. This is only
4146 * relevant for double-byte encodings where the second byte may be '%'.
4147 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004148 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4149 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004150 *
4151 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004152 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004153 * is greater or equal to "str_m", not all characters from the result
4154 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4155 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004156 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004157 */
4158
4159/*
4160 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004161 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004162 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004163 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004164 */
4165
Bram Moolenaar85a20022019-12-21 18:25:54 +01004166// When generating prototypes all of this is skipped, cproto doesn't
4167// understand this.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004168#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004169
Bram Moolenaar85a20022019-12-21 18:25:54 +01004170// Like vim_vsnprintf() but append to the string.
Bram Moolenaara800b422010-06-27 01:15:55 +02004171 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004172vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004173{
4174 va_list ap;
4175 int str_l;
4176 size_t len = STRLEN(str);
4177 size_t space;
4178
4179 if (str_m <= len)
4180 space = 0;
4181 else
4182 space = str_m - len;
4183 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004184 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004185 va_end(ap);
4186 return str_l;
4187}
Bram Moolenaara800b422010-06-27 01:15:55 +02004188
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004189 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004190vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004191{
4192 va_list ap;
4193 int str_l;
4194
4195 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004196 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004197 va_end(ap);
4198 return str_l;
4199}
4200
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004201 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004202vim_vsnprintf(
4203 char *str,
4204 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004205 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004206 va_list ap)
4207{
4208 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4209}
4210
4211 int
4212vim_vsnprintf_typval(
4213 char *str,
4214 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004215 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004216 va_list ap,
4217 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004218{
4219 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004220 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004221 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004222
4223 if (p == NULL)
4224 p = "";
4225 while (*p != NUL)
4226 {
4227 if (*p != '%')
4228 {
4229 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004230 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004231
Bram Moolenaar85a20022019-12-21 18:25:54 +01004232 // Copy up to the next '%' or NUL without any changes.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004233 if (str_l < str_m)
4234 {
4235 size_t avail = str_m - str_l;
4236
4237 mch_memmove(str + str_l, p, n > avail ? avail : n);
4238 }
4239 p += n;
4240 str_l += n;
4241 }
4242 else
4243 {
4244 size_t min_field_width = 0, precision = 0;
4245 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4246 int alternate_form = 0, force_sign = 0;
4247
Bram Moolenaar85a20022019-12-21 18:25:54 +01004248 // If both the ' ' and '+' flags appear, the ' ' flag should be
4249 // ignored.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004250 int space_for_positive = 1;
4251
Bram Moolenaar85a20022019-12-21 18:25:54 +01004252 // allowed values: \0, h, l, L
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004253 char length_modifier = '\0';
4254
Bram Moolenaar85a20022019-12-21 18:25:54 +01004255 // temporary buffer for simple numeric->string conversion
Bram Moolenaar91984b92016-08-16 21:58:41 +02004256# if defined(FEAT_FLOAT)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004257# define TMP_LEN 350 // On my system 1e308 is the biggest number possible.
4258 // That sounds reasonable to use as the maximum
4259 // printable.
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004260# else
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004261# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004262# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004263 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004264
Bram Moolenaar85a20022019-12-21 18:25:54 +01004265 // string address in case of string argument
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004266 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004267
Bram Moolenaar85a20022019-12-21 18:25:54 +01004268 // natural field width of arg without padding and sign
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004269 size_t str_arg_l;
4270
Bram Moolenaar85a20022019-12-21 18:25:54 +01004271 // unsigned char argument value - only defined for c conversion.
4272 // N.B. standard explicitly states the char argument for the c
4273 // conversion is unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004274 unsigned char uchar_arg;
4275
Bram Moolenaar85a20022019-12-21 18:25:54 +01004276 // number of zeros to be inserted for numeric conversions as
4277 // required by the precision or minimal field width
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004278 size_t number_of_zeros_to_pad = 0;
4279
Bram Moolenaar85a20022019-12-21 18:25:54 +01004280 // index into tmp where zero padding is to be inserted
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004281 size_t zero_padding_insertion_ind = 0;
4282
Bram Moolenaar85a20022019-12-21 18:25:54 +01004283 // current conversion specifier character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004284 char fmt_spec = '\0';
4285
Bram Moolenaar85a20022019-12-21 18:25:54 +01004286 // buffer for 's' and 'S' specs
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004287 char_u *tofree = NULL;
4288
4289
Bram Moolenaar85a20022019-12-21 18:25:54 +01004290 p++; // skip '%'
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004291
Bram Moolenaar85a20022019-12-21 18:25:54 +01004292 // parse flags
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004293 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4294 || *p == '#' || *p == '\'')
4295 {
4296 switch (*p)
4297 {
4298 case '0': zero_padding = 1; break;
4299 case '-': justify_left = 1; break;
4300 case '+': force_sign = 1; space_for_positive = 0; break;
4301 case ' ': force_sign = 1;
Bram Moolenaar85a20022019-12-21 18:25:54 +01004302 // If both the ' ' and '+' flags appear, the ' '
4303 // flag should be ignored
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004304 break;
4305 case '#': alternate_form = 1; break;
4306 case '\'': break;
4307 }
4308 p++;
4309 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004310 // If the '0' and '-' flags both appear, the '0' flag should be
4311 // ignored.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004312
Bram Moolenaar85a20022019-12-21 18:25:54 +01004313 // parse field width
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004314 if (*p == '*')
4315 {
4316 int j;
4317
4318 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004319 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004320# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004321 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004322# endif
4323 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324 if (j >= 0)
4325 min_field_width = j;
4326 else
4327 {
4328 min_field_width = -j;
4329 justify_left = 1;
4330 }
4331 }
4332 else if (VIM_ISDIGIT((int)(*p)))
4333 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004334 // size_t could be wider than unsigned int; make sure we treat
4335 // argument like common implementations do
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004336 unsigned int uj = *p++ - '0';
4337
4338 while (VIM_ISDIGIT((int)(*p)))
4339 uj = 10 * uj + (unsigned int)(*p++ - '0');
4340 min_field_width = uj;
4341 }
4342
Bram Moolenaar85a20022019-12-21 18:25:54 +01004343 // parse precision
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004344 if (*p == '.')
4345 {
4346 p++;
4347 precision_specified = 1;
4348 if (*p == '*')
4349 {
4350 int j;
4351
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004352 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004353# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004354 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004355# endif
4356 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004357 p++;
4358 if (j >= 0)
4359 precision = j;
4360 else
4361 {
4362 precision_specified = 0;
4363 precision = 0;
4364 }
4365 }
4366 else if (VIM_ISDIGIT((int)(*p)))
4367 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004368 // size_t could be wider than unsigned int; make sure we
4369 // treat argument like common implementations do
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004370 unsigned int uj = *p++ - '0';
4371
4372 while (VIM_ISDIGIT((int)(*p)))
4373 uj = 10 * uj + (unsigned int)(*p++ - '0');
4374 precision = uj;
4375 }
4376 }
4377
Bram Moolenaar85a20022019-12-21 18:25:54 +01004378 // parse 'h', 'l' and 'll' length modifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004379 if (*p == 'h' || *p == 'l')
4380 {
4381 length_modifier = *p;
4382 p++;
4383 if (length_modifier == 'l' && *p == 'l')
4384 {
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004385 // double l = __int64 / varnumber_T
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004386 length_modifier = 'L';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004387 p++;
4388 }
4389 }
4390 fmt_spec = *p;
4391
Bram Moolenaar85a20022019-12-21 18:25:54 +01004392 // common synonyms:
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004393 switch (fmt_spec)
4394 {
4395 case 'i': fmt_spec = 'd'; break;
4396 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4397 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4398 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4399 default: break;
4400 }
4401
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004402# if defined(FEAT_EVAL)
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004403 switch (fmt_spec)
4404 {
4405 case 'd': case 'u': case 'o': case 'x': case 'X':
4406 if (tvs != NULL && length_modifier == '\0')
4407 length_modifier = 'L';
4408 }
4409# endif
4410
Bram Moolenaar85a20022019-12-21 18:25:54 +01004411 // get parameter value, do initial processing
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004412 switch (fmt_spec)
4413 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004414 // '%' and 'c' behave similar to 's' regarding flags and field
4415 // widths
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004416 case '%':
4417 case 'c':
4418 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004419 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004420 str_arg_l = 1;
4421 switch (fmt_spec)
4422 {
4423 case '%':
4424 str_arg = p;
4425 break;
4426
4427 case 'c':
4428 {
4429 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004430
4431 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004432# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004433 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004434# endif
4435 va_arg(ap, int);
Bram Moolenaar85a20022019-12-21 18:25:54 +01004436 // standard demands unsigned char
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004437 uchar_arg = (unsigned char)j;
4438 str_arg = (char *)&uchar_arg;
4439 break;
4440 }
4441
4442 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004443 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004444 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004445# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004446 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004447# endif
4448 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004449 if (str_arg == NULL)
4450 {
4451 str_arg = "[NULL]";
4452 str_arg_l = 6;
4453 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004454 // make sure not to address string beyond the specified
4455 // precision !!!
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004456 else if (!precision_specified)
4457 str_arg_l = strlen(str_arg);
Bram Moolenaar85a20022019-12-21 18:25:54 +01004458 // truncate string if necessary as requested by precision
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004459 else if (precision == 0)
4460 str_arg_l = 0;
4461 else
4462 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004463 // Don't put the #if inside memchr(), it can be a
4464 // macro.
4465 // memchr on HP does not like n > 2^31 !!!
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004466 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004467 precision <= (size_t)0x7fffffffL ? precision
4468 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004469 str_arg_l = (q == NULL) ? precision
4470 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004471 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004472 if (fmt_spec == 'S')
4473 {
4474 if (min_field_width != 0)
4475 min_field_width += STRLEN(str_arg)
4476 - mb_string2cells((char_u *)str_arg, -1);
4477 if (precision)
4478 {
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004479 char_u *p1;
4480 size_t i = 0;
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004481
Bram Moolenaarce0fac22019-09-27 13:32:06 +02004482 for (p1 = (char_u *)str_arg; *p1;
4483 p1 += mb_ptr2len(p1))
4484 {
4485 i += (size_t)mb_ptr2cells(p1);
4486 if (i > precision)
4487 break;
4488 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004489 str_arg_l = precision = p1 - (char_u *)str_arg;
4490 }
4491 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004492 break;
4493
4494 default:
4495 break;
4496 }
4497 break;
4498
Bram Moolenaar91984b92016-08-16 21:58:41 +02004499 case 'd': case 'u':
4500 case 'b': case 'B':
4501 case 'o':
4502 case 'x': case 'X':
4503 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004504 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004505 // NOTE: the u, b, o, x, X and p conversion specifiers
4506 // imply the value is unsigned; d implies a signed
4507 // value
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004508
Bram Moolenaar85a20022019-12-21 18:25:54 +01004509 // 0 if numeric argument is zero (or if pointer is
4510 // NULL for 'p'), +1 if greater than zero (or nonzero
4511 // for unsigned arguments), -1 if negative (unsigned
4512 // argument is never negative)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004513 int arg_sign = 0;
4514
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004515 // only set for length modifier h, or for no length
4516 // modifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004517 int int_arg = 0;
4518 unsigned int uint_arg = 0;
4519
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004520 // only set for length modifier l
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004521 long int long_arg = 0;
4522 unsigned long int ulong_arg = 0;
4523
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004524 // only set for length modifier ll
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004525 varnumber_T llong_arg = 0;
4526 uvarnumber_T ullong_arg = 0;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004527
Bram Moolenaarf9706e92020-02-22 14:27:04 +01004528 // only set for b conversion
Bram Moolenaar91984b92016-08-16 21:58:41 +02004529 uvarnumber_T bin_arg = 0;
4530
Bram Moolenaar85a20022019-12-21 18:25:54 +01004531 // pointer argument value -only defined for p
4532 // conversion
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004533 void *ptr_arg = NULL;
4534
4535 if (fmt_spec == 'p')
4536 {
4537 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004538 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004539# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004540 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4541 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004542# endif
4543 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004544 if (ptr_arg != NULL)
4545 arg_sign = 1;
4546 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004547 else if (fmt_spec == 'b' || fmt_spec == 'B')
4548 {
4549 bin_arg =
4550# if defined(FEAT_EVAL)
4551 tvs != NULL ?
4552 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4553# endif
4554 va_arg(ap, uvarnumber_T);
4555 if (bin_arg != 0)
4556 arg_sign = 1;
4557 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004558 else if (fmt_spec == 'd')
4559 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004560 // signed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004561 switch (length_modifier)
4562 {
4563 case '\0':
4564 case 'h':
Bram Moolenaar85a20022019-12-21 18:25:54 +01004565 // char and short arguments are passed as int.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004566 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004567# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004568 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004569# endif
4570 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004571 if (int_arg > 0)
4572 arg_sign = 1;
4573 else if (int_arg < 0)
4574 arg_sign = -1;
4575 break;
4576 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004577 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004578# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004579 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004580# endif
4581 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004582 if (long_arg > 0)
4583 arg_sign = 1;
4584 else if (long_arg < 0)
4585 arg_sign = -1;
4586 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004587 case 'L':
4588 llong_arg =
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004589# if defined(FEAT_EVAL)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004590 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004591# endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004592 va_arg(ap, varnumber_T);
4593 if (llong_arg > 0)
4594 arg_sign = 1;
4595 else if (llong_arg < 0)
4596 arg_sign = -1;
4597 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004598 }
4599 }
4600 else
4601 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004602 // unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004603 switch (length_modifier)
4604 {
4605 case '\0':
4606 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004607 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004608# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004609 tvs != NULL ? (unsigned)
4610 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004611# endif
4612 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004613 if (uint_arg != 0)
4614 arg_sign = 1;
4615 break;
4616 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004617 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004618# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004619 tvs != NULL ? (unsigned long)
4620 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004621# endif
4622 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004623 if (ulong_arg != 0)
4624 arg_sign = 1;
4625 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004626 case 'L':
4627 ullong_arg =
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004628# if defined(FEAT_EVAL)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004629 tvs != NULL ? (uvarnumber_T)
4630 tv_nr(tvs, &arg_idx) :
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004631# endif
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004632 va_arg(ap, uvarnumber_T);
4633 if (ullong_arg != 0)
4634 arg_sign = 1;
4635 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004636 }
4637 }
4638
4639 str_arg = tmp;
4640 str_arg_l = 0;
4641
Bram Moolenaar85a20022019-12-21 18:25:54 +01004642 // NOTE:
4643 // For d, i, u, o, x, and X conversions, if precision is
4644 // specified, the '0' flag should be ignored. This is so
4645 // with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4646 // FreeBSD, NetBSD; but not with Perl.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004647 if (precision_specified)
4648 zero_padding = 0;
4649 if (fmt_spec == 'd')
4650 {
4651 if (force_sign && arg_sign >= 0)
4652 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
Bram Moolenaar85a20022019-12-21 18:25:54 +01004653 // leave negative numbers for sprintf to handle, to
4654 // avoid handling tricky cases like (short int)-32768
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004655 }
4656 else if (alternate_form)
4657 {
4658 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004659 && (fmt_spec == 'b' || fmt_spec == 'B'
4660 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004661 {
4662 tmp[str_arg_l++] = '0';
4663 tmp[str_arg_l++] = fmt_spec;
4664 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004665 // alternate form should have no effect for p
4666 // conversion, but ...
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004667 }
4668
4669 zero_padding_insertion_ind = str_arg_l;
4670 if (!precision_specified)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004671 precision = 1; // default precision is 1
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004672 if (precision == 0 && arg_sign == 0)
4673 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004674 // When zero value is formatted with an explicit
4675 // precision 0, the resulting formatted string is
4676 // empty (d, i, u, b, B, o, x, X, p).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004677 }
4678 else
4679 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004680 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004681 int f_l = 0;
4682
Bram Moolenaar85a20022019-12-21 18:25:54 +01004683 // construct a simple format string for sprintf
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004684 f[f_l++] = '%';
4685 if (!length_modifier)
4686 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004687 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004688 {
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004689# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004690 f[f_l++] = 'I';
4691 f[f_l++] = '6';
4692 f[f_l++] = '4';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004693# else
4694 f[f_l++] = 'l';
Bram Moolenaar82f654e2020-02-17 22:12:50 +01004695 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004696# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004697 }
4698 else
4699 f[f_l++] = length_modifier;
4700 f[f_l++] = fmt_spec;
4701 f[f_l++] = '\0';
4702
4703 if (fmt_spec == 'p')
4704 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004705 else if (fmt_spec == 'b' || fmt_spec == 'B')
4706 {
4707 char b[8 * sizeof(uvarnumber_T)];
4708 size_t b_l = 0;
4709 uvarnumber_T bn = bin_arg;
4710
4711 do
4712 {
4713 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4714 bn >>= 1;
4715 }
4716 while (bn != 0);
4717
4718 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4719 str_arg_l += b_l;
4720 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004721 else if (fmt_spec == 'd')
4722 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004723 // signed
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004724 switch (length_modifier)
4725 {
Bram Moolenaar693e80e2020-03-08 18:41:09 +01004726 case '\0': str_arg_l += sprintf(
4727 tmp + str_arg_l, f,
4728 int_arg);
4729 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004730 case 'h': str_arg_l += sprintf(
Bram Moolenaar693e80e2020-03-08 18:41:09 +01004731 tmp + str_arg_l, f,
4732 (short)int_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004733 break;
4734 case 'l': str_arg_l += sprintf(
4735 tmp + str_arg_l, f, long_arg);
4736 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004737 case 'L': str_arg_l += sprintf(
4738 tmp + str_arg_l, f, llong_arg);
4739 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004740 }
4741 }
4742 else
4743 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004744 // unsigned
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004745 switch (length_modifier)
4746 {
Bram Moolenaar693e80e2020-03-08 18:41:09 +01004747 case '\0': str_arg_l += sprintf(
4748 tmp + str_arg_l, f,
4749 uint_arg);
4750 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004751 case 'h': str_arg_l += sprintf(
Bram Moolenaar693e80e2020-03-08 18:41:09 +01004752 tmp + str_arg_l, f,
4753 (unsigned short)uint_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004754 break;
4755 case 'l': str_arg_l += sprintf(
4756 tmp + str_arg_l, f, ulong_arg);
4757 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004758 case 'L': str_arg_l += sprintf(
4759 tmp + str_arg_l, f, ullong_arg);
4760 break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004761 }
4762 }
4763
Bram Moolenaar85a20022019-12-21 18:25:54 +01004764 // include the optional minus sign and possible
4765 // "0x" in the region before the zero padding
4766 // insertion point
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004767 if (zero_padding_insertion_ind < str_arg_l
4768 && tmp[zero_padding_insertion_ind] == '-')
4769 zero_padding_insertion_ind++;
4770 if (zero_padding_insertion_ind + 1 < str_arg_l
4771 && tmp[zero_padding_insertion_ind] == '0'
4772 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4773 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4774 zero_padding_insertion_ind += 2;
4775 }
4776
4777 {
4778 size_t num_of_digits = str_arg_l
4779 - zero_padding_insertion_ind;
4780
4781 if (alternate_form && fmt_spec == 'o'
Bram Moolenaar85a20022019-12-21 18:25:54 +01004782 // unless zero is already the first
4783 // character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004784 && !(zero_padding_insertion_ind < str_arg_l
4785 && tmp[zero_padding_insertion_ind] == '0'))
4786 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004787 // assure leading zero for alternate-form
4788 // octal numbers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004789 if (!precision_specified
4790 || precision < num_of_digits + 1)
4791 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004792 // precision is increased to force the
4793 // first character to be zero, except if a
4794 // zero value is formatted with an
4795 // explicit precision of zero
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004796 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004797 }
4798 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004799 // zero padding to specified precision?
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004800 if (num_of_digits < precision)
4801 number_of_zeros_to_pad = precision - num_of_digits;
4802 }
Bram Moolenaar85a20022019-12-21 18:25:54 +01004803 // zero padding to specified minimal field width?
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004804 if (!justify_left && zero_padding)
4805 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004806 int n = (int)(min_field_width - (str_arg_l
4807 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004808 if (n > 0)
4809 number_of_zeros_to_pad += n;
4810 }
4811 break;
4812 }
4813
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004814# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004815 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004816 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004817 case 'e':
4818 case 'E':
4819 case 'g':
4820 case 'G':
4821 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004822 // Floating point.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004823 double f;
4824 double abs_f;
4825 char format[40];
4826 int l;
4827 int remove_trailing_zeroes = FALSE;
4828
4829 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004830# if defined(FEAT_EVAL)
4831 tvs != NULL ? tv_float(tvs, &arg_idx) :
4832# endif
4833 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004834 abs_f = f < 0 ? -f : f;
4835
4836 if (fmt_spec == 'g' || fmt_spec == 'G')
4837 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004838 // Would be nice to use %g directly, but it prints
4839 // "1.0" as "1", we don't want that.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004840 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4841 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004842 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004843 else
4844 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4845 remove_trailing_zeroes = TRUE;
4846 }
4847
Bram Moolenaar04186092016-08-29 21:55:35 +02004848 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004849# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004850 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004851# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004852 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004853# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004854 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004855 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004856 // Avoid a buffer overflow
Bram Moolenaare9997822016-08-28 16:03:38 +02004857 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4858 force_sign, space_for_positive));
4859 str_arg_l = STRLEN(tmp);
4860 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004861 }
4862 else
4863 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004864 if (isnan(f))
4865 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004866 // Not a number: nan or NAN
Bram Moolenaare9997822016-08-28 16:03:38 +02004867 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4868 : "nan");
4869 str_arg_l = 3;
4870 zero_padding = 0;
4871 }
4872 else if (isinf(f))
4873 {
4874 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4875 force_sign, space_for_positive));
4876 str_arg_l = STRLEN(tmp);
4877 zero_padding = 0;
4878 }
4879 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004880 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004881 // Regular float number
Bram Moolenaar04186092016-08-29 21:55:35 +02004882 format[0] = '%';
4883 l = 1;
4884 if (force_sign)
4885 format[l++] = space_for_positive ? ' ' : '+';
4886 if (precision_specified)
4887 {
4888 size_t max_prec = TMP_LEN - 10;
4889
Bram Moolenaar85a20022019-12-21 18:25:54 +01004890 // Make sure we don't get more digits than we
4891 // have room for.
Bram Moolenaar04186092016-08-29 21:55:35 +02004892 if ((fmt_spec == 'f' || fmt_spec == 'F')
4893 && abs_f > 1.0)
4894 max_prec -= (size_t)log10(abs_f);
4895 if (precision > max_prec)
4896 precision = max_prec;
4897 l += sprintf(format + l, ".%d", (int)precision);
4898 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004899 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004900 format[l + 1] = NUL;
4901
Bram Moolenaare9997822016-08-28 16:03:38 +02004902 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004903 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004904
Bram Moolenaara7241f52008-06-24 20:39:31 +00004905 if (remove_trailing_zeroes)
4906 {
4907 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004908 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004909
Bram Moolenaar85a20022019-12-21 18:25:54 +01004910 // Using %g or %G: remove superfluous zeroes.
Bram Moolenaar04186092016-08-29 21:55:35 +02004911 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004912 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004913 else
4914 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004915 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004916 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004917 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004918 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004919 // Remove superfluous '+' and leading
4920 // zeroes from the exponent.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004921 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004922 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004923 // Change "1.0e+07" to "1.0e07"
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004924 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004925 --str_arg_l;
4926 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004927 i = (tp[1] == '-') ? 2 : 1;
4928 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004929 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004930 // Change "1.0e07" to "1.0e7"
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004931 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004932 --str_arg_l;
4933 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004934 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004935 }
4936 }
4937
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004938 if (tp != NULL && !precision_specified)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004939 // Remove trailing zeroes, but keep the one
4940 // just after a dot.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004941 while (tp > tmp + 2 && *tp == '0'
4942 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004943 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004944 STRMOVE(tp, tp + 1);
4945 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004946 --str_arg_l;
4947 }
4948 }
4949 else
4950 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004951 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004952
Bram Moolenaar85a20022019-12-21 18:25:54 +01004953 // Be consistent: some printf("%e") use 1.0e+12
4954 // and some 1.0e+012. Remove one zero in the last
4955 // case.
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004956 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004957 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004958 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4959 && tp[2] == '0'
4960 && vim_isdigit(tp[3])
4961 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004962 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004963 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004964 --str_arg_l;
4965 }
4966 }
4967 }
Bram Moolenaar04186092016-08-29 21:55:35 +02004968 if (zero_padding && min_field_width > str_arg_l
4969 && (tmp[0] == '-' || force_sign))
4970 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01004971 // padding 0's should be inserted after the sign
Bram Moolenaar04186092016-08-29 21:55:35 +02004972 number_of_zeros_to_pad = min_field_width - str_arg_l;
4973 zero_padding_insertion_ind = 1;
4974 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00004975 str_arg = tmp;
4976 break;
4977 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004978# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004979
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004980 default:
Bram Moolenaar85a20022019-12-21 18:25:54 +01004981 // unrecognized conversion specifier, keep format string
4982 // as-is
4983 zero_padding = 0; // turn zero padding off for non-numeric
4984 // conversion
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004985 justify_left = 1;
Bram Moolenaar85a20022019-12-21 18:25:54 +01004986 min_field_width = 0; // reset flags
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004987
Bram Moolenaar85a20022019-12-21 18:25:54 +01004988 // discard the unrecognized conversion, just keep *
4989 // the unrecognized conversion character
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004990 str_arg = p;
4991 str_arg_l = 0;
4992 if (*p != NUL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004993 str_arg_l++; // include invalid conversion specifier
4994 // unchanged if not at end-of-string
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004995 break;
4996 }
4997
4998 if (*p != NUL)
Bram Moolenaar85a20022019-12-21 18:25:54 +01004999 p++; // step over the just processed conversion specifier
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005000
Bram Moolenaar85a20022019-12-21 18:25:54 +01005001 // insert padding to the left as requested by min_field_width;
5002 // this does not include the zero padding in case of numerical
5003 // conversions
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005004 if (!justify_left)
5005 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005006 // left padding with blank or zero
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005007 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005008
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005009 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005010 {
5011 if (str_l < str_m)
5012 {
5013 size_t avail = str_m - str_l;
5014
5015 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005016 (size_t)pn > avail ? avail
5017 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005018 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005019 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005020 }
5021 }
5022
Bram Moolenaar85a20022019-12-21 18:25:54 +01005023 // zero padding as requested by the precision or by the minimal
5024 // field width for numeric conversions required?
Bram Moolenaarea424162005-06-16 21:51:00 +00005025 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005026 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005027 // will not copy first part of numeric right now, *
5028 // force it to be copied later in its entirety
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005029 zero_padding_insertion_ind = 0;
5030 }
5031 else
5032 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005033 // insert first part of numerics (sign or '0x') before zero
5034 // padding
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005035 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005036
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005037 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005038 {
5039 if (str_l < str_m)
5040 {
5041 size_t avail = str_m - str_l;
5042
5043 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005044 (size_t)zn > avail ? avail
5045 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005046 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005047 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005048 }
5049
Bram Moolenaar85a20022019-12-21 18:25:54 +01005050 // insert zero padding as requested by the precision or min
5051 // field width
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005052 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005053 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005054 {
5055 if (str_l < str_m)
5056 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005057 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005058
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005059 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005060 (size_t)zn > avail ? avail
5061 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005062 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005063 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005064 }
5065 }
5066
Bram Moolenaar85a20022019-12-21 18:25:54 +01005067 // insert formatted string
5068 // (or as-is conversion specifier for unknown conversions)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005069 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005070 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005071
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005072 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005073 {
5074 if (str_l < str_m)
5075 {
5076 size_t avail = str_m - str_l;
5077
5078 mch_memmove(str + str_l,
5079 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005080 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005081 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005082 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005083 }
5084 }
5085
Bram Moolenaar85a20022019-12-21 18:25:54 +01005086 // insert right padding
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005087 if (justify_left)
5088 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005089 // right blank padding to the field width
Bram Moolenaara7241f52008-06-24 20:39:31 +00005090 int pn = (int)(min_field_width
5091 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005093 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005094 {
5095 if (str_l < str_m)
5096 {
5097 size_t avail = str_m - str_l;
5098
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005099 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005100 (size_t)pn > avail ? avail
5101 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005102 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005103 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005104 }
5105 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005106 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005107 }
5108 }
5109
5110 if (str_m > 0)
5111 {
Bram Moolenaar85a20022019-12-21 18:25:54 +01005112 // make sure the string is nul-terminated even at the expense of
5113 // overwriting the last character (shouldn't happen, but just in case)
5114 //
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005115 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5116 }
5117
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005118 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005119 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005120
Bram Moolenaar85a20022019-12-21 18:25:54 +01005121 // Return the number of characters formatted (excluding trailing nul
5122 // character), that is, the number of characters that would have been
5123 // written to the buffer if it were large enough.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005124 return (int)str_l;
5125}
5126
Bram Moolenaar85a20022019-12-21 18:25:54 +01005127#endif // PROTO