blob: fa37df12bb25e27936dafbe31d03ba07dace472a [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 Moolenaar0d8562a2019-02-19 21:34:05 +0100733#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100734/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100735 * Print an error message with format string and variable arguments.
736 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100737 */
738 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100739semsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100740{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100741 /* Skip this if not giving error messages at the moment. */
742 if (!emsg_not_now())
743 {
744 va_list ap;
Bram Moolenaar95f09602016-11-10 20:01:45 +0100745
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100746 va_start(ap, s);
747 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
748 va_end(ap);
749 return emsg_core(IObuff);
750 }
751 return TRUE; /* no error messages at the moment */
Bram Moolenaar95f09602016-11-10 20:01:45 +0100752}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100753#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100754
755/*
756 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
757 * defined. It is used for internal errors only, so that they can be
758 * detected when fuzzing vim.
759 */
760 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100761iemsg(char *s)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100762{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100763 if (!emsg_not_now())
764 emsg_core((char_u *)s);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100765#ifdef ABORT_ON_INTERNAL_ERROR
766 abort();
767#endif
768}
769
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100770#ifndef PROTO // manual proto with __attribute__
Bram Moolenaar95f09602016-11-10 20:01:45 +0100771/*
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100772 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
Bram Moolenaar95f09602016-11-10 20:01:45 +0100773 * defined. It is used for internal errors only, so that they can be
774 * detected when fuzzing vim.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775 * Note: caller must not pass 'IObuff' as 1st argument.
Bram Moolenaar95f09602016-11-10 20:01:45 +0100776 */
777 void
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778siemsg(const char *s, ...)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100779{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100780 if (!emsg_not_now())
781 {
782 va_list ap;
783
784 va_start(ap, s);
785 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap);
786 va_end(ap);
787 emsg_core(IObuff);
788 }
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100789# ifdef ABORT_ON_INTERNAL_ERROR
Bram Moolenaar95f09602016-11-10 20:01:45 +0100790 abort();
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100791# endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100792}
Bram Moolenaar0d8562a2019-02-19 21:34:05 +0100793#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +0100794
795/*
796 * Give an "Internal error" message.
797 */
798 void
799internal_error(char *where)
800{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100801 siemsg(_(e_intern2), where);
Bram Moolenaar95f09602016-11-10 20:01:45 +0100802}
803
Bram Moolenaarea424162005-06-16 21:51:00 +0000804/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaardf177f62005-02-22 08:39:57 +0000806 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100807emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000808{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100809 semsg(_("E354: Invalid register name: '%s'"), transchar(name));
Bram Moolenaardf177f62005-02-22 08:39:57 +0000810}
811
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812/*
813 * Like msg(), but truncate to a single line if p_shm contains 't', or when
814 * "force" is TRUE. This truncates in another way as for normal messages.
815 * Careful: The string may be changed by msg_may_trunc()!
816 * Returns a pointer to the printed message, if wait_return() not called.
817 */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100818 char *
819msg_trunc_attr(char *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820{
821 int n;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100822 char *ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
824 /* Add message to history before truncating */
Bram Moolenaar32526b32019-01-19 17:43:09 +0100825 add_msg_hist((char_u *)s, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
Bram Moolenaar32526b32019-01-19 17:43:09 +0100827 ts = (char *)msg_may_trunc(force, (char_u *)s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828
829 msg_hist_off = TRUE;
Bram Moolenaar32526b32019-01-19 17:43:09 +0100830 n = msg_attr(ts, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 msg_hist_off = FALSE;
832
833 if (n)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100834 return ts;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 return NULL;
836}
837
838/*
839 * Check if message "s" should be truncated at the start (for filenames).
840 * Return a pointer to where the truncated message starts.
841 * Note: May change the message by replacing a character with '<'.
842 */
843 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100844msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845{
846 int n;
847 int room;
848
849 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
850 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
851 && (n = (int)STRLEN(s) - room) > 0)
852 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 if (has_mbyte)
854 {
855 int size = vim_strsize(s);
856
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000857 /* There may be room anyway when there are multibyte chars. */
858 if (size <= room)
859 return s;
860
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 for (n = 0; size >= room; )
862 {
863 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000864 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 }
866 --n;
867 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 s += n;
869 *s = '<';
870 }
871 return s;
872}
873
874 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100875add_msg_hist(
876 char_u *s,
877 int len, /* -1 for undetermined length */
878 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879{
880 struct msg_hist *p;
881
882 if (msg_hist_off || msg_silent != 0)
883 return;
884
885 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000886 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000887 (void)delete_first_msg();
888
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 /* allocate an entry and add the message at the end of the history */
890 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
891 if (p != NULL)
892 {
893 if (len < 0)
894 len = (int)STRLEN(s);
895 /* remove leading and trailing newlines */
896 while (len > 0 && *s == '\n')
897 {
898 ++s;
899 --len;
900 }
901 while (len > 0 && s[len - 1] == '\n')
902 --len;
903 p->msg = vim_strnsave(s, len);
904 p->next = NULL;
905 p->attr = attr;
906 if (last_msg_hist != NULL)
907 last_msg_hist->next = p;
908 last_msg_hist = p;
909 if (first_msg_hist == NULL)
910 first_msg_hist = last_msg_hist;
911 ++msg_hist_len;
912 }
913}
914
915/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000916 * Delete the first (oldest) message from the history.
917 * Returns FAIL if there are no messages.
918 */
919 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100920delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000921{
922 struct msg_hist *p;
923
924 if (msg_hist_len <= 0)
925 return FAIL;
926 p = first_msg_hist;
927 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000928 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200929 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000930 vim_free(p->msg);
931 vim_free(p);
932 --msg_hist_len;
933 return OK;
934}
935
936/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 * ":messages" command.
938 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200940ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941{
942 struct msg_hist *p;
943 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200944 int c = 0;
945
946 if (STRCMP(eap->arg, "clear") == 0)
947 {
948 int keep = eap->addr_count == 0 ? 0 : eap->line2;
949
950 while (msg_hist_len > keep)
951 (void)delete_first_msg();
952 return;
953 }
954
955 if (*eap->arg != NUL)
956 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100957 emsg(_(e_invarg));
Bram Moolenaar451f8492016-04-14 17:16:22 +0200958 return;
959 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 msg_hist_off = TRUE;
962
Bram Moolenaar451f8492016-04-14 17:16:22 +0200963 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200964 if (eap->addr_count != 0)
965 {
966 /* Count total messages */
967 for (; p != NULL && !got_int; p = p->next)
968 c++;
969
970 c -= eap->line2;
971
972 /* Skip without number of messages specified */
973 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
974 p = p->next, c--);
975 }
976
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200977 if (p == first_msg_hist)
978 {
979 s = mch_getenv((char_u *)"LANG");
980 if (s != NULL && *s != NUL)
Bram Moolenaar0c183192018-06-28 14:54:43 +0200981 // The next comment is extracted by xgettext and put in po file for
982 // translators to read.
Bram Moolenaar32526b32019-01-19 17:43:09 +0100983 msg_attr(
Bram Moolenaar0c183192018-06-28 14:54:43 +0200984 // Translator: Please replace the name and email address
985 // with the appropriate text for your translation.
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200986 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100987 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200988 }
989
Bram Moolenaar451f8492016-04-14 17:16:22 +0200990 /* Display what was not skipped. */
991 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 if (p->msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +0100993 msg_attr((char *)p->msg, p->attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994
995 msg_hist_off = FALSE;
996}
997
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000998#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999/*
1000 * Call this after prompting the user. This will avoid a hit-return message
1001 * and a delay.
1002 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001003 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001004msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005{
1006 need_wait_return = FALSE;
1007 emsg_on_display = FALSE;
1008 cmdline_row = msg_row;
1009 msg_col = 0;
1010 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001011 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012}
1013#endif
1014
1015/*
Bram Moolenaar32526b32019-01-19 17:43:09 +01001016 * Wait for the user to hit a key (normally Enter).
1017 * If "redraw" is TRUE, clear and redraw the screen.
1018 * If "redraw" is FALSE, just redraw the screen.
1019 * If "redraw" is -1, don't redraw at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 */
1021 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001022wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023{
1024 int c;
1025 int oldState;
1026 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 int had_got_int;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001028 int save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001029 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031 if (redraw == TRUE)
1032 must_redraw = CLEAR;
1033
1034 /* If using ":silent cmd", don't wait for a return. Also don't set
1035 * need_wait_return to do it later. */
1036 if (msg_silent != 0)
1037 return;
1038
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001039 /*
1040 * When inside vgetc(), we can't wait for a typed character at all.
1041 * With the global command (and some others) we only need one return at
1042 * the end. Adjust cmdline_row to avoid the next message overwriting the
1043 * last one.
1044 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001045 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001047 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 if (no_wait_return)
1049 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 if (!exmode_active)
1051 cmdline_row = msg_row;
1052 return;
1053 }
1054
1055 redir_off = TRUE; /* don't redirect this message */
1056 oldState = State;
1057 if (quit_more)
1058 {
1059 c = CAR; /* just pretend CR was hit */
1060 quit_more = FALSE;
1061 got_int = FALSE;
1062 }
1063 else if (exmode_active)
1064 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001065 msg_puts(" "); /* make sure the cursor is on the right line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 c = CAR; /* no need for a return in ex mode */
1067 got_int = FALSE;
1068 }
1069 else
1070 {
1071 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1072 * just changed. */
1073 screenalloc(FALSE);
1074
1075 State = HITRETURN;
1076#ifdef FEAT_MOUSE
1077 setmouse();
1078#endif
1079#ifdef USE_ON_FLY_SCROLL
1080 dont_scroll = TRUE; /* disallow scrolling here */
1081#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001082 cmdline_row = msg_row;
1083
Bram Moolenaarec38d692013-04-24 15:12:32 +02001084 /* Avoid the sequence that the user types ":" at the hit-return prompt
1085 * to start an Ex command, but the file-changed dialog gets in the
1086 * way. */
1087 if (need_check_timestamps)
1088 check_timestamps(FALSE);
1089
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 hit_return_msg();
1091
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 do
1093 {
1094 /* Remember "got_int", if it is set vgetc() probably returns a
1095 * CTRL-C, but we need to loop then. */
1096 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001097
1098 /* Don't do mappings here, we put the character back in the
1099 * typeahead buffer. */
1100 ++no_mapping;
1101 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001102
1103 /* Temporarily disable Recording. If Recording is active, the
1104 * character will be recorded later, since it will be added to the
1105 * typebuf after the loop */
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001106 save_reg_recording = reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001107 save_scriptout = scriptout;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001108 reg_recording = 0;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001109 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001111 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001113 --no_mapping;
1114 --allow_keys;
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02001115 reg_recording = save_reg_recording;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001116 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001117
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118#ifdef FEAT_CLIPBOARD
1119 /* Strange way to allow copying (yanking) a modeless selection at
1120 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1121 * Cmdline-mode and it's harmless when there is no selection. */
1122 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1123 {
1124 clip_copy_modeless_selection(TRUE);
1125 c = K_IGNORE;
1126 }
1127#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001128
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001129 /*
1130 * Allow scrolling back in the messages.
1131 * Also accept scroll-down commands when messages fill the screen,
1132 * to avoid that typing one 'j' too many makes the messages
1133 * disappear.
1134 */
1135 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001136 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001137 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1138 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001139 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001140 if (msg_scrolled > Rows)
1141 /* scroll back to show older messages */
1142 do_more_prompt(c);
1143 else
1144 {
1145 msg_didout = FALSE;
1146 c = K_IGNORE;
1147 msg_col =
1148#ifdef FEAT_RIGHTLEFT
1149 cmdmsg_rl ? Columns - 1 :
1150#endif
1151 0;
1152 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001153 if (quit_more)
1154 {
1155 c = CAR; /* just pretend CR was hit */
1156 quit_more = FALSE;
1157 got_int = FALSE;
1158 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001159 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001160 {
1161 c = K_IGNORE;
1162 hit_return_msg();
1163 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001164 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001165 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001166 && (c == 'j' || c == 'd' || c == 'f'
1167 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001169 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 } while ((had_got_int && c == Ctrl_C)
1171 || c == K_IGNORE
1172#ifdef FEAT_GUI
1173 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1174#endif
1175#ifdef FEAT_MOUSE
1176 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1177 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1178 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001179 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 || c == K_MOUSEDOWN || c == K_MOUSEUP
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001181 || c == K_MOUSEMOVE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 || (!mouse_has(MOUSE_RETURN)
1183 && mouse_row < msg_row
1184 && (c == K_LEFTMOUSE
1185 || c == K_MIDDLEMOUSE
1186 || c == K_RIGHTMOUSE
1187 || c == K_X1MOUSE
1188 || c == K_X2MOUSE))
1189#endif
1190 );
1191 ui_breakcheck();
1192#ifdef FEAT_MOUSE
1193 /*
1194 * Avoid that the mouse-up event causes visual mode to start.
1195 */
1196 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1197 || c == K_X1MOUSE || c == K_X2MOUSE)
1198 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1199 else
1200#endif
1201 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1202 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001203 /* Put the character back in the typeahead buffer. Don't use the
1204 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001205 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001207 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 }
1210 redir_off = FALSE;
1211
1212 /*
1213 * If the user hits ':', '?' or '/' we get a command line from the next
1214 * line.
1215 */
1216 if (c == ':' || c == '?' || c == '/')
1217 {
1218 if (!exmode_active)
1219 cmdline_row = msg_row;
1220 skip_redraw = TRUE; /* skip redraw once */
1221 do_redraw = FALSE;
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02001222#ifdef FEAT_TERMINAL
1223 skip_term_loop = TRUE;
1224#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 }
1226
1227 /*
1228 * If the window size changed set_shellsize() will redraw the screen.
1229 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1230 * typed.
1231 */
1232 tmpState = State;
1233 State = oldState; /* restore State before set_shellsize */
1234#ifdef FEAT_MOUSE
1235 setmouse();
1236#endif
1237 msg_check();
1238
1239#if defined(UNIX) || defined(VMS)
1240 /*
1241 * When switching screens, we need to output an extra newline on exit.
1242 */
1243 if (swapping_screen() && !termcap_active)
1244 newline_on_exit = TRUE;
1245#endif
1246
1247 need_wait_return = FALSE;
1248 did_wait_return = TRUE;
1249 emsg_on_display = FALSE; /* can delete error message now */
1250 lines_left = -1; /* reset lines_left at next msg_start() */
1251 reset_last_sourcing();
1252 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1253 (Rows - cmdline_row - 1) * Columns + sc_col)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001254 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1257 {
1258 starttermcap(); /* start termcap before redrawing */
1259 shell_resized();
1260 }
1261 else if (!skip_redraw
1262 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1263 {
1264 starttermcap(); /* start termcap before redrawing */
1265 redraw_later(VALID);
1266 }
1267}
1268
1269/*
1270 * Write the hit-return prompt.
1271 */
1272 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001273hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001275 int save_p_more = p_more;
1276
1277 p_more = FALSE; /* don't want see this message when scrolling back */
1278 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 msg_putchar('\n');
1280 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001281 msg_puts(_("Interrupt: "));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282
Bram Moolenaar32526b32019-01-19 17:43:09 +01001283 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 if (!msg_use_printf())
1285 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001286 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287}
1288
1289/*
1290 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1291 */
1292 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001293set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294{
1295 vim_free(keep_msg);
1296 if (s != NULL && msg_silent == 0)
1297 keep_msg = vim_strsave(s);
1298 else
1299 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001300 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001301 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302}
1303
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001304#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1305/*
1306 * If there currently is a message being displayed, set "keep_msg" to it, so
1307 * that it will be displayed again after redraw.
1308 */
1309 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001310set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001311{
1312 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1313 && (State & NORMAL))
1314 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1315}
1316#endif
1317
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318/*
1319 * Prepare for outputting characters in the command line.
1320 */
1321 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001322msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323{
1324 int did_return = FALSE;
1325
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001326 if (!msg_silent)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001327 VIM_CLEAR(keep_msg);
Bram Moolenaara7241f52008-06-24 20:39:31 +00001328
1329#ifdef FEAT_EVAL
1330 if (need_clr_eos)
1331 {
1332 /* Halfway an ":echo" command and getting an (error) message: clear
1333 * any text from the command. */
1334 need_clr_eos = FALSE;
1335 msg_clr_eos();
1336 }
1337#endif
1338
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 if (!msg_scroll && full_screen) /* overwrite last message */
1340 {
1341 msg_row = cmdline_row;
1342 msg_col =
1343#ifdef FEAT_RIGHTLEFT
1344 cmdmsg_rl ? Columns - 1 :
1345#endif
1346 0;
1347 }
1348 else if (msg_didout) /* start message on next line */
1349 {
1350 msg_putchar('\n');
1351 did_return = TRUE;
1352 if (exmode_active != EXMODE_NORMAL)
1353 cmdline_row = msg_row;
1354 }
1355 if (!msg_didany || lines_left < 0)
1356 msg_starthere();
1357 if (msg_silent == 0)
1358 {
1359 msg_didout = FALSE; /* no output on current line yet */
1360 cursor_off();
1361 }
1362
1363 /* when redirecting, may need to start a new line. */
1364 if (!did_return)
1365 redir_write((char_u *)"\n", -1);
1366}
1367
1368/*
1369 * Note that the current msg position is where messages start.
1370 */
1371 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001372msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373{
1374 lines_left = cmdline_row;
1375 msg_didany = FALSE;
1376}
1377
1378 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001379msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380{
1381 msg_putchar_attr(c, 0);
1382}
1383
1384 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001385msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386{
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001387 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388
1389 if (IS_SPECIAL(c))
1390 {
1391 buf[0] = K_SPECIAL;
1392 buf[1] = K_SECOND(c);
1393 buf[2] = K_THIRD(c);
1394 buf[3] = NUL;
1395 }
1396 else
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001397 buf[(*mb_char2bytes)(c, buf)] = NUL;
Bram Moolenaar63c0ccd2019-01-19 21:06:58 +01001398 msg_puts_attr((char *)buf, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399}
1400
1401 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001402msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001404 char buf[20];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
Bram Moolenaar32526b32019-01-19 17:43:09 +01001406 sprintf(buf, "%ld", n);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 msg_puts(buf);
1408}
1409
1410 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001411msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412{
1413 msg_home_replace_attr(fname, 0);
1414}
1415
1416#if defined(FEAT_FIND_ID) || defined(PROTO)
1417 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001418msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001420 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421}
1422#endif
1423
1424 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001425msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426{
1427 char_u *name;
1428
1429 name = home_replace_save(NULL, fname);
1430 if (name != NULL)
1431 msg_outtrans_attr(name, attr);
1432 vim_free(name);
1433}
1434
1435/*
1436 * Output 'len' characters in 'str' (including NULs) with translation
1437 * if 'len' is -1, output upto a NUL character.
1438 * Use attributes 'attr'.
1439 * Return the number of characters it takes on the screen.
1440 */
1441 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001442msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443{
1444 return msg_outtrans_attr(str, 0);
1445}
1446
1447 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001448msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449{
1450 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1451}
1452
1453 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001454msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455{
1456 return msg_outtrans_len_attr(str, len, 0);
1457}
1458
1459/*
1460 * Output one character at "p". Return pointer to the next character.
1461 * Handles multi-byte characters.
1462 */
1463 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001464msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 int l;
1467
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001468 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469 {
1470 msg_outtrans_len_attr(p, l, attr);
1471 return p + l;
1472 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001473 msg_puts_attr((char *)transchar_byte(*p), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 return p + 1;
1475}
1476
1477 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001478msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479{
1480 int retval = 0;
1481 char_u *str = msgstr;
1482 char_u *plain_start = msgstr;
1483 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 int mb_l;
1485 int c;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 /* if MSG_HIST flag set, add message to history */
1488 if (attr & MSG_HIST)
1489 {
1490 add_msg_hist(str, len, attr);
1491 attr &= ~MSG_HIST;
1492 }
1493
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 /* If the string starts with a composing character first draw a space on
1495 * which the composing char can be drawn. */
1496 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
Bram Moolenaar32526b32019-01-19 17:43:09 +01001497 msg_puts_attr(" ", attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498
1499 /*
1500 * Go over the string. Special characters are translated and printed.
1501 * Normal characters are printed several at a time.
1502 */
1503 while (--len >= 0)
1504 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 if (enc_utf8)
1506 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001507 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001509 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 else
1511 mb_l = 1;
1512 if (has_mbyte && mb_l > 1)
1513 {
1514 c = (*mb_ptr2char)(str);
1515 if (vim_isprintc(c))
1516 /* printable multi-byte char: count the cells. */
1517 retval += (*mb_ptr2cells)(str);
1518 else
1519 {
1520 /* unprintable multi-byte char: print the printable chars so
1521 * far and the translation of the unprintable char. */
1522 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001523 msg_puts_attr_len((char *)plain_start,
1524 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 plain_start = str + mb_l;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001526 msg_puts_attr((char *)transchar(c),
1527 attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 retval += char2cells(c);
1529 }
1530 len -= mb_l - 1;
1531 str += mb_l;
1532 }
1533 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 {
1535 s = transchar_byte(*str);
1536 if (s[1] != NUL)
1537 {
1538 /* unprintable char: print the printable chars so far and the
1539 * translation of the unprintable char. */
1540 if (str > plain_start)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001541 msg_puts_attr_len((char *)plain_start,
1542 (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 plain_start = str + 1;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001544 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001545 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001547 else
1548 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 ++str;
1550 }
1551 }
1552
1553 if (str > plain_start)
1554 /* print the printable chars at the end */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001555 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556
1557 return retval;
1558}
1559
1560#if defined(FEAT_QUICKFIX) || defined(PROTO)
1561 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001562msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563{
1564 int i;
1565 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1566
1567 arg = skipwhite(arg);
1568 for (i = 5; *arg && i >= 0; --i)
1569 if (*arg++ != str[i])
1570 break;
1571 if (i < 0)
1572 {
1573 msg_putchar('\n');
1574 for (i = 0; rs[i]; ++i)
1575 msg_putchar(rs[i] - 3);
1576 }
1577}
1578#endif
1579
1580/*
1581 * Output the string 'str' upto a NUL character.
1582 * Return the number of characters it takes on the screen.
1583 *
1584 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1585 * following character and shown as <F1>, <S-Up> etc. Any other character
1586 * which is not printable shown in <> form.
1587 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1588 * If a character is displayed in one of these special ways, is also
1589 * highlighted (its highlight name is '8' in the p_hl variable).
1590 * Otherwise characters are not highlighted.
1591 * This function is used to show mappings, where we want to see how to type
1592 * the character/string -- webb
1593 */
1594 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001595msg_outtrans_special(
1596 char_u *strstart,
1597 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598{
1599 char_u *str = strstart;
1600 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001601 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 int attr;
1603 int len;
1604
Bram Moolenaar8820b482017-03-16 17:23:31 +01001605 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 while (*str != NUL)
1607 {
1608 /* Leading and trailing spaces need to be displayed in <> form. */
1609 if ((str == strstart || str[1] == NUL) && *str == ' ')
1610 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001611 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 ++str;
1613 }
1614 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001615 text = (char *)str2special(&str, from);
1616 len = vim_strsize((char_u *)text);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 /* Highlight special keys */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001618 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001619 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 retval += len;
1621 }
1622 return retval;
1623}
1624
Bram Moolenaarbd743252010-10-20 21:23:33 +02001625#if defined(FEAT_EVAL) || defined(PROTO)
1626/*
1627 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1628 * strings, in an allocated string.
1629 */
1630 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001631str2special_save(
1632 char_u *str,
1633 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001634{
1635 garray_T ga;
1636 char_u *p = str;
1637
1638 ga_init2(&ga, 1, 40);
1639 while (*p != NUL)
1640 ga_concat(&ga, str2special(&p, is_lhs));
1641 ga_append(&ga, NUL);
1642 return (char_u *)ga.ga_data;
1643}
1644#endif
1645
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646/*
1647 * Return the printable string for the key codes at "*sp".
1648 * Used for translating the lhs or rhs of a mapping to printable chars.
1649 * Advances "sp" to the next code.
1650 */
1651 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001652str2special(
1653 char_u **sp,
1654 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655{
1656 int c;
1657 static char_u buf[7];
1658 char_u *str = *sp;
1659 int modifiers = 0;
1660 int special = FALSE;
1661
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 if (has_mbyte)
1663 {
1664 char_u *p;
1665
1666 /* Try to un-escape a multi-byte character. Return the un-escaped
1667 * string if it is a multi-byte character. */
1668 p = mb_unescape(sp);
1669 if (p != NULL)
1670 return p;
1671 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673 c = *str;
1674 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1675 {
1676 if (str[1] == KS_MODIFIER)
1677 {
1678 modifiers = str[2];
1679 str += 3;
1680 c = *str;
1681 }
1682 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1683 {
1684 c = TO_SPECIAL(str[1], str[2]);
1685 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 }
1687 if (IS_SPECIAL(c) || modifiers) /* special key */
1688 special = TRUE;
1689 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001691 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001693 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001694
1695 /* For multi-byte characters check for an illegal byte. */
1696 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1697 {
1698 transchar_nonprint(buf, c);
1699 *sp = str + 1;
1700 return buf;
1701 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001702 /* Since 'special' is TRUE the multi-byte character 'c' will be
1703 * processed by get_special_key_name() */
1704 c = (*mb_ptr2char)(str);
1705 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001707 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001708 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
1710 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1711 * Use <Space> only for lhs of a mapping. */
1712 if (special || char2cells(c) > 1 || (from && c == ' '))
1713 return get_special_key_name(c, modifiers);
1714 buf[0] = c;
1715 buf[1] = NUL;
1716 return buf;
1717}
1718
1719/*
1720 * Translate a key sequence into special key names.
1721 */
1722 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001723str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724{
1725 char_u *s;
1726
1727 *buf = NUL;
1728 while (*sp)
1729 {
1730 s = str2special(&sp, FALSE);
1731 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1732 STRCAT(buf, s);
1733 }
1734}
1735
1736/*
1737 * print line for :print or :list command
1738 */
1739 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001740msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741{
1742 int c;
1743 int col = 0;
1744 int n_extra = 0;
1745 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001746 int c_final = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 char_u *p_extra = NULL; /* init to make SASC shut up */
1748 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001749 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 int l;
1752 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753
Bram Moolenaardf177f62005-02-22 08:39:57 +00001754 if (curwin->w_p_list)
1755 list = TRUE;
1756
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001758 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 {
1760 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001761 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 --trail;
1763 }
1764
1765 /* output a space for an empty line, otherwise the line will be
1766 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001767 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 msg_putchar(' ');
1769
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001770 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001772 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 {
1774 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001775 if (n_extra == 0 && c_final)
1776 c = c_final;
1777 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 c = c_extra;
1779 else
1780 c = *p_extra++;
1781 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001782 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 {
1784 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001785 if (lcs_nbsp != NUL && list
1786 && (mb_ptr2char(s) == 160
1787 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001788 {
1789 mb_char2bytes(lcs_nbsp, buf);
1790 buf[(*mb_ptr2len)(buf)] = NUL;
1791 }
1792 else
1793 {
1794 mch_memmove(buf, s, (size_t)l);
1795 buf[l] = NUL;
1796 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001797 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 s += l;
1799 continue;
1800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 else
1802 {
1803 attr = 0;
1804 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001805 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 {
1807 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001808#ifdef FEAT_VARTABS
1809 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1810 curbuf->b_p_vts_array) - 1;
1811#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001813#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001814 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 {
1816 c = ' ';
1817 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001818 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 }
1820 else
1821 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001822 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001824 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001825 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 }
1827 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001828 else if (c == 160 && list && lcs_nbsp != NUL)
1829 {
1830 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001831 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001832 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001833 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 {
1835 p_extra = (char_u *)"";
1836 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001837 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 n_extra = 1;
1839 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001840 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 --s;
1842 }
1843 else if (c != NUL && (n = byte2cells(c)) > 1)
1844 {
1845 n_extra = n - 1;
1846 p_extra = transchar_byte(c);
1847 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001848 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001850 /* Use special coloring to be able to distinguish <hex> from
1851 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001852 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 }
1854 else if (c == ' ' && trail != NULL && s > trail)
1855 {
1856 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001857 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001859 else if (c == ' ' && list && lcs_space != NUL)
1860 {
1861 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001862 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001863 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 }
1865
1866 if (c == NUL)
1867 break;
1868
1869 msg_putchar_attr(c, attr);
1870 col++;
1871 }
1872 msg_clr_eos();
1873}
1874
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875/*
1876 * Use screen_puts() to output one multi-byte character.
1877 * Return the pointer "s" advanced to the next character.
1878 */
1879 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001880screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881{
1882 int cw;
1883
1884 msg_didout = TRUE; /* remember that line is not empty */
1885 cw = (*mb_ptr2cells)(s);
1886 if (cw > 1 && (
1887#ifdef FEAT_RIGHTLEFT
1888 cmdmsg_rl ? msg_col <= 1 :
1889#endif
1890 msg_col == Columns - 1))
1891 {
1892 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001893 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 return s;
1895 }
1896
1897 screen_puts_len(s, l, msg_row, msg_col, attr);
1898#ifdef FEAT_RIGHTLEFT
1899 if (cmdmsg_rl)
1900 {
1901 msg_col -= cw;
1902 if (msg_col == 0)
1903 {
1904 msg_col = Columns;
1905 ++msg_row;
1906 }
1907 }
1908 else
1909#endif
1910 {
1911 msg_col += cw;
1912 if (msg_col >= Columns)
1913 {
1914 msg_col = 0;
1915 ++msg_row;
1916 }
1917 }
1918 return s + l;
1919}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920
1921/*
1922 * Output a string to the screen at position msg_row, msg_col.
1923 * Update msg_row and msg_col for the next message.
1924 */
1925 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001926msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001928 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929}
1930
1931 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001932msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001934 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935}
1936
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937/*
1938 * Show a message in such a way that it always fits in the line. Cut out a
1939 * part in the middle and replace it with "..." when necessary.
1940 * Does not handle multi-byte characters!
1941 */
1942 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001943msg_outtrans_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001945 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946}
1947
1948 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001949msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950{
1951 int slen = len;
1952 int room;
1953
1954 room = Columns - msg_col;
1955 if (len > room && room >= 20)
1956 {
1957 slen = (room - 3) / 2;
1958 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001959 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 }
1961 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1962}
1963
1964/*
1965 * Basic function for writing a message with highlight attributes.
1966 */
1967 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001968msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969{
1970 msg_puts_attr_len(s, -1, attr);
1971}
1972
1973/*
1974 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1975 * When "maxlen" is -1 there is no maximum length.
1976 * When "maxlen" is >= 0 the message is not put in the history.
1977 */
1978 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001979msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 /*
1982 * If redirection is on, also write to the redirection file.
1983 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001984 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985
1986 /*
1987 * Don't print anything when using ":silent cmd".
1988 */
1989 if (msg_silent != 0)
1990 return;
1991
1992 /* if MSG_HIST flag set, add message to history */
1993 if ((attr & MSG_HIST) && maxlen < 0)
1994 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001995 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 attr &= ~MSG_HIST;
1997 }
1998
1999 /*
2000 * When writing something to the screen after it has scrolled, requires a
2001 * wait-return prompt later. Needed when scrolling, resetting
2002 * need_wait_return after some prompt, and then outputting something
2003 * without scrolling
2004 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002005 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 need_wait_return = TRUE;
2007 msg_didany = TRUE; /* remember that something was outputted */
2008
2009 /*
2010 * If there is no valid screen, use fprintf so we can see error messages.
2011 * If termcap is not active, we may be writing in an alternate console
2012 * window, cursor positioning may not work correctly (window size may be
2013 * different, e.g. for Win32 console) or we just don't know where the
2014 * cursor is.
2015 */
2016 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002017 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002018 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002019 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002020}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002022/*
2023 * The display part of msg_puts_attr_len().
2024 * May be called recursively to display scroll-back text.
2025 */
2026 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002027msg_puts_display(
2028 char_u *str,
2029 int maxlen,
2030 int attr,
2031 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002032{
2033 char_u *s = str;
2034 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2035 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002036 int l;
2037 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002038 char_u *sb_str = str;
2039 int sb_col = msg_col;
2040 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002041 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042
2043 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002044 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 {
2046 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002047 * We are at the end of the screen line when:
2048 * - When outputting a newline.
2049 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002051 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052#ifdef FEAT_RIGHTLEFT
2053 cmdmsg_rl
2054 ? (
2055 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002056 || (*s == TAB && msg_col <= 7)
2057 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 :
2059#endif
2060 (msg_col + t_col >= Columns - 1
2061 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002063 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002065 /*
2066 * The screen is scrolled up when at the last row (some terminals
2067 * scroll automatically, some don't. To avoid problems we scroll
2068 * ourselves).
2069 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002072 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002074 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 if (msg_no_more && lines_left == 0)
2076 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002078 /* Scroll the screen up one line. */
2079 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
2081 msg_row = Rows - 2;
2082 if (msg_col >= Columns) /* can happen after screen resize */
2083 msg_col = Columns - 1;
2084
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002085 /* Display char in last column before showing more-prompt. */
2086 if (*s >= ' '
2087#ifdef FEAT_RIGHTLEFT
2088 && !cmdmsg_rl
2089#endif
2090 )
2091 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002092 if (has_mbyte)
2093 {
2094 if (enc_utf8 && maxlen >= 0)
2095 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002096 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002097 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002098 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002099 s = screen_puts_mbyte(s, l, attr);
2100 }
2101 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002102 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002103 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002104 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002105 else
2106 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002107
2108 if (p_more)
2109 /* store text for scrolling back */
2110 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2111
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002112 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002113 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 redraw_cmdline = TRUE;
2115 if (cmdline_row > 0 && !exmode_active)
2116 --cmdline_row;
2117
2118 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002119 * If screen is completely filled and 'more' is set then wait
2120 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002122 if (lines_left > 0)
2123 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002124 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 && !msg_no_more && !exmode_active)
2126 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002128 if (do_more_prompt(NUL))
2129 s = confirm_msg_tail;
2130#else
2131 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132#endif
2133 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002134 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002136
2137 /* When we displayed a char in last column need to check if there
2138 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002139 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002140 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 }
2142
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002143 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002146 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002147 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2148 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002150 t_puts(&t_col, t_s, s, attr);
2151
2152 if (wrap && p_more && !recurse)
2153 /* store text for scrolling back */
2154 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155
2156 if (*s == '\n') /* go to next line */
2157 {
2158 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002159#ifdef FEAT_RIGHTLEFT
2160 if (cmdmsg_rl)
2161 msg_col = Columns - 1;
2162 else
2163#endif
2164 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 if (++msg_row >= Rows) /* safety check */
2166 msg_row = Rows - 1;
2167 }
2168 else if (*s == '\r') /* go to column 0 */
2169 {
2170 msg_col = 0;
2171 }
2172 else if (*s == '\b') /* go to previous char */
2173 {
2174 if (msg_col)
2175 --msg_col;
2176 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002177 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 {
2179 do
2180 msg_screen_putchar(' ', attr);
2181 while (msg_col & 7);
2182 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002183 else if (*s == BELL) /* beep (from ":sh") */
2184 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 else
2186 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 if (has_mbyte)
2188 {
2189 cw = (*mb_ptr2cells)(s);
2190 if (enc_utf8 && maxlen >= 0)
2191 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002192 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002194 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 }
2196 else
2197 {
2198 cw = 1;
2199 l = 1;
2200 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002201
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 /* When drawing from right to left or when a double-wide character
2203 * doesn't fit, draw a single character here. Otherwise collect
2204 * characters and draw them all at once later. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 if (
2206# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002207 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002209 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 if (l > 1)
2212 s = screen_puts_mbyte(s, l, attr) - 1;
2213 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 msg_screen_putchar(*s, attr);
2215 }
2216 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 {
2218 /* postpone this character until later */
2219 if (t_col == 0)
2220 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 t_col += cw;
2222 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 }
2224 }
2225 ++s;
2226 }
2227
2228 /* output any postponed text */
2229 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002230 t_puts(&t_col, t_s, s, attr);
2231 if (p_more && !recurse)
2232 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233
2234 msg_check();
2235}
2236
2237/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002238 * Return TRUE when ":filter pattern" was used and "msg" does not match
2239 * "pattern".
2240 */
2241 int
2242message_filtered(char_u *msg)
2243{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002244 int match;
2245
2246 if (cmdmod.filter_regmatch.regprog == NULL)
2247 return FALSE;
2248 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2249 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002250}
2251
2252/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002253 * Scroll the screen up one line for displaying the next message line.
2254 */
2255 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002256msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002257{
2258#ifdef FEAT_GUI
2259 /* Remove the cursor before scrolling, ScreenLines[] is going
2260 * to become invalid. */
2261 if (gui.in_use)
2262 gui_undraw_cursor();
2263#endif
2264 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002265 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002266 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002267 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002268
2269 if (!can_clear((char_u *)" "))
2270 {
2271 /* Scrolling up doesn't result in the right background. Set the
2272 * background here. It's not efficient, but avoids that we have to do
2273 * it all over the code. */
2274 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2275
2276 /* Also clear the last char of the last but one line if it was not
2277 * cleared before to avoid a scroll-up. */
2278 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2279 screen_fill((int)Rows - 2, (int)Rows - 1,
2280 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2281 }
2282}
2283
2284/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002285 * Increment "msg_scrolled".
2286 */
2287 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002288inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002289{
2290#ifdef FEAT_EVAL
2291 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2292 {
2293 char_u *p = sourcing_name;
2294 char_u *tofree = NULL;
2295 int len;
2296
2297 /* v:scrollstart is empty, set it to the script/function name and line
2298 * number */
2299 if (p == NULL)
2300 p = (char_u *)_("Unknown");
2301 else
2302 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002303 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002304 tofree = alloc(len);
2305 if (tofree != NULL)
2306 {
2307 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2308 p, (long)sourcing_lnum);
2309 p = tofree;
2310 }
2311 }
2312 set_vim_var_string(VV_SCROLLSTART, p, -1);
2313 vim_free(tofree);
2314 }
2315#endif
2316 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002317 if (must_redraw < VALID)
2318 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002319}
2320
2321/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002322 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2323 * store the displayed text and remember where screen lines start.
2324 */
2325typedef struct msgchunk_S msgchunk_T;
2326struct msgchunk_S
2327{
2328 msgchunk_T *sb_next;
2329 msgchunk_T *sb_prev;
2330 char sb_eol; /* TRUE when line ends after this text */
2331 int sb_msg_col; /* column in which text starts */
2332 int sb_attr; /* text attributes */
2333 char_u sb_text[1]; /* text to be displayed, actually longer */
2334};
2335
2336static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2337
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002338static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002339
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002340typedef enum {
2341 SB_CLEAR_NONE = 0,
2342 SB_CLEAR_ALL,
2343 SB_CLEAR_CMDLINE_BUSY,
2344 SB_CLEAR_CMDLINE_DONE
2345} sb_clear_T;
2346
2347/* When to clear text on next msg. */
2348static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002349
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002350/*
2351 * Store part of a printed message for displaying when scrolling back.
2352 */
2353 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002354store_sb_text(
2355 char_u **sb_str, /* start of string */
2356 char_u *s, /* just after string */
2357 int attr,
2358 int *sb_col,
2359 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002360{
2361 msgchunk_T *mp;
2362
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002363 if (do_clear_sb_text == SB_CLEAR_ALL
2364 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002365 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002366 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2367 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002368 }
2369
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002370 if (s > *sb_str)
2371 {
2372 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2373 if (mp != NULL)
2374 {
2375 mp->sb_eol = finish;
2376 mp->sb_msg_col = *sb_col;
2377 mp->sb_attr = attr;
2378 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2379
2380 if (last_msgchunk == NULL)
2381 {
2382 last_msgchunk = mp;
2383 mp->sb_prev = NULL;
2384 }
2385 else
2386 {
2387 mp->sb_prev = last_msgchunk;
2388 last_msgchunk->sb_next = mp;
2389 last_msgchunk = mp;
2390 }
2391 mp->sb_next = NULL;
2392 }
2393 }
2394 else if (finish && last_msgchunk != NULL)
2395 last_msgchunk->sb_eol = TRUE;
2396
2397 *sb_str = s;
2398 *sb_col = 0;
2399}
2400
2401/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002402 * Finished showing messages, clear the scroll-back text on the next message.
2403 */
2404 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002405may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002406{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002407 do_clear_sb_text = SB_CLEAR_ALL;
2408}
2409
2410/*
2411 * Starting to edit the command line, do not clear messages now.
2412 */
2413 void
2414sb_text_start_cmdline(void)
2415{
2416 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2417 msg_sb_eol();
2418}
2419
2420/*
2421 * Ending to edit the command line. Clear old lines but the last one later.
2422 */
2423 void
2424sb_text_end_cmdline(void)
2425{
2426 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002427}
2428
2429/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002430 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002431 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002432 * Called when redrawing the screen.
2433 */
2434 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002435clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002436{
2437 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002438 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002439
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002440 if (all)
2441 lastp = &last_msgchunk;
2442 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002443 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002444 if (last_msgchunk == NULL)
2445 return;
2446 lastp = &last_msgchunk->sb_prev;
2447 }
2448
2449 while (*lastp != NULL)
2450 {
2451 mp = (*lastp)->sb_prev;
2452 vim_free(*lastp);
2453 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002454 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002455}
2456
2457/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458 * "g<" command.
2459 */
2460 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002461show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002462{
2463 msgchunk_T *mp;
2464
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002465 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002466 * weird, typing a command without output results in one line. */
2467 mp = msg_sb_start(last_msgchunk);
2468 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002469 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002470 else
2471 {
2472 do_more_prompt('G');
2473 wait_return(FALSE);
2474 }
2475}
2476
2477/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002478 * Move to the start of screen line in already displayed text.
2479 */
2480 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002481msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002482{
2483 msgchunk_T *mp = mps;
2484
2485 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2486 mp = mp->sb_prev;
2487 return mp;
2488}
2489
2490/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002491 * Mark the last message chunk as finishing the line.
2492 */
2493 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002494msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002495{
2496 if (last_msgchunk != NULL)
2497 last_msgchunk->sb_eol = TRUE;
2498}
2499
2500/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002501 * Display a screen line from previously displayed text at row "row".
2502 * Returns a pointer to the text for the next line (can be NULL).
2503 */
2504 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002505disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002506{
2507 msgchunk_T *mp = smp;
2508 char_u *p;
2509
2510 for (;;)
2511 {
2512 msg_row = row;
2513 msg_col = mp->sb_msg_col;
2514 p = mp->sb_text;
2515 if (*p == '\n') /* don't display the line break */
2516 ++p;
2517 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2518 if (mp->sb_eol || mp->sb_next == NULL)
2519 break;
2520 mp = mp->sb_next;
2521 }
2522 return mp->sb_next;
2523}
2524
2525/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 * Output any postponed text for msg_puts_attr_len().
2527 */
2528 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002529t_puts(
2530 int *t_col,
2531 char_u *t_s,
2532 char_u *s,
2533 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534{
2535 /* output postponed text */
2536 msg_didout = TRUE; /* remember that line is not empty */
2537 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002538 msg_col += *t_col;
2539 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 /* If the string starts with a composing character don't increment the
2541 * column position for it. */
2542 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2543 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 if (msg_col >= Columns)
2545 {
2546 msg_col = 0;
2547 ++msg_row;
2548 }
2549}
2550
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551/*
2552 * Returns TRUE when messages should be printed with mch_errmsg().
2553 * This is used when there is no valid screen, so we can see error messages.
2554 * If termcap is not active, we may be writing in an alternate console
2555 * window, cursor positioning may not work correctly (window size may be
2556 * different, e.g. for Win32 console) or we just don't know where the
2557 * cursor is.
2558 */
2559 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002560msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561{
2562 return (!msg_check_screen()
Bram Moolenaar4f974752019-02-17 17:44:42 +01002563#if defined(MSWIN) && !defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 || !termcap_active
2565#endif
2566 || (swapping_screen() && !termcap_active)
2567 );
2568}
2569
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002570/*
2571 * Print a message when there is no valid screen.
2572 */
2573 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002574msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002575{
2576 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002577 char_u *buf = NULL;
2578 char_u *p = s;
2579
Bram Moolenaar4f974752019-02-17 17:44:42 +01002580#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002581 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002582 mch_settmode(TMODE_COOK); /* handle CR and NL correctly */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002583#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002584 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002585 {
2586 if (!(silent_mode && p_verbose == 0))
2587 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002588 // NL --> CR NL translation (for Unix, not for "--version")
2589 if (*s == NL)
2590 {
2591 int n = (int)(s - p);
2592
2593 buf = alloc(n + 3);
2594 memcpy(buf, p, n);
2595 if (!info_message)
2596 buf[n++] = CAR;
Bram Moolenaar00590742019-02-15 21:06:09 +01002597 buf[n++] = NL;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002598 buf[n++] = NUL;
2599 if (info_message) // informative message, not an error
2600 mch_msg((char *)buf);
2601 else
2602 mch_errmsg((char *)buf);
2603 vim_free(buf);
2604 p = s + 1;
2605 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002606 }
2607
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002608 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002609#ifdef FEAT_RIGHTLEFT
2610 if (cmdmsg_rl)
2611 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002612 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002613 msg_col = Columns - 1;
2614 else
2615 --msg_col;
2616 }
2617 else
2618#endif
2619 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002620 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002621 msg_col = 0;
2622 else
2623 ++msg_col;
2624 }
2625 ++s;
2626 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002627
2628 if (*p != NUL && !(silent_mode && p_verbose == 0))
2629 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002630 int c = -1;
2631
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002632 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002633 {
2634 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002635 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002636 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002637 if (info_message)
2638 mch_msg((char *)p);
2639 else
2640 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002641 if (c != -1)
2642 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002643 }
2644
2645 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002646
Bram Moolenaar4f974752019-02-17 17:44:42 +01002647#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002648 if (!(silent_mode && p_verbose == 0))
2649 mch_settmode(TMODE_RAW);
2650#endif
2651}
2652
2653/*
2654 * Show the more-prompt and handle the user response.
2655 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002656 * When at hit-enter prompt "typed_char" is the already typed character,
2657 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002658 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2659 */
2660 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002661do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002662{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002663 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002664 int used_typed_char = typed_char;
2665 int oldState = State;
2666 int c;
2667#ifdef FEAT_CON_DIALOG
2668 int retval = FALSE;
2669#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002670 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002671 msgchunk_T *mp_last = NULL;
2672 msgchunk_T *mp;
2673 int i;
2674
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002675 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002676 * that case don't show another prompt. Also when at the hit-Enter prompt
2677 * and nothing was typed. */
2678 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002679 return FALSE;
2680 entered = TRUE;
2681
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002682 if (typed_char == 'G')
2683 {
2684 /* "g<": Find first line on the last page. */
2685 mp_last = msg_sb_start(last_msgchunk);
2686 for (i = 0; i < Rows - 2 && mp_last != NULL
2687 && mp_last->sb_prev != NULL; ++i)
2688 mp_last = msg_sb_start(mp_last->sb_prev);
2689 }
2690
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002691 State = ASKMORE;
2692#ifdef FEAT_MOUSE
2693 setmouse();
2694#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002695 if (typed_char == NUL)
2696 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002697 for (;;)
2698 {
2699 /*
2700 * Get a typed character directly from the user.
2701 */
2702 if (used_typed_char != NUL)
2703 {
2704 c = used_typed_char; /* was typed at hit-enter prompt */
2705 used_typed_char = NUL;
2706 }
2707 else
2708 c = get_keystroke();
2709
2710#if defined(FEAT_MENU) && defined(FEAT_GUI)
2711 if (c == K_MENU)
2712 {
2713 int idx = get_menu_index(current_menu, ASKMORE);
2714
2715 /* Used a menu. If it starts with CTRL-Y, it must
2716 * be a "Copy" for the clipboard. Otherwise
2717 * assume that we end */
2718 if (idx == MENU_INDEX_INVALID)
2719 continue;
2720 c = *current_menu->strings[idx];
2721 if (c != NUL && current_menu->strings[idx][1] != NUL)
2722 ins_typebuf(current_menu->strings[idx] + 1,
2723 current_menu->noremap[idx], 0, TRUE,
2724 current_menu->silent[idx]);
2725 }
2726#endif
2727
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002728 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002729 switch (c)
2730 {
2731 case BS: /* scroll one line back */
2732 case K_BS:
2733 case 'k':
2734 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002735 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002736 break;
2737
2738 case CAR: /* one extra line */
2739 case NL:
2740 case 'j':
2741 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002742 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002743 break;
2744
2745 case 'u': /* Up 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 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002750 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002751 break;
2752
2753 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002754 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002755 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002756 break;
2757
2758 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002759 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002760 case K_PAGEDOWN:
2761 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002762 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002763 break;
2764
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002765 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002766 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002767 break;
2768
2769 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002770 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002771 lines_left = 999999;
2772 break;
2773
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002774 case ':': /* start new command line */
2775#ifdef FEAT_CON_DIALOG
2776 if (!confirm_msg_used)
2777#endif
2778 {
2779 /* Since got_int is set all typeahead will be flushed, but we
2780 * want to keep this ':', remember that in a special way. */
2781 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002782#ifdef FEAT_TERMINAL
2783 skip_term_loop = TRUE;
2784#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002785 cmdline_row = Rows - 1; /* put ':' on this line */
2786 skip_redraw = TRUE; /* skip redraw once */
2787 need_wait_return = FALSE; /* don't wait in main() */
2788 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002789 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002790 case 'q': /* quit */
2791 case Ctrl_C:
2792 case ESC:
2793#ifdef FEAT_CON_DIALOG
2794 if (confirm_msg_used)
2795 {
2796 /* Jump to the choices of the dialog. */
2797 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002798 }
2799 else
2800#endif
2801 {
2802 got_int = TRUE;
2803 quit_more = TRUE;
2804 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002805 /* When there is some more output (wrapping line) display that
2806 * without another prompt. */
2807 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002808 break;
2809
2810#ifdef FEAT_CLIPBOARD
2811 case Ctrl_Y:
2812 /* Strange way to allow copying (yanking) a modeless
2813 * selection at the more prompt. Use CTRL-Y,
2814 * because the same is used in Cmdline-mode and at the
2815 * hit-enter prompt. However, scrolling one line up
2816 * might be expected... */
2817 if (clip_star.state == SELECT_DONE)
2818 clip_copy_modeless_selection(TRUE);
2819 continue;
2820#endif
2821 default: /* no valid response */
2822 msg_moremsg(TRUE);
2823 continue;
2824 }
2825
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002826 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002827 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002828 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002829 {
2830 /* go to start of last line */
2831 if (mp_last == NULL)
2832 mp = msg_sb_start(last_msgchunk);
2833 else if (mp_last->sb_prev != NULL)
2834 mp = msg_sb_start(mp_last->sb_prev);
2835 else
2836 mp = NULL;
2837
2838 /* go to start of line at top of the screen */
2839 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2840 ++i)
2841 mp = msg_sb_start(mp->sb_prev);
2842
2843 if (mp != NULL && mp->sb_prev != NULL)
2844 {
2845 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002846 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002847 {
2848 if (mp == NULL || mp->sb_prev == NULL)
2849 break;
2850 mp = msg_sb_start(mp->sb_prev);
2851 if (mp_last == NULL)
2852 mp_last = msg_sb_start(last_msgchunk);
2853 else
2854 mp_last = msg_sb_start(mp_last->sb_prev);
2855 }
2856
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002857 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002858 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002859 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002860 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002861 (void)disp_sb_line(0, mp);
2862 }
2863 else
2864 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002865 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002866 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002867 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2868 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002869 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002870 ++msg_scrolled;
2871 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002872 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002873 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002874 }
2875 }
2876 else
2877 {
2878 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002879 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002880 {
2881 /* scroll up, display line at bottom */
2882 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002883 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002884 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2885 (int)Columns, ' ', ' ', 0);
2886 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002887 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002888 }
2889 }
2890
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002891 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002892 {
2893 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002894 screen_fill((int)Rows - 1, (int)Rows, 0,
2895 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002896 msg_moremsg(FALSE);
2897 continue;
2898 }
2899
2900 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002901 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002902 }
2903
2904 break;
2905 }
2906
2907 /* clear the --more-- message */
2908 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2909 State = oldState;
2910#ifdef FEAT_MOUSE
2911 setmouse();
2912#endif
2913 if (quit_more)
2914 {
2915 msg_row = Rows - 1;
2916 msg_col = 0;
2917 }
2918#ifdef FEAT_RIGHTLEFT
2919 else if (cmdmsg_rl)
2920 msg_col = Columns - 1;
2921#endif
2922
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002923 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002924#ifdef FEAT_CON_DIALOG
2925 return retval;
2926#else
2927 return FALSE;
2928#endif
2929}
2930
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2932
2933#ifdef mch_errmsg
2934# undef mch_errmsg
2935#endif
2936#ifdef mch_msg
2937# undef mch_msg
2938#endif
2939
2940/*
2941 * Give an error message. To be used when the screen hasn't been initialized
2942 * yet. When stderr can't be used, collect error messages until the GUI has
2943 * started and they can be displayed in a message box.
2944 */
2945 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002946mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947{
Bram Moolenaar4f974752019-02-17 17:44:42 +01002948#if defined(MSWIN) && !defined(FEAT_GUI_MSWIN)
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002949 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002950 DWORD nwrite = 0;
2951 DWORD mode = 0;
2952 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
2953
2954 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
2955 && (int)GetConsoleCP() != enc_codepage)
2956 {
2957 WCHAR *w = enc_to_utf16((char_u *)str, &len);
2958
2959 WriteConsoleW(h, w, len, &nwrite, NULL);
2960 vim_free(w);
2961 }
2962 else
2963 {
2964 fprintf(stderr, "%s", str);
2965 }
2966#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 int len;
2968
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002969# if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 /* On Unix use stderr if it's a tty.
2971 * When not going to start the GUI also use stderr.
2972 * On Mac, when started from Finder, stderr is the console. */
2973 if (
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002974# ifdef UNIX
2975# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002977# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 isatty(2)
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002979# endif
2980# ifdef FEAT_GUI
2981 ||
2982# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983# endif
2984# ifdef FEAT_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 !(gui.in_use || gui.starting)
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002986# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 )
2988 {
2989 fprintf(stderr, "%s", str);
2990 return;
2991 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002992# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993
2994 /* avoid a delay for a message that isn't there */
2995 emsg_on_display = FALSE;
2996
2997 len = (int)STRLEN(str) + 1;
2998 if (error_ga.ga_growsize == 0)
2999 {
3000 error_ga.ga_growsize = 80;
3001 error_ga.ga_itemsize = 1;
3002 }
3003 if (ga_grow(&error_ga, len) == OK)
3004 {
3005 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3006 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003007# ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 /* remove CR characters, they are displayed */
3009 {
3010 char_u *p;
3011
3012 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3013 for (;;)
3014 {
3015 p = vim_strchr(p, '\r');
3016 if (p == NULL)
3017 break;
3018 *p = ' ';
3019 }
3020 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003021# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 --len; /* don't count the NUL at the end */
3023 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003025#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026}
3027
3028/*
3029 * Give a message. To be used when the screen hasn't been initialized yet.
3030 * When there is no tty, collect messages until the GUI has started and they
3031 * can be displayed in a message box.
3032 */
3033 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003034mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035{
Bram Moolenaar4f974752019-02-17 17:44:42 +01003036#if defined(MSWIN) && !defined(FEAT_GUI_MSWIN)
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003037 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003038 DWORD nwrite = 0;
3039 DWORD mode;
3040 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3041
3042
3043 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3044 && (int)GetConsoleCP() != enc_codepage)
3045 {
3046 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3047
3048 WriteConsoleW(h, w, len, &nwrite, NULL);
3049 vim_free(w);
3050 }
3051 else
3052 {
3053 printf("%s", str);
3054 }
3055#else
3056# if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3058 * uses mch_errmsg() when started from the desktop.
3059 * When not going to start the GUI also use stdout.
3060 * On Mac, when started from Finder, stderr is the console. */
3061 if (
3062# ifdef UNIX
Bram Moolenaard0573012017-10-28 21:11:06 +02003063# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3065# else
3066 isatty(2)
3067# endif
3068# ifdef FEAT_GUI
3069 ||
3070# endif
3071# endif
3072# ifdef FEAT_GUI
3073 !(gui.in_use || gui.starting)
3074# endif
3075 )
3076 {
3077 printf("%s", str);
3078 return;
3079 }
3080# endif
3081 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003082#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083}
3084#endif /* USE_MCH_ERRMSG */
3085
3086/*
3087 * Put a character on the screen at the current message position and advance
3088 * to the next position. Only for printable ASCII!
3089 */
3090 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003091msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092{
3093 msg_didout = TRUE; /* remember that line is not empty */
3094 screen_putchar(c, msg_row, msg_col, attr);
3095#ifdef FEAT_RIGHTLEFT
3096 if (cmdmsg_rl)
3097 {
3098 if (--msg_col == 0)
3099 {
3100 msg_col = Columns;
3101 ++msg_row;
3102 }
3103 }
3104 else
3105#endif
3106 {
3107 if (++msg_col >= Columns)
3108 {
3109 msg_col = 0;
3110 ++msg_row;
3111 }
3112 }
3113}
3114
3115 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003116msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003118 int attr;
3119 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120
Bram Moolenaar8820b482017-03-16 17:23:31 +01003121 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003122 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003124 screen_puts((char_u *)
3125 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3126 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127}
3128
3129/*
3130 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3131 * exmode_active.
3132 */
3133 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003134repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135{
3136 if (State == ASKMORE)
3137 {
3138 msg_moremsg(TRUE); /* display --more-- message again */
3139 msg_row = Rows - 1;
3140 }
3141#ifdef FEAT_CON_DIALOG
3142 else if (State == CONFIRM)
3143 {
3144 display_confirm_msg(); /* display ":confirm" message again */
3145 msg_row = Rows - 1;
3146 }
3147#endif
3148 else if (State == EXTERNCMD)
3149 {
3150 windgoto(msg_row, msg_col); /* put cursor back */
3151 }
3152 else if (State == HITRETURN || State == SETWSIZE)
3153 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003154 if (msg_row == Rows - 1)
3155 {
3156 /* Avoid drawing the "hit-enter" prompt below the previous one,
3157 * overwrite it. Esp. useful when regaining focus and a
3158 * FocusGained autocmd exists but didn't draw anything. */
3159 msg_didout = FALSE;
3160 msg_col = 0;
3161 msg_clr_eos();
3162 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 hit_return_msg();
3164 msg_row = Rows - 1;
3165 }
3166}
3167
3168/*
3169 * msg_check_screen - check if the screen is initialized.
3170 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3171 * While starting the GUI the terminal codes will be set for the GUI, but the
3172 * output goes to the terminal. Don't use the terminal codes then.
3173 */
3174 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003175msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176{
3177 if (!full_screen || !screen_valid(FALSE))
3178 return FALSE;
3179
3180 if (msg_row >= Rows)
3181 msg_row = Rows - 1;
3182 if (msg_col >= Columns)
3183 msg_col = Columns - 1;
3184 return TRUE;
3185}
3186
3187/*
3188 * Clear from current message position to end of screen.
3189 * Skip this when ":silent" was used, no need to clear for redirection.
3190 */
3191 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003192msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193{
3194 if (msg_silent == 0)
3195 msg_clr_eos_force();
3196}
3197
3198/*
3199 * Clear from current message position to end of screen.
3200 * Note: msg_col is not updated, so we remember the end of the message
3201 * for msg_check().
3202 */
3203 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003204msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205{
3206 if (msg_use_printf())
3207 {
3208 if (full_screen) /* only when termcap codes are valid */
3209 {
3210 if (*T_CD)
3211 out_str(T_CD); /* clear to end of display */
3212 else if (*T_CE)
3213 out_str(T_CE); /* clear to end of line */
3214 }
3215 }
3216 else
3217 {
3218#ifdef FEAT_RIGHTLEFT
3219 if (cmdmsg_rl)
3220 {
3221 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3222 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3223 }
3224 else
3225#endif
3226 {
3227 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3228 ' ', ' ', 0);
3229 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3230 }
3231 }
3232}
3233
3234/*
3235 * Clear the command line.
3236 */
3237 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003238msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239{
3240 msg_row = cmdline_row;
3241 msg_col = 0;
3242 msg_clr_eos_force();
3243}
3244
3245/*
3246 * end putting a message on the screen
3247 * call wait_return if the message does not fit in the available space
3248 * return TRUE if wait_return not called.
3249 */
3250 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003251msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252{
3253 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003254 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 * or the ruler option is set and we run into it,
3256 * we have to redraw the window.
3257 * Do not do this if we are abandoning the file or editing the command line.
3258 */
3259 if (!exiting && need_wait_return && !(State & CMDLINE))
3260 {
3261 wait_return(FALSE);
3262 return FALSE;
3263 }
3264 out_flush();
3265 return TRUE;
3266}
3267
3268/*
3269 * If the written message runs into the shown command or ruler, we have to
3270 * wait for hit-return and redraw the window later.
3271 */
3272 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003273msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274{
3275 if (msg_row == Rows - 1 && msg_col >= sc_col)
3276 {
3277 need_wait_return = TRUE;
3278 redraw_cmdline = TRUE;
3279 }
3280}
3281
3282/*
3283 * May write a string to the redirection file.
3284 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3285 */
3286 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003287redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288{
3289 char_u *s = str;
3290 static int cur_col = 0;
3291
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003292 /* Don't do anything for displaying prompts and the like. */
3293 if (redir_off)
3294 return;
3295
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003296 /* If 'verbosefile' is set prepare for writing in that file. */
3297 if (*p_vfile != NUL && verbose_fd == NULL)
3298 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003299
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003300 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 {
3302 /* If the string doesn't start with CR or NL, go to msg_col */
3303 if (*s != '\n' && *s != '\r')
3304 {
3305 while (cur_col < msg_col)
3306 {
3307#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003308 if (redir_execute)
3309 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003310 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003312 else if (redir_vname)
3313 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003314 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003316 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003318 if (verbose_fd != NULL)
3319 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 ++cur_col;
3321 }
3322 }
3323
3324#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003325 if (redir_execute)
3326 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003327 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003329 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003330 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331#endif
3332
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003333 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3335 {
3336#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003337 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003339 if (redir_fd != NULL)
3340 putc(*s, redir_fd);
3341 if (verbose_fd != NULL)
3342 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 if (*s == '\r' || *s == '\n')
3344 cur_col = 0;
3345 else if (*s == '\t')
3346 cur_col += (8 - cur_col % 8);
3347 else
3348 ++cur_col;
3349 ++s;
3350 }
3351
3352 if (msg_silent != 0) /* should update msg_col */
3353 msg_col = cur_col;
3354 }
3355}
3356
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003357 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003358redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003359{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003360 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003361#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003362 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003363#endif
3364 ;
3365}
3366
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003368 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003369 * Must always be called paired with verbose_leave()!
3370 */
3371 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003372verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003373{
3374 if (*p_vfile != NUL)
3375 ++msg_silent;
3376}
3377
3378/*
3379 * After giving verbose message.
3380 * Must always be called paired with verbose_enter()!
3381 */
3382 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003383verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003384{
3385 if (*p_vfile != NUL)
3386 if (--msg_silent < 0)
3387 msg_silent = 0;
3388}
3389
3390/*
3391 * Like verbose_enter() and set msg_scroll when displaying the message.
3392 */
3393 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003394verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003395{
3396 if (*p_vfile != NUL)
3397 ++msg_silent;
3398 else
3399 /* always scroll up, don't overwrite */
3400 msg_scroll = TRUE;
3401}
3402
3403/*
3404 * Like verbose_leave() and set cmdline_row when displaying the message.
3405 */
3406 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003407verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003408{
3409 if (*p_vfile != NUL)
3410 {
3411 if (--msg_silent < 0)
3412 msg_silent = 0;
3413 }
3414 else
3415 cmdline_row = msg_row;
3416}
3417
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003418/*
3419 * Called when 'verbosefile' is set: stop writing to the file.
3420 */
3421 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003422verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003423{
3424 if (verbose_fd != NULL)
3425 {
3426 fclose(verbose_fd);
3427 verbose_fd = NULL;
3428 }
3429 verbose_did_open = FALSE;
3430}
3431
3432/*
3433 * Open the file 'verbosefile'.
3434 * Return FAIL or OK.
3435 */
3436 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003437verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003438{
3439 if (verbose_fd == NULL && !verbose_did_open)
3440 {
3441 /* Only give the error message once. */
3442 verbose_did_open = TRUE;
3443
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003444 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003445 if (verbose_fd == NULL)
3446 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003447 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003448 return FAIL;
3449 }
3450 }
3451 return OK;
3452}
3453
3454/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 * Give a warning message (for searching).
3456 * Use 'w' highlighting and may repeat the message after redrawing
3457 */
3458 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003459give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460{
3461 /* Don't do this for ":silent". */
3462 if (msg_silent != 0)
3463 return;
3464
3465 /* Don't want a hit-enter prompt here. */
3466 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468#ifdef FEAT_EVAL
3469 set_vim_var_string(VV_WARNINGMSG, message, -1);
3470#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003471 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003473 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 else
3475 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003476 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003477 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 msg_didout = FALSE; /* overwrite this message */
3479 msg_nowait = TRUE; /* don't wait for this message */
3480 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003481
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 --no_wait_return;
3483}
3484
Bram Moolenaar113e1072019-01-20 15:30:40 +01003485#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003486 void
3487give_warning2(char_u *message, char_u *a1, int hl)
3488{
3489 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3490 give_warning(IObuff, hl);
3491}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003492#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003493
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494/*
3495 * Advance msg cursor to column "col".
3496 */
3497 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003498msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499{
3500 if (msg_silent != 0) /* nothing to advance to */
3501 {
3502 msg_col = col; /* for redirection, may fill it up later */
3503 return;
3504 }
3505 if (col >= Columns) /* not enough room */
3506 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003507#ifdef FEAT_RIGHTLEFT
3508 if (cmdmsg_rl)
3509 while (msg_col > Columns - col)
3510 msg_putchar(' ');
3511 else
3512#endif
3513 while (msg_col < col)
3514 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515}
3516
3517#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3518/*
3519 * Used for "confirm()" function, and the :confirm command prefix.
3520 * Versions which haven't got flexible dialogs yet, and console
3521 * versions, get this generic handler which uses the command line.
3522 *
3523 * type = one of:
3524 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3525 * title = title string (can be NULL for default)
3526 * (neither used in console dialogs at the moment)
3527 *
3528 * Format of the "buttons" string:
3529 * "Button1Name\nButton2Name\nButton3Name"
3530 * The first button should normally be the default/accept
3531 * The second button should be the 'Cancel' button
3532 * Other buttons- use your imagination!
3533 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3534 * different letter.
3535 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003537do_dialog(
3538 int type UNUSED,
3539 char_u *title UNUSED,
3540 char_u *message,
3541 char_u *buttons,
3542 int dfltbutton,
3543 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003544 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003545 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003546 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547{
3548 int oldState;
3549 int retval = 0;
3550 char_u *hotkeys;
3551 int c;
3552 int i;
3553
3554#ifndef NO_CONSOLE
3555 /* Don't output anything in silent mode ("ex -s") */
3556 if (silent_mode)
3557 return dfltbutton; /* return default option */
3558#endif
3559
3560#ifdef FEAT_GUI_DIALOG
3561 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3562 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3563 {
3564 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003565 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003566 /* avoid a hit-enter prompt without clearing the cmdline */
3567 need_wait_return = FALSE;
3568 emsg_on_display = FALSE;
3569 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570
3571 /* Flush output to avoid that further messages and redrawing is done
3572 * in the wrong order. */
3573 out_flush();
3574 gui_mch_update();
3575
3576 return c;
3577 }
3578#endif
3579
3580 oldState = State;
3581 State = CONFIRM;
3582#ifdef FEAT_MOUSE
3583 setmouse();
3584#endif
3585
3586 /*
3587 * Since we wait for a keypress, don't make the
3588 * user press RETURN as well afterwards.
3589 */
3590 ++no_wait_return;
3591 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3592
3593 if (hotkeys != NULL)
3594 {
3595 for (;;)
3596 {
3597 /* Get a typed character directly from the user. */
3598 c = get_keystroke();
3599 switch (c)
3600 {
3601 case CAR: /* User accepts default option */
3602 case NL:
3603 retval = dfltbutton;
3604 break;
3605 case Ctrl_C: /* User aborts/cancels */
3606 case ESC:
3607 retval = 0;
3608 break;
3609 default: /* Could be a hotkey? */
3610 if (c < 0) /* special keys are ignored here */
3611 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003612 if (c == ':' && ex_cmd)
3613 {
3614 retval = dfltbutton;
3615 ins_char_typebuf(':');
3616 break;
3617 }
3618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 /* Make the character lowercase, as chars in "hotkeys" are. */
3620 c = MB_TOLOWER(c);
3621 retval = 1;
3622 for (i = 0; hotkeys[i]; ++i)
3623 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 if (has_mbyte)
3625 {
3626 if ((*mb_ptr2char)(hotkeys + i) == c)
3627 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003628 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 }
3630 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 if (hotkeys[i] == c)
3632 break;
3633 ++retval;
3634 }
3635 if (hotkeys[i])
3636 break;
3637 /* No hotkey match, so keep waiting */
3638 continue;
3639 }
3640 break;
3641 }
3642
3643 vim_free(hotkeys);
3644 }
3645
3646 State = oldState;
3647#ifdef FEAT_MOUSE
3648 setmouse();
3649#endif
3650 --no_wait_return;
3651 msg_end_prompt();
3652
3653 return retval;
3654}
3655
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656/*
3657 * Copy one character from "*from" to "*to", taking care of multi-byte
3658 * characters. Return the length of the character in bytes.
3659 */
3660 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003661copy_char(
3662 char_u *from,
3663 char_u *to,
3664 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 int len;
3667 int c;
3668
3669 if (has_mbyte)
3670 {
3671 if (lowercase)
3672 {
3673 c = MB_TOLOWER((*mb_ptr2char)(from));
3674 return (*mb_char2bytes)(c, to);
3675 }
3676 else
3677 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003678 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 mch_memmove(to, from, (size_t)len);
3680 return len;
3681 }
3682 }
3683 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 {
3685 if (lowercase)
3686 *to = (char_u)TOLOWER_LOC(*from);
3687 else
3688 *to = *from;
3689 return 1;
3690 }
3691}
3692
3693/*
3694 * Format the dialog string, and display it at the bottom of
3695 * the screen. Return a string of hotkey chars (if defined) for
3696 * each 'button'. If a button has no hotkey defined, the first character of
3697 * the button is used.
3698 * The hotkeys can be multi-byte characters, but without combining chars.
3699 *
3700 * Returns an allocated string with hotkeys, or NULL for error.
3701 */
3702 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003703msg_show_console_dialog(
3704 char_u *message,
3705 char_u *buttons,
3706 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707{
3708 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003709#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 int lenhotkey = HOTK_LEN; /* count first button */
3711 char_u *hotk = NULL;
3712 char_u *msgp = NULL;
3713 char_u *hotkp = NULL;
3714 char_u *r;
3715 int copy;
3716#define HAS_HOTKEY_LEN 30
3717 char_u has_hotkey[HAS_HOTKEY_LEN];
3718 int first_hotkey = FALSE; /* first char of button is hotkey */
3719 int idx;
3720
3721 has_hotkey[0] = FALSE;
3722
3723 /*
3724 * First loop: compute the size of memory to allocate.
3725 * Second loop: copy to the allocated memory.
3726 */
3727 for (copy = 0; copy <= 1; ++copy)
3728 {
3729 r = buttons;
3730 idx = 0;
3731 while (*r)
3732 {
3733 if (*r == DLG_BUTTON_SEP)
3734 {
3735 if (copy)
3736 {
3737 *msgp++ = ',';
3738 *msgp++ = ' '; /* '\n' -> ', ' */
3739
3740 /* advance to next hotkey and set default hotkey */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003742 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003745 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 if (dfltbutton)
3747 --dfltbutton;
3748
3749 /* If no hotkey is specified first char is used. */
3750 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3751 first_hotkey = TRUE;
3752 }
3753 else
3754 {
3755 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3756 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3757 if (idx < HAS_HOTKEY_LEN - 1)
3758 has_hotkey[++idx] = FALSE;
3759 }
3760 }
3761 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3762 {
3763 if (*r == DLG_HOTKEY_CHAR)
3764 ++r;
3765 first_hotkey = FALSE;
3766 if (copy)
3767 {
3768 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3769 *msgp++ = *r;
3770 else
3771 {
3772 /* '&a' -> '[a]' */
3773 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3774 msgp += copy_char(r, msgp, FALSE);
3775 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3776
3777 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003778 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 }
3780 }
3781 else
3782 {
3783 ++len; /* '&a' -> '[a]' */
3784 if (idx < HAS_HOTKEY_LEN - 1)
3785 has_hotkey[idx] = TRUE;
3786 }
3787 }
3788 else
3789 {
3790 /* everything else copy literally */
3791 if (copy)
3792 msgp += copy_char(r, msgp, FALSE);
3793 }
3794
3795 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003796 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 }
3798
3799 if (copy)
3800 {
3801 *msgp++ = ':';
3802 *msgp++ = ' ';
3803 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 }
3805 else
3806 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003807 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003808 + 2 /* for the NL's */
3809 + STRLEN(buttons)
3810 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003811 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812
3813 /* If no hotkey is specified first char is used. */
3814 if (!has_hotkey[0])
3815 {
3816 first_hotkey = TRUE;
3817 len += 2; /* "x" -> "[x]" */
3818 }
3819
3820 /*
3821 * Now allocate and load the strings
3822 */
3823 vim_free(confirm_msg);
3824 confirm_msg = alloc(len);
3825 if (confirm_msg == NULL)
3826 return NULL;
3827 *confirm_msg = NUL;
3828 hotk = alloc(lenhotkey);
3829 if (hotk == NULL)
3830 return NULL;
3831
3832 *confirm_msg = '\n';
3833 STRCPY(confirm_msg + 1, message);
3834
3835 msgp = confirm_msg + 1 + STRLEN(message);
3836 hotkp = hotk;
3837
Bram Moolenaar6a516062007-07-05 08:11:42 +00003838 /* Define first default hotkey. Keep the hotkey string NUL
3839 * terminated to avoid reading past the end. */
3840 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841
3842 /* Remember where the choices start, displaying starts here when
3843 * "hotkp" typed at the more prompt. */
3844 confirm_msg_tail = msgp;
3845 *msgp++ = '\n';
3846 }
3847 }
3848
3849 display_confirm_msg();
3850 return hotk;
3851}
3852
3853/*
3854 * Display the ":confirm" message. Also called when screen resized.
3855 */
3856 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003857display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858{
3859 /* avoid that 'q' at the more prompt truncates the message here */
3860 ++confirm_msg_used;
3861 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003862 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 --confirm_msg_used;
3864}
3865
3866#endif /* FEAT_CON_DIALOG */
3867
3868#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3869
3870 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003871vim_dialog_yesno(
3872 int type,
3873 char_u *title,
3874 char_u *message,
3875 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876{
3877 if (do_dialog(type,
3878 title == NULL ? (char_u *)_("Question") : title,
3879 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003880 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 return VIM_YES;
3882 return VIM_NO;
3883}
3884
3885 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003886vim_dialog_yesnocancel(
3887 int type,
3888 char_u *title,
3889 char_u *message,
3890 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891{
3892 switch (do_dialog(type,
3893 title == NULL ? (char_u *)_("Question") : title,
3894 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003895 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 {
3897 case 1: return VIM_YES;
3898 case 2: return VIM_NO;
3899 }
3900 return VIM_CANCEL;
3901}
3902
3903 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003904vim_dialog_yesnoallcancel(
3905 int type,
3906 char_u *title,
3907 char_u *message,
3908 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909{
3910 switch (do_dialog(type,
3911 title == NULL ? (char_u *)"Question" : title,
3912 message,
3913 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003914 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 {
3916 case 1: return VIM_YES;
3917 case 2: return VIM_NO;
3918 case 3: return VIM_ALL;
3919 case 4: return VIM_DISCARDALL;
3920 }
3921 return VIM_CANCEL;
3922}
3923
3924#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3925
3926#if defined(FEAT_BROWSE) || defined(PROTO)
3927/*
3928 * Generic browse function. Calls gui_mch_browse() when possible.
3929 * Later this may pop-up a non-GUI file selector (external command?).
3930 */
3931 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003932do_browse(
3933 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3934 char_u *title, /* title for the window */
3935 char_u *dflt, /* default file name (may include directory) */
3936 char_u *ext, /* extension added */
3937 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003939 char_u *filter, /* file name filter */
3940 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941{
3942 char_u *fname;
3943 static char_u *last_dir = NULL; /* last used directory */
3944 char_u *tofree = NULL;
3945 int save_browse = cmdmod.browse;
3946
3947 /* Must turn off browse to avoid that autocommands will get the
3948 * flag too! */
3949 cmdmod.browse = FALSE;
3950
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003951 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003953 if (flags & BROWSE_DIR)
3954 title = (char_u *)_("Select Directory dialog");
3955 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 title = (char_u *)_("Save File dialog");
3957 else
3958 title = (char_u *)_("Open File dialog");
3959 }
3960
3961 /* When no directory specified, use default file name, default dir, buffer
3962 * dir, last dir or current dir */
3963 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3964 {
3965 if (mch_isdir(dflt)) /* default file name is a directory */
3966 {
3967 initdir = dflt;
3968 dflt = NULL;
3969 }
3970 else if (gettail(dflt) != dflt) /* default file name includes a path */
3971 {
3972 tofree = vim_strsave(dflt);
3973 if (tofree != NULL)
3974 {
3975 initdir = tofree;
3976 *gettail(initdir) = NUL;
3977 dflt = gettail(dflt);
3978 }
3979 }
3980 }
3981
3982 if (initdir == NULL || *initdir == NUL)
3983 {
3984 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003985 if (STRCMP(p_bsdir, "last") != 0
3986 && STRCMP(p_bsdir, "buffer") != 0
3987 && STRCMP(p_bsdir, "current") != 0
3988 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 initdir = p_bsdir;
3990 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003991 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 && buf != NULL && buf->b_ffname != NULL)
3993 {
3994 if (dflt == NULL || *dflt == NUL)
3995 dflt = gettail(curbuf->b_ffname);
3996 tofree = vim_strsave(curbuf->b_ffname);
3997 if (tofree != NULL)
3998 {
3999 initdir = tofree;
4000 *gettail(initdir) = NUL;
4001 }
4002 }
4003 /* When 'browsedir' is "last", use dir from last browse */
4004 else if (*p_bsdir == 'l')
4005 initdir = last_dir;
4006 /* When 'browsedir is "current", use current directory. This is the
4007 * default already, leave initdir empty. */
4008 }
4009
4010# ifdef FEAT_GUI
4011 if (gui.in_use) /* when this changes, also adjust f_has()! */
4012 {
4013 if (filter == NULL
4014# ifdef FEAT_EVAL
4015 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4016 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4017# endif
4018 )
4019 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004020 if (flags & BROWSE_DIR)
4021 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01004022# if defined(FEAT_GUI_GTK) || defined(MSWIN)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004023 /* For systems that have a directory dialog. */
4024 fname = gui_mch_browsedir(title, initdir);
4025# else
4026 /* Generic solution for selecting a directory: select a file and
4027 * remove the file name. */
4028 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4029# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004030# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004031 /* Win32 adds a dummy file name, others return an arbitrary file
4032 * name. GTK+ 2 returns only the directory, */
4033 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4034 {
4035 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004036 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004037
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004038 if (tail == fname)
4039 *tail++ = '.'; /* use current dir */
4040 *tail = NUL;
4041 }
4042# endif
4043 }
4044 else
4045 fname = gui_mch_browse(flags & BROWSE_SAVE,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004046 title, dflt, ext, initdir, (char_u *)_(filter));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047
4048 /* We hang around in the dialog for a while, the user might do some
4049 * things to our files. The Win32 dialog allows deleting or renaming
4050 * a file, check timestamps. */
4051 need_check_timestamps = TRUE;
4052 did_check_timestamps = FALSE;
4053 }
4054 else
4055# endif
4056 {
4057 /* TODO: non-GUI file selector here */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004058 emsg(_("E338: Sorry, no file browser in console mode"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 fname = NULL;
4060 }
4061
4062 /* keep the directory for next time */
4063 if (fname != NULL)
4064 {
4065 vim_free(last_dir);
4066 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004067 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 {
4069 *gettail(last_dir) = NUL;
4070 if (*last_dir == NUL)
4071 {
4072 /* filename only returned, must be in current dir */
4073 vim_free(last_dir);
4074 last_dir = alloc(MAXPATHL);
4075 if (last_dir != NULL)
4076 mch_dirname(last_dir, MAXPATHL);
4077 }
4078 }
4079 }
4080
4081 vim_free(tofree);
4082 cmdmod.browse = save_browse;
4083
4084 return fname;
4085}
4086#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004087
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004088#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004089static char *e_printf = N_("E766: Insufficient arguments for printf()");
4090
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004091/*
4092 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4093 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004094 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004095tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004096{
4097 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004098 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004099 int err = FALSE;
4100
4101 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004102 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004103 else
4104 {
4105 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004106 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004107 if (err)
4108 n = 0;
4109 }
4110 return n;
4111}
4112
4113/*
4114 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004115 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004116 * are not converted to a string.
4117 * If "tofree" is not NULL echo_string() is used. All types are converted to
4118 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004119 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004120 */
4121 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004122tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004123{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004124 int idx = *idxp - 1;
4125 char *s = NULL;
4126 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004127
4128 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004129 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004130 else
4131 {
4132 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004133 if (tofree != NULL)
4134 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4135 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004136 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004137 }
4138 return s;
4139}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004140
4141# ifdef FEAT_FLOAT
4142/*
4143 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4144 */
4145 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004146tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004147{
4148 int idx = *idxp - 1;
4149 double f = 0;
4150
4151 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004152 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004153 else
4154 {
4155 ++*idxp;
4156 if (tvs[idx].v_type == VAR_FLOAT)
4157 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004158 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004159 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004160 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004161 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004162 }
4163 return f;
4164}
4165# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004166#endif
4167
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004168#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004169/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004170 * Return the representation of infinity for printf() function:
4171 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4172 */
4173 static const char *
4174infinity_str(int positive,
4175 char fmt_spec,
4176 int force_sign,
4177 int space_for_positive)
4178{
4179 static const char *table[] =
4180 {
4181 "-inf", "inf", "+inf", " inf",
4182 "-INF", "INF", "+INF", " INF"
4183 };
4184 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4185
4186 if (ASCII_ISUPPER(fmt_spec))
4187 idx += 4;
4188 return table[idx];
4189}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004190#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004191
4192/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004193 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004194 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004195 * consistency.
4196 *
4197 * This code is based on snprintf.c - a portable implementation of snprintf
4198 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004199 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004200 * The original code, including useful comments, can be found here:
4201 * http://www.ijs.si/software/snprintf/
4202 *
4203 * This snprintf() only supports the following conversion specifiers:
4204 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4205 * with flags: '-', '+', ' ', '0' and '#'.
4206 * An asterisk is supported for field width as well as precision.
4207 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004208 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004209 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004210 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4211 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004212 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004213 * The locale is not used, the string is used as a byte string. This is only
4214 * relevant for double-byte encodings where the second byte may be '%'.
4215 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004216 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4217 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004218 *
4219 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004220 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004221 * is greater or equal to "str_m", not all characters from the result
4222 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4223 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004224 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004225 */
4226
4227/*
4228 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004229 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004230 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004231 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004232 */
4233
4234/* When generating prototypes all of this is skipped, cproto doesn't
4235 * understand this. */
4236#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004237
Bram Moolenaara800b422010-06-27 01:15:55 +02004238/* Like vim_vsnprintf() but append to the string. */
4239 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004240vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004241{
4242 va_list ap;
4243 int str_l;
4244 size_t len = STRLEN(str);
4245 size_t space;
4246
4247 if (str_m <= len)
4248 space = 0;
4249 else
4250 space = str_m - len;
4251 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004252 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004253 va_end(ap);
4254 return str_l;
4255}
Bram Moolenaara800b422010-06-27 01:15:55 +02004256
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004257 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004258vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004259{
4260 va_list ap;
4261 int str_l;
4262
4263 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004264 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004265 va_end(ap);
4266 return str_l;
4267}
4268
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004269 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004270vim_vsnprintf(
4271 char *str,
4272 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004273 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004274 va_list ap)
4275{
4276 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4277}
4278
4279 int
4280vim_vsnprintf_typval(
4281 char *str,
4282 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004283 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004284 va_list ap,
4285 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004286{
4287 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004288 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004289 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004290
4291 if (p == NULL)
4292 p = "";
4293 while (*p != NUL)
4294 {
4295 if (*p != '%')
4296 {
4297 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004298 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004299
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004300 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004301 if (str_l < str_m)
4302 {
4303 size_t avail = str_m - str_l;
4304
4305 mch_memmove(str + str_l, p, n > avail ? avail : n);
4306 }
4307 p += n;
4308 str_l += n;
4309 }
4310 else
4311 {
4312 size_t min_field_width = 0, precision = 0;
4313 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4314 int alternate_form = 0, force_sign = 0;
4315
4316 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4317 * ignored. */
4318 int space_for_positive = 1;
4319
4320 /* allowed values: \0, h, l, L */
4321 char length_modifier = '\0';
4322
4323 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004324# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004325# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004326 * That sounds reasonable to use as the maximum
4327 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004328# elif defined(FEAT_NUM64)
4329# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004330# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004331# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004332# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004333 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004334
4335 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004336 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004337
4338 /* natural field width of arg without padding and sign */
4339 size_t str_arg_l;
4340
4341 /* unsigned char argument value - only defined for c conversion.
4342 * N.B. standard explicitly states the char argument for the c
4343 * conversion is unsigned */
4344 unsigned char uchar_arg;
4345
4346 /* number of zeros to be inserted for numeric conversions as
4347 * required by the precision or minimal field width */
4348 size_t number_of_zeros_to_pad = 0;
4349
4350 /* index into tmp where zero padding is to be inserted */
4351 size_t zero_padding_insertion_ind = 0;
4352
4353 /* current conversion specifier character */
4354 char fmt_spec = '\0';
4355
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004356 /* buffer for 's' and 'S' specs */
4357 char_u *tofree = NULL;
4358
4359
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004360 p++; /* skip '%' */
4361
4362 /* parse flags */
4363 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4364 || *p == '#' || *p == '\'')
4365 {
4366 switch (*p)
4367 {
4368 case '0': zero_padding = 1; break;
4369 case '-': justify_left = 1; break;
4370 case '+': force_sign = 1; space_for_positive = 0; break;
4371 case ' ': force_sign = 1;
4372 /* If both the ' ' and '+' flags appear, the ' '
4373 * flag should be ignored */
4374 break;
4375 case '#': alternate_form = 1; break;
4376 case '\'': break;
4377 }
4378 p++;
4379 }
4380 /* If the '0' and '-' flags both appear, the '0' flag should be
4381 * ignored. */
4382
4383 /* parse field width */
4384 if (*p == '*')
4385 {
4386 int j;
4387
4388 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004389 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004390# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004391 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004392# endif
4393 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004394 if (j >= 0)
4395 min_field_width = j;
4396 else
4397 {
4398 min_field_width = -j;
4399 justify_left = 1;
4400 }
4401 }
4402 else if (VIM_ISDIGIT((int)(*p)))
4403 {
4404 /* size_t could be wider than unsigned int; make sure we treat
4405 * argument like common implementations do */
4406 unsigned int uj = *p++ - '0';
4407
4408 while (VIM_ISDIGIT((int)(*p)))
4409 uj = 10 * uj + (unsigned int)(*p++ - '0');
4410 min_field_width = uj;
4411 }
4412
4413 /* parse precision */
4414 if (*p == '.')
4415 {
4416 p++;
4417 precision_specified = 1;
4418 if (*p == '*')
4419 {
4420 int j;
4421
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004422 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004423# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004424 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004425# endif
4426 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004427 p++;
4428 if (j >= 0)
4429 precision = j;
4430 else
4431 {
4432 precision_specified = 0;
4433 precision = 0;
4434 }
4435 }
4436 else if (VIM_ISDIGIT((int)(*p)))
4437 {
4438 /* size_t could be wider than unsigned int; make sure we
4439 * treat argument like common implementations do */
4440 unsigned int uj = *p++ - '0';
4441
4442 while (VIM_ISDIGIT((int)(*p)))
4443 uj = 10 * uj + (unsigned int)(*p++ - '0');
4444 precision = uj;
4445 }
4446 }
4447
4448 /* parse 'h', 'l' and 'll' length modifiers */
4449 if (*p == 'h' || *p == 'l')
4450 {
4451 length_modifier = *p;
4452 p++;
4453 if (length_modifier == 'l' && *p == 'l')
4454 {
4455 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004456# ifdef FEAT_NUM64
4457 length_modifier = 'L';
4458# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004459 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004460# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004461 p++;
4462 }
4463 }
4464 fmt_spec = *p;
4465
4466 /* common synonyms: */
4467 switch (fmt_spec)
4468 {
4469 case 'i': fmt_spec = 'd'; break;
4470 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4471 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4472 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4473 default: break;
4474 }
4475
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004476# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4477 switch (fmt_spec)
4478 {
4479 case 'd': case 'u': case 'o': case 'x': case 'X':
4480 if (tvs != NULL && length_modifier == '\0')
4481 length_modifier = 'L';
4482 }
4483# endif
4484
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004485 /* get parameter value, do initial processing */
4486 switch (fmt_spec)
4487 {
4488 /* '%' and 'c' behave similar to 's' regarding flags and field
4489 * widths */
4490 case '%':
4491 case 'c':
4492 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004493 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004494 str_arg_l = 1;
4495 switch (fmt_spec)
4496 {
4497 case '%':
4498 str_arg = p;
4499 break;
4500
4501 case 'c':
4502 {
4503 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004504
4505 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004506# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004507 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004508# endif
4509 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004510 /* standard demands unsigned char */
4511 uchar_arg = (unsigned char)j;
4512 str_arg = (char *)&uchar_arg;
4513 break;
4514 }
4515
4516 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004517 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004518 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004519# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004520 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004521# endif
4522 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004523 if (str_arg == NULL)
4524 {
4525 str_arg = "[NULL]";
4526 str_arg_l = 6;
4527 }
4528 /* make sure not to address string beyond the specified
4529 * precision !!! */
4530 else if (!precision_specified)
4531 str_arg_l = strlen(str_arg);
4532 /* truncate string if necessary as requested by precision */
4533 else if (precision == 0)
4534 str_arg_l = 0;
4535 else
4536 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004537 /* Don't put the #if inside memchr(), it can be a
4538 * macro. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004539 /* memchr on HP does not like n > 2^31 !!! */
4540 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004541 precision <= (size_t)0x7fffffffL ? precision
4542 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004543 str_arg_l = (q == NULL) ? precision
4544 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004545 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004546 if (fmt_spec == 'S')
4547 {
4548 if (min_field_width != 0)
4549 min_field_width += STRLEN(str_arg)
4550 - mb_string2cells((char_u *)str_arg, -1);
4551 if (precision)
4552 {
4553 char_u *p1 = (char_u *)str_arg;
4554 size_t i;
4555
4556 for (i = 0; i < precision && *p1; i++)
4557 p1 += mb_ptr2len(p1);
4558
4559 str_arg_l = precision = p1 - (char_u *)str_arg;
4560 }
4561 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004562 break;
4563
4564 default:
4565 break;
4566 }
4567 break;
4568
Bram Moolenaar91984b92016-08-16 21:58:41 +02004569 case 'd': case 'u':
4570 case 'b': case 'B':
4571 case 'o':
4572 case 'x': case 'X':
4573 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004574 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004575 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004576 * imply the value is unsigned; d implies a signed
4577 * value */
4578
4579 /* 0 if numeric argument is zero (or if pointer is
4580 * NULL for 'p'), +1 if greater than zero (or nonzero
4581 * for unsigned arguments), -1 if negative (unsigned
4582 * argument is never negative) */
4583 int arg_sign = 0;
4584
4585 /* only defined for length modifier h, or for no
4586 * length modifiers */
4587 int int_arg = 0;
4588 unsigned int uint_arg = 0;
4589
4590 /* only defined for length modifier l */
4591 long int long_arg = 0;
4592 unsigned long int ulong_arg = 0;
4593
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004594# ifdef FEAT_NUM64
4595 /* only defined for length modifier ll */
4596 varnumber_T llong_arg = 0;
4597 uvarnumber_T ullong_arg = 0;
4598# endif
4599
Bram Moolenaare9997822016-08-28 16:03:38 +02004600 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004601 uvarnumber_T bin_arg = 0;
4602
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004603 /* pointer argument value -only defined for p
4604 * conversion */
4605 void *ptr_arg = NULL;
4606
4607 if (fmt_spec == 'p')
4608 {
4609 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004610 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004611# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004612 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4613 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004614# endif
4615 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004616 if (ptr_arg != NULL)
4617 arg_sign = 1;
4618 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004619 else if (fmt_spec == 'b' || fmt_spec == 'B')
4620 {
4621 bin_arg =
4622# if defined(FEAT_EVAL)
4623 tvs != NULL ?
4624 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4625# endif
4626 va_arg(ap, uvarnumber_T);
4627 if (bin_arg != 0)
4628 arg_sign = 1;
4629 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004630 else if (fmt_spec == 'd')
4631 {
4632 /* signed */
4633 switch (length_modifier)
4634 {
4635 case '\0':
4636 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004637 /* char and short arguments are passed as int. */
4638 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004639# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004640 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004641# endif
4642 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004643 if (int_arg > 0)
4644 arg_sign = 1;
4645 else if (int_arg < 0)
4646 arg_sign = -1;
4647 break;
4648 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004649 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004650# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004651 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004652# endif
4653 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004654 if (long_arg > 0)
4655 arg_sign = 1;
4656 else if (long_arg < 0)
4657 arg_sign = -1;
4658 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004659# ifdef FEAT_NUM64
4660 case 'L':
4661 llong_arg =
4662# if defined(FEAT_EVAL)
4663 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4664# endif
4665 va_arg(ap, varnumber_T);
4666 if (llong_arg > 0)
4667 arg_sign = 1;
4668 else if (llong_arg < 0)
4669 arg_sign = -1;
4670 break;
4671# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004672 }
4673 }
4674 else
4675 {
4676 /* unsigned */
4677 switch (length_modifier)
4678 {
4679 case '\0':
4680 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004681 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004682# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004683 tvs != NULL ? (unsigned)
4684 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004685# endif
4686 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004687 if (uint_arg != 0)
4688 arg_sign = 1;
4689 break;
4690 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004691 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004692# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004693 tvs != NULL ? (unsigned long)
4694 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004695# endif
4696 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004697 if (ulong_arg != 0)
4698 arg_sign = 1;
4699 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004700# ifdef FEAT_NUM64
4701 case 'L':
4702 ullong_arg =
4703# if defined(FEAT_EVAL)
4704 tvs != NULL ? (uvarnumber_T)
4705 tv_nr(tvs, &arg_idx) :
4706# endif
4707 va_arg(ap, uvarnumber_T);
4708 if (ullong_arg != 0)
4709 arg_sign = 1;
4710 break;
4711# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004712 }
4713 }
4714
4715 str_arg = tmp;
4716 str_arg_l = 0;
4717
4718 /* NOTE:
4719 * For d, i, u, o, x, and X conversions, if precision is
4720 * specified, the '0' flag should be ignored. This is so
4721 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4722 * FreeBSD, NetBSD; but not with Perl.
4723 */
4724 if (precision_specified)
4725 zero_padding = 0;
4726 if (fmt_spec == 'd')
4727 {
4728 if (force_sign && arg_sign >= 0)
4729 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4730 /* leave negative numbers for sprintf to handle, to
4731 * avoid handling tricky cases like (short int)-32768 */
4732 }
4733 else if (alternate_form)
4734 {
4735 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004736 && (fmt_spec == 'b' || fmt_spec == 'B'
4737 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004738 {
4739 tmp[str_arg_l++] = '0';
4740 tmp[str_arg_l++] = fmt_spec;
4741 }
4742 /* alternate form should have no effect for p
4743 * conversion, but ... */
4744 }
4745
4746 zero_padding_insertion_ind = str_arg_l;
4747 if (!precision_specified)
4748 precision = 1; /* default precision is 1 */
4749 if (precision == 0 && arg_sign == 0)
4750 {
4751 /* When zero value is formatted with an explicit
4752 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004753 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004754 }
4755 else
4756 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004757 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004758 int f_l = 0;
4759
4760 /* construct a simple format string for sprintf */
4761 f[f_l++] = '%';
4762 if (!length_modifier)
4763 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004764 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004765 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004766# ifdef FEAT_NUM64
Bram Moolenaar4f974752019-02-17 17:44:42 +01004767# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004768 f[f_l++] = 'I';
4769 f[f_l++] = '6';
4770 f[f_l++] = '4';
4771# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004772 f[f_l++] = 'l';
4773 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004774# endif
4775# else
4776 f[f_l++] = 'l';
4777# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004778 }
4779 else
4780 f[f_l++] = length_modifier;
4781 f[f_l++] = fmt_spec;
4782 f[f_l++] = '\0';
4783
4784 if (fmt_spec == 'p')
4785 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004786 else if (fmt_spec == 'b' || fmt_spec == 'B')
4787 {
4788 char b[8 * sizeof(uvarnumber_T)];
4789 size_t b_l = 0;
4790 uvarnumber_T bn = bin_arg;
4791
4792 do
4793 {
4794 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4795 bn >>= 1;
4796 }
4797 while (bn != 0);
4798
4799 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4800 str_arg_l += b_l;
4801 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004802 else if (fmt_spec == 'd')
4803 {
4804 /* signed */
4805 switch (length_modifier)
4806 {
4807 case '\0':
4808 case 'h': str_arg_l += sprintf(
4809 tmp + str_arg_l, f, int_arg);
4810 break;
4811 case 'l': str_arg_l += sprintf(
4812 tmp + str_arg_l, f, long_arg);
4813 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004814# ifdef FEAT_NUM64
4815 case 'L': str_arg_l += sprintf(
4816 tmp + str_arg_l, f, llong_arg);
4817 break;
4818# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004819 }
4820 }
4821 else
4822 {
4823 /* unsigned */
4824 switch (length_modifier)
4825 {
4826 case '\0':
4827 case 'h': str_arg_l += sprintf(
4828 tmp + str_arg_l, f, uint_arg);
4829 break;
4830 case 'l': str_arg_l += sprintf(
4831 tmp + str_arg_l, f, ulong_arg);
4832 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004833# ifdef FEAT_NUM64
4834 case 'L': str_arg_l += sprintf(
4835 tmp + str_arg_l, f, ullong_arg);
4836 break;
4837# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004838 }
4839 }
4840
4841 /* include the optional minus sign and possible
4842 * "0x" in the region before the zero padding
4843 * insertion point */
4844 if (zero_padding_insertion_ind < str_arg_l
4845 && tmp[zero_padding_insertion_ind] == '-')
4846 zero_padding_insertion_ind++;
4847 if (zero_padding_insertion_ind + 1 < str_arg_l
4848 && tmp[zero_padding_insertion_ind] == '0'
4849 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4850 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4851 zero_padding_insertion_ind += 2;
4852 }
4853
4854 {
4855 size_t num_of_digits = str_arg_l
4856 - zero_padding_insertion_ind;
4857
4858 if (alternate_form && fmt_spec == 'o'
4859 /* unless zero is already the first
4860 * character */
4861 && !(zero_padding_insertion_ind < str_arg_l
4862 && tmp[zero_padding_insertion_ind] == '0'))
4863 {
4864 /* assure leading zero for alternate-form
4865 * octal numbers */
4866 if (!precision_specified
4867 || precision < num_of_digits + 1)
4868 {
4869 /* precision is increased to force the
4870 * first character to be zero, except if a
4871 * zero value is formatted with an
4872 * explicit precision of zero */
4873 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004874 }
4875 }
4876 /* zero padding to specified precision? */
4877 if (num_of_digits < precision)
4878 number_of_zeros_to_pad = precision - num_of_digits;
4879 }
4880 /* zero padding to specified minimal field width? */
4881 if (!justify_left && zero_padding)
4882 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004883 int n = (int)(min_field_width - (str_arg_l
4884 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004885 if (n > 0)
4886 number_of_zeros_to_pad += n;
4887 }
4888 break;
4889 }
4890
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004891# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004892 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004893 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004894 case 'e':
4895 case 'E':
4896 case 'g':
4897 case 'G':
4898 {
4899 /* Floating point. */
4900 double f;
4901 double abs_f;
4902 char format[40];
4903 int l;
4904 int remove_trailing_zeroes = FALSE;
4905
4906 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004907# if defined(FEAT_EVAL)
4908 tvs != NULL ? tv_float(tvs, &arg_idx) :
4909# endif
4910 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004911 abs_f = f < 0 ? -f : f;
4912
4913 if (fmt_spec == 'g' || fmt_spec == 'G')
4914 {
4915 /* Would be nice to use %g directly, but it prints
4916 * "1.0" as "1", we don't want that. */
4917 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4918 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004919 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004920 else
4921 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4922 remove_trailing_zeroes = TRUE;
4923 }
4924
Bram Moolenaar04186092016-08-29 21:55:35 +02004925 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004926# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004927 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004928# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004929 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004930# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004931 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004932 {
4933 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004934 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4935 force_sign, space_for_positive));
4936 str_arg_l = STRLEN(tmp);
4937 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004938 }
4939 else
4940 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004941 if (isnan(f))
4942 {
4943 /* Not a number: nan or NAN */
4944 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4945 : "nan");
4946 str_arg_l = 3;
4947 zero_padding = 0;
4948 }
4949 else if (isinf(f))
4950 {
4951 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4952 force_sign, space_for_positive));
4953 str_arg_l = STRLEN(tmp);
4954 zero_padding = 0;
4955 }
4956 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004957 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004958 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004959 format[0] = '%';
4960 l = 1;
4961 if (force_sign)
4962 format[l++] = space_for_positive ? ' ' : '+';
4963 if (precision_specified)
4964 {
4965 size_t max_prec = TMP_LEN - 10;
4966
4967 /* Make sure we don't get more digits than we
4968 * have room for. */
4969 if ((fmt_spec == 'f' || fmt_spec == 'F')
4970 && abs_f > 1.0)
4971 max_prec -= (size_t)log10(abs_f);
4972 if (precision > max_prec)
4973 precision = max_prec;
4974 l += sprintf(format + l, ".%d", (int)precision);
4975 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02004976 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02004977 format[l + 1] = NUL;
4978
Bram Moolenaare9997822016-08-28 16:03:38 +02004979 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004980 }
Bram Moolenaar99922372016-08-27 15:26:35 +02004981
Bram Moolenaara7241f52008-06-24 20:39:31 +00004982 if (remove_trailing_zeroes)
4983 {
4984 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004985 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004986
4987 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02004988 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004989 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004990 else
4991 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004992 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004993 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004994 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004995 {
4996 /* Remove superfluous '+' and leading
4997 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004998 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004999 {
5000 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005001 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005002 --str_arg_l;
5003 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005004 i = (tp[1] == '-') ? 2 : 1;
5005 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005006 {
5007 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005008 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005009 --str_arg_l;
5010 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005011 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005012 }
5013 }
5014
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005015 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005016 /* Remove trailing zeroes, but keep the one
5017 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005018 while (tp > tmp + 2 && *tp == '0'
5019 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005020 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005021 STRMOVE(tp, tp + 1);
5022 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005023 --str_arg_l;
5024 }
5025 }
5026 else
5027 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005028 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005029
5030 /* Be consistent: some printf("%e") use 1.0e+12
5031 * and some 1.0e+012. Remove one zero in the last
5032 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005033 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005034 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005035 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5036 && tp[2] == '0'
5037 && vim_isdigit(tp[3])
5038 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005039 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005040 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005041 --str_arg_l;
5042 }
5043 }
5044 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005045 if (zero_padding && min_field_width > str_arg_l
5046 && (tmp[0] == '-' || force_sign))
5047 {
5048 /* padding 0's should be inserted after the sign */
5049 number_of_zeros_to_pad = min_field_width - str_arg_l;
5050 zero_padding_insertion_ind = 1;
5051 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005052 str_arg = tmp;
5053 break;
5054 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005055# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005056
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005057 default:
5058 /* unrecognized conversion specifier, keep format string
5059 * as-is */
5060 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005061 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005062 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005063 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005064
5065 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005066 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005067 str_arg = p;
5068 str_arg_l = 0;
5069 if (*p != NUL)
5070 str_arg_l++; /* include invalid conversion specifier
5071 unchanged if not at end-of-string */
5072 break;
5073 }
5074
5075 if (*p != NUL)
5076 p++; /* step over the just processed conversion specifier */
5077
5078 /* insert padding to the left as requested by min_field_width;
5079 * this does not include the zero padding in case of numerical
5080 * conversions*/
5081 if (!justify_left)
5082 {
5083 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005084 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005085
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005086 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005087 {
5088 if (str_l < str_m)
5089 {
5090 size_t avail = str_m - str_l;
5091
5092 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005093 (size_t)pn > avail ? avail
5094 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005095 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005096 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097 }
5098 }
5099
5100 /* zero padding as requested by the precision or by the minimal
5101 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005102 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005103 {
5104 /* will not copy first part of numeric right now, *
5105 * force it to be copied later in its entirety */
5106 zero_padding_insertion_ind = 0;
5107 }
5108 else
5109 {
5110 /* insert first part of numerics (sign or '0x') before zero
5111 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005112 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005113
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005114 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005115 {
5116 if (str_l < str_m)
5117 {
5118 size_t avail = str_m - str_l;
5119
5120 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005121 (size_t)zn > avail ? avail
5122 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005123 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005124 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005125 }
5126
5127 /* insert zero padding as requested by the precision or min
5128 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005129 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005130 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005131 {
5132 if (str_l < str_m)
5133 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005134 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005135
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005136 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005137 (size_t)zn > avail ? avail
5138 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005139 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005140 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005141 }
5142 }
5143
5144 /* insert formatted string
5145 * (or as-is conversion specifier for unknown conversions) */
5146 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005147 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005148
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005149 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005150 {
5151 if (str_l < str_m)
5152 {
5153 size_t avail = str_m - str_l;
5154
5155 mch_memmove(str + str_l,
5156 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005157 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005158 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005159 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005160 }
5161 }
5162
5163 /* insert right padding */
5164 if (justify_left)
5165 {
5166 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005167 int pn = (int)(min_field_width
5168 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005169
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005170 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005171 {
5172 if (str_l < str_m)
5173 {
5174 size_t avail = str_m - str_l;
5175
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005176 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005177 (size_t)pn > avail ? avail
5178 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005179 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005180 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005181 }
5182 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005183 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005184 }
5185 }
5186
5187 if (str_m > 0)
5188 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005189 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005190 * overwriting the last character (shouldn't happen, but just in case)
5191 * */
5192 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5193 }
5194
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005195 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005196 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005197
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005198 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005199 * character), that is, the number of characters that would have been
5200 * written to the buffer if it were large enough. */
5201 return (int)str_l;
5202}
5203
5204#endif /* PROTO */