blob: bf677d4508dc153f40ed9a6afbb50ccd97eeff3e [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,
Bram Moolenaar725310d2019-04-24 23:08:23 +02001597 int from, // TRUE for lhs of a mapping
1598 int maxlen) // screen columns, 0 for unlimeted
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599{
1600 char_u *str = strstart;
1601 int retval = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001602 char *text;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 int attr;
1604 int len;
1605
Bram Moolenaar8820b482017-03-16 17:23:31 +01001606 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 while (*str != NUL)
1608 {
1609 /* Leading and trailing spaces need to be displayed in <> form. */
1610 if ((str == strstart || str[1] == NUL) && *str == ' ')
1611 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001612 text = "<Space>";
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 ++str;
1614 }
1615 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001616 text = (char *)str2special(&str, from);
1617 len = vim_strsize((char_u *)text);
Bram Moolenaar725310d2019-04-24 23:08:23 +02001618 if (maxlen > 0 && retval + len >= maxlen)
1619 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 /* Highlight special keys */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001621 msg_puts_attr(text, len > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01001622 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 retval += len;
1624 }
1625 return retval;
1626}
1627
Bram Moolenaarbd743252010-10-20 21:23:33 +02001628#if defined(FEAT_EVAL) || defined(PROTO)
1629/*
1630 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1631 * strings, in an allocated string.
1632 */
1633 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001634str2special_save(
1635 char_u *str,
1636 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001637{
1638 garray_T ga;
1639 char_u *p = str;
1640
1641 ga_init2(&ga, 1, 40);
1642 while (*p != NUL)
1643 ga_concat(&ga, str2special(&p, is_lhs));
1644 ga_append(&ga, NUL);
1645 return (char_u *)ga.ga_data;
1646}
1647#endif
1648
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649/*
1650 * Return the printable string for the key codes at "*sp".
1651 * Used for translating the lhs or rhs of a mapping to printable chars.
1652 * Advances "sp" to the next code.
1653 */
1654 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001655str2special(
1656 char_u **sp,
1657 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658{
1659 int c;
1660 static char_u buf[7];
1661 char_u *str = *sp;
1662 int modifiers = 0;
1663 int special = FALSE;
1664
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 if (has_mbyte)
1666 {
1667 char_u *p;
1668
1669 /* Try to un-escape a multi-byte character. Return the un-escaped
1670 * string if it is a multi-byte character. */
1671 p = mb_unescape(sp);
1672 if (p != NULL)
1673 return p;
1674 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675
1676 c = *str;
1677 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1678 {
1679 if (str[1] == KS_MODIFIER)
1680 {
1681 modifiers = str[2];
1682 str += 3;
1683 c = *str;
1684 }
1685 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1686 {
1687 c = TO_SPECIAL(str[1], str[2]);
1688 str += 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 }
1690 if (IS_SPECIAL(c) || modifiers) /* special key */
1691 special = TRUE;
1692 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001694 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001696 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001697
1698 /* For multi-byte characters check for an illegal byte. */
1699 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1700 {
1701 transchar_nonprint(buf, c);
1702 *sp = str + 1;
1703 return buf;
1704 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001705 /* Since 'special' is TRUE the multi-byte character 'c' will be
1706 * processed by get_special_key_name() */
1707 c = (*mb_ptr2char)(str);
1708 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001710 else
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001711 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712
1713 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1714 * Use <Space> only for lhs of a mapping. */
1715 if (special || char2cells(c) > 1 || (from && c == ' '))
1716 return get_special_key_name(c, modifiers);
1717 buf[0] = c;
1718 buf[1] = NUL;
1719 return buf;
1720}
1721
1722/*
1723 * Translate a key sequence into special key names.
1724 */
1725 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001726str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727{
1728 char_u *s;
1729
1730 *buf = NUL;
1731 while (*sp)
1732 {
1733 s = str2special(&sp, FALSE);
1734 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1735 STRCAT(buf, s);
1736 }
1737}
1738
1739/*
1740 * print line for :print or :list command
1741 */
1742 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001743msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744{
1745 int c;
1746 int col = 0;
1747 int n_extra = 0;
1748 int c_extra = 0;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001749 int c_final = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 char_u *p_extra = NULL; /* init to make SASC shut up */
1751 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001752 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 char_u *trail = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 int l;
1755 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
Bram Moolenaardf177f62005-02-22 08:39:57 +00001757 if (curwin->w_p_list)
1758 list = TRUE;
1759
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001761 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 {
1763 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001764 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 --trail;
1766 }
1767
1768 /* output a space for an empty line, otherwise the line will be
1769 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001770 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 msg_putchar(' ');
1772
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001773 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001775 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 {
1777 --n_extra;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001778 if (n_extra == 0 && c_final)
1779 c = c_final;
1780 else if (c_extra)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 c = c_extra;
1782 else
1783 c = *p_extra++;
1784 }
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001785 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 {
1787 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001788 if (lcs_nbsp != NUL && list
1789 && (mb_ptr2char(s) == 160
1790 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001791 {
1792 mb_char2bytes(lcs_nbsp, buf);
1793 buf[(*mb_ptr2len)(buf)] = NUL;
1794 }
1795 else
1796 {
1797 mch_memmove(buf, s, (size_t)l);
1798 buf[l] = NUL;
1799 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001800 msg_puts((char *)buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 s += l;
1802 continue;
1803 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 else
1805 {
1806 attr = 0;
1807 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001808 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 {
1810 /* tab amount depends on current column */
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001811#ifdef FEAT_VARTABS
1812 n_extra = tabstop_padding(col, curbuf->b_p_ts,
1813 curbuf->b_p_vts_array) - 1;
1814#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001816#endif
Bram Moolenaardf177f62005-02-22 08:39:57 +00001817 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 {
1819 c = ' ';
1820 c_extra = ' ';
Bram Moolenaar83a52172019-01-16 22:41:54 +01001821 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 }
1823 else
1824 {
Bram Moolenaar83a52172019-01-16 22:41:54 +01001825 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 c_extra = lcs_tab2;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001827 c_final = lcs_tab3;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001828 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 }
1830 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001831 else if (c == 160 && list && lcs_nbsp != NUL)
1832 {
1833 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001834 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001835 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001836 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 {
1838 p_extra = (char_u *)"";
1839 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001840 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 n_extra = 1;
1842 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001843 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 --s;
1845 }
1846 else if (c != NUL && (n = byte2cells(c)) > 1)
1847 {
1848 n_extra = n - 1;
1849 p_extra = transchar_byte(c);
1850 c_extra = NUL;
Bram Moolenaar83a52172019-01-16 22:41:54 +01001851 c_final = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001853 /* Use special coloring to be able to distinguish <hex> from
1854 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001855 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 }
1857 else if (c == ' ' && trail != NULL && s > trail)
1858 {
1859 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001860 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001862 else if (c == ' ' && list && lcs_space != NUL)
1863 {
1864 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001865 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001866 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 }
1868
1869 if (c == NUL)
1870 break;
1871
1872 msg_putchar_attr(c, attr);
1873 col++;
1874 }
1875 msg_clr_eos();
1876}
1877
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878/*
1879 * Use screen_puts() to output one multi-byte character.
1880 * Return the pointer "s" advanced to the next character.
1881 */
1882 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001883screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884{
1885 int cw;
1886
1887 msg_didout = TRUE; /* remember that line is not empty */
1888 cw = (*mb_ptr2cells)(s);
1889 if (cw > 1 && (
1890#ifdef FEAT_RIGHTLEFT
1891 cmdmsg_rl ? msg_col <= 1 :
1892#endif
1893 msg_col == Columns - 1))
1894 {
1895 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001896 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 return s;
1898 }
1899
1900 screen_puts_len(s, l, msg_row, msg_col, attr);
1901#ifdef FEAT_RIGHTLEFT
1902 if (cmdmsg_rl)
1903 {
1904 msg_col -= cw;
1905 if (msg_col == 0)
1906 {
1907 msg_col = Columns;
1908 ++msg_row;
1909 }
1910 }
1911 else
1912#endif
1913 {
1914 msg_col += cw;
1915 if (msg_col >= Columns)
1916 {
1917 msg_col = 0;
1918 ++msg_row;
1919 }
1920 }
1921 return s + l;
1922}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923
1924/*
1925 * Output a string to the screen at position msg_row, msg_col.
1926 * Update msg_row and msg_col for the next message.
1927 */
1928 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001929msg_puts(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001931 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932}
1933
1934 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001935msg_puts_title(char *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001937 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938}
1939
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940/*
1941 * Show a message in such a way that it always fits in the line. Cut out a
1942 * part in the middle and replace it with "..." when necessary.
1943 * Does not handle multi-byte characters!
1944 */
1945 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001946msg_outtrans_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001948 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949}
1950
1951 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001952msg_outtrans_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953{
1954 int slen = len;
1955 int room;
1956
1957 room = Columns - msg_col;
1958 if (len > room && room >= 20)
1959 {
1960 slen = (room - 3) / 2;
1961 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001962 msg_puts_attr("...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 }
1964 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1965}
1966
1967/*
1968 * Basic function for writing a message with highlight attributes.
1969 */
1970 void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001971msg_puts_attr(char *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972{
1973 msg_puts_attr_len(s, -1, attr);
1974}
1975
1976/*
1977 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1978 * When "maxlen" is -1 there is no maximum length.
1979 * When "maxlen" is >= 0 the message is not put in the history.
1980 */
1981 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01001982msg_puts_attr_len(char *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 /*
1985 * If redirection is on, also write to the redirection file.
1986 */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001987 redir_write((char_u *)str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988
1989 /*
1990 * Don't print anything when using ":silent cmd".
1991 */
1992 if (msg_silent != 0)
1993 return;
1994
1995 /* if MSG_HIST flag set, add message to history */
1996 if ((attr & MSG_HIST) && maxlen < 0)
1997 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001998 add_msg_hist((char_u *)str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 attr &= ~MSG_HIST;
2000 }
2001
2002 /*
2003 * When writing something to the screen after it has scrolled, requires a
2004 * wait-return prompt later. Needed when scrolling, resetting
2005 * need_wait_return after some prompt, and then outputting something
2006 * without scrolling
2007 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002008 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 need_wait_return = TRUE;
2010 msg_didany = TRUE; /* remember that something was outputted */
2011
2012 /*
2013 * If there is no valid screen, use fprintf so we can see error messages.
2014 * If termcap is not active, we may be writing in an alternate console
2015 * window, cursor positioning may not work correctly (window size may be
2016 * different, e.g. for Win32 console) or we just don't know where the
2017 * cursor is.
2018 */
2019 if (msg_use_printf())
Bram Moolenaar32526b32019-01-19 17:43:09 +01002020 msg_puts_printf((char_u *)str, maxlen);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002021 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01002022 msg_puts_display((char_u *)str, maxlen, attr, FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002023}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002025/*
2026 * The display part of msg_puts_attr_len().
2027 * May be called recursively to display scroll-back text.
2028 */
2029 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002030msg_puts_display(
2031 char_u *str,
2032 int maxlen,
2033 int attr,
2034 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002035{
2036 char_u *s = str;
2037 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2038 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002039 int l;
2040 int cw;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002041 char_u *sb_str = str;
2042 int sb_col = msg_col;
2043 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002044 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045
2046 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002047 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 {
2049 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002050 * We are at the end of the screen line when:
2051 * - When outputting a newline.
2052 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002054 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055#ifdef FEAT_RIGHTLEFT
2056 cmdmsg_rl
2057 ? (
2058 msg_col <= 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002059 || (*s == TAB && msg_col <= 7)
2060 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 :
2062#endif
2063 (msg_col + t_col >= Columns - 1
2064 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002066 && msg_col + t_col >= Columns - 2)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002068 /*
2069 * The screen is scrolled up when at the last row (some terminals
2070 * scroll automatically, some don't. To avoid problems we scroll
2071 * ourselves).
2072 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002075 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002077 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 if (msg_no_more && lines_left == 0)
2079 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 /* Scroll the screen up one line. */
2082 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083
2084 msg_row = Rows - 2;
2085 if (msg_col >= Columns) /* can happen after screen resize */
2086 msg_col = Columns - 1;
2087
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002088 /* Display char in last column before showing more-prompt. */
2089 if (*s >= ' '
2090#ifdef FEAT_RIGHTLEFT
2091 && !cmdmsg_rl
2092#endif
2093 )
2094 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002095 if (has_mbyte)
2096 {
2097 if (enc_utf8 && maxlen >= 0)
2098 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002099 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002100 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002101 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002102 s = screen_puts_mbyte(s, l, attr);
2103 }
2104 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002105 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002106 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002107 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002108 else
2109 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002110
2111 if (p_more)
2112 /* store text for scrolling back */
2113 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2114
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002115 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002116 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 redraw_cmdline = TRUE;
2118 if (cmdline_row > 0 && !exmode_active)
2119 --cmdline_row;
2120
2121 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002122 * If screen is completely filled and 'more' is set then wait
2123 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002125 if (lines_left > 0)
2126 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002127 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 && !msg_no_more && !exmode_active)
2129 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002131 if (do_more_prompt(NUL))
2132 s = confirm_msg_tail;
2133#else
2134 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135#endif
2136 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002137 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002139
2140 /* When we displayed a char in last column need to check if there
2141 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002142 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002143 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 }
2145
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002146 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 || msg_col + t_col >= Columns
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 || (has_mbyte && (*mb_ptr2cells)(s) > 1
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002149 && msg_col + t_col >= Columns - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002150 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2151 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002153 t_puts(&t_col, t_s, s, attr);
2154
2155 if (wrap && p_more && !recurse)
2156 /* store text for scrolling back */
2157 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158
2159 if (*s == '\n') /* go to next line */
2160 {
2161 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002162#ifdef FEAT_RIGHTLEFT
2163 if (cmdmsg_rl)
2164 msg_col = Columns - 1;
2165 else
2166#endif
2167 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 if (++msg_row >= Rows) /* safety check */
2169 msg_row = Rows - 1;
2170 }
2171 else if (*s == '\r') /* go to column 0 */
2172 {
2173 msg_col = 0;
2174 }
2175 else if (*s == '\b') /* go to previous char */
2176 {
2177 if (msg_col)
2178 --msg_col;
2179 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002180 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 {
2182 do
2183 msg_screen_putchar(' ', attr);
2184 while (msg_col & 7);
2185 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002186 else if (*s == BELL) /* beep (from ":sh") */
2187 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 else
2189 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 if (has_mbyte)
2191 {
2192 cw = (*mb_ptr2cells)(s);
2193 if (enc_utf8 && maxlen >= 0)
2194 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002195 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002197 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 }
2199 else
2200 {
2201 cw = 1;
2202 l = 1;
2203 }
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002204
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 /* When drawing from right to left or when a double-wide character
2206 * doesn't fit, draw a single character here. Otherwise collect
2207 * characters and draw them all at once later. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 if (
2209# ifdef FEAT_RIGHTLEFT
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002210 cmdmsg_rl ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211# endif
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01002212 (cw > 1 && msg_col + t_col >= Columns - 1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 if (l > 1)
2215 s = screen_puts_mbyte(s, l, attr) - 1;
2216 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 msg_screen_putchar(*s, attr);
2218 }
2219 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 {
2221 /* postpone this character until later */
2222 if (t_col == 0)
2223 t_s = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 t_col += cw;
2225 s += l - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 }
2227 }
2228 ++s;
2229 }
2230
2231 /* output any postponed text */
2232 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002233 t_puts(&t_col, t_s, s, attr);
2234 if (p_more && !recurse)
2235 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236
2237 msg_check();
2238}
2239
2240/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002241 * Return TRUE when ":filter pattern" was used and "msg" does not match
2242 * "pattern".
2243 */
2244 int
2245message_filtered(char_u *msg)
2246{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002247 int match;
2248
2249 if (cmdmod.filter_regmatch.regprog == NULL)
2250 return FALSE;
2251 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2252 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002253}
2254
2255/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002256 * Scroll the screen up one line for displaying the next message line.
2257 */
2258 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002259msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002260{
2261#ifdef FEAT_GUI
2262 /* Remove the cursor before scrolling, ScreenLines[] is going
2263 * to become invalid. */
2264 if (gui.in_use)
2265 gui_undraw_cursor();
2266#endif
2267 /* scrolling up always works */
Bram Moolenaara338adc2018-01-31 20:51:47 +01002268 mch_disable_flush();
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002269 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL);
Bram Moolenaara338adc2018-01-31 20:51:47 +01002270 mch_enable_flush();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002271
2272 if (!can_clear((char_u *)" "))
2273 {
2274 /* Scrolling up doesn't result in the right background. Set the
2275 * background here. It's not efficient, but avoids that we have to do
2276 * it all over the code. */
2277 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2278
2279 /* Also clear the last char of the last but one line if it was not
2280 * cleared before to avoid a scroll-up. */
2281 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2282 screen_fill((int)Rows - 2, (int)Rows - 1,
2283 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2284 }
2285}
2286
2287/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002288 * Increment "msg_scrolled".
2289 */
2290 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002291inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002292{
2293#ifdef FEAT_EVAL
2294 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2295 {
2296 char_u *p = sourcing_name;
2297 char_u *tofree = NULL;
2298 int len;
2299
2300 /* v:scrollstart is empty, set it to the script/function name and line
2301 * number */
2302 if (p == NULL)
2303 p = (char_u *)_("Unknown");
2304 else
2305 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002306 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002307 tofree = alloc(len);
2308 if (tofree != NULL)
2309 {
2310 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2311 p, (long)sourcing_lnum);
2312 p = tofree;
2313 }
2314 }
2315 set_vim_var_string(VV_SCROLLSTART, p, -1);
2316 vim_free(tofree);
2317 }
2318#endif
2319 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002320 if (must_redraw < VALID)
2321 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002322}
2323
2324/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002325 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2326 * store the displayed text and remember where screen lines start.
2327 */
2328typedef struct msgchunk_S msgchunk_T;
2329struct msgchunk_S
2330{
2331 msgchunk_T *sb_next;
2332 msgchunk_T *sb_prev;
2333 char sb_eol; /* TRUE when line ends after this text */
2334 int sb_msg_col; /* column in which text starts */
2335 int sb_attr; /* text attributes */
2336 char_u sb_text[1]; /* text to be displayed, actually longer */
2337};
2338
2339static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2340
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002341static msgchunk_T *msg_sb_start(msgchunk_T *mps);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002342
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002343typedef enum {
2344 SB_CLEAR_NONE = 0,
2345 SB_CLEAR_ALL,
2346 SB_CLEAR_CMDLINE_BUSY,
2347 SB_CLEAR_CMDLINE_DONE
2348} sb_clear_T;
2349
2350/* When to clear text on next msg. */
2351static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002352
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002353/*
2354 * Store part of a printed message for displaying when scrolling back.
2355 */
2356 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002357store_sb_text(
2358 char_u **sb_str, /* start of string */
2359 char_u *s, /* just after string */
2360 int attr,
2361 int *sb_col,
2362 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002363{
2364 msgchunk_T *mp;
2365
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002366 if (do_clear_sb_text == SB_CLEAR_ALL
2367 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002368 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002369 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2370 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002371 }
2372
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002373 if (s > *sb_str)
2374 {
2375 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2376 if (mp != NULL)
2377 {
2378 mp->sb_eol = finish;
2379 mp->sb_msg_col = *sb_col;
2380 mp->sb_attr = attr;
2381 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2382
2383 if (last_msgchunk == NULL)
2384 {
2385 last_msgchunk = mp;
2386 mp->sb_prev = NULL;
2387 }
2388 else
2389 {
2390 mp->sb_prev = last_msgchunk;
2391 last_msgchunk->sb_next = mp;
2392 last_msgchunk = mp;
2393 }
2394 mp->sb_next = NULL;
2395 }
2396 }
2397 else if (finish && last_msgchunk != NULL)
2398 last_msgchunk->sb_eol = TRUE;
2399
2400 *sb_str = s;
2401 *sb_col = 0;
2402}
2403
2404/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002405 * Finished showing messages, clear the scroll-back text on the next message.
2406 */
2407 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002408may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002409{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002410 do_clear_sb_text = SB_CLEAR_ALL;
2411}
2412
2413/*
2414 * Starting to edit the command line, do not clear messages now.
2415 */
2416 void
2417sb_text_start_cmdline(void)
2418{
2419 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2420 msg_sb_eol();
2421}
2422
2423/*
2424 * Ending to edit the command line. Clear old lines but the last one later.
2425 */
2426 void
2427sb_text_end_cmdline(void)
2428{
2429 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002430}
2431
2432/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002433 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002434 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002435 * Called when redrawing the screen.
2436 */
2437 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002438clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002439{
2440 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002441 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002442
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002443 if (all)
2444 lastp = &last_msgchunk;
2445 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002446 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002447 if (last_msgchunk == NULL)
2448 return;
2449 lastp = &last_msgchunk->sb_prev;
2450 }
2451
2452 while (*lastp != NULL)
2453 {
2454 mp = (*lastp)->sb_prev;
2455 vim_free(*lastp);
2456 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002457 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002458}
2459
2460/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002461 * "g<" command.
2462 */
2463 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002464show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002465{
2466 msgchunk_T *mp;
2467
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002468 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002469 * weird, typing a command without output results in one line. */
2470 mp = msg_sb_start(last_msgchunk);
2471 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002472 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002473 else
2474 {
2475 do_more_prompt('G');
2476 wait_return(FALSE);
2477 }
2478}
2479
2480/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002481 * Move to the start of screen line in already displayed text.
2482 */
2483 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002484msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002485{
2486 msgchunk_T *mp = mps;
2487
2488 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2489 mp = mp->sb_prev;
2490 return mp;
2491}
2492
2493/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002494 * Mark the last message chunk as finishing the line.
2495 */
2496 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002497msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002498{
2499 if (last_msgchunk != NULL)
2500 last_msgchunk->sb_eol = TRUE;
2501}
2502
2503/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002504 * Display a screen line from previously displayed text at row "row".
2505 * Returns a pointer to the text for the next line (can be NULL).
2506 */
2507 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002508disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002509{
2510 msgchunk_T *mp = smp;
2511 char_u *p;
2512
2513 for (;;)
2514 {
2515 msg_row = row;
2516 msg_col = mp->sb_msg_col;
2517 p = mp->sb_text;
2518 if (*p == '\n') /* don't display the line break */
2519 ++p;
2520 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2521 if (mp->sb_eol || mp->sb_next == NULL)
2522 break;
2523 mp = mp->sb_next;
2524 }
2525 return mp->sb_next;
2526}
2527
2528/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 * Output any postponed text for msg_puts_attr_len().
2530 */
2531 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002532t_puts(
2533 int *t_col,
2534 char_u *t_s,
2535 char_u *s,
2536 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537{
2538 /* output postponed text */
2539 msg_didout = TRUE; /* remember that line is not empty */
2540 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002541 msg_col += *t_col;
2542 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 /* If the string starts with a composing character don't increment the
2544 * column position for it. */
2545 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2546 --msg_col;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 if (msg_col >= Columns)
2548 {
2549 msg_col = 0;
2550 ++msg_row;
2551 }
2552}
2553
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554/*
2555 * Returns TRUE when messages should be printed with mch_errmsg().
2556 * This is used when there is no valid screen, so we can see error messages.
2557 * If termcap is not active, we may be writing in an alternate console
2558 * window, cursor positioning may not work correctly (window size may be
2559 * different, e.g. for Win32 console) or we just don't know where the
2560 * cursor is.
2561 */
2562 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002563msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564{
2565 return (!msg_check_screen()
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002566#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2567# ifdef VIMDLL
2568 || (!gui.in_use && !termcap_active)
2569# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 || !termcap_active
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002571# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572#endif
2573 || (swapping_screen() && !termcap_active)
2574 );
2575}
2576
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002577/*
2578 * Print a message when there is no valid screen.
2579 */
2580 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002581msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002582{
2583 char_u *s = str;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002584 char_u *buf = NULL;
2585 char_u *p = s;
2586
Bram Moolenaar4f974752019-02-17 17:44:42 +01002587#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002588 if (!(silent_mode && p_verbose == 0))
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002589 mch_settmode(TMODE_COOK); /* handle CR and NL correctly */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002590#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002591 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002592 {
2593 if (!(silent_mode && p_verbose == 0))
2594 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002595 // NL --> CR NL translation (for Unix, not for "--version")
2596 if (*s == NL)
2597 {
2598 int n = (int)(s - p);
2599
2600 buf = alloc(n + 3);
2601 memcpy(buf, p, n);
2602 if (!info_message)
2603 buf[n++] = CAR;
Bram Moolenaar00590742019-02-15 21:06:09 +01002604 buf[n++] = NL;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002605 buf[n++] = NUL;
2606 if (info_message) // informative message, not an error
2607 mch_msg((char *)buf);
2608 else
2609 mch_errmsg((char *)buf);
2610 vim_free(buf);
2611 p = s + 1;
2612 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002613 }
2614
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002615 // primitive way to compute the current column
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002616#ifdef FEAT_RIGHTLEFT
2617 if (cmdmsg_rl)
2618 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002619 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002620 msg_col = Columns - 1;
2621 else
2622 --msg_col;
2623 }
2624 else
2625#endif
2626 {
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002627 if (*s == CAR || *s == NL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002628 msg_col = 0;
2629 else
2630 ++msg_col;
2631 }
2632 ++s;
2633 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002634
2635 if (*p != NUL && !(silent_mode && p_verbose == 0))
2636 {
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002637 int c = -1;
2638
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002639 if (maxlen > 0 && STRLEN(p) > (size_t)maxlen)
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002640 {
2641 c = p[maxlen];
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002642 p[maxlen] = 0;
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002643 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002644 if (info_message)
2645 mch_msg((char *)p);
2646 else
2647 mch_errmsg((char *)p);
Bram Moolenaar97c2c052019-02-22 13:42:07 +01002648 if (c != -1)
2649 p[maxlen] = c;
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002650 }
2651
2652 msg_didout = TRUE; // assume that line is not empty
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002653
Bram Moolenaar4f974752019-02-17 17:44:42 +01002654#ifdef MSWIN
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002655 if (!(silent_mode && p_verbose == 0))
2656 mch_settmode(TMODE_RAW);
2657#endif
2658}
2659
2660/*
2661 * Show the more-prompt and handle the user response.
2662 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002663 * When at hit-enter prompt "typed_char" is the already typed character,
2664 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002665 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2666 */
2667 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002668do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002669{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002670 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002671 int used_typed_char = typed_char;
2672 int oldState = State;
2673 int c;
2674#ifdef FEAT_CON_DIALOG
2675 int retval = FALSE;
2676#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002677 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002678 msgchunk_T *mp_last = NULL;
2679 msgchunk_T *mp;
2680 int i;
2681
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002682 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002683 * that case don't show another prompt. Also when at the hit-Enter prompt
2684 * and nothing was typed. */
2685 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002686 return FALSE;
2687 entered = TRUE;
2688
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002689 if (typed_char == 'G')
2690 {
2691 /* "g<": Find first line on the last page. */
2692 mp_last = msg_sb_start(last_msgchunk);
2693 for (i = 0; i < Rows - 2 && mp_last != NULL
2694 && mp_last->sb_prev != NULL; ++i)
2695 mp_last = msg_sb_start(mp_last->sb_prev);
2696 }
2697
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002698 State = ASKMORE;
2699#ifdef FEAT_MOUSE
2700 setmouse();
2701#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002702 if (typed_char == NUL)
2703 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002704 for (;;)
2705 {
2706 /*
2707 * Get a typed character directly from the user.
2708 */
2709 if (used_typed_char != NUL)
2710 {
2711 c = used_typed_char; /* was typed at hit-enter prompt */
2712 used_typed_char = NUL;
2713 }
2714 else
2715 c = get_keystroke();
2716
2717#if defined(FEAT_MENU) && defined(FEAT_GUI)
2718 if (c == K_MENU)
2719 {
2720 int idx = get_menu_index(current_menu, ASKMORE);
2721
2722 /* Used a menu. If it starts with CTRL-Y, it must
2723 * be a "Copy" for the clipboard. Otherwise
2724 * assume that we end */
2725 if (idx == MENU_INDEX_INVALID)
2726 continue;
2727 c = *current_menu->strings[idx];
2728 if (c != NUL && current_menu->strings[idx][1] != NUL)
2729 ins_typebuf(current_menu->strings[idx] + 1,
2730 current_menu->noremap[idx], 0, TRUE,
2731 current_menu->silent[idx]);
2732 }
2733#endif
2734
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002735 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002736 switch (c)
2737 {
2738 case BS: /* scroll one line back */
2739 case K_BS:
2740 case 'k':
2741 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002742 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002743 break;
2744
2745 case CAR: /* one extra line */
2746 case NL:
2747 case 'j':
2748 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002749 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002750 break;
2751
2752 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002753 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002754 break;
2755
2756 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002757 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002758 break;
2759
2760 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002761 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002762 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002763 break;
2764
2765 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002766 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002767 case K_PAGEDOWN:
2768 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002769 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002770 break;
2771
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002772 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002773 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002774 break;
2775
2776 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002777 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002778 lines_left = 999999;
2779 break;
2780
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002781 case ':': /* start new command line */
2782#ifdef FEAT_CON_DIALOG
2783 if (!confirm_msg_used)
2784#endif
2785 {
2786 /* Since got_int is set all typeahead will be flushed, but we
2787 * want to keep this ':', remember that in a special way. */
2788 typeahead_noflush(':');
Bram Moolenaar1d4754f2018-06-19 17:49:24 +02002789#ifdef FEAT_TERMINAL
2790 skip_term_loop = TRUE;
2791#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002792 cmdline_row = Rows - 1; /* put ':' on this line */
2793 skip_redraw = TRUE; /* skip redraw once */
2794 need_wait_return = FALSE; /* don't wait in main() */
2795 }
Bram Moolenaar2f40d122017-10-24 21:49:36 +02002796 /* FALLTHROUGH */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002797 case 'q': /* quit */
2798 case Ctrl_C:
2799 case ESC:
2800#ifdef FEAT_CON_DIALOG
2801 if (confirm_msg_used)
2802 {
2803 /* Jump to the choices of the dialog. */
2804 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002805 }
2806 else
2807#endif
2808 {
2809 got_int = TRUE;
2810 quit_more = TRUE;
2811 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002812 /* When there is some more output (wrapping line) display that
2813 * without another prompt. */
2814 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002815 break;
2816
2817#ifdef FEAT_CLIPBOARD
2818 case Ctrl_Y:
2819 /* Strange way to allow copying (yanking) a modeless
2820 * selection at the more prompt. Use CTRL-Y,
2821 * because the same is used in Cmdline-mode and at the
2822 * hit-enter prompt. However, scrolling one line up
2823 * might be expected... */
2824 if (clip_star.state == SELECT_DONE)
2825 clip_copy_modeless_selection(TRUE);
2826 continue;
2827#endif
2828 default: /* no valid response */
2829 msg_moremsg(TRUE);
2830 continue;
2831 }
2832
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002833 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002834 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002835 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002836 {
2837 /* go to start of last line */
2838 if (mp_last == NULL)
2839 mp = msg_sb_start(last_msgchunk);
2840 else if (mp_last->sb_prev != NULL)
2841 mp = msg_sb_start(mp_last->sb_prev);
2842 else
2843 mp = NULL;
2844
2845 /* go to start of line at top of the screen */
2846 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2847 ++i)
2848 mp = msg_sb_start(mp->sb_prev);
2849
2850 if (mp != NULL && mp->sb_prev != NULL)
2851 {
2852 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002853 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002854 {
2855 if (mp == NULL || mp->sb_prev == NULL)
2856 break;
2857 mp = msg_sb_start(mp->sb_prev);
2858 if (mp_last == NULL)
2859 mp_last = msg_sb_start(last_msgchunk);
2860 else
2861 mp_last = msg_sb_start(mp_last->sb_prev);
2862 }
2863
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002864 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaarcfce7172017-08-17 20:31:48 +02002865 (int)Rows, 0, NULL) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002866 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002867 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002868 (void)disp_sb_line(0, mp);
2869 }
2870 else
2871 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002872 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002873 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002874 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2875 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002876 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002877 ++msg_scrolled;
2878 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002879 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002880 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002881 }
2882 }
2883 else
2884 {
2885 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002886 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002887 {
2888 /* scroll up, display line at bottom */
2889 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002890 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002891 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2892 (int)Columns, ' ', ' ', 0);
2893 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002894 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002895 }
2896 }
2897
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002898 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002899 {
2900 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002901 screen_fill((int)Rows - 1, (int)Rows, 0,
2902 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002903 msg_moremsg(FALSE);
2904 continue;
2905 }
2906
2907 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002908 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002909 }
2910
2911 break;
2912 }
2913
2914 /* clear the --more-- message */
2915 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2916 State = oldState;
2917#ifdef FEAT_MOUSE
2918 setmouse();
2919#endif
2920 if (quit_more)
2921 {
2922 msg_row = Rows - 1;
2923 msg_col = 0;
2924 }
2925#ifdef FEAT_RIGHTLEFT
2926 else if (cmdmsg_rl)
2927 msg_col = Columns - 1;
2928#endif
2929
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002930 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002931#ifdef FEAT_CON_DIALOG
2932 return retval;
2933#else
2934 return FALSE;
2935#endif
2936}
2937
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2939
2940#ifdef mch_errmsg
2941# undef mch_errmsg
2942#endif
2943#ifdef mch_msg
2944# undef mch_msg
2945#endif
2946
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002947#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
2948 static void
2949mch_errmsg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01002951 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002952 DWORD nwrite = 0;
2953 DWORD mode = 0;
2954 HANDLE h = GetStdHandle(STD_ERROR_HANDLE);
2955
2956 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
2957 && (int)GetConsoleCP() != enc_codepage)
2958 {
2959 WCHAR *w = enc_to_utf16((char_u *)str, &len);
2960
2961 WriteConsoleW(h, w, len, &nwrite, NULL);
2962 vim_free(w);
2963 }
2964 else
2965 {
2966 fprintf(stderr, "%s", str);
2967 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002968}
2969#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002971/*
2972 * Give an error message. To be used when the screen hasn't been initialized
2973 * yet. When stderr can't be used, collect error messages until the GUI has
2974 * started and they can be displayed in a message box.
2975 */
2976 void
2977mch_errmsg(char *str)
2978{
2979#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
2980 int len;
2981#endif
2982
2983#if (defined(UNIX) || defined(FEAT_GUI)) && (!defined(ALWAYS_USE_GUI) || !defined(VIMDLL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 /* On Unix use stderr if it's a tty.
2985 * When not going to start the GUI also use stderr.
2986 * On Mac, when started from Finder, stderr is the console. */
2987 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002988# ifdef UNIX
2989# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002991# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 isatty(2)
2993# endif
2994# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002995 ||
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01002996# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02002997# endif
2998# ifdef FEAT_GUI
2999 !(gui.in_use || gui.starting)
3000# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 )
3002 {
3003 fprintf(stderr, "%s", str);
3004 return;
3005 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003006#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003008#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3009# ifdef VIMDLL
3010 if (!(gui.in_use || gui.starting))
3011# endif
3012 {
3013 mch_errmsg_c(str);
3014 return;
3015 }
3016#endif
3017
3018#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 /* avoid a delay for a message that isn't there */
3020 emsg_on_display = FALSE;
3021
3022 len = (int)STRLEN(str) + 1;
3023 if (error_ga.ga_growsize == 0)
3024 {
3025 error_ga.ga_growsize = 80;
3026 error_ga.ga_itemsize = 1;
3027 }
3028 if (ga_grow(&error_ga, len) == OK)
3029 {
3030 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3031 (char_u *)str, len);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003032# ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 /* remove CR characters, they are displayed */
3034 {
3035 char_u *p;
3036
3037 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3038 for (;;)
3039 {
3040 p = vim_strchr(p, '\r');
3041 if (p == NULL)
3042 break;
3043 *p = ' ';
3044 }
3045 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003046# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 --len; /* don't count the NUL at the end */
3048 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 }
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003050#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051}
3052
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003053#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3054 static void
3055mch_msg_c(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056{
Bram Moolenaar0f77d6a2019-02-14 20:55:09 +01003057 int len = (int)STRLEN(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003058 DWORD nwrite = 0;
3059 DWORD mode;
3060 HANDLE h = GetStdHandle(STD_OUTPUT_HANDLE);
3061
3062
3063 if (GetConsoleMode(h, &mode) && enc_codepage >= 0
3064 && (int)GetConsoleCP() != enc_codepage)
3065 {
3066 WCHAR *w = enc_to_utf16((char_u *)str, &len);
3067
3068 WriteConsoleW(h, w, len, &nwrite, NULL);
3069 vim_free(w);
3070 }
3071 else
3072 {
3073 printf("%s", str);
3074 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003075}
3076#endif
3077
3078/*
3079 * Give a message. To be used when the screen hasn't been initialized yet.
3080 * When there is no tty, collect messages until the GUI has started and they
3081 * can be displayed in a message box.
3082 */
3083 void
3084mch_msg(char *str)
3085{
3086#if (defined(UNIX) || defined(FEAT_GUI)) && (!defined(ALWAYS_USE_GUI) || !defined(VIMDLL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3088 * uses mch_errmsg() when started from the desktop.
3089 * When not going to start the GUI also use stdout.
3090 * On Mac, when started from Finder, stderr is the console. */
3091 if (
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003092# ifdef UNIX
3093# ifdef MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003095# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 isatty(2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098# ifdef FEAT_GUI
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003099 ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003101# endif
3102# ifdef FEAT_GUI
3103 !(gui.in_use || gui.starting)
3104# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 )
3106 {
3107 printf("%s", str);
3108 return;
3109 }
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003110#endif
3111
3112#if defined(MSWIN) && (!defined(FEAT_GUI_MSWIN) || defined(VIMDLL))
3113# ifdef VIMDLL
3114 if (!(gui.in_use || gui.starting))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02003116 {
3117 mch_msg_c(str);
3118 return;
3119 }
3120#endif
3121#if !defined(MSWIN) || defined(FEAT_GUI_MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 mch_errmsg(str);
Bram Moolenaar9b5c1fc2019-02-14 14:08:04 +01003123#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124}
3125#endif /* USE_MCH_ERRMSG */
3126
3127/*
3128 * Put a character on the screen at the current message position and advance
3129 * to the next position. Only for printable ASCII!
3130 */
3131 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003132msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133{
3134 msg_didout = TRUE; /* remember that line is not empty */
3135 screen_putchar(c, msg_row, msg_col, attr);
3136#ifdef FEAT_RIGHTLEFT
3137 if (cmdmsg_rl)
3138 {
3139 if (--msg_col == 0)
3140 {
3141 msg_col = Columns;
3142 ++msg_row;
3143 }
3144 }
3145 else
3146#endif
3147 {
3148 if (++msg_col >= Columns)
3149 {
3150 msg_col = 0;
3151 ++msg_row;
3152 }
3153 }
3154}
3155
3156 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003157msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003159 int attr;
3160 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161
Bram Moolenaar8820b482017-03-16 17:23:31 +01003162 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003163 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003165 screen_puts((char_u *)
3166 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3167 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168}
3169
3170/*
3171 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3172 * exmode_active.
3173 */
3174 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003175repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176{
3177 if (State == ASKMORE)
3178 {
3179 msg_moremsg(TRUE); /* display --more-- message again */
3180 msg_row = Rows - 1;
3181 }
3182#ifdef FEAT_CON_DIALOG
3183 else if (State == CONFIRM)
3184 {
3185 display_confirm_msg(); /* display ":confirm" message again */
3186 msg_row = Rows - 1;
3187 }
3188#endif
3189 else if (State == EXTERNCMD)
3190 {
3191 windgoto(msg_row, msg_col); /* put cursor back */
3192 }
3193 else if (State == HITRETURN || State == SETWSIZE)
3194 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003195 if (msg_row == Rows - 1)
3196 {
3197 /* Avoid drawing the "hit-enter" prompt below the previous one,
3198 * overwrite it. Esp. useful when regaining focus and a
3199 * FocusGained autocmd exists but didn't draw anything. */
3200 msg_didout = FALSE;
3201 msg_col = 0;
3202 msg_clr_eos();
3203 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 hit_return_msg();
3205 msg_row = Rows - 1;
3206 }
3207}
3208
3209/*
3210 * msg_check_screen - check if the screen is initialized.
3211 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3212 * While starting the GUI the terminal codes will be set for the GUI, but the
3213 * output goes to the terminal. Don't use the terminal codes then.
3214 */
3215 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003216msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217{
3218 if (!full_screen || !screen_valid(FALSE))
3219 return FALSE;
3220
3221 if (msg_row >= Rows)
3222 msg_row = Rows - 1;
3223 if (msg_col >= Columns)
3224 msg_col = Columns - 1;
3225 return TRUE;
3226}
3227
3228/*
3229 * Clear from current message position to end of screen.
3230 * Skip this when ":silent" was used, no need to clear for redirection.
3231 */
3232 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003233msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234{
3235 if (msg_silent == 0)
3236 msg_clr_eos_force();
3237}
3238
3239/*
3240 * Clear from current message position to end of screen.
3241 * Note: msg_col is not updated, so we remember the end of the message
3242 * for msg_check().
3243 */
3244 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003245msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246{
3247 if (msg_use_printf())
3248 {
3249 if (full_screen) /* only when termcap codes are valid */
3250 {
3251 if (*T_CD)
3252 out_str(T_CD); /* clear to end of display */
3253 else if (*T_CE)
3254 out_str(T_CE); /* clear to end of line */
3255 }
3256 }
3257 else
3258 {
3259#ifdef FEAT_RIGHTLEFT
3260 if (cmdmsg_rl)
3261 {
3262 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3263 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3264 }
3265 else
3266#endif
3267 {
3268 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3269 ' ', ' ', 0);
3270 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3271 }
3272 }
3273}
3274
3275/*
3276 * Clear the command line.
3277 */
3278 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003279msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280{
3281 msg_row = cmdline_row;
3282 msg_col = 0;
3283 msg_clr_eos_force();
3284}
3285
3286/*
3287 * end putting a message on the screen
3288 * call wait_return if the message does not fit in the available space
3289 * return TRUE if wait_return not called.
3290 */
3291 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003292msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293{
3294 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003295 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 * or the ruler option is set and we run into it,
3297 * we have to redraw the window.
3298 * Do not do this if we are abandoning the file or editing the command line.
3299 */
3300 if (!exiting && need_wait_return && !(State & CMDLINE))
3301 {
3302 wait_return(FALSE);
3303 return FALSE;
3304 }
3305 out_flush();
3306 return TRUE;
3307}
3308
3309/*
3310 * If the written message runs into the shown command or ruler, we have to
3311 * wait for hit-return and redraw the window later.
3312 */
3313 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003314msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315{
3316 if (msg_row == Rows - 1 && msg_col >= sc_col)
3317 {
3318 need_wait_return = TRUE;
3319 redraw_cmdline = TRUE;
3320 }
3321}
3322
3323/*
3324 * May write a string to the redirection file.
3325 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3326 */
3327 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003328redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329{
3330 char_u *s = str;
3331 static int cur_col = 0;
3332
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003333 /* Don't do anything for displaying prompts and the like. */
3334 if (redir_off)
3335 return;
3336
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003337 /* If 'verbosefile' is set prepare for writing in that file. */
3338 if (*p_vfile != NUL && verbose_fd == NULL)
3339 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003340
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003341 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 {
3343 /* If the string doesn't start with CR or NL, go to msg_col */
3344 if (*s != '\n' && *s != '\r')
3345 {
3346 while (cur_col < msg_col)
3347 {
3348#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003349 if (redir_execute)
3350 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003351 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003353 else if (redir_vname)
3354 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003355 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003357 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003359 if (verbose_fd != NULL)
3360 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 ++cur_col;
3362 }
3363 }
3364
3365#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003366 if (redir_execute)
3367 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003368 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003370 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003371 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372#endif
3373
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003374 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3376 {
3377#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003378 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003380 if (redir_fd != NULL)
3381 putc(*s, redir_fd);
3382 if (verbose_fd != NULL)
3383 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 if (*s == '\r' || *s == '\n')
3385 cur_col = 0;
3386 else if (*s == '\t')
3387 cur_col += (8 - cur_col % 8);
3388 else
3389 ++cur_col;
3390 ++s;
3391 }
3392
3393 if (msg_silent != 0) /* should update msg_col */
3394 msg_col = cur_col;
3395 }
3396}
3397
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003398 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003399redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003400{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003401 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003402#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003403 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003404#endif
3405 ;
3406}
3407
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003409 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003410 * Must always be called paired with verbose_leave()!
3411 */
3412 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003413verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003414{
3415 if (*p_vfile != NUL)
3416 ++msg_silent;
3417}
3418
3419/*
3420 * After giving verbose message.
3421 * Must always be called paired with verbose_enter()!
3422 */
3423 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003424verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003425{
3426 if (*p_vfile != NUL)
3427 if (--msg_silent < 0)
3428 msg_silent = 0;
3429}
3430
3431/*
3432 * Like verbose_enter() and set msg_scroll when displaying the message.
3433 */
3434 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003435verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003436{
3437 if (*p_vfile != NUL)
3438 ++msg_silent;
3439 else
3440 /* always scroll up, don't overwrite */
3441 msg_scroll = TRUE;
3442}
3443
3444/*
3445 * Like verbose_leave() and set cmdline_row when displaying the message.
3446 */
3447 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003448verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003449{
3450 if (*p_vfile != NUL)
3451 {
3452 if (--msg_silent < 0)
3453 msg_silent = 0;
3454 }
3455 else
3456 cmdline_row = msg_row;
3457}
3458
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003459/*
3460 * Called when 'verbosefile' is set: stop writing to the file.
3461 */
3462 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003463verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003464{
3465 if (verbose_fd != NULL)
3466 {
3467 fclose(verbose_fd);
3468 verbose_fd = NULL;
3469 }
3470 verbose_did_open = FALSE;
3471}
3472
3473/*
3474 * Open the file 'verbosefile'.
3475 * Return FAIL or OK.
3476 */
3477 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003478verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003479{
3480 if (verbose_fd == NULL && !verbose_did_open)
3481 {
3482 /* Only give the error message once. */
3483 verbose_did_open = TRUE;
3484
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003485 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003486 if (verbose_fd == NULL)
3487 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003488 semsg(_(e_notopen), p_vfile);
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003489 return FAIL;
3490 }
3491 }
3492 return OK;
3493}
3494
3495/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 * Give a warning message (for searching).
3497 * Use 'w' highlighting and may repeat the message after redrawing
3498 */
3499 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003500give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501{
3502 /* Don't do this for ":silent". */
3503 if (msg_silent != 0)
3504 return;
3505
3506 /* Don't want a hit-enter prompt here. */
3507 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003508
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509#ifdef FEAT_EVAL
3510 set_vim_var_string(VV_WARNINGMSG, message, -1);
3511#endif
Bram Moolenaard23a8232018-02-10 18:45:26 +01003512 VIM_CLEAR(keep_msg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003514 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 else
3516 keep_msg_attr = 0;
Bram Moolenaar32526b32019-01-19 17:43:09 +01003517 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003518 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 msg_didout = FALSE; /* overwrite this message */
3520 msg_nowait = TRUE; /* don't wait for this message */
3521 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003522
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 --no_wait_return;
3524}
3525
Bram Moolenaar113e1072019-01-20 15:30:40 +01003526#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003527 void
3528give_warning2(char_u *message, char_u *a1, int hl)
3529{
3530 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3531 give_warning(IObuff, hl);
3532}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003533#endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535/*
3536 * Advance msg cursor to column "col".
3537 */
3538 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003539msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540{
3541 if (msg_silent != 0) /* nothing to advance to */
3542 {
3543 msg_col = col; /* for redirection, may fill it up later */
3544 return;
3545 }
3546 if (col >= Columns) /* not enough room */
3547 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003548#ifdef FEAT_RIGHTLEFT
3549 if (cmdmsg_rl)
3550 while (msg_col > Columns - col)
3551 msg_putchar(' ');
3552 else
3553#endif
3554 while (msg_col < col)
3555 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556}
3557
3558#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3559/*
3560 * Used for "confirm()" function, and the :confirm command prefix.
3561 * Versions which haven't got flexible dialogs yet, and console
3562 * versions, get this generic handler which uses the command line.
3563 *
3564 * type = one of:
3565 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3566 * title = title string (can be NULL for default)
3567 * (neither used in console dialogs at the moment)
3568 *
3569 * Format of the "buttons" string:
3570 * "Button1Name\nButton2Name\nButton3Name"
3571 * The first button should normally be the default/accept
3572 * The second button should be the 'Cancel' button
3573 * Other buttons- use your imagination!
3574 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3575 * different letter.
3576 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003578do_dialog(
3579 int type UNUSED,
3580 char_u *title UNUSED,
3581 char_u *message,
3582 char_u *buttons,
3583 int dfltbutton,
3584 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003585 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003586 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003587 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588{
3589 int oldState;
3590 int retval = 0;
3591 char_u *hotkeys;
3592 int c;
3593 int i;
3594
3595#ifndef NO_CONSOLE
3596 /* Don't output anything in silent mode ("ex -s") */
3597 if (silent_mode)
3598 return dfltbutton; /* return default option */
3599#endif
3600
3601#ifdef FEAT_GUI_DIALOG
3602 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3603 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3604 {
3605 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003606 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003607 /* avoid a hit-enter prompt without clearing the cmdline */
3608 need_wait_return = FALSE;
3609 emsg_on_display = FALSE;
3610 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611
3612 /* Flush output to avoid that further messages and redrawing is done
3613 * in the wrong order. */
3614 out_flush();
3615 gui_mch_update();
3616
3617 return c;
3618 }
3619#endif
3620
3621 oldState = State;
3622 State = CONFIRM;
3623#ifdef FEAT_MOUSE
3624 setmouse();
3625#endif
3626
3627 /*
3628 * Since we wait for a keypress, don't make the
3629 * user press RETURN as well afterwards.
3630 */
3631 ++no_wait_return;
3632 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3633
3634 if (hotkeys != NULL)
3635 {
3636 for (;;)
3637 {
3638 /* Get a typed character directly from the user. */
3639 c = get_keystroke();
3640 switch (c)
3641 {
3642 case CAR: /* User accepts default option */
3643 case NL:
3644 retval = dfltbutton;
3645 break;
3646 case Ctrl_C: /* User aborts/cancels */
3647 case ESC:
3648 retval = 0;
3649 break;
3650 default: /* Could be a hotkey? */
3651 if (c < 0) /* special keys are ignored here */
3652 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003653 if (c == ':' && ex_cmd)
3654 {
3655 retval = dfltbutton;
3656 ins_char_typebuf(':');
3657 break;
3658 }
3659
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 /* Make the character lowercase, as chars in "hotkeys" are. */
3661 c = MB_TOLOWER(c);
3662 retval = 1;
3663 for (i = 0; hotkeys[i]; ++i)
3664 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 if (has_mbyte)
3666 {
3667 if ((*mb_ptr2char)(hotkeys + i) == c)
3668 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003669 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 }
3671 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 if (hotkeys[i] == c)
3673 break;
3674 ++retval;
3675 }
3676 if (hotkeys[i])
3677 break;
3678 /* No hotkey match, so keep waiting */
3679 continue;
3680 }
3681 break;
3682 }
3683
3684 vim_free(hotkeys);
3685 }
3686
3687 State = oldState;
3688#ifdef FEAT_MOUSE
3689 setmouse();
3690#endif
3691 --no_wait_return;
3692 msg_end_prompt();
3693
3694 return retval;
3695}
3696
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697/*
3698 * Copy one character from "*from" to "*to", taking care of multi-byte
3699 * characters. Return the length of the character in bytes.
3700 */
3701 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003702copy_char(
3703 char_u *from,
3704 char_u *to,
3705 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 int len;
3708 int c;
3709
3710 if (has_mbyte)
3711 {
3712 if (lowercase)
3713 {
3714 c = MB_TOLOWER((*mb_ptr2char)(from));
3715 return (*mb_char2bytes)(c, to);
3716 }
3717 else
3718 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003719 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 mch_memmove(to, from, (size_t)len);
3721 return len;
3722 }
3723 }
3724 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 {
3726 if (lowercase)
3727 *to = (char_u)TOLOWER_LOC(*from);
3728 else
3729 *to = *from;
3730 return 1;
3731 }
3732}
3733
3734/*
3735 * Format the dialog string, and display it at the bottom of
3736 * the screen. Return a string of hotkey chars (if defined) for
3737 * each 'button'. If a button has no hotkey defined, the first character of
3738 * the button is used.
3739 * The hotkeys can be multi-byte characters, but without combining chars.
3740 *
3741 * Returns an allocated string with hotkeys, or NULL for error.
3742 */
3743 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003744msg_show_console_dialog(
3745 char_u *message,
3746 char_u *buttons,
3747 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748{
3749 int len = 0;
Bram Moolenaarfc3abf42019-01-24 15:54:21 +01003750#define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 int lenhotkey = HOTK_LEN; /* count first button */
3752 char_u *hotk = NULL;
3753 char_u *msgp = NULL;
3754 char_u *hotkp = NULL;
3755 char_u *r;
3756 int copy;
3757#define HAS_HOTKEY_LEN 30
3758 char_u has_hotkey[HAS_HOTKEY_LEN];
3759 int first_hotkey = FALSE; /* first char of button is hotkey */
3760 int idx;
3761
3762 has_hotkey[0] = FALSE;
3763
3764 /*
3765 * First loop: compute the size of memory to allocate.
3766 * Second loop: copy to the allocated memory.
3767 */
3768 for (copy = 0; copy <= 1; ++copy)
3769 {
3770 r = buttons;
3771 idx = 0;
3772 while (*r)
3773 {
3774 if (*r == DLG_BUTTON_SEP)
3775 {
3776 if (copy)
3777 {
3778 *msgp++ = ',';
3779 *msgp++ = ' '; /* '\n' -> ', ' */
3780
3781 /* advance to next hotkey and set default hotkey */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003783 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003786 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 if (dfltbutton)
3788 --dfltbutton;
3789
3790 /* If no hotkey is specified first char is used. */
3791 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3792 first_hotkey = TRUE;
3793 }
3794 else
3795 {
3796 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3797 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3798 if (idx < HAS_HOTKEY_LEN - 1)
3799 has_hotkey[++idx] = FALSE;
3800 }
3801 }
3802 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3803 {
3804 if (*r == DLG_HOTKEY_CHAR)
3805 ++r;
3806 first_hotkey = FALSE;
3807 if (copy)
3808 {
3809 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3810 *msgp++ = *r;
3811 else
3812 {
3813 /* '&a' -> '[a]' */
3814 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3815 msgp += copy_char(r, msgp, FALSE);
3816 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3817
3818 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003819 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 }
3821 }
3822 else
3823 {
3824 ++len; /* '&a' -> '[a]' */
3825 if (idx < HAS_HOTKEY_LEN - 1)
3826 has_hotkey[idx] = TRUE;
3827 }
3828 }
3829 else
3830 {
3831 /* everything else copy literally */
3832 if (copy)
3833 msgp += copy_char(r, msgp, FALSE);
3834 }
3835
3836 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003837 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 }
3839
3840 if (copy)
3841 {
3842 *msgp++ = ':';
3843 *msgp++ = ' ';
3844 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 }
3846 else
3847 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003848 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003849 + 2 /* for the NL's */
3850 + STRLEN(buttons)
3851 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003852 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853
3854 /* If no hotkey is specified first char is used. */
3855 if (!has_hotkey[0])
3856 {
3857 first_hotkey = TRUE;
3858 len += 2; /* "x" -> "[x]" */
3859 }
3860
3861 /*
3862 * Now allocate and load the strings
3863 */
3864 vim_free(confirm_msg);
3865 confirm_msg = alloc(len);
3866 if (confirm_msg == NULL)
3867 return NULL;
3868 *confirm_msg = NUL;
3869 hotk = alloc(lenhotkey);
3870 if (hotk == NULL)
3871 return NULL;
3872
3873 *confirm_msg = '\n';
3874 STRCPY(confirm_msg + 1, message);
3875
3876 msgp = confirm_msg + 1 + STRLEN(message);
3877 hotkp = hotk;
3878
Bram Moolenaar6a516062007-07-05 08:11:42 +00003879 /* Define first default hotkey. Keep the hotkey string NUL
3880 * terminated to avoid reading past the end. */
3881 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882
3883 /* Remember where the choices start, displaying starts here when
3884 * "hotkp" typed at the more prompt. */
3885 confirm_msg_tail = msgp;
3886 *msgp++ = '\n';
3887 }
3888 }
3889
3890 display_confirm_msg();
3891 return hotk;
3892}
3893
3894/*
3895 * Display the ":confirm" message. Also called when screen resized.
3896 */
3897 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003898display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899{
3900 /* avoid that 'q' at the more prompt truncates the message here */
3901 ++confirm_msg_used;
3902 if (confirm_msg != NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003903 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 --confirm_msg_used;
3905}
3906
3907#endif /* FEAT_CON_DIALOG */
3908
3909#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3910
3911 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003912vim_dialog_yesno(
3913 int type,
3914 char_u *title,
3915 char_u *message,
3916 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917{
3918 if (do_dialog(type,
3919 title == NULL ? (char_u *)_("Question") : title,
3920 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003921 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 return VIM_YES;
3923 return VIM_NO;
3924}
3925
3926 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003927vim_dialog_yesnocancel(
3928 int type,
3929 char_u *title,
3930 char_u *message,
3931 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932{
3933 switch (do_dialog(type,
3934 title == NULL ? (char_u *)_("Question") : title,
3935 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003936 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 {
3938 case 1: return VIM_YES;
3939 case 2: return VIM_NO;
3940 }
3941 return VIM_CANCEL;
3942}
3943
3944 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003945vim_dialog_yesnoallcancel(
3946 int type,
3947 char_u *title,
3948 char_u *message,
3949 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950{
3951 switch (do_dialog(type,
3952 title == NULL ? (char_u *)"Question" : title,
3953 message,
3954 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003955 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 {
3957 case 1: return VIM_YES;
3958 case 2: return VIM_NO;
3959 case 3: return VIM_ALL;
3960 case 4: return VIM_DISCARDALL;
3961 }
3962 return VIM_CANCEL;
3963}
3964
3965#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3966
3967#if defined(FEAT_BROWSE) || defined(PROTO)
3968/*
3969 * Generic browse function. Calls gui_mch_browse() when possible.
3970 * Later this may pop-up a non-GUI file selector (external command?).
3971 */
3972 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003973do_browse(
3974 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3975 char_u *title, /* title for the window */
3976 char_u *dflt, /* default file name (may include directory) */
3977 char_u *ext, /* extension added */
3978 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003980 char_u *filter, /* file name filter */
3981 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982{
3983 char_u *fname;
3984 static char_u *last_dir = NULL; /* last used directory */
3985 char_u *tofree = NULL;
3986 int save_browse = cmdmod.browse;
3987
3988 /* Must turn off browse to avoid that autocommands will get the
3989 * flag too! */
3990 cmdmod.browse = FALSE;
3991
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003992 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003994 if (flags & BROWSE_DIR)
3995 title = (char_u *)_("Select Directory dialog");
3996 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 title = (char_u *)_("Save File dialog");
3998 else
3999 title = (char_u *)_("Open File dialog");
4000 }
4001
4002 /* When no directory specified, use default file name, default dir, buffer
4003 * dir, last dir or current dir */
4004 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
4005 {
4006 if (mch_isdir(dflt)) /* default file name is a directory */
4007 {
4008 initdir = dflt;
4009 dflt = NULL;
4010 }
4011 else if (gettail(dflt) != dflt) /* default file name includes a path */
4012 {
4013 tofree = vim_strsave(dflt);
4014 if (tofree != NULL)
4015 {
4016 initdir = tofree;
4017 *gettail(initdir) = NUL;
4018 dflt = gettail(dflt);
4019 }
4020 }
4021 }
4022
4023 if (initdir == NULL || *initdir == NUL)
4024 {
4025 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004026 if (STRCMP(p_bsdir, "last") != 0
4027 && STRCMP(p_bsdir, "buffer") != 0
4028 && STRCMP(p_bsdir, "current") != 0
4029 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 initdir = p_bsdir;
4031 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004032 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 && buf != NULL && buf->b_ffname != NULL)
4034 {
4035 if (dflt == NULL || *dflt == NUL)
4036 dflt = gettail(curbuf->b_ffname);
4037 tofree = vim_strsave(curbuf->b_ffname);
4038 if (tofree != NULL)
4039 {
4040 initdir = tofree;
4041 *gettail(initdir) = NUL;
4042 }
4043 }
4044 /* When 'browsedir' is "last", use dir from last browse */
4045 else if (*p_bsdir == 'l')
4046 initdir = last_dir;
4047 /* When 'browsedir is "current", use current directory. This is the
4048 * default already, leave initdir empty. */
4049 }
4050
4051# ifdef FEAT_GUI
4052 if (gui.in_use) /* when this changes, also adjust f_has()! */
4053 {
4054 if (filter == NULL
4055# ifdef FEAT_EVAL
4056 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4057 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4058# endif
4059 )
4060 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004061 if (flags & BROWSE_DIR)
4062 {
Bram Moolenaar4f974752019-02-17 17:44:42 +01004063# if defined(FEAT_GUI_GTK) || defined(MSWIN)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004064 /* For systems that have a directory dialog. */
4065 fname = gui_mch_browsedir(title, initdir);
4066# else
4067 /* Generic solution for selecting a directory: select a file and
4068 * remove the file name. */
4069 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4070# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004071# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004072 /* Win32 adds a dummy file name, others return an arbitrary file
4073 * name. GTK+ 2 returns only the directory, */
4074 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4075 {
4076 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004077 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004078
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004079 if (tail == fname)
4080 *tail++ = '.'; /* use current dir */
4081 *tail = NUL;
4082 }
4083# endif
4084 }
4085 else
4086 fname = gui_mch_browse(flags & BROWSE_SAVE,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004087 title, dflt, ext, initdir, (char_u *)_(filter));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088
4089 /* We hang around in the dialog for a while, the user might do some
4090 * things to our files. The Win32 dialog allows deleting or renaming
4091 * a file, check timestamps. */
4092 need_check_timestamps = TRUE;
4093 did_check_timestamps = FALSE;
4094 }
4095 else
4096# endif
4097 {
4098 /* TODO: non-GUI file selector here */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004099 emsg(_("E338: Sorry, no file browser in console mode"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 fname = NULL;
4101 }
4102
4103 /* keep the directory for next time */
4104 if (fname != NULL)
4105 {
4106 vim_free(last_dir);
4107 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004108 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 {
4110 *gettail(last_dir) = NUL;
4111 if (*last_dir == NUL)
4112 {
4113 /* filename only returned, must be in current dir */
4114 vim_free(last_dir);
4115 last_dir = alloc(MAXPATHL);
4116 if (last_dir != NULL)
4117 mch_dirname(last_dir, MAXPATHL);
4118 }
4119 }
4120 }
4121
4122 vim_free(tofree);
4123 cmdmod.browse = save_browse;
4124
4125 return fname;
4126}
4127#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004128
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004129#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004130static char *e_printf = N_("E766: Insufficient arguments for printf()");
4131
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004132/*
4133 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4134 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004135 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004136tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004137{
4138 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004139 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004140 int err = FALSE;
4141
4142 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004143 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004144 else
4145 {
4146 ++*idxp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004147 n = tv_get_number_chk(&tvs[idx], &err);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004148 if (err)
4149 n = 0;
4150 }
4151 return n;
4152}
4153
4154/*
4155 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004156 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004157 * are not converted to a string.
4158 * If "tofree" is not NULL echo_string() is used. All types are converted to
4159 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004160 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004161 */
4162 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004163tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004164{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004165 int idx = *idxp - 1;
4166 char *s = NULL;
4167 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004168
4169 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004170 emsg(_(e_printf));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004171 else
4172 {
4173 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004174 if (tofree != NULL)
4175 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4176 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004177 s = (char *)tv_get_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004178 }
4179 return s;
4180}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004181
4182# ifdef FEAT_FLOAT
4183/*
4184 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4185 */
4186 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004187tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004188{
4189 int idx = *idxp - 1;
4190 double f = 0;
4191
4192 if (tvs[idx].v_type == VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004193 emsg(_(e_printf));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004194 else
4195 {
4196 ++*idxp;
4197 if (tvs[idx].v_type == VAR_FLOAT)
4198 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004199 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004200 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004201 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004202 emsg(_("E807: Expected Float argument for printf()"));
Bram Moolenaara7241f52008-06-24 20:39:31 +00004203 }
4204 return f;
4205}
4206# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004207#endif
4208
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004209#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004210/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004211 * Return the representation of infinity for printf() function:
4212 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4213 */
4214 static const char *
4215infinity_str(int positive,
4216 char fmt_spec,
4217 int force_sign,
4218 int space_for_positive)
4219{
4220 static const char *table[] =
4221 {
4222 "-inf", "inf", "+inf", " inf",
4223 "-INF", "INF", "+INF", " INF"
4224 };
4225 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4226
4227 if (ASCII_ISUPPER(fmt_spec))
4228 idx += 4;
4229 return table[idx];
4230}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004231#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004232
4233/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004234 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004235 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004236 * consistency.
4237 *
4238 * This code is based on snprintf.c - a portable implementation of snprintf
4239 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004240 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004241 * The original code, including useful comments, can be found here:
4242 * http://www.ijs.si/software/snprintf/
4243 *
4244 * This snprintf() only supports the following conversion specifiers:
4245 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4246 * with flags: '-', '+', ' ', '0' and '#'.
4247 * An asterisk is supported for field width as well as precision.
4248 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004249 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004250 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004251 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4252 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004253 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004254 * The locale is not used, the string is used as a byte string. This is only
4255 * relevant for double-byte encodings where the second byte may be '%'.
4256 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004257 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4258 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004259 *
4260 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004261 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004262 * is greater or equal to "str_m", not all characters from the result
4263 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4264 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004265 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004266 */
4267
4268/*
4269 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004270 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004271 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004272 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004273 */
4274
4275/* When generating prototypes all of this is skipped, cproto doesn't
4276 * understand this. */
4277#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004278
Bram Moolenaara800b422010-06-27 01:15:55 +02004279/* Like vim_vsnprintf() but append to the string. */
4280 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004281vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaara800b422010-06-27 01:15:55 +02004282{
4283 va_list ap;
4284 int str_l;
4285 size_t len = STRLEN(str);
4286 size_t space;
4287
4288 if (str_m <= len)
4289 space = 0;
4290 else
4291 space = str_m - len;
4292 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004293 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004294 va_end(ap);
4295 return str_l;
4296}
Bram Moolenaara800b422010-06-27 01:15:55 +02004297
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004298 int
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004299vim_snprintf(char *str, size_t str_m, const char *fmt, ...)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004300{
4301 va_list ap;
4302 int str_l;
4303
4304 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004305 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004306 va_end(ap);
4307 return str_l;
4308}
4309
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004310 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004311vim_vsnprintf(
4312 char *str,
4313 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004314 const char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004315 va_list ap)
4316{
4317 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4318}
4319
4320 int
4321vim_vsnprintf_typval(
4322 char *str,
4323 size_t str_m,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004324 const char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004325 va_list ap,
4326 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004327{
4328 size_t str_l = 0;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004329 const char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004330 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004331
4332 if (p == NULL)
4333 p = "";
4334 while (*p != NUL)
4335 {
4336 if (*p != '%')
4337 {
4338 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004339 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004340
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004341 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004342 if (str_l < str_m)
4343 {
4344 size_t avail = str_m - str_l;
4345
4346 mch_memmove(str + str_l, p, n > avail ? avail : n);
4347 }
4348 p += n;
4349 str_l += n;
4350 }
4351 else
4352 {
4353 size_t min_field_width = 0, precision = 0;
4354 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4355 int alternate_form = 0, force_sign = 0;
4356
4357 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4358 * ignored. */
4359 int space_for_positive = 1;
4360
4361 /* allowed values: \0, h, l, L */
4362 char length_modifier = '\0';
4363
4364 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004365# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004366# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004367 * That sounds reasonable to use as the maximum
4368 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004369# elif defined(FEAT_NUM64)
4370# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004371# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004372# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004373# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004374 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004375
4376 /* string address in case of string argument */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004377 const char *str_arg = NULL;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004378
4379 /* natural field width of arg without padding and sign */
4380 size_t str_arg_l;
4381
4382 /* unsigned char argument value - only defined for c conversion.
4383 * N.B. standard explicitly states the char argument for the c
4384 * conversion is unsigned */
4385 unsigned char uchar_arg;
4386
4387 /* number of zeros to be inserted for numeric conversions as
4388 * required by the precision or minimal field width */
4389 size_t number_of_zeros_to_pad = 0;
4390
4391 /* index into tmp where zero padding is to be inserted */
4392 size_t zero_padding_insertion_ind = 0;
4393
4394 /* current conversion specifier character */
4395 char fmt_spec = '\0';
4396
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004397 /* buffer for 's' and 'S' specs */
4398 char_u *tofree = NULL;
4399
4400
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004401 p++; /* skip '%' */
4402
4403 /* parse flags */
4404 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4405 || *p == '#' || *p == '\'')
4406 {
4407 switch (*p)
4408 {
4409 case '0': zero_padding = 1; break;
4410 case '-': justify_left = 1; break;
4411 case '+': force_sign = 1; space_for_positive = 0; break;
4412 case ' ': force_sign = 1;
4413 /* If both the ' ' and '+' flags appear, the ' '
4414 * flag should be ignored */
4415 break;
4416 case '#': alternate_form = 1; break;
4417 case '\'': break;
4418 }
4419 p++;
4420 }
4421 /* If the '0' and '-' flags both appear, the '0' flag should be
4422 * ignored. */
4423
4424 /* parse field width */
4425 if (*p == '*')
4426 {
4427 int j;
4428
4429 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004430 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004431# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004432 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004433# endif
4434 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004435 if (j >= 0)
4436 min_field_width = j;
4437 else
4438 {
4439 min_field_width = -j;
4440 justify_left = 1;
4441 }
4442 }
4443 else if (VIM_ISDIGIT((int)(*p)))
4444 {
4445 /* size_t could be wider than unsigned int; make sure we treat
4446 * argument like common implementations do */
4447 unsigned int uj = *p++ - '0';
4448
4449 while (VIM_ISDIGIT((int)(*p)))
4450 uj = 10 * uj + (unsigned int)(*p++ - '0');
4451 min_field_width = uj;
4452 }
4453
4454 /* parse precision */
4455 if (*p == '.')
4456 {
4457 p++;
4458 precision_specified = 1;
4459 if (*p == '*')
4460 {
4461 int j;
4462
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004463 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004464# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004465 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004466# endif
4467 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004468 p++;
4469 if (j >= 0)
4470 precision = j;
4471 else
4472 {
4473 precision_specified = 0;
4474 precision = 0;
4475 }
4476 }
4477 else if (VIM_ISDIGIT((int)(*p)))
4478 {
4479 /* size_t could be wider than unsigned int; make sure we
4480 * treat argument like common implementations do */
4481 unsigned int uj = *p++ - '0';
4482
4483 while (VIM_ISDIGIT((int)(*p)))
4484 uj = 10 * uj + (unsigned int)(*p++ - '0');
4485 precision = uj;
4486 }
4487 }
4488
4489 /* parse 'h', 'l' and 'll' length modifiers */
4490 if (*p == 'h' || *p == 'l')
4491 {
4492 length_modifier = *p;
4493 p++;
4494 if (length_modifier == 'l' && *p == 'l')
4495 {
4496 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004497# ifdef FEAT_NUM64
4498 length_modifier = 'L';
4499# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004500 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004501# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004502 p++;
4503 }
4504 }
4505 fmt_spec = *p;
4506
4507 /* common synonyms: */
4508 switch (fmt_spec)
4509 {
4510 case 'i': fmt_spec = 'd'; break;
4511 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4512 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4513 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4514 default: break;
4515 }
4516
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004517# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4518 switch (fmt_spec)
4519 {
4520 case 'd': case 'u': case 'o': case 'x': case 'X':
4521 if (tvs != NULL && length_modifier == '\0')
4522 length_modifier = 'L';
4523 }
4524# endif
4525
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004526 /* get parameter value, do initial processing */
4527 switch (fmt_spec)
4528 {
4529 /* '%' and 'c' behave similar to 's' regarding flags and field
4530 * widths */
4531 case '%':
4532 case 'c':
4533 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004534 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004535 str_arg_l = 1;
4536 switch (fmt_spec)
4537 {
4538 case '%':
4539 str_arg = p;
4540 break;
4541
4542 case 'c':
4543 {
4544 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004545
4546 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004547# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004548 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004549# endif
4550 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004551 /* standard demands unsigned char */
4552 uchar_arg = (unsigned char)j;
4553 str_arg = (char *)&uchar_arg;
4554 break;
4555 }
4556
4557 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004558 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004559 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004560# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004561 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004562# endif
4563 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004564 if (str_arg == NULL)
4565 {
4566 str_arg = "[NULL]";
4567 str_arg_l = 6;
4568 }
4569 /* make sure not to address string beyond the specified
4570 * precision !!! */
4571 else if (!precision_specified)
4572 str_arg_l = strlen(str_arg);
4573 /* truncate string if necessary as requested by precision */
4574 else if (precision == 0)
4575 str_arg_l = 0;
4576 else
4577 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004578 /* Don't put the #if inside memchr(), it can be a
4579 * macro. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004580 /* memchr on HP does not like n > 2^31 !!! */
4581 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004582 precision <= (size_t)0x7fffffffL ? precision
4583 : (size_t)0x7fffffffL);
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004584 str_arg_l = (q == NULL) ? precision
4585 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004586 }
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004587 if (fmt_spec == 'S')
4588 {
4589 if (min_field_width != 0)
4590 min_field_width += STRLEN(str_arg)
4591 - mb_string2cells((char_u *)str_arg, -1);
4592 if (precision)
4593 {
4594 char_u *p1 = (char_u *)str_arg;
4595 size_t i;
4596
4597 for (i = 0; i < precision && *p1; i++)
4598 p1 += mb_ptr2len(p1);
4599
4600 str_arg_l = precision = p1 - (char_u *)str_arg;
4601 }
4602 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004603 break;
4604
4605 default:
4606 break;
4607 }
4608 break;
4609
Bram Moolenaar91984b92016-08-16 21:58:41 +02004610 case 'd': case 'u':
4611 case 'b': case 'B':
4612 case 'o':
4613 case 'x': case 'X':
4614 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004615 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004616 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004617 * imply the value is unsigned; d implies a signed
4618 * value */
4619
4620 /* 0 if numeric argument is zero (or if pointer is
4621 * NULL for 'p'), +1 if greater than zero (or nonzero
4622 * for unsigned arguments), -1 if negative (unsigned
4623 * argument is never negative) */
4624 int arg_sign = 0;
4625
4626 /* only defined for length modifier h, or for no
4627 * length modifiers */
4628 int int_arg = 0;
4629 unsigned int uint_arg = 0;
4630
4631 /* only defined for length modifier l */
4632 long int long_arg = 0;
4633 unsigned long int ulong_arg = 0;
4634
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004635# ifdef FEAT_NUM64
4636 /* only defined for length modifier ll */
4637 varnumber_T llong_arg = 0;
4638 uvarnumber_T ullong_arg = 0;
4639# endif
4640
Bram Moolenaare9997822016-08-28 16:03:38 +02004641 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004642 uvarnumber_T bin_arg = 0;
4643
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004644 /* pointer argument value -only defined for p
4645 * conversion */
4646 void *ptr_arg = NULL;
4647
4648 if (fmt_spec == 'p')
4649 {
4650 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004651 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004652# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004653 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4654 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004655# endif
4656 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004657 if (ptr_arg != NULL)
4658 arg_sign = 1;
4659 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004660 else if (fmt_spec == 'b' || fmt_spec == 'B')
4661 {
4662 bin_arg =
4663# if defined(FEAT_EVAL)
4664 tvs != NULL ?
4665 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4666# endif
4667 va_arg(ap, uvarnumber_T);
4668 if (bin_arg != 0)
4669 arg_sign = 1;
4670 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004671 else if (fmt_spec == 'd')
4672 {
4673 /* signed */
4674 switch (length_modifier)
4675 {
4676 case '\0':
4677 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004678 /* char and short arguments are passed as int. */
4679 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004680# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004681 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004682# endif
4683 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004684 if (int_arg > 0)
4685 arg_sign = 1;
4686 else if (int_arg < 0)
4687 arg_sign = -1;
4688 break;
4689 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004690 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004691# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004692 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004693# endif
4694 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004695 if (long_arg > 0)
4696 arg_sign = 1;
4697 else if (long_arg < 0)
4698 arg_sign = -1;
4699 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004700# ifdef FEAT_NUM64
4701 case 'L':
4702 llong_arg =
4703# if defined(FEAT_EVAL)
4704 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4705# endif
4706 va_arg(ap, varnumber_T);
4707 if (llong_arg > 0)
4708 arg_sign = 1;
4709 else if (llong_arg < 0)
4710 arg_sign = -1;
4711 break;
4712# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004713 }
4714 }
4715 else
4716 {
4717 /* unsigned */
4718 switch (length_modifier)
4719 {
4720 case '\0':
4721 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004722 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004723# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004724 tvs != NULL ? (unsigned)
4725 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004726# endif
4727 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004728 if (uint_arg != 0)
4729 arg_sign = 1;
4730 break;
4731 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004732 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004733# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004734 tvs != NULL ? (unsigned long)
4735 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004736# endif
4737 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004738 if (ulong_arg != 0)
4739 arg_sign = 1;
4740 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004741# ifdef FEAT_NUM64
4742 case 'L':
4743 ullong_arg =
4744# if defined(FEAT_EVAL)
4745 tvs != NULL ? (uvarnumber_T)
4746 tv_nr(tvs, &arg_idx) :
4747# endif
4748 va_arg(ap, uvarnumber_T);
4749 if (ullong_arg != 0)
4750 arg_sign = 1;
4751 break;
4752# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004753 }
4754 }
4755
4756 str_arg = tmp;
4757 str_arg_l = 0;
4758
4759 /* NOTE:
4760 * For d, i, u, o, x, and X conversions, if precision is
4761 * specified, the '0' flag should be ignored. This is so
4762 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4763 * FreeBSD, NetBSD; but not with Perl.
4764 */
4765 if (precision_specified)
4766 zero_padding = 0;
4767 if (fmt_spec == 'd')
4768 {
4769 if (force_sign && arg_sign >= 0)
4770 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4771 /* leave negative numbers for sprintf to handle, to
4772 * avoid handling tricky cases like (short int)-32768 */
4773 }
4774 else if (alternate_form)
4775 {
4776 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004777 && (fmt_spec == 'b' || fmt_spec == 'B'
4778 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004779 {
4780 tmp[str_arg_l++] = '0';
4781 tmp[str_arg_l++] = fmt_spec;
4782 }
4783 /* alternate form should have no effect for p
4784 * conversion, but ... */
4785 }
4786
4787 zero_padding_insertion_ind = str_arg_l;
4788 if (!precision_specified)
4789 precision = 1; /* default precision is 1 */
4790 if (precision == 0 && arg_sign == 0)
4791 {
4792 /* When zero value is formatted with an explicit
4793 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004794 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004795 }
4796 else
4797 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004798 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004799 int f_l = 0;
4800
4801 /* construct a simple format string for sprintf */
4802 f[f_l++] = '%';
4803 if (!length_modifier)
4804 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004805 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004806 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004807# ifdef FEAT_NUM64
Bram Moolenaar4f974752019-02-17 17:44:42 +01004808# ifdef MSWIN
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004809 f[f_l++] = 'I';
4810 f[f_l++] = '6';
4811 f[f_l++] = '4';
4812# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004813 f[f_l++] = 'l';
4814 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004815# endif
4816# else
4817 f[f_l++] = 'l';
4818# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004819 }
4820 else
4821 f[f_l++] = length_modifier;
4822 f[f_l++] = fmt_spec;
4823 f[f_l++] = '\0';
4824
4825 if (fmt_spec == 'p')
4826 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004827 else if (fmt_spec == 'b' || fmt_spec == 'B')
4828 {
4829 char b[8 * sizeof(uvarnumber_T)];
4830 size_t b_l = 0;
4831 uvarnumber_T bn = bin_arg;
4832
4833 do
4834 {
4835 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4836 bn >>= 1;
4837 }
4838 while (bn != 0);
4839
4840 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4841 str_arg_l += b_l;
4842 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004843 else if (fmt_spec == 'd')
4844 {
4845 /* signed */
4846 switch (length_modifier)
4847 {
4848 case '\0':
4849 case 'h': str_arg_l += sprintf(
4850 tmp + str_arg_l, f, int_arg);
4851 break;
4852 case 'l': str_arg_l += sprintf(
4853 tmp + str_arg_l, f, long_arg);
4854 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004855# ifdef FEAT_NUM64
4856 case 'L': str_arg_l += sprintf(
4857 tmp + str_arg_l, f, llong_arg);
4858 break;
4859# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004860 }
4861 }
4862 else
4863 {
4864 /* unsigned */
4865 switch (length_modifier)
4866 {
4867 case '\0':
4868 case 'h': str_arg_l += sprintf(
4869 tmp + str_arg_l, f, uint_arg);
4870 break;
4871 case 'l': str_arg_l += sprintf(
4872 tmp + str_arg_l, f, ulong_arg);
4873 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004874# ifdef FEAT_NUM64
4875 case 'L': str_arg_l += sprintf(
4876 tmp + str_arg_l, f, ullong_arg);
4877 break;
4878# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004879 }
4880 }
4881
4882 /* include the optional minus sign and possible
4883 * "0x" in the region before the zero padding
4884 * insertion point */
4885 if (zero_padding_insertion_ind < str_arg_l
4886 && tmp[zero_padding_insertion_ind] == '-')
4887 zero_padding_insertion_ind++;
4888 if (zero_padding_insertion_ind + 1 < str_arg_l
4889 && tmp[zero_padding_insertion_ind] == '0'
4890 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4891 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4892 zero_padding_insertion_ind += 2;
4893 }
4894
4895 {
4896 size_t num_of_digits = str_arg_l
4897 - zero_padding_insertion_ind;
4898
4899 if (alternate_form && fmt_spec == 'o'
4900 /* unless zero is already the first
4901 * character */
4902 && !(zero_padding_insertion_ind < str_arg_l
4903 && tmp[zero_padding_insertion_ind] == '0'))
4904 {
4905 /* assure leading zero for alternate-form
4906 * octal numbers */
4907 if (!precision_specified
4908 || precision < num_of_digits + 1)
4909 {
4910 /* precision is increased to force the
4911 * first character to be zero, except if a
4912 * zero value is formatted with an
4913 * explicit precision of zero */
4914 precision = num_of_digits + 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004915 }
4916 }
4917 /* zero padding to specified precision? */
4918 if (num_of_digits < precision)
4919 number_of_zeros_to_pad = precision - num_of_digits;
4920 }
4921 /* zero padding to specified minimal field width? */
4922 if (!justify_left && zero_padding)
4923 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004924 int n = (int)(min_field_width - (str_arg_l
4925 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004926 if (n > 0)
4927 number_of_zeros_to_pad += n;
4928 }
4929 break;
4930 }
4931
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004932# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004933 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004934 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004935 case 'e':
4936 case 'E':
4937 case 'g':
4938 case 'G':
4939 {
4940 /* Floating point. */
4941 double f;
4942 double abs_f;
4943 char format[40];
4944 int l;
4945 int remove_trailing_zeroes = FALSE;
4946
4947 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004948# if defined(FEAT_EVAL)
4949 tvs != NULL ? tv_float(tvs, &arg_idx) :
4950# endif
4951 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004952 abs_f = f < 0 ? -f : f;
4953
4954 if (fmt_spec == 'g' || fmt_spec == 'G')
4955 {
4956 /* Would be nice to use %g directly, but it prints
4957 * "1.0" as "1", we don't want that. */
4958 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4959 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004960 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004961 else
4962 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4963 remove_trailing_zeroes = TRUE;
4964 }
4965
Bram Moolenaar04186092016-08-29 21:55:35 +02004966 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004967# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004968 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004969# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004970 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004971# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004972 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004973 {
4974 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004975 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4976 force_sign, space_for_positive));
4977 str_arg_l = STRLEN(tmp);
4978 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004979 }
4980 else
4981 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004982 if (isnan(f))
4983 {
4984 /* Not a number: nan or NAN */
4985 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4986 : "nan");
4987 str_arg_l = 3;
4988 zero_padding = 0;
4989 }
4990 else if (isinf(f))
4991 {
4992 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4993 force_sign, space_for_positive));
4994 str_arg_l = STRLEN(tmp);
4995 zero_padding = 0;
4996 }
4997 else
Bram Moolenaar191f18b2018-02-04 16:38:47 +01004998 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004999 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02005000 format[0] = '%';
5001 l = 1;
5002 if (force_sign)
5003 format[l++] = space_for_positive ? ' ' : '+';
5004 if (precision_specified)
5005 {
5006 size_t max_prec = TMP_LEN - 10;
5007
5008 /* Make sure we don't get more digits than we
5009 * have room for. */
5010 if ((fmt_spec == 'f' || fmt_spec == 'F')
5011 && abs_f > 1.0)
5012 max_prec -= (size_t)log10(abs_f);
5013 if (precision > max_prec)
5014 precision = max_prec;
5015 l += sprintf(format + l, ".%d", (int)precision);
5016 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02005017 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02005018 format[l + 1] = NUL;
5019
Bram Moolenaare9997822016-08-28 16:03:38 +02005020 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar191f18b2018-02-04 16:38:47 +01005021 }
Bram Moolenaar99922372016-08-27 15:26:35 +02005022
Bram Moolenaara7241f52008-06-24 20:39:31 +00005023 if (remove_trailing_zeroes)
5024 {
5025 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005026 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005027
5028 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02005029 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005030 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005031 else
5032 {
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)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005036 {
5037 /* Remove superfluous '+' and leading
5038 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005039 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005040 {
5041 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005042 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005043 --str_arg_l;
5044 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005045 i = (tp[1] == '-') ? 2 : 1;
5046 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005047 {
5048 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005049 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005050 --str_arg_l;
5051 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005052 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005053 }
5054 }
5055
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005056 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005057 /* Remove trailing zeroes, but keep the one
5058 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005059 while (tp > tmp + 2 && *tp == '0'
5060 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005061 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005062 STRMOVE(tp, tp + 1);
5063 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005064 --str_arg_l;
5065 }
5066 }
5067 else
5068 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005069 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005070
5071 /* Be consistent: some printf("%e") use 1.0e+12
5072 * and some 1.0e+012. Remove one zero in the last
5073 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005074 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005075 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005076 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5077 && tp[2] == '0'
5078 && vim_isdigit(tp[3])
5079 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005080 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005081 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005082 --str_arg_l;
5083 }
5084 }
5085 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005086 if (zero_padding && min_field_width > str_arg_l
5087 && (tmp[0] == '-' || force_sign))
5088 {
5089 /* padding 0's should be inserted after the sign */
5090 number_of_zeros_to_pad = min_field_width - str_arg_l;
5091 zero_padding_insertion_ind = 1;
5092 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005093 str_arg = tmp;
5094 break;
5095 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005096# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005097
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005098 default:
5099 /* unrecognized conversion specifier, keep format string
5100 * as-is */
5101 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005102 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005103 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005104 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005105
5106 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005107 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005108 str_arg = p;
5109 str_arg_l = 0;
5110 if (*p != NUL)
5111 str_arg_l++; /* include invalid conversion specifier
5112 unchanged if not at end-of-string */
5113 break;
5114 }
5115
5116 if (*p != NUL)
5117 p++; /* step over the just processed conversion specifier */
5118
5119 /* insert padding to the left as requested by min_field_width;
5120 * this does not include the zero padding in case of numerical
5121 * conversions*/
5122 if (!justify_left)
5123 {
5124 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005125 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005126
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005127 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005128 {
5129 if (str_l < str_m)
5130 {
5131 size_t avail = str_m - str_l;
5132
5133 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005134 (size_t)pn > avail ? avail
5135 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005136 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005137 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005138 }
5139 }
5140
5141 /* zero padding as requested by the precision or by the minimal
5142 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005143 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005144 {
5145 /* will not copy first part of numeric right now, *
5146 * force it to be copied later in its entirety */
5147 zero_padding_insertion_ind = 0;
5148 }
5149 else
5150 {
5151 /* insert first part of numerics (sign or '0x') before zero
5152 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005153 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005154
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005155 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005156 {
5157 if (str_l < str_m)
5158 {
5159 size_t avail = str_m - str_l;
5160
5161 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005162 (size_t)zn > avail ? avail
5163 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005164 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005165 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005166 }
5167
5168 /* insert zero padding as requested by the precision or min
5169 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005170 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005171 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005172 {
5173 if (str_l < str_m)
5174 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005175 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005176
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005177 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005178 (size_t)zn > avail ? avail
5179 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005180 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005181 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005182 }
5183 }
5184
5185 /* insert formatted string
5186 * (or as-is conversion specifier for unknown conversions) */
5187 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005188 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005189
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005190 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005191 {
5192 if (str_l < str_m)
5193 {
5194 size_t avail = str_m - str_l;
5195
5196 mch_memmove(str + str_l,
5197 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005198 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005199 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005200 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005201 }
5202 }
5203
5204 /* insert right padding */
5205 if (justify_left)
5206 {
5207 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005208 int pn = (int)(min_field_width
5209 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005210
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005211 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005212 {
5213 if (str_l < str_m)
5214 {
5215 size_t avail = str_m - str_l;
5216
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005217 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005218 (size_t)pn > avail ? avail
5219 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005220 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005221 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005222 }
5223 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005224 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005225 }
5226 }
5227
5228 if (str_m > 0)
5229 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005230 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005231 * overwriting the last character (shouldn't happen, but just in case)
5232 * */
5233 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5234 }
5235
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005236 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005237 emsg(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005238
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005239 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005240 * character), that is, the number of characters that would have been
5241 * written to the buffer if it were large enough. */
5242 return (int)str_l;
5243}
5244
5245#endif /* PROTO */