blob: 635dd8be94869e5d3a321e46bbfc0572d5dcd9b4 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * message.c: functions for displaying messages on the command line
12 */
13
14#define MESSAGE_FILE /* don't include prototype for smsg() */
Bram Moolenaar44ca54a2016-08-27 15:41:32 +020015#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
17#include "vim.h"
18
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010019static void add_msg_hist(char_u *s, int len, int attr);
20static void hit_return_msg(void);
21static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010022static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
23static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
24static void msg_scroll_up(void);
25static void inc_msg_scrolled(void);
26static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
27static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
28static void msg_puts_printf(char_u *str, int maxlen);
29static int do_more_prompt(int typed_char);
30static void msg_screen_putchar(int c, int attr);
31static int msg_check_screen(void);
32static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000033#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010034static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000035static int confirm_msg_used = FALSE; /* displaying confirm_msg */
36static char_u *confirm_msg = NULL; /* ":confirm" message */
37static char_u *confirm_msg_tail; /* tail of confirm_msg */
38#endif
Bram Moolenaar958dc692016-12-01 15:34:12 +010039#ifdef FEAT_JOB_CHANNEL
40static int emsg_to_channel_log = FALSE;
41#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
43struct msg_hist
44{
45 struct msg_hist *next;
46 char_u *msg;
47 int attr;
48};
49
50static struct msg_hist *first_msg_hist = NULL;
51static struct msg_hist *last_msg_hist = NULL;
52static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000053
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020054static FILE *verbose_fd = NULL;
55static int verbose_did_open = FALSE;
56
Bram Moolenaar071d4272004-06-13 20:20:40 +000057/*
58 * When writing messages to the screen, there are many different situations.
59 * A number of variables is used to remember the current state:
60 * msg_didany TRUE when messages were written since the last time the
61 * user reacted to a prompt.
62 * Reset: After hitting a key for the hit-return prompt,
63 * hitting <CR> for the command line or input().
64 * Set: When any message is written to the screen.
65 * msg_didout TRUE when something was written to the current line.
66 * Reset: When advancing to the next line, when the current
67 * text can be overwritten.
68 * Set: When any message is written to the screen.
69 * msg_nowait No extra delay for the last drawn message.
70 * Used in normal_cmd() before the mode message is drawn.
71 * emsg_on_display There was an error message recently. Indicates that there
72 * should be a delay before redrawing.
73 * msg_scroll The next message should not overwrite the current one.
74 * msg_scrolled How many lines the screen has been scrolled (because of
75 * messages). Used in update_screen() to scroll the screen
76 * back. Incremented each time the screen scrolls a line.
77 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
78 * writes something without scrolling should not make
79 * need_wait_return to be set. This is a hack to make ":ts"
80 * work without an extra prompt.
81 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010082 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 * need_wait_return TRUE when the hit-return prompt is needed.
84 * Reset: After giving the hit-return prompt, when the user
85 * has answered some other prompt.
86 * Set: When the ruler or typeahead display is overwritten,
87 * scrolling the screen for some message.
88 * keep_msg Message to be displayed after redrawing the screen, in
89 * main_loop().
90 * This is an allocated string or NULL when not used.
91 */
92
93/*
94 * msg(s) - displays the string 's' on the status line
95 * When terminal not initialized (yet) mch_errmsg(..) is used.
96 * return TRUE if wait_return not called
97 */
98 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +010099msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100{
101 return msg_attr_keep(s, 0, FALSE);
102}
103
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000104#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000105 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000106/*
107 * Like msg() but keep it silent when 'verbosefile' is set.
108 */
109 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100110verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000111{
112 int n;
113
114 verbose_enter();
115 n = msg_attr_keep(s, 0, FALSE);
116 verbose_leave();
117
118 return n;
119}
120#endif
121
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100123msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124{
125 return msg_attr_keep(s, attr, FALSE);
126}
127
128 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100129msg_attr_keep(
130 char_u *s,
131 int attr,
132 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133{
134 static int entered = 0;
135 int retval;
136 char_u *buf = NULL;
137
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200138 /* Skip messages not matching ":filter pattern".
139 * Don't filter when there is an error. */
140 if (!emsg_on_display && message_filtered(s))
141 return TRUE;
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143#ifdef FEAT_EVAL
144 if (attr == 0)
145 set_vim_var_string(VV_STATUSMSG, s, -1);
146#endif
147
148 /*
149 * It is possible that displaying a messages causes a problem (e.g.,
150 * when redrawing the window), which causes another message, etc.. To
151 * break this loop, limit the recursiveness to 3 levels.
152 */
153 if (entered >= 3)
154 return TRUE;
155 ++entered;
156
157 /* Add message to history (unless it's a repeated kept message or a
158 * truncated message) */
159 if (s != keep_msg
160 || (*s != '<'
161 && last_msg_hist != NULL
162 && last_msg_hist->msg != NULL
163 && STRCMP(s, last_msg_hist->msg)))
164 add_msg_hist(s, -1, attr);
165
Bram Moolenaar958dc692016-12-01 15:34:12 +0100166#ifdef FEAT_JOB_CHANNEL
167 if (emsg_to_channel_log)
Bram Moolenaar958dc692016-12-01 15:34:12 +0100168 /* Write message in the channel log. */
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200169 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100170#endif
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 /* When displaying keep_msg, don't let msg_start() free it, caller must do
173 * that. */
174 if (s == keep_msg)
175 keep_msg = NULL;
176
177 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000178 msg_start();
179 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 if (buf != NULL)
181 s = buf;
182
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 msg_outtrans_attr(s, attr);
184 msg_clr_eos();
185 retval = msg_end();
186
187 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
188 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000189 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190
191 vim_free(buf);
192 --entered;
193 return retval;
194}
195
196/*
197 * Truncate a string such that it can be printed without causing a scroll.
198 * Returns an allocated string or NULL when no truncating is done.
199 */
200 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100201msg_strtrunc(
202 char_u *s,
203 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204{
205 char_u *buf = NULL;
206 int len;
207 int room;
208
209 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000210 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
211 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 {
213 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000214 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000215 /* Use all the columns. */
216 room = (int)(Rows - msg_row) * Columns - 1;
217 else
218 /* Use up to 'showcmd' column. */
219 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 if (len > room && room > 0)
221 {
222#ifdef FEAT_MBYTE
223 if (enc_utf8)
224 /* may have up to 18 bytes per cell (6 per char, up to two
225 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100226 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 else if (enc_dbcs == DBCS_JPNU)
228 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100229 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 else
231#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100232 len = room + 2;
233 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100235 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 }
237 }
238 return buf;
239}
240
241/*
242 * Truncate a string "s" to "buf" with cell width "room".
243 * "s" and "buf" may be equal.
244 */
245 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100246trunc_string(
247 char_u *s,
248 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200249 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100250 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200252 size_t room = room_in - 3; /* "..." takes 3 chars */
253 size_t half;
254 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 int e;
256 int i;
257 int n;
258
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200259 if (room_in < 3)
260 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262
263 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100264 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265 {
266 if (s[e] == NUL)
267 {
268 /* text fits without truncating! */
269 buf[e] = NUL;
270 return;
271 }
272 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200273 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 break;
275 len += n;
276 buf[e] = s[e];
277#ifdef FEAT_MBYTE
278 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000279 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100281 if (++e == buflen)
282 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283 buf[e] = s[e];
284 }
285#endif
286 }
287
288 /* Last part: End of the string. */
289 i = e;
290#ifdef FEAT_MBYTE
291 if (enc_dbcs != 0)
292 {
293 /* For DBCS going backwards in a string is slow, but
294 * computing the cell width isn't too slow: go forward
295 * until the rest fits. */
296 n = vim_strsize(s + i);
297 while (len + n > room)
298 {
299 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000300 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301 }
302 }
303 else if (enc_utf8)
304 {
305 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000306 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 for (;;)
308 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000309 do
Bram Moolenaarace95982017-03-29 17:30:27 +0200310 half = half - utf_head_off(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200311 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200313 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 break;
315 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200316 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 }
318 }
319 else
320#endif
321 {
322 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
323 len += n;
324 }
325
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200326
327 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100328 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200329 /* text fits without truncating */
330 if (s != buf)
331 {
332 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200333 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200334 len = buflen - 1;
335 len = len - e + 1;
336 if (len < 1)
337 buf[e - 1] = NUL;
338 else
339 mch_memmove(buf + e, s + e, len);
340 }
341 }
342 else if (e + 3 < buflen)
343 {
344 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100345 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200346 len = STRLEN(s + i) + 1;
347 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100348 len = buflen - e - 3 - 1;
349 mch_memmove(buf + e + 3, s + i, len);
350 buf[e + 3 + len - 1] = NUL;
351 }
352 else
353 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200354 /* can't fit in the "...", just truncate it */
355 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100356 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357}
358
359/*
360 * Automatic prototype generation does not understand this function.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100361 * Note: Caller of smsg() and smsg_attr() must check the resulting string is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 * shorter than IOSIZE!!!
363 */
364#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100366int vim_snprintf(char *str, size_t str_m, const char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000367
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100369# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100371# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100372smsg(const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373{
374 va_list arglist;
375
376 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100377 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378 va_end(arglist);
379 return msg(IObuff);
380}
381
382 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100383# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100385# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100386smsg_attr(int attr, const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387{
388 va_list arglist;
389
390 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100391 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392 va_end(arglist);
393 return msg_attr(IObuff, attr);
394}
395
Bram Moolenaare0429682018-07-01 16:44:03 +0200396 int
397# ifdef __BORLANDC__
398_RTLENTRYF
399# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100400smsg_attr_keep(int attr, const char *s, ...)
Bram Moolenaare0429682018-07-01 16:44:03 +0200401{
402 va_list arglist;
403
404 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100405 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaare0429682018-07-01 16:44:03 +0200406 va_end(arglist);
407 return msg_attr_keep(IObuff, attr, TRUE);
408}
409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410#endif
411
412/*
413 * Remember the last sourcing name/lnum used in an error message, so that it
414 * isn't printed each time when it didn't change.
415 */
416static int last_sourcing_lnum = 0;
417static char_u *last_sourcing_name = NULL;
418
419/*
420 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
421 * for the next error message;
422 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000423 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100424reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100426 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 last_sourcing_lnum = 0;
428}
429
430/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000431 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
432 */
433 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100434other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000435{
436 if (sourcing_name != NULL)
437 {
438 if (last_sourcing_name != NULL)
439 return STRCMP(sourcing_name, last_sourcing_name) != 0;
440 return TRUE;
441 }
442 return FALSE;
443}
444
445/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 * Get the message about the source, as used for an error message.
447 * Returns an allocated string with room for one more character.
448 * Returns NULL when no message is to be given.
449 */
450 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100451get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452{
453 char_u *Buf, *p;
454
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000455 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 {
457 p = (char_u *)_("Error detected while processing %s:");
458 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
459 if (Buf != NULL)
460 sprintf((char *)Buf, (char *)p, sourcing_name);
461 return Buf;
462 }
463 return NULL;
464}
465
466/*
467 * Get the message about the source lnum, as used for an error message.
468 * Returns an allocated string with room for one more character.
469 * Returns NULL when no message is to be given.
470 */
471 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100472get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473{
474 char_u *Buf, *p;
475
476 /* lnum is 0 when executing a command from the command line
477 * argument, we don't want a line number then */
478 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000479 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480 && sourcing_lnum != 0)
481 {
482 p = (char_u *)_("line %4ld:");
483 Buf = alloc((unsigned)(STRLEN(p) + 20));
484 if (Buf != NULL)
485 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
486 return Buf;
487 }
488 return NULL;
489}
490
491/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000492 * Display name and line number for the source of an error.
493 * Remember the file name and line number, so that for the next error the info
494 * is only displayed if it changed.
495 */
496 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100497msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000498{
499 char_u *p;
500
501 ++no_wait_return;
502 p = get_emsg_source();
503 if (p != NULL)
504 {
505 msg_attr(p, attr);
506 vim_free(p);
507 }
508 p = get_emsg_lnum();
509 if (p != NULL)
510 {
Bram Moolenaar8820b482017-03-16 17:23:31 +0100511 msg_attr(p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000512 vim_free(p);
513 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
514 }
515
516 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000517 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000518 {
519 vim_free(last_sourcing_name);
520 if (sourcing_name == NULL)
521 last_sourcing_name = NULL;
522 else
523 last_sourcing_name = vim_strsave(sourcing_name);
524 }
525 --no_wait_return;
526}
527
528/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000529 * Return TRUE if not giving error messages right now:
530 * If "emsg_off" is set: no error messages at the moment.
531 * If "msg" is in 'debug': do error message but without side effects.
532 * If "emsg_skip" is set: never do error messages.
533 */
534 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100535emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000536{
537 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
538 && vim_strchr(p_debug, 't') == NULL)
539#ifdef FEAT_EVAL
540 || emsg_skip > 0
541#endif
542 )
543 return TRUE;
544 return FALSE;
545}
546
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100547#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100548static garray_T ignore_error_list = GA_EMPTY;
549
550 void
551ignore_error_for_testing(char_u *error)
552{
553 if (ignore_error_list.ga_itemsize == 0)
554 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
555
Bram Moolenaar461a7fc2018-12-22 13:28:07 +0100556 if (STRCMP("RESET", error) == 0)
557 ga_clear_strings(&ignore_error_list);
558 else
559 ga_add_string(&ignore_error_list, error);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100560}
561
562 static int
563ignore_error(char_u *msg)
564{
565 int i;
566
567 for (i = 0; i < ignore_error_list.ga_len; ++i)
568 if (strstr((char *)msg,
569 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
570 return TRUE;
571 return FALSE;
572}
573#endif
574
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200575#if !defined(HAVE_STRERROR) || defined(PROTO)
576/*
577 * Replacement for perror() that behaves more or less like emsg() was called.
578 * v:errmsg will be set and called_emsg will be set.
579 */
580 void
581do_perror(char *msg)
582{
583 perror(msg);
584 ++emsg_silent;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100585 emsg(msg);
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200586 --emsg_silent;
587}
588#endif
589
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000590/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100591 * emsg_core() - display an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 *
593 * Rings the bell, if appropriate, and calls message() to do the real work
594 * When terminal not initialized (yet) mch_errmsg(..) is used.
595 *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100596 * Return TRUE if wait_return not called.
597 * Note: caller must check 'emsg_not_now()' before calling this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100599 static int
600emsg_core(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601{
602 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100604 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605#ifdef FEAT_EVAL
606 int ignore = FALSE;
607 int severe;
608#endif
609
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100610#ifdef FEAT_EVAL
611 /* When testing some errors are turned into a normal message. */
612 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100613 /* don't call msg() if it results in a dialog */
614 return msg_use_printf() ? FALSE : msg(s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100615#endif
616
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 called_emsg = TRUE;
618
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619#ifdef FEAT_EVAL
Bram Moolenaare723c422017-09-06 23:40:10 +0200620 /* If "emsg_severe" is TRUE: When an error exception is to be thrown,
621 * prefer this message over previous messages for the same command. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622 severe = emsg_severe;
623 emsg_severe = FALSE;
624#endif
625
Bram Moolenaar57657d82006-04-21 22:12:41 +0000626 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627 {
628#ifdef FEAT_EVAL
629 /*
630 * Cause a throw of an error exception if appropriate. Don't display
631 * the error message in this case. (If no matching catch clause will
632 * be found, the message will be displayed later on.) "ignore" is set
633 * when the message should be ignored completely (used for the
634 * interrupt message).
635 */
636 if (cause_errthrow(s, severe, &ignore) == TRUE)
637 {
638 if (!ignore)
Bram Moolenaar76a63452018-11-28 20:38:37 +0100639 ++did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 return TRUE;
641 }
642
643 /* set "v:errmsg", also when using ":silent! cmd" */
644 set_vim_var_string(VV_ERRMSG, s, -1);
645#endif
646
647 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000648 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 * But do write it to the redirection file.
650 */
651 if (emsg_silent != 0)
652 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200653 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200655 msg_start();
656 p = get_emsg_source();
657 if (p != NULL)
658 {
659 STRCAT(p, "\n");
660 redir_write(p, -1);
661 vim_free(p);
662 }
663 p = get_emsg_lnum();
664 if (p != NULL)
665 {
666 STRCAT(p, "\n");
667 redir_write(p, -1);
668 vim_free(p);
669 }
670 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100672#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200673 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100674#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 return TRUE;
676 }
677
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100678 ex_exitval = 1;
679
Bram Moolenaar2f40d122017-10-24 21:49:36 +0200680 /* Reset msg_silent, an error causes messages to be switched back on.
681 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 msg_silent = 0;
683 cmd_silent = FALSE;
684
685 if (global_busy) /* break :global command */
686 ++global_busy;
687
688 if (p_eb)
689 beep_flush(); /* also includes flush_buffers() */
690 else
Bram Moolenaar6a2633b2018-10-07 23:16:36 +0200691 flush_buffers(FLUSH_MINIMAL); // flush internal buffers
Bram Moolenaar76a63452018-11-28 20:38:37 +0100692 ++did_emsg; // flag for DoOneCmd()
Bram Moolenaare723c422017-09-06 23:40:10 +0200693#ifdef FEAT_EVAL
694 did_uncaught_emsg = TRUE;
695#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 }
697
698 emsg_on_display = TRUE; /* remember there is an error message */
699 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100700 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000701 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 need_wait_return = TRUE; /* needed in case emsg() is called after
703 * wait_return has reset need_wait_return
704 * and a redraw is expected because
705 * msg_scrolled is non-zero */
706
Bram Moolenaar958dc692016-12-01 15:34:12 +0100707#ifdef FEAT_JOB_CHANNEL
708 emsg_to_channel_log = TRUE;
709#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 /*
711 * Display name and line number for the source of the error.
712 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000713 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714
715 /*
716 * Display the error message itself.
717 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000718 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar958dc692016-12-01 15:34:12 +0100719 r = msg_attr(s, attr);
720
721#ifdef FEAT_JOB_CHANNEL
722 emsg_to_channel_log = FALSE;
723#endif
724 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725}
726
727/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100728 * Print an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 */
730 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100731emsg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100733 /* Skip this if not giving error messages at the moment. */
734 if (!emsg_not_now())
735 return emsg_core((char_u *)s);
736 return TRUE; /* no error messages at the moment */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737}
738
Bram Moolenaar95f09602016-11-10 20:01:45 +0100739/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100740 * Print an error message with format string and variable arguments.
741 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100742 */
743 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100744semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100745{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100746 /* Skip this if not giving error messages at the moment. */
747 if (!emsg_not_now())
748 {
749 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100750
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100751 va_start(ap, s);
752 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
753 va_end(ap);
754 return emsg_core(IObuff);
755 }
756 return TRUE; /* no error messages at the moment */
Bram Moolenaar95f09602016-11-10 20:01:45 +0100757}
758
759/*
760 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
761 * defined. It is used for internal errors only, so that they can be
762 * detected when fuzzing vim.
763 */
764 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100765iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100766{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100767 if (!emsg_not_now())
768 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100769#ifdef ABORT_ON_INTERNAL_ERROR
770 abort();
771#endif
772}
773
774/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100776 * defined. It is used for internal errors only, so that they can be
777 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100779 */
780 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100781siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100782{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100783 if (!emsg_not_now())
784 {
785 va_list ap;
786
787 va_start(ap, s);
788 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
789 va_end(ap);
790 emsg_core(IObuff);
791 }
Bram Moolenaar95f09602016-11-10 20:01:45 +0100792#ifdef ABORT_ON_INTERNAL_ERROR
793 abort();
794#endif
795}
796
797/*
798 * Give an "Internal error" message.
799 */
800 void
801internal_error(char *where)
802{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100803 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100804}
805
Bram Moolenaarea424162005-06-16 21:51:00 +0000806/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
Bram Moolenaardf177f62005-02-22 08:39:57 +0000808 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100809emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000810{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100811 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000812}
813
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814/*
815 * Like msg(), but truncate to a single line if p_shm contains 't', or when
816 * "force" is TRUE. This truncates in another way as for normal messages.
817 * Careful: The string may be changed by msg_may_trunc()!
818 * Returns a pointer to the printed message, if wait_return() not called.
819 */
820 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100821msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822{
823 int n;
824
825 /* Add message to history before truncating */
826 add_msg_hist(s, -1, attr);
827
828 s = msg_may_trunc(force, s);
829
830 msg_hist_off = TRUE;
831 n = msg_attr(s, attr);
832 msg_hist_off = FALSE;
833
834 if (n)
835 return s;
836 return NULL;
837}
838
839/*
840 * Check if message "s" should be truncated at the start (for filenames).
841 * Return a pointer to where the truncated message starts.
842 * Note: May change the message by replacing a character with '<'.
843 */
844 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100845msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846{
847 int n;
848 int room;
849
850 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
851 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
852 && (n = (int)STRLEN(s) - room) > 0)
853 {
854#ifdef FEAT_MBYTE
855 if (has_mbyte)
856 {
857 int size = vim_strsize(s);
858
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000859 /* There may be room anyway when there are multibyte chars. */
860 if (size <= room)
861 return s;
862
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 for (n = 0; size >= room; )
864 {
865 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000866 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 }
868 --n;
869 }
870#endif
871 s += n;
872 *s = '<';
873 }
874 return s;
875}
876
877 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100878add_msg_hist(
879 char_u *s,
880 int len, /* -1 for undetermined length */
881 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882{
883 struct msg_hist *p;
884
885 if (msg_hist_off || msg_silent != 0)
886 return;
887
888 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000889 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000890 (void)delete_first_msg();
891
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 /* allocate an entry and add the message at the end of the history */
893 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
894 if (p != NULL)
895 {
896 if (len < 0)
897 len = (int)STRLEN(s);
898 /* remove leading and trailing newlines */
899 while (len > 0 && *s == '\n')
900 {
901 ++s;
902 --len;
903 }
904 while (len > 0 && s[len - 1] == '\n')
905 --len;
906 p->msg = vim_strnsave(s, len);
907 p->next = NULL;
908 p->attr = attr;
909 if (last_msg_hist != NULL)
910 last_msg_hist->next = p;
911 last_msg_hist = p;
912 if (first_msg_hist == NULL)
913 first_msg_hist = last_msg_hist;
914 ++msg_hist_len;
915 }
916}
917
918/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000919 * Delete the first (oldest) message from the history.
920 * Returns FAIL if there are no messages.
921 */
922 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100923delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000924{
925 struct msg_hist *p;
926
927 if (msg_hist_len <= 0)
928 return FAIL;
929 p = first_msg_hist;
930 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000931 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200932 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000933 vim_free(p->msg);
934 vim_free(p);
935 --msg_hist_len;
936 return OK;
937}
938
939/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 * ":messages" command.
941 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200943ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944{
945 struct msg_hist *p;
946 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200947 int c = 0;
948
949 if (STRCMP(eap->arg, "clear") == 0)
950 {
951 int keep = eap->addr_count == 0 ? 0 : eap->line2;
952
953 while (msg_hist_len > keep)
954 (void)delete_first_msg();
955 return;
956 }
957
958 if (*eap->arg != NUL)
959 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100960 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200961 return;
962 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 msg_hist_off = TRUE;
965
Bram Moolenaar451f8492016-04-14 17:16:22 +0200966 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200967 if (eap->addr_count != 0)
968 {
969 /* Count total messages */
970 for (; p != NULL && !got_int; p = p->next)
971 c++;
972
973 c -= eap->line2;
974
975 /* Skip without number of messages specified */
976 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
977 p = p->next, c--);
978 }
979
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200980 if (p == first_msg_hist)
981 {
982 s = mch_getenv((char_u *)"LANG");
983 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +0200984 // The next comment is extracted by xgettext and put in po file for
985 // translators to read.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200986 msg_attr((char_u *)
Bram Moolenaar0c183192018-06-28 14:54:43 +0200987 // Translator: Please replace the name and email address
988 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200989 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100990 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200991 }
992
Bram Moolenaar451f8492016-04-14 17:16:22 +0200993 /* Display what was not skipped. */
994 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 if (p->msg != NULL)
996 msg_attr(p->msg, p->attr);
997
998 msg_hist_off = FALSE;
999}
1000
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001001#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002/*
1003 * Call this after prompting the user. This will avoid a hit-return message
1004 * and a delay.
1005 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001006 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001007msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008{
1009 need_wait_return = FALSE;
1010 emsg_on_display = FALSE;
1011 cmdline_row = msg_row;
1012 msg_col = 0;
1013 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001014 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015}
1016#endif
1017
1018/*
1019 * wait for the user to hit a key (normally a return)
1020 * if 'redraw' is TRUE, clear and redraw the screen
1021 * if 'redraw' is FALSE, just redraw the screen
1022 * if 'redraw' is -1, don't redraw at all
1023 */
1024 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001025wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026{
1027 int c;
1028 int oldState;
1029 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001031 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001032 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 if (redraw == TRUE)
1035 must_redraw = CLEAR;
1036
1037 /* If using ":silent cmd", don't wait for a return. Also don't set
1038 * need_wait_return to do it later. */
1039 if (msg_silent != 0)
1040 return;
1041
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001042 /*
1043 * When inside vgetc(), we can't wait for a typed character at all.
1044 * With the global command (and some others) we only need one return at
1045 * the end. Adjust cmdline_row to avoid the next message overwriting the
1046 * last one.
1047 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001048 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001050 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 if (no_wait_return)
1052 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 if (!exmode_active)
1054 cmdline_row = msg_row;
1055 return;
1056 }
1057
1058 redir_off = TRUE; /* don't redirect this message */
1059 oldState = State;
1060 if (quit_more)
1061 {
1062 c = CAR; /* just pretend CR was hit */
1063 quit_more = FALSE;
1064 got_int = FALSE;
1065 }
1066 else if (exmode_active)
1067 {
1068 MSG_PUTS(" "); /* make sure the cursor is on the right line */
1069 c = CAR; /* no need for a return in ex mode */
1070 got_int = FALSE;
1071 }
1072 else
1073 {
1074 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1075 * just changed. */
1076 screenalloc(FALSE);
1077
1078 State = HITRETURN;
1079#ifdef FEAT_MOUSE
1080 setmouse();
1081#endif
1082#ifdef USE_ON_FLY_SCROLL
1083 dont_scroll = TRUE; /* disallow scrolling here */
1084#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001085 cmdline_row = msg_row;
1086
Bram Moolenaarec38d692013-04-24 15:12:32 +02001087 /* Avoid the sequence that the user types ":" at the hit-return prompt
1088 * to start an Ex command, but the file-changed dialog gets in the
1089 * way. */
1090 if (need_check_timestamps)
1091 check_timestamps(FALSE);
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 hit_return_msg();
1094
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 do
1096 {
1097 /* Remember "got_int", if it is set vgetc() probably returns a
1098 * CTRL-C, but we need to loop then. */
1099 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001100
1101 /* Don't do mappings here, we put the character back in the
1102 * typeahead buffer. */
1103 ++no_mapping;
1104 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001105
1106 /* Temporarily disable Recording. If Recording is active, the
1107 * character will be recorded later, since it will be added to the
1108 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001109 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001110 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001111 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001112 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001114 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001116 --no_mapping;
1117 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001118 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001119 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001120
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121#ifdef FEAT_CLIPBOARD
1122 /* Strange way to allow copying (yanking) a modeless selection at
1123 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1124 * Cmdline-mode and it's harmless when there is no selection. */
1125 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1126 {
1127 clip_copy_modeless_selection(TRUE);
1128 c = K_IGNORE;
1129 }
1130#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001131
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001132 /*
1133 * Allow scrolling back in the messages.
1134 * Also accept scroll-down commands when messages fill the screen,
1135 * to avoid that typing one 'j' too many makes the messages
1136 * disappear.
1137 */
1138 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001139 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001140 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1141 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001142 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001143 if (msg_scrolled > Rows)
1144 /* scroll back to show older messages */
1145 do_more_prompt(c);
1146 else
1147 {
1148 msg_didout = FALSE;
1149 c = K_IGNORE;
1150 msg_col =
1151#ifdef FEAT_RIGHTLEFT
1152 cmdmsg_rl ? Columns - 1 :
1153#endif
1154 0;
1155 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001156 if (quit_more)
1157 {
1158 c = CAR; /* just pretend CR was hit */
1159 quit_more = FALSE;
1160 got_int = FALSE;
1161 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001162 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001163 {
1164 c = K_IGNORE;
1165 hit_return_msg();
1166 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001167 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001168 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001169 && (c == 'j' || c == 'd' || c == 'f'
1170 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001171 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001172 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 } while ((had_got_int && c == Ctrl_C)
1174 || c == K_IGNORE
1175#ifdef FEAT_GUI
1176 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1177#endif
1178#ifdef FEAT_MOUSE
1179 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1180 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1181 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001182 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001184 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 || (!mouse_has(MOUSE_RETURN)
1186 && mouse_row < msg_row
1187 && (c == K_LEFTMOUSE
1188 || c == K_MIDDLEMOUSE
1189 || c == K_RIGHTMOUSE
1190 || c == K_X1MOUSE
1191 || c == K_X2MOUSE))
1192#endif
1193 );
1194 ui_breakcheck();
1195#ifdef FEAT_MOUSE
1196 /*
1197 * Avoid that the mouse-up event causes visual mode to start.
1198 */
1199 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1200 || c == K_X1MOUSE || c == K_X2MOUSE)
1201 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1202 else
1203#endif
1204 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1205 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001206 /* Put the character back in the typeahead buffer. Don't use the
1207 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001208 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001210 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 }
1213 redir_off = FALSE;
1214
1215 /*
1216 * If the user hits ':', '?' or '/' we get a command line from the next
1217 * line.
1218 */
1219 if (c == ':' || c == '?' || c == '/')
1220 {
1221 if (!exmode_active)
1222 cmdline_row = msg_row;
1223 skip_redraw = TRUE; /* skip redraw once */
1224 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001225#ifdef FEAT_TERMINAL
1226 skip_term_loop = TRUE;
1227#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 }
1229
1230 /*
1231 * If the window size changed set_shellsize() will redraw the screen.
1232 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1233 * typed.
1234 */
1235 tmpState = State;
1236 State = oldState; /* restore State before set_shellsize */
1237#ifdef FEAT_MOUSE
1238 setmouse();
1239#endif
1240 msg_check();
1241
1242#if defined(UNIX) || defined(VMS)
1243 /*
1244 * When switching screens, we need to output an extra newline on exit.
1245 */
1246 if (swapping_screen() && !termcap_active)
1247 newline_on_exit = TRUE;
1248#endif
1249
1250 need_wait_return = FALSE;
1251 did_wait_return = TRUE;
1252 emsg_on_display = FALSE; /* can delete error message now */
1253 lines_left = -1; /* reset lines_left at next msg_start() */
1254 reset_last_sourcing();
1255 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1256 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001257 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1260 {
1261 starttermcap(); /* start termcap before redrawing */
1262 shell_resized();
1263 }
1264 else if (!skip_redraw
1265 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1266 {
1267 starttermcap(); /* start termcap before redrawing */
1268 redraw_later(VALID);
1269 }
1270}
1271
1272/*
1273 * Write the hit-return prompt.
1274 */
1275 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001276hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001278 int save_p_more = p_more;
1279
1280 p_more = FALSE; /* don't want see this message when scrolling back */
1281 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 msg_putchar('\n');
1283 if (got_int)
1284 MSG_PUTS(_("Interrupt: "));
1285
Bram Moolenaar8820b482017-03-16 17:23:31 +01001286 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 if (!msg_use_printf())
1288 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001289 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290}
1291
1292/*
1293 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1294 */
1295 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001296set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297{
1298 vim_free(keep_msg);
1299 if (s != NULL && msg_silent == 0)
1300 keep_msg = vim_strsave(s);
1301 else
1302 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001303 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001304 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305}
1306
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001307#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1308/*
1309 * If there currently is a message being displayed, set "keep_msg" to it, so
1310 * that it will be displayed again after redraw.
1311 */
1312 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001313set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001314{
1315 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1316 && (State & NORMAL))
1317 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1318}
1319#endif
1320
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321/*
1322 * Prepare for outputting characters in the command line.
1323 */
1324 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001325msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326{
1327 int did_return = FALSE;
1328
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001329 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001330 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001331
1332#ifdef FEAT_EVAL
1333 if (need_clr_eos)
1334 {
1335 /* Halfway an ":echo" command and getting an (error) message: clear
1336 * any text from the command. */
1337 need_clr_eos = FALSE;
1338 msg_clr_eos();
1339 }
1340#endif
1341
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 if (!msg_scroll && full_screen) /* overwrite last message */
1343 {
1344 msg_row = cmdline_row;
1345 msg_col =
1346#ifdef FEAT_RIGHTLEFT
1347 cmdmsg_rl ? Columns - 1 :
1348#endif
1349 0;
1350 }
1351 else if (msg_didout) /* start message on next line */
1352 {
1353 msg_putchar('\n');
1354 did_return = TRUE;
1355 if (exmode_active != EXMODE_NORMAL)
1356 cmdline_row = msg_row;
1357 }
1358 if (!msg_didany || lines_left < 0)
1359 msg_starthere();
1360 if (msg_silent == 0)
1361 {
1362 msg_didout = FALSE; /* no output on current line yet */
1363 cursor_off();
1364 }
1365
1366 /* when redirecting, may need to start a new line. */
1367 if (!did_return)
1368 redir_write((char_u *)"\n", -1);
1369}
1370
1371/*
1372 * Note that the current msg position is where messages start.
1373 */
1374 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001375msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376{
1377 lines_left = cmdline_row;
1378 msg_didany = FALSE;
1379}
1380
1381 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001382msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383{
1384 msg_putchar_attr(c, 0);
1385}
1386
1387 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001388msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389{
1390#ifdef FEAT_MBYTE
1391 char_u buf[MB_MAXBYTES + 1];
1392#else
1393 char_u buf[4];
1394#endif
1395
1396 if (IS_SPECIAL(c))
1397 {
1398 buf[0] = K_SPECIAL;
1399 buf[1] = K_SECOND(c);
1400 buf[2] = K_THIRD(c);
1401 buf[3] = NUL;
1402 }
1403 else
1404 {
1405#ifdef FEAT_MBYTE
1406 buf[(*mb_char2bytes)(c, buf)] = NUL;
1407#else
1408 buf[0] = c;
1409 buf[1] = NUL;
1410#endif
1411 }
1412 msg_puts_attr(buf, attr);
1413}
1414
1415 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001416msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417{
1418 char_u buf[20];
1419
1420 sprintf((char *)buf, "%ld", n);
1421 msg_puts(buf);
1422}
1423
1424 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001425msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426{
1427 msg_home_replace_attr(fname, 0);
1428}
1429
1430#if defined(FEAT_FIND_ID) || defined(PROTO)
1431 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001432msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001434 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435}
1436#endif
1437
1438 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001439msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440{
1441 char_u *name;
1442
1443 name = home_replace_save(NULL, fname);
1444 if (name != NULL)
1445 msg_outtrans_attr(name, attr);
1446 vim_free(name);
1447}
1448
1449/*
1450 * Output 'len' characters in 'str' (including NULs) with translation
1451 * if 'len' is -1, output upto a NUL character.
1452 * Use attributes 'attr'.
1453 * Return the number of characters it takes on the screen.
1454 */
1455 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001456msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457{
1458 return msg_outtrans_attr(str, 0);
1459}
1460
1461 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001462msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463{
1464 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1465}
1466
1467 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001468msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469{
1470 return msg_outtrans_len_attr(str, len, 0);
1471}
1472
1473/*
1474 * Output one character at "p". Return pointer to the next character.
1475 * Handles multi-byte characters.
1476 */
1477 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001478msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479{
1480#ifdef FEAT_MBYTE
1481 int l;
1482
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001483 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 {
1485 msg_outtrans_len_attr(p, l, attr);
1486 return p + l;
1487 }
1488#endif
1489 msg_puts_attr(transchar_byte(*p), attr);
1490 return p + 1;
1491}
1492
1493 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001494msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495{
1496 int retval = 0;
1497 char_u *str = msgstr;
1498 char_u *plain_start = msgstr;
1499 char_u *s;
1500#ifdef FEAT_MBYTE
1501 int mb_l;
1502 int c;
1503#endif
1504
1505 /* if MSG_HIST flag set, add message to history */
1506 if (attr & MSG_HIST)
1507 {
1508 add_msg_hist(str, len, attr);
1509 attr &= ~MSG_HIST;
1510 }
1511
1512#ifdef FEAT_MBYTE
1513 /* If the string starts with a composing character first draw a space on
1514 * which the composing char can be drawn. */
1515 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1516 msg_puts_attr((char_u *)" ", attr);
1517#endif
1518
1519 /*
1520 * Go over the string. Special characters are translated and printed.
1521 * Normal characters are printed several at a time.
1522 */
1523 while (--len >= 0)
1524 {
1525#ifdef FEAT_MBYTE
1526 if (enc_utf8)
1527 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001528 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001530 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 else
1532 mb_l = 1;
1533 if (has_mbyte && mb_l > 1)
1534 {
1535 c = (*mb_ptr2char)(str);
1536 if (vim_isprintc(c))
1537 /* printable multi-byte char: count the cells. */
1538 retval += (*mb_ptr2cells)(str);
1539 else
1540 {
1541 /* unprintable multi-byte char: print the printable chars so
1542 * far and the translation of the unprintable char. */
1543 if (str > plain_start)
1544 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1545 attr);
1546 plain_start = str + mb_l;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001547 msg_puts_attr(transchar(c), attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 retval += char2cells(c);
1549 }
1550 len -= mb_l - 1;
1551 str += mb_l;
1552 }
1553 else
1554#endif
1555 {
1556 s = transchar_byte(*str);
1557 if (s[1] != NUL)
1558 {
1559 /* unprintable char: print the printable chars so far and the
1560 * translation of the unprintable char. */
1561 if (str > plain_start)
1562 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1563 attr);
1564 plain_start = str + 1;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001565 msg_puts_attr(s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001566 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001568 else
1569 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 ++str;
1571 }
1572 }
1573
1574 if (str > plain_start)
1575 /* print the printable chars at the end */
1576 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1577
1578 return retval;
1579}
1580
1581#if defined(FEAT_QUICKFIX) || defined(PROTO)
1582 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001583msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584{
1585 int i;
1586 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1587
1588 arg = skipwhite(arg);
1589 for (i = 5; *arg && i >= 0; --i)
1590 if (*arg++ != str[i])
1591 break;
1592 if (i < 0)
1593 {
1594 msg_putchar('\n');
1595 for (i = 0; rs[i]; ++i)
1596 msg_putchar(rs[i] - 3);
1597 }
1598}
1599#endif
1600
1601/*
1602 * Output the string 'str' upto a NUL character.
1603 * Return the number of characters it takes on the screen.
1604 *
1605 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1606 * following character and shown as <F1>, <S-Up> etc. Any other character
1607 * which is not printable shown in <> form.
1608 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1609 * If a character is displayed in one of these special ways, is also
1610 * highlighted (its highlight name is '8' in the p_hl variable).
1611 * Otherwise characters are not highlighted.
1612 * This function is used to show mappings, where we want to see how to type
1613 * the character/string -- webb
1614 */
1615 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001616msg_outtrans_special(
1617 char_u *strstart,
1618 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619{
1620 char_u *str = strstart;
1621 int retval = 0;
1622 char_u *string;
1623 int attr;
1624 int len;
1625
Bram Moolenaar8820b482017-03-16 17:23:31 +01001626 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 while (*str != NUL)
1628 {
1629 /* Leading and trailing spaces need to be displayed in <> form. */
1630 if ((str == strstart || str[1] == NUL) && *str == ' ')
1631 {
1632 string = (char_u *)"<Space>";
1633 ++str;
1634 }
1635 else
1636 string = str2special(&str, from);
1637 len = vim_strsize(string);
1638 /* Highlight special keys */
1639 msg_puts_attr(string, len > 1
1640#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001641 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642#endif
1643 ? attr : 0);
1644 retval += len;
1645 }
1646 return retval;
1647}
1648
Bram Moolenaarbd743252010-10-20 21:23:33 +02001649#if defined(FEAT_EVAL) || defined(PROTO)
1650/*
1651 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1652 * strings, in an allocated string.
1653 */
1654 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001655str2special_save(
1656 char_u *str,
1657 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001658{
1659 garray_T ga;
1660 char_u *p = str;
1661
1662 ga_init2(&ga, 1, 40);
1663 while (*p != NUL)
1664 ga_concat(&ga, str2special(&p, is_lhs));
1665 ga_append(&ga, NUL);
1666 return (char_u *)ga.ga_data;
1667}
1668#endif
1669
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670/*
1671 * Return the printable string for the key codes at "*sp".
1672 * Used for translating the lhs or rhs of a mapping to printable chars.
1673 * Advances "sp" to the next code.
1674 */
1675 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001676str2special(
1677 char_u **sp,
1678 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679{
1680 int c;
1681 static char_u buf[7];
1682 char_u *str = *sp;
1683 int modifiers = 0;
1684 int special = FALSE;
1685
1686#ifdef FEAT_MBYTE
1687 if (has_mbyte)
1688 {
1689 char_u *p;
1690
1691 /* Try to un-escape a multi-byte character. Return the un-escaped
1692 * string if it is a multi-byte character. */
1693 p = mb_unescape(sp);
1694 if (p != NULL)
1695 return p;
1696 }
1697#endif
1698
1699 c = *str;
1700 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1701 {
1702 if (str[1] == KS_MODIFIER)
1703 {
1704 modifiers = str[2];
1705 str += 3;
1706 c = *str;
1707 }
1708 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1709 {
1710 c = TO_SPECIAL(str[1], str[2]);
1711 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 }
1713 if (IS_SPECIAL(c) || modifiers) /* special key */
1714 special = TRUE;
1715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716
1717#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001718 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001720 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001721
1722 /* For multi-byte characters check for an illegal byte. */
1723 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1724 {
1725 transchar_nonprint(buf, c);
1726 *sp = str + 1;
1727 return buf;
1728 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001729 /* Since 'special' is TRUE the multi-byte character 'c' will be
1730 * processed by get_special_key_name() */
1731 c = (*mb_ptr2char)(str);
1732 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001734 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001736 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1739 * Use <Space> only for lhs of a mapping. */
1740 if (special || char2cells(c) > 1 || (from && c == ' '))
1741 return get_special_key_name(c, modifiers);
1742 buf[0] = c;
1743 buf[1] = NUL;
1744 return buf;
1745}
1746
1747/*
1748 * Translate a key sequence into special key names.
1749 */
1750 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001751str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752{
1753 char_u *s;
1754
1755 *buf = NUL;
1756 while (*sp)
1757 {
1758 s = str2special(&sp, FALSE);
1759 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1760 STRCAT(buf, s);
1761 }
1762}
1763
1764/*
1765 * print line for :print or :list command
1766 */
1767 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001768msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769{
1770 int c;
1771 int col = 0;
1772 int n_extra = 0;
1773 int c_extra = 0;
1774 char_u *p_extra = NULL; /* init to make SASC shut up */
1775 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001776 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 char_u *trail = NULL;
1778#ifdef FEAT_MBYTE
1779 int l;
1780 char_u buf[MB_MAXBYTES + 1];
1781#endif
1782
Bram Moolenaardf177f62005-02-22 08:39:57 +00001783 if (curwin->w_p_list)
1784 list = TRUE;
1785
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001787 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 {
1789 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001790 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 --trail;
1792 }
1793
1794 /* output a space for an empty line, otherwise the line will be
1795 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001796 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 msg_putchar(' ');
1798
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001799 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001801 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
1803 --n_extra;
1804 if (c_extra)
1805 c = c_extra;
1806 else
1807 c = *p_extra++;
1808 }
1809#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001810 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 {
1812 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001813 if (lcs_nbsp != NUL && list
1814 && (mb_ptr2char(s) == 160
1815 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001816 {
1817 mb_char2bytes(lcs_nbsp, buf);
1818 buf[(*mb_ptr2len)(buf)] = NUL;
1819 }
1820 else
1821 {
1822 mch_memmove(buf, s, (size_t)l);
1823 buf[l] = NUL;
1824 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001825 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 s += l;
1827 continue;
1828 }
1829#endif
1830 else
1831 {
1832 attr = 0;
1833 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001834 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 {
1836 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001837#ifdef FEAT_VARTABS
1838 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1839 curbuf->b_p_vts_array) - 1;
1840#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001842#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001843 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 {
1845 c = ' ';
1846 c_extra = ' ';
1847 }
1848 else
1849 {
1850 c = lcs_tab1;
1851 c_extra = lcs_tab2;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001852 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 }
1854 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001855 else if (c == 160 && list && lcs_nbsp != NUL)
1856 {
1857 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001858 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001859 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001860 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 {
1862 p_extra = (char_u *)"";
1863 c_extra = NUL;
1864 n_extra = 1;
1865 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001866 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 --s;
1868 }
1869 else if (c != NUL && (n = byte2cells(c)) > 1)
1870 {
1871 n_extra = n - 1;
1872 p_extra = transchar_byte(c);
1873 c_extra = NUL;
1874 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001875 /* Use special coloring to be able to distinguish <hex> from
1876 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001877 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 }
1879 else if (c == ' ' && trail != NULL && s > trail)
1880 {
1881 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001882 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001884 else if (c == ' ' && list && lcs_space != NUL)
1885 {
1886 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001887 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001888 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 }
1890
1891 if (c == NUL)
1892 break;
1893
1894 msg_putchar_attr(c, attr);
1895 col++;
1896 }
1897 msg_clr_eos();
1898}
1899
1900#ifdef FEAT_MBYTE
1901/*
1902 * Use screen_puts() to output one multi-byte character.
1903 * Return the pointer "s" advanced to the next character.
1904 */
1905 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001906screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907{
1908 int cw;
1909
1910 msg_didout = TRUE; /* remember that line is not empty */
1911 cw = (*mb_ptr2cells)(s);
1912 if (cw > 1 && (
1913#ifdef FEAT_RIGHTLEFT
1914 cmdmsg_rl ? msg_col <= 1 :
1915#endif
1916 msg_col == Columns - 1))
1917 {
1918 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001919 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 return s;
1921 }
1922
1923 screen_puts_len(s, l, msg_row, msg_col, attr);
1924#ifdef FEAT_RIGHTLEFT
1925 if (cmdmsg_rl)
1926 {
1927 msg_col -= cw;
1928 if (msg_col == 0)
1929 {
1930 msg_col = Columns;
1931 ++msg_row;
1932 }
1933 }
1934 else
1935#endif
1936 {
1937 msg_col += cw;
1938 if (msg_col >= Columns)
1939 {
1940 msg_col = 0;
1941 ++msg_row;
1942 }
1943 }
1944 return s + l;
1945}
1946#endif
1947
1948/*
1949 * Output a string to the screen at position msg_row, msg_col.
1950 * Update msg_row and msg_col for the next message.
1951 */
1952 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001953msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001955 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956}
1957
1958 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001959msg_puts_title(
1960 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001962 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963}
1964
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965/*
1966 * Show a message in such a way that it always fits in the line. Cut out a
1967 * part in the middle and replace it with "..." when necessary.
1968 * Does not handle multi-byte characters!
1969 */
1970 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001971msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001973 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974}
1975
1976 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001977msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978{
1979 int slen = len;
1980 int room;
1981
1982 room = Columns - msg_col;
1983 if (len > room && room >= 20)
1984 {
1985 slen = (room - 3) / 2;
1986 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001987 msg_puts_attr((char_u *)"...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 }
1989 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1990}
1991
1992/*
1993 * Basic function for writing a message with highlight attributes.
1994 */
1995 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001996msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997{
1998 msg_puts_attr_len(s, -1, attr);
1999}
2000
2001/*
2002 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
2003 * When "maxlen" is -1 there is no maximum length.
2004 * When "maxlen" is >= 0 the message is not put in the history.
2005 */
2006 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002007msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 /*
2010 * If redirection is on, also write to the redirection file.
2011 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002012 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013
2014 /*
2015 * Don't print anything when using ":silent cmd".
2016 */
2017 if (msg_silent != 0)
2018 return;
2019
2020 /* if MSG_HIST flag set, add message to history */
2021 if ((attr & MSG_HIST) && maxlen < 0)
2022 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002023 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 attr &= ~MSG_HIST;
2025 }
2026
2027 /*
2028 * When writing something to the screen after it has scrolled, requires a
2029 * wait-return prompt later. Needed when scrolling, resetting
2030 * need_wait_return after some prompt, and then outputting something
2031 * without scrolling
2032 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002033 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 need_wait_return = TRUE;
2035 msg_didany = TRUE; /* remember that something was outputted */
2036
2037 /*
2038 * If there is no valid screen, use fprintf so we can see error messages.
2039 * If termcap is not active, we may be writing in an alternate console
2040 * window, cursor positioning may not work correctly (window size may be
2041 * different, e.g. for Win32 console) or we just don't know where the
2042 * cursor is.
2043 */
2044 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002045 msg_puts_printf(str, maxlen);
2046 else
2047 msg_puts_display(str, maxlen, attr, FALSE);
2048}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002050/*
2051 * The display part of msg_puts_attr_len().
2052 * May be called recursively to display scroll-back text.
2053 */
2054 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002055msg_puts_display(
2056 char_u *str,
2057 int maxlen,
2058 int attr,
2059 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002060{
2061 char_u *s = str;
2062 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2063 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
2064#ifdef FEAT_MBYTE
2065 int l;
2066 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002068 char_u *sb_str = str;
2069 int sb_col = msg_col;
2070 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002071 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
2073 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002074 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 {
2076 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002077 * We are at the end of the screen line when:
2078 * - When outputting a newline.
2079 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082#ifdef FEAT_RIGHTLEFT
2083 cmdmsg_rl
2084 ? (
2085 msg_col <= 1
2086 || (*s == TAB && msg_col <= 7)
2087# ifdef FEAT_MBYTE
2088 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
2089# endif
2090 )
2091 :
2092#endif
2093 (msg_col + t_col >= Columns - 1
2094 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
2095# ifdef FEAT_MBYTE
2096 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2097 && msg_col + t_col >= Columns - 2)
2098# endif
2099 ))))
2100 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002101 /*
2102 * The screen is scrolled up when at the last row (some terminals
2103 * scroll automatically, some don't. To avoid problems we scroll
2104 * ourselves).
2105 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002108 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002110 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 if (msg_no_more && lines_left == 0)
2112 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002114 /* Scroll the screen up one line. */
2115 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116
2117 msg_row = Rows - 2;
2118 if (msg_col >= Columns) /* can happen after screen resize */
2119 msg_col = Columns - 1;
2120
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002121 /* Display char in last column before showing more-prompt. */
2122 if (*s >= ' '
2123#ifdef FEAT_RIGHTLEFT
2124 && !cmdmsg_rl
2125#endif
2126 )
2127 {
2128#ifdef FEAT_MBYTE
2129 if (has_mbyte)
2130 {
2131 if (enc_utf8 && maxlen >= 0)
2132 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002133 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002134 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002135 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002136 s = screen_puts_mbyte(s, l, attr);
2137 }
2138 else
2139#endif
2140 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002141 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002142 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002143 else
2144 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002145
2146 if (p_more)
2147 /* store text for scrolling back */
2148 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2149
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002150 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002151 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 redraw_cmdline = TRUE;
2153 if (cmdline_row > 0 && !exmode_active)
2154 --cmdline_row;
2155
2156 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002157 * If screen is completely filled and 'more' is set then wait
2158 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002160 if (lines_left > 0)
2161 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002162 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 && !msg_no_more && !exmode_active)
2164 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002166 if (do_more_prompt(NUL))
2167 s = confirm_msg_tail;
2168#else
2169 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170#endif
2171 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002172 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002174
2175 /* When we displayed a char in last column need to check if there
2176 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002177 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002178 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 }
2180
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002181 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 || msg_col + t_col >= Columns
2183#ifdef FEAT_MBYTE
2184 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2185 && msg_col + t_col >= Columns - 1)
2186#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002187 ;
2188 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2189 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002191 t_puts(&t_col, t_s, s, attr);
2192
2193 if (wrap && p_more && !recurse)
2194 /* store text for scrolling back */
2195 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196
2197 if (*s == '\n') /* go to next line */
2198 {
2199 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002200#ifdef FEAT_RIGHTLEFT
2201 if (cmdmsg_rl)
2202 msg_col = Columns - 1;
2203 else
2204#endif
2205 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 if (++msg_row >= Rows) /* safety check */
2207 msg_row = Rows - 1;
2208 }
2209 else if (*s == '\r') /* go to column 0 */
2210 {
2211 msg_col = 0;
2212 }
2213 else if (*s == '\b') /* go to previous char */
2214 {
2215 if (msg_col)
2216 --msg_col;
2217 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002218 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 {
2220 do
2221 msg_screen_putchar(' ', attr);
2222 while (msg_col & 7);
2223 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002224 else if (*s == BELL) /* beep (from ":sh") */
2225 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 else
2227 {
2228#ifdef FEAT_MBYTE
2229 if (has_mbyte)
2230 {
2231 cw = (*mb_ptr2cells)(s);
2232 if (enc_utf8 && maxlen >= 0)
2233 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002234 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002236 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 }
2238 else
2239 {
2240 cw = 1;
2241 l = 1;
2242 }
2243#endif
2244 /* When drawing from right to left or when a double-wide character
2245 * doesn't fit, draw a single character here. Otherwise collect
2246 * characters and draw them all at once later. */
2247#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2248 if (
2249# ifdef FEAT_RIGHTLEFT
2250 cmdmsg_rl
2251# ifdef FEAT_MBYTE
2252 ||
2253# endif
2254# endif
2255# ifdef FEAT_MBYTE
2256 (cw > 1 && msg_col + t_col >= Columns - 1)
2257# endif
2258 )
2259 {
2260# ifdef FEAT_MBYTE
2261 if (l > 1)
2262 s = screen_puts_mbyte(s, l, attr) - 1;
2263 else
2264# endif
2265 msg_screen_putchar(*s, attr);
2266 }
2267 else
2268#endif
2269 {
2270 /* postpone this character until later */
2271 if (t_col == 0)
2272 t_s = s;
2273#ifdef FEAT_MBYTE
2274 t_col += cw;
2275 s += l - 1;
2276#else
2277 ++t_col;
2278#endif
2279 }
2280 }
2281 ++s;
2282 }
2283
2284 /* output any postponed text */
2285 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002286 t_puts(&t_col, t_s, s, attr);
2287 if (p_more && !recurse)
2288 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289
2290 msg_check();
2291}
2292
2293/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002294 * Return TRUE when ":filter pattern" was used and "msg" does not match
2295 * "pattern".
2296 */
2297 int
2298message_filtered(char_u *msg)
2299{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002300 int match;
2301
2302 if (cmdmod.filter_regmatch.regprog == NULL)
2303 return FALSE;
2304 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2305 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002306}
2307
2308/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002309 * Scroll the screen up one line for displaying the next message line.
2310 */
2311 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002312msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002313{
2314#ifdef FEAT_GUI
2315 /* Remove the cursor before scrolling, ScreenLines[] is going
2316 * to become invalid. */
2317 if (gui.in_use)
2318 gui_undraw_cursor();
2319#endif
2320 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002321 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002322 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002323 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002324
2325 if (!can_clear((char_u *)" "))
2326 {
2327 /* Scrolling up doesn't result in the right background. Set the
2328 * background here. It's not efficient, but avoids that we have to do
2329 * it all over the code. */
2330 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2331
2332 /* Also clear the last char of the last but one line if it was not
2333 * cleared before to avoid a scroll-up. */
2334 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2335 screen_fill((int)Rows - 2, (int)Rows - 1,
2336 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2337 }
2338}
2339
2340/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002341 * Increment "msg_scrolled".
2342 */
2343 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002344inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002345{
2346#ifdef FEAT_EVAL
2347 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2348 {
2349 char_u *p = sourcing_name;
2350 char_u *tofree = NULL;
2351 int len;
2352
2353 /* v:scrollstart is empty, set it to the script/function name and line
2354 * number */
2355 if (p == NULL)
2356 p = (char_u *)_("Unknown");
2357 else
2358 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002359 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002360 tofree = alloc(len);
2361 if (tofree != NULL)
2362 {
2363 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2364 p, (long)sourcing_lnum);
2365 p = tofree;
2366 }
2367 }
2368 set_vim_var_string(VV_SCROLLSTART, p, -1);
2369 vim_free(tofree);
2370 }
2371#endif
2372 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002373 if (must_redraw < VALID)
2374 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002375}
2376
2377/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002378 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2379 * store the displayed text and remember where screen lines start.
2380 */
2381typedef struct msgchunk_S msgchunk_T;
2382struct msgchunk_S
2383{
2384 msgchunk_T *sb_next;
2385 msgchunk_T *sb_prev;
2386 char sb_eol; /* TRUE when line ends after this text */
2387 int sb_msg_col; /* column in which text starts */
2388 int sb_attr; /* text attributes */
2389 char_u sb_text[1]; /* text to be displayed, actually longer */
2390};
2391
2392static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2393
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002394static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002395
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002396typedef enum {
2397 SB_CLEAR_NONE = 0,
2398 SB_CLEAR_ALL,
2399 SB_CLEAR_CMDLINE_BUSY,
2400 SB_CLEAR_CMDLINE_DONE
2401} sb_clear_T;
2402
2403/* When to clear text on next msg. */
2404static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002405
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002406/*
2407 * Store part of a printed message for displaying when scrolling back.
2408 */
2409 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002410store_sb_text(
2411 char_u **sb_str, /* start of string */
2412 char_u *s, /* just after string */
2413 int attr,
2414 int *sb_col,
2415 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002416{
2417 msgchunk_T *mp;
2418
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002419 if (do_clear_sb_text == SB_CLEAR_ALL
2420 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002421 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002422 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2423 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002424 }
2425
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002426 if (s > *sb_str)
2427 {
2428 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2429 if (mp != NULL)
2430 {
2431 mp->sb_eol = finish;
2432 mp->sb_msg_col = *sb_col;
2433 mp->sb_attr = attr;
2434 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2435
2436 if (last_msgchunk == NULL)
2437 {
2438 last_msgchunk = mp;
2439 mp->sb_prev = NULL;
2440 }
2441 else
2442 {
2443 mp->sb_prev = last_msgchunk;
2444 last_msgchunk->sb_next = mp;
2445 last_msgchunk = mp;
2446 }
2447 mp->sb_next = NULL;
2448 }
2449 }
2450 else if (finish && last_msgchunk != NULL)
2451 last_msgchunk->sb_eol = TRUE;
2452
2453 *sb_str = s;
2454 *sb_col = 0;
2455}
2456
2457/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458 * Finished showing messages, clear the scroll-back text on the next message.
2459 */
2460 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002461may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002462{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002463 do_clear_sb_text = SB_CLEAR_ALL;
2464}
2465
2466/*
2467 * Starting to edit the command line, do not clear messages now.
2468 */
2469 void
2470sb_text_start_cmdline(void)
2471{
2472 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2473 msg_sb_eol();
2474}
2475
2476/*
2477 * Ending to edit the command line. Clear old lines but the last one later.
2478 */
2479 void
2480sb_text_end_cmdline(void)
2481{
2482 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002483}
2484
2485/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002486 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002487 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002488 * Called when redrawing the screen.
2489 */
2490 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002491clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002492{
2493 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002494 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002495
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002496 if (all)
2497 lastp = &last_msgchunk;
2498 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002499 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002500 if (last_msgchunk == NULL)
2501 return;
2502 lastp = &last_msgchunk->sb_prev;
2503 }
2504
2505 while (*lastp != NULL)
2506 {
2507 mp = (*lastp)->sb_prev;
2508 vim_free(*lastp);
2509 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002510 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002511}
2512
2513/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002514 * "g<" command.
2515 */
2516 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002517show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002518{
2519 msgchunk_T *mp;
2520
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002521 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002522 * weird, typing a command without output results in one line. */
2523 mp = msg_sb_start(last_msgchunk);
2524 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002525 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002526 else
2527 {
2528 do_more_prompt('G');
2529 wait_return(FALSE);
2530 }
2531}
2532
2533/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002534 * Move to the start of screen line in already displayed text.
2535 */
2536 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002537msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002538{
2539 msgchunk_T *mp = mps;
2540
2541 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2542 mp = mp->sb_prev;
2543 return mp;
2544}
2545
2546/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002547 * Mark the last message chunk as finishing the line.
2548 */
2549 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002550msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002551{
2552 if (last_msgchunk != NULL)
2553 last_msgchunk->sb_eol = TRUE;
2554}
2555
2556/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002557 * Display a screen line from previously displayed text at row "row".
2558 * Returns a pointer to the text for the next line (can be NULL).
2559 */
2560 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002561disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002562{
2563 msgchunk_T *mp = smp;
2564 char_u *p;
2565
2566 for (;;)
2567 {
2568 msg_row = row;
2569 msg_col = mp->sb_msg_col;
2570 p = mp->sb_text;
2571 if (*p == '\n') /* don't display the line break */
2572 ++p;
2573 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2574 if (mp->sb_eol || mp->sb_next == NULL)
2575 break;
2576 mp = mp->sb_next;
2577 }
2578 return mp->sb_next;
2579}
2580
2581/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 * Output any postponed text for msg_puts_attr_len().
2583 */
2584 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002585t_puts(
2586 int *t_col,
2587 char_u *t_s,
2588 char_u *s,
2589 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590{
2591 /* output postponed text */
2592 msg_didout = TRUE; /* remember that line is not empty */
2593 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002594 msg_col += *t_col;
2595 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596#ifdef FEAT_MBYTE
2597 /* If the string starts with a composing character don't increment the
2598 * column position for it. */
2599 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2600 --msg_col;
2601#endif
2602 if (msg_col >= Columns)
2603 {
2604 msg_col = 0;
2605 ++msg_row;
2606 }
2607}
2608
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609/*
2610 * Returns TRUE when messages should be printed with mch_errmsg().
2611 * This is used when there is no valid screen, so we can see error messages.
2612 * If termcap is not active, we may be writing in an alternate console
2613 * window, cursor positioning may not work correctly (window size may be
2614 * different, e.g. for Win32 console) or we just don't know where the
2615 * cursor is.
2616 */
2617 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002618msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619{
2620 return (!msg_check_screen()
2621#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2622 || !termcap_active
2623#endif
2624 || (swapping_screen() && !termcap_active)
2625 );
2626}
2627
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002628/*
2629 * Print a message when there is no valid screen.
2630 */
2631 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002632msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002633{
2634 char_u *s = str;
2635 char_u buf[4];
2636 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002637#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002638# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2639 char_u *ccp = NULL;
2640
2641# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002642 if (!(silent_mode && p_verbose == 0))
2643 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002644
2645# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2646 if (enc_codepage >= 0 && (int)GetConsoleCP() != enc_codepage)
2647 {
Bram Moolenaar116a0f82017-08-07 21:17:57 +02002648 int inlen = (int)STRLEN(str);
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002649 int outlen;
2650 WCHAR *widestr = (WCHAR *)enc_to_utf16(str, &inlen);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002651
2652 if (widestr != NULL)
2653 {
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002654 WideCharToMultiByte_alloc(GetConsoleCP(), 0, widestr, inlen,
2655 (LPSTR *)&ccp, &outlen, 0, 0);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002656 vim_free(widestr);
2657 s = str = ccp;
2658 }
2659 }
2660# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002661#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002662 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002663 {
2664 if (!(silent_mode && p_verbose == 0))
2665 {
2666 /* NL --> CR NL translation (for Unix, not for "--version") */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002667 p = &buf[0];
2668 if (*s == '\n' && !info_message)
2669 *p++ = '\r';
Bram Moolenaard0573012017-10-28 21:11:06 +02002670#if defined(USE_CR)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002671 else
2672#endif
2673 *p++ = *s;
2674 *p = '\0';
2675 if (info_message) /* informative message, not an error */
2676 mch_msg((char *)buf);
2677 else
2678 mch_errmsg((char *)buf);
2679 }
2680
2681 /* primitive way to compute the current column */
2682#ifdef FEAT_RIGHTLEFT
2683 if (cmdmsg_rl)
2684 {
2685 if (*s == '\r' || *s == '\n')
2686 msg_col = Columns - 1;
2687 else
2688 --msg_col;
2689 }
2690 else
2691#endif
2692 {
2693 if (*s == '\r' || *s == '\n')
2694 msg_col = 0;
2695 else
2696 ++msg_col;
2697 }
2698 ++s;
2699 }
2700 msg_didout = TRUE; /* assume that line is not empty */
2701
2702#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002703# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2704 vim_free(ccp);
2705# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002706 if (!(silent_mode && p_verbose == 0))
2707 mch_settmode(TMODE_RAW);
2708#endif
2709}
2710
2711/*
2712 * Show the more-prompt and handle the user response.
2713 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002714 * When at hit-enter prompt "typed_char" is the already typed character,
2715 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002716 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2717 */
2718 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002719do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002720{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002721 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002722 int used_typed_char = typed_char;
2723 int oldState = State;
2724 int c;
2725#ifdef FEAT_CON_DIALOG
2726 int retval = FALSE;
2727#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002728 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002729 msgchunk_T *mp_last = NULL;
2730 msgchunk_T *mp;
2731 int i;
2732
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002733 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002734 * that case don't show another prompt. Also when at the hit-Enter prompt
2735 * and nothing was typed. */
2736 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002737 return FALSE;
2738 entered = TRUE;
2739
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002740 if (typed_char == 'G')
2741 {
2742 /* "g<": Find first line on the last page. */
2743 mp_last = msg_sb_start(last_msgchunk);
2744 for (i = 0; i < Rows - 2 && mp_last != NULL
2745 && mp_last->sb_prev != NULL; ++i)
2746 mp_last = msg_sb_start(mp_last->sb_prev);
2747 }
2748
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002749 State = ASKMORE;
2750#ifdef FEAT_MOUSE
2751 setmouse();
2752#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002753 if (typed_char == NUL)
2754 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002755 for (;;)
2756 {
2757 /*
2758 * Get a typed character directly from the user.
2759 */
2760 if (used_typed_char != NUL)
2761 {
2762 c = used_typed_char; /* was typed at hit-enter prompt */
2763 used_typed_char = NUL;
2764 }
2765 else
2766 c = get_keystroke();
2767
2768#if defined(FEAT_MENU) && defined(FEAT_GUI)
2769 if (c == K_MENU)
2770 {
2771 int idx = get_menu_index(current_menu, ASKMORE);
2772
2773 /* Used a menu. If it starts with CTRL-Y, it must
2774 * be a "Copy" for the clipboard. Otherwise
2775 * assume that we end */
2776 if (idx == MENU_INDEX_INVALID)
2777 continue;
2778 c = *current_menu->strings[idx];
2779 if (c != NUL && current_menu->strings[idx][1] != NUL)
2780 ins_typebuf(current_menu->strings[idx] + 1,
2781 current_menu->noremap[idx], 0, TRUE,
2782 current_menu->silent[idx]);
2783 }
2784#endif
2785
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002786 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002787 switch (c)
2788 {
2789 case BS: /* scroll one line back */
2790 case K_BS:
2791 case 'k':
2792 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002793 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002794 break;
2795
2796 case CAR: /* one extra line */
2797 case NL:
2798 case 'j':
2799 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002800 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002801 break;
2802
2803 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002804 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002805 break;
2806
2807 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002808 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002809 break;
2810
2811 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002812 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002813 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002814 break;
2815
2816 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002817 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002818 case K_PAGEDOWN:
2819 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002820 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002821 break;
2822
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002823 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002824 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002825 break;
2826
2827 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002828 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002829 lines_left = 999999;
2830 break;
2831
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002832 case ':': /* start new command line */
2833#ifdef FEAT_CON_DIALOG
2834 if (!confirm_msg_used)
2835#endif
2836 {
2837 /* Since got_int is set all typeahead will be flushed, but we
2838 * want to keep this ':', remember that in a special way. */
2839 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002840#ifdef FEAT_TERMINAL
2841 skip_term_loop = TRUE;
2842#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002843 cmdline_row = Rows - 1; /* put ':' on this line */
2844 skip_redraw = TRUE; /* skip redraw once */
2845 need_wait_return = FALSE; /* don't wait in main() */
2846 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002847 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002848 case 'q': /* quit */
2849 case Ctrl_C:
2850 case ESC:
2851#ifdef FEAT_CON_DIALOG
2852 if (confirm_msg_used)
2853 {
2854 /* Jump to the choices of the dialog. */
2855 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002856 }
2857 else
2858#endif
2859 {
2860 got_int = TRUE;
2861 quit_more = TRUE;
2862 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002863 /* When there is some more output (wrapping line) display that
2864 * without another prompt. */
2865 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002866 break;
2867
2868#ifdef FEAT_CLIPBOARD
2869 case Ctrl_Y:
2870 /* Strange way to allow copying (yanking) a modeless
2871 * selection at the more prompt. Use CTRL-Y,
2872 * because the same is used in Cmdline-mode and at the
2873 * hit-enter prompt. However, scrolling one line up
2874 * might be expected... */
2875 if (clip_star.state == SELECT_DONE)
2876 clip_copy_modeless_selection(TRUE);
2877 continue;
2878#endif
2879 default: /* no valid response */
2880 msg_moremsg(TRUE);
2881 continue;
2882 }
2883
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002884 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002885 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002886 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002887 {
2888 /* go to start of last line */
2889 if (mp_last == NULL)
2890 mp = msg_sb_start(last_msgchunk);
2891 else if (mp_last->sb_prev != NULL)
2892 mp = msg_sb_start(mp_last->sb_prev);
2893 else
2894 mp = NULL;
2895
2896 /* go to start of line at top of the screen */
2897 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2898 ++i)
2899 mp = msg_sb_start(mp->sb_prev);
2900
2901 if (mp != NULL && mp->sb_prev != NULL)
2902 {
2903 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002904 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002905 {
2906 if (mp == NULL || mp->sb_prev == NULL)
2907 break;
2908 mp = msg_sb_start(mp->sb_prev);
2909 if (mp_last == NULL)
2910 mp_last = msg_sb_start(last_msgchunk);
2911 else
2912 mp_last = msg_sb_start(mp_last->sb_prev);
2913 }
2914
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002915 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002916 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002917 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002918 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002919 (void)disp_sb_line(0, mp);
2920 }
2921 else
2922 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002923 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002924 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002925 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2926 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002927 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002928 ++msg_scrolled;
2929 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002930 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002931 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002932 }
2933 }
2934 else
2935 {
2936 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002937 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002938 {
2939 /* scroll up, display line at bottom */
2940 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002941 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002942 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2943 (int)Columns, ' ', ' ', 0);
2944 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002945 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002946 }
2947 }
2948
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002949 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002950 {
2951 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002952 screen_fill((int)Rows - 1, (int)Rows, 0,
2953 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002954 msg_moremsg(FALSE);
2955 continue;
2956 }
2957
2958 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002959 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002960 }
2961
2962 break;
2963 }
2964
2965 /* clear the --more-- message */
2966 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2967 State = oldState;
2968#ifdef FEAT_MOUSE
2969 setmouse();
2970#endif
2971 if (quit_more)
2972 {
2973 msg_row = Rows - 1;
2974 msg_col = 0;
2975 }
2976#ifdef FEAT_RIGHTLEFT
2977 else if (cmdmsg_rl)
2978 msg_col = Columns - 1;
2979#endif
2980
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002981 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002982#ifdef FEAT_CON_DIALOG
2983 return retval;
2984#else
2985 return FALSE;
2986#endif
2987}
2988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2990
2991#ifdef mch_errmsg
2992# undef mch_errmsg
2993#endif
2994#ifdef mch_msg
2995# undef mch_msg
2996#endif
2997
2998/*
2999 * Give an error message. To be used when the screen hasn't been initialized
3000 * yet. When stderr can't be used, collect error messages until the GUI has
3001 * started and they can be displayed in a message box.
3002 */
3003 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003004mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005{
3006 int len;
3007
3008#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3009 /* On Unix use stderr if it's a tty.
3010 * When not going to start the GUI also use stderr.
3011 * On Mac, when started from Finder, stderr is the console. */
3012 if (
3013# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003014# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3016# else
3017 isatty(2)
3018# endif
3019# ifdef FEAT_GUI
3020 ||
3021# endif
3022# endif
3023# ifdef FEAT_GUI
3024 !(gui.in_use || gui.starting)
3025# endif
3026 )
3027 {
3028 fprintf(stderr, "%s", str);
3029 return;
3030 }
3031#endif
3032
3033 /* avoid a delay for a message that isn't there */
3034 emsg_on_display = FALSE;
3035
3036 len = (int)STRLEN(str) + 1;
3037 if (error_ga.ga_growsize == 0)
3038 {
3039 error_ga.ga_growsize = 80;
3040 error_ga.ga_itemsize = 1;
3041 }
3042 if (ga_grow(&error_ga, len) == OK)
3043 {
3044 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3045 (char_u *)str, len);
3046#ifdef UNIX
3047 /* remove CR characters, they are displayed */
3048 {
3049 char_u *p;
3050
3051 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3052 for (;;)
3053 {
3054 p = vim_strchr(p, '\r');
3055 if (p == NULL)
3056 break;
3057 *p = ' ';
3058 }
3059 }
3060#endif
3061 --len; /* don't count the NUL at the end */
3062 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 }
3064}
3065
3066/*
3067 * Give a message. To be used when the screen hasn't been initialized yet.
3068 * When there is no tty, collect messages until the GUI has started and they
3069 * can be displayed in a message box.
3070 */
3071 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003072mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073{
3074#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3075 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3076 * uses mch_errmsg() when started from the desktop.
3077 * When not going to start the GUI also use stdout.
3078 * On Mac, when started from Finder, stderr is the console. */
3079 if (
3080# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003081# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3083# else
3084 isatty(2)
3085# endif
3086# ifdef FEAT_GUI
3087 ||
3088# endif
3089# endif
3090# ifdef FEAT_GUI
3091 !(gui.in_use || gui.starting)
3092# endif
3093 )
3094 {
3095 printf("%s", str);
3096 return;
3097 }
3098# endif
3099 mch_errmsg(str);
3100}
3101#endif /* USE_MCH_ERRMSG */
3102
3103/*
3104 * Put a character on the screen at the current message position and advance
3105 * to the next position. Only for printable ASCII!
3106 */
3107 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003108msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109{
3110 msg_didout = TRUE; /* remember that line is not empty */
3111 screen_putchar(c, msg_row, msg_col, attr);
3112#ifdef FEAT_RIGHTLEFT
3113 if (cmdmsg_rl)
3114 {
3115 if (--msg_col == 0)
3116 {
3117 msg_col = Columns;
3118 ++msg_row;
3119 }
3120 }
3121 else
3122#endif
3123 {
3124 if (++msg_col >= Columns)
3125 {
3126 msg_col = 0;
3127 ++msg_row;
3128 }
3129 }
3130}
3131
3132 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003133msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003135 int attr;
3136 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137
Bram Moolenaar8820b482017-03-16 17:23:31 +01003138 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003139 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003141 screen_puts((char_u *)
3142 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3143 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144}
3145
3146/*
3147 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3148 * exmode_active.
3149 */
3150 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003151repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152{
3153 if (State == ASKMORE)
3154 {
3155 msg_moremsg(TRUE); /* display --more-- message again */
3156 msg_row = Rows - 1;
3157 }
3158#ifdef FEAT_CON_DIALOG
3159 else if (State == CONFIRM)
3160 {
3161 display_confirm_msg(); /* display ":confirm" message again */
3162 msg_row = Rows - 1;
3163 }
3164#endif
3165 else if (State == EXTERNCMD)
3166 {
3167 windgoto(msg_row, msg_col); /* put cursor back */
3168 }
3169 else if (State == HITRETURN || State == SETWSIZE)
3170 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003171 if (msg_row == Rows - 1)
3172 {
3173 /* Avoid drawing the "hit-enter" prompt below the previous one,
3174 * overwrite it. Esp. useful when regaining focus and a
3175 * FocusGained autocmd exists but didn't draw anything. */
3176 msg_didout = FALSE;
3177 msg_col = 0;
3178 msg_clr_eos();
3179 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 hit_return_msg();
3181 msg_row = Rows - 1;
3182 }
3183}
3184
3185/*
3186 * msg_check_screen - check if the screen is initialized.
3187 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3188 * While starting the GUI the terminal codes will be set for the GUI, but the
3189 * output goes to the terminal. Don't use the terminal codes then.
3190 */
3191 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003192msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193{
3194 if (!full_screen || !screen_valid(FALSE))
3195 return FALSE;
3196
3197 if (msg_row >= Rows)
3198 msg_row = Rows - 1;
3199 if (msg_col >= Columns)
3200 msg_col = Columns - 1;
3201 return TRUE;
3202}
3203
3204/*
3205 * Clear from current message position to end of screen.
3206 * Skip this when ":silent" was used, no need to clear for redirection.
3207 */
3208 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003209msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210{
3211 if (msg_silent == 0)
3212 msg_clr_eos_force();
3213}
3214
3215/*
3216 * Clear from current message position to end of screen.
3217 * Note: msg_col is not updated, so we remember the end of the message
3218 * for msg_check().
3219 */
3220 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003221msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222{
3223 if (msg_use_printf())
3224 {
3225 if (full_screen) /* only when termcap codes are valid */
3226 {
3227 if (*T_CD)
3228 out_str(T_CD); /* clear to end of display */
3229 else if (*T_CE)
3230 out_str(T_CE); /* clear to end of line */
3231 }
3232 }
3233 else
3234 {
3235#ifdef FEAT_RIGHTLEFT
3236 if (cmdmsg_rl)
3237 {
3238 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3239 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3240 }
3241 else
3242#endif
3243 {
3244 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3245 ' ', ' ', 0);
3246 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3247 }
3248 }
3249}
3250
3251/*
3252 * Clear the command line.
3253 */
3254 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003255msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256{
3257 msg_row = cmdline_row;
3258 msg_col = 0;
3259 msg_clr_eos_force();
3260}
3261
3262/*
3263 * end putting a message on the screen
3264 * call wait_return if the message does not fit in the available space
3265 * return TRUE if wait_return not called.
3266 */
3267 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003268msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269{
3270 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003271 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 * or the ruler option is set and we run into it,
3273 * we have to redraw the window.
3274 * Do not do this if we are abandoning the file or editing the command line.
3275 */
3276 if (!exiting && need_wait_return && !(State & CMDLINE))
3277 {
3278 wait_return(FALSE);
3279 return FALSE;
3280 }
3281 out_flush();
3282 return TRUE;
3283}
3284
3285/*
3286 * If the written message runs into the shown command or ruler, we have to
3287 * wait for hit-return and redraw the window later.
3288 */
3289 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003290msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291{
3292 if (msg_row == Rows - 1 && msg_col >= sc_col)
3293 {
3294 need_wait_return = TRUE;
3295 redraw_cmdline = TRUE;
3296 }
3297}
3298
3299/*
3300 * May write a string to the redirection file.
3301 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3302 */
3303 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003304redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305{
3306 char_u *s = str;
3307 static int cur_col = 0;
3308
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003309 /* Don't do anything for displaying prompts and the like. */
3310 if (redir_off)
3311 return;
3312
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003313 /* If 'verbosefile' is set prepare for writing in that file. */
3314 if (*p_vfile != NUL && verbose_fd == NULL)
3315 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003316
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003317 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 {
3319 /* If the string doesn't start with CR or NL, go to msg_col */
3320 if (*s != '\n' && *s != '\r')
3321 {
3322 while (cur_col < msg_col)
3323 {
3324#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003325 if (redir_execute)
3326 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003327 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003329 else if (redir_vname)
3330 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003331 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003333 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003335 if (verbose_fd != NULL)
3336 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 ++cur_col;
3338 }
3339 }
3340
3341#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003342 if (redir_execute)
3343 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003344 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003346 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003347 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348#endif
3349
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003350 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3352 {
3353#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003354 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003356 if (redir_fd != NULL)
3357 putc(*s, redir_fd);
3358 if (verbose_fd != NULL)
3359 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 if (*s == '\r' || *s == '\n')
3361 cur_col = 0;
3362 else if (*s == '\t')
3363 cur_col += (8 - cur_col % 8);
3364 else
3365 ++cur_col;
3366 ++s;
3367 }
3368
3369 if (msg_silent != 0) /* should update msg_col */
3370 msg_col = cur_col;
3371 }
3372}
3373
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003374 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003375redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003376{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003377 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003378#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003379 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003380#endif
3381 ;
3382}
3383
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003385 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003386 * Must always be called paired with verbose_leave()!
3387 */
3388 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003389verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003390{
3391 if (*p_vfile != NUL)
3392 ++msg_silent;
3393}
3394
3395/*
3396 * After giving verbose message.
3397 * Must always be called paired with verbose_enter()!
3398 */
3399 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003400verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003401{
3402 if (*p_vfile != NUL)
3403 if (--msg_silent < 0)
3404 msg_silent = 0;
3405}
3406
3407/*
3408 * Like verbose_enter() and set msg_scroll when displaying the message.
3409 */
3410 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003411verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003412{
3413 if (*p_vfile != NUL)
3414 ++msg_silent;
3415 else
3416 /* always scroll up, don't overwrite */
3417 msg_scroll = TRUE;
3418}
3419
3420/*
3421 * Like verbose_leave() and set cmdline_row when displaying the message.
3422 */
3423 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003424verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003425{
3426 if (*p_vfile != NUL)
3427 {
3428 if (--msg_silent < 0)
3429 msg_silent = 0;
3430 }
3431 else
3432 cmdline_row = msg_row;
3433}
3434
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003435/*
3436 * Called when 'verbosefile' is set: stop writing to the file.
3437 */
3438 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003439verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003440{
3441 if (verbose_fd != NULL)
3442 {
3443 fclose(verbose_fd);
3444 verbose_fd = NULL;
3445 }
3446 verbose_did_open = FALSE;
3447}
3448
3449/*
3450 * Open the file 'verbosefile'.
3451 * Return FAIL or OK.
3452 */
3453 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003454verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003455{
3456 if (verbose_fd == NULL && !verbose_did_open)
3457 {
3458 /* Only give the error message once. */
3459 verbose_did_open = TRUE;
3460
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003461 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003462 if (verbose_fd == NULL)
3463 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003464 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003465 return FAIL;
3466 }
3467 }
3468 return OK;
3469}
3470
3471/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 * Give a warning message (for searching).
3473 * Use 'w' highlighting and may repeat the message after redrawing
3474 */
3475 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003476give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477{
3478 /* Don't do this for ":silent". */
3479 if (msg_silent != 0)
3480 return;
3481
3482 /* Don't want a hit-enter prompt here. */
3483 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003484
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485#ifdef FEAT_EVAL
3486 set_vim_var_string(VV_WARNINGMSG, message, -1);
3487#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003488 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003490 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 else
3492 keep_msg_attr = 0;
3493 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003494 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 msg_didout = FALSE; /* overwrite this message */
3496 msg_nowait = TRUE; /* don't wait for this message */
3497 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003498
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 --no_wait_return;
3500}
3501
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003502 void
3503give_warning2(char_u *message, char_u *a1, int hl)
3504{
3505 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3506 give_warning(IObuff, hl);
3507}
3508
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509/*
3510 * Advance msg cursor to column "col".
3511 */
3512 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003513msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514{
3515 if (msg_silent != 0) /* nothing to advance to */
3516 {
3517 msg_col = col; /* for redirection, may fill it up later */
3518 return;
3519 }
3520 if (col >= Columns) /* not enough room */
3521 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003522#ifdef FEAT_RIGHTLEFT
3523 if (cmdmsg_rl)
3524 while (msg_col > Columns - col)
3525 msg_putchar(' ');
3526 else
3527#endif
3528 while (msg_col < col)
3529 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530}
3531
3532#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3533/*
3534 * Used for "confirm()" function, and the :confirm command prefix.
3535 * Versions which haven't got flexible dialogs yet, and console
3536 * versions, get this generic handler which uses the command line.
3537 *
3538 * type = one of:
3539 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3540 * title = title string (can be NULL for default)
3541 * (neither used in console dialogs at the moment)
3542 *
3543 * Format of the "buttons" string:
3544 * "Button1Name\nButton2Name\nButton3Name"
3545 * The first button should normally be the default/accept
3546 * The second button should be the 'Cancel' button
3547 * Other buttons- use your imagination!
3548 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3549 * different letter.
3550 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003552do_dialog(
3553 int type UNUSED,
3554 char_u *title UNUSED,
3555 char_u *message,
3556 char_u *buttons,
3557 int dfltbutton,
3558 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003559 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003560 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003561 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562{
3563 int oldState;
3564 int retval = 0;
3565 char_u *hotkeys;
3566 int c;
3567 int i;
3568
3569#ifndef NO_CONSOLE
3570 /* Don't output anything in silent mode ("ex -s") */
3571 if (silent_mode)
3572 return dfltbutton; /* return default option */
3573#endif
3574
3575#ifdef FEAT_GUI_DIALOG
3576 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3577 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3578 {
3579 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003580 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003581 /* avoid a hit-enter prompt without clearing the cmdline */
3582 need_wait_return = FALSE;
3583 emsg_on_display = FALSE;
3584 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585
3586 /* Flush output to avoid that further messages and redrawing is done
3587 * in the wrong order. */
3588 out_flush();
3589 gui_mch_update();
3590
3591 return c;
3592 }
3593#endif
3594
3595 oldState = State;
3596 State = CONFIRM;
3597#ifdef FEAT_MOUSE
3598 setmouse();
3599#endif
3600
3601 /*
3602 * Since we wait for a keypress, don't make the
3603 * user press RETURN as well afterwards.
3604 */
3605 ++no_wait_return;
3606 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3607
3608 if (hotkeys != NULL)
3609 {
3610 for (;;)
3611 {
3612 /* Get a typed character directly from the user. */
3613 c = get_keystroke();
3614 switch (c)
3615 {
3616 case CAR: /* User accepts default option */
3617 case NL:
3618 retval = dfltbutton;
3619 break;
3620 case Ctrl_C: /* User aborts/cancels */
3621 case ESC:
3622 retval = 0;
3623 break;
3624 default: /* Could be a hotkey? */
3625 if (c < 0) /* special keys are ignored here */
3626 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003627 if (c == ':' && ex_cmd)
3628 {
3629 retval = dfltbutton;
3630 ins_char_typebuf(':');
3631 break;
3632 }
3633
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 /* Make the character lowercase, as chars in "hotkeys" are. */
3635 c = MB_TOLOWER(c);
3636 retval = 1;
3637 for (i = 0; hotkeys[i]; ++i)
3638 {
3639#ifdef FEAT_MBYTE
3640 if (has_mbyte)
3641 {
3642 if ((*mb_ptr2char)(hotkeys + i) == c)
3643 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003644 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 }
3646 else
3647#endif
3648 if (hotkeys[i] == c)
3649 break;
3650 ++retval;
3651 }
3652 if (hotkeys[i])
3653 break;
3654 /* No hotkey match, so keep waiting */
3655 continue;
3656 }
3657 break;
3658 }
3659
3660 vim_free(hotkeys);
3661 }
3662
3663 State = oldState;
3664#ifdef FEAT_MOUSE
3665 setmouse();
3666#endif
3667 --no_wait_return;
3668 msg_end_prompt();
3669
3670 return retval;
3671}
3672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673/*
3674 * Copy one character from "*from" to "*to", taking care of multi-byte
3675 * characters. Return the length of the character in bytes.
3676 */
3677 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003678copy_char(
3679 char_u *from,
3680 char_u *to,
3681 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682{
3683#ifdef FEAT_MBYTE
3684 int len;
3685 int c;
3686
3687 if (has_mbyte)
3688 {
3689 if (lowercase)
3690 {
3691 c = MB_TOLOWER((*mb_ptr2char)(from));
3692 return (*mb_char2bytes)(c, to);
3693 }
3694 else
3695 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003696 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 mch_memmove(to, from, (size_t)len);
3698 return len;
3699 }
3700 }
3701 else
3702#endif
3703 {
3704 if (lowercase)
3705 *to = (char_u)TOLOWER_LOC(*from);
3706 else
3707 *to = *from;
3708 return 1;
3709 }
3710}
3711
3712/*
3713 * Format the dialog string, and display it at the bottom of
3714 * the screen. Return a string of hotkey chars (if defined) for
3715 * each 'button'. If a button has no hotkey defined, the first character of
3716 * the button is used.
3717 * The hotkeys can be multi-byte characters, but without combining chars.
3718 *
3719 * Returns an allocated string with hotkeys, or NULL for error.
3720 */
3721 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003722msg_show_console_dialog(
3723 char_u *message,
3724 char_u *buttons,
3725 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726{
3727 int len = 0;
3728#ifdef FEAT_MBYTE
3729# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3730#else
3731# define HOTK_LEN 1
3732#endif
3733 int lenhotkey = HOTK_LEN; /* count first button */
3734 char_u *hotk = NULL;
3735 char_u *msgp = NULL;
3736 char_u *hotkp = NULL;
3737 char_u *r;
3738 int copy;
3739#define HAS_HOTKEY_LEN 30
3740 char_u has_hotkey[HAS_HOTKEY_LEN];
3741 int first_hotkey = FALSE; /* first char of button is hotkey */
3742 int idx;
3743
3744 has_hotkey[0] = FALSE;
3745
3746 /*
3747 * First loop: compute the size of memory to allocate.
3748 * Second loop: copy to the allocated memory.
3749 */
3750 for (copy = 0; copy <= 1; ++copy)
3751 {
3752 r = buttons;
3753 idx = 0;
3754 while (*r)
3755 {
3756 if (*r == DLG_BUTTON_SEP)
3757 {
3758 if (copy)
3759 {
3760 *msgp++ = ',';
3761 *msgp++ = ' '; /* '\n' -> ', ' */
3762
3763 /* advance to next hotkey and set default hotkey */
3764#ifdef FEAT_MBYTE
3765 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003766 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 else
3768#endif
3769 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003770 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 if (dfltbutton)
3772 --dfltbutton;
3773
3774 /* If no hotkey is specified first char is used. */
3775 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3776 first_hotkey = TRUE;
3777 }
3778 else
3779 {
3780 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3781 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3782 if (idx < HAS_HOTKEY_LEN - 1)
3783 has_hotkey[++idx] = FALSE;
3784 }
3785 }
3786 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3787 {
3788 if (*r == DLG_HOTKEY_CHAR)
3789 ++r;
3790 first_hotkey = FALSE;
3791 if (copy)
3792 {
3793 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3794 *msgp++ = *r;
3795 else
3796 {
3797 /* '&a' -> '[a]' */
3798 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3799 msgp += copy_char(r, msgp, FALSE);
3800 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3801
3802 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003803 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 }
3805 }
3806 else
3807 {
3808 ++len; /* '&a' -> '[a]' */
3809 if (idx < HAS_HOTKEY_LEN - 1)
3810 has_hotkey[idx] = TRUE;
3811 }
3812 }
3813 else
3814 {
3815 /* everything else copy literally */
3816 if (copy)
3817 msgp += copy_char(r, msgp, FALSE);
3818 }
3819
3820 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003821 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 }
3823
3824 if (copy)
3825 {
3826 *msgp++ = ':';
3827 *msgp++ = ' ';
3828 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 }
3830 else
3831 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003832 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003833 + 2 /* for the NL's */
3834 + STRLEN(buttons)
3835 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003836 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837
3838 /* If no hotkey is specified first char is used. */
3839 if (!has_hotkey[0])
3840 {
3841 first_hotkey = TRUE;
3842 len += 2; /* "x" -> "[x]" */
3843 }
3844
3845 /*
3846 * Now allocate and load the strings
3847 */
3848 vim_free(confirm_msg);
3849 confirm_msg = alloc(len);
3850 if (confirm_msg == NULL)
3851 return NULL;
3852 *confirm_msg = NUL;
3853 hotk = alloc(lenhotkey);
3854 if (hotk == NULL)
3855 return NULL;
3856
3857 *confirm_msg = '\n';
3858 STRCPY(confirm_msg + 1, message);
3859
3860 msgp = confirm_msg + 1 + STRLEN(message);
3861 hotkp = hotk;
3862
Bram Moolenaar6a516062007-07-05 08:11:42 +00003863 /* Define first default hotkey. Keep the hotkey string NUL
3864 * terminated to avoid reading past the end. */
3865 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866
3867 /* Remember where the choices start, displaying starts here when
3868 * "hotkp" typed at the more prompt. */
3869 confirm_msg_tail = msgp;
3870 *msgp++ = '\n';
3871 }
3872 }
3873
3874 display_confirm_msg();
3875 return hotk;
3876}
3877
3878/*
3879 * Display the ":confirm" message. Also called when screen resized.
3880 */
3881 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003882display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883{
3884 /* avoid that 'q' at the more prompt truncates the message here */
3885 ++confirm_msg_used;
3886 if (confirm_msg != NULL)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003887 msg_puts_attr(confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 --confirm_msg_used;
3889}
3890
3891#endif /* FEAT_CON_DIALOG */
3892
3893#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3894
3895 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003896vim_dialog_yesno(
3897 int type,
3898 char_u *title,
3899 char_u *message,
3900 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901{
3902 if (do_dialog(type,
3903 title == NULL ? (char_u *)_("Question") : title,
3904 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003905 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 return VIM_YES;
3907 return VIM_NO;
3908}
3909
3910 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003911vim_dialog_yesnocancel(
3912 int type,
3913 char_u *title,
3914 char_u *message,
3915 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916{
3917 switch (do_dialog(type,
3918 title == NULL ? (char_u *)_("Question") : title,
3919 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003920 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 {
3922 case 1: return VIM_YES;
3923 case 2: return VIM_NO;
3924 }
3925 return VIM_CANCEL;
3926}
3927
3928 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003929vim_dialog_yesnoallcancel(
3930 int type,
3931 char_u *title,
3932 char_u *message,
3933 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934{
3935 switch (do_dialog(type,
3936 title == NULL ? (char_u *)"Question" : title,
3937 message,
3938 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003939 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 {
3941 case 1: return VIM_YES;
3942 case 2: return VIM_NO;
3943 case 3: return VIM_ALL;
3944 case 4: return VIM_DISCARDALL;
3945 }
3946 return VIM_CANCEL;
3947}
3948
3949#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3950
3951#if defined(FEAT_BROWSE) || defined(PROTO)
3952/*
3953 * Generic browse function. Calls gui_mch_browse() when possible.
3954 * Later this may pop-up a non-GUI file selector (external command?).
3955 */
3956 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003957do_browse(
3958 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3959 char_u *title, /* title for the window */
3960 char_u *dflt, /* default file name (may include directory) */
3961 char_u *ext, /* extension added */
3962 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003964 char_u *filter, /* file name filter */
3965 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966{
3967 char_u *fname;
3968 static char_u *last_dir = NULL; /* last used directory */
3969 char_u *tofree = NULL;
3970 int save_browse = cmdmod.browse;
3971
3972 /* Must turn off browse to avoid that autocommands will get the
3973 * flag too! */
3974 cmdmod.browse = FALSE;
3975
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003976 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003978 if (flags & BROWSE_DIR)
3979 title = (char_u *)_("Select Directory dialog");
3980 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 title = (char_u *)_("Save File dialog");
3982 else
3983 title = (char_u *)_("Open File dialog");
3984 }
3985
3986 /* When no directory specified, use default file name, default dir, buffer
3987 * dir, last dir or current dir */
3988 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3989 {
3990 if (mch_isdir(dflt)) /* default file name is a directory */
3991 {
3992 initdir = dflt;
3993 dflt = NULL;
3994 }
3995 else if (gettail(dflt) != dflt) /* default file name includes a path */
3996 {
3997 tofree = vim_strsave(dflt);
3998 if (tofree != NULL)
3999 {
4000 initdir = tofree;
4001 *gettail(initdir) = NUL;
4002 dflt = gettail(dflt);
4003 }
4004 }
4005 }
4006
4007 if (initdir == NULL || *initdir == NUL)
4008 {
4009 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004010 if (STRCMP(p_bsdir, "last") != 0
4011 && STRCMP(p_bsdir, "buffer") != 0
4012 && STRCMP(p_bsdir, "current") != 0
4013 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 initdir = p_bsdir;
4015 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004016 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 && buf != NULL && buf->b_ffname != NULL)
4018 {
4019 if (dflt == NULL || *dflt == NUL)
4020 dflt = gettail(curbuf->b_ffname);
4021 tofree = vim_strsave(curbuf->b_ffname);
4022 if (tofree != NULL)
4023 {
4024 initdir = tofree;
4025 *gettail(initdir) = NUL;
4026 }
4027 }
4028 /* When 'browsedir' is "last", use dir from last browse */
4029 else if (*p_bsdir == 'l')
4030 initdir = last_dir;
4031 /* When 'browsedir is "current", use current directory. This is the
4032 * default already, leave initdir empty. */
4033 }
4034
4035# ifdef FEAT_GUI
4036 if (gui.in_use) /* when this changes, also adjust f_has()! */
4037 {
4038 if (filter == NULL
4039# ifdef FEAT_EVAL
4040 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4041 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4042# endif
4043 )
4044 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004045 if (flags & BROWSE_DIR)
4046 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004047# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004048 /* For systems that have a directory dialog. */
4049 fname = gui_mch_browsedir(title, initdir);
4050# else
4051 /* Generic solution for selecting a directory: select a file and
4052 * remove the file name. */
4053 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4054# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004055# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004056 /* Win32 adds a dummy file name, others return an arbitrary file
4057 * name. GTK+ 2 returns only the directory, */
4058 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4059 {
4060 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004061 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004062
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004063 if (tail == fname)
4064 *tail++ = '.'; /* use current dir */
4065 *tail = NUL;
4066 }
4067# endif
4068 }
4069 else
4070 fname = gui_mch_browse(flags & BROWSE_SAVE,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004071 title, dflt, ext, initdir, (char_u *)_(filter));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072
4073 /* We hang around in the dialog for a while, the user might do some
4074 * things to our files. The Win32 dialog allows deleting or renaming
4075 * a file, check timestamps. */
4076 need_check_timestamps = TRUE;
4077 did_check_timestamps = FALSE;
4078 }
4079 else
4080# endif
4081 {
4082 /* TODO: non-GUI file selector here */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004083 emsg(_("E338: Sorry, no file browser in console mode"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 fname = NULL;
4085 }
4086
4087 /* keep the directory for next time */
4088 if (fname != NULL)
4089 {
4090 vim_free(last_dir);
4091 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004092 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 {
4094 *gettail(last_dir) = NUL;
4095 if (*last_dir == NUL)
4096 {
4097 /* filename only returned, must be in current dir */
4098 vim_free(last_dir);
4099 last_dir = alloc(MAXPATHL);
4100 if (last_dir != NULL)
4101 mch_dirname(last_dir, MAXPATHL);
4102 }
4103 }
4104 }
4105
4106 vim_free(tofree);
4107 cmdmod.browse = save_browse;
4108
4109 return fname;
4110}
4111#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004112
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004113#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004114static char *e_printf = N_("E766: Insufficient arguments for printf()");
4115
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004116/*
4117 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4118 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004119 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004120tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004121{
4122 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004123 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004124 int err = FALSE;
4125
4126 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004127 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004128 else
4129 {
4130 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004131 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004132 if (err)
4133 n = 0;
4134 }
4135 return n;
4136}
4137
4138/*
4139 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004140 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004141 * are not converted to a string.
4142 * If "tofree" is not NULL echo_string() is used. All types are converted to
4143 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004144 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004145 */
4146 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004147tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004148{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004149 int idx = *idxp - 1;
4150 char *s = NULL;
4151 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004152
4153 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004154 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004155 else
4156 {
4157 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004158 if (tofree != NULL)
4159 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4160 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004161 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004162 }
4163 return s;
4164}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004165
4166# ifdef FEAT_FLOAT
4167/*
4168 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4169 */
4170 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004171tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004172{
4173 int idx = *idxp - 1;
4174 double f = 0;
4175
4176 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004177 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004178 else
4179 {
4180 ++*idxp;
4181 if (tvs[idx].v_type == VAR_FLOAT)
4182 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004183 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004184 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004185 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004186 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004187 }
4188 return f;
4189}
4190# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004191#endif
4192
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004193#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004194/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004195 * Return the representation of infinity for printf() function:
4196 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4197 */
4198 static const char *
4199infinity_str(int positive,
4200 char fmt_spec,
4201 int force_sign,
4202 int space_for_positive)
4203{
4204 static const char *table[] =
4205 {
4206 "-inf", "inf", "+inf", " inf",
4207 "-INF", "INF", "+INF", " INF"
4208 };
4209 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4210
4211 if (ASCII_ISUPPER(fmt_spec))
4212 idx += 4;
4213 return table[idx];
4214}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004215#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004216
4217/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004218 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004219 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004220 * consistency.
4221 *
4222 * This code is based on snprintf.c - a portable implementation of snprintf
4223 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004224 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004225 * The original code, including useful comments, can be found here:
4226 * http://www.ijs.si/software/snprintf/
4227 *
4228 * This snprintf() only supports the following conversion specifiers:
4229 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4230 * with flags: '-', '+', ' ', '0' and '#'.
4231 * An asterisk is supported for field width as well as precision.
4232 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004233 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004234 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004235 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4236 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004237 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004238 * The locale is not used, the string is used as a byte string. This is only
4239 * relevant for double-byte encodings where the second byte may be '%'.
4240 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004241 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4242 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004243 *
4244 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004245 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004246 * is greater or equal to "str_m", not all characters from the result
4247 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4248 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004249 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004250 */
4251
4252/*
4253 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004254 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004255 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004256 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004257 */
4258
4259/* When generating prototypes all of this is skipped, cproto doesn't
4260 * understand this. */
4261#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004262
Bram Moolenaara800b422010-06-27 01:15:55 +02004263/* Like vim_vsnprintf() but append to the string. */
4264 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004265vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004266{
4267 va_list ap;
4268 int str_l;
4269 size_t len = STRLEN(str);
4270 size_t space;
4271
4272 if (str_m <= len)
4273 space = 0;
4274 else
4275 space = str_m - len;
4276 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004277 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004278 va_end(ap);
4279 return str_l;
4280}
Bram Moolenaara800b422010-06-27 01:15:55 +02004281
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004282 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004283vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004284{
4285 va_list ap;
4286 int str_l;
4287
4288 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004289 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004290 va_end(ap);
4291 return str_l;
4292}
4293
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004294 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004295vim_vsnprintf(
4296 char *str,
4297 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004298 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004299 va_list ap)
4300{
4301 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4302}
4303
4304 int
4305vim_vsnprintf_typval(
4306 char *str,
4307 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004308 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004309 va_list ap,
4310 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004311{
4312 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004313 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004314 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004315
4316 if (p == NULL)
4317 p = "";
4318 while (*p != NUL)
4319 {
4320 if (*p != '%')
4321 {
4322 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004323 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004325 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004326 if (str_l < str_m)
4327 {
4328 size_t avail = str_m - str_l;
4329
4330 mch_memmove(str + str_l, p, n > avail ? avail : n);
4331 }
4332 p += n;
4333 str_l += n;
4334 }
4335 else
4336 {
4337 size_t min_field_width = 0, precision = 0;
4338 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4339 int alternate_form = 0, force_sign = 0;
4340
4341 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4342 * ignored. */
4343 int space_for_positive = 1;
4344
4345 /* allowed values: \0, h, l, L */
4346 char length_modifier = '\0';
4347
4348 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004349# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004350# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004351 * That sounds reasonable to use as the maximum
4352 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004353# elif defined(FEAT_NUM64)
4354# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004355# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004356# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004357# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004358 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004359
4360 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004361 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004362
4363 /* natural field width of arg without padding and sign */
4364 size_t str_arg_l;
4365
4366 /* unsigned char argument value - only defined for c conversion.
4367 * N.B. standard explicitly states the char argument for the c
4368 * conversion is unsigned */
4369 unsigned char uchar_arg;
4370
4371 /* number of zeros to be inserted for numeric conversions as
4372 * required by the precision or minimal field width */
4373 size_t number_of_zeros_to_pad = 0;
4374
4375 /* index into tmp where zero padding is to be inserted */
4376 size_t zero_padding_insertion_ind = 0;
4377
4378 /* current conversion specifier character */
4379 char fmt_spec = '\0';
4380
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004381 /* buffer for 's' and 'S' specs */
4382 char_u *tofree = NULL;
4383
4384
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004385 p++; /* skip '%' */
4386
4387 /* parse flags */
4388 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4389 || *p == '#' || *p == '\'')
4390 {
4391 switch (*p)
4392 {
4393 case '0': zero_padding = 1; break;
4394 case '-': justify_left = 1; break;
4395 case '+': force_sign = 1; space_for_positive = 0; break;
4396 case ' ': force_sign = 1;
4397 /* If both the ' ' and '+' flags appear, the ' '
4398 * flag should be ignored */
4399 break;
4400 case '#': alternate_form = 1; break;
4401 case '\'': break;
4402 }
4403 p++;
4404 }
4405 /* If the '0' and '-' flags both appear, the '0' flag should be
4406 * ignored. */
4407
4408 /* parse field width */
4409 if (*p == '*')
4410 {
4411 int j;
4412
4413 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004414 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004415# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004416 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004417# endif
4418 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004419 if (j >= 0)
4420 min_field_width = j;
4421 else
4422 {
4423 min_field_width = -j;
4424 justify_left = 1;
4425 }
4426 }
4427 else if (VIM_ISDIGIT((int)(*p)))
4428 {
4429 /* size_t could be wider than unsigned int; make sure we treat
4430 * argument like common implementations do */
4431 unsigned int uj = *p++ - '0';
4432
4433 while (VIM_ISDIGIT((int)(*p)))
4434 uj = 10 * uj + (unsigned int)(*p++ - '0');
4435 min_field_width = uj;
4436 }
4437
4438 /* parse precision */
4439 if (*p == '.')
4440 {
4441 p++;
4442 precision_specified = 1;
4443 if (*p == '*')
4444 {
4445 int j;
4446
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004447 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004448# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004449 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004450# endif
4451 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004452 p++;
4453 if (j >= 0)
4454 precision = j;
4455 else
4456 {
4457 precision_specified = 0;
4458 precision = 0;
4459 }
4460 }
4461 else if (VIM_ISDIGIT((int)(*p)))
4462 {
4463 /* size_t could be wider than unsigned int; make sure we
4464 * treat argument like common implementations do */
4465 unsigned int uj = *p++ - '0';
4466
4467 while (VIM_ISDIGIT((int)(*p)))
4468 uj = 10 * uj + (unsigned int)(*p++ - '0');
4469 precision = uj;
4470 }
4471 }
4472
4473 /* parse 'h', 'l' and 'll' length modifiers */
4474 if (*p == 'h' || *p == 'l')
4475 {
4476 length_modifier = *p;
4477 p++;
4478 if (length_modifier == 'l' && *p == 'l')
4479 {
4480 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004481# ifdef FEAT_NUM64
4482 length_modifier = 'L';
4483# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004484 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004485# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004486 p++;
4487 }
4488 }
4489 fmt_spec = *p;
4490
4491 /* common synonyms: */
4492 switch (fmt_spec)
4493 {
4494 case 'i': fmt_spec = 'd'; break;
4495 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4496 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4497 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4498 default: break;
4499 }
4500
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004501# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4502 switch (fmt_spec)
4503 {
4504 case 'd': case 'u': case 'o': case 'x': case 'X':
4505 if (tvs != NULL && length_modifier == '\0')
4506 length_modifier = 'L';
4507 }
4508# endif
4509
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004510 /* get parameter value, do initial processing */
4511 switch (fmt_spec)
4512 {
4513 /* '%' and 'c' behave similar to 's' regarding flags and field
4514 * widths */
4515 case '%':
4516 case 'c':
4517 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004518 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004519 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004520 str_arg_l = 1;
4521 switch (fmt_spec)
4522 {
4523 case '%':
4524 str_arg = p;
4525 break;
4526
4527 case 'c':
4528 {
4529 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004530
4531 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004532# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004533 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004534# endif
4535 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004536 /* standard demands unsigned char */
4537 uchar_arg = (unsigned char)j;
4538 str_arg = (char *)&uchar_arg;
4539 break;
4540 }
4541
4542 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004543 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004544 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004545# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004546 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004547# endif
4548 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004549 if (str_arg == NULL)
4550 {
4551 str_arg = "[NULL]";
4552 str_arg_l = 6;
4553 }
4554 /* make sure not to address string beyond the specified
4555 * precision !!! */
4556 else if (!precision_specified)
4557 str_arg_l = strlen(str_arg);
4558 /* truncate string if necessary as requested by precision */
4559 else if (precision == 0)
4560 str_arg_l = 0;
4561 else
4562 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004563 /* Don't put the #if inside memchr(), it can be a
4564 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004565# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004566 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004567# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004568 /* memchr on HP does not like n > 2^31 !!! */
4569 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004570 precision <= (size_t)0x7fffffffL ? precision
4571 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004572# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004573 str_arg_l = (q == NULL) ? precision
4574 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004575 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004576# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004577 if (fmt_spec == 'S')
4578 {
4579 if (min_field_width != 0)
4580 min_field_width += STRLEN(str_arg)
4581 - mb_string2cells((char_u *)str_arg, -1);
4582 if (precision)
4583 {
4584 char_u *p1 = (char_u *)str_arg;
4585 size_t i;
4586
4587 for (i = 0; i < precision && *p1; i++)
4588 p1 += mb_ptr2len(p1);
4589
4590 str_arg_l = precision = p1 - (char_u *)str_arg;
4591 }
4592 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004593# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004594 break;
4595
4596 default:
4597 break;
4598 }
4599 break;
4600
Bram Moolenaar91984b92016-08-16 21:58:41 +02004601 case 'd': case 'u':
4602 case 'b': case 'B':
4603 case 'o':
4604 case 'x': case 'X':
4605 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004606 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004607 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004608 * imply the value is unsigned; d implies a signed
4609 * value */
4610
4611 /* 0 if numeric argument is zero (or if pointer is
4612 * NULL for 'p'), +1 if greater than zero (or nonzero
4613 * for unsigned arguments), -1 if negative (unsigned
4614 * argument is never negative) */
4615 int arg_sign = 0;
4616
4617 /* only defined for length modifier h, or for no
4618 * length modifiers */
4619 int int_arg = 0;
4620 unsigned int uint_arg = 0;
4621
4622 /* only defined for length modifier l */
4623 long int long_arg = 0;
4624 unsigned long int ulong_arg = 0;
4625
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004626# ifdef FEAT_NUM64
4627 /* only defined for length modifier ll */
4628 varnumber_T llong_arg = 0;
4629 uvarnumber_T ullong_arg = 0;
4630# endif
4631
Bram Moolenaare9997822016-08-28 16:03:38 +02004632 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004633 uvarnumber_T bin_arg = 0;
4634
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004635 /* pointer argument value -only defined for p
4636 * conversion */
4637 void *ptr_arg = NULL;
4638
4639 if (fmt_spec == 'p')
4640 {
4641 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004642 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004643# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004644 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4645 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004646# endif
4647 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004648 if (ptr_arg != NULL)
4649 arg_sign = 1;
4650 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004651 else if (fmt_spec == 'b' || fmt_spec == 'B')
4652 {
4653 bin_arg =
4654# if defined(FEAT_EVAL)
4655 tvs != NULL ?
4656 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4657# endif
4658 va_arg(ap, uvarnumber_T);
4659 if (bin_arg != 0)
4660 arg_sign = 1;
4661 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004662 else if (fmt_spec == 'd')
4663 {
4664 /* signed */
4665 switch (length_modifier)
4666 {
4667 case '\0':
4668 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004669 /* char and short arguments are passed as int. */
4670 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004671# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004672 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004673# endif
4674 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004675 if (int_arg > 0)
4676 arg_sign = 1;
4677 else if (int_arg < 0)
4678 arg_sign = -1;
4679 break;
4680 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004681 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004682# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004683 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004684# endif
4685 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004686 if (long_arg > 0)
4687 arg_sign = 1;
4688 else if (long_arg < 0)
4689 arg_sign = -1;
4690 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004691# ifdef FEAT_NUM64
4692 case 'L':
4693 llong_arg =
4694# if defined(FEAT_EVAL)
4695 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4696# endif
4697 va_arg(ap, varnumber_T);
4698 if (llong_arg > 0)
4699 arg_sign = 1;
4700 else if (llong_arg < 0)
4701 arg_sign = -1;
4702 break;
4703# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004704 }
4705 }
4706 else
4707 {
4708 /* unsigned */
4709 switch (length_modifier)
4710 {
4711 case '\0':
4712 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004713 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004714# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004715 tvs != NULL ? (unsigned)
4716 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004717# endif
4718 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004719 if (uint_arg != 0)
4720 arg_sign = 1;
4721 break;
4722 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004723 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004724# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004725 tvs != NULL ? (unsigned long)
4726 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004727# endif
4728 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004729 if (ulong_arg != 0)
4730 arg_sign = 1;
4731 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004732# ifdef FEAT_NUM64
4733 case 'L':
4734 ullong_arg =
4735# if defined(FEAT_EVAL)
4736 tvs != NULL ? (uvarnumber_T)
4737 tv_nr(tvs, &arg_idx) :
4738# endif
4739 va_arg(ap, uvarnumber_T);
4740 if (ullong_arg != 0)
4741 arg_sign = 1;
4742 break;
4743# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004744 }
4745 }
4746
4747 str_arg = tmp;
4748 str_arg_l = 0;
4749
4750 /* NOTE:
4751 * For d, i, u, o, x, and X conversions, if precision is
4752 * specified, the '0' flag should be ignored. This is so
4753 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4754 * FreeBSD, NetBSD; but not with Perl.
4755 */
4756 if (precision_specified)
4757 zero_padding = 0;
4758 if (fmt_spec == 'd')
4759 {
4760 if (force_sign && arg_sign >= 0)
4761 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4762 /* leave negative numbers for sprintf to handle, to
4763 * avoid handling tricky cases like (short int)-32768 */
4764 }
4765 else if (alternate_form)
4766 {
4767 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004768 && (fmt_spec == 'b' || fmt_spec == 'B'
4769 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004770 {
4771 tmp[str_arg_l++] = '0';
4772 tmp[str_arg_l++] = fmt_spec;
4773 }
4774 /* alternate form should have no effect for p
4775 * conversion, but ... */
4776 }
4777
4778 zero_padding_insertion_ind = str_arg_l;
4779 if (!precision_specified)
4780 precision = 1; /* default precision is 1 */
4781 if (precision == 0 && arg_sign == 0)
4782 {
4783 /* When zero value is formatted with an explicit
4784 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004785 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004786 }
4787 else
4788 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004789 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004790 int f_l = 0;
4791
4792 /* construct a simple format string for sprintf */
4793 f[f_l++] = '%';
4794 if (!length_modifier)
4795 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004796 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004797 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004798# ifdef FEAT_NUM64
4799# ifdef WIN3264
4800 f[f_l++] = 'I';
4801 f[f_l++] = '6';
4802 f[f_l++] = '4';
4803# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004804 f[f_l++] = 'l';
4805 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004806# endif
4807# else
4808 f[f_l++] = 'l';
4809# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004810 }
4811 else
4812 f[f_l++] = length_modifier;
4813 f[f_l++] = fmt_spec;
4814 f[f_l++] = '\0';
4815
4816 if (fmt_spec == 'p')
4817 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004818 else if (fmt_spec == 'b' || fmt_spec == 'B')
4819 {
4820 char b[8 * sizeof(uvarnumber_T)];
4821 size_t b_l = 0;
4822 uvarnumber_T bn = bin_arg;
4823
4824 do
4825 {
4826 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4827 bn >>= 1;
4828 }
4829 while (bn != 0);
4830
4831 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4832 str_arg_l += b_l;
4833 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004834 else if (fmt_spec == 'd')
4835 {
4836 /* signed */
4837 switch (length_modifier)
4838 {
4839 case '\0':
4840 case 'h': str_arg_l += sprintf(
4841 tmp + str_arg_l, f, int_arg);
4842 break;
4843 case 'l': str_arg_l += sprintf(
4844 tmp + str_arg_l, f, long_arg);
4845 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004846# ifdef FEAT_NUM64
4847 case 'L': str_arg_l += sprintf(
4848 tmp + str_arg_l, f, llong_arg);
4849 break;
4850# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004851 }
4852 }
4853 else
4854 {
4855 /* unsigned */
4856 switch (length_modifier)
4857 {
4858 case '\0':
4859 case 'h': str_arg_l += sprintf(
4860 tmp + str_arg_l, f, uint_arg);
4861 break;
4862 case 'l': str_arg_l += sprintf(
4863 tmp + str_arg_l, f, ulong_arg);
4864 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004865# ifdef FEAT_NUM64
4866 case 'L': str_arg_l += sprintf(
4867 tmp + str_arg_l, f, ullong_arg);
4868 break;
4869# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004870 }
4871 }
4872
4873 /* include the optional minus sign and possible
4874 * "0x" in the region before the zero padding
4875 * insertion point */
4876 if (zero_padding_insertion_ind < str_arg_l
4877 && tmp[zero_padding_insertion_ind] == '-')
4878 zero_padding_insertion_ind++;
4879 if (zero_padding_insertion_ind + 1 < str_arg_l
4880 && tmp[zero_padding_insertion_ind] == '0'
4881 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4882 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4883 zero_padding_insertion_ind += 2;
4884 }
4885
4886 {
4887 size_t num_of_digits = str_arg_l
4888 - zero_padding_insertion_ind;
4889
4890 if (alternate_form && fmt_spec == 'o'
4891 /* unless zero is already the first
4892 * character */
4893 && !(zero_padding_insertion_ind < str_arg_l
4894 && tmp[zero_padding_insertion_ind] == '0'))
4895 {
4896 /* assure leading zero for alternate-form
4897 * octal numbers */
4898 if (!precision_specified
4899 || precision < num_of_digits + 1)
4900 {
4901 /* precision is increased to force the
4902 * first character to be zero, except if a
4903 * zero value is formatted with an
4904 * explicit precision of zero */
4905 precision = num_of_digits + 1;
4906 precision_specified = 1;
4907 }
4908 }
4909 /* zero padding to specified precision? */
4910 if (num_of_digits < precision)
4911 number_of_zeros_to_pad = precision - num_of_digits;
4912 }
4913 /* zero padding to specified minimal field width? */
4914 if (!justify_left && zero_padding)
4915 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004916 int n = (int)(min_field_width - (str_arg_l
4917 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004918 if (n > 0)
4919 number_of_zeros_to_pad += n;
4920 }
4921 break;
4922 }
4923
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004924# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004925 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004926 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004927 case 'e':
4928 case 'E':
4929 case 'g':
4930 case 'G':
4931 {
4932 /* Floating point. */
4933 double f;
4934 double abs_f;
4935 char format[40];
4936 int l;
4937 int remove_trailing_zeroes = FALSE;
4938
4939 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004940# if defined(FEAT_EVAL)
4941 tvs != NULL ? tv_float(tvs, &arg_idx) :
4942# endif
4943 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004944 abs_f = f < 0 ? -f : f;
4945
4946 if (fmt_spec == 'g' || fmt_spec == 'G')
4947 {
4948 /* Would be nice to use %g directly, but it prints
4949 * "1.0" as "1", we don't want that. */
4950 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4951 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004952 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004953 else
4954 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4955 remove_trailing_zeroes = TRUE;
4956 }
4957
Bram Moolenaar04186092016-08-29 21:55:35 +02004958 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004959# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004960 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004961# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004962 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004963# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004964 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004965 {
4966 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004967 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4968 force_sign, space_for_positive));
4969 str_arg_l = STRLEN(tmp);
4970 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004971 }
4972 else
4973 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004974 if (isnan(f))
4975 {
4976 /* Not a number: nan or NAN */
4977 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4978 : "nan");
4979 str_arg_l = 3;
4980 zero_padding = 0;
4981 }
4982 else if (isinf(f))
4983 {
4984 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4985 force_sign, space_for_positive));
4986 str_arg_l = STRLEN(tmp);
4987 zero_padding = 0;
4988 }
4989 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004990 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004991 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004992 format[0] = '%';
4993 l = 1;
4994 if (force_sign)
4995 format[l++] = space_for_positive ? ' ' : '+';
4996 if (precision_specified)
4997 {
4998 size_t max_prec = TMP_LEN - 10;
4999
5000 /* Make sure we don't get more digits than we
5001 * have room for. */
5002 if ((fmt_spec == 'f' || fmt_spec == 'F')
5003 && abs_f > 1.0)
5004 max_prec -= (size_t)log10(abs_f);
5005 if (precision > max_prec)
5006 precision = max_prec;
5007 l += sprintf(format + l, ".%d", (int)precision);
5008 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02005009 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02005010 format[l + 1] = NUL;
5011
Bram Moolenaare9997822016-08-28 16:03:38 +02005012 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01005013 }
Bram Moolenaar99922372016-08-27 15:26:35 +02005014
Bram Moolenaara7241f52008-06-24 20:39:31 +00005015 if (remove_trailing_zeroes)
5016 {
5017 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005018 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005019
5020 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02005021 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005022 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005023 else
5024 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005025 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005026 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005027 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005028 {
5029 /* Remove superfluous '+' and leading
5030 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005031 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005032 {
5033 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005034 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005035 --str_arg_l;
5036 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005037 i = (tp[1] == '-') ? 2 : 1;
5038 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005039 {
5040 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005041 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005042 --str_arg_l;
5043 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005044 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005045 }
5046 }
5047
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005048 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005049 /* Remove trailing zeroes, but keep the one
5050 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005051 while (tp > tmp + 2 && *tp == '0'
5052 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005053 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005054 STRMOVE(tp, tp + 1);
5055 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005056 --str_arg_l;
5057 }
5058 }
5059 else
5060 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005061 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005062
5063 /* Be consistent: some printf("%e") use 1.0e+12
5064 * and some 1.0e+012. Remove one zero in the last
5065 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005066 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005067 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005068 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5069 && tp[2] == '0'
5070 && vim_isdigit(tp[3])
5071 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005072 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005073 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005074 --str_arg_l;
5075 }
5076 }
5077 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005078 if (zero_padding && min_field_width > str_arg_l
5079 && (tmp[0] == '-' || force_sign))
5080 {
5081 /* padding 0's should be inserted after the sign */
5082 number_of_zeros_to_pad = min_field_width - str_arg_l;
5083 zero_padding_insertion_ind = 1;
5084 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005085 str_arg = tmp;
5086 break;
5087 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005088# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005089
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005090 default:
5091 /* unrecognized conversion specifier, keep format string
5092 * as-is */
5093 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005094 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005095 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005096 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097
5098 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005099 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005100 str_arg = p;
5101 str_arg_l = 0;
5102 if (*p != NUL)
5103 str_arg_l++; /* include invalid conversion specifier
5104 unchanged if not at end-of-string */
5105 break;
5106 }
5107
5108 if (*p != NUL)
5109 p++; /* step over the just processed conversion specifier */
5110
5111 /* insert padding to the left as requested by min_field_width;
5112 * this does not include the zero padding in case of numerical
5113 * conversions*/
5114 if (!justify_left)
5115 {
5116 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005117 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005118
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005119 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005120 {
5121 if (str_l < str_m)
5122 {
5123 size_t avail = str_m - str_l;
5124
5125 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005126 (size_t)pn > avail ? avail
5127 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005128 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005129 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005130 }
5131 }
5132
5133 /* zero padding as requested by the precision or by the minimal
5134 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005135 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005136 {
5137 /* will not copy first part of numeric right now, *
5138 * force it to be copied later in its entirety */
5139 zero_padding_insertion_ind = 0;
5140 }
5141 else
5142 {
5143 /* insert first part of numerics (sign or '0x') before zero
5144 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005145 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005146
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005147 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005148 {
5149 if (str_l < str_m)
5150 {
5151 size_t avail = str_m - str_l;
5152
5153 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005154 (size_t)zn > avail ? avail
5155 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005156 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005157 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005158 }
5159
5160 /* insert zero padding as requested by the precision or min
5161 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005162 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005163 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005164 {
5165 if (str_l < str_m)
5166 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005167 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005168
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005169 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005170 (size_t)zn > avail ? avail
5171 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005172 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005173 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005174 }
5175 }
5176
5177 /* insert formatted string
5178 * (or as-is conversion specifier for unknown conversions) */
5179 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005180 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005181
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005182 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005183 {
5184 if (str_l < str_m)
5185 {
5186 size_t avail = str_m - str_l;
5187
5188 mch_memmove(str + str_l,
5189 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005190 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005191 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005192 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005193 }
5194 }
5195
5196 /* insert right padding */
5197 if (justify_left)
5198 {
5199 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005200 int pn = (int)(min_field_width
5201 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005202
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005203 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005204 {
5205 if (str_l < str_m)
5206 {
5207 size_t avail = str_m - str_l;
5208
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005209 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005210 (size_t)pn > avail ? avail
5211 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005212 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005213 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005214 }
5215 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005216 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005217 }
5218 }
5219
5220 if (str_m > 0)
5221 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005222 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005223 * overwriting the last character (shouldn't happen, but just in case)
5224 * */
5225 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5226 }
5227
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005228 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005229 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005230
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005231 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005232 * character), that is, the number of characters that would have been
5233 * written to the buffer if it were large enough. */
5234 return (int)str_l;
5235}
5236
5237#endif /* PROTO */