blob: 063fadae4a2ad17f624e0e29f87462ddcaf70b06 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * message.c: functions for displaying messages on the command line
12 */
13
14#define MESSAGE_FILE /* don't include prototype for smsg() */
Bram Moolenaar44ca54a2016-08-27 15:41:32 +020015#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
17#include "vim.h"
18
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010019static void add_msg_hist(char_u *s, int len, int attr);
20static void hit_return_msg(void);
21static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +010022static void msg_puts_attr_len(char *str, int maxlen, int attr);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010023static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
24static void msg_scroll_up(void);
25static void inc_msg_scrolled(void);
26static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
27static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
28static void msg_puts_printf(char_u *str, int maxlen);
29static int do_more_prompt(int typed_char);
30static void msg_screen_putchar(int c, int attr);
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 Moolenaar32526b32019-01-19 17:43:09 +010099msg(char *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 Moolenaar32526b32019-01-19 17:43:09 +0100110verb_msg(char *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000111{
112 int n;
113
114 verbose_enter();
115 n = msg_attr_keep(s, 0, FALSE);
116 verbose_leave();
117
118 return n;
119}
120#endif
121
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 int
Bram Moolenaar32526b32019-01-19 17:43:09 +0100123msg_attr(char *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(
Bram Moolenaar32526b32019-01-19 17:43:09 +0100130 char *s,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100131 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. */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100140 if (!emsg_on_display && message_filtered((char_u *)s))
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200141 return TRUE;
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143#ifdef FEAT_EVAL
144 if (attr == 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100145 set_vim_var_string(VV_STATUSMSG, (char_u *)s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146#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) */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100159 if ((char_u *)s != keep_msg
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 || (*s != '<'
161 && last_msg_hist != NULL
162 && last_msg_hist->msg != NULL
163 && STRCMP(s, last_msg_hist->msg)))
Bram Moolenaar32526b32019-01-19 17:43:09 +0100164 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165
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. */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100174 if ((char_u *)s == keep_msg)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 keep_msg = NULL;
176
177 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000178 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +0100179 buf = msg_strtrunc((char_u *)s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 if (buf != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100181 s = (char *)buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182
Bram Moolenaar32526b32019-01-19 17:43:09 +0100183 msg_outtrans_attr((char_u *)s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184 msg_clr_eos();
185 retval = msg_end();
186
Bram Moolenaar32526b32019-01-19 17:43:09 +0100187 if (keep && retval && vim_strsize((char_u *)s)
188 < (int)(Rows - cmdline_row - 1) * Columns + sc_col)
189 set_keep_msg((char_u *)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 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222 if (enc_utf8)
223 /* may have up to 18 bytes per cell (6 per char, up to two
224 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100225 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 else if (enc_dbcs == DBCS_JPNU)
227 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100228 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229 else
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100230 len = room + 2;
231 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100233 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 }
235 }
236 return buf;
237}
238
239/*
240 * Truncate a string "s" to "buf" with cell width "room".
241 * "s" and "buf" may be equal.
242 */
243 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100244trunc_string(
245 char_u *s,
246 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200247 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100248 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200250 size_t room = room_in - 3; /* "..." takes 3 chars */
251 size_t half;
252 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253 int e;
254 int i;
255 int n;
256
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200257 if (room_in < 3)
258 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260
261 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100262 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 {
264 if (s[e] == NUL)
265 {
266 /* text fits without truncating! */
267 buf[e] = NUL;
268 return;
269 }
270 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200271 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 break;
273 len += n;
274 buf[e] = s[e];
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000276 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100278 if (++e == buflen)
279 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 buf[e] = s[e];
281 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282 }
283
284 /* Last part: End of the string. */
285 i = e;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 if (enc_dbcs != 0)
287 {
288 /* For DBCS going backwards in a string is slow, but
289 * computing the cell width isn't too slow: go forward
290 * until the rest fits. */
291 n = vim_strsize(s + i);
292 while (len + n > room)
293 {
294 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000295 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 }
297 }
298 else if (enc_utf8)
299 {
300 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000301 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 for (;;)
303 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000304 do
Bram Moolenaarace95982017-03-29 17:30:27 +0200305 half = half - utf_head_off(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200306 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200308 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 break;
310 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200311 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312 }
313 }
314 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315 {
316 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
317 len += n;
318 }
319
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200320
321 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100322 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200323 /* text fits without truncating */
324 if (s != buf)
325 {
326 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200327 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200328 len = buflen - 1;
329 len = len - e + 1;
330 if (len < 1)
331 buf[e - 1] = NUL;
332 else
333 mch_memmove(buf + e, s + e, len);
334 }
335 }
336 else if (e + 3 < buflen)
337 {
338 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100339 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200340 len = STRLEN(s + i) + 1;
341 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100342 len = buflen - e - 3 - 1;
343 mch_memmove(buf + e + 3, s + i, len);
344 buf[e + 3 + len - 1] = NUL;
345 }
346 else
347 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200348 /* can't fit in the "...", just truncate it */
349 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100350 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351}
352
353/*
354 * Automatic prototype generation does not understand this function.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100355 * Note: Caller of smsg() and smsg_attr() must check the resulting string is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 * shorter than IOSIZE!!!
357 */
358#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100360int vim_snprintf(char *str, size_t str_m, const char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000361
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100363# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100365# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100366smsg(const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367{
368 va_list arglist;
369
370 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100371 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100373 return msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374}
375
376 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100377# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100379# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100380smsg_attr(int attr, const char *s, ...)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381{
382 va_list arglist;
383
384 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100385 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100387 return msg_attr((char *)IObuff, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388}
389
Bram Moolenaare0429682018-07-01 16:44:03 +0200390 int
391# ifdef __BORLANDC__
392_RTLENTRYF
393# endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100394smsg_attr_keep(int attr, const char *s, ...)
Bram Moolenaare0429682018-07-01 16:44:03 +0200395{
396 va_list arglist;
397
398 va_start(arglist, s);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100399 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist);
Bram Moolenaare0429682018-07-01 16:44:03 +0200400 va_end(arglist);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100401 return msg_attr_keep((char *)IObuff, attr, TRUE);
Bram Moolenaare0429682018-07-01 16:44:03 +0200402}
403
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404#endif
405
406/*
407 * Remember the last sourcing name/lnum used in an error message, so that it
408 * isn't printed each time when it didn't change.
409 */
410static int last_sourcing_lnum = 0;
411static char_u *last_sourcing_name = NULL;
412
413/*
414 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
415 * for the next error message;
416 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000417 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100418reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419{
Bram Moolenaard23a8232018-02-10 18:45:26 +0100420 VIM_CLEAR(last_sourcing_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 last_sourcing_lnum = 0;
422}
423
424/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000425 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
426 */
427 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100428other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000429{
430 if (sourcing_name != NULL)
431 {
432 if (last_sourcing_name != NULL)
433 return STRCMP(sourcing_name, last_sourcing_name) != 0;
434 return TRUE;
435 }
436 return FALSE;
437}
438
439/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 * Get the message about the source, as used for an error message.
441 * Returns an allocated string with room for one more character.
442 * Returns NULL when no message is to be given.
443 */
444 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100445get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446{
447 char_u *Buf, *p;
448
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000449 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 {
451 p = (char_u *)_("Error detected while processing %s:");
452 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
453 if (Buf != NULL)
454 sprintf((char *)Buf, (char *)p, sourcing_name);
455 return Buf;
456 }
457 return NULL;
458}
459
460/*
461 * Get the message about the source lnum, as used for an error message.
462 * Returns an allocated string with room for one more character.
463 * Returns NULL when no message is to be given.
464 */
465 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100466get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000467{
468 char_u *Buf, *p;
469
470 /* lnum is 0 when executing a command from the command line
471 * argument, we don't want a line number then */
472 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000473 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474 && sourcing_lnum != 0)
475 {
476 p = (char_u *)_("line %4ld:");
477 Buf = alloc((unsigned)(STRLEN(p) + 20));
478 if (Buf != NULL)
479 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
480 return Buf;
481 }
482 return NULL;
483}
484
485/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000486 * Display name and line number for the source of an error.
487 * Remember the file name and line number, so that for the next error the info
488 * is only displayed if it changed.
489 */
490 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100491msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000492{
493 char_u *p;
494
495 ++no_wait_return;
496 p = get_emsg_source();
497 if (p != NULL)
498 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100499 msg_attr((char *)p, attr);
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000500 vim_free(p);
501 }
502 p = get_emsg_lnum();
503 if (p != NULL)
504 {
Bram Moolenaar32526b32019-01-19 17:43:09 +0100505 msg_attr((char *)p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000506 vim_free(p);
507 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
508 }
509
510 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000511 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000512 {
513 vim_free(last_sourcing_name);
514 if (sourcing_name == NULL)
515 last_sourcing_name = NULL;
516 else
517 last_sourcing_name = vim_strsave(sourcing_name);
518 }
519 --no_wait_return;
520}
521
522/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000523 * Return TRUE if not giving error messages right now:
524 * If "emsg_off" is set: no error messages at the moment.
525 * If "msg" is in 'debug': do error message but without side effects.
526 * If "emsg_skip" is set: never do error messages.
527 */
528 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100529emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000530{
531 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
532 && vim_strchr(p_debug, 't') == NULL)
533#ifdef FEAT_EVAL
534 || emsg_skip > 0
535#endif
536 )
537 return TRUE;
538 return FALSE;
539}
540
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100541#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100542static garray_T ignore_error_list = GA_EMPTY;
543
544 void
545ignore_error_for_testing(char_u *error)
546{
547 if (ignore_error_list.ga_itemsize == 0)
548 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
549
Bram Moolenaar461a7fc2018-12-22 13:28:07 +0100550 if (STRCMP("RESET", error) == 0)
551 ga_clear_strings(&ignore_error_list);
552 else
553 ga_add_string(&ignore_error_list, error);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100554}
555
556 static int
557ignore_error(char_u *msg)
558{
559 int i;
560
561 for (i = 0; i < ignore_error_list.ga_len; ++i)
562 if (strstr((char *)msg,
563 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
564 return TRUE;
565 return FALSE;
566}
567#endif
568
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200569#if !defined(HAVE_STRERROR) || defined(PROTO)
570/*
571 * Replacement for perror() that behaves more or less like emsg() was called.
572 * v:errmsg will be set and called_emsg will be set.
573 */
574 void
575do_perror(char *msg)
576{
577 perror(msg);
578 ++emsg_silent;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100579 emsg(msg);
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200580 --emsg_silent;
581}
582#endif
583
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000584/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100585 * emsg_core() - display an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 *
587 * Rings the bell, if appropriate, and calls message() to do the real work
588 * When terminal not initialized (yet) mch_errmsg(..) is used.
589 *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100590 * Return TRUE if wait_return not called.
591 * Note: caller must check 'emsg_not_now()' before calling this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100593 static int
594emsg_core(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595{
596 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100598 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599#ifdef FEAT_EVAL
600 int ignore = FALSE;
601 int severe;
602#endif
603
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100604#ifdef FEAT_EVAL
605 /* When testing some errors are turned into a normal message. */
606 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100607 /* don't call msg() if it results in a dialog */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100608 return msg_use_printf() ? FALSE : msg((char *)s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100609#endif
610
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 called_emsg = TRUE;
612
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613#ifdef FEAT_EVAL
Bram Moolenaare723c422017-09-06 23:40:10 +0200614 /* If "emsg_severe" is TRUE: When an error exception is to be thrown,
615 * prefer this message over previous messages for the same command. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616 severe = emsg_severe;
617 emsg_severe = FALSE;
618#endif
619
Bram Moolenaar57657d82006-04-21 22:12:41 +0000620 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621 {
622#ifdef FEAT_EVAL
623 /*
624 * Cause a throw of an error exception if appropriate. Don't display
625 * the error message in this case. (If no matching catch clause will
626 * be found, the message will be displayed later on.) "ignore" is set
627 * when the message should be ignored completely (used for the
628 * interrupt message).
629 */
630 if (cause_errthrow(s, severe, &ignore) == TRUE)
631 {
632 if (!ignore)
Bram Moolenaar76a63452018-11-28 20:38:37 +0100633 ++did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 return TRUE;
635 }
636
637 /* set "v:errmsg", also when using ":silent! cmd" */
638 set_vim_var_string(VV_ERRMSG, s, -1);
639#endif
640
641 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000642 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 * But do write it to the redirection file.
644 */
645 if (emsg_silent != 0)
646 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200647 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200649 msg_start();
650 p = get_emsg_source();
651 if (p != NULL)
652 {
653 STRCAT(p, "\n");
654 redir_write(p, -1);
655 vim_free(p);
656 }
657 p = get_emsg_lnum();
658 if (p != NULL)
659 {
660 STRCAT(p, "\n");
661 redir_write(p, -1);
662 vim_free(p);
663 }
664 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100666#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200667 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100668#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 return TRUE;
670 }
671
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100672 ex_exitval = 1;
673
Bram Moolenaar2f40d122017-10-24 21:49:36 +0200674 /* Reset msg_silent, an error causes messages to be switched back on.
675 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 msg_silent = 0;
677 cmd_silent = FALSE;
678
679 if (global_busy) /* break :global command */
680 ++global_busy;
681
682 if (p_eb)
683 beep_flush(); /* also includes flush_buffers() */
684 else
Bram Moolenaar6a2633b2018-10-07 23:16:36 +0200685 flush_buffers(FLUSH_MINIMAL); // flush internal buffers
Bram Moolenaar76a63452018-11-28 20:38:37 +0100686 ++did_emsg; // flag for DoOneCmd()
Bram Moolenaare723c422017-09-06 23:40:10 +0200687#ifdef FEAT_EVAL
688 did_uncaught_emsg = TRUE;
689#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 }
691
692 emsg_on_display = TRUE; /* remember there is an error message */
693 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100694 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000695 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 need_wait_return = TRUE; /* needed in case emsg() is called after
697 * wait_return has reset need_wait_return
698 * and a redraw is expected because
699 * msg_scrolled is non-zero */
700
Bram Moolenaar958dc692016-12-01 15:34:12 +0100701#ifdef FEAT_JOB_CHANNEL
702 emsg_to_channel_log = TRUE;
703#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 /*
705 * Display name and line number for the source of the error.
706 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000707 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709 /*
710 * Display the error message itself.
711 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000712 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100713 r = msg_attr((char *)s, attr);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100714
715#ifdef FEAT_JOB_CHANNEL
716 emsg_to_channel_log = FALSE;
717#endif
718 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719}
720
721/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100722 * Print an error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 */
724 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100725emsg(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100727 /* Skip this if not giving error messages at the moment. */
728 if (!emsg_not_now())
729 return emsg_core((char_u *)s);
730 return TRUE; /* no error messages at the moment */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731}
732
Bram Moolenaar95f09602016-11-10 20:01:45 +0100733/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100734 * Print an error message with format string and variable arguments.
735 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100736 */
737 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100738semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100739{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100740 /* Skip this if not giving error messages at the moment. */
741 if (!emsg_not_now())
742 {
743 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100744
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100745 va_start(ap, s);
746 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
747 va_end(ap);
748 return emsg_core(IObuff);
749 }
750 return TRUE; /* no error messages at the moment */
Bram Moolenaar95f09602016-11-10 20:01:45 +0100751}
752
753/*
754 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
755 * defined. It is used for internal errors only, so that they can be
756 * detected when fuzzing vim.
757 */
758 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100759iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100760{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100761 if (!emsg_not_now())
762 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100763#ifdef ABORT_ON_INTERNAL_ERROR
764 abort();
765#endif
766}
767
768/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100769 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100770 * defined. It is used for internal errors only, so that they can be
771 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100772 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100773 */
774 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100776{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100777 if (!emsg_not_now())
778 {
779 va_list ap;
780
781 va_start(ap, s);
782 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
783 va_end(ap);
784 emsg_core(IObuff);
785 }
Bram Moolenaar95f09602016-11-10 20:01:45 +0100786#ifdef ABORT_ON_INTERNAL_ERROR
787 abort();
788#endif
789}
790
791/*
792 * Give an "Internal error" message.
793 */
794 void
795internal_error(char *where)
796{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100797 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100798}
799
Bram Moolenaarea424162005-06-16 21:51:00 +0000800/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
Bram Moolenaardf177f62005-02-22 08:39:57 +0000802 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100803emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000804{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100805 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000806}
807
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808/*
809 * Like msg(), but truncate to a single line if p_shm contains 't', or when
810 * "force" is TRUE. This truncates in another way as for normal messages.
811 * Careful: The string may be changed by msg_may_trunc()!
812 * Returns a pointer to the printed message, if wait_return() not called.
813 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100814 char *
815msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816{
817 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100818 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820 /* Add message to history before truncating */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100821 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
Bram Moolenaar32526b32019-01-19 17:43:09 +0100823 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824
825 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100826 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 msg_hist_off = FALSE;
828
829 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100830 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 return NULL;
832}
833
834/*
835 * Check if message "s" should be truncated at the start (for filenames).
836 * Return a pointer to where the truncated message starts.
837 * Note: May change the message by replacing a character with '<'.
838 */
839 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100840msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841{
842 int n;
843 int room;
844
845 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
846 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
847 && (n = (int)STRLEN(s) - room) > 0)
848 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 if (has_mbyte)
850 {
851 int size = vim_strsize(s);
852
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000853 /* There may be room anyway when there are multibyte chars. */
854 if (size <= room)
855 return s;
856
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857 for (n = 0; size >= room; )
858 {
859 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000860 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 }
862 --n;
863 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 s += n;
865 *s = '<';
866 }
867 return s;
868}
869
870 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100871add_msg_hist(
872 char_u *s,
873 int len, /* -1 for undetermined length */
874 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875{
876 struct msg_hist *p;
877
878 if (msg_hist_off || msg_silent != 0)
879 return;
880
881 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000882 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000883 (void)delete_first_msg();
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 /* allocate an entry and add the message at the end of the history */
886 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
887 if (p != NULL)
888 {
889 if (len < 0)
890 len = (int)STRLEN(s);
891 /* remove leading and trailing newlines */
892 while (len > 0 && *s == '\n')
893 {
894 ++s;
895 --len;
896 }
897 while (len > 0 && s[len - 1] == '\n')
898 --len;
899 p->msg = vim_strnsave(s, len);
900 p->next = NULL;
901 p->attr = attr;
902 if (last_msg_hist != NULL)
903 last_msg_hist->next = p;
904 last_msg_hist = p;
905 if (first_msg_hist == NULL)
906 first_msg_hist = last_msg_hist;
907 ++msg_hist_len;
908 }
909}
910
911/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000912 * Delete the first (oldest) message from the history.
913 * Returns FAIL if there are no messages.
914 */
915 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100916delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000917{
918 struct msg_hist *p;
919
920 if (msg_hist_len <= 0)
921 return FAIL;
922 p = first_msg_hist;
923 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000924 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200925 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000926 vim_free(p->msg);
927 vim_free(p);
928 --msg_hist_len;
929 return OK;
930}
931
932/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 * ":messages" command.
934 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200936ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937{
938 struct msg_hist *p;
939 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200940 int c = 0;
941
942 if (STRCMP(eap->arg, "clear") == 0)
943 {
944 int keep = eap->addr_count == 0 ? 0 : eap->line2;
945
946 while (msg_hist_len > keep)
947 (void)delete_first_msg();
948 return;
949 }
950
951 if (*eap->arg != NUL)
952 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100953 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200954 return;
955 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956
957 msg_hist_off = TRUE;
958
Bram Moolenaar451f8492016-04-14 17:16:22 +0200959 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200960 if (eap->addr_count != 0)
961 {
962 /* Count total messages */
963 for (; p != NULL && !got_int; p = p->next)
964 c++;
965
966 c -= eap->line2;
967
968 /* Skip without number of messages specified */
969 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
970 p = p->next, c--);
971 }
972
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200973 if (p == first_msg_hist)
974 {
975 s = mch_getenv((char_u *)"LANG");
976 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +0200977 // The next comment is extracted by xgettext and put in po file for
978 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +0100979 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +0200980 // Translator: Please replace the name and email address
981 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200982 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100983 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200984 }
985
Bram Moolenaar451f8492016-04-14 17:16:22 +0200986 /* Display what was not skipped. */
987 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100989 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990
991 msg_hist_off = FALSE;
992}
993
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000994#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995/*
996 * Call this after prompting the user. This will avoid a hit-return message
997 * and a delay.
998 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000999 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001000msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001{
1002 need_wait_return = FALSE;
1003 emsg_on_display = FALSE;
1004 cmdline_row = msg_row;
1005 msg_col = 0;
1006 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001007 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008}
1009#endif
1010
1011/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001012 * Wait for the user to hit a key (normally Enter).
1013 * If "redraw" is TRUE, clear and redraw the screen.
1014 * If "redraw" is FALSE, just redraw the screen.
1015 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 */
1017 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001018wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019{
1020 int c;
1021 int oldState;
1022 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001024 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001025 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
1027 if (redraw == TRUE)
1028 must_redraw = CLEAR;
1029
1030 /* If using ":silent cmd", don't wait for a return. Also don't set
1031 * need_wait_return to do it later. */
1032 if (msg_silent != 0)
1033 return;
1034
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001035 /*
1036 * When inside vgetc(), we can't wait for a typed character at all.
1037 * With the global command (and some others) we only need one return at
1038 * the end. Adjust cmdline_row to avoid the next message overwriting the
1039 * last one.
1040 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001041 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001043 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 if (no_wait_return)
1045 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 if (!exmode_active)
1047 cmdline_row = msg_row;
1048 return;
1049 }
1050
1051 redir_off = TRUE; /* don't redirect this message */
1052 oldState = State;
1053 if (quit_more)
1054 {
1055 c = CAR; /* just pretend CR was hit */
1056 quit_more = FALSE;
1057 got_int = FALSE;
1058 }
1059 else if (exmode_active)
1060 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001061 msg_puts(" "); /* make sure the cursor is on the right line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 c = CAR; /* no need for a return in ex mode */
1063 got_int = FALSE;
1064 }
1065 else
1066 {
1067 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1068 * just changed. */
1069 screenalloc(FALSE);
1070
1071 State = HITRETURN;
1072#ifdef FEAT_MOUSE
1073 setmouse();
1074#endif
1075#ifdef USE_ON_FLY_SCROLL
1076 dont_scroll = TRUE; /* disallow scrolling here */
1077#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001078 cmdline_row = msg_row;
1079
Bram Moolenaarec38d692013-04-24 15:12:32 +02001080 /* Avoid the sequence that the user types ":" at the hit-return prompt
1081 * to start an Ex command, but the file-changed dialog gets in the
1082 * way. */
1083 if (need_check_timestamps)
1084 check_timestamps(FALSE);
1085
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 hit_return_msg();
1087
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088 do
1089 {
1090 /* Remember "got_int", if it is set vgetc() probably returns a
1091 * CTRL-C, but we need to loop then. */
1092 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001093
1094 /* Don't do mappings here, we put the character back in the
1095 * typeahead buffer. */
1096 ++no_mapping;
1097 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001098
1099 /* Temporarily disable Recording. If Recording is active, the
1100 * character will be recorded later, since it will be added to the
1101 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001102 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001103 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001104 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001105 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001107 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001109 --no_mapping;
1110 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001111 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001112 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001113
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114#ifdef FEAT_CLIPBOARD
1115 /* Strange way to allow copying (yanking) a modeless selection at
1116 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1117 * Cmdline-mode and it's harmless when there is no selection. */
1118 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1119 {
1120 clip_copy_modeless_selection(TRUE);
1121 c = K_IGNORE;
1122 }
1123#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001124
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001125 /*
1126 * Allow scrolling back in the messages.
1127 * Also accept scroll-down commands when messages fill the screen,
1128 * to avoid that typing one 'j' too many makes the messages
1129 * disappear.
1130 */
1131 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001132 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001133 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1134 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001135 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001136 if (msg_scrolled > Rows)
1137 /* scroll back to show older messages */
1138 do_more_prompt(c);
1139 else
1140 {
1141 msg_didout = FALSE;
1142 c = K_IGNORE;
1143 msg_col =
1144#ifdef FEAT_RIGHTLEFT
1145 cmdmsg_rl ? Columns - 1 :
1146#endif
1147 0;
1148 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001149 if (quit_more)
1150 {
1151 c = CAR; /* just pretend CR was hit */
1152 quit_more = FALSE;
1153 got_int = FALSE;
1154 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001155 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001156 {
1157 c = K_IGNORE;
1158 hit_return_msg();
1159 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001160 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001161 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001162 && (c == 'j' || c == 'd' || c == 'f'
1163 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001164 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001165 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 } while ((had_got_int && c == Ctrl_C)
1167 || c == K_IGNORE
1168#ifdef FEAT_GUI
1169 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1170#endif
1171#ifdef FEAT_MOUSE
1172 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1173 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1174 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001175 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001177 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 || (!mouse_has(MOUSE_RETURN)
1179 && mouse_row < msg_row
1180 && (c == K_LEFTMOUSE
1181 || c == K_MIDDLEMOUSE
1182 || c == K_RIGHTMOUSE
1183 || c == K_X1MOUSE
1184 || c == K_X2MOUSE))
1185#endif
1186 );
1187 ui_breakcheck();
1188#ifdef FEAT_MOUSE
1189 /*
1190 * Avoid that the mouse-up event causes visual mode to start.
1191 */
1192 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1193 || c == K_X1MOUSE || c == K_X2MOUSE)
1194 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1195 else
1196#endif
1197 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1198 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001199 /* Put the character back in the typeahead buffer. Don't use the
1200 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001201 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001203 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 }
1206 redir_off = FALSE;
1207
1208 /*
1209 * If the user hits ':', '?' or '/' we get a command line from the next
1210 * line.
1211 */
1212 if (c == ':' || c == '?' || c == '/')
1213 {
1214 if (!exmode_active)
1215 cmdline_row = msg_row;
1216 skip_redraw = TRUE; /* skip redraw once */
1217 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001218#ifdef FEAT_TERMINAL
1219 skip_term_loop = TRUE;
1220#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 }
1222
1223 /*
1224 * If the window size changed set_shellsize() will redraw the screen.
1225 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1226 * typed.
1227 */
1228 tmpState = State;
1229 State = oldState; /* restore State before set_shellsize */
1230#ifdef FEAT_MOUSE
1231 setmouse();
1232#endif
1233 msg_check();
1234
1235#if defined(UNIX) || defined(VMS)
1236 /*
1237 * When switching screens, we need to output an extra newline on exit.
1238 */
1239 if (swapping_screen() && !termcap_active)
1240 newline_on_exit = TRUE;
1241#endif
1242
1243 need_wait_return = FALSE;
1244 did_wait_return = TRUE;
1245 emsg_on_display = FALSE; /* can delete error message now */
1246 lines_left = -1; /* reset lines_left at next msg_start() */
1247 reset_last_sourcing();
1248 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1249 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001250 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251
1252 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1253 {
1254 starttermcap(); /* start termcap before redrawing */
1255 shell_resized();
1256 }
1257 else if (!skip_redraw
1258 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1259 {
1260 starttermcap(); /* start termcap before redrawing */
1261 redraw_later(VALID);
1262 }
1263}
1264
1265/*
1266 * Write the hit-return prompt.
1267 */
1268 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001269hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001271 int save_p_more = p_more;
1272
1273 p_more = FALSE; /* don't want see this message when scrolling back */
1274 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 msg_putchar('\n');
1276 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001277 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
Bram Moolenaar32526b32019-01-19 17:43:09 +01001279 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 if (!msg_use_printf())
1281 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001282 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283}
1284
1285/*
1286 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1287 */
1288 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001289set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290{
1291 vim_free(keep_msg);
1292 if (s != NULL && msg_silent == 0)
1293 keep_msg = vim_strsave(s);
1294 else
1295 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001296 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001297 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298}
1299
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001300#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1301/*
1302 * If there currently is a message being displayed, set "keep_msg" to it, so
1303 * that it will be displayed again after redraw.
1304 */
1305 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001306set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001307{
1308 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1309 && (State & NORMAL))
1310 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1311}
1312#endif
1313
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314/*
1315 * Prepare for outputting characters in the command line.
1316 */
1317 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001318msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319{
1320 int did_return = FALSE;
1321
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001322 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001323 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001324
1325#ifdef FEAT_EVAL
1326 if (need_clr_eos)
1327 {
1328 /* Halfway an ":echo" command and getting an (error) message: clear
1329 * any text from the command. */
1330 need_clr_eos = FALSE;
1331 msg_clr_eos();
1332 }
1333#endif
1334
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 if (!msg_scroll && full_screen) /* overwrite last message */
1336 {
1337 msg_row = cmdline_row;
1338 msg_col =
1339#ifdef FEAT_RIGHTLEFT
1340 cmdmsg_rl ? Columns - 1 :
1341#endif
1342 0;
1343 }
1344 else if (msg_didout) /* start message on next line */
1345 {
1346 msg_putchar('\n');
1347 did_return = TRUE;
1348 if (exmode_active != EXMODE_NORMAL)
1349 cmdline_row = msg_row;
1350 }
1351 if (!msg_didany || lines_left < 0)
1352 msg_starthere();
1353 if (msg_silent == 0)
1354 {
1355 msg_didout = FALSE; /* no output on current line yet */
1356 cursor_off();
1357 }
1358
1359 /* when redirecting, may need to start a new line. */
1360 if (!did_return)
1361 redir_write((char_u *)"\n", -1);
1362}
1363
1364/*
1365 * Note that the current msg position is where messages start.
1366 */
1367 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001368msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369{
1370 lines_left = cmdline_row;
1371 msg_didany = FALSE;
1372}
1373
1374 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001375msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376{
1377 msg_putchar_attr(c, 0);
1378}
1379
1380 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001381msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001383 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384
1385 if (IS_SPECIAL(c))
1386 {
1387 buf[0] = K_SPECIAL;
1388 buf[1] = K_SECOND(c);
1389 buf[2] = K_THIRD(c);
1390 buf[3] = NUL;
1391 }
1392 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001393 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001394 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395}
1396
1397 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001398msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001400 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401
Bram Moolenaar32526b32019-01-19 17:43:09 +01001402 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 msg_puts(buf);
1404}
1405
1406 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001407msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408{
1409 msg_home_replace_attr(fname, 0);
1410}
1411
1412#if defined(FEAT_FIND_ID) || defined(PROTO)
1413 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001414msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001416 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417}
1418#endif
1419
1420 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001421msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422{
1423 char_u *name;
1424
1425 name = home_replace_save(NULL, fname);
1426 if (name != NULL)
1427 msg_outtrans_attr(name, attr);
1428 vim_free(name);
1429}
1430
1431/*
1432 * Output 'len' characters in 'str' (including NULs) with translation
1433 * if 'len' is -1, output upto a NUL character.
1434 * Use attributes 'attr'.
1435 * Return the number of characters it takes on the screen.
1436 */
1437 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001438msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439{
1440 return msg_outtrans_attr(str, 0);
1441}
1442
1443 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001444msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445{
1446 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1447}
1448
1449 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001450msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451{
1452 return msg_outtrans_len_attr(str, len, 0);
1453}
1454
1455/*
1456 * Output one character at "p". Return pointer to the next character.
1457 * Handles multi-byte characters.
1458 */
1459 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001460msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 int l;
1463
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001464 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 {
1466 msg_outtrans_len_attr(p, l, attr);
1467 return p + l;
1468 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001469 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 return p + 1;
1471}
1472
1473 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001474msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475{
1476 int retval = 0;
1477 char_u *str = msgstr;
1478 char_u *plain_start = msgstr;
1479 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 int mb_l;
1481 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482
1483 /* if MSG_HIST flag set, add message to history */
1484 if (attr & MSG_HIST)
1485 {
1486 add_msg_hist(str, len, attr);
1487 attr &= ~MSG_HIST;
1488 }
1489
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 /* If the string starts with a composing character first draw a space on
1491 * which the composing char can be drawn. */
1492 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001493 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494
1495 /*
1496 * Go over the string. Special characters are translated and printed.
1497 * Normal characters are printed several at a time.
1498 */
1499 while (--len >= 0)
1500 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 if (enc_utf8)
1502 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001503 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001505 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 else
1507 mb_l = 1;
1508 if (has_mbyte && mb_l > 1)
1509 {
1510 c = (*mb_ptr2char)(str);
1511 if (vim_isprintc(c))
1512 /* printable multi-byte char: count the cells. */
1513 retval += (*mb_ptr2cells)(str);
1514 else
1515 {
1516 /* unprintable multi-byte char: print the printable chars so
1517 * far and the translation of the unprintable char. */
1518 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001519 msg_puts_attr_len((char *)plain_start,
1520 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001522 msg_puts_attr((char *)transchar(c),
1523 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 retval += char2cells(c);
1525 }
1526 len -= mb_l - 1;
1527 str += mb_l;
1528 }
1529 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {
1531 s = transchar_byte(*str);
1532 if (s[1] != NUL)
1533 {
1534 /* unprintable char: print the printable chars so far and the
1535 * translation of the unprintable char. */
1536 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001537 msg_puts_attr_len((char *)plain_start,
1538 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001540 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001541 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001543 else
1544 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 ++str;
1546 }
1547 }
1548
1549 if (str > plain_start)
1550 /* print the printable chars at the end */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001551 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552
1553 return retval;
1554}
1555
1556#if defined(FEAT_QUICKFIX) || defined(PROTO)
1557 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001558msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559{
1560 int i;
1561 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1562
1563 arg = skipwhite(arg);
1564 for (i = 5; *arg && i >= 0; --i)
1565 if (*arg++ != str[i])
1566 break;
1567 if (i < 0)
1568 {
1569 msg_putchar('\n');
1570 for (i = 0; rs[i]; ++i)
1571 msg_putchar(rs[i] - 3);
1572 }
1573}
1574#endif
1575
1576/*
1577 * Output the string 'str' upto a NUL character.
1578 * Return the number of characters it takes on the screen.
1579 *
1580 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1581 * following character and shown as <F1>, <S-Up> etc. Any other character
1582 * which is not printable shown in <> form.
1583 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1584 * If a character is displayed in one of these special ways, is also
1585 * highlighted (its highlight name is '8' in the p_hl variable).
1586 * Otherwise characters are not highlighted.
1587 * This function is used to show mappings, where we want to see how to type
1588 * the character/string -- webb
1589 */
1590 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001591msg_outtrans_special(
1592 char_u *strstart,
1593 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594{
1595 char_u *str = strstart;
1596 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001597 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 int attr;
1599 int len;
1600
Bram Moolenaar8820b482017-03-16 17:23:31 +01001601 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 while (*str != NUL)
1603 {
1604 /* Leading and trailing spaces need to be displayed in <> form. */
1605 if ((str == strstart || str[1] == NUL) && *str == ' ')
1606 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001607 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 ++str;
1609 }
1610 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001611 text = (char *)str2special(&str, from);
1612 len = vim_strsize((char_u *)text);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 /* Highlight special keys */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001614 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001615 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 retval += len;
1617 }
1618 return retval;
1619}
1620
Bram Moolenaarbd743252010-10-20 21:23:33 +02001621#if defined(FEAT_EVAL) || defined(PROTO)
1622/*
1623 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1624 * strings, in an allocated string.
1625 */
1626 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001627str2special_save(
1628 char_u *str,
1629 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001630{
1631 garray_T ga;
1632 char_u *p = str;
1633
1634 ga_init2(&ga, 1, 40);
1635 while (*p != NUL)
1636 ga_concat(&ga, str2special(&p, is_lhs));
1637 ga_append(&ga, NUL);
1638 return (char_u *)ga.ga_data;
1639}
1640#endif
1641
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642/*
1643 * Return the printable string for the key codes at "*sp".
1644 * Used for translating the lhs or rhs of a mapping to printable chars.
1645 * Advances "sp" to the next code.
1646 */
1647 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001648str2special(
1649 char_u **sp,
1650 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651{
1652 int c;
1653 static char_u buf[7];
1654 char_u *str = *sp;
1655 int modifiers = 0;
1656 int special = FALSE;
1657
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 if (has_mbyte)
1659 {
1660 char_u *p;
1661
1662 /* Try to un-escape a multi-byte character. Return the un-escaped
1663 * string if it is a multi-byte character. */
1664 p = mb_unescape(sp);
1665 if (p != NULL)
1666 return p;
1667 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668
1669 c = *str;
1670 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1671 {
1672 if (str[1] == KS_MODIFIER)
1673 {
1674 modifiers = str[2];
1675 str += 3;
1676 c = *str;
1677 }
1678 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1679 {
1680 c = TO_SPECIAL(str[1], str[2]);
1681 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 }
1683 if (IS_SPECIAL(c) || modifiers) /* special key */
1684 special = TRUE;
1685 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001687 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001689 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001690
1691 /* For multi-byte characters check for an illegal byte. */
1692 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1693 {
1694 transchar_nonprint(buf, c);
1695 *sp = str + 1;
1696 return buf;
1697 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001698 /* Since 'special' is TRUE the multi-byte character 'c' will be
1699 * processed by get_special_key_name() */
1700 c = (*mb_ptr2char)(str);
1701 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001703 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001704 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705
1706 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1707 * Use <Space> only for lhs of a mapping. */
1708 if (special || char2cells(c) > 1 || (from && c == ' '))
1709 return get_special_key_name(c, modifiers);
1710 buf[0] = c;
1711 buf[1] = NUL;
1712 return buf;
1713}
1714
1715/*
1716 * Translate a key sequence into special key names.
1717 */
1718 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001719str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720{
1721 char_u *s;
1722
1723 *buf = NUL;
1724 while (*sp)
1725 {
1726 s = str2special(&sp, FALSE);
1727 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1728 STRCAT(buf, s);
1729 }
1730}
1731
1732/*
1733 * print line for :print or :list command
1734 */
1735 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001736msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737{
1738 int c;
1739 int col = 0;
1740 int n_extra = 0;
1741 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001742 int c_final = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 char_u *p_extra = NULL; /* init to make SASC shut up */
1744 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001745 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 int l;
1748 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749
Bram Moolenaardf177f62005-02-22 08:39:57 +00001750 if (curwin->w_p_list)
1751 list = TRUE;
1752
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001754 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 {
1756 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001757 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 --trail;
1759 }
1760
1761 /* output a space for an empty line, otherwise the line will be
1762 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001763 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 msg_putchar(' ');
1765
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001766 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001768 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 {
1770 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001771 if (n_extra == 0 && c_final)
1772 c = c_final;
1773 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 c = c_extra;
1775 else
1776 c = *p_extra++;
1777 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001778 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 {
1780 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001781 if (lcs_nbsp != NUL && list
1782 && (mb_ptr2char(s) == 160
1783 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001784 {
1785 mb_char2bytes(lcs_nbsp, buf);
1786 buf[(*mb_ptr2len)(buf)] = NUL;
1787 }
1788 else
1789 {
1790 mch_memmove(buf, s, (size_t)l);
1791 buf[l] = NUL;
1792 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001793 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 s += l;
1795 continue;
1796 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 else
1798 {
1799 attr = 0;
1800 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001801 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
1803 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001804#ifdef FEAT_VARTABS
1805 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1806 curbuf->b_p_vts_array) - 1;
1807#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001809#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001810 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 {
1812 c = ' ';
1813 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001814 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 }
1816 else
1817 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001818 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001820 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001821 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 }
1823 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001824 else if (c == 160 && list && lcs_nbsp != NUL)
1825 {
1826 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001827 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001828 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001829 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 {
1831 p_extra = (char_u *)"";
1832 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001833 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 n_extra = 1;
1835 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001836 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 --s;
1838 }
1839 else if (c != NUL && (n = byte2cells(c)) > 1)
1840 {
1841 n_extra = n - 1;
1842 p_extra = transchar_byte(c);
1843 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001844 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001846 /* Use special coloring to be able to distinguish <hex> from
1847 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001848 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 }
1850 else if (c == ' ' && trail != NULL && s > trail)
1851 {
1852 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001853 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001855 else if (c == ' ' && list && lcs_space != NUL)
1856 {
1857 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001858 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001859 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 }
1861
1862 if (c == NUL)
1863 break;
1864
1865 msg_putchar_attr(c, attr);
1866 col++;
1867 }
1868 msg_clr_eos();
1869}
1870
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871/*
1872 * Use screen_puts() to output one multi-byte character.
1873 * Return the pointer "s" advanced to the next character.
1874 */
1875 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001876screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877{
1878 int cw;
1879
1880 msg_didout = TRUE; /* remember that line is not empty */
1881 cw = (*mb_ptr2cells)(s);
1882 if (cw > 1 && (
1883#ifdef FEAT_RIGHTLEFT
1884 cmdmsg_rl ? msg_col <= 1 :
1885#endif
1886 msg_col == Columns - 1))
1887 {
1888 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001889 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 return s;
1891 }
1892
1893 screen_puts_len(s, l, msg_row, msg_col, attr);
1894#ifdef FEAT_RIGHTLEFT
1895 if (cmdmsg_rl)
1896 {
1897 msg_col -= cw;
1898 if (msg_col == 0)
1899 {
1900 msg_col = Columns;
1901 ++msg_row;
1902 }
1903 }
1904 else
1905#endif
1906 {
1907 msg_col += cw;
1908 if (msg_col >= Columns)
1909 {
1910 msg_col = 0;
1911 ++msg_row;
1912 }
1913 }
1914 return s + l;
1915}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
1917/*
1918 * Output a string to the screen at position msg_row, msg_col.
1919 * Update msg_row and msg_col for the next message.
1920 */
1921 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001922msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001924 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925}
1926
1927 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001928msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001930 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931}
1932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933/*
1934 * Show a message in such a way that it always fits in the line. Cut out a
1935 * part in the middle and replace it with "..." when necessary.
1936 * Does not handle multi-byte characters!
1937 */
1938 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001939msg_outtrans_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001941 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942}
1943
1944 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001945msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946{
1947 int slen = len;
1948 int room;
1949
1950 room = Columns - msg_col;
1951 if (len > room && room >= 20)
1952 {
1953 slen = (room - 3) / 2;
1954 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001955 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 }
1957 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1958}
1959
1960/*
1961 * Basic function for writing a message with highlight attributes.
1962 */
1963 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001964msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965{
1966 msg_puts_attr_len(s, -1, attr);
1967}
1968
1969/*
1970 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1971 * When "maxlen" is -1 there is no maximum length.
1972 * When "maxlen" is >= 0 the message is not put in the history.
1973 */
1974 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001975msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 /*
1978 * If redirection is on, also write to the redirection file.
1979 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001980 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981
1982 /*
1983 * Don't print anything when using ":silent cmd".
1984 */
1985 if (msg_silent != 0)
1986 return;
1987
1988 /* if MSG_HIST flag set, add message to history */
1989 if ((attr & MSG_HIST) && maxlen < 0)
1990 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001991 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 attr &= ~MSG_HIST;
1993 }
1994
1995 /*
1996 * When writing something to the screen after it has scrolled, requires a
1997 * wait-return prompt later. Needed when scrolling, resetting
1998 * need_wait_return after some prompt, and then outputting something
1999 * without scrolling
2000 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002001 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 need_wait_return = TRUE;
2003 msg_didany = TRUE; /* remember that something was outputted */
2004
2005 /*
2006 * If there is no valid screen, use fprintf so we can see error messages.
2007 * If termcap is not active, we may be writing in an alternate console
2008 * window, cursor positioning may not work correctly (window size may be
2009 * different, e.g. for Win32 console) or we just don't know where the
2010 * cursor is.
2011 */
2012 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002013 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002014 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002015 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002016}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002018/*
2019 * The display part of msg_puts_attr_len().
2020 * May be called recursively to display scroll-back text.
2021 */
2022 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002023msg_puts_display(
2024 char_u *str,
2025 int maxlen,
2026 int attr,
2027 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002028{
2029 char_u *s = str;
2030 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2031 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002032 int l;
2033 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002034 char_u *sb_str = str;
2035 int sb_col = msg_col;
2036 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002037 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038
2039 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002040 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 {
2042 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002043 * We are at the end of the screen line when:
2044 * - When outputting a newline.
2045 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002047 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048#ifdef FEAT_RIGHTLEFT
2049 cmdmsg_rl
2050 ? (
2051 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002052 || (*s == TAB && msg_col <= 7)
2053 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 :
2055#endif
2056 (msg_col + t_col >= Columns - 1
2057 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002059 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002061 /*
2062 * The screen is scrolled up when at the last row (some terminals
2063 * scroll automatically, some don't. To avoid problems we scroll
2064 * ourselves).
2065 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002068 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002070 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 if (msg_no_more && lines_left == 0)
2072 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002074 /* Scroll the screen up one line. */
2075 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076
2077 msg_row = Rows - 2;
2078 if (msg_col >= Columns) /* can happen after screen resize */
2079 msg_col = Columns - 1;
2080
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 /* Display char in last column before showing more-prompt. */
2082 if (*s >= ' '
2083#ifdef FEAT_RIGHTLEFT
2084 && !cmdmsg_rl
2085#endif
2086 )
2087 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 if (has_mbyte)
2089 {
2090 if (enc_utf8 && maxlen >= 0)
2091 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002092 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002093 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002094 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002095 s = screen_puts_mbyte(s, l, attr);
2096 }
2097 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002098 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002099 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002100 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002101 else
2102 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002103
2104 if (p_more)
2105 /* store text for scrolling back */
2106 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2107
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002108 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002109 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 redraw_cmdline = TRUE;
2111 if (cmdline_row > 0 && !exmode_active)
2112 --cmdline_row;
2113
2114 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002115 * If screen is completely filled and 'more' is set then wait
2116 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002118 if (lines_left > 0)
2119 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002120 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 && !msg_no_more && !exmode_active)
2122 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002124 if (do_more_prompt(NUL))
2125 s = confirm_msg_tail;
2126#else
2127 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128#endif
2129 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002130 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002132
2133 /* When we displayed a char in last column need to check if there
2134 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002135 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002136 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 }
2138
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002139 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002142 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002143 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2144 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002146 t_puts(&t_col, t_s, s, attr);
2147
2148 if (wrap && p_more && !recurse)
2149 /* store text for scrolling back */
2150 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151
2152 if (*s == '\n') /* go to next line */
2153 {
2154 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002155#ifdef FEAT_RIGHTLEFT
2156 if (cmdmsg_rl)
2157 msg_col = Columns - 1;
2158 else
2159#endif
2160 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 if (++msg_row >= Rows) /* safety check */
2162 msg_row = Rows - 1;
2163 }
2164 else if (*s == '\r') /* go to column 0 */
2165 {
2166 msg_col = 0;
2167 }
2168 else if (*s == '\b') /* go to previous char */
2169 {
2170 if (msg_col)
2171 --msg_col;
2172 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002173 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 {
2175 do
2176 msg_screen_putchar(' ', attr);
2177 while (msg_col & 7);
2178 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002179 else if (*s == BELL) /* beep (from ":sh") */
2180 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 else
2182 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 if (has_mbyte)
2184 {
2185 cw = (*mb_ptr2cells)(s);
2186 if (enc_utf8 && maxlen >= 0)
2187 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002188 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002190 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 }
2192 else
2193 {
2194 cw = 1;
2195 l = 1;
2196 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002197
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 /* When drawing from right to left or when a double-wide character
2199 * doesn't fit, draw a single character here. Otherwise collect
2200 * characters and draw them all at once later. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 if (
2202# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002203 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002205 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 if (l > 1)
2208 s = screen_puts_mbyte(s, l, attr) - 1;
2209 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 msg_screen_putchar(*s, attr);
2211 }
2212 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 {
2214 /* postpone this character until later */
2215 if (t_col == 0)
2216 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 t_col += cw;
2218 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 }
2220 }
2221 ++s;
2222 }
2223
2224 /* output any postponed text */
2225 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002226 t_puts(&t_col, t_s, s, attr);
2227 if (p_more && !recurse)
2228 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229
2230 msg_check();
2231}
2232
2233/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002234 * Return TRUE when ":filter pattern" was used and "msg" does not match
2235 * "pattern".
2236 */
2237 int
2238message_filtered(char_u *msg)
2239{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002240 int match;
2241
2242 if (cmdmod.filter_regmatch.regprog == NULL)
2243 return FALSE;
2244 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2245 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002246}
2247
2248/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002249 * Scroll the screen up one line for displaying the next message line.
2250 */
2251 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002252msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002253{
2254#ifdef FEAT_GUI
2255 /* Remove the cursor before scrolling, ScreenLines[] is going
2256 * to become invalid. */
2257 if (gui.in_use)
2258 gui_undraw_cursor();
2259#endif
2260 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002261 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002262 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002263 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002264
2265 if (!can_clear((char_u *)" "))
2266 {
2267 /* Scrolling up doesn't result in the right background. Set the
2268 * background here. It's not efficient, but avoids that we have to do
2269 * it all over the code. */
2270 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2271
2272 /* Also clear the last char of the last but one line if it was not
2273 * cleared before to avoid a scroll-up. */
2274 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2275 screen_fill((int)Rows - 2, (int)Rows - 1,
2276 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2277 }
2278}
2279
2280/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002281 * Increment "msg_scrolled".
2282 */
2283 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002284inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002285{
2286#ifdef FEAT_EVAL
2287 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2288 {
2289 char_u *p = sourcing_name;
2290 char_u *tofree = NULL;
2291 int len;
2292
2293 /* v:scrollstart is empty, set it to the script/function name and line
2294 * number */
2295 if (p == NULL)
2296 p = (char_u *)_("Unknown");
2297 else
2298 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002299 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002300 tofree = alloc(len);
2301 if (tofree != NULL)
2302 {
2303 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2304 p, (long)sourcing_lnum);
2305 p = tofree;
2306 }
2307 }
2308 set_vim_var_string(VV_SCROLLSTART, p, -1);
2309 vim_free(tofree);
2310 }
2311#endif
2312 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002313 if (must_redraw < VALID)
2314 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002315}
2316
2317/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002318 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2319 * store the displayed text and remember where screen lines start.
2320 */
2321typedef struct msgchunk_S msgchunk_T;
2322struct msgchunk_S
2323{
2324 msgchunk_T *sb_next;
2325 msgchunk_T *sb_prev;
2326 char sb_eol; /* TRUE when line ends after this text */
2327 int sb_msg_col; /* column in which text starts */
2328 int sb_attr; /* text attributes */
2329 char_u sb_text[1]; /* text to be displayed, actually longer */
2330};
2331
2332static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2333
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002334static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002335
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002336typedef enum {
2337 SB_CLEAR_NONE = 0,
2338 SB_CLEAR_ALL,
2339 SB_CLEAR_CMDLINE_BUSY,
2340 SB_CLEAR_CMDLINE_DONE
2341} sb_clear_T;
2342
2343/* When to clear text on next msg. */
2344static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002345
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002346/*
2347 * Store part of a printed message for displaying when scrolling back.
2348 */
2349 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002350store_sb_text(
2351 char_u **sb_str, /* start of string */
2352 char_u *s, /* just after string */
2353 int attr,
2354 int *sb_col,
2355 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002356{
2357 msgchunk_T *mp;
2358
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002359 if (do_clear_sb_text == SB_CLEAR_ALL
2360 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002361 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002362 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2363 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002364 }
2365
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002366 if (s > *sb_str)
2367 {
2368 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2369 if (mp != NULL)
2370 {
2371 mp->sb_eol = finish;
2372 mp->sb_msg_col = *sb_col;
2373 mp->sb_attr = attr;
2374 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2375
2376 if (last_msgchunk == NULL)
2377 {
2378 last_msgchunk = mp;
2379 mp->sb_prev = NULL;
2380 }
2381 else
2382 {
2383 mp->sb_prev = last_msgchunk;
2384 last_msgchunk->sb_next = mp;
2385 last_msgchunk = mp;
2386 }
2387 mp->sb_next = NULL;
2388 }
2389 }
2390 else if (finish && last_msgchunk != NULL)
2391 last_msgchunk->sb_eol = TRUE;
2392
2393 *sb_str = s;
2394 *sb_col = 0;
2395}
2396
2397/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002398 * Finished showing messages, clear the scroll-back text on the next message.
2399 */
2400 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002401may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002402{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002403 do_clear_sb_text = SB_CLEAR_ALL;
2404}
2405
2406/*
2407 * Starting to edit the command line, do not clear messages now.
2408 */
2409 void
2410sb_text_start_cmdline(void)
2411{
2412 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2413 msg_sb_eol();
2414}
2415
2416/*
2417 * Ending to edit the command line. Clear old lines but the last one later.
2418 */
2419 void
2420sb_text_end_cmdline(void)
2421{
2422 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002423}
2424
2425/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002426 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002427 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002428 * Called when redrawing the screen.
2429 */
2430 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002431clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002432{
2433 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002434 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002435
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002436 if (all)
2437 lastp = &last_msgchunk;
2438 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002439 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002440 if (last_msgchunk == NULL)
2441 return;
2442 lastp = &last_msgchunk->sb_prev;
2443 }
2444
2445 while (*lastp != NULL)
2446 {
2447 mp = (*lastp)->sb_prev;
2448 vim_free(*lastp);
2449 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002450 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002451}
2452
2453/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002454 * "g<" command.
2455 */
2456 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002457show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458{
2459 msgchunk_T *mp;
2460
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002461 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002462 * weird, typing a command without output results in one line. */
2463 mp = msg_sb_start(last_msgchunk);
2464 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002465 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002466 else
2467 {
2468 do_more_prompt('G');
2469 wait_return(FALSE);
2470 }
2471}
2472
2473/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002474 * Move to the start of screen line in already displayed text.
2475 */
2476 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002477msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002478{
2479 msgchunk_T *mp = mps;
2480
2481 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2482 mp = mp->sb_prev;
2483 return mp;
2484}
2485
2486/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002487 * Mark the last message chunk as finishing the line.
2488 */
2489 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002490msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002491{
2492 if (last_msgchunk != NULL)
2493 last_msgchunk->sb_eol = TRUE;
2494}
2495
2496/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002497 * Display a screen line from previously displayed text at row "row".
2498 * Returns a pointer to the text for the next line (can be NULL).
2499 */
2500 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002501disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002502{
2503 msgchunk_T *mp = smp;
2504 char_u *p;
2505
2506 for (;;)
2507 {
2508 msg_row = row;
2509 msg_col = mp->sb_msg_col;
2510 p = mp->sb_text;
2511 if (*p == '\n') /* don't display the line break */
2512 ++p;
2513 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2514 if (mp->sb_eol || mp->sb_next == NULL)
2515 break;
2516 mp = mp->sb_next;
2517 }
2518 return mp->sb_next;
2519}
2520
2521/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 * Output any postponed text for msg_puts_attr_len().
2523 */
2524 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002525t_puts(
2526 int *t_col,
2527 char_u *t_s,
2528 char_u *s,
2529 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530{
2531 /* output postponed text */
2532 msg_didout = TRUE; /* remember that line is not empty */
2533 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002534 msg_col += *t_col;
2535 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 /* If the string starts with a composing character don't increment the
2537 * column position for it. */
2538 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2539 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 if (msg_col >= Columns)
2541 {
2542 msg_col = 0;
2543 ++msg_row;
2544 }
2545}
2546
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547/*
2548 * Returns TRUE when messages should be printed with mch_errmsg().
2549 * This is used when there is no valid screen, so we can see error messages.
2550 * If termcap is not active, we may be writing in an alternate console
2551 * window, cursor positioning may not work correctly (window size may be
2552 * different, e.g. for Win32 console) or we just don't know where the
2553 * cursor is.
2554 */
2555 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002556msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557{
2558 return (!msg_check_screen()
2559#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2560 || !termcap_active
2561#endif
2562 || (swapping_screen() && !termcap_active)
2563 );
2564}
2565
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002566/*
2567 * Print a message when there is no valid screen.
2568 */
2569 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002570msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002571{
2572 char_u *s = str;
2573 char_u buf[4];
2574 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002575#ifdef WIN3264
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002576# if !defined(FEAT_GUI_MSWIN)
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002577 char_u *ccp = NULL;
2578
2579# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002580 if (!(silent_mode && p_verbose == 0))
2581 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002582
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002583# if !defined(FEAT_GUI_MSWIN)
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002584 if (enc_codepage >= 0 && (int)GetConsoleCP() != enc_codepage)
2585 {
Bram Moolenaar116a0f82017-08-07 21:17:57 +02002586 int inlen = (int)STRLEN(str);
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002587 int outlen;
2588 WCHAR *widestr = (WCHAR *)enc_to_utf16(str, &inlen);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002589
2590 if (widestr != NULL)
2591 {
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002592 WideCharToMultiByte_alloc(GetConsoleCP(), 0, widestr, inlen,
2593 (LPSTR *)&ccp, &outlen, 0, 0);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002594 vim_free(widestr);
2595 s = str = ccp;
2596 }
2597 }
2598# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002599#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002600 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002601 {
2602 if (!(silent_mode && p_verbose == 0))
2603 {
2604 /* NL --> CR NL translation (for Unix, not for "--version") */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002605 p = &buf[0];
2606 if (*s == '\n' && !info_message)
2607 *p++ = '\r';
Bram Moolenaard0573012017-10-28 21:11:06 +02002608#if defined(USE_CR)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002609 else
2610#endif
2611 *p++ = *s;
2612 *p = '\0';
2613 if (info_message) /* informative message, not an error */
2614 mch_msg((char *)buf);
2615 else
2616 mch_errmsg((char *)buf);
2617 }
2618
2619 /* primitive way to compute the current column */
2620#ifdef FEAT_RIGHTLEFT
2621 if (cmdmsg_rl)
2622 {
2623 if (*s == '\r' || *s == '\n')
2624 msg_col = Columns - 1;
2625 else
2626 --msg_col;
2627 }
2628 else
2629#endif
2630 {
2631 if (*s == '\r' || *s == '\n')
2632 msg_col = 0;
2633 else
2634 ++msg_col;
2635 }
2636 ++s;
2637 }
2638 msg_didout = TRUE; /* assume that line is not empty */
2639
2640#ifdef WIN3264
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002641# if !defined(FEAT_GUI_MSWIN)
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002642 vim_free(ccp);
2643# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002644 if (!(silent_mode && p_verbose == 0))
2645 mch_settmode(TMODE_RAW);
2646#endif
2647}
2648
2649/*
2650 * Show the more-prompt and handle the user response.
2651 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002652 * When at hit-enter prompt "typed_char" is the already typed character,
2653 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002654 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2655 */
2656 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002657do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002658{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002659 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002660 int used_typed_char = typed_char;
2661 int oldState = State;
2662 int c;
2663#ifdef FEAT_CON_DIALOG
2664 int retval = FALSE;
2665#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002666 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002667 msgchunk_T *mp_last = NULL;
2668 msgchunk_T *mp;
2669 int i;
2670
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002671 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002672 * that case don't show another prompt. Also when at the hit-Enter prompt
2673 * and nothing was typed. */
2674 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002675 return FALSE;
2676 entered = TRUE;
2677
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002678 if (typed_char == 'G')
2679 {
2680 /* "g<": Find first line on the last page. */
2681 mp_last = msg_sb_start(last_msgchunk);
2682 for (i = 0; i < Rows - 2 && mp_last != NULL
2683 && mp_last->sb_prev != NULL; ++i)
2684 mp_last = msg_sb_start(mp_last->sb_prev);
2685 }
2686
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002687 State = ASKMORE;
2688#ifdef FEAT_MOUSE
2689 setmouse();
2690#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002691 if (typed_char == NUL)
2692 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002693 for (;;)
2694 {
2695 /*
2696 * Get a typed character directly from the user.
2697 */
2698 if (used_typed_char != NUL)
2699 {
2700 c = used_typed_char; /* was typed at hit-enter prompt */
2701 used_typed_char = NUL;
2702 }
2703 else
2704 c = get_keystroke();
2705
2706#if defined(FEAT_MENU) && defined(FEAT_GUI)
2707 if (c == K_MENU)
2708 {
2709 int idx = get_menu_index(current_menu, ASKMORE);
2710
2711 /* Used a menu. If it starts with CTRL-Y, it must
2712 * be a "Copy" for the clipboard. Otherwise
2713 * assume that we end */
2714 if (idx == MENU_INDEX_INVALID)
2715 continue;
2716 c = *current_menu->strings[idx];
2717 if (c != NUL && current_menu->strings[idx][1] != NUL)
2718 ins_typebuf(current_menu->strings[idx] + 1,
2719 current_menu->noremap[idx], 0, TRUE,
2720 current_menu->silent[idx]);
2721 }
2722#endif
2723
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002724 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002725 switch (c)
2726 {
2727 case BS: /* scroll one line back */
2728 case K_BS:
2729 case 'k':
2730 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002731 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002732 break;
2733
2734 case CAR: /* one extra line */
2735 case NL:
2736 case 'j':
2737 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002738 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002739 break;
2740
2741 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002742 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002743 break;
2744
2745 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002746 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002747 break;
2748
2749 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002750 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002751 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002752 break;
2753
2754 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002755 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002756 case K_PAGEDOWN:
2757 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002758 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002759 break;
2760
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002761 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002762 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002763 break;
2764
2765 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002766 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002767 lines_left = 999999;
2768 break;
2769
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002770 case ':': /* start new command line */
2771#ifdef FEAT_CON_DIALOG
2772 if (!confirm_msg_used)
2773#endif
2774 {
2775 /* Since got_int is set all typeahead will be flushed, but we
2776 * want to keep this ':', remember that in a special way. */
2777 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002778#ifdef FEAT_TERMINAL
2779 skip_term_loop = TRUE;
2780#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002781 cmdline_row = Rows - 1; /* put ':' on this line */
2782 skip_redraw = TRUE; /* skip redraw once */
2783 need_wait_return = FALSE; /* don't wait in main() */
2784 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002785 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002786 case 'q': /* quit */
2787 case Ctrl_C:
2788 case ESC:
2789#ifdef FEAT_CON_DIALOG
2790 if (confirm_msg_used)
2791 {
2792 /* Jump to the choices of the dialog. */
2793 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002794 }
2795 else
2796#endif
2797 {
2798 got_int = TRUE;
2799 quit_more = TRUE;
2800 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002801 /* When there is some more output (wrapping line) display that
2802 * without another prompt. */
2803 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002804 break;
2805
2806#ifdef FEAT_CLIPBOARD
2807 case Ctrl_Y:
2808 /* Strange way to allow copying (yanking) a modeless
2809 * selection at the more prompt. Use CTRL-Y,
2810 * because the same is used in Cmdline-mode and at the
2811 * hit-enter prompt. However, scrolling one line up
2812 * might be expected... */
2813 if (clip_star.state == SELECT_DONE)
2814 clip_copy_modeless_selection(TRUE);
2815 continue;
2816#endif
2817 default: /* no valid response */
2818 msg_moremsg(TRUE);
2819 continue;
2820 }
2821
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002822 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002823 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002824 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002825 {
2826 /* go to start of last line */
2827 if (mp_last == NULL)
2828 mp = msg_sb_start(last_msgchunk);
2829 else if (mp_last->sb_prev != NULL)
2830 mp = msg_sb_start(mp_last->sb_prev);
2831 else
2832 mp = NULL;
2833
2834 /* go to start of line at top of the screen */
2835 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2836 ++i)
2837 mp = msg_sb_start(mp->sb_prev);
2838
2839 if (mp != NULL && mp->sb_prev != NULL)
2840 {
2841 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002842 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002843 {
2844 if (mp == NULL || mp->sb_prev == NULL)
2845 break;
2846 mp = msg_sb_start(mp->sb_prev);
2847 if (mp_last == NULL)
2848 mp_last = msg_sb_start(last_msgchunk);
2849 else
2850 mp_last = msg_sb_start(mp_last->sb_prev);
2851 }
2852
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002853 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002854 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002855 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002856 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002857 (void)disp_sb_line(0, mp);
2858 }
2859 else
2860 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002861 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002862 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002863 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2864 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002865 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002866 ++msg_scrolled;
2867 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002868 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002869 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002870 }
2871 }
2872 else
2873 {
2874 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002875 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002876 {
2877 /* scroll up, display line at bottom */
2878 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002879 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002880 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2881 (int)Columns, ' ', ' ', 0);
2882 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002883 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002884 }
2885 }
2886
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002887 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002888 {
2889 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002890 screen_fill((int)Rows - 1, (int)Rows, 0,
2891 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002892 msg_moremsg(FALSE);
2893 continue;
2894 }
2895
2896 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002897 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002898 }
2899
2900 break;
2901 }
2902
2903 /* clear the --more-- message */
2904 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2905 State = oldState;
2906#ifdef FEAT_MOUSE
2907 setmouse();
2908#endif
2909 if (quit_more)
2910 {
2911 msg_row = Rows - 1;
2912 msg_col = 0;
2913 }
2914#ifdef FEAT_RIGHTLEFT
2915 else if (cmdmsg_rl)
2916 msg_col = Columns - 1;
2917#endif
2918
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002919 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002920#ifdef FEAT_CON_DIALOG
2921 return retval;
2922#else
2923 return FALSE;
2924#endif
2925}
2926
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2928
2929#ifdef mch_errmsg
2930# undef mch_errmsg
2931#endif
2932#ifdef mch_msg
2933# undef mch_msg
2934#endif
2935
2936/*
2937 * Give an error message. To be used when the screen hasn't been initialized
2938 * yet. When stderr can't be used, collect error messages until the GUI has
2939 * started and they can be displayed in a message box.
2940 */
2941 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002942mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943{
2944 int len;
2945
2946#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2947 /* On Unix use stderr if it's a tty.
2948 * When not going to start the GUI also use stderr.
2949 * On Mac, when started from Finder, stderr is the console. */
2950 if (
2951# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02002952# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2954# else
2955 isatty(2)
2956# endif
2957# ifdef FEAT_GUI
2958 ||
2959# endif
2960# endif
2961# ifdef FEAT_GUI
2962 !(gui.in_use || gui.starting)
2963# endif
2964 )
2965 {
2966 fprintf(stderr, "%s", str);
2967 return;
2968 }
2969#endif
2970
2971 /* avoid a delay for a message that isn't there */
2972 emsg_on_display = FALSE;
2973
2974 len = (int)STRLEN(str) + 1;
2975 if (error_ga.ga_growsize == 0)
2976 {
2977 error_ga.ga_growsize = 80;
2978 error_ga.ga_itemsize = 1;
2979 }
2980 if (ga_grow(&error_ga, len) == OK)
2981 {
2982 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2983 (char_u *)str, len);
2984#ifdef UNIX
2985 /* remove CR characters, they are displayed */
2986 {
2987 char_u *p;
2988
2989 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2990 for (;;)
2991 {
2992 p = vim_strchr(p, '\r');
2993 if (p == NULL)
2994 break;
2995 *p = ' ';
2996 }
2997 }
2998#endif
2999 --len; /* don't count the NUL at the end */
3000 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 }
3002}
3003
3004/*
3005 * Give a message. To be used when the screen hasn't been initialized yet.
3006 * When there is no tty, collect messages until the GUI has started and they
3007 * can be displayed in a message box.
3008 */
3009 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003010mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011{
3012#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3013 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3014 * uses mch_errmsg() when started from the desktop.
3015 * When not going to start the GUI also use stdout.
3016 * On Mac, when started from Finder, stderr is the console. */
3017 if (
3018# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003019# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3021# else
3022 isatty(2)
3023# endif
3024# ifdef FEAT_GUI
3025 ||
3026# endif
3027# endif
3028# ifdef FEAT_GUI
3029 !(gui.in_use || gui.starting)
3030# endif
3031 )
3032 {
3033 printf("%s", str);
3034 return;
3035 }
3036# endif
3037 mch_errmsg(str);
3038}
3039#endif /* USE_MCH_ERRMSG */
3040
3041/*
3042 * Put a character on the screen at the current message position and advance
3043 * to the next position. Only for printable ASCII!
3044 */
3045 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003046msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047{
3048 msg_didout = TRUE; /* remember that line is not empty */
3049 screen_putchar(c, msg_row, msg_col, attr);
3050#ifdef FEAT_RIGHTLEFT
3051 if (cmdmsg_rl)
3052 {
3053 if (--msg_col == 0)
3054 {
3055 msg_col = Columns;
3056 ++msg_row;
3057 }
3058 }
3059 else
3060#endif
3061 {
3062 if (++msg_col >= Columns)
3063 {
3064 msg_col = 0;
3065 ++msg_row;
3066 }
3067 }
3068}
3069
3070 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003071msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003073 int attr;
3074 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075
Bram Moolenaar8820b482017-03-16 17:23:31 +01003076 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003077 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003079 screen_puts((char_u *)
3080 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3081 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082}
3083
3084/*
3085 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3086 * exmode_active.
3087 */
3088 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003089repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090{
3091 if (State == ASKMORE)
3092 {
3093 msg_moremsg(TRUE); /* display --more-- message again */
3094 msg_row = Rows - 1;
3095 }
3096#ifdef FEAT_CON_DIALOG
3097 else if (State == CONFIRM)
3098 {
3099 display_confirm_msg(); /* display ":confirm" message again */
3100 msg_row = Rows - 1;
3101 }
3102#endif
3103 else if (State == EXTERNCMD)
3104 {
3105 windgoto(msg_row, msg_col); /* put cursor back */
3106 }
3107 else if (State == HITRETURN || State == SETWSIZE)
3108 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003109 if (msg_row == Rows - 1)
3110 {
3111 /* Avoid drawing the "hit-enter" prompt below the previous one,
3112 * overwrite it. Esp. useful when regaining focus and a
3113 * FocusGained autocmd exists but didn't draw anything. */
3114 msg_didout = FALSE;
3115 msg_col = 0;
3116 msg_clr_eos();
3117 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 hit_return_msg();
3119 msg_row = Rows - 1;
3120 }
3121}
3122
3123/*
3124 * msg_check_screen - check if the screen is initialized.
3125 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3126 * While starting the GUI the terminal codes will be set for the GUI, but the
3127 * output goes to the terminal. Don't use the terminal codes then.
3128 */
3129 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003130msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131{
3132 if (!full_screen || !screen_valid(FALSE))
3133 return FALSE;
3134
3135 if (msg_row >= Rows)
3136 msg_row = Rows - 1;
3137 if (msg_col >= Columns)
3138 msg_col = Columns - 1;
3139 return TRUE;
3140}
3141
3142/*
3143 * Clear from current message position to end of screen.
3144 * Skip this when ":silent" was used, no need to clear for redirection.
3145 */
3146 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003147msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148{
3149 if (msg_silent == 0)
3150 msg_clr_eos_force();
3151}
3152
3153/*
3154 * Clear from current message position to end of screen.
3155 * Note: msg_col is not updated, so we remember the end of the message
3156 * for msg_check().
3157 */
3158 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003159msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160{
3161 if (msg_use_printf())
3162 {
3163 if (full_screen) /* only when termcap codes are valid */
3164 {
3165 if (*T_CD)
3166 out_str(T_CD); /* clear to end of display */
3167 else if (*T_CE)
3168 out_str(T_CE); /* clear to end of line */
3169 }
3170 }
3171 else
3172 {
3173#ifdef FEAT_RIGHTLEFT
3174 if (cmdmsg_rl)
3175 {
3176 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3177 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3178 }
3179 else
3180#endif
3181 {
3182 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3183 ' ', ' ', 0);
3184 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3185 }
3186 }
3187}
3188
3189/*
3190 * Clear the command line.
3191 */
3192 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003193msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194{
3195 msg_row = cmdline_row;
3196 msg_col = 0;
3197 msg_clr_eos_force();
3198}
3199
3200/*
3201 * end putting a message on the screen
3202 * call wait_return if the message does not fit in the available space
3203 * return TRUE if wait_return not called.
3204 */
3205 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003206msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207{
3208 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003209 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 * or the ruler option is set and we run into it,
3211 * we have to redraw the window.
3212 * Do not do this if we are abandoning the file or editing the command line.
3213 */
3214 if (!exiting && need_wait_return && !(State & CMDLINE))
3215 {
3216 wait_return(FALSE);
3217 return FALSE;
3218 }
3219 out_flush();
3220 return TRUE;
3221}
3222
3223/*
3224 * If the written message runs into the shown command or ruler, we have to
3225 * wait for hit-return and redraw the window later.
3226 */
3227 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003228msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229{
3230 if (msg_row == Rows - 1 && msg_col >= sc_col)
3231 {
3232 need_wait_return = TRUE;
3233 redraw_cmdline = TRUE;
3234 }
3235}
3236
3237/*
3238 * May write a string to the redirection file.
3239 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3240 */
3241 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003242redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243{
3244 char_u *s = str;
3245 static int cur_col = 0;
3246
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003247 /* Don't do anything for displaying prompts and the like. */
3248 if (redir_off)
3249 return;
3250
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003251 /* If 'verbosefile' is set prepare for writing in that file. */
3252 if (*p_vfile != NUL && verbose_fd == NULL)
3253 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003254
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003255 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 {
3257 /* If the string doesn't start with CR or NL, go to msg_col */
3258 if (*s != '\n' && *s != '\r')
3259 {
3260 while (cur_col < msg_col)
3261 {
3262#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003263 if (redir_execute)
3264 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003265 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003267 else if (redir_vname)
3268 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003269 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003271 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003273 if (verbose_fd != NULL)
3274 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 ++cur_col;
3276 }
3277 }
3278
3279#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003280 if (redir_execute)
3281 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003282 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003284 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003285 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286#endif
3287
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003288 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3290 {
3291#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003292 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003294 if (redir_fd != NULL)
3295 putc(*s, redir_fd);
3296 if (verbose_fd != NULL)
3297 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 if (*s == '\r' || *s == '\n')
3299 cur_col = 0;
3300 else if (*s == '\t')
3301 cur_col += (8 - cur_col % 8);
3302 else
3303 ++cur_col;
3304 ++s;
3305 }
3306
3307 if (msg_silent != 0) /* should update msg_col */
3308 msg_col = cur_col;
3309 }
3310}
3311
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003312 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003313redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003314{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003315 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003316#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003317 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003318#endif
3319 ;
3320}
3321
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003323 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003324 * Must always be called paired with verbose_leave()!
3325 */
3326 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003327verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003328{
3329 if (*p_vfile != NUL)
3330 ++msg_silent;
3331}
3332
3333/*
3334 * After giving verbose message.
3335 * Must always be called paired with verbose_enter()!
3336 */
3337 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003338verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003339{
3340 if (*p_vfile != NUL)
3341 if (--msg_silent < 0)
3342 msg_silent = 0;
3343}
3344
3345/*
3346 * Like verbose_enter() and set msg_scroll when displaying the message.
3347 */
3348 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003349verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003350{
3351 if (*p_vfile != NUL)
3352 ++msg_silent;
3353 else
3354 /* always scroll up, don't overwrite */
3355 msg_scroll = TRUE;
3356}
3357
3358/*
3359 * Like verbose_leave() and set cmdline_row when displaying the message.
3360 */
3361 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003362verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003363{
3364 if (*p_vfile != NUL)
3365 {
3366 if (--msg_silent < 0)
3367 msg_silent = 0;
3368 }
3369 else
3370 cmdline_row = msg_row;
3371}
3372
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003373/*
3374 * Called when 'verbosefile' is set: stop writing to the file.
3375 */
3376 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003377verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003378{
3379 if (verbose_fd != NULL)
3380 {
3381 fclose(verbose_fd);
3382 verbose_fd = NULL;
3383 }
3384 verbose_did_open = FALSE;
3385}
3386
3387/*
3388 * Open the file 'verbosefile'.
3389 * Return FAIL or OK.
3390 */
3391 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003392verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003393{
3394 if (verbose_fd == NULL && !verbose_did_open)
3395 {
3396 /* Only give the error message once. */
3397 verbose_did_open = TRUE;
3398
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003399 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003400 if (verbose_fd == NULL)
3401 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003402 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003403 return FAIL;
3404 }
3405 }
3406 return OK;
3407}
3408
3409/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 * Give a warning message (for searching).
3411 * Use 'w' highlighting and may repeat the message after redrawing
3412 */
3413 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003414give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415{
3416 /* Don't do this for ":silent". */
3417 if (msg_silent != 0)
3418 return;
3419
3420 /* Don't want a hit-enter prompt here. */
3421 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003422
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423#ifdef FEAT_EVAL
3424 set_vim_var_string(VV_WARNINGMSG, message, -1);
3425#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003426 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003428 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 else
3430 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003431 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003432 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 msg_didout = FALSE; /* overwrite this message */
3434 msg_nowait = TRUE; /* don't wait for this message */
3435 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003436
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 --no_wait_return;
3438}
3439
Bram Moolenaar113e1072019-01-20 15:30:40 +01003440#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003441 void
3442give_warning2(char_u *message, char_u *a1, int hl)
3443{
3444 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3445 give_warning(IObuff, hl);
3446}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003447#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003448
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449/*
3450 * Advance msg cursor to column "col".
3451 */
3452 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003453msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454{
3455 if (msg_silent != 0) /* nothing to advance to */
3456 {
3457 msg_col = col; /* for redirection, may fill it up later */
3458 return;
3459 }
3460 if (col >= Columns) /* not enough room */
3461 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003462#ifdef FEAT_RIGHTLEFT
3463 if (cmdmsg_rl)
3464 while (msg_col > Columns - col)
3465 msg_putchar(' ');
3466 else
3467#endif
3468 while (msg_col < col)
3469 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470}
3471
3472#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3473/*
3474 * Used for "confirm()" function, and the :confirm command prefix.
3475 * Versions which haven't got flexible dialogs yet, and console
3476 * versions, get this generic handler which uses the command line.
3477 *
3478 * type = one of:
3479 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3480 * title = title string (can be NULL for default)
3481 * (neither used in console dialogs at the moment)
3482 *
3483 * Format of the "buttons" string:
3484 * "Button1Name\nButton2Name\nButton3Name"
3485 * The first button should normally be the default/accept
3486 * The second button should be the 'Cancel' button
3487 * Other buttons- use your imagination!
3488 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3489 * different letter.
3490 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003492do_dialog(
3493 int type UNUSED,
3494 char_u *title UNUSED,
3495 char_u *message,
3496 char_u *buttons,
3497 int dfltbutton,
3498 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003499 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003500 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003501 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502{
3503 int oldState;
3504 int retval = 0;
3505 char_u *hotkeys;
3506 int c;
3507 int i;
3508
3509#ifndef NO_CONSOLE
3510 /* Don't output anything in silent mode ("ex -s") */
3511 if (silent_mode)
3512 return dfltbutton; /* return default option */
3513#endif
3514
3515#ifdef FEAT_GUI_DIALOG
3516 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3517 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3518 {
3519 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003520 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003521 /* avoid a hit-enter prompt without clearing the cmdline */
3522 need_wait_return = FALSE;
3523 emsg_on_display = FALSE;
3524 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
3526 /* Flush output to avoid that further messages and redrawing is done
3527 * in the wrong order. */
3528 out_flush();
3529 gui_mch_update();
3530
3531 return c;
3532 }
3533#endif
3534
3535 oldState = State;
3536 State = CONFIRM;
3537#ifdef FEAT_MOUSE
3538 setmouse();
3539#endif
3540
3541 /*
3542 * Since we wait for a keypress, don't make the
3543 * user press RETURN as well afterwards.
3544 */
3545 ++no_wait_return;
3546 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3547
3548 if (hotkeys != NULL)
3549 {
3550 for (;;)
3551 {
3552 /* Get a typed character directly from the user. */
3553 c = get_keystroke();
3554 switch (c)
3555 {
3556 case CAR: /* User accepts default option */
3557 case NL:
3558 retval = dfltbutton;
3559 break;
3560 case Ctrl_C: /* User aborts/cancels */
3561 case ESC:
3562 retval = 0;
3563 break;
3564 default: /* Could be a hotkey? */
3565 if (c < 0) /* special keys are ignored here */
3566 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003567 if (c == ':' && ex_cmd)
3568 {
3569 retval = dfltbutton;
3570 ins_char_typebuf(':');
3571 break;
3572 }
3573
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 /* Make the character lowercase, as chars in "hotkeys" are. */
3575 c = MB_TOLOWER(c);
3576 retval = 1;
3577 for (i = 0; hotkeys[i]; ++i)
3578 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 if (has_mbyte)
3580 {
3581 if ((*mb_ptr2char)(hotkeys + i) == c)
3582 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003583 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 }
3585 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 if (hotkeys[i] == c)
3587 break;
3588 ++retval;
3589 }
3590 if (hotkeys[i])
3591 break;
3592 /* No hotkey match, so keep waiting */
3593 continue;
3594 }
3595 break;
3596 }
3597
3598 vim_free(hotkeys);
3599 }
3600
3601 State = oldState;
3602#ifdef FEAT_MOUSE
3603 setmouse();
3604#endif
3605 --no_wait_return;
3606 msg_end_prompt();
3607
3608 return retval;
3609}
3610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611/*
3612 * Copy one character from "*from" to "*to", taking care of multi-byte
3613 * characters. Return the length of the character in bytes.
3614 */
3615 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003616copy_char(
3617 char_u *from,
3618 char_u *to,
3619 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 int len;
3622 int c;
3623
3624 if (has_mbyte)
3625 {
3626 if (lowercase)
3627 {
3628 c = MB_TOLOWER((*mb_ptr2char)(from));
3629 return (*mb_char2bytes)(c, to);
3630 }
3631 else
3632 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003633 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 mch_memmove(to, from, (size_t)len);
3635 return len;
3636 }
3637 }
3638 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 {
3640 if (lowercase)
3641 *to = (char_u)TOLOWER_LOC(*from);
3642 else
3643 *to = *from;
3644 return 1;
3645 }
3646}
3647
3648/*
3649 * Format the dialog string, and display it at the bottom of
3650 * the screen. Return a string of hotkey chars (if defined) for
3651 * each 'button'. If a button has no hotkey defined, the first character of
3652 * the button is used.
3653 * The hotkeys can be multi-byte characters, but without combining chars.
3654 *
3655 * Returns an allocated string with hotkeys, or NULL for error.
3656 */
3657 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003658msg_show_console_dialog(
3659 char_u *message,
3660 char_u *buttons,
3661 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662{
3663 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003664#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 int lenhotkey = HOTK_LEN; /* count first button */
3666 char_u *hotk = NULL;
3667 char_u *msgp = NULL;
3668 char_u *hotkp = NULL;
3669 char_u *r;
3670 int copy;
3671#define HAS_HOTKEY_LEN 30
3672 char_u has_hotkey[HAS_HOTKEY_LEN];
3673 int first_hotkey = FALSE; /* first char of button is hotkey */
3674 int idx;
3675
3676 has_hotkey[0] = FALSE;
3677
3678 /*
3679 * First loop: compute the size of memory to allocate.
3680 * Second loop: copy to the allocated memory.
3681 */
3682 for (copy = 0; copy <= 1; ++copy)
3683 {
3684 r = buttons;
3685 idx = 0;
3686 while (*r)
3687 {
3688 if (*r == DLG_BUTTON_SEP)
3689 {
3690 if (copy)
3691 {
3692 *msgp++ = ',';
3693 *msgp++ = ' '; /* '\n' -> ', ' */
3694
3695 /* advance to next hotkey and set default hotkey */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003697 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003700 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 if (dfltbutton)
3702 --dfltbutton;
3703
3704 /* If no hotkey is specified first char is used. */
3705 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3706 first_hotkey = TRUE;
3707 }
3708 else
3709 {
3710 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3711 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3712 if (idx < HAS_HOTKEY_LEN - 1)
3713 has_hotkey[++idx] = FALSE;
3714 }
3715 }
3716 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3717 {
3718 if (*r == DLG_HOTKEY_CHAR)
3719 ++r;
3720 first_hotkey = FALSE;
3721 if (copy)
3722 {
3723 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3724 *msgp++ = *r;
3725 else
3726 {
3727 /* '&a' -> '[a]' */
3728 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3729 msgp += copy_char(r, msgp, FALSE);
3730 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3731
3732 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003733 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 }
3735 }
3736 else
3737 {
3738 ++len; /* '&a' -> '[a]' */
3739 if (idx < HAS_HOTKEY_LEN - 1)
3740 has_hotkey[idx] = TRUE;
3741 }
3742 }
3743 else
3744 {
3745 /* everything else copy literally */
3746 if (copy)
3747 msgp += copy_char(r, msgp, FALSE);
3748 }
3749
3750 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003751 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 }
3753
3754 if (copy)
3755 {
3756 *msgp++ = ':';
3757 *msgp++ = ' ';
3758 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 }
3760 else
3761 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003762 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003763 + 2 /* for the NL's */
3764 + STRLEN(buttons)
3765 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003766 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767
3768 /* If no hotkey is specified first char is used. */
3769 if (!has_hotkey[0])
3770 {
3771 first_hotkey = TRUE;
3772 len += 2; /* "x" -> "[x]" */
3773 }
3774
3775 /*
3776 * Now allocate and load the strings
3777 */
3778 vim_free(confirm_msg);
3779 confirm_msg = alloc(len);
3780 if (confirm_msg == NULL)
3781 return NULL;
3782 *confirm_msg = NUL;
3783 hotk = alloc(lenhotkey);
3784 if (hotk == NULL)
3785 return NULL;
3786
3787 *confirm_msg = '\n';
3788 STRCPY(confirm_msg + 1, message);
3789
3790 msgp = confirm_msg + 1 + STRLEN(message);
3791 hotkp = hotk;
3792
Bram Moolenaar6a516062007-07-05 08:11:42 +00003793 /* Define first default hotkey. Keep the hotkey string NUL
3794 * terminated to avoid reading past the end. */
3795 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796
3797 /* Remember where the choices start, displaying starts here when
3798 * "hotkp" typed at the more prompt. */
3799 confirm_msg_tail = msgp;
3800 *msgp++ = '\n';
3801 }
3802 }
3803
3804 display_confirm_msg();
3805 return hotk;
3806}
3807
3808/*
3809 * Display the ":confirm" message. Also called when screen resized.
3810 */
3811 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003812display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813{
3814 /* avoid that 'q' at the more prompt truncates the message here */
3815 ++confirm_msg_used;
3816 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003817 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 --confirm_msg_used;
3819}
3820
3821#endif /* FEAT_CON_DIALOG */
3822
3823#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3824
3825 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003826vim_dialog_yesno(
3827 int type,
3828 char_u *title,
3829 char_u *message,
3830 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831{
3832 if (do_dialog(type,
3833 title == NULL ? (char_u *)_("Question") : title,
3834 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003835 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 return VIM_YES;
3837 return VIM_NO;
3838}
3839
3840 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003841vim_dialog_yesnocancel(
3842 int type,
3843 char_u *title,
3844 char_u *message,
3845 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846{
3847 switch (do_dialog(type,
3848 title == NULL ? (char_u *)_("Question") : title,
3849 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003850 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 {
3852 case 1: return VIM_YES;
3853 case 2: return VIM_NO;
3854 }
3855 return VIM_CANCEL;
3856}
3857
3858 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003859vim_dialog_yesnoallcancel(
3860 int type,
3861 char_u *title,
3862 char_u *message,
3863 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864{
3865 switch (do_dialog(type,
3866 title == NULL ? (char_u *)"Question" : title,
3867 message,
3868 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003869 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 {
3871 case 1: return VIM_YES;
3872 case 2: return VIM_NO;
3873 case 3: return VIM_ALL;
3874 case 4: return VIM_DISCARDALL;
3875 }
3876 return VIM_CANCEL;
3877}
3878
3879#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3880
3881#if defined(FEAT_BROWSE) || defined(PROTO)
3882/*
3883 * Generic browse function. Calls gui_mch_browse() when possible.
3884 * Later this may pop-up a non-GUI file selector (external command?).
3885 */
3886 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003887do_browse(
3888 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3889 char_u *title, /* title for the window */
3890 char_u *dflt, /* default file name (may include directory) */
3891 char_u *ext, /* extension added */
3892 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003894 char_u *filter, /* file name filter */
3895 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896{
3897 char_u *fname;
3898 static char_u *last_dir = NULL; /* last used directory */
3899 char_u *tofree = NULL;
3900 int save_browse = cmdmod.browse;
3901
3902 /* Must turn off browse to avoid that autocommands will get the
3903 * flag too! */
3904 cmdmod.browse = FALSE;
3905
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003906 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003908 if (flags & BROWSE_DIR)
3909 title = (char_u *)_("Select Directory dialog");
3910 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 title = (char_u *)_("Save File dialog");
3912 else
3913 title = (char_u *)_("Open File dialog");
3914 }
3915
3916 /* When no directory specified, use default file name, default dir, buffer
3917 * dir, last dir or current dir */
3918 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3919 {
3920 if (mch_isdir(dflt)) /* default file name is a directory */
3921 {
3922 initdir = dflt;
3923 dflt = NULL;
3924 }
3925 else if (gettail(dflt) != dflt) /* default file name includes a path */
3926 {
3927 tofree = vim_strsave(dflt);
3928 if (tofree != NULL)
3929 {
3930 initdir = tofree;
3931 *gettail(initdir) = NUL;
3932 dflt = gettail(dflt);
3933 }
3934 }
3935 }
3936
3937 if (initdir == NULL || *initdir == NUL)
3938 {
3939 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003940 if (STRCMP(p_bsdir, "last") != 0
3941 && STRCMP(p_bsdir, "buffer") != 0
3942 && STRCMP(p_bsdir, "current") != 0
3943 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 initdir = p_bsdir;
3945 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003946 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 && buf != NULL && buf->b_ffname != NULL)
3948 {
3949 if (dflt == NULL || *dflt == NUL)
3950 dflt = gettail(curbuf->b_ffname);
3951 tofree = vim_strsave(curbuf->b_ffname);
3952 if (tofree != NULL)
3953 {
3954 initdir = tofree;
3955 *gettail(initdir) = NUL;
3956 }
3957 }
3958 /* When 'browsedir' is "last", use dir from last browse */
3959 else if (*p_bsdir == 'l')
3960 initdir = last_dir;
3961 /* When 'browsedir is "current", use current directory. This is the
3962 * default already, leave initdir empty. */
3963 }
3964
3965# ifdef FEAT_GUI
3966 if (gui.in_use) /* when this changes, also adjust f_has()! */
3967 {
3968 if (filter == NULL
3969# ifdef FEAT_EVAL
3970 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3971 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3972# endif
3973 )
3974 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003975 if (flags & BROWSE_DIR)
3976 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003977# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003978 /* For systems that have a directory dialog. */
3979 fname = gui_mch_browsedir(title, initdir);
3980# else
3981 /* Generic solution for selecting a directory: select a file and
3982 * remove the file name. */
3983 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3984# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003985# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003986 /* Win32 adds a dummy file name, others return an arbitrary file
3987 * name. GTK+ 2 returns only the directory, */
3988 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3989 {
3990 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003991 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003992
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003993 if (tail == fname)
3994 *tail++ = '.'; /* use current dir */
3995 *tail = NUL;
3996 }
3997# endif
3998 }
3999 else
4000 fname = gui_mch_browse(flags & BROWSE_SAVE,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004001 title, dflt, ext, initdir, (char_u *)_(filter));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002
4003 /* We hang around in the dialog for a while, the user might do some
4004 * things to our files. The Win32 dialog allows deleting or renaming
4005 * a file, check timestamps. */
4006 need_check_timestamps = TRUE;
4007 did_check_timestamps = FALSE;
4008 }
4009 else
4010# endif
4011 {
4012 /* TODO: non-GUI file selector here */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004013 emsg(_("E338: Sorry, no file browser in console mode"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 fname = NULL;
4015 }
4016
4017 /* keep the directory for next time */
4018 if (fname != NULL)
4019 {
4020 vim_free(last_dir);
4021 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004022 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 {
4024 *gettail(last_dir) = NUL;
4025 if (*last_dir == NUL)
4026 {
4027 /* filename only returned, must be in current dir */
4028 vim_free(last_dir);
4029 last_dir = alloc(MAXPATHL);
4030 if (last_dir != NULL)
4031 mch_dirname(last_dir, MAXPATHL);
4032 }
4033 }
4034 }
4035
4036 vim_free(tofree);
4037 cmdmod.browse = save_browse;
4038
4039 return fname;
4040}
4041#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004042
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004043#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004044static char *e_printf = N_("E766: Insufficient arguments for printf()");
4045
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004046/*
4047 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4048 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004049 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004050tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004051{
4052 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004053 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004054 int err = FALSE;
4055
4056 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004057 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004058 else
4059 {
4060 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004061 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004062 if (err)
4063 n = 0;
4064 }
4065 return n;
4066}
4067
4068/*
4069 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004070 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004071 * are not converted to a string.
4072 * If "tofree" is not NULL echo_string() is used. All types are converted to
4073 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004074 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004075 */
4076 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004077tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004078{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004079 int idx = *idxp - 1;
4080 char *s = NULL;
4081 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004082
4083 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004084 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004085 else
4086 {
4087 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004088 if (tofree != NULL)
4089 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4090 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004091 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004092 }
4093 return s;
4094}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004095
4096# ifdef FEAT_FLOAT
4097/*
4098 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4099 */
4100 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004101tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004102{
4103 int idx = *idxp - 1;
4104 double f = 0;
4105
4106 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004107 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004108 else
4109 {
4110 ++*idxp;
4111 if (tvs[idx].v_type == VAR_FLOAT)
4112 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004113 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004114 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004115 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004116 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004117 }
4118 return f;
4119}
4120# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004121#endif
4122
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004123#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004124/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004125 * Return the representation of infinity for printf() function:
4126 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4127 */
4128 static const char *
4129infinity_str(int positive,
4130 char fmt_spec,
4131 int force_sign,
4132 int space_for_positive)
4133{
4134 static const char *table[] =
4135 {
4136 "-inf", "inf", "+inf", " inf",
4137 "-INF", "INF", "+INF", " INF"
4138 };
4139 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4140
4141 if (ASCII_ISUPPER(fmt_spec))
4142 idx += 4;
4143 return table[idx];
4144}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004145#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004146
4147/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004148 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004149 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004150 * consistency.
4151 *
4152 * This code is based on snprintf.c - a portable implementation of snprintf
4153 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004154 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004155 * The original code, including useful comments, can be found here:
4156 * http://www.ijs.si/software/snprintf/
4157 *
4158 * This snprintf() only supports the following conversion specifiers:
4159 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4160 * with flags: '-', '+', ' ', '0' and '#'.
4161 * An asterisk is supported for field width as well as precision.
4162 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004163 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004164 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004165 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4166 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004167 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004168 * The locale is not used, the string is used as a byte string. This is only
4169 * relevant for double-byte encodings where the second byte may be '%'.
4170 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004171 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4172 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004173 *
4174 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004175 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004176 * is greater or equal to "str_m", not all characters from the result
4177 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4178 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004179 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004180 */
4181
4182/*
4183 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004184 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004185 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004186 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004187 */
4188
4189/* When generating prototypes all of this is skipped, cproto doesn't
4190 * understand this. */
4191#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004192
Bram Moolenaara800b422010-06-27 01:15:55 +02004193/* Like vim_vsnprintf() but append to the string. */
4194 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004195vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004196{
4197 va_list ap;
4198 int str_l;
4199 size_t len = STRLEN(str);
4200 size_t space;
4201
4202 if (str_m <= len)
4203 space = 0;
4204 else
4205 space = str_m - len;
4206 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004207 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004208 va_end(ap);
4209 return str_l;
4210}
Bram Moolenaara800b422010-06-27 01:15:55 +02004211
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004212 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004213vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004214{
4215 va_list ap;
4216 int str_l;
4217
4218 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004219 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004220 va_end(ap);
4221 return str_l;
4222}
4223
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004224 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004225vim_vsnprintf(
4226 char *str,
4227 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004228 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004229 va_list ap)
4230{
4231 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4232}
4233
4234 int
4235vim_vsnprintf_typval(
4236 char *str,
4237 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004238 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004239 va_list ap,
4240 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004241{
4242 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004243 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004244 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004245
4246 if (p == NULL)
4247 p = "";
4248 while (*p != NUL)
4249 {
4250 if (*p != '%')
4251 {
4252 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004253 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004254
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004255 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004256 if (str_l < str_m)
4257 {
4258 size_t avail = str_m - str_l;
4259
4260 mch_memmove(str + str_l, p, n > avail ? avail : n);
4261 }
4262 p += n;
4263 str_l += n;
4264 }
4265 else
4266 {
4267 size_t min_field_width = 0, precision = 0;
4268 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4269 int alternate_form = 0, force_sign = 0;
4270
4271 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4272 * ignored. */
4273 int space_for_positive = 1;
4274
4275 /* allowed values: \0, h, l, L */
4276 char length_modifier = '\0';
4277
4278 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004279# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004280# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004281 * That sounds reasonable to use as the maximum
4282 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004283# elif defined(FEAT_NUM64)
4284# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004285# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004286# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004287# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004288 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004289
4290 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004291 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004292
4293 /* natural field width of arg without padding and sign */
4294 size_t str_arg_l;
4295
4296 /* unsigned char argument value - only defined for c conversion.
4297 * N.B. standard explicitly states the char argument for the c
4298 * conversion is unsigned */
4299 unsigned char uchar_arg;
4300
4301 /* number of zeros to be inserted for numeric conversions as
4302 * required by the precision or minimal field width */
4303 size_t number_of_zeros_to_pad = 0;
4304
4305 /* index into tmp where zero padding is to be inserted */
4306 size_t zero_padding_insertion_ind = 0;
4307
4308 /* current conversion specifier character */
4309 char fmt_spec = '\0';
4310
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004311 /* buffer for 's' and 'S' specs */
4312 char_u *tofree = NULL;
4313
4314
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004315 p++; /* skip '%' */
4316
4317 /* parse flags */
4318 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4319 || *p == '#' || *p == '\'')
4320 {
4321 switch (*p)
4322 {
4323 case '0': zero_padding = 1; break;
4324 case '-': justify_left = 1; break;
4325 case '+': force_sign = 1; space_for_positive = 0; break;
4326 case ' ': force_sign = 1;
4327 /* If both the ' ' and '+' flags appear, the ' '
4328 * flag should be ignored */
4329 break;
4330 case '#': alternate_form = 1; break;
4331 case '\'': break;
4332 }
4333 p++;
4334 }
4335 /* If the '0' and '-' flags both appear, the '0' flag should be
4336 * ignored. */
4337
4338 /* parse field width */
4339 if (*p == '*')
4340 {
4341 int j;
4342
4343 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004344 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004345# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004346 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004347# endif
4348 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004349 if (j >= 0)
4350 min_field_width = j;
4351 else
4352 {
4353 min_field_width = -j;
4354 justify_left = 1;
4355 }
4356 }
4357 else if (VIM_ISDIGIT((int)(*p)))
4358 {
4359 /* size_t could be wider than unsigned int; make sure we treat
4360 * argument like common implementations do */
4361 unsigned int uj = *p++ - '0';
4362
4363 while (VIM_ISDIGIT((int)(*p)))
4364 uj = 10 * uj + (unsigned int)(*p++ - '0');
4365 min_field_width = uj;
4366 }
4367
4368 /* parse precision */
4369 if (*p == '.')
4370 {
4371 p++;
4372 precision_specified = 1;
4373 if (*p == '*')
4374 {
4375 int j;
4376
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004377 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004378# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004379 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004380# endif
4381 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004382 p++;
4383 if (j >= 0)
4384 precision = j;
4385 else
4386 {
4387 precision_specified = 0;
4388 precision = 0;
4389 }
4390 }
4391 else if (VIM_ISDIGIT((int)(*p)))
4392 {
4393 /* size_t could be wider than unsigned int; make sure we
4394 * treat argument like common implementations do */
4395 unsigned int uj = *p++ - '0';
4396
4397 while (VIM_ISDIGIT((int)(*p)))
4398 uj = 10 * uj + (unsigned int)(*p++ - '0');
4399 precision = uj;
4400 }
4401 }
4402
4403 /* parse 'h', 'l' and 'll' length modifiers */
4404 if (*p == 'h' || *p == 'l')
4405 {
4406 length_modifier = *p;
4407 p++;
4408 if (length_modifier == 'l' && *p == 'l')
4409 {
4410 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004411# ifdef FEAT_NUM64
4412 length_modifier = 'L';
4413# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004414 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004415# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004416 p++;
4417 }
4418 }
4419 fmt_spec = *p;
4420
4421 /* common synonyms: */
4422 switch (fmt_spec)
4423 {
4424 case 'i': fmt_spec = 'd'; break;
4425 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4426 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4427 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4428 default: break;
4429 }
4430
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004431# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4432 switch (fmt_spec)
4433 {
4434 case 'd': case 'u': case 'o': case 'x': case 'X':
4435 if (tvs != NULL && length_modifier == '\0')
4436 length_modifier = 'L';
4437 }
4438# endif
4439
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004440 /* get parameter value, do initial processing */
4441 switch (fmt_spec)
4442 {
4443 /* '%' and 'c' behave similar to 's' regarding flags and field
4444 * widths */
4445 case '%':
4446 case 'c':
4447 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004448 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004449 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004450 str_arg_l = 1;
4451 switch (fmt_spec)
4452 {
4453 case '%':
4454 str_arg = p;
4455 break;
4456
4457 case 'c':
4458 {
4459 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004460
4461 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004462# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004463 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004464# endif
4465 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004466 /* standard demands unsigned char */
4467 uchar_arg = (unsigned char)j;
4468 str_arg = (char *)&uchar_arg;
4469 break;
4470 }
4471
4472 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004473 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004474 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004475# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004476 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004477# endif
4478 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004479 if (str_arg == NULL)
4480 {
4481 str_arg = "[NULL]";
4482 str_arg_l = 6;
4483 }
4484 /* make sure not to address string beyond the specified
4485 * precision !!! */
4486 else if (!precision_specified)
4487 str_arg_l = strlen(str_arg);
4488 /* truncate string if necessary as requested by precision */
4489 else if (precision == 0)
4490 str_arg_l = 0;
4491 else
4492 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004493 /* Don't put the #if inside memchr(), it can be a
4494 * macro. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004495 /* memchr on HP does not like n > 2^31 !!! */
4496 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004497 precision <= (size_t)0x7fffffffL ? precision
4498 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004499 str_arg_l = (q == NULL) ? precision
4500 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004501 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004502 if (fmt_spec == 'S')
4503 {
4504 if (min_field_width != 0)
4505 min_field_width += STRLEN(str_arg)
4506 - mb_string2cells((char_u *)str_arg, -1);
4507 if (precision)
4508 {
4509 char_u *p1 = (char_u *)str_arg;
4510 size_t i;
4511
4512 for (i = 0; i < precision && *p1; i++)
4513 p1 += mb_ptr2len(p1);
4514
4515 str_arg_l = precision = p1 - (char_u *)str_arg;
4516 }
4517 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004518 break;
4519
4520 default:
4521 break;
4522 }
4523 break;
4524
Bram Moolenaar91984b92016-08-16 21:58:41 +02004525 case 'd': case 'u':
4526 case 'b': case 'B':
4527 case 'o':
4528 case 'x': case 'X':
4529 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004530 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004531 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004532 * imply the value is unsigned; d implies a signed
4533 * value */
4534
4535 /* 0 if numeric argument is zero (or if pointer is
4536 * NULL for 'p'), +1 if greater than zero (or nonzero
4537 * for unsigned arguments), -1 if negative (unsigned
4538 * argument is never negative) */
4539 int arg_sign = 0;
4540
4541 /* only defined for length modifier h, or for no
4542 * length modifiers */
4543 int int_arg = 0;
4544 unsigned int uint_arg = 0;
4545
4546 /* only defined for length modifier l */
4547 long int long_arg = 0;
4548 unsigned long int ulong_arg = 0;
4549
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004550# ifdef FEAT_NUM64
4551 /* only defined for length modifier ll */
4552 varnumber_T llong_arg = 0;
4553 uvarnumber_T ullong_arg = 0;
4554# endif
4555
Bram Moolenaare9997822016-08-28 16:03:38 +02004556 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004557 uvarnumber_T bin_arg = 0;
4558
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004559 /* pointer argument value -only defined for p
4560 * conversion */
4561 void *ptr_arg = NULL;
4562
4563 if (fmt_spec == 'p')
4564 {
4565 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004566 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004567# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004568 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4569 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004570# endif
4571 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004572 if (ptr_arg != NULL)
4573 arg_sign = 1;
4574 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004575 else if (fmt_spec == 'b' || fmt_spec == 'B')
4576 {
4577 bin_arg =
4578# if defined(FEAT_EVAL)
4579 tvs != NULL ?
4580 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4581# endif
4582 va_arg(ap, uvarnumber_T);
4583 if (bin_arg != 0)
4584 arg_sign = 1;
4585 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004586 else if (fmt_spec == 'd')
4587 {
4588 /* signed */
4589 switch (length_modifier)
4590 {
4591 case '\0':
4592 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004593 /* char and short arguments are passed as int. */
4594 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004595# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004596 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004597# endif
4598 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004599 if (int_arg > 0)
4600 arg_sign = 1;
4601 else if (int_arg < 0)
4602 arg_sign = -1;
4603 break;
4604 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004605 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004606# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004607 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004608# endif
4609 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004610 if (long_arg > 0)
4611 arg_sign = 1;
4612 else if (long_arg < 0)
4613 arg_sign = -1;
4614 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004615# ifdef FEAT_NUM64
4616 case 'L':
4617 llong_arg =
4618# if defined(FEAT_EVAL)
4619 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4620# endif
4621 va_arg(ap, varnumber_T);
4622 if (llong_arg > 0)
4623 arg_sign = 1;
4624 else if (llong_arg < 0)
4625 arg_sign = -1;
4626 break;
4627# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004628 }
4629 }
4630 else
4631 {
4632 /* unsigned */
4633 switch (length_modifier)
4634 {
4635 case '\0':
4636 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004637 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004638# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004639 tvs != NULL ? (unsigned)
4640 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004641# endif
4642 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004643 if (uint_arg != 0)
4644 arg_sign = 1;
4645 break;
4646 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004647 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004648# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004649 tvs != NULL ? (unsigned long)
4650 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004651# endif
4652 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004653 if (ulong_arg != 0)
4654 arg_sign = 1;
4655 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004656# ifdef FEAT_NUM64
4657 case 'L':
4658 ullong_arg =
4659# if defined(FEAT_EVAL)
4660 tvs != NULL ? (uvarnumber_T)
4661 tv_nr(tvs, &arg_idx) :
4662# endif
4663 va_arg(ap, uvarnumber_T);
4664 if (ullong_arg != 0)
4665 arg_sign = 1;
4666 break;
4667# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004668 }
4669 }
4670
4671 str_arg = tmp;
4672 str_arg_l = 0;
4673
4674 /* NOTE:
4675 * For d, i, u, o, x, and X conversions, if precision is
4676 * specified, the '0' flag should be ignored. This is so
4677 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4678 * FreeBSD, NetBSD; but not with Perl.
4679 */
4680 if (precision_specified)
4681 zero_padding = 0;
4682 if (fmt_spec == 'd')
4683 {
4684 if (force_sign && arg_sign >= 0)
4685 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4686 /* leave negative numbers for sprintf to handle, to
4687 * avoid handling tricky cases like (short int)-32768 */
4688 }
4689 else if (alternate_form)
4690 {
4691 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004692 && (fmt_spec == 'b' || fmt_spec == 'B'
4693 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004694 {
4695 tmp[str_arg_l++] = '0';
4696 tmp[str_arg_l++] = fmt_spec;
4697 }
4698 /* alternate form should have no effect for p
4699 * conversion, but ... */
4700 }
4701
4702 zero_padding_insertion_ind = str_arg_l;
4703 if (!precision_specified)
4704 precision = 1; /* default precision is 1 */
4705 if (precision == 0 && arg_sign == 0)
4706 {
4707 /* When zero value is formatted with an explicit
4708 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004709 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004710 }
4711 else
4712 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004713 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004714 int f_l = 0;
4715
4716 /* construct a simple format string for sprintf */
4717 f[f_l++] = '%';
4718 if (!length_modifier)
4719 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004720 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004721 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004722# ifdef FEAT_NUM64
4723# ifdef WIN3264
4724 f[f_l++] = 'I';
4725 f[f_l++] = '6';
4726 f[f_l++] = '4';
4727# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004728 f[f_l++] = 'l';
4729 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004730# endif
4731# else
4732 f[f_l++] = 'l';
4733# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004734 }
4735 else
4736 f[f_l++] = length_modifier;
4737 f[f_l++] = fmt_spec;
4738 f[f_l++] = '\0';
4739
4740 if (fmt_spec == 'p')
4741 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004742 else if (fmt_spec == 'b' || fmt_spec == 'B')
4743 {
4744 char b[8 * sizeof(uvarnumber_T)];
4745 size_t b_l = 0;
4746 uvarnumber_T bn = bin_arg;
4747
4748 do
4749 {
4750 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4751 bn >>= 1;
4752 }
4753 while (bn != 0);
4754
4755 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4756 str_arg_l += b_l;
4757 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004758 else if (fmt_spec == 'd')
4759 {
4760 /* signed */
4761 switch (length_modifier)
4762 {
4763 case '\0':
4764 case 'h': str_arg_l += sprintf(
4765 tmp + str_arg_l, f, int_arg);
4766 break;
4767 case 'l': str_arg_l += sprintf(
4768 tmp + str_arg_l, f, long_arg);
4769 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004770# ifdef FEAT_NUM64
4771 case 'L': str_arg_l += sprintf(
4772 tmp + str_arg_l, f, llong_arg);
4773 break;
4774# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004775 }
4776 }
4777 else
4778 {
4779 /* unsigned */
4780 switch (length_modifier)
4781 {
4782 case '\0':
4783 case 'h': str_arg_l += sprintf(
4784 tmp + str_arg_l, f, uint_arg);
4785 break;
4786 case 'l': str_arg_l += sprintf(
4787 tmp + str_arg_l, f, ulong_arg);
4788 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004789# ifdef FEAT_NUM64
4790 case 'L': str_arg_l += sprintf(
4791 tmp + str_arg_l, f, ullong_arg);
4792 break;
4793# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004794 }
4795 }
4796
4797 /* include the optional minus sign and possible
4798 * "0x" in the region before the zero padding
4799 * insertion point */
4800 if (zero_padding_insertion_ind < str_arg_l
4801 && tmp[zero_padding_insertion_ind] == '-')
4802 zero_padding_insertion_ind++;
4803 if (zero_padding_insertion_ind + 1 < str_arg_l
4804 && tmp[zero_padding_insertion_ind] == '0'
4805 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4806 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4807 zero_padding_insertion_ind += 2;
4808 }
4809
4810 {
4811 size_t num_of_digits = str_arg_l
4812 - zero_padding_insertion_ind;
4813
4814 if (alternate_form && fmt_spec == 'o'
4815 /* unless zero is already the first
4816 * character */
4817 && !(zero_padding_insertion_ind < str_arg_l
4818 && tmp[zero_padding_insertion_ind] == '0'))
4819 {
4820 /* assure leading zero for alternate-form
4821 * octal numbers */
4822 if (!precision_specified
4823 || precision < num_of_digits + 1)
4824 {
4825 /* precision is increased to force the
4826 * first character to be zero, except if a
4827 * zero value is formatted with an
4828 * explicit precision of zero */
4829 precision = num_of_digits + 1;
4830 precision_specified = 1;
4831 }
4832 }
4833 /* zero padding to specified precision? */
4834 if (num_of_digits < precision)
4835 number_of_zeros_to_pad = precision - num_of_digits;
4836 }
4837 /* zero padding to specified minimal field width? */
4838 if (!justify_left && zero_padding)
4839 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004840 int n = (int)(min_field_width - (str_arg_l
4841 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004842 if (n > 0)
4843 number_of_zeros_to_pad += n;
4844 }
4845 break;
4846 }
4847
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004848# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004849 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004850 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004851 case 'e':
4852 case 'E':
4853 case 'g':
4854 case 'G':
4855 {
4856 /* Floating point. */
4857 double f;
4858 double abs_f;
4859 char format[40];
4860 int l;
4861 int remove_trailing_zeroes = FALSE;
4862
4863 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004864# if defined(FEAT_EVAL)
4865 tvs != NULL ? tv_float(tvs, &arg_idx) :
4866# endif
4867 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004868 abs_f = f < 0 ? -f : f;
4869
4870 if (fmt_spec == 'g' || fmt_spec == 'G')
4871 {
4872 /* Would be nice to use %g directly, but it prints
4873 * "1.0" as "1", we don't want that. */
4874 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4875 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004876 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004877 else
4878 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4879 remove_trailing_zeroes = TRUE;
4880 }
4881
Bram Moolenaar04186092016-08-29 21:55:35 +02004882 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004883# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004884 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004885# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004886 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004887# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004888 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004889 {
4890 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004891 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4892 force_sign, space_for_positive));
4893 str_arg_l = STRLEN(tmp);
4894 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004895 }
4896 else
4897 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004898 if (isnan(f))
4899 {
4900 /* Not a number: nan or NAN */
4901 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4902 : "nan");
4903 str_arg_l = 3;
4904 zero_padding = 0;
4905 }
4906 else if (isinf(f))
4907 {
4908 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4909 force_sign, space_for_positive));
4910 str_arg_l = STRLEN(tmp);
4911 zero_padding = 0;
4912 }
4913 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004914 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004915 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004916 format[0] = '%';
4917 l = 1;
4918 if (force_sign)
4919 format[l++] = space_for_positive ? ' ' : '+';
4920 if (precision_specified)
4921 {
4922 size_t max_prec = TMP_LEN - 10;
4923
4924 /* Make sure we don't get more digits than we
4925 * have room for. */
4926 if ((fmt_spec == 'f' || fmt_spec == 'F')
4927 && abs_f > 1.0)
4928 max_prec -= (size_t)log10(abs_f);
4929 if (precision > max_prec)
4930 precision = max_prec;
4931 l += sprintf(format + l, ".%d", (int)precision);
4932 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004933 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004934 format[l + 1] = NUL;
4935
Bram Moolenaare9997822016-08-28 16:03:38 +02004936 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004937 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004938
Bram Moolenaara7241f52008-06-24 20:39:31 +00004939 if (remove_trailing_zeroes)
4940 {
4941 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004942 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004943
4944 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02004945 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004946 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004947 else
4948 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004949 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004950 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004951 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004952 {
4953 /* Remove superfluous '+' and leading
4954 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004955 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004956 {
4957 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004958 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004959 --str_arg_l;
4960 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004961 i = (tp[1] == '-') ? 2 : 1;
4962 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004963 {
4964 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004965 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004966 --str_arg_l;
4967 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004968 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004969 }
4970 }
4971
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004972 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004973 /* Remove trailing zeroes, but keep the one
4974 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004975 while (tp > tmp + 2 && *tp == '0'
4976 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004977 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004978 STRMOVE(tp, tp + 1);
4979 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004980 --str_arg_l;
4981 }
4982 }
4983 else
4984 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004985 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004986
4987 /* Be consistent: some printf("%e") use 1.0e+12
4988 * and some 1.0e+012. Remove one zero in the last
4989 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004990 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004991 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004992 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4993 && tp[2] == '0'
4994 && vim_isdigit(tp[3])
4995 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004996 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004997 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004998 --str_arg_l;
4999 }
5000 }
5001 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005002 if (zero_padding && min_field_width > str_arg_l
5003 && (tmp[0] == '-' || force_sign))
5004 {
5005 /* padding 0's should be inserted after the sign */
5006 number_of_zeros_to_pad = min_field_width - str_arg_l;
5007 zero_padding_insertion_ind = 1;
5008 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005009 str_arg = tmp;
5010 break;
5011 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005012# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005013
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005014 default:
5015 /* unrecognized conversion specifier, keep format string
5016 * as-is */
5017 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005018 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005019 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005020 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005021
5022 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005023 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005024 str_arg = p;
5025 str_arg_l = 0;
5026 if (*p != NUL)
5027 str_arg_l++; /* include invalid conversion specifier
5028 unchanged if not at end-of-string */
5029 break;
5030 }
5031
5032 if (*p != NUL)
5033 p++; /* step over the just processed conversion specifier */
5034
5035 /* insert padding to the left as requested by min_field_width;
5036 * this does not include the zero padding in case of numerical
5037 * conversions*/
5038 if (!justify_left)
5039 {
5040 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005041 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005042
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005043 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005044 {
5045 if (str_l < str_m)
5046 {
5047 size_t avail = str_m - str_l;
5048
5049 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005050 (size_t)pn > avail ? avail
5051 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005052 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005053 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005054 }
5055 }
5056
5057 /* zero padding as requested by the precision or by the minimal
5058 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005059 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005060 {
5061 /* will not copy first part of numeric right now, *
5062 * force it to be copied later in its entirety */
5063 zero_padding_insertion_ind = 0;
5064 }
5065 else
5066 {
5067 /* insert first part of numerics (sign or '0x') before zero
5068 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005069 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005070
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005071 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005072 {
5073 if (str_l < str_m)
5074 {
5075 size_t avail = str_m - str_l;
5076
5077 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005078 (size_t)zn > avail ? avail
5079 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005080 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005081 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005082 }
5083
5084 /* insert zero padding as requested by the precision or min
5085 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005086 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005087 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005088 {
5089 if (str_l < str_m)
5090 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005091 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005093 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005094 (size_t)zn > avail ? avail
5095 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005096 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005097 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005098 }
5099 }
5100
5101 /* insert formatted string
5102 * (or as-is conversion specifier for unknown conversions) */
5103 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005104 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005105
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005106 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005107 {
5108 if (str_l < str_m)
5109 {
5110 size_t avail = str_m - str_l;
5111
5112 mch_memmove(str + str_l,
5113 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005114 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005115 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005116 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005117 }
5118 }
5119
5120 /* insert right padding */
5121 if (justify_left)
5122 {
5123 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005124 int pn = (int)(min_field_width
5125 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005126
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005127 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005128 {
5129 if (str_l < str_m)
5130 {
5131 size_t avail = str_m - str_l;
5132
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005133 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005134 (size_t)pn > avail ? avail
5135 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005136 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005137 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005138 }
5139 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005140 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005141 }
5142 }
5143
5144 if (str_m > 0)
5145 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005146 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005147 * overwriting the last character (shouldn't happen, but just in case)
5148 * */
5149 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5150 }
5151
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005152 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005153 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005154
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005155 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005156 * character), that is, the number of characters that would have been
5157 * written to the buffer if it were large enough. */
5158 return (int)str_l;
5159}
5160
5161#endif /* PROTO */