blob: fd087a4a79870ab684be08cf075bb4537bd45019 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * message.c: functions for displaying messages on the command line
12 */
13
14#define MESSAGE_FILE /* don't include prototype for smsg() */
Bram Moolenaar44ca54a2016-08-27 15:41:32 +020015#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
17#include "vim.h"
18
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010019static int other_sourcing_name(void);
20static char_u *get_emsg_source(void);
21static char_u *get_emsg_lnum(void);
22static void add_msg_hist(char_u *s, int len, int attr);
23static void hit_return_msg(void);
24static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000025#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010026static char_u *screen_puts_mbyte(char_u *s, int l, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000027#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010028static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
29static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
30static void msg_scroll_up(void);
31static void inc_msg_scrolled(void);
32static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
33static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
34static void msg_puts_printf(char_u *str, int maxlen);
35static int do_more_prompt(int typed_char);
36static void msg_screen_putchar(int c, int attr);
37static int msg_check_screen(void);
38static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000039#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010040static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000041static int confirm_msg_used = FALSE; /* displaying confirm_msg */
42static char_u *confirm_msg = NULL; /* ":confirm" message */
43static char_u *confirm_msg_tail; /* tail of confirm_msg */
44#endif
Bram Moolenaar958dc692016-12-01 15:34:12 +010045#ifdef FEAT_JOB_CHANNEL
46static int emsg_to_channel_log = FALSE;
47#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000048
49struct msg_hist
50{
51 struct msg_hist *next;
52 char_u *msg;
53 int attr;
54};
55
56static struct msg_hist *first_msg_hist = NULL;
57static struct msg_hist *last_msg_hist = NULL;
58static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020060static FILE *verbose_fd = NULL;
61static int verbose_did_open = FALSE;
62
Bram Moolenaar071d4272004-06-13 20:20:40 +000063/*
64 * When writing messages to the screen, there are many different situations.
65 * A number of variables is used to remember the current state:
66 * msg_didany TRUE when messages were written since the last time the
67 * user reacted to a prompt.
68 * Reset: After hitting a key for the hit-return prompt,
69 * hitting <CR> for the command line or input().
70 * Set: When any message is written to the screen.
71 * msg_didout TRUE when something was written to the current line.
72 * Reset: When advancing to the next line, when the current
73 * text can be overwritten.
74 * Set: When any message is written to the screen.
75 * msg_nowait No extra delay for the last drawn message.
76 * Used in normal_cmd() before the mode message is drawn.
77 * emsg_on_display There was an error message recently. Indicates that there
78 * should be a delay before redrawing.
79 * msg_scroll The next message should not overwrite the current one.
80 * msg_scrolled How many lines the screen has been scrolled (because of
81 * messages). Used in update_screen() to scroll the screen
82 * back. Incremented each time the screen scrolls a line.
83 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
84 * writes something without scrolling should not make
85 * need_wait_return to be set. This is a hack to make ":ts"
86 * work without an extra prompt.
87 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010088 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000089 * need_wait_return TRUE when the hit-return prompt is needed.
90 * Reset: After giving the hit-return prompt, when the user
91 * has answered some other prompt.
92 * Set: When the ruler or typeahead display is overwritten,
93 * scrolling the screen for some message.
94 * keep_msg Message to be displayed after redrawing the screen, in
95 * main_loop().
96 * This is an allocated string or NULL when not used.
97 */
98
99/*
100 * msg(s) - displays the string 's' on the status line
101 * When terminal not initialized (yet) mch_errmsg(..) is used.
102 * return TRUE if wait_return not called
103 */
104 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100105msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106{
107 return msg_attr_keep(s, 0, FALSE);
108}
109
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000110#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000111 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000112/*
113 * Like msg() but keep it silent when 'verbosefile' is set.
114 */
115 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100116verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000117{
118 int n;
119
120 verbose_enter();
121 n = msg_attr_keep(s, 0, FALSE);
122 verbose_leave();
123
124 return n;
125}
126#endif
127
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100129msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130{
131 return msg_attr_keep(s, attr, FALSE);
132}
133
134 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100135msg_attr_keep(
136 char_u *s,
137 int attr,
138 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139{
140 static int entered = 0;
141 int retval;
142 char_u *buf = NULL;
143
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200144 /* Skip messages not matching ":filter pattern".
145 * Don't filter when there is an error. */
146 if (!emsg_on_display && message_filtered(s))
147 return TRUE;
148
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149#ifdef FEAT_EVAL
150 if (attr == 0)
151 set_vim_var_string(VV_STATUSMSG, s, -1);
152#endif
153
154 /*
155 * It is possible that displaying a messages causes a problem (e.g.,
156 * when redrawing the window), which causes another message, etc.. To
157 * break this loop, limit the recursiveness to 3 levels.
158 */
159 if (entered >= 3)
160 return TRUE;
161 ++entered;
162
163 /* Add message to history (unless it's a repeated kept message or a
164 * truncated message) */
165 if (s != keep_msg
166 || (*s != '<'
167 && last_msg_hist != NULL
168 && last_msg_hist->msg != NULL
169 && STRCMP(s, last_msg_hist->msg)))
170 add_msg_hist(s, -1, attr);
171
Bram Moolenaar958dc692016-12-01 15:34:12 +0100172#ifdef FEAT_JOB_CHANNEL
173 if (emsg_to_channel_log)
Bram Moolenaar958dc692016-12-01 15:34:12 +0100174 /* Write message in the channel log. */
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200175 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100176#endif
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 /* When displaying keep_msg, don't let msg_start() free it, caller must do
179 * that. */
180 if (s == keep_msg)
181 keep_msg = NULL;
182
183 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000184 msg_start();
185 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 if (buf != NULL)
187 s = buf;
188
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 msg_outtrans_attr(s, attr);
190 msg_clr_eos();
191 retval = msg_end();
192
193 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
194 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000195 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
197 vim_free(buf);
198 --entered;
199 return retval;
200}
201
202/*
203 * Truncate a string such that it can be printed without causing a scroll.
204 * Returns an allocated string or NULL when no truncating is done.
205 */
206 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100207msg_strtrunc(
208 char_u *s,
209 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210{
211 char_u *buf = NULL;
212 int len;
213 int room;
214
215 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000216 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
217 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 {
219 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000220 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000221 /* Use all the columns. */
222 room = (int)(Rows - msg_row) * Columns - 1;
223 else
224 /* Use up to 'showcmd' column. */
225 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 if (len > room && room > 0)
227 {
228#ifdef FEAT_MBYTE
229 if (enc_utf8)
230 /* may have up to 18 bytes per cell (6 per char, up to two
231 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100232 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 else if (enc_dbcs == DBCS_JPNU)
234 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100235 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 else
237#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100238 len = room + 2;
239 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100241 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242 }
243 }
244 return buf;
245}
246
247/*
248 * Truncate a string "s" to "buf" with cell width "room".
249 * "s" and "buf" may be equal.
250 */
251 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100252trunc_string(
253 char_u *s,
254 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200255 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100256 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200258 size_t room = room_in - 3; /* "..." takes 3 chars */
259 size_t half;
260 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 int e;
262 int i;
263 int n;
264
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200265 if (room_in < 3)
266 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100270 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 {
272 if (s[e] == NUL)
273 {
274 /* text fits without truncating! */
275 buf[e] = NUL;
276 return;
277 }
278 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200279 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 break;
281 len += n;
282 buf[e] = s[e];
283#ifdef FEAT_MBYTE
284 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000285 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100287 if (++e == buflen)
288 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000289 buf[e] = s[e];
290 }
291#endif
292 }
293
294 /* Last part: End of the string. */
295 i = e;
296#ifdef FEAT_MBYTE
297 if (enc_dbcs != 0)
298 {
299 /* For DBCS going backwards in a string is slow, but
300 * computing the cell width isn't too slow: go forward
301 * until the rest fits. */
302 n = vim_strsize(s + i);
303 while (len + n > room)
304 {
305 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000306 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 }
308 }
309 else if (enc_utf8)
310 {
311 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000312 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 for (;;)
314 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000315 do
Bram Moolenaarace95982017-03-29 17:30:27 +0200316 half = half - utf_head_off(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200317 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200319 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 break;
321 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200322 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323 }
324 }
325 else
326#endif
327 {
328 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
329 len += n;
330 }
331
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200332
333 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100334 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200335 /* text fits without truncating */
336 if (s != buf)
337 {
338 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200339 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200340 len = buflen - 1;
341 len = len - e + 1;
342 if (len < 1)
343 buf[e - 1] = NUL;
344 else
345 mch_memmove(buf + e, s + e, len);
346 }
347 }
348 else if (e + 3 < buflen)
349 {
350 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100351 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200352 len = STRLEN(s + i) + 1;
353 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100354 len = buflen - e - 3 - 1;
355 mch_memmove(buf + e + 3, s + i, len);
356 buf[e + 3 + len - 1] = NUL;
357 }
358 else
359 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200360 /* can't fit in the "...", just truncate it */
361 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100362 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363}
364
365/*
366 * Automatic prototype generation does not understand this function.
367 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
368 * shorter than IOSIZE!!!
369 */
370#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000372int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000373
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100375# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100377# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378smsg(char_u *s, ...)
379{
380 va_list arglist;
381
382 va_start(arglist, s);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +0200383 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 va_end(arglist);
385 return msg(IObuff);
386}
387
388 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100389# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100391# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392smsg_attr(int attr, char_u *s, ...)
393{
394 va_list arglist;
395
396 va_start(arglist, s);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +0200397 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 va_end(arglist);
399 return msg_attr(IObuff, attr);
400}
401
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402#endif
403
404/*
405 * Remember the last sourcing name/lnum used in an error message, so that it
406 * isn't printed each time when it didn't change.
407 */
408static int last_sourcing_lnum = 0;
409static char_u *last_sourcing_name = NULL;
410
411/*
412 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
413 * for the next error message;
414 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000415 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100416reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100418 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419 last_sourcing_lnum = 0;
420}
421
422/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000423 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
424 */
425 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100426other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000427{
428 if (sourcing_name != NULL)
429 {
430 if (last_sourcing_name != NULL)
431 return STRCMP(sourcing_name, last_sourcing_name) != 0;
432 return TRUE;
433 }
434 return FALSE;
435}
436
437/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 * Get the message about the source, as used for an error message.
439 * Returns an allocated string with room for one more character.
440 * Returns NULL when no message is to be given.
441 */
442 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100443get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444{
445 char_u *Buf, *p;
446
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000447 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448 {
449 p = (char_u *)_("Error detected while processing %s:");
450 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
451 if (Buf != NULL)
452 sprintf((char *)Buf, (char *)p, sourcing_name);
453 return Buf;
454 }
455 return NULL;
456}
457
458/*
459 * Get the message about the source lnum, as used for an error message.
460 * Returns an allocated string with room for one more character.
461 * Returns NULL when no message is to be given.
462 */
463 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100464get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465{
466 char_u *Buf, *p;
467
468 /* lnum is 0 when executing a command from the command line
469 * argument, we don't want a line number then */
470 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000471 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 && sourcing_lnum != 0)
473 {
474 p = (char_u *)_("line %4ld:");
475 Buf = alloc((unsigned)(STRLEN(p) + 20));
476 if (Buf != NULL)
477 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
478 return Buf;
479 }
480 return NULL;
481}
482
483/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000484 * Display name and line number for the source of an error.
485 * Remember the file name and line number, so that for the next error the info
486 * is only displayed if it changed.
487 */
488 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100489msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000490{
491 char_u *p;
492
493 ++no_wait_return;
494 p = get_emsg_source();
495 if (p != NULL)
496 {
497 msg_attr(p, attr);
498 vim_free(p);
499 }
500 p = get_emsg_lnum();
501 if (p != NULL)
502 {
Bram Moolenaar8820b482017-03-16 17:23:31 +0100503 msg_attr(p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000504 vim_free(p);
505 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
506 }
507
508 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000509 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000510 {
511 vim_free(last_sourcing_name);
512 if (sourcing_name == NULL)
513 last_sourcing_name = NULL;
514 else
515 last_sourcing_name = vim_strsave(sourcing_name);
516 }
517 --no_wait_return;
518}
519
520/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000521 * Return TRUE if not giving error messages right now:
522 * If "emsg_off" is set: no error messages at the moment.
523 * If "msg" is in 'debug': do error message but without side effects.
524 * If "emsg_skip" is set: never do error messages.
525 */
526 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100527emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000528{
529 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
530 && vim_strchr(p_debug, 't') == NULL)
531#ifdef FEAT_EVAL
532 || emsg_skip > 0
533#endif
534 )
535 return TRUE;
536 return FALSE;
537}
538
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100539#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100540static garray_T ignore_error_list = GA_EMPTY;
541
542 void
543ignore_error_for_testing(char_u *error)
544{
545 if (ignore_error_list.ga_itemsize == 0)
546 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
547
548 ga_add_string(&ignore_error_list, error);
549}
550
551 static int
552ignore_error(char_u *msg)
553{
554 int i;
555
556 for (i = 0; i < ignore_error_list.ga_len; ++i)
557 if (strstr((char *)msg,
558 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
559 return TRUE;
560 return FALSE;
561}
562#endif
563
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200564#if !defined(HAVE_STRERROR) || defined(PROTO)
565/*
566 * Replacement for perror() that behaves more or less like emsg() was called.
567 * v:errmsg will be set and called_emsg will be set.
568 */
569 void
570do_perror(char *msg)
571{
572 perror(msg);
573 ++emsg_silent;
574 emsg((char_u *)msg);
575 --emsg_silent;
576}
577#endif
578
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000579/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580 * emsg() - display an error message
581 *
582 * Rings the bell, if appropriate, and calls message() to do the real work
583 * When terminal not initialized (yet) mch_errmsg(..) is used.
584 *
585 * return TRUE if wait_return not called
586 */
587 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100588emsg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589{
590 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100592 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593#ifdef FEAT_EVAL
594 int ignore = FALSE;
595 int severe;
596#endif
597
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100598 /* Skip this if not giving error messages at the moment. */
599 if (emsg_not_now())
600 return TRUE;
601
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100602#ifdef FEAT_EVAL
603 /* When testing some errors are turned into a normal message. */
604 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100605 /* don't call msg() if it results in a dialog */
606 return msg_use_printf() ? FALSE : msg(s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100607#endif
608
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 called_emsg = TRUE;
610
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611#ifdef FEAT_EVAL
Bram Moolenaare723c422017-09-06 23:40:10 +0200612 /* If "emsg_severe" is TRUE: When an error exception is to be thrown,
613 * prefer this message over previous messages for the same command. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 severe = emsg_severe;
615 emsg_severe = FALSE;
616#endif
617
Bram Moolenaar57657d82006-04-21 22:12:41 +0000618 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619 {
620#ifdef FEAT_EVAL
621 /*
622 * Cause a throw of an error exception if appropriate. Don't display
623 * the error message in this case. (If no matching catch clause will
624 * be found, the message will be displayed later on.) "ignore" is set
625 * when the message should be ignored completely (used for the
626 * interrupt message).
627 */
628 if (cause_errthrow(s, severe, &ignore) == TRUE)
629 {
630 if (!ignore)
631 did_emsg = TRUE;
632 return TRUE;
633 }
634
635 /* set "v:errmsg", also when using ":silent! cmd" */
636 set_vim_var_string(VV_ERRMSG, s, -1);
637#endif
638
639 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000640 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 * But do write it to the redirection file.
642 */
643 if (emsg_silent != 0)
644 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200645 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200647 msg_start();
648 p = get_emsg_source();
649 if (p != NULL)
650 {
651 STRCAT(p, "\n");
652 redir_write(p, -1);
653 vim_free(p);
654 }
655 p = get_emsg_lnum();
656 if (p != NULL)
657 {
658 STRCAT(p, "\n");
659 redir_write(p, -1);
660 vim_free(p);
661 }
662 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100664#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200665 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100666#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 return TRUE;
668 }
669
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100670 ex_exitval = 1;
671
Bram Moolenaar2f40d122017-10-24 21:49:36 +0200672 /* Reset msg_silent, an error causes messages to be switched back on.
673 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 msg_silent = 0;
675 cmd_silent = FALSE;
676
677 if (global_busy) /* break :global command */
678 ++global_busy;
679
680 if (p_eb)
681 beep_flush(); /* also includes flush_buffers() */
682 else
683 flush_buffers(FALSE); /* flush internal buffers */
684 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaare723c422017-09-06 23:40:10 +0200685#ifdef FEAT_EVAL
686 did_uncaught_emsg = TRUE;
687#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 }
689
690 emsg_on_display = TRUE; /* remember there is an error message */
691 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100692 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000693 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 need_wait_return = TRUE; /* needed in case emsg() is called after
695 * wait_return has reset need_wait_return
696 * and a redraw is expected because
697 * msg_scrolled is non-zero */
698
Bram Moolenaar958dc692016-12-01 15:34:12 +0100699#ifdef FEAT_JOB_CHANNEL
700 emsg_to_channel_log = TRUE;
701#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 /*
703 * Display name and line number for the source of the error.
704 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000705 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706
707 /*
708 * Display the error message itself.
709 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000710 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar958dc692016-12-01 15:34:12 +0100711 r = msg_attr(s, attr);
712
713#ifdef FEAT_JOB_CHANNEL
714 emsg_to_channel_log = FALSE;
715#endif
716 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717}
718
Bram Moolenaar95f09602016-11-10 20:01:45 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720/*
721 * Print an error message with one "%s" and one string argument.
722 */
723 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100724emsg2(char_u *s, char_u *a1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725{
726 return emsg3(s, a1, NULL);
727}
728
Bram Moolenaar95f09602016-11-10 20:01:45 +0100729/*
730 * Print an error message with one or two "%s" and one or two string arguments.
731 * This is not in message.c to avoid a warning for prototypes.
732 */
733 int
734emsg3(char_u *s, char_u *a1, char_u *a2)
735{
736 if (emsg_not_now())
737 return TRUE; /* no error messages at the moment */
738 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, a1, a2);
739 return emsg(IObuff);
740}
741
742/*
743 * Print an error message with one "%ld" and one long int argument.
744 * This is not in message.c to avoid a warning for prototypes.
745 */
746 int
747emsgn(char_u *s, long n)
748{
749 if (emsg_not_now())
750 return TRUE; /* no error messages at the moment */
751 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, n);
752 return emsg(IObuff);
753}
754
755/*
756 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
757 * defined. It is used for internal errors only, so that they can be
758 * detected when fuzzing vim.
759 */
760 void
761iemsg(char_u *s)
762{
Bram Moolenaar191f18b2018-02-04 16:38:47 +0100763 emsg(s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100764#ifdef ABORT_ON_INTERNAL_ERROR
765 abort();
766#endif
767}
768
769
770/*
771 * Same as emsg2(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
772 * defined. It is used for internal errors only, so that they can be
773 * detected when fuzzing vim.
774 */
775 void
776iemsg2(char_u *s, char_u *a1)
777{
778 emsg2(s, a1);
779#ifdef ABORT_ON_INTERNAL_ERROR
780 abort();
781#endif
782}
783
784/*
785 * Same as emsgn(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
786 * defined. It is used for internal errors only, so that they can be
787 * detected when fuzzing vim.
788 */
789 void
790iemsgn(char_u *s, long n)
791{
792 emsgn(s, n);
793#ifdef ABORT_ON_INTERNAL_ERROR
794 abort();
795#endif
796}
797
798/*
799 * Give an "Internal error" message.
800 */
801 void
802internal_error(char *where)
803{
804 IEMSG2(_(e_intern2), where);
805}
806
Bram Moolenaarea424162005-06-16 21:51:00 +0000807/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808
Bram Moolenaardf177f62005-02-22 08:39:57 +0000809 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100810emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000811{
812 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
813}
814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815/*
816 * Like msg(), but truncate to a single line if p_shm contains 't', or when
817 * "force" is TRUE. This truncates in another way as for normal messages.
818 * Careful: The string may be changed by msg_may_trunc()!
819 * Returns a pointer to the printed message, if wait_return() not called.
820 */
821 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100822msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823{
824 int n;
825
826 /* Add message to history before truncating */
827 add_msg_hist(s, -1, attr);
828
829 s = msg_may_trunc(force, s);
830
831 msg_hist_off = TRUE;
832 n = msg_attr(s, attr);
833 msg_hist_off = FALSE;
834
835 if (n)
836 return s;
837 return NULL;
838}
839
840/*
841 * Check if message "s" should be truncated at the start (for filenames).
842 * Return a pointer to where the truncated message starts.
843 * Note: May change the message by replacing a character with '<'.
844 */
845 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100846msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847{
848 int n;
849 int room;
850
851 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
852 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
853 && (n = (int)STRLEN(s) - room) > 0)
854 {
855#ifdef FEAT_MBYTE
856 if (has_mbyte)
857 {
858 int size = vim_strsize(s);
859
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000860 /* There may be room anyway when there are multibyte chars. */
861 if (size <= room)
862 return s;
863
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 for (n = 0; size >= room; )
865 {
866 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000867 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 }
869 --n;
870 }
871#endif
872 s += n;
873 *s = '<';
874 }
875 return s;
876}
877
878 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100879add_msg_hist(
880 char_u *s,
881 int len, /* -1 for undetermined length */
882 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883{
884 struct msg_hist *p;
885
886 if (msg_hist_off || msg_silent != 0)
887 return;
888
889 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000890 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000891 (void)delete_first_msg();
892
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 /* allocate an entry and add the message at the end of the history */
894 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
895 if (p != NULL)
896 {
897 if (len < 0)
898 len = (int)STRLEN(s);
899 /* remove leading and trailing newlines */
900 while (len > 0 && *s == '\n')
901 {
902 ++s;
903 --len;
904 }
905 while (len > 0 && s[len - 1] == '\n')
906 --len;
907 p->msg = vim_strnsave(s, len);
908 p->next = NULL;
909 p->attr = attr;
910 if (last_msg_hist != NULL)
911 last_msg_hist->next = p;
912 last_msg_hist = p;
913 if (first_msg_hist == NULL)
914 first_msg_hist = last_msg_hist;
915 ++msg_hist_len;
916 }
917}
918
919/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000920 * Delete the first (oldest) message from the history.
921 * Returns FAIL if there are no messages.
922 */
923 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100924delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000925{
926 struct msg_hist *p;
927
928 if (msg_hist_len <= 0)
929 return FAIL;
930 p = first_msg_hist;
931 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000932 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200933 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000934 vim_free(p->msg);
935 vim_free(p);
936 --msg_hist_len;
937 return OK;
938}
939
940/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 * ":messages" command.
942 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200944ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945{
946 struct msg_hist *p;
947 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200948 int c = 0;
949
950 if (STRCMP(eap->arg, "clear") == 0)
951 {
952 int keep = eap->addr_count == 0 ? 0 : eap->line2;
953
954 while (msg_hist_len > keep)
955 (void)delete_first_msg();
956 return;
957 }
958
959 if (*eap->arg != NUL)
960 {
961 EMSG(_(e_invarg));
962 return;
963 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964
965 msg_hist_off = TRUE;
966
Bram Moolenaar451f8492016-04-14 17:16:22 +0200967 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200968 if (eap->addr_count != 0)
969 {
970 /* Count total messages */
971 for (; p != NULL && !got_int; p = p->next)
972 c++;
973
974 c -= eap->line2;
975
976 /* Skip without number of messages specified */
977 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
978 p = p->next, c--);
979 }
980
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200981 if (p == first_msg_hist)
982 {
983 s = mch_getenv((char_u *)"LANG");
984 if (s != NULL && *s != NUL)
985 msg_attr((char_u *)
986 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100987 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200988 }
989
Bram Moolenaar451f8492016-04-14 17:16:22 +0200990 /* Display what was not skipped. */
991 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 if (p->msg != NULL)
993 msg_attr(p->msg, p->attr);
994
995 msg_hist_off = FALSE;
996}
997
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000998#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999/*
1000 * Call this after prompting the user. This will avoid a hit-return message
1001 * and a delay.
1002 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001003 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001004msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005{
1006 need_wait_return = FALSE;
1007 emsg_on_display = FALSE;
1008 cmdline_row = msg_row;
1009 msg_col = 0;
1010 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001011 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012}
1013#endif
1014
1015/*
1016 * wait for the user to hit a key (normally a return)
1017 * if 'redraw' is TRUE, clear and redraw the screen
1018 * if 'redraw' is FALSE, just redraw the screen
1019 * if 'redraw' is -1, don't redraw at all
1020 */
1021 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001022wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023{
1024 int c;
1025 int oldState;
1026 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001028 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001029 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031 if (redraw == TRUE)
1032 must_redraw = CLEAR;
1033
1034 /* If using ":silent cmd", don't wait for a return. Also don't set
1035 * need_wait_return to do it later. */
1036 if (msg_silent != 0)
1037 return;
1038
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001039 /*
1040 * When inside vgetc(), we can't wait for a typed character at all.
1041 * With the global command (and some others) we only need one return at
1042 * the end. Adjust cmdline_row to avoid the next message overwriting the
1043 * last one.
1044 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001045 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001047 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 if (no_wait_return)
1049 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 if (!exmode_active)
1051 cmdline_row = msg_row;
1052 return;
1053 }
1054
1055 redir_off = TRUE; /* don't redirect this message */
1056 oldState = State;
1057 if (quit_more)
1058 {
1059 c = CAR; /* just pretend CR was hit */
1060 quit_more = FALSE;
1061 got_int = FALSE;
1062 }
1063 else if (exmode_active)
1064 {
1065 MSG_PUTS(" "); /* make sure the cursor is on the right line */
1066 c = CAR; /* no need for a return in ex mode */
1067 got_int = FALSE;
1068 }
1069 else
1070 {
1071 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1072 * just changed. */
1073 screenalloc(FALSE);
1074
1075 State = HITRETURN;
1076#ifdef FEAT_MOUSE
1077 setmouse();
1078#endif
1079#ifdef USE_ON_FLY_SCROLL
1080 dont_scroll = TRUE; /* disallow scrolling here */
1081#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001082 cmdline_row = msg_row;
1083
Bram Moolenaarec38d692013-04-24 15:12:32 +02001084 /* Avoid the sequence that the user types ":" at the hit-return prompt
1085 * to start an Ex command, but the file-changed dialog gets in the
1086 * way. */
1087 if (need_check_timestamps)
1088 check_timestamps(FALSE);
1089
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 hit_return_msg();
1091
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 do
1093 {
1094 /* Remember "got_int", if it is set vgetc() probably returns a
1095 * CTRL-C, but we need to loop then. */
1096 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001097
1098 /* Don't do mappings here, we put the character back in the
1099 * typeahead buffer. */
1100 ++no_mapping;
1101 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001102
1103 /* Temporarily disable Recording. If Recording is active, the
1104 * character will be recorded later, since it will be added to the
1105 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001106 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001107 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001108 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001109 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001111 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001113 --no_mapping;
1114 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001115 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001116 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001117
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118#ifdef FEAT_CLIPBOARD
1119 /* Strange way to allow copying (yanking) a modeless selection at
1120 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1121 * Cmdline-mode and it's harmless when there is no selection. */
1122 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1123 {
1124 clip_copy_modeless_selection(TRUE);
1125 c = K_IGNORE;
1126 }
1127#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001128
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001129 /*
1130 * Allow scrolling back in the messages.
1131 * Also accept scroll-down commands when messages fill the screen,
1132 * to avoid that typing one 'j' too many makes the messages
1133 * disappear.
1134 */
1135 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001136 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001137 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1138 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001139 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001140 if (msg_scrolled > Rows)
1141 /* scroll back to show older messages */
1142 do_more_prompt(c);
1143 else
1144 {
1145 msg_didout = FALSE;
1146 c = K_IGNORE;
1147 msg_col =
1148#ifdef FEAT_RIGHTLEFT
1149 cmdmsg_rl ? Columns - 1 :
1150#endif
1151 0;
1152 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001153 if (quit_more)
1154 {
1155 c = CAR; /* just pretend CR was hit */
1156 quit_more = FALSE;
1157 got_int = FALSE;
1158 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001159 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001160 {
1161 c = K_IGNORE;
1162 hit_return_msg();
1163 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001164 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001165 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001166 && (c == 'j' || c == 'd' || c == 'f'
1167 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001169 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 } while ((had_got_int && c == Ctrl_C)
1171 || c == K_IGNORE
1172#ifdef FEAT_GUI
1173 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1174#endif
1175#ifdef FEAT_MOUSE
1176 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1177 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1178 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001179 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001181 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 || (!mouse_has(MOUSE_RETURN)
1183 && mouse_row < msg_row
1184 && (c == K_LEFTMOUSE
1185 || c == K_MIDDLEMOUSE
1186 || c == K_RIGHTMOUSE
1187 || c == K_X1MOUSE
1188 || c == K_X2MOUSE))
1189#endif
1190 );
1191 ui_breakcheck();
1192#ifdef FEAT_MOUSE
1193 /*
1194 * Avoid that the mouse-up event causes visual mode to start.
1195 */
1196 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1197 || c == K_X1MOUSE || c == K_X2MOUSE)
1198 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1199 else
1200#endif
1201 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1202 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001203 /* Put the character back in the typeahead buffer. Don't use the
1204 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001205 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001207 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 }
1210 redir_off = FALSE;
1211
1212 /*
1213 * If the user hits ':', '?' or '/' we get a command line from the next
1214 * line.
1215 */
1216 if (c == ':' || c == '?' || c == '/')
1217 {
1218 if (!exmode_active)
1219 cmdline_row = msg_row;
1220 skip_redraw = TRUE; /* skip redraw once */
1221 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001222#ifdef FEAT_TERMINAL
1223 skip_term_loop = TRUE;
1224#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 }
1226
1227 /*
1228 * If the window size changed set_shellsize() will redraw the screen.
1229 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1230 * typed.
1231 */
1232 tmpState = State;
1233 State = oldState; /* restore State before set_shellsize */
1234#ifdef FEAT_MOUSE
1235 setmouse();
1236#endif
1237 msg_check();
1238
1239#if defined(UNIX) || defined(VMS)
1240 /*
1241 * When switching screens, we need to output an extra newline on exit.
1242 */
1243 if (swapping_screen() && !termcap_active)
1244 newline_on_exit = TRUE;
1245#endif
1246
1247 need_wait_return = FALSE;
1248 did_wait_return = TRUE;
1249 emsg_on_display = FALSE; /* can delete error message now */
1250 lines_left = -1; /* reset lines_left at next msg_start() */
1251 reset_last_sourcing();
1252 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1253 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001254 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1257 {
1258 starttermcap(); /* start termcap before redrawing */
1259 shell_resized();
1260 }
1261 else if (!skip_redraw
1262 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1263 {
1264 starttermcap(); /* start termcap before redrawing */
1265 redraw_later(VALID);
1266 }
1267}
1268
1269/*
1270 * Write the hit-return prompt.
1271 */
1272 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001273hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001275 int save_p_more = p_more;
1276
1277 p_more = FALSE; /* don't want see this message when scrolling back */
1278 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 msg_putchar('\n');
1280 if (got_int)
1281 MSG_PUTS(_("Interrupt: "));
1282
Bram Moolenaar8820b482017-03-16 17:23:31 +01001283 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 if (!msg_use_printf())
1285 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001286 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287}
1288
1289/*
1290 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1291 */
1292 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001293set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294{
1295 vim_free(keep_msg);
1296 if (s != NULL && msg_silent == 0)
1297 keep_msg = vim_strsave(s);
1298 else
1299 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001300 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001301 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302}
1303
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001304#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1305/*
1306 * If there currently is a message being displayed, set "keep_msg" to it, so
1307 * that it will be displayed again after redraw.
1308 */
1309 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001310set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001311{
1312 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1313 && (State & NORMAL))
1314 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1315}
1316#endif
1317
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318/*
1319 * Prepare for outputting characters in the command line.
1320 */
1321 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001322msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323{
1324 int did_return = FALSE;
1325
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001326 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001327 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001328
1329#ifdef FEAT_EVAL
1330 if (need_clr_eos)
1331 {
1332 /* Halfway an ":echo" command and getting an (error) message: clear
1333 * any text from the command. */
1334 need_clr_eos = FALSE;
1335 msg_clr_eos();
1336 }
1337#endif
1338
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 if (!msg_scroll && full_screen) /* overwrite last message */
1340 {
1341 msg_row = cmdline_row;
1342 msg_col =
1343#ifdef FEAT_RIGHTLEFT
1344 cmdmsg_rl ? Columns - 1 :
1345#endif
1346 0;
1347 }
1348 else if (msg_didout) /* start message on next line */
1349 {
1350 msg_putchar('\n');
1351 did_return = TRUE;
1352 if (exmode_active != EXMODE_NORMAL)
1353 cmdline_row = msg_row;
1354 }
1355 if (!msg_didany || lines_left < 0)
1356 msg_starthere();
1357 if (msg_silent == 0)
1358 {
1359 msg_didout = FALSE; /* no output on current line yet */
1360 cursor_off();
1361 }
1362
1363 /* when redirecting, may need to start a new line. */
1364 if (!did_return)
1365 redir_write((char_u *)"\n", -1);
1366}
1367
1368/*
1369 * Note that the current msg position is where messages start.
1370 */
1371 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001372msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373{
1374 lines_left = cmdline_row;
1375 msg_didany = FALSE;
1376}
1377
1378 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001379msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380{
1381 msg_putchar_attr(c, 0);
1382}
1383
1384 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001385msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386{
1387#ifdef FEAT_MBYTE
1388 char_u buf[MB_MAXBYTES + 1];
1389#else
1390 char_u buf[4];
1391#endif
1392
1393 if (IS_SPECIAL(c))
1394 {
1395 buf[0] = K_SPECIAL;
1396 buf[1] = K_SECOND(c);
1397 buf[2] = K_THIRD(c);
1398 buf[3] = NUL;
1399 }
1400 else
1401 {
1402#ifdef FEAT_MBYTE
1403 buf[(*mb_char2bytes)(c, buf)] = NUL;
1404#else
1405 buf[0] = c;
1406 buf[1] = NUL;
1407#endif
1408 }
1409 msg_puts_attr(buf, attr);
1410}
1411
1412 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001413msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414{
1415 char_u buf[20];
1416
1417 sprintf((char *)buf, "%ld", n);
1418 msg_puts(buf);
1419}
1420
1421 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001422msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423{
1424 msg_home_replace_attr(fname, 0);
1425}
1426
1427#if defined(FEAT_FIND_ID) || defined(PROTO)
1428 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001429msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001431 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432}
1433#endif
1434
1435 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001436msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437{
1438 char_u *name;
1439
1440 name = home_replace_save(NULL, fname);
1441 if (name != NULL)
1442 msg_outtrans_attr(name, attr);
1443 vim_free(name);
1444}
1445
1446/*
1447 * Output 'len' characters in 'str' (including NULs) with translation
1448 * if 'len' is -1, output upto a NUL character.
1449 * Use attributes 'attr'.
1450 * Return the number of characters it takes on the screen.
1451 */
1452 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001453msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454{
1455 return msg_outtrans_attr(str, 0);
1456}
1457
1458 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001459msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460{
1461 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1462}
1463
1464 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001465msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466{
1467 return msg_outtrans_len_attr(str, len, 0);
1468}
1469
1470/*
1471 * Output one character at "p". Return pointer to the next character.
1472 * Handles multi-byte characters.
1473 */
1474 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001475msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476{
1477#ifdef FEAT_MBYTE
1478 int l;
1479
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001480 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 {
1482 msg_outtrans_len_attr(p, l, attr);
1483 return p + l;
1484 }
1485#endif
1486 msg_puts_attr(transchar_byte(*p), attr);
1487 return p + 1;
1488}
1489
1490 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001491msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492{
1493 int retval = 0;
1494 char_u *str = msgstr;
1495 char_u *plain_start = msgstr;
1496 char_u *s;
1497#ifdef FEAT_MBYTE
1498 int mb_l;
1499 int c;
1500#endif
1501
1502 /* if MSG_HIST flag set, add message to history */
1503 if (attr & MSG_HIST)
1504 {
1505 add_msg_hist(str, len, attr);
1506 attr &= ~MSG_HIST;
1507 }
1508
1509#ifdef FEAT_MBYTE
1510 /* If the string starts with a composing character first draw a space on
1511 * which the composing char can be drawn. */
1512 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1513 msg_puts_attr((char_u *)" ", attr);
1514#endif
1515
1516 /*
1517 * Go over the string. Special characters are translated and printed.
1518 * Normal characters are printed several at a time.
1519 */
1520 while (--len >= 0)
1521 {
1522#ifdef FEAT_MBYTE
1523 if (enc_utf8)
1524 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001525 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001527 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 else
1529 mb_l = 1;
1530 if (has_mbyte && mb_l > 1)
1531 {
1532 c = (*mb_ptr2char)(str);
1533 if (vim_isprintc(c))
1534 /* printable multi-byte char: count the cells. */
1535 retval += (*mb_ptr2cells)(str);
1536 else
1537 {
1538 /* unprintable multi-byte char: print the printable chars so
1539 * far and the translation of the unprintable char. */
1540 if (str > plain_start)
1541 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1542 attr);
1543 plain_start = str + mb_l;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001544 msg_puts_attr(transchar(c), attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 retval += char2cells(c);
1546 }
1547 len -= mb_l - 1;
1548 str += mb_l;
1549 }
1550 else
1551#endif
1552 {
1553 s = transchar_byte(*str);
1554 if (s[1] != NUL)
1555 {
1556 /* unprintable char: print the printable chars so far and the
1557 * translation of the unprintable char. */
1558 if (str > plain_start)
1559 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1560 attr);
1561 plain_start = str + 1;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001562 msg_puts_attr(s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001563 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001565 else
1566 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 ++str;
1568 }
1569 }
1570
1571 if (str > plain_start)
1572 /* print the printable chars at the end */
1573 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1574
1575 return retval;
1576}
1577
1578#if defined(FEAT_QUICKFIX) || defined(PROTO)
1579 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001580msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581{
1582 int i;
1583 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1584
1585 arg = skipwhite(arg);
1586 for (i = 5; *arg && i >= 0; --i)
1587 if (*arg++ != str[i])
1588 break;
1589 if (i < 0)
1590 {
1591 msg_putchar('\n');
1592 for (i = 0; rs[i]; ++i)
1593 msg_putchar(rs[i] - 3);
1594 }
1595}
1596#endif
1597
1598/*
1599 * Output the string 'str' upto a NUL character.
1600 * Return the number of characters it takes on the screen.
1601 *
1602 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1603 * following character and shown as <F1>, <S-Up> etc. Any other character
1604 * which is not printable shown in <> form.
1605 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1606 * If a character is displayed in one of these special ways, is also
1607 * highlighted (its highlight name is '8' in the p_hl variable).
1608 * Otherwise characters are not highlighted.
1609 * This function is used to show mappings, where we want to see how to type
1610 * the character/string -- webb
1611 */
1612 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001613msg_outtrans_special(
1614 char_u *strstart,
1615 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616{
1617 char_u *str = strstart;
1618 int retval = 0;
1619 char_u *string;
1620 int attr;
1621 int len;
1622
Bram Moolenaar8820b482017-03-16 17:23:31 +01001623 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 while (*str != NUL)
1625 {
1626 /* Leading and trailing spaces need to be displayed in <> form. */
1627 if ((str == strstart || str[1] == NUL) && *str == ' ')
1628 {
1629 string = (char_u *)"<Space>";
1630 ++str;
1631 }
1632 else
1633 string = str2special(&str, from);
1634 len = vim_strsize(string);
1635 /* Highlight special keys */
1636 msg_puts_attr(string, len > 1
1637#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001638 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639#endif
1640 ? attr : 0);
1641 retval += len;
1642 }
1643 return retval;
1644}
1645
Bram Moolenaarbd743252010-10-20 21:23:33 +02001646#if defined(FEAT_EVAL) || defined(PROTO)
1647/*
1648 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1649 * strings, in an allocated string.
1650 */
1651 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001652str2special_save(
1653 char_u *str,
1654 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001655{
1656 garray_T ga;
1657 char_u *p = str;
1658
1659 ga_init2(&ga, 1, 40);
1660 while (*p != NUL)
1661 ga_concat(&ga, str2special(&p, is_lhs));
1662 ga_append(&ga, NUL);
1663 return (char_u *)ga.ga_data;
1664}
1665#endif
1666
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667/*
1668 * Return the printable string for the key codes at "*sp".
1669 * Used for translating the lhs or rhs of a mapping to printable chars.
1670 * Advances "sp" to the next code.
1671 */
1672 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001673str2special(
1674 char_u **sp,
1675 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676{
1677 int c;
1678 static char_u buf[7];
1679 char_u *str = *sp;
1680 int modifiers = 0;
1681 int special = FALSE;
1682
1683#ifdef FEAT_MBYTE
1684 if (has_mbyte)
1685 {
1686 char_u *p;
1687
1688 /* Try to un-escape a multi-byte character. Return the un-escaped
1689 * string if it is a multi-byte character. */
1690 p = mb_unescape(sp);
1691 if (p != NULL)
1692 return p;
1693 }
1694#endif
1695
1696 c = *str;
1697 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1698 {
1699 if (str[1] == KS_MODIFIER)
1700 {
1701 modifiers = str[2];
1702 str += 3;
1703 c = *str;
1704 }
1705 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1706 {
1707 c = TO_SPECIAL(str[1], str[2]);
1708 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 }
1710 if (IS_SPECIAL(c) || modifiers) /* special key */
1711 special = TRUE;
1712 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713
1714#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001715 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001717 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001718
1719 /* For multi-byte characters check for an illegal byte. */
1720 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1721 {
1722 transchar_nonprint(buf, c);
1723 *sp = str + 1;
1724 return buf;
1725 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001726 /* Since 'special' is TRUE the multi-byte character 'c' will be
1727 * processed by get_special_key_name() */
1728 c = (*mb_ptr2char)(str);
1729 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001731 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001733 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734
1735 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1736 * Use <Space> only for lhs of a mapping. */
1737 if (special || char2cells(c) > 1 || (from && c == ' '))
1738 return get_special_key_name(c, modifiers);
1739 buf[0] = c;
1740 buf[1] = NUL;
1741 return buf;
1742}
1743
1744/*
1745 * Translate a key sequence into special key names.
1746 */
1747 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001748str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749{
1750 char_u *s;
1751
1752 *buf = NUL;
1753 while (*sp)
1754 {
1755 s = str2special(&sp, FALSE);
1756 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1757 STRCAT(buf, s);
1758 }
1759}
1760
1761/*
1762 * print line for :print or :list command
1763 */
1764 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001765msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766{
1767 int c;
1768 int col = 0;
1769 int n_extra = 0;
1770 int c_extra = 0;
1771 char_u *p_extra = NULL; /* init to make SASC shut up */
1772 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001773 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 char_u *trail = NULL;
1775#ifdef FEAT_MBYTE
1776 int l;
1777 char_u buf[MB_MAXBYTES + 1];
1778#endif
1779
Bram Moolenaardf177f62005-02-22 08:39:57 +00001780 if (curwin->w_p_list)
1781 list = TRUE;
1782
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001784 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 {
1786 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001787 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 --trail;
1789 }
1790
1791 /* output a space for an empty line, otherwise the line will be
1792 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001793 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 msg_putchar(' ');
1795
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001796 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001798 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 {
1800 --n_extra;
1801 if (c_extra)
1802 c = c_extra;
1803 else
1804 c = *p_extra++;
1805 }
1806#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001807 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 {
1809 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001810 if (lcs_nbsp != NUL && list
1811 && (mb_ptr2char(s) == 160
1812 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001813 {
1814 mb_char2bytes(lcs_nbsp, buf);
1815 buf[(*mb_ptr2len)(buf)] = NUL;
1816 }
1817 else
1818 {
1819 mch_memmove(buf, s, (size_t)l);
1820 buf[l] = NUL;
1821 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001822 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 s += l;
1824 continue;
1825 }
1826#endif
1827 else
1828 {
1829 attr = 0;
1830 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001831 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 {
1833 /* tab amount depends on current column */
1834 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001835 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 {
1837 c = ' ';
1838 c_extra = ' ';
1839 }
1840 else
1841 {
1842 c = lcs_tab1;
1843 c_extra = lcs_tab2;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001844 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 }
1846 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001847 else if (c == 160 && list && lcs_nbsp != NUL)
1848 {
1849 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001850 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001851 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001852 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 {
1854 p_extra = (char_u *)"";
1855 c_extra = NUL;
1856 n_extra = 1;
1857 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001858 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 --s;
1860 }
1861 else if (c != NUL && (n = byte2cells(c)) > 1)
1862 {
1863 n_extra = n - 1;
1864 p_extra = transchar_byte(c);
1865 c_extra = NUL;
1866 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001867 /* Use special coloring to be able to distinguish <hex> from
1868 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001869 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 }
1871 else if (c == ' ' && trail != NULL && s > trail)
1872 {
1873 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001874 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001876 else if (c == ' ' && list && lcs_space != NUL)
1877 {
1878 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001879 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001880 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 }
1882
1883 if (c == NUL)
1884 break;
1885
1886 msg_putchar_attr(c, attr);
1887 col++;
1888 }
1889 msg_clr_eos();
1890}
1891
1892#ifdef FEAT_MBYTE
1893/*
1894 * Use screen_puts() to output one multi-byte character.
1895 * Return the pointer "s" advanced to the next character.
1896 */
1897 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001898screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899{
1900 int cw;
1901
1902 msg_didout = TRUE; /* remember that line is not empty */
1903 cw = (*mb_ptr2cells)(s);
1904 if (cw > 1 && (
1905#ifdef FEAT_RIGHTLEFT
1906 cmdmsg_rl ? msg_col <= 1 :
1907#endif
1908 msg_col == Columns - 1))
1909 {
1910 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001911 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 return s;
1913 }
1914
1915 screen_puts_len(s, l, msg_row, msg_col, attr);
1916#ifdef FEAT_RIGHTLEFT
1917 if (cmdmsg_rl)
1918 {
1919 msg_col -= cw;
1920 if (msg_col == 0)
1921 {
1922 msg_col = Columns;
1923 ++msg_row;
1924 }
1925 }
1926 else
1927#endif
1928 {
1929 msg_col += cw;
1930 if (msg_col >= Columns)
1931 {
1932 msg_col = 0;
1933 ++msg_row;
1934 }
1935 }
1936 return s + l;
1937}
1938#endif
1939
1940/*
1941 * Output a string to the screen at position msg_row, msg_col.
1942 * Update msg_row and msg_col for the next message.
1943 */
1944 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001945msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001947 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948}
1949
1950 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001951msg_puts_title(
1952 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001954 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955}
1956
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957/*
1958 * Show a message in such a way that it always fits in the line. Cut out a
1959 * part in the middle and replace it with "..." when necessary.
1960 * Does not handle multi-byte characters!
1961 */
1962 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001963msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001965 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966}
1967
1968 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001969msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970{
1971 int slen = len;
1972 int room;
1973
1974 room = Columns - msg_col;
1975 if (len > room && room >= 20)
1976 {
1977 slen = (room - 3) / 2;
1978 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001979 msg_puts_attr((char_u *)"...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 }
1981 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1982}
1983
1984/*
1985 * Basic function for writing a message with highlight attributes.
1986 */
1987 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001988msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989{
1990 msg_puts_attr_len(s, -1, attr);
1991}
1992
1993/*
1994 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1995 * When "maxlen" is -1 there is no maximum length.
1996 * When "maxlen" is >= 0 the message is not put in the history.
1997 */
1998 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001999msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 /*
2002 * If redirection is on, also write to the redirection file.
2003 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002004 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005
2006 /*
2007 * Don't print anything when using ":silent cmd".
2008 */
2009 if (msg_silent != 0)
2010 return;
2011
2012 /* if MSG_HIST flag set, add message to history */
2013 if ((attr & MSG_HIST) && maxlen < 0)
2014 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002015 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 attr &= ~MSG_HIST;
2017 }
2018
2019 /*
2020 * When writing something to the screen after it has scrolled, requires a
2021 * wait-return prompt later. Needed when scrolling, resetting
2022 * need_wait_return after some prompt, and then outputting something
2023 * without scrolling
2024 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002025 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 need_wait_return = TRUE;
2027 msg_didany = TRUE; /* remember that something was outputted */
2028
2029 /*
2030 * If there is no valid screen, use fprintf so we can see error messages.
2031 * If termcap is not active, we may be writing in an alternate console
2032 * window, cursor positioning may not work correctly (window size may be
2033 * different, e.g. for Win32 console) or we just don't know where the
2034 * cursor is.
2035 */
2036 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002037 msg_puts_printf(str, maxlen);
2038 else
2039 msg_puts_display(str, maxlen, attr, FALSE);
2040}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002042/*
2043 * The display part of msg_puts_attr_len().
2044 * May be called recursively to display scroll-back text.
2045 */
2046 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002047msg_puts_display(
2048 char_u *str,
2049 int maxlen,
2050 int attr,
2051 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002052{
2053 char_u *s = str;
2054 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2055 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
2056#ifdef FEAT_MBYTE
2057 int l;
2058 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002060 char_u *sb_str = str;
2061 int sb_col = msg_col;
2062 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002063 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064
2065 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002066 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 {
2068 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002069 * We are at the end of the screen line when:
2070 * - When outputting a newline.
2071 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002073 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074#ifdef FEAT_RIGHTLEFT
2075 cmdmsg_rl
2076 ? (
2077 msg_col <= 1
2078 || (*s == TAB && msg_col <= 7)
2079# ifdef FEAT_MBYTE
2080 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
2081# endif
2082 )
2083 :
2084#endif
2085 (msg_col + t_col >= Columns - 1
2086 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
2087# ifdef FEAT_MBYTE
2088 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2089 && msg_col + t_col >= Columns - 2)
2090# endif
2091 ))))
2092 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002093 /*
2094 * The screen is scrolled up when at the last row (some terminals
2095 * scroll automatically, some don't. To avoid problems we scroll
2096 * ourselves).
2097 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002100 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002102 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 if (msg_no_more && lines_left == 0)
2104 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002106 /* Scroll the screen up one line. */
2107 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108
2109 msg_row = Rows - 2;
2110 if (msg_col >= Columns) /* can happen after screen resize */
2111 msg_col = Columns - 1;
2112
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002113 /* Display char in last column before showing more-prompt. */
2114 if (*s >= ' '
2115#ifdef FEAT_RIGHTLEFT
2116 && !cmdmsg_rl
2117#endif
2118 )
2119 {
2120#ifdef FEAT_MBYTE
2121 if (has_mbyte)
2122 {
2123 if (enc_utf8 && maxlen >= 0)
2124 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002125 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002126 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002127 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002128 s = screen_puts_mbyte(s, l, attr);
2129 }
2130 else
2131#endif
2132 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002133 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002134 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002135 else
2136 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002137
2138 if (p_more)
2139 /* store text for scrolling back */
2140 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2141
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002142 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002143 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 redraw_cmdline = TRUE;
2145 if (cmdline_row > 0 && !exmode_active)
2146 --cmdline_row;
2147
2148 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002149 * If screen is completely filled and 'more' is set then wait
2150 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002152 if (lines_left > 0)
2153 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002154 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 && !msg_no_more && !exmode_active)
2156 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002158 if (do_more_prompt(NUL))
2159 s = confirm_msg_tail;
2160#else
2161 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162#endif
2163 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002164 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002166
2167 /* When we displayed a char in last column need to check if there
2168 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002169 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002170 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 }
2172
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002173 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 || msg_col + t_col >= Columns
2175#ifdef FEAT_MBYTE
2176 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2177 && msg_col + t_col >= Columns - 1)
2178#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002179 ;
2180 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2181 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002183 t_puts(&t_col, t_s, s, attr);
2184
2185 if (wrap && p_more && !recurse)
2186 /* store text for scrolling back */
2187 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188
2189 if (*s == '\n') /* go to next line */
2190 {
2191 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002192#ifdef FEAT_RIGHTLEFT
2193 if (cmdmsg_rl)
2194 msg_col = Columns - 1;
2195 else
2196#endif
2197 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 if (++msg_row >= Rows) /* safety check */
2199 msg_row = Rows - 1;
2200 }
2201 else if (*s == '\r') /* go to column 0 */
2202 {
2203 msg_col = 0;
2204 }
2205 else if (*s == '\b') /* go to previous char */
2206 {
2207 if (msg_col)
2208 --msg_col;
2209 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002210 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 {
2212 do
2213 msg_screen_putchar(' ', attr);
2214 while (msg_col & 7);
2215 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002216 else if (*s == BELL) /* beep (from ":sh") */
2217 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 else
2219 {
2220#ifdef FEAT_MBYTE
2221 if (has_mbyte)
2222 {
2223 cw = (*mb_ptr2cells)(s);
2224 if (enc_utf8 && maxlen >= 0)
2225 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002226 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002228 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 }
2230 else
2231 {
2232 cw = 1;
2233 l = 1;
2234 }
2235#endif
2236 /* When drawing from right to left or when a double-wide character
2237 * doesn't fit, draw a single character here. Otherwise collect
2238 * characters and draw them all at once later. */
2239#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2240 if (
2241# ifdef FEAT_RIGHTLEFT
2242 cmdmsg_rl
2243# ifdef FEAT_MBYTE
2244 ||
2245# endif
2246# endif
2247# ifdef FEAT_MBYTE
2248 (cw > 1 && msg_col + t_col >= Columns - 1)
2249# endif
2250 )
2251 {
2252# ifdef FEAT_MBYTE
2253 if (l > 1)
2254 s = screen_puts_mbyte(s, l, attr) - 1;
2255 else
2256# endif
2257 msg_screen_putchar(*s, attr);
2258 }
2259 else
2260#endif
2261 {
2262 /* postpone this character until later */
2263 if (t_col == 0)
2264 t_s = s;
2265#ifdef FEAT_MBYTE
2266 t_col += cw;
2267 s += l - 1;
2268#else
2269 ++t_col;
2270#endif
2271 }
2272 }
2273 ++s;
2274 }
2275
2276 /* output any postponed text */
2277 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002278 t_puts(&t_col, t_s, s, attr);
2279 if (p_more && !recurse)
2280 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281
2282 msg_check();
2283}
2284
2285/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002286 * Return TRUE when ":filter pattern" was used and "msg" does not match
2287 * "pattern".
2288 */
2289 int
2290message_filtered(char_u *msg)
2291{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002292 int match;
2293
2294 if (cmdmod.filter_regmatch.regprog == NULL)
2295 return FALSE;
2296 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2297 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002298}
2299
2300/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002301 * Scroll the screen up one line for displaying the next message line.
2302 */
2303 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002304msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002305{
2306#ifdef FEAT_GUI
2307 /* Remove the cursor before scrolling, ScreenLines[] is going
2308 * to become invalid. */
2309 if (gui.in_use)
2310 gui_undraw_cursor();
2311#endif
2312 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002313 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002314 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002315 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002316
2317 if (!can_clear((char_u *)" "))
2318 {
2319 /* Scrolling up doesn't result in the right background. Set the
2320 * background here. It's not efficient, but avoids that we have to do
2321 * it all over the code. */
2322 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2323
2324 /* Also clear the last char of the last but one line if it was not
2325 * cleared before to avoid a scroll-up. */
2326 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2327 screen_fill((int)Rows - 2, (int)Rows - 1,
2328 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2329 }
2330}
2331
2332/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002333 * Increment "msg_scrolled".
2334 */
2335 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002336inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002337{
2338#ifdef FEAT_EVAL
2339 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2340 {
2341 char_u *p = sourcing_name;
2342 char_u *tofree = NULL;
2343 int len;
2344
2345 /* v:scrollstart is empty, set it to the script/function name and line
2346 * number */
2347 if (p == NULL)
2348 p = (char_u *)_("Unknown");
2349 else
2350 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002351 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002352 tofree = alloc(len);
2353 if (tofree != NULL)
2354 {
2355 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2356 p, (long)sourcing_lnum);
2357 p = tofree;
2358 }
2359 }
2360 set_vim_var_string(VV_SCROLLSTART, p, -1);
2361 vim_free(tofree);
2362 }
2363#endif
2364 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002365 if (must_redraw < VALID)
2366 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002367}
2368
2369/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002370 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2371 * store the displayed text and remember where screen lines start.
2372 */
2373typedef struct msgchunk_S msgchunk_T;
2374struct msgchunk_S
2375{
2376 msgchunk_T *sb_next;
2377 msgchunk_T *sb_prev;
2378 char sb_eol; /* TRUE when line ends after this text */
2379 int sb_msg_col; /* column in which text starts */
2380 int sb_attr; /* text attributes */
2381 char_u sb_text[1]; /* text to be displayed, actually longer */
2382};
2383
2384static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2385
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002386static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2387static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002388
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002389typedef enum {
2390 SB_CLEAR_NONE = 0,
2391 SB_CLEAR_ALL,
2392 SB_CLEAR_CMDLINE_BUSY,
2393 SB_CLEAR_CMDLINE_DONE
2394} sb_clear_T;
2395
2396/* When to clear text on next msg. */
2397static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002398
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002399/*
2400 * Store part of a printed message for displaying when scrolling back.
2401 */
2402 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002403store_sb_text(
2404 char_u **sb_str, /* start of string */
2405 char_u *s, /* just after string */
2406 int attr,
2407 int *sb_col,
2408 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002409{
2410 msgchunk_T *mp;
2411
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002412 if (do_clear_sb_text == SB_CLEAR_ALL
2413 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002414 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002415 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2416 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002417 }
2418
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002419 if (s > *sb_str)
2420 {
2421 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2422 if (mp != NULL)
2423 {
2424 mp->sb_eol = finish;
2425 mp->sb_msg_col = *sb_col;
2426 mp->sb_attr = attr;
2427 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2428
2429 if (last_msgchunk == NULL)
2430 {
2431 last_msgchunk = mp;
2432 mp->sb_prev = NULL;
2433 }
2434 else
2435 {
2436 mp->sb_prev = last_msgchunk;
2437 last_msgchunk->sb_next = mp;
2438 last_msgchunk = mp;
2439 }
2440 mp->sb_next = NULL;
2441 }
2442 }
2443 else if (finish && last_msgchunk != NULL)
2444 last_msgchunk->sb_eol = TRUE;
2445
2446 *sb_str = s;
2447 *sb_col = 0;
2448}
2449
2450/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002451 * Finished showing messages, clear the scroll-back text on the next message.
2452 */
2453 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002454may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002455{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002456 do_clear_sb_text = SB_CLEAR_ALL;
2457}
2458
2459/*
2460 * Starting to edit the command line, do not clear messages now.
2461 */
2462 void
2463sb_text_start_cmdline(void)
2464{
2465 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2466 msg_sb_eol();
2467}
2468
2469/*
2470 * Ending to edit the command line. Clear old lines but the last one later.
2471 */
2472 void
2473sb_text_end_cmdline(void)
2474{
2475 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002476}
2477
2478/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002479 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002480 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002481 * Called when redrawing the screen.
2482 */
2483 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002484clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002485{
2486 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002487 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002488
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002489 if (all)
2490 lastp = &last_msgchunk;
2491 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002492 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002493 if (last_msgchunk == NULL)
2494 return;
2495 lastp = &last_msgchunk->sb_prev;
2496 }
2497
2498 while (*lastp != NULL)
2499 {
2500 mp = (*lastp)->sb_prev;
2501 vim_free(*lastp);
2502 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002503 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002504}
2505
2506/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002507 * "g<" command.
2508 */
2509 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002510show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002511{
2512 msgchunk_T *mp;
2513
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002514 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002515 * weird, typing a command without output results in one line. */
2516 mp = msg_sb_start(last_msgchunk);
2517 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002518 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002519 else
2520 {
2521 do_more_prompt('G');
2522 wait_return(FALSE);
2523 }
2524}
2525
2526/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002527 * Move to the start of screen line in already displayed text.
2528 */
2529 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002530msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002531{
2532 msgchunk_T *mp = mps;
2533
2534 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2535 mp = mp->sb_prev;
2536 return mp;
2537}
2538
2539/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002540 * Mark the last message chunk as finishing the line.
2541 */
2542 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002543msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002544{
2545 if (last_msgchunk != NULL)
2546 last_msgchunk->sb_eol = TRUE;
2547}
2548
2549/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002550 * Display a screen line from previously displayed text at row "row".
2551 * Returns a pointer to the text for the next line (can be NULL).
2552 */
2553 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002554disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002555{
2556 msgchunk_T *mp = smp;
2557 char_u *p;
2558
2559 for (;;)
2560 {
2561 msg_row = row;
2562 msg_col = mp->sb_msg_col;
2563 p = mp->sb_text;
2564 if (*p == '\n') /* don't display the line break */
2565 ++p;
2566 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2567 if (mp->sb_eol || mp->sb_next == NULL)
2568 break;
2569 mp = mp->sb_next;
2570 }
2571 return mp->sb_next;
2572}
2573
2574/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 * Output any postponed text for msg_puts_attr_len().
2576 */
2577 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002578t_puts(
2579 int *t_col,
2580 char_u *t_s,
2581 char_u *s,
2582 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583{
2584 /* output postponed text */
2585 msg_didout = TRUE; /* remember that line is not empty */
2586 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002587 msg_col += *t_col;
2588 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589#ifdef FEAT_MBYTE
2590 /* If the string starts with a composing character don't increment the
2591 * column position for it. */
2592 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2593 --msg_col;
2594#endif
2595 if (msg_col >= Columns)
2596 {
2597 msg_col = 0;
2598 ++msg_row;
2599 }
2600}
2601
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602/*
2603 * Returns TRUE when messages should be printed with mch_errmsg().
2604 * This is used when there is no valid screen, so we can see error messages.
2605 * If termcap is not active, we may be writing in an alternate console
2606 * window, cursor positioning may not work correctly (window size may be
2607 * different, e.g. for Win32 console) or we just don't know where the
2608 * cursor is.
2609 */
2610 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002611msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612{
2613 return (!msg_check_screen()
2614#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2615 || !termcap_active
2616#endif
2617 || (swapping_screen() && !termcap_active)
2618 );
2619}
2620
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002621/*
2622 * Print a message when there is no valid screen.
2623 */
2624 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002625msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002626{
2627 char_u *s = str;
2628 char_u buf[4];
2629 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002630#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002631# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2632 char_u *ccp = NULL;
2633
2634# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002635 if (!(silent_mode && p_verbose == 0))
2636 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002637
2638# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2639 if (enc_codepage >= 0 && (int)GetConsoleCP() != enc_codepage)
2640 {
Bram Moolenaar116a0f82017-08-07 21:17:57 +02002641 int inlen = (int)STRLEN(str);
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002642 int outlen;
2643 WCHAR *widestr = (WCHAR *)enc_to_utf16(str, &inlen);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002644
2645 if (widestr != NULL)
2646 {
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002647 WideCharToMultiByte_alloc(GetConsoleCP(), 0, widestr, inlen,
2648 (LPSTR *)&ccp, &outlen, 0, 0);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002649 vim_free(widestr);
2650 s = str = ccp;
2651 }
2652 }
2653# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002654#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002655 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002656 {
2657 if (!(silent_mode && p_verbose == 0))
2658 {
2659 /* NL --> CR NL translation (for Unix, not for "--version") */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002660 p = &buf[0];
2661 if (*s == '\n' && !info_message)
2662 *p++ = '\r';
Bram Moolenaard0573012017-10-28 21:11:06 +02002663#if defined(USE_CR)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002664 else
2665#endif
2666 *p++ = *s;
2667 *p = '\0';
2668 if (info_message) /* informative message, not an error */
2669 mch_msg((char *)buf);
2670 else
2671 mch_errmsg((char *)buf);
2672 }
2673
2674 /* primitive way to compute the current column */
2675#ifdef FEAT_RIGHTLEFT
2676 if (cmdmsg_rl)
2677 {
2678 if (*s == '\r' || *s == '\n')
2679 msg_col = Columns - 1;
2680 else
2681 --msg_col;
2682 }
2683 else
2684#endif
2685 {
2686 if (*s == '\r' || *s == '\n')
2687 msg_col = 0;
2688 else
2689 ++msg_col;
2690 }
2691 ++s;
2692 }
2693 msg_didout = TRUE; /* assume that line is not empty */
2694
2695#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002696# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2697 vim_free(ccp);
2698# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002699 if (!(silent_mode && p_verbose == 0))
2700 mch_settmode(TMODE_RAW);
2701#endif
2702}
2703
2704/*
2705 * Show the more-prompt and handle the user response.
2706 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002707 * When at hit-enter prompt "typed_char" is the already typed character,
2708 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002709 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2710 */
2711 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002712do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002713{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002714 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002715 int used_typed_char = typed_char;
2716 int oldState = State;
2717 int c;
2718#ifdef FEAT_CON_DIALOG
2719 int retval = FALSE;
2720#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002721 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002722 msgchunk_T *mp_last = NULL;
2723 msgchunk_T *mp;
2724 int i;
2725
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002726 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002727 * that case don't show another prompt. Also when at the hit-Enter prompt
2728 * and nothing was typed. */
2729 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002730 return FALSE;
2731 entered = TRUE;
2732
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002733 if (typed_char == 'G')
2734 {
2735 /* "g<": Find first line on the last page. */
2736 mp_last = msg_sb_start(last_msgchunk);
2737 for (i = 0; i < Rows - 2 && mp_last != NULL
2738 && mp_last->sb_prev != NULL; ++i)
2739 mp_last = msg_sb_start(mp_last->sb_prev);
2740 }
2741
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002742 State = ASKMORE;
2743#ifdef FEAT_MOUSE
2744 setmouse();
2745#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002746 if (typed_char == NUL)
2747 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002748 for (;;)
2749 {
2750 /*
2751 * Get a typed character directly from the user.
2752 */
2753 if (used_typed_char != NUL)
2754 {
2755 c = used_typed_char; /* was typed at hit-enter prompt */
2756 used_typed_char = NUL;
2757 }
2758 else
2759 c = get_keystroke();
2760
2761#if defined(FEAT_MENU) && defined(FEAT_GUI)
2762 if (c == K_MENU)
2763 {
2764 int idx = get_menu_index(current_menu, ASKMORE);
2765
2766 /* Used a menu. If it starts with CTRL-Y, it must
2767 * be a "Copy" for the clipboard. Otherwise
2768 * assume that we end */
2769 if (idx == MENU_INDEX_INVALID)
2770 continue;
2771 c = *current_menu->strings[idx];
2772 if (c != NUL && current_menu->strings[idx][1] != NUL)
2773 ins_typebuf(current_menu->strings[idx] + 1,
2774 current_menu->noremap[idx], 0, TRUE,
2775 current_menu->silent[idx]);
2776 }
2777#endif
2778
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002779 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002780 switch (c)
2781 {
2782 case BS: /* scroll one line back */
2783 case K_BS:
2784 case 'k':
2785 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002786 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002787 break;
2788
2789 case CAR: /* one extra line */
2790 case NL:
2791 case 'j':
2792 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002793 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002794 break;
2795
2796 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002797 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002798 break;
2799
2800 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002801 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002802 break;
2803
2804 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002805 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002806 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002807 break;
2808
2809 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002810 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002811 case K_PAGEDOWN:
2812 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002813 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002814 break;
2815
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002816 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002817 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002818 break;
2819
2820 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002821 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002822 lines_left = 999999;
2823 break;
2824
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002825 case ':': /* start new command line */
2826#ifdef FEAT_CON_DIALOG
2827 if (!confirm_msg_used)
2828#endif
2829 {
2830 /* Since got_int is set all typeahead will be flushed, but we
2831 * want to keep this ':', remember that in a special way. */
2832 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002833#ifdef FEAT_TERMINAL
2834 skip_term_loop = TRUE;
2835#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002836 cmdline_row = Rows - 1; /* put ':' on this line */
2837 skip_redraw = TRUE; /* skip redraw once */
2838 need_wait_return = FALSE; /* don't wait in main() */
2839 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002840 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002841 case 'q': /* quit */
2842 case Ctrl_C:
2843 case ESC:
2844#ifdef FEAT_CON_DIALOG
2845 if (confirm_msg_used)
2846 {
2847 /* Jump to the choices of the dialog. */
2848 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002849 }
2850 else
2851#endif
2852 {
2853 got_int = TRUE;
2854 quit_more = TRUE;
2855 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002856 /* When there is some more output (wrapping line) display that
2857 * without another prompt. */
2858 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002859 break;
2860
2861#ifdef FEAT_CLIPBOARD
2862 case Ctrl_Y:
2863 /* Strange way to allow copying (yanking) a modeless
2864 * selection at the more prompt. Use CTRL-Y,
2865 * because the same is used in Cmdline-mode and at the
2866 * hit-enter prompt. However, scrolling one line up
2867 * might be expected... */
2868 if (clip_star.state == SELECT_DONE)
2869 clip_copy_modeless_selection(TRUE);
2870 continue;
2871#endif
2872 default: /* no valid response */
2873 msg_moremsg(TRUE);
2874 continue;
2875 }
2876
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002877 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002878 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002879 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002880 {
2881 /* go to start of last line */
2882 if (mp_last == NULL)
2883 mp = msg_sb_start(last_msgchunk);
2884 else if (mp_last->sb_prev != NULL)
2885 mp = msg_sb_start(mp_last->sb_prev);
2886 else
2887 mp = NULL;
2888
2889 /* go to start of line at top of the screen */
2890 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2891 ++i)
2892 mp = msg_sb_start(mp->sb_prev);
2893
2894 if (mp != NULL && mp->sb_prev != NULL)
2895 {
2896 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002897 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002898 {
2899 if (mp == NULL || mp->sb_prev == NULL)
2900 break;
2901 mp = msg_sb_start(mp->sb_prev);
2902 if (mp_last == NULL)
2903 mp_last = msg_sb_start(last_msgchunk);
2904 else
2905 mp_last = msg_sb_start(mp_last->sb_prev);
2906 }
2907
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002908 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002909 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002910 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002911 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002912 (void)disp_sb_line(0, mp);
2913 }
2914 else
2915 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002916 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002917 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002918 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2919 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002920 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002921 ++msg_scrolled;
2922 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002923 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002924 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002925 }
2926 }
2927 else
2928 {
2929 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002930 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002931 {
2932 /* scroll up, display line at bottom */
2933 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002934 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002935 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2936 (int)Columns, ' ', ' ', 0);
2937 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002938 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002939 }
2940 }
2941
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002942 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002943 {
2944 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002945 screen_fill((int)Rows - 1, (int)Rows, 0,
2946 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002947 msg_moremsg(FALSE);
2948 continue;
2949 }
2950
2951 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002952 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002953 }
2954
2955 break;
2956 }
2957
2958 /* clear the --more-- message */
2959 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2960 State = oldState;
2961#ifdef FEAT_MOUSE
2962 setmouse();
2963#endif
2964 if (quit_more)
2965 {
2966 msg_row = Rows - 1;
2967 msg_col = 0;
2968 }
2969#ifdef FEAT_RIGHTLEFT
2970 else if (cmdmsg_rl)
2971 msg_col = Columns - 1;
2972#endif
2973
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002974 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002975#ifdef FEAT_CON_DIALOG
2976 return retval;
2977#else
2978 return FALSE;
2979#endif
2980}
2981
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2983
2984#ifdef mch_errmsg
2985# undef mch_errmsg
2986#endif
2987#ifdef mch_msg
2988# undef mch_msg
2989#endif
2990
2991/*
2992 * Give an error message. To be used when the screen hasn't been initialized
2993 * yet. When stderr can't be used, collect error messages until the GUI has
2994 * started and they can be displayed in a message box.
2995 */
2996 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002997mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998{
2999 int len;
3000
3001#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3002 /* On Unix use stderr if it's a tty.
3003 * When not going to start the GUI also use stderr.
3004 * On Mac, when started from Finder, stderr is the console. */
3005 if (
3006# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003007# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3009# else
3010 isatty(2)
3011# endif
3012# ifdef FEAT_GUI
3013 ||
3014# endif
3015# endif
3016# ifdef FEAT_GUI
3017 !(gui.in_use || gui.starting)
3018# endif
3019 )
3020 {
3021 fprintf(stderr, "%s", str);
3022 return;
3023 }
3024#endif
3025
3026 /* avoid a delay for a message that isn't there */
3027 emsg_on_display = FALSE;
3028
3029 len = (int)STRLEN(str) + 1;
3030 if (error_ga.ga_growsize == 0)
3031 {
3032 error_ga.ga_growsize = 80;
3033 error_ga.ga_itemsize = 1;
3034 }
3035 if (ga_grow(&error_ga, len) == OK)
3036 {
3037 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3038 (char_u *)str, len);
3039#ifdef UNIX
3040 /* remove CR characters, they are displayed */
3041 {
3042 char_u *p;
3043
3044 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3045 for (;;)
3046 {
3047 p = vim_strchr(p, '\r');
3048 if (p == NULL)
3049 break;
3050 *p = ' ';
3051 }
3052 }
3053#endif
3054 --len; /* don't count the NUL at the end */
3055 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 }
3057}
3058
3059/*
3060 * Give a message. To be used when the screen hasn't been initialized yet.
3061 * When there is no tty, collect messages until the GUI has started and they
3062 * can be displayed in a message box.
3063 */
3064 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003065mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066{
3067#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3068 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3069 * uses mch_errmsg() when started from the desktop.
3070 * When not going to start the GUI also use stdout.
3071 * On Mac, when started from Finder, stderr is the console. */
3072 if (
3073# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003074# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3076# else
3077 isatty(2)
3078# endif
3079# ifdef FEAT_GUI
3080 ||
3081# endif
3082# endif
3083# ifdef FEAT_GUI
3084 !(gui.in_use || gui.starting)
3085# endif
3086 )
3087 {
3088 printf("%s", str);
3089 return;
3090 }
3091# endif
3092 mch_errmsg(str);
3093}
3094#endif /* USE_MCH_ERRMSG */
3095
3096/*
3097 * Put a character on the screen at the current message position and advance
3098 * to the next position. Only for printable ASCII!
3099 */
3100 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003101msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102{
3103 msg_didout = TRUE; /* remember that line is not empty */
3104 screen_putchar(c, msg_row, msg_col, attr);
3105#ifdef FEAT_RIGHTLEFT
3106 if (cmdmsg_rl)
3107 {
3108 if (--msg_col == 0)
3109 {
3110 msg_col = Columns;
3111 ++msg_row;
3112 }
3113 }
3114 else
3115#endif
3116 {
3117 if (++msg_col >= Columns)
3118 {
3119 msg_col = 0;
3120 ++msg_row;
3121 }
3122 }
3123}
3124
3125 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003126msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003128 int attr;
3129 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130
Bram Moolenaar8820b482017-03-16 17:23:31 +01003131 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003132 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003134 screen_puts((char_u *)
3135 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3136 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137}
3138
3139/*
3140 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3141 * exmode_active.
3142 */
3143 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003144repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145{
3146 if (State == ASKMORE)
3147 {
3148 msg_moremsg(TRUE); /* display --more-- message again */
3149 msg_row = Rows - 1;
3150 }
3151#ifdef FEAT_CON_DIALOG
3152 else if (State == CONFIRM)
3153 {
3154 display_confirm_msg(); /* display ":confirm" message again */
3155 msg_row = Rows - 1;
3156 }
3157#endif
3158 else if (State == EXTERNCMD)
3159 {
3160 windgoto(msg_row, msg_col); /* put cursor back */
3161 }
3162 else if (State == HITRETURN || State == SETWSIZE)
3163 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003164 if (msg_row == Rows - 1)
3165 {
3166 /* Avoid drawing the "hit-enter" prompt below the previous one,
3167 * overwrite it. Esp. useful when regaining focus and a
3168 * FocusGained autocmd exists but didn't draw anything. */
3169 msg_didout = FALSE;
3170 msg_col = 0;
3171 msg_clr_eos();
3172 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 hit_return_msg();
3174 msg_row = Rows - 1;
3175 }
3176}
3177
3178/*
3179 * msg_check_screen - check if the screen is initialized.
3180 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3181 * While starting the GUI the terminal codes will be set for the GUI, but the
3182 * output goes to the terminal. Don't use the terminal codes then.
3183 */
3184 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003185msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186{
3187 if (!full_screen || !screen_valid(FALSE))
3188 return FALSE;
3189
3190 if (msg_row >= Rows)
3191 msg_row = Rows - 1;
3192 if (msg_col >= Columns)
3193 msg_col = Columns - 1;
3194 return TRUE;
3195}
3196
3197/*
3198 * Clear from current message position to end of screen.
3199 * Skip this when ":silent" was used, no need to clear for redirection.
3200 */
3201 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003202msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203{
3204 if (msg_silent == 0)
3205 msg_clr_eos_force();
3206}
3207
3208/*
3209 * Clear from current message position to end of screen.
3210 * Note: msg_col is not updated, so we remember the end of the message
3211 * for msg_check().
3212 */
3213 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003214msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215{
3216 if (msg_use_printf())
3217 {
3218 if (full_screen) /* only when termcap codes are valid */
3219 {
3220 if (*T_CD)
3221 out_str(T_CD); /* clear to end of display */
3222 else if (*T_CE)
3223 out_str(T_CE); /* clear to end of line */
3224 }
3225 }
3226 else
3227 {
3228#ifdef FEAT_RIGHTLEFT
3229 if (cmdmsg_rl)
3230 {
3231 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3232 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3233 }
3234 else
3235#endif
3236 {
3237 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3238 ' ', ' ', 0);
3239 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3240 }
3241 }
3242}
3243
3244/*
3245 * Clear the command line.
3246 */
3247 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003248msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249{
3250 msg_row = cmdline_row;
3251 msg_col = 0;
3252 msg_clr_eos_force();
3253}
3254
3255/*
3256 * end putting a message on the screen
3257 * call wait_return if the message does not fit in the available space
3258 * return TRUE if wait_return not called.
3259 */
3260 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003261msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262{
3263 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003264 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 * or the ruler option is set and we run into it,
3266 * we have to redraw the window.
3267 * Do not do this if we are abandoning the file or editing the command line.
3268 */
3269 if (!exiting && need_wait_return && !(State & CMDLINE))
3270 {
3271 wait_return(FALSE);
3272 return FALSE;
3273 }
3274 out_flush();
3275 return TRUE;
3276}
3277
3278/*
3279 * If the written message runs into the shown command or ruler, we have to
3280 * wait for hit-return and redraw the window later.
3281 */
3282 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003283msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284{
3285 if (msg_row == Rows - 1 && msg_col >= sc_col)
3286 {
3287 need_wait_return = TRUE;
3288 redraw_cmdline = TRUE;
3289 }
3290}
3291
3292/*
3293 * May write a string to the redirection file.
3294 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3295 */
3296 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003297redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298{
3299 char_u *s = str;
3300 static int cur_col = 0;
3301
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003302 /* Don't do anything for displaying prompts and the like. */
3303 if (redir_off)
3304 return;
3305
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003306 /* If 'verbosefile' is set prepare for writing in that file. */
3307 if (*p_vfile != NUL && verbose_fd == NULL)
3308 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003309
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003310 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 {
3312 /* If the string doesn't start with CR or NL, go to msg_col */
3313 if (*s != '\n' && *s != '\r')
3314 {
3315 while (cur_col < msg_col)
3316 {
3317#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003318 if (redir_execute)
3319 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003320 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003322 else if (redir_vname)
3323 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003324 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003326 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003328 if (verbose_fd != NULL)
3329 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 ++cur_col;
3331 }
3332 }
3333
3334#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003335 if (redir_execute)
3336 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003337 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003339 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003340 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341#endif
3342
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003343 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3345 {
3346#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003347 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003349 if (redir_fd != NULL)
3350 putc(*s, redir_fd);
3351 if (verbose_fd != NULL)
3352 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 if (*s == '\r' || *s == '\n')
3354 cur_col = 0;
3355 else if (*s == '\t')
3356 cur_col += (8 - cur_col % 8);
3357 else
3358 ++cur_col;
3359 ++s;
3360 }
3361
3362 if (msg_silent != 0) /* should update msg_col */
3363 msg_col = cur_col;
3364 }
3365}
3366
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003367 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003368redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003369{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003370 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003371#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003372 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003373#endif
3374 ;
3375}
3376
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003378 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003379 * Must always be called paired with verbose_leave()!
3380 */
3381 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003382verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003383{
3384 if (*p_vfile != NUL)
3385 ++msg_silent;
3386}
3387
3388/*
3389 * After giving verbose message.
3390 * Must always be called paired with verbose_enter()!
3391 */
3392 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003393verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003394{
3395 if (*p_vfile != NUL)
3396 if (--msg_silent < 0)
3397 msg_silent = 0;
3398}
3399
3400/*
3401 * Like verbose_enter() and set msg_scroll when displaying the message.
3402 */
3403 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003404verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003405{
3406 if (*p_vfile != NUL)
3407 ++msg_silent;
3408 else
3409 /* always scroll up, don't overwrite */
3410 msg_scroll = TRUE;
3411}
3412
3413/*
3414 * Like verbose_leave() and set cmdline_row when displaying the message.
3415 */
3416 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003417verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003418{
3419 if (*p_vfile != NUL)
3420 {
3421 if (--msg_silent < 0)
3422 msg_silent = 0;
3423 }
3424 else
3425 cmdline_row = msg_row;
3426}
3427
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003428/*
3429 * Called when 'verbosefile' is set: stop writing to the file.
3430 */
3431 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003432verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003433{
3434 if (verbose_fd != NULL)
3435 {
3436 fclose(verbose_fd);
3437 verbose_fd = NULL;
3438 }
3439 verbose_did_open = FALSE;
3440}
3441
3442/*
3443 * Open the file 'verbosefile'.
3444 * Return FAIL or OK.
3445 */
3446 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003447verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003448{
3449 if (verbose_fd == NULL && !verbose_did_open)
3450 {
3451 /* Only give the error message once. */
3452 verbose_did_open = TRUE;
3453
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003454 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003455 if (verbose_fd == NULL)
3456 {
3457 EMSG2(_(e_notopen), p_vfile);
3458 return FAIL;
3459 }
3460 }
3461 return OK;
3462}
3463
3464/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 * Give a warning message (for searching).
3466 * Use 'w' highlighting and may repeat the message after redrawing
3467 */
3468 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003469give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470{
3471 /* Don't do this for ":silent". */
3472 if (msg_silent != 0)
3473 return;
3474
3475 /* Don't want a hit-enter prompt here. */
3476 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003477
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478#ifdef FEAT_EVAL
3479 set_vim_var_string(VV_WARNINGMSG, message, -1);
3480#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003481 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003483 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 else
3485 keep_msg_attr = 0;
3486 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003487 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 msg_didout = FALSE; /* overwrite this message */
3489 msg_nowait = TRUE; /* don't wait for this message */
3490 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003491
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 --no_wait_return;
3493}
3494
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003495 void
3496give_warning2(char_u *message, char_u *a1, int hl)
3497{
3498 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3499 give_warning(IObuff, hl);
3500}
3501
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502/*
3503 * Advance msg cursor to column "col".
3504 */
3505 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003506msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507{
3508 if (msg_silent != 0) /* nothing to advance to */
3509 {
3510 msg_col = col; /* for redirection, may fill it up later */
3511 return;
3512 }
3513 if (col >= Columns) /* not enough room */
3514 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003515#ifdef FEAT_RIGHTLEFT
3516 if (cmdmsg_rl)
3517 while (msg_col > Columns - col)
3518 msg_putchar(' ');
3519 else
3520#endif
3521 while (msg_col < col)
3522 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523}
3524
3525#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3526/*
3527 * Used for "confirm()" function, and the :confirm command prefix.
3528 * Versions which haven't got flexible dialogs yet, and console
3529 * versions, get this generic handler which uses the command line.
3530 *
3531 * type = one of:
3532 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3533 * title = title string (can be NULL for default)
3534 * (neither used in console dialogs at the moment)
3535 *
3536 * Format of the "buttons" string:
3537 * "Button1Name\nButton2Name\nButton3Name"
3538 * The first button should normally be the default/accept
3539 * The second button should be the 'Cancel' button
3540 * Other buttons- use your imagination!
3541 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3542 * different letter.
3543 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003545do_dialog(
3546 int type UNUSED,
3547 char_u *title UNUSED,
3548 char_u *message,
3549 char_u *buttons,
3550 int dfltbutton,
3551 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003552 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003553 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003554 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555{
3556 int oldState;
3557 int retval = 0;
3558 char_u *hotkeys;
3559 int c;
3560 int i;
3561
3562#ifndef NO_CONSOLE
3563 /* Don't output anything in silent mode ("ex -s") */
3564 if (silent_mode)
3565 return dfltbutton; /* return default option */
3566#endif
3567
3568#ifdef FEAT_GUI_DIALOG
3569 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3570 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3571 {
3572 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003573 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003574 /* avoid a hit-enter prompt without clearing the cmdline */
3575 need_wait_return = FALSE;
3576 emsg_on_display = FALSE;
3577 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
3579 /* Flush output to avoid that further messages and redrawing is done
3580 * in the wrong order. */
3581 out_flush();
3582 gui_mch_update();
3583
3584 return c;
3585 }
3586#endif
3587
3588 oldState = State;
3589 State = CONFIRM;
3590#ifdef FEAT_MOUSE
3591 setmouse();
3592#endif
3593
3594 /*
3595 * Since we wait for a keypress, don't make the
3596 * user press RETURN as well afterwards.
3597 */
3598 ++no_wait_return;
3599 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3600
3601 if (hotkeys != NULL)
3602 {
3603 for (;;)
3604 {
3605 /* Get a typed character directly from the user. */
3606 c = get_keystroke();
3607 switch (c)
3608 {
3609 case CAR: /* User accepts default option */
3610 case NL:
3611 retval = dfltbutton;
3612 break;
3613 case Ctrl_C: /* User aborts/cancels */
3614 case ESC:
3615 retval = 0;
3616 break;
3617 default: /* Could be a hotkey? */
3618 if (c < 0) /* special keys are ignored here */
3619 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003620 if (c == ':' && ex_cmd)
3621 {
3622 retval = dfltbutton;
3623 ins_char_typebuf(':');
3624 break;
3625 }
3626
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 /* Make the character lowercase, as chars in "hotkeys" are. */
3628 c = MB_TOLOWER(c);
3629 retval = 1;
3630 for (i = 0; hotkeys[i]; ++i)
3631 {
3632#ifdef FEAT_MBYTE
3633 if (has_mbyte)
3634 {
3635 if ((*mb_ptr2char)(hotkeys + i) == c)
3636 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003637 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 }
3639 else
3640#endif
3641 if (hotkeys[i] == c)
3642 break;
3643 ++retval;
3644 }
3645 if (hotkeys[i])
3646 break;
3647 /* No hotkey match, so keep waiting */
3648 continue;
3649 }
3650 break;
3651 }
3652
3653 vim_free(hotkeys);
3654 }
3655
3656 State = oldState;
3657#ifdef FEAT_MOUSE
3658 setmouse();
3659#endif
3660 --no_wait_return;
3661 msg_end_prompt();
3662
3663 return retval;
3664}
3665
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003666static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667
3668/*
3669 * Copy one character from "*from" to "*to", taking care of multi-byte
3670 * characters. Return the length of the character in bytes.
3671 */
3672 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003673copy_char(
3674 char_u *from,
3675 char_u *to,
3676 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677{
3678#ifdef FEAT_MBYTE
3679 int len;
3680 int c;
3681
3682 if (has_mbyte)
3683 {
3684 if (lowercase)
3685 {
3686 c = MB_TOLOWER((*mb_ptr2char)(from));
3687 return (*mb_char2bytes)(c, to);
3688 }
3689 else
3690 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003691 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 mch_memmove(to, from, (size_t)len);
3693 return len;
3694 }
3695 }
3696 else
3697#endif
3698 {
3699 if (lowercase)
3700 *to = (char_u)TOLOWER_LOC(*from);
3701 else
3702 *to = *from;
3703 return 1;
3704 }
3705}
3706
3707/*
3708 * Format the dialog string, and display it at the bottom of
3709 * the screen. Return a string of hotkey chars (if defined) for
3710 * each 'button'. If a button has no hotkey defined, the first character of
3711 * the button is used.
3712 * The hotkeys can be multi-byte characters, but without combining chars.
3713 *
3714 * Returns an allocated string with hotkeys, or NULL for error.
3715 */
3716 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003717msg_show_console_dialog(
3718 char_u *message,
3719 char_u *buttons,
3720 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721{
3722 int len = 0;
3723#ifdef FEAT_MBYTE
3724# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3725#else
3726# define HOTK_LEN 1
3727#endif
3728 int lenhotkey = HOTK_LEN; /* count first button */
3729 char_u *hotk = NULL;
3730 char_u *msgp = NULL;
3731 char_u *hotkp = NULL;
3732 char_u *r;
3733 int copy;
3734#define HAS_HOTKEY_LEN 30
3735 char_u has_hotkey[HAS_HOTKEY_LEN];
3736 int first_hotkey = FALSE; /* first char of button is hotkey */
3737 int idx;
3738
3739 has_hotkey[0] = FALSE;
3740
3741 /*
3742 * First loop: compute the size of memory to allocate.
3743 * Second loop: copy to the allocated memory.
3744 */
3745 for (copy = 0; copy <= 1; ++copy)
3746 {
3747 r = buttons;
3748 idx = 0;
3749 while (*r)
3750 {
3751 if (*r == DLG_BUTTON_SEP)
3752 {
3753 if (copy)
3754 {
3755 *msgp++ = ',';
3756 *msgp++ = ' '; /* '\n' -> ', ' */
3757
3758 /* advance to next hotkey and set default hotkey */
3759#ifdef FEAT_MBYTE
3760 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003761 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 else
3763#endif
3764 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003765 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 if (dfltbutton)
3767 --dfltbutton;
3768
3769 /* If no hotkey is specified first char is used. */
3770 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3771 first_hotkey = TRUE;
3772 }
3773 else
3774 {
3775 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3776 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3777 if (idx < HAS_HOTKEY_LEN - 1)
3778 has_hotkey[++idx] = FALSE;
3779 }
3780 }
3781 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3782 {
3783 if (*r == DLG_HOTKEY_CHAR)
3784 ++r;
3785 first_hotkey = FALSE;
3786 if (copy)
3787 {
3788 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3789 *msgp++ = *r;
3790 else
3791 {
3792 /* '&a' -> '[a]' */
3793 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3794 msgp += copy_char(r, msgp, FALSE);
3795 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3796
3797 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003798 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 }
3800 }
3801 else
3802 {
3803 ++len; /* '&a' -> '[a]' */
3804 if (idx < HAS_HOTKEY_LEN - 1)
3805 has_hotkey[idx] = TRUE;
3806 }
3807 }
3808 else
3809 {
3810 /* everything else copy literally */
3811 if (copy)
3812 msgp += copy_char(r, msgp, FALSE);
3813 }
3814
3815 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003816 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 }
3818
3819 if (copy)
3820 {
3821 *msgp++ = ':';
3822 *msgp++ = ' ';
3823 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 }
3825 else
3826 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003827 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003828 + 2 /* for the NL's */
3829 + STRLEN(buttons)
3830 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003831 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832
3833 /* If no hotkey is specified first char is used. */
3834 if (!has_hotkey[0])
3835 {
3836 first_hotkey = TRUE;
3837 len += 2; /* "x" -> "[x]" */
3838 }
3839
3840 /*
3841 * Now allocate and load the strings
3842 */
3843 vim_free(confirm_msg);
3844 confirm_msg = alloc(len);
3845 if (confirm_msg == NULL)
3846 return NULL;
3847 *confirm_msg = NUL;
3848 hotk = alloc(lenhotkey);
3849 if (hotk == NULL)
3850 return NULL;
3851
3852 *confirm_msg = '\n';
3853 STRCPY(confirm_msg + 1, message);
3854
3855 msgp = confirm_msg + 1 + STRLEN(message);
3856 hotkp = hotk;
3857
Bram Moolenaar6a516062007-07-05 08:11:42 +00003858 /* Define first default hotkey. Keep the hotkey string NUL
3859 * terminated to avoid reading past the end. */
3860 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861
3862 /* Remember where the choices start, displaying starts here when
3863 * "hotkp" typed at the more prompt. */
3864 confirm_msg_tail = msgp;
3865 *msgp++ = '\n';
3866 }
3867 }
3868
3869 display_confirm_msg();
3870 return hotk;
3871}
3872
3873/*
3874 * Display the ":confirm" message. Also called when screen resized.
3875 */
3876 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003877display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878{
3879 /* avoid that 'q' at the more prompt truncates the message here */
3880 ++confirm_msg_used;
3881 if (confirm_msg != NULL)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003882 msg_puts_attr(confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 --confirm_msg_used;
3884}
3885
3886#endif /* FEAT_CON_DIALOG */
3887
3888#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3889
3890 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003891vim_dialog_yesno(
3892 int type,
3893 char_u *title,
3894 char_u *message,
3895 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896{
3897 if (do_dialog(type,
3898 title == NULL ? (char_u *)_("Question") : title,
3899 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003900 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 return VIM_YES;
3902 return VIM_NO;
3903}
3904
3905 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003906vim_dialog_yesnocancel(
3907 int type,
3908 char_u *title,
3909 char_u *message,
3910 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911{
3912 switch (do_dialog(type,
3913 title == NULL ? (char_u *)_("Question") : title,
3914 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003915 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 {
3917 case 1: return VIM_YES;
3918 case 2: return VIM_NO;
3919 }
3920 return VIM_CANCEL;
3921}
3922
3923 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003924vim_dialog_yesnoallcancel(
3925 int type,
3926 char_u *title,
3927 char_u *message,
3928 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929{
3930 switch (do_dialog(type,
3931 title == NULL ? (char_u *)"Question" : title,
3932 message,
3933 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003934 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 {
3936 case 1: return VIM_YES;
3937 case 2: return VIM_NO;
3938 case 3: return VIM_ALL;
3939 case 4: return VIM_DISCARDALL;
3940 }
3941 return VIM_CANCEL;
3942}
3943
3944#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3945
3946#if defined(FEAT_BROWSE) || defined(PROTO)
3947/*
3948 * Generic browse function. Calls gui_mch_browse() when possible.
3949 * Later this may pop-up a non-GUI file selector (external command?).
3950 */
3951 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003952do_browse(
3953 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3954 char_u *title, /* title for the window */
3955 char_u *dflt, /* default file name (may include directory) */
3956 char_u *ext, /* extension added */
3957 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003959 char_u *filter, /* file name filter */
3960 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961{
3962 char_u *fname;
3963 static char_u *last_dir = NULL; /* last used directory */
3964 char_u *tofree = NULL;
3965 int save_browse = cmdmod.browse;
3966
3967 /* Must turn off browse to avoid that autocommands will get the
3968 * flag too! */
3969 cmdmod.browse = FALSE;
3970
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003971 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003973 if (flags & BROWSE_DIR)
3974 title = (char_u *)_("Select Directory dialog");
3975 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 title = (char_u *)_("Save File dialog");
3977 else
3978 title = (char_u *)_("Open File dialog");
3979 }
3980
3981 /* When no directory specified, use default file name, default dir, buffer
3982 * dir, last dir or current dir */
3983 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3984 {
3985 if (mch_isdir(dflt)) /* default file name is a directory */
3986 {
3987 initdir = dflt;
3988 dflt = NULL;
3989 }
3990 else if (gettail(dflt) != dflt) /* default file name includes a path */
3991 {
3992 tofree = vim_strsave(dflt);
3993 if (tofree != NULL)
3994 {
3995 initdir = tofree;
3996 *gettail(initdir) = NUL;
3997 dflt = gettail(dflt);
3998 }
3999 }
4000 }
4001
4002 if (initdir == NULL || *initdir == NUL)
4003 {
4004 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004005 if (STRCMP(p_bsdir, "last") != 0
4006 && STRCMP(p_bsdir, "buffer") != 0
4007 && STRCMP(p_bsdir, "current") != 0
4008 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 initdir = p_bsdir;
4010 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004011 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 && buf != NULL && buf->b_ffname != NULL)
4013 {
4014 if (dflt == NULL || *dflt == NUL)
4015 dflt = gettail(curbuf->b_ffname);
4016 tofree = vim_strsave(curbuf->b_ffname);
4017 if (tofree != NULL)
4018 {
4019 initdir = tofree;
4020 *gettail(initdir) = NUL;
4021 }
4022 }
4023 /* When 'browsedir' is "last", use dir from last browse */
4024 else if (*p_bsdir == 'l')
4025 initdir = last_dir;
4026 /* When 'browsedir is "current", use current directory. This is the
4027 * default already, leave initdir empty. */
4028 }
4029
4030# ifdef FEAT_GUI
4031 if (gui.in_use) /* when this changes, also adjust f_has()! */
4032 {
4033 if (filter == NULL
4034# ifdef FEAT_EVAL
4035 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4036 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4037# endif
4038 )
4039 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004040 if (flags & BROWSE_DIR)
4041 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004042# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004043 /* For systems that have a directory dialog. */
4044 fname = gui_mch_browsedir(title, initdir);
4045# else
4046 /* Generic solution for selecting a directory: select a file and
4047 * remove the file name. */
4048 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4049# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004050# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004051 /* Win32 adds a dummy file name, others return an arbitrary file
4052 * name. GTK+ 2 returns only the directory, */
4053 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4054 {
4055 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004056 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004057
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004058 if (tail == fname)
4059 *tail++ = '.'; /* use current dir */
4060 *tail = NUL;
4061 }
4062# endif
4063 }
4064 else
4065 fname = gui_mch_browse(flags & BROWSE_SAVE,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004066 title, dflt, ext, initdir, (char_u *)_(filter));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067
4068 /* We hang around in the dialog for a while, the user might do some
4069 * things to our files. The Win32 dialog allows deleting or renaming
4070 * a file, check timestamps. */
4071 need_check_timestamps = TRUE;
4072 did_check_timestamps = FALSE;
4073 }
4074 else
4075# endif
4076 {
4077 /* TODO: non-GUI file selector here */
4078 EMSG(_("E338: Sorry, no file browser in console mode"));
4079 fname = NULL;
4080 }
4081
4082 /* keep the directory for next time */
4083 if (fname != NULL)
4084 {
4085 vim_free(last_dir);
4086 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004087 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 {
4089 *gettail(last_dir) = NUL;
4090 if (*last_dir == NUL)
4091 {
4092 /* filename only returned, must be in current dir */
4093 vim_free(last_dir);
4094 last_dir = alloc(MAXPATHL);
4095 if (last_dir != NULL)
4096 mch_dirname(last_dir, MAXPATHL);
4097 }
4098 }
4099 }
4100
4101 vim_free(tofree);
4102 cmdmod.browse = save_browse;
4103
4104 return fname;
4105}
4106#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004107
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004108#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004109static char *e_printf = N_("E766: Insufficient arguments for printf()");
4110
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004111static varnumber_T tv_nr(typval_T *tvs, int *idxp);
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004112static char *tv_str(typval_T *tvs, int *idxp, char_u **tofree);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004113# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004114static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004115# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004116
4117/*
4118 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4119 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004120 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004121tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004122{
4123 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004124 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004125 int err = FALSE;
4126
4127 if (tvs[idx].v_type == VAR_UNKNOWN)
4128 EMSG(_(e_printf));
4129 else
4130 {
4131 ++*idxp;
4132 n = get_tv_number_chk(&tvs[idx], &err);
4133 if (err)
4134 n = 0;
4135 }
4136 return n;
4137}
4138
4139/*
4140 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004141 * If "tofree" is NULL get_tv_string_chk() is used. Some types (e.g. List)
4142 * are not converted to a string.
4143 * If "tofree" is not NULL echo_string() is used. All types are converted to
4144 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004145 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004146 */
4147 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004148tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004149{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004150 int idx = *idxp - 1;
4151 char *s = NULL;
4152 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004153
4154 if (tvs[idx].v_type == VAR_UNKNOWN)
4155 EMSG(_(e_printf));
4156 else
4157 {
4158 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004159 if (tofree != NULL)
4160 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4161 else
4162 s = (char *)get_tv_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004163 }
4164 return s;
4165}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004166
4167# ifdef FEAT_FLOAT
4168/*
4169 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4170 */
4171 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004172tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004173{
4174 int idx = *idxp - 1;
4175 double f = 0;
4176
4177 if (tvs[idx].v_type == VAR_UNKNOWN)
4178 EMSG(_(e_printf));
4179 else
4180 {
4181 ++*idxp;
4182 if (tvs[idx].v_type == VAR_FLOAT)
4183 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004184 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004185 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004186 else
4187 EMSG(_("E807: Expected Float argument for printf()"));
4188 }
4189 return f;
4190}
4191# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004192#endif
4193
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004194#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004195/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004196 * Return the representation of infinity for printf() function:
4197 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4198 */
4199 static const char *
4200infinity_str(int positive,
4201 char fmt_spec,
4202 int force_sign,
4203 int space_for_positive)
4204{
4205 static const char *table[] =
4206 {
4207 "-inf", "inf", "+inf", " inf",
4208 "-INF", "INF", "+INF", " INF"
4209 };
4210 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4211
4212 if (ASCII_ISUPPER(fmt_spec))
4213 idx += 4;
4214 return table[idx];
4215}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004216#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004217
4218/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004219 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004220 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004221 * consistency.
4222 *
4223 * This code is based on snprintf.c - a portable implementation of snprintf
4224 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004225 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004226 * The original code, including useful comments, can be found here:
4227 * http://www.ijs.si/software/snprintf/
4228 *
4229 * This snprintf() only supports the following conversion specifiers:
4230 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4231 * with flags: '-', '+', ' ', '0' and '#'.
4232 * An asterisk is supported for field width as well as precision.
4233 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004234 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004235 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004236 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4237 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004238 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004239 * The locale is not used, the string is used as a byte string. This is only
4240 * relevant for double-byte encodings where the second byte may be '%'.
4241 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004242 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4243 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004244 *
4245 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004246 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004247 * is greater or equal to "str_m", not all characters from the result
4248 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4249 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004250 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004251 */
4252
4253/*
4254 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004255 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004256 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004257 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004258 */
4259
4260/* When generating prototypes all of this is skipped, cproto doesn't
4261 * understand this. */
4262#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004263
Bram Moolenaara800b422010-06-27 01:15:55 +02004264/* Like vim_vsnprintf() but append to the string. */
4265 int
4266vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4267{
4268 va_list ap;
4269 int str_l;
4270 size_t len = STRLEN(str);
4271 size_t space;
4272
4273 if (str_m <= len)
4274 space = 0;
4275 else
4276 space = str_m - len;
4277 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004278 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004279 va_end(ap);
4280 return str_l;
4281}
Bram Moolenaara800b422010-06-27 01:15:55 +02004282
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004283 int
4284vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4285{
4286 va_list ap;
4287 int str_l;
4288
4289 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004290 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004291 va_end(ap);
4292 return str_l;
4293}
4294
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004295 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004296vim_vsnprintf(
4297 char *str,
4298 size_t str_m,
4299 char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004300 va_list ap)
4301{
4302 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4303}
4304
4305 int
4306vim_vsnprintf_typval(
4307 char *str,
4308 size_t str_m,
4309 char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004310 va_list ap,
4311 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004312{
4313 size_t str_l = 0;
4314 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004315 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004316
4317 if (p == NULL)
4318 p = "";
4319 while (*p != NUL)
4320 {
4321 if (*p != '%')
4322 {
4323 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004324 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004325
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004326 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004327 if (str_l < str_m)
4328 {
4329 size_t avail = str_m - str_l;
4330
4331 mch_memmove(str + str_l, p, n > avail ? avail : n);
4332 }
4333 p += n;
4334 str_l += n;
4335 }
4336 else
4337 {
4338 size_t min_field_width = 0, precision = 0;
4339 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4340 int alternate_form = 0, force_sign = 0;
4341
4342 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4343 * ignored. */
4344 int space_for_positive = 1;
4345
4346 /* allowed values: \0, h, l, L */
4347 char length_modifier = '\0';
4348
4349 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004350# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004351# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004352 * That sounds reasonable to use as the maximum
4353 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004354# elif defined(FEAT_NUM64)
4355# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004356# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004357# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004358# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004359 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004360
4361 /* string address in case of string argument */
4362 char *str_arg;
4363
4364 /* natural field width of arg without padding and sign */
4365 size_t str_arg_l;
4366
4367 /* unsigned char argument value - only defined for c conversion.
4368 * N.B. standard explicitly states the char argument for the c
4369 * conversion is unsigned */
4370 unsigned char uchar_arg;
4371
4372 /* number of zeros to be inserted for numeric conversions as
4373 * required by the precision or minimal field width */
4374 size_t number_of_zeros_to_pad = 0;
4375
4376 /* index into tmp where zero padding is to be inserted */
4377 size_t zero_padding_insertion_ind = 0;
4378
4379 /* current conversion specifier character */
4380 char fmt_spec = '\0';
4381
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004382 /* buffer for 's' and 'S' specs */
4383 char_u *tofree = NULL;
4384
4385
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004386 str_arg = NULL;
4387 p++; /* skip '%' */
4388
4389 /* parse flags */
4390 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4391 || *p == '#' || *p == '\'')
4392 {
4393 switch (*p)
4394 {
4395 case '0': zero_padding = 1; break;
4396 case '-': justify_left = 1; break;
4397 case '+': force_sign = 1; space_for_positive = 0; break;
4398 case ' ': force_sign = 1;
4399 /* If both the ' ' and '+' flags appear, the ' '
4400 * flag should be ignored */
4401 break;
4402 case '#': alternate_form = 1; break;
4403 case '\'': break;
4404 }
4405 p++;
4406 }
4407 /* If the '0' and '-' flags both appear, the '0' flag should be
4408 * ignored. */
4409
4410 /* parse field width */
4411 if (*p == '*')
4412 {
4413 int j;
4414
4415 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004416 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004417# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004418 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004419# endif
4420 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004421 if (j >= 0)
4422 min_field_width = j;
4423 else
4424 {
4425 min_field_width = -j;
4426 justify_left = 1;
4427 }
4428 }
4429 else if (VIM_ISDIGIT((int)(*p)))
4430 {
4431 /* size_t could be wider than unsigned int; make sure we treat
4432 * argument like common implementations do */
4433 unsigned int uj = *p++ - '0';
4434
4435 while (VIM_ISDIGIT((int)(*p)))
4436 uj = 10 * uj + (unsigned int)(*p++ - '0');
4437 min_field_width = uj;
4438 }
4439
4440 /* parse precision */
4441 if (*p == '.')
4442 {
4443 p++;
4444 precision_specified = 1;
4445 if (*p == '*')
4446 {
4447 int j;
4448
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004449 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004450# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004451 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004452# endif
4453 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004454 p++;
4455 if (j >= 0)
4456 precision = j;
4457 else
4458 {
4459 precision_specified = 0;
4460 precision = 0;
4461 }
4462 }
4463 else if (VIM_ISDIGIT((int)(*p)))
4464 {
4465 /* size_t could be wider than unsigned int; make sure we
4466 * treat argument like common implementations do */
4467 unsigned int uj = *p++ - '0';
4468
4469 while (VIM_ISDIGIT((int)(*p)))
4470 uj = 10 * uj + (unsigned int)(*p++ - '0');
4471 precision = uj;
4472 }
4473 }
4474
4475 /* parse 'h', 'l' and 'll' length modifiers */
4476 if (*p == 'h' || *p == 'l')
4477 {
4478 length_modifier = *p;
4479 p++;
4480 if (length_modifier == 'l' && *p == 'l')
4481 {
4482 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004483# ifdef FEAT_NUM64
4484 length_modifier = 'L';
4485# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004486 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004487# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004488 p++;
4489 }
4490 }
4491 fmt_spec = *p;
4492
4493 /* common synonyms: */
4494 switch (fmt_spec)
4495 {
4496 case 'i': fmt_spec = 'd'; break;
4497 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4498 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4499 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4500 default: break;
4501 }
4502
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004503# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4504 switch (fmt_spec)
4505 {
4506 case 'd': case 'u': case 'o': case 'x': case 'X':
4507 if (tvs != NULL && length_modifier == '\0')
4508 length_modifier = 'L';
4509 }
4510# endif
4511
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004512 /* get parameter value, do initial processing */
4513 switch (fmt_spec)
4514 {
4515 /* '%' and 'c' behave similar to 's' regarding flags and field
4516 * widths */
4517 case '%':
4518 case 'c':
4519 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004520 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004521 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004522 str_arg_l = 1;
4523 switch (fmt_spec)
4524 {
4525 case '%':
4526 str_arg = p;
4527 break;
4528
4529 case 'c':
4530 {
4531 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004532
4533 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004534# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004535 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004536# endif
4537 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004538 /* standard demands unsigned char */
4539 uchar_arg = (unsigned char)j;
4540 str_arg = (char *)&uchar_arg;
4541 break;
4542 }
4543
4544 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004545 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004546 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004547# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004548 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004549# endif
4550 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004551 if (str_arg == NULL)
4552 {
4553 str_arg = "[NULL]";
4554 str_arg_l = 6;
4555 }
4556 /* make sure not to address string beyond the specified
4557 * precision !!! */
4558 else if (!precision_specified)
4559 str_arg_l = strlen(str_arg);
4560 /* truncate string if necessary as requested by precision */
4561 else if (precision == 0)
4562 str_arg_l = 0;
4563 else
4564 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004565 /* Don't put the #if inside memchr(), it can be a
4566 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004567# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004568 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004569# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004570 /* memchr on HP does not like n > 2^31 !!! */
4571 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004572 precision <= (size_t)0x7fffffffL ? precision
4573 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004574# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004575 str_arg_l = (q == NULL) ? precision
4576 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004577 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004578# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004579 if (fmt_spec == 'S')
4580 {
4581 if (min_field_width != 0)
4582 min_field_width += STRLEN(str_arg)
4583 - mb_string2cells((char_u *)str_arg, -1);
4584 if (precision)
4585 {
4586 char_u *p1 = (char_u *)str_arg;
4587 size_t i;
4588
4589 for (i = 0; i < precision && *p1; i++)
4590 p1 += mb_ptr2len(p1);
4591
4592 str_arg_l = precision = p1 - (char_u *)str_arg;
4593 }
4594 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004595# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004596 break;
4597
4598 default:
4599 break;
4600 }
4601 break;
4602
Bram Moolenaar91984b92016-08-16 21:58:41 +02004603 case 'd': case 'u':
4604 case 'b': case 'B':
4605 case 'o':
4606 case 'x': case 'X':
4607 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004608 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004609 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004610 * imply the value is unsigned; d implies a signed
4611 * value */
4612
4613 /* 0 if numeric argument is zero (or if pointer is
4614 * NULL for 'p'), +1 if greater than zero (or nonzero
4615 * for unsigned arguments), -1 if negative (unsigned
4616 * argument is never negative) */
4617 int arg_sign = 0;
4618
4619 /* only defined for length modifier h, or for no
4620 * length modifiers */
4621 int int_arg = 0;
4622 unsigned int uint_arg = 0;
4623
4624 /* only defined for length modifier l */
4625 long int long_arg = 0;
4626 unsigned long int ulong_arg = 0;
4627
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004628# ifdef FEAT_NUM64
4629 /* only defined for length modifier ll */
4630 varnumber_T llong_arg = 0;
4631 uvarnumber_T ullong_arg = 0;
4632# endif
4633
Bram Moolenaare9997822016-08-28 16:03:38 +02004634 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004635 uvarnumber_T bin_arg = 0;
4636
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004637 /* pointer argument value -only defined for p
4638 * conversion */
4639 void *ptr_arg = NULL;
4640
4641 if (fmt_spec == 'p')
4642 {
4643 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004644 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004645# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004646 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4647 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004648# endif
4649 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004650 if (ptr_arg != NULL)
4651 arg_sign = 1;
4652 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004653 else if (fmt_spec == 'b' || fmt_spec == 'B')
4654 {
4655 bin_arg =
4656# if defined(FEAT_EVAL)
4657 tvs != NULL ?
4658 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4659# endif
4660 va_arg(ap, uvarnumber_T);
4661 if (bin_arg != 0)
4662 arg_sign = 1;
4663 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004664 else if (fmt_spec == 'd')
4665 {
4666 /* signed */
4667 switch (length_modifier)
4668 {
4669 case '\0':
4670 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004671 /* char and short arguments are passed as int. */
4672 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004673# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004674 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004675# endif
4676 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004677 if (int_arg > 0)
4678 arg_sign = 1;
4679 else if (int_arg < 0)
4680 arg_sign = -1;
4681 break;
4682 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004683 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004684# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004685 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004686# endif
4687 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004688 if (long_arg > 0)
4689 arg_sign = 1;
4690 else if (long_arg < 0)
4691 arg_sign = -1;
4692 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004693# ifdef FEAT_NUM64
4694 case 'L':
4695 llong_arg =
4696# if defined(FEAT_EVAL)
4697 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4698# endif
4699 va_arg(ap, varnumber_T);
4700 if (llong_arg > 0)
4701 arg_sign = 1;
4702 else if (llong_arg < 0)
4703 arg_sign = -1;
4704 break;
4705# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004706 }
4707 }
4708 else
4709 {
4710 /* unsigned */
4711 switch (length_modifier)
4712 {
4713 case '\0':
4714 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004715 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004716# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004717 tvs != NULL ? (unsigned)
4718 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004719# endif
4720 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004721 if (uint_arg != 0)
4722 arg_sign = 1;
4723 break;
4724 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004725 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004726# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004727 tvs != NULL ? (unsigned long)
4728 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004729# endif
4730 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004731 if (ulong_arg != 0)
4732 arg_sign = 1;
4733 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004734# ifdef FEAT_NUM64
4735 case 'L':
4736 ullong_arg =
4737# if defined(FEAT_EVAL)
4738 tvs != NULL ? (uvarnumber_T)
4739 tv_nr(tvs, &arg_idx) :
4740# endif
4741 va_arg(ap, uvarnumber_T);
4742 if (ullong_arg != 0)
4743 arg_sign = 1;
4744 break;
4745# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004746 }
4747 }
4748
4749 str_arg = tmp;
4750 str_arg_l = 0;
4751
4752 /* NOTE:
4753 * For d, i, u, o, x, and X conversions, if precision is
4754 * specified, the '0' flag should be ignored. This is so
4755 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4756 * FreeBSD, NetBSD; but not with Perl.
4757 */
4758 if (precision_specified)
4759 zero_padding = 0;
4760 if (fmt_spec == 'd')
4761 {
4762 if (force_sign && arg_sign >= 0)
4763 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4764 /* leave negative numbers for sprintf to handle, to
4765 * avoid handling tricky cases like (short int)-32768 */
4766 }
4767 else if (alternate_form)
4768 {
4769 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004770 && (fmt_spec == 'b' || fmt_spec == 'B'
4771 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004772 {
4773 tmp[str_arg_l++] = '0';
4774 tmp[str_arg_l++] = fmt_spec;
4775 }
4776 /* alternate form should have no effect for p
4777 * conversion, but ... */
4778 }
4779
4780 zero_padding_insertion_ind = str_arg_l;
4781 if (!precision_specified)
4782 precision = 1; /* default precision is 1 */
4783 if (precision == 0 && arg_sign == 0)
4784 {
4785 /* When zero value is formatted with an explicit
4786 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004787 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004788 }
4789 else
4790 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004791 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004792 int f_l = 0;
4793
4794 /* construct a simple format string for sprintf */
4795 f[f_l++] = '%';
4796 if (!length_modifier)
4797 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004798 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004799 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004800# ifdef FEAT_NUM64
4801# ifdef WIN3264
4802 f[f_l++] = 'I';
4803 f[f_l++] = '6';
4804 f[f_l++] = '4';
4805# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004806 f[f_l++] = 'l';
4807 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004808# endif
4809# else
4810 f[f_l++] = 'l';
4811# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004812 }
4813 else
4814 f[f_l++] = length_modifier;
4815 f[f_l++] = fmt_spec;
4816 f[f_l++] = '\0';
4817
4818 if (fmt_spec == 'p')
4819 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004820 else if (fmt_spec == 'b' || fmt_spec == 'B')
4821 {
4822 char b[8 * sizeof(uvarnumber_T)];
4823 size_t b_l = 0;
4824 uvarnumber_T bn = bin_arg;
4825
4826 do
4827 {
4828 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4829 bn >>= 1;
4830 }
4831 while (bn != 0);
4832
4833 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4834 str_arg_l += b_l;
4835 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004836 else if (fmt_spec == 'd')
4837 {
4838 /* signed */
4839 switch (length_modifier)
4840 {
4841 case '\0':
4842 case 'h': str_arg_l += sprintf(
4843 tmp + str_arg_l, f, int_arg);
4844 break;
4845 case 'l': str_arg_l += sprintf(
4846 tmp + str_arg_l, f, long_arg);
4847 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004848# ifdef FEAT_NUM64
4849 case 'L': str_arg_l += sprintf(
4850 tmp + str_arg_l, f, llong_arg);
4851 break;
4852# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004853 }
4854 }
4855 else
4856 {
4857 /* unsigned */
4858 switch (length_modifier)
4859 {
4860 case '\0':
4861 case 'h': str_arg_l += sprintf(
4862 tmp + str_arg_l, f, uint_arg);
4863 break;
4864 case 'l': str_arg_l += sprintf(
4865 tmp + str_arg_l, f, ulong_arg);
4866 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004867# ifdef FEAT_NUM64
4868 case 'L': str_arg_l += sprintf(
4869 tmp + str_arg_l, f, ullong_arg);
4870 break;
4871# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004872 }
4873 }
4874
4875 /* include the optional minus sign and possible
4876 * "0x" in the region before the zero padding
4877 * insertion point */
4878 if (zero_padding_insertion_ind < str_arg_l
4879 && tmp[zero_padding_insertion_ind] == '-')
4880 zero_padding_insertion_ind++;
4881 if (zero_padding_insertion_ind + 1 < str_arg_l
4882 && tmp[zero_padding_insertion_ind] == '0'
4883 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4884 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4885 zero_padding_insertion_ind += 2;
4886 }
4887
4888 {
4889 size_t num_of_digits = str_arg_l
4890 - zero_padding_insertion_ind;
4891
4892 if (alternate_form && fmt_spec == 'o'
4893 /* unless zero is already the first
4894 * character */
4895 && !(zero_padding_insertion_ind < str_arg_l
4896 && tmp[zero_padding_insertion_ind] == '0'))
4897 {
4898 /* assure leading zero for alternate-form
4899 * octal numbers */
4900 if (!precision_specified
4901 || precision < num_of_digits + 1)
4902 {
4903 /* precision is increased to force the
4904 * first character to be zero, except if a
4905 * zero value is formatted with an
4906 * explicit precision of zero */
4907 precision = num_of_digits + 1;
4908 precision_specified = 1;
4909 }
4910 }
4911 /* zero padding to specified precision? */
4912 if (num_of_digits < precision)
4913 number_of_zeros_to_pad = precision - num_of_digits;
4914 }
4915 /* zero padding to specified minimal field width? */
4916 if (!justify_left && zero_padding)
4917 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004918 int n = (int)(min_field_width - (str_arg_l
4919 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004920 if (n > 0)
4921 number_of_zeros_to_pad += n;
4922 }
4923 break;
4924 }
4925
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004926# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004927 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004928 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004929 case 'e':
4930 case 'E':
4931 case 'g':
4932 case 'G':
4933 {
4934 /* Floating point. */
4935 double f;
4936 double abs_f;
4937 char format[40];
4938 int l;
4939 int remove_trailing_zeroes = FALSE;
4940
4941 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004942# if defined(FEAT_EVAL)
4943 tvs != NULL ? tv_float(tvs, &arg_idx) :
4944# endif
4945 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004946 abs_f = f < 0 ? -f : f;
4947
4948 if (fmt_spec == 'g' || fmt_spec == 'G')
4949 {
4950 /* Would be nice to use %g directly, but it prints
4951 * "1.0" as "1", we don't want that. */
4952 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4953 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004954 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004955 else
4956 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4957 remove_trailing_zeroes = TRUE;
4958 }
4959
Bram Moolenaar04186092016-08-29 21:55:35 +02004960 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004961# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004962 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004963# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004964 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004965# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004966 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004967 {
4968 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004969 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4970 force_sign, space_for_positive));
4971 str_arg_l = STRLEN(tmp);
4972 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004973 }
4974 else
4975 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004976 if (isnan(f))
4977 {
4978 /* Not a number: nan or NAN */
4979 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4980 : "nan");
4981 str_arg_l = 3;
4982 zero_padding = 0;
4983 }
4984 else if (isinf(f))
4985 {
4986 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4987 force_sign, space_for_positive));
4988 str_arg_l = STRLEN(tmp);
4989 zero_padding = 0;
4990 }
4991 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004992 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004993 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004994 format[0] = '%';
4995 l = 1;
4996 if (force_sign)
4997 format[l++] = space_for_positive ? ' ' : '+';
4998 if (precision_specified)
4999 {
5000 size_t max_prec = TMP_LEN - 10;
5001
5002 /* Make sure we don't get more digits than we
5003 * have room for. */
5004 if ((fmt_spec == 'f' || fmt_spec == 'F')
5005 && abs_f > 1.0)
5006 max_prec -= (size_t)log10(abs_f);
5007 if (precision > max_prec)
5008 precision = max_prec;
5009 l += sprintf(format + l, ".%d", (int)precision);
5010 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02005011 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02005012 format[l + 1] = NUL;
5013
Bram Moolenaare9997822016-08-28 16:03:38 +02005014 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01005015 }
Bram Moolenaar99922372016-08-27 15:26:35 +02005016
Bram Moolenaara7241f52008-06-24 20:39:31 +00005017 if (remove_trailing_zeroes)
5018 {
5019 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005020 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005021
5022 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02005023 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005024 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005025 else
5026 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005027 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005028 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005029 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005030 {
5031 /* Remove superfluous '+' and leading
5032 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005033 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005034 {
5035 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005036 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005037 --str_arg_l;
5038 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005039 i = (tp[1] == '-') ? 2 : 1;
5040 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005041 {
5042 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005043 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005044 --str_arg_l;
5045 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005046 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005047 }
5048 }
5049
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005050 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005051 /* Remove trailing zeroes, but keep the one
5052 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005053 while (tp > tmp + 2 && *tp == '0'
5054 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005055 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005056 STRMOVE(tp, tp + 1);
5057 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005058 --str_arg_l;
5059 }
5060 }
5061 else
5062 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005063 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005064
5065 /* Be consistent: some printf("%e") use 1.0e+12
5066 * and some 1.0e+012. Remove one zero in the last
5067 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005068 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005069 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005070 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5071 && tp[2] == '0'
5072 && vim_isdigit(tp[3])
5073 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005074 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005075 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005076 --str_arg_l;
5077 }
5078 }
5079 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005080 if (zero_padding && min_field_width > str_arg_l
5081 && (tmp[0] == '-' || force_sign))
5082 {
5083 /* padding 0's should be inserted after the sign */
5084 number_of_zeros_to_pad = min_field_width - str_arg_l;
5085 zero_padding_insertion_ind = 1;
5086 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005087 str_arg = tmp;
5088 break;
5089 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005090# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005091
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092 default:
5093 /* unrecognized conversion specifier, keep format string
5094 * as-is */
5095 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005096 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005098 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005099
5100 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005101 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005102 str_arg = p;
5103 str_arg_l = 0;
5104 if (*p != NUL)
5105 str_arg_l++; /* include invalid conversion specifier
5106 unchanged if not at end-of-string */
5107 break;
5108 }
5109
5110 if (*p != NUL)
5111 p++; /* step over the just processed conversion specifier */
5112
5113 /* insert padding to the left as requested by min_field_width;
5114 * this does not include the zero padding in case of numerical
5115 * conversions*/
5116 if (!justify_left)
5117 {
5118 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005119 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005120
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005121 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005122 {
5123 if (str_l < str_m)
5124 {
5125 size_t avail = str_m - str_l;
5126
5127 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005128 (size_t)pn > avail ? avail
5129 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005130 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005131 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005132 }
5133 }
5134
5135 /* zero padding as requested by the precision or by the minimal
5136 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005137 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005138 {
5139 /* will not copy first part of numeric right now, *
5140 * force it to be copied later in its entirety */
5141 zero_padding_insertion_ind = 0;
5142 }
5143 else
5144 {
5145 /* insert first part of numerics (sign or '0x') before zero
5146 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005147 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005148
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005149 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005150 {
5151 if (str_l < str_m)
5152 {
5153 size_t avail = str_m - str_l;
5154
5155 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005156 (size_t)zn > avail ? avail
5157 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005158 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005159 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005160 }
5161
5162 /* insert zero padding as requested by the precision or min
5163 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005164 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005165 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005166 {
5167 if (str_l < str_m)
5168 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005169 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005170
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005171 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005172 (size_t)zn > avail ? avail
5173 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005174 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005175 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005176 }
5177 }
5178
5179 /* insert formatted string
5180 * (or as-is conversion specifier for unknown conversions) */
5181 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005182 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005183
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005184 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005185 {
5186 if (str_l < str_m)
5187 {
5188 size_t avail = str_m - str_l;
5189
5190 mch_memmove(str + str_l,
5191 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005192 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005193 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005194 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005195 }
5196 }
5197
5198 /* insert right padding */
5199 if (justify_left)
5200 {
5201 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005202 int pn = (int)(min_field_width
5203 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005204
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005205 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005206 {
5207 if (str_l < str_m)
5208 {
5209 size_t avail = str_m - str_l;
5210
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005211 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005212 (size_t)pn > avail ? avail
5213 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005214 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005215 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005216 }
5217 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005218 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005219 }
5220 }
5221
5222 if (str_m > 0)
5223 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005224 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005225 * overwriting the last character (shouldn't happen, but just in case)
5226 * */
5227 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5228 }
5229
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005230 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005231 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005232
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005233 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005234 * character), that is, the number of characters that would have been
5235 * written to the buffer if it were large enough. */
5236 return (int)str_l;
5237}
5238
5239#endif /* PROTO */