blob: 62e6bfe1ef6f6c85243a67eff9ac50958e2a8f16 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * message.c: functions for displaying messages on the command line
12 */
13
14#define MESSAGE_FILE /* don't include prototype for smsg() */
Bram Moolenaar44ca54a2016-08-27 15:41:32 +020015#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
17#include "vim.h"
18
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010019static int other_sourcing_name(void);
20static char_u *get_emsg_source(void);
21static char_u *get_emsg_lnum(void);
22static void add_msg_hist(char_u *s, int len, int attr);
23static void hit_return_msg(void);
24static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000025#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010026static char_u *screen_puts_mbyte(char_u *s, int l, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000027#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010028static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
29static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
30static void msg_scroll_up(void);
31static void inc_msg_scrolled(void);
32static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
33static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
34static void msg_puts_printf(char_u *str, int maxlen);
35static int do_more_prompt(int typed_char);
36static void msg_screen_putchar(int c, int attr);
37static int msg_check_screen(void);
38static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000039#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010040static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000041static int confirm_msg_used = FALSE; /* displaying confirm_msg */
42static char_u *confirm_msg = NULL; /* ":confirm" message */
43static char_u *confirm_msg_tail; /* tail of confirm_msg */
44#endif
Bram Moolenaar958dc692016-12-01 15:34:12 +010045#ifdef FEAT_JOB_CHANNEL
46static int emsg_to_channel_log = FALSE;
47#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000048
49struct msg_hist
50{
51 struct msg_hist *next;
52 char_u *msg;
53 int attr;
54};
55
56static struct msg_hist *first_msg_hist = NULL;
57static struct msg_hist *last_msg_hist = NULL;
58static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020060static FILE *verbose_fd = NULL;
61static int verbose_did_open = FALSE;
62
Bram Moolenaar071d4272004-06-13 20:20:40 +000063/*
64 * When writing messages to the screen, there are many different situations.
65 * A number of variables is used to remember the current state:
66 * msg_didany TRUE when messages were written since the last time the
67 * user reacted to a prompt.
68 * Reset: After hitting a key for the hit-return prompt,
69 * hitting <CR> for the command line or input().
70 * Set: When any message is written to the screen.
71 * msg_didout TRUE when something was written to the current line.
72 * Reset: When advancing to the next line, when the current
73 * text can be overwritten.
74 * Set: When any message is written to the screen.
75 * msg_nowait No extra delay for the last drawn message.
76 * Used in normal_cmd() before the mode message is drawn.
77 * emsg_on_display There was an error message recently. Indicates that there
78 * should be a delay before redrawing.
79 * msg_scroll The next message should not overwrite the current one.
80 * msg_scrolled How many lines the screen has been scrolled (because of
81 * messages). Used in update_screen() to scroll the screen
82 * back. Incremented each time the screen scrolls a line.
83 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
84 * writes something without scrolling should not make
85 * need_wait_return to be set. This is a hack to make ":ts"
86 * work without an extra prompt.
87 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010088 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000089 * need_wait_return TRUE when the hit-return prompt is needed.
90 * Reset: After giving the hit-return prompt, when the user
91 * has answered some other prompt.
92 * Set: When the ruler or typeahead display is overwritten,
93 * scrolling the screen for some message.
94 * keep_msg Message to be displayed after redrawing the screen, in
95 * main_loop().
96 * This is an allocated string or NULL when not used.
97 */
98
99/*
100 * msg(s) - displays the string 's' on the status line
101 * When terminal not initialized (yet) mch_errmsg(..) is used.
102 * return TRUE if wait_return not called
103 */
104 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100105msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106{
107 return msg_attr_keep(s, 0, FALSE);
108}
109
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000110#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000111 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000112/*
113 * Like msg() but keep it silent when 'verbosefile' is set.
114 */
115 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100116verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000117{
118 int n;
119
120 verbose_enter();
121 n = msg_attr_keep(s, 0, FALSE);
122 verbose_leave();
123
124 return n;
125}
126#endif
127
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100129msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130{
131 return msg_attr_keep(s, attr, FALSE);
132}
133
134 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100135msg_attr_keep(
136 char_u *s,
137 int attr,
138 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139{
140 static int entered = 0;
141 int retval;
142 char_u *buf = NULL;
143
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200144 /* Skip messages not matching ":filter pattern".
145 * Don't filter when there is an error. */
146 if (!emsg_on_display && message_filtered(s))
147 return TRUE;
148
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149#ifdef FEAT_EVAL
150 if (attr == 0)
151 set_vim_var_string(VV_STATUSMSG, s, -1);
152#endif
153
154 /*
155 * It is possible that displaying a messages causes a problem (e.g.,
156 * when redrawing the window), which causes another message, etc.. To
157 * break this loop, limit the recursiveness to 3 levels.
158 */
159 if (entered >= 3)
160 return TRUE;
161 ++entered;
162
163 /* Add message to history (unless it's a repeated kept message or a
164 * truncated message) */
165 if (s != keep_msg
166 || (*s != '<'
167 && last_msg_hist != NULL
168 && last_msg_hist->msg != NULL
169 && STRCMP(s, last_msg_hist->msg)))
170 add_msg_hist(s, -1, attr);
171
Bram Moolenaar958dc692016-12-01 15:34:12 +0100172#ifdef FEAT_JOB_CHANNEL
173 if (emsg_to_channel_log)
Bram Moolenaar958dc692016-12-01 15:34:12 +0100174 /* Write message in the channel log. */
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200175 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100176#endif
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 /* When displaying keep_msg, don't let msg_start() free it, caller must do
179 * that. */
180 if (s == keep_msg)
181 keep_msg = NULL;
182
183 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000184 msg_start();
185 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 if (buf != NULL)
187 s = buf;
188
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 msg_outtrans_attr(s, attr);
190 msg_clr_eos();
191 retval = msg_end();
192
193 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
194 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000195 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
197 vim_free(buf);
198 --entered;
199 return retval;
200}
201
202/*
203 * Truncate a string such that it can be printed without causing a scroll.
204 * Returns an allocated string or NULL when no truncating is done.
205 */
206 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100207msg_strtrunc(
208 char_u *s,
209 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210{
211 char_u *buf = NULL;
212 int len;
213 int room;
214
215 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000216 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
217 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 {
219 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000220 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000221 /* Use all the columns. */
222 room = (int)(Rows - msg_row) * Columns - 1;
223 else
224 /* Use up to 'showcmd' column. */
225 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 if (len > room && room > 0)
227 {
228#ifdef FEAT_MBYTE
229 if (enc_utf8)
230 /* may have up to 18 bytes per cell (6 per char, up to two
231 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100232 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 else if (enc_dbcs == DBCS_JPNU)
234 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100235 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 else
237#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100238 len = room + 2;
239 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100241 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242 }
243 }
244 return buf;
245}
246
247/*
248 * Truncate a string "s" to "buf" with cell width "room".
249 * "s" and "buf" may be equal.
250 */
251 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100252trunc_string(
253 char_u *s,
254 char_u *buf,
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200255 int room_in,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100256 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257{
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200258 size_t room = room_in - 3; /* "..." takes 3 chars */
259 size_t half;
260 size_t len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 int e;
262 int i;
263 int n;
264
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200265 if (room_in < 3)
266 room = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 half = room / 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100270 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 {
272 if (s[e] == NUL)
273 {
274 /* text fits without truncating! */
275 buf[e] = NUL;
276 return;
277 }
278 n = ptr2cells(s + e);
Bram Moolenaar502ae4b2016-07-16 19:50:13 +0200279 if (len + n > half)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 break;
281 len += n;
282 buf[e] = s[e];
283#ifdef FEAT_MBYTE
284 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000285 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100287 if (++e == buflen)
288 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000289 buf[e] = s[e];
290 }
291#endif
292 }
293
294 /* Last part: End of the string. */
295 i = e;
296#ifdef FEAT_MBYTE
297 if (enc_dbcs != 0)
298 {
299 /* For DBCS going backwards in a string is slow, but
300 * computing the cell width isn't too slow: go forward
301 * until the rest fits. */
302 n = vim_strsize(s + i);
303 while (len + n > room)
304 {
305 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000306 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 }
308 }
309 else if (enc_utf8)
310 {
311 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000312 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 for (;;)
314 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000315 do
Bram Moolenaarace95982017-03-29 17:30:27 +0200316 half = half - utf_head_off(s, s + half - 1) - 1;
Bram Moolenaarb9644432016-07-19 12:33:44 +0200317 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half)));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 n = ptr2cells(s + half);
Bram Moolenaarb9644432016-07-19 12:33:44 +0200319 if (len + n > room || half == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 break;
321 len += n;
Bram Moolenaara5c0cc12016-07-30 16:40:39 +0200322 i = (int)half;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323 }
324 }
325 else
326#endif
327 {
328 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
329 len += n;
330 }
331
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200332
333 if (i <= e + 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100334 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200335 /* text fits without truncating */
336 if (s != buf)
337 {
338 len = STRLEN(s);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200339 if (len >= (size_t)buflen)
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200340 len = buflen - 1;
341 len = len - e + 1;
342 if (len < 1)
343 buf[e - 1] = NUL;
344 else
345 mch_memmove(buf + e, s + e, len);
346 }
347 }
348 else if (e + 3 < buflen)
349 {
350 /* set the middle and copy the last part */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100351 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaard4f31dc2016-07-23 17:28:22 +0200352 len = STRLEN(s + i) + 1;
353 if (len >= (size_t)buflen - e - 3)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100354 len = buflen - e - 3 - 1;
355 mch_memmove(buf + e + 3, s + i, len);
356 buf[e + 3 + len - 1] = NUL;
357 }
358 else
359 {
Bram Moolenaarf6acffb2016-07-16 16:54:24 +0200360 /* can't fit in the "...", just truncate it */
361 buf[e - 1] = NUL;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100362 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363}
364
365/*
366 * Automatic prototype generation does not understand this function.
367 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
368 * shorter than IOSIZE!!!
369 */
370#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000372int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000373
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100375# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100377# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378smsg(char_u *s, ...)
379{
380 va_list arglist;
381
382 va_start(arglist, s);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +0200383 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 va_end(arglist);
385 return msg(IObuff);
386}
387
388 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100389# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100391# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392smsg_attr(int attr, char_u *s, ...)
393{
394 va_list arglist;
395
396 va_start(arglist, s);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +0200397 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 va_end(arglist);
399 return msg_attr(IObuff, attr);
400}
401
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402#endif
403
404/*
405 * Remember the last sourcing name/lnum used in an error message, so that it
406 * isn't printed each time when it didn't change.
407 */
408static int last_sourcing_lnum = 0;
409static char_u *last_sourcing_name = NULL;
410
411/*
412 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
413 * for the next error message;
414 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000415 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100416reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417{
418 vim_free(last_sourcing_name);
419 last_sourcing_name = NULL;
420 last_sourcing_lnum = 0;
421}
422
423/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000424 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
425 */
426 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100427other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000428{
429 if (sourcing_name != NULL)
430 {
431 if (last_sourcing_name != NULL)
432 return STRCMP(sourcing_name, last_sourcing_name) != 0;
433 return TRUE;
434 }
435 return FALSE;
436}
437
438/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 * Get the message about the source, as used for an error message.
440 * Returns an allocated string with room for one more character.
441 * Returns NULL when no message is to be given.
442 */
443 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100444get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445{
446 char_u *Buf, *p;
447
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000448 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449 {
450 p = (char_u *)_("Error detected while processing %s:");
451 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
452 if (Buf != NULL)
453 sprintf((char *)Buf, (char *)p, sourcing_name);
454 return Buf;
455 }
456 return NULL;
457}
458
459/*
460 * Get the message about the source lnum, as used for an error message.
461 * Returns an allocated string with room for one more character.
462 * Returns NULL when no message is to be given.
463 */
464 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100465get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466{
467 char_u *Buf, *p;
468
469 /* lnum is 0 when executing a command from the command line
470 * argument, we don't want a line number then */
471 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000472 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473 && sourcing_lnum != 0)
474 {
475 p = (char_u *)_("line %4ld:");
476 Buf = alloc((unsigned)(STRLEN(p) + 20));
477 if (Buf != NULL)
478 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
479 return Buf;
480 }
481 return NULL;
482}
483
484/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000485 * Display name and line number for the source of an error.
486 * Remember the file name and line number, so that for the next error the info
487 * is only displayed if it changed.
488 */
489 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100490msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000491{
492 char_u *p;
493
494 ++no_wait_return;
495 p = get_emsg_source();
496 if (p != NULL)
497 {
498 msg_attr(p, attr);
499 vim_free(p);
500 }
501 p = get_emsg_lnum();
502 if (p != NULL)
503 {
Bram Moolenaar8820b482017-03-16 17:23:31 +0100504 msg_attr(p, HL_ATTR(HLF_N));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000505 vim_free(p);
506 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
507 }
508
509 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000510 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000511 {
512 vim_free(last_sourcing_name);
513 if (sourcing_name == NULL)
514 last_sourcing_name = NULL;
515 else
516 last_sourcing_name = vim_strsave(sourcing_name);
517 }
518 --no_wait_return;
519}
520
521/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000522 * Return TRUE if not giving error messages right now:
523 * If "emsg_off" is set: no error messages at the moment.
524 * If "msg" is in 'debug': do error message but without side effects.
525 * If "emsg_skip" is set: never do error messages.
526 */
527 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100528emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000529{
530 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
531 && vim_strchr(p_debug, 't') == NULL)
532#ifdef FEAT_EVAL
533 || emsg_skip > 0
534#endif
535 )
536 return TRUE;
537 return FALSE;
538}
539
Bram Moolenaar5a66dfb2017-03-01 20:40:39 +0100540#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100541static garray_T ignore_error_list = GA_EMPTY;
542
543 void
544ignore_error_for_testing(char_u *error)
545{
546 if (ignore_error_list.ga_itemsize == 0)
547 ga_init2(&ignore_error_list, sizeof(char_u *), 1);
548
549 ga_add_string(&ignore_error_list, error);
550}
551
552 static int
553ignore_error(char_u *msg)
554{
555 int i;
556
557 for (i = 0; i < ignore_error_list.ga_len; ++i)
558 if (strstr((char *)msg,
559 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL)
560 return TRUE;
561 return FALSE;
562}
563#endif
564
Bram Moolenaarb869c0d2016-07-20 00:10:51 +0200565#if !defined(HAVE_STRERROR) || defined(PROTO)
566/*
567 * Replacement for perror() that behaves more or less like emsg() was called.
568 * v:errmsg will be set and called_emsg will be set.
569 */
570 void
571do_perror(char *msg)
572{
573 perror(msg);
574 ++emsg_silent;
575 emsg((char_u *)msg);
576 --emsg_silent;
577}
578#endif
579
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000580/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581 * emsg() - display an error message
582 *
583 * Rings the bell, if appropriate, and calls message() to do the real work
584 * When terminal not initialized (yet) mch_errmsg(..) is used.
585 *
586 * return TRUE if wait_return not called
587 */
588 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100589emsg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590{
591 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 char_u *p;
Bram Moolenaar958dc692016-12-01 15:34:12 +0100593 int r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594#ifdef FEAT_EVAL
595 int ignore = FALSE;
596 int severe;
597#endif
598
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100599 /* Skip this if not giving error messages at the moment. */
600 if (emsg_not_now())
601 return TRUE;
602
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100603#ifdef FEAT_EVAL
604 /* When testing some errors are turned into a normal message. */
605 if (ignore_error(s))
Bram Moolenaarf8ab1b12017-03-01 18:30:34 +0100606 /* don't call msg() if it results in a dialog */
607 return msg_use_printf() ? FALSE : msg(s);
Bram Moolenaare0c31f62017-03-01 15:07:05 +0100608#endif
609
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 called_emsg = TRUE;
611
612 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000613 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
614 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 */
616#ifdef FEAT_EVAL
617 severe = emsg_severe;
618 emsg_severe = FALSE;
619#endif
620
Bram Moolenaar57657d82006-04-21 22:12:41 +0000621 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622 {
623#ifdef FEAT_EVAL
624 /*
625 * Cause a throw of an error exception if appropriate. Don't display
626 * the error message in this case. (If no matching catch clause will
627 * be found, the message will be displayed later on.) "ignore" is set
628 * when the message should be ignored completely (used for the
629 * interrupt message).
630 */
631 if (cause_errthrow(s, severe, &ignore) == TRUE)
632 {
633 if (!ignore)
634 did_emsg = TRUE;
635 return TRUE;
636 }
637
638 /* set "v:errmsg", also when using ":silent! cmd" */
639 set_vim_var_string(VV_ERRMSG, s, -1);
640#endif
641
642 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000643 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 * But do write it to the redirection file.
645 */
646 if (emsg_silent != 0)
647 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200648 if (emsg_noredir == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 {
Bram Moolenaar79815f12016-07-09 17:07:29 +0200650 msg_start();
651 p = get_emsg_source();
652 if (p != NULL)
653 {
654 STRCAT(p, "\n");
655 redir_write(p, -1);
656 vim_free(p);
657 }
658 p = get_emsg_lnum();
659 if (p != NULL)
660 {
661 STRCAT(p, "\n");
662 redir_write(p, -1);
663 vim_free(p);
664 }
665 redir_write(s, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 }
Bram Moolenaar958dc692016-12-01 15:34:12 +0100667#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +0200668 ch_log(NULL, "ERROR: %s", (char *)s);
Bram Moolenaar958dc692016-12-01 15:34:12 +0100669#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 return TRUE;
671 }
672
Bram Moolenaar2b7bc562017-01-14 19:24:52 +0100673 ex_exitval = 1;
674
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 /* Reset msg_silent, an error causes messages to be switched back on. */
676 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
685 flush_buffers(FALSE); /* flush internal buffers */
686 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 }
688
689 emsg_on_display = TRUE; /* remember there is an error message */
690 ++msg_scroll; /* don't overwrite a previous message */
Bram Moolenaar8820b482017-03-16 17:23:31 +0100691 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000692 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 need_wait_return = TRUE; /* needed in case emsg() is called after
694 * wait_return has reset need_wait_return
695 * and a redraw is expected because
696 * msg_scrolled is non-zero */
697
Bram Moolenaar958dc692016-12-01 15:34:12 +0100698#ifdef FEAT_JOB_CHANNEL
699 emsg_to_channel_log = TRUE;
700#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 /*
702 * Display name and line number for the source of the error.
703 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000704 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 /*
707 * Display the error message itself.
708 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000709 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar958dc692016-12-01 15:34:12 +0100710 r = msg_attr(s, attr);
711
712#ifdef FEAT_JOB_CHANNEL
713 emsg_to_channel_log = FALSE;
714#endif
715 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716}
717
Bram Moolenaar95f09602016-11-10 20:01:45 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719/*
720 * Print an error message with one "%s" and one string argument.
721 */
722 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100723emsg2(char_u *s, char_u *a1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724{
725 return emsg3(s, a1, NULL);
726}
727
Bram Moolenaar95f09602016-11-10 20:01:45 +0100728/*
729 * Print an error message with one or two "%s" and one or two string arguments.
730 * This is not in message.c to avoid a warning for prototypes.
731 */
732 int
733emsg3(char_u *s, char_u *a1, char_u *a2)
734{
735 if (emsg_not_now())
736 return TRUE; /* no error messages at the moment */
737 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, a1, a2);
738 return emsg(IObuff);
739}
740
741/*
742 * Print an error message with one "%ld" and one long int argument.
743 * This is not in message.c to avoid a warning for prototypes.
744 */
745 int
746emsgn(char_u *s, long n)
747{
748 if (emsg_not_now())
749 return TRUE; /* no error messages at the moment */
750 vim_snprintf((char *)IObuff, IOSIZE, (char *)s, n);
751 return emsg(IObuff);
752}
753
754/*
755 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is
756 * defined. It is used for internal errors only, so that they can be
757 * detected when fuzzing vim.
758 */
759 void
760iemsg(char_u *s)
761{
762 msg(s);
763#ifdef ABORT_ON_INTERNAL_ERROR
764 abort();
765#endif
766}
767
768
769/*
770 * Same as emsg2(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
771 * defined. It is used for internal errors only, so that they can be
772 * detected when fuzzing vim.
773 */
774 void
775iemsg2(char_u *s, char_u *a1)
776{
777 emsg2(s, a1);
778#ifdef ABORT_ON_INTERNAL_ERROR
779 abort();
780#endif
781}
782
783/*
784 * Same as emsgn(...) but abort on error when ABORT_ON_INTERNAL_ERROR is
785 * defined. It is used for internal errors only, so that they can be
786 * detected when fuzzing vim.
787 */
788 void
789iemsgn(char_u *s, long n)
790{
791 emsgn(s, n);
792#ifdef ABORT_ON_INTERNAL_ERROR
793 abort();
794#endif
795}
796
797/*
798 * Give an "Internal error" message.
799 */
800 void
801internal_error(char *where)
802{
803 IEMSG2(_(e_intern2), where);
804}
805
Bram Moolenaarea424162005-06-16 21:51:00 +0000806/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
Bram Moolenaardf177f62005-02-22 08:39:57 +0000808 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100809emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000810{
811 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
812}
813
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814/*
815 * Like msg(), but truncate to a single line if p_shm contains 't', or when
816 * "force" is TRUE. This truncates in another way as for normal messages.
817 * Careful: The string may be changed by msg_may_trunc()!
818 * Returns a pointer to the printed message, if wait_return() not called.
819 */
820 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100821msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822{
823 int n;
824
825 /* Add message to history before truncating */
826 add_msg_hist(s, -1, attr);
827
828 s = msg_may_trunc(force, s);
829
830 msg_hist_off = TRUE;
831 n = msg_attr(s, attr);
832 msg_hist_off = FALSE;
833
834 if (n)
835 return s;
836 return NULL;
837}
838
839/*
840 * Check if message "s" should be truncated at the start (for filenames).
841 * Return a pointer to where the truncated message starts.
842 * Note: May change the message by replacing a character with '<'.
843 */
844 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100845msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846{
847 int n;
848 int room;
849
850 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
851 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
852 && (n = (int)STRLEN(s) - room) > 0)
853 {
854#ifdef FEAT_MBYTE
855 if (has_mbyte)
856 {
857 int size = vim_strsize(s);
858
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000859 /* There may be room anyway when there are multibyte chars. */
860 if (size <= room)
861 return s;
862
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 for (n = 0; size >= room; )
864 {
865 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000866 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 }
868 --n;
869 }
870#endif
871 s += n;
872 *s = '<';
873 }
874 return s;
875}
876
877 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100878add_msg_hist(
879 char_u *s,
880 int len, /* -1 for undetermined length */
881 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882{
883 struct msg_hist *p;
884
885 if (msg_hist_off || msg_silent != 0)
886 return;
887
888 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000889 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000890 (void)delete_first_msg();
891
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 /* allocate an entry and add the message at the end of the history */
893 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
894 if (p != NULL)
895 {
896 if (len < 0)
897 len = (int)STRLEN(s);
898 /* remove leading and trailing newlines */
899 while (len > 0 && *s == '\n')
900 {
901 ++s;
902 --len;
903 }
904 while (len > 0 && s[len - 1] == '\n')
905 --len;
906 p->msg = vim_strnsave(s, len);
907 p->next = NULL;
908 p->attr = attr;
909 if (last_msg_hist != NULL)
910 last_msg_hist->next = p;
911 last_msg_hist = p;
912 if (first_msg_hist == NULL)
913 first_msg_hist = last_msg_hist;
914 ++msg_hist_len;
915 }
916}
917
918/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000919 * Delete the first (oldest) message from the history.
920 * Returns FAIL if there are no messages.
921 */
922 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100923delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000924{
925 struct msg_hist *p;
926
927 if (msg_hist_len <= 0)
928 return FAIL;
929 p = first_msg_hist;
930 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000931 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200932 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000933 vim_free(p->msg);
934 vim_free(p);
935 --msg_hist_len;
936 return OK;
937}
938
939/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 * ":messages" command.
941 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200943ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944{
945 struct msg_hist *p;
946 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200947 int c = 0;
948
949 if (STRCMP(eap->arg, "clear") == 0)
950 {
951 int keep = eap->addr_count == 0 ? 0 : eap->line2;
952
953 while (msg_hist_len > keep)
954 (void)delete_first_msg();
955 return;
956 }
957
958 if (*eap->arg != NUL)
959 {
960 EMSG(_(e_invarg));
961 return;
962 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 msg_hist_off = TRUE;
965
Bram Moolenaar451f8492016-04-14 17:16:22 +0200966 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200967 if (eap->addr_count != 0)
968 {
969 /* Count total messages */
970 for (; p != NULL && !got_int; p = p->next)
971 c++;
972
973 c -= eap->line2;
974
975 /* Skip without number of messages specified */
976 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
977 p = p->next, c--);
978 }
979
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200980 if (p == first_msg_hist)
981 {
982 s = mch_getenv((char_u *)"LANG");
983 if (s != NULL && *s != NUL)
984 msg_attr((char_u *)
985 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
Bram Moolenaar8820b482017-03-16 17:23:31 +0100986 HL_ATTR(HLF_T));
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200987 }
988
Bram Moolenaar451f8492016-04-14 17:16:22 +0200989 /* Display what was not skipped. */
990 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 if (p->msg != NULL)
992 msg_attr(p->msg, p->attr);
993
994 msg_hist_off = FALSE;
995}
996
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000997#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998/*
999 * Call this after prompting the user. This will avoid a hit-return message
1000 * and a delay.
1001 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001002 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001003msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004{
1005 need_wait_return = FALSE;
1006 emsg_on_display = FALSE;
1007 cmdline_row = msg_row;
1008 msg_col = 0;
1009 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +01001010 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011}
1012#endif
1013
1014/*
1015 * wait for the user to hit a key (normally a return)
1016 * if 'redraw' is TRUE, clear and redraw the screen
1017 * if 'redraw' is FALSE, just redraw the screen
1018 * if 'redraw' is -1, don't redraw at all
1019 */
1020 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001021wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022{
1023 int c;
1024 int oldState;
1025 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 int had_got_int;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001027 int save_Recording;
1028 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
1030 if (redraw == TRUE)
1031 must_redraw = CLEAR;
1032
1033 /* If using ":silent cmd", don't wait for a return. Also don't set
1034 * need_wait_return to do it later. */
1035 if (msg_silent != 0)
1036 return;
1037
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001038 /*
1039 * When inside vgetc(), we can't wait for a typed character at all.
1040 * With the global command (and some others) we only need one return at
1041 * the end. Adjust cmdline_row to avoid the next message overwriting the
1042 * last one.
1043 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +00001044 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +01001046 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 if (no_wait_return)
1048 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 if (!exmode_active)
1050 cmdline_row = msg_row;
1051 return;
1052 }
1053
1054 redir_off = TRUE; /* don't redirect this message */
1055 oldState = State;
1056 if (quit_more)
1057 {
1058 c = CAR; /* just pretend CR was hit */
1059 quit_more = FALSE;
1060 got_int = FALSE;
1061 }
1062 else if (exmode_active)
1063 {
1064 MSG_PUTS(" "); /* make sure the cursor is on the right line */
1065 c = CAR; /* no need for a return in ex mode */
1066 got_int = FALSE;
1067 }
1068 else
1069 {
1070 /* Make sure the hit-return prompt is on screen when 'guioptions' was
1071 * just changed. */
1072 screenalloc(FALSE);
1073
1074 State = HITRETURN;
1075#ifdef FEAT_MOUSE
1076 setmouse();
1077#endif
1078#ifdef USE_ON_FLY_SCROLL
1079 dont_scroll = TRUE; /* disallow scrolling here */
1080#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01001081 cmdline_row = msg_row;
1082
Bram Moolenaarec38d692013-04-24 15:12:32 +02001083 /* Avoid the sequence that the user types ":" at the hit-return prompt
1084 * to start an Ex command, but the file-changed dialog gets in the
1085 * way. */
1086 if (need_check_timestamps)
1087 check_timestamps(FALSE);
1088
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 hit_return_msg();
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 do
1092 {
1093 /* Remember "got_int", if it is set vgetc() probably returns a
1094 * CTRL-C, but we need to loop then. */
1095 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001096
1097 /* Don't do mappings here, we put the character back in the
1098 * typeahead buffer. */
1099 ++no_mapping;
1100 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001101
1102 /* Temporarily disable Recording. If Recording is active, the
1103 * character will be recorded later, since it will be added to the
1104 * typebuf after the loop */
1105 save_Recording = Recording;
1106 save_scriptout = scriptout;
1107 Recording = FALSE;
1108 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001110 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001112 --no_mapping;
1113 --allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +01001114 Recording = save_Recording;
1115 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001116
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117#ifdef FEAT_CLIPBOARD
1118 /* Strange way to allow copying (yanking) a modeless selection at
1119 * the hit-enter prompt. Use CTRL-Y, because the same is used in
1120 * Cmdline-mode and it's harmless when there is no selection. */
1121 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
1122 {
1123 clip_copy_modeless_selection(TRUE);
1124 c = K_IGNORE;
1125 }
1126#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001127
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001128 /*
1129 * Allow scrolling back in the messages.
1130 * Also accept scroll-down commands when messages fill the screen,
1131 * to avoid that typing one 'j' too many makes the messages
1132 * disappear.
1133 */
1134 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001135 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001136 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
1137 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001138 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001139 if (msg_scrolled > Rows)
1140 /* scroll back to show older messages */
1141 do_more_prompt(c);
1142 else
1143 {
1144 msg_didout = FALSE;
1145 c = K_IGNORE;
1146 msg_col =
1147#ifdef FEAT_RIGHTLEFT
1148 cmdmsg_rl ? Columns - 1 :
1149#endif
1150 0;
1151 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001152 if (quit_more)
1153 {
1154 c = CAR; /* just pretend CR was hit */
1155 quit_more = FALSE;
1156 got_int = FALSE;
1157 }
Bram Moolenaarb0912962013-08-09 20:38:26 +02001158 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001159 {
1160 c = K_IGNORE;
1161 hit_return_msg();
1162 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001163 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +00001164 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +01001165 && (c == 'j' || c == 'd' || c == 'f'
1166 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001167 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 } while ((had_got_int && c == Ctrl_C)
1170 || c == K_IGNORE
1171#ifdef FEAT_GUI
1172 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
1173#endif
1174#ifdef FEAT_MOUSE
1175 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1176 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1177 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001178 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 || c == K_MOUSEDOWN || c == K_MOUSEUP
1180 || (!mouse_has(MOUSE_RETURN)
1181 && mouse_row < msg_row
1182 && (c == K_LEFTMOUSE
1183 || c == K_MIDDLEMOUSE
1184 || c == K_RIGHTMOUSE
1185 || c == K_X1MOUSE
1186 || c == K_X2MOUSE))
1187#endif
1188 );
1189 ui_breakcheck();
1190#ifdef FEAT_MOUSE
1191 /*
1192 * Avoid that the mouse-up event causes visual mode to start.
1193 */
1194 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1195 || c == K_X1MOUSE || c == K_X2MOUSE)
1196 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1197 else
1198#endif
1199 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1200 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001201 /* Put the character back in the typeahead buffer. Don't use the
1202 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001203 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001205 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 }
1208 redir_off = FALSE;
1209
1210 /*
1211 * If the user hits ':', '?' or '/' we get a command line from the next
1212 * line.
1213 */
1214 if (c == ':' || c == '?' || c == '/')
1215 {
1216 if (!exmode_active)
1217 cmdline_row = msg_row;
1218 skip_redraw = TRUE; /* skip redraw once */
1219 do_redraw = FALSE;
1220 }
1221
1222 /*
1223 * If the window size changed set_shellsize() will redraw the screen.
1224 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1225 * typed.
1226 */
1227 tmpState = State;
1228 State = oldState; /* restore State before set_shellsize */
1229#ifdef FEAT_MOUSE
1230 setmouse();
1231#endif
1232 msg_check();
1233
1234#if defined(UNIX) || defined(VMS)
1235 /*
1236 * When switching screens, we need to output an extra newline on exit.
1237 */
1238 if (swapping_screen() && !termcap_active)
1239 newline_on_exit = TRUE;
1240#endif
1241
1242 need_wait_return = FALSE;
1243 did_wait_return = TRUE;
1244 emsg_on_display = FALSE; /* can delete error message now */
1245 lines_left = -1; /* reset lines_left at next msg_start() */
1246 reset_last_sourcing();
1247 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1248 (Rows - cmdline_row - 1) * Columns + sc_col)
1249 {
1250 vim_free(keep_msg);
1251 keep_msg = NULL; /* don't redisplay message, it's too long */
1252 }
1253
1254 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1255 {
1256 starttermcap(); /* start termcap before redrawing */
1257 shell_resized();
1258 }
1259 else if (!skip_redraw
1260 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1261 {
1262 starttermcap(); /* start termcap before redrawing */
1263 redraw_later(VALID);
1264 }
1265}
1266
1267/*
1268 * Write the hit-return prompt.
1269 */
1270 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001271hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001273 int save_p_more = p_more;
1274
1275 p_more = FALSE; /* don't want see this message when scrolling back */
1276 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 msg_putchar('\n');
1278 if (got_int)
1279 MSG_PUTS(_("Interrupt: "));
1280
Bram Moolenaar8820b482017-03-16 17:23:31 +01001281 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 if (!msg_use_printf())
1283 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001284 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285}
1286
1287/*
1288 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1289 */
1290 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001291set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292{
1293 vim_free(keep_msg);
1294 if (s != NULL && msg_silent == 0)
1295 keep_msg = vim_strsave(s);
1296 else
1297 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001298 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001299 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300}
1301
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001302#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1303/*
1304 * If there currently is a message being displayed, set "keep_msg" to it, so
1305 * that it will be displayed again after redraw.
1306 */
1307 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001308set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001309{
1310 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1311 && (State & NORMAL))
1312 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1313}
1314#endif
1315
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316/*
1317 * Prepare for outputting characters in the command line.
1318 */
1319 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001320msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321{
1322 int did_return = FALSE;
1323
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001324 if (!msg_silent)
1325 {
1326 vim_free(keep_msg);
1327 keep_msg = NULL; /* don't display old message now */
1328 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001329
1330#ifdef FEAT_EVAL
1331 if (need_clr_eos)
1332 {
1333 /* Halfway an ":echo" command and getting an (error) message: clear
1334 * any text from the command. */
1335 need_clr_eos = FALSE;
1336 msg_clr_eos();
1337 }
1338#endif
1339
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 if (!msg_scroll && full_screen) /* overwrite last message */
1341 {
1342 msg_row = cmdline_row;
1343 msg_col =
1344#ifdef FEAT_RIGHTLEFT
1345 cmdmsg_rl ? Columns - 1 :
1346#endif
1347 0;
1348 }
1349 else if (msg_didout) /* start message on next line */
1350 {
1351 msg_putchar('\n');
1352 did_return = TRUE;
1353 if (exmode_active != EXMODE_NORMAL)
1354 cmdline_row = msg_row;
1355 }
1356 if (!msg_didany || lines_left < 0)
1357 msg_starthere();
1358 if (msg_silent == 0)
1359 {
1360 msg_didout = FALSE; /* no output on current line yet */
1361 cursor_off();
1362 }
1363
1364 /* when redirecting, may need to start a new line. */
1365 if (!did_return)
1366 redir_write((char_u *)"\n", -1);
1367}
1368
1369/*
1370 * Note that the current msg position is where messages start.
1371 */
1372 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001373msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374{
1375 lines_left = cmdline_row;
1376 msg_didany = FALSE;
1377}
1378
1379 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001380msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381{
1382 msg_putchar_attr(c, 0);
1383}
1384
1385 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001386msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387{
1388#ifdef FEAT_MBYTE
1389 char_u buf[MB_MAXBYTES + 1];
1390#else
1391 char_u buf[4];
1392#endif
1393
1394 if (IS_SPECIAL(c))
1395 {
1396 buf[0] = K_SPECIAL;
1397 buf[1] = K_SECOND(c);
1398 buf[2] = K_THIRD(c);
1399 buf[3] = NUL;
1400 }
1401 else
1402 {
1403#ifdef FEAT_MBYTE
1404 buf[(*mb_char2bytes)(c, buf)] = NUL;
1405#else
1406 buf[0] = c;
1407 buf[1] = NUL;
1408#endif
1409 }
1410 msg_puts_attr(buf, attr);
1411}
1412
1413 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001414msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415{
1416 char_u buf[20];
1417
1418 sprintf((char *)buf, "%ld", n);
1419 msg_puts(buf);
1420}
1421
1422 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001423msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424{
1425 msg_home_replace_attr(fname, 0);
1426}
1427
1428#if defined(FEAT_FIND_ID) || defined(PROTO)
1429 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001430msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001432 msg_home_replace_attr(fname, HL_ATTR(HLF_D));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433}
1434#endif
1435
1436 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001437msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438{
1439 char_u *name;
1440
1441 name = home_replace_save(NULL, fname);
1442 if (name != NULL)
1443 msg_outtrans_attr(name, attr);
1444 vim_free(name);
1445}
1446
1447/*
1448 * Output 'len' characters in 'str' (including NULs) with translation
1449 * if 'len' is -1, output upto a NUL character.
1450 * Use attributes 'attr'.
1451 * Return the number of characters it takes on the screen.
1452 */
1453 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001454msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455{
1456 return msg_outtrans_attr(str, 0);
1457}
1458
1459 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001460msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461{
1462 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1463}
1464
1465 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001466msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467{
1468 return msg_outtrans_len_attr(str, len, 0);
1469}
1470
1471/*
1472 * Output one character at "p". Return pointer to the next character.
1473 * Handles multi-byte characters.
1474 */
1475 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001476msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477{
1478#ifdef FEAT_MBYTE
1479 int l;
1480
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001481 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 {
1483 msg_outtrans_len_attr(p, l, attr);
1484 return p + l;
1485 }
1486#endif
1487 msg_puts_attr(transchar_byte(*p), attr);
1488 return p + 1;
1489}
1490
1491 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001492msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493{
1494 int retval = 0;
1495 char_u *str = msgstr;
1496 char_u *plain_start = msgstr;
1497 char_u *s;
1498#ifdef FEAT_MBYTE
1499 int mb_l;
1500 int c;
1501#endif
1502
1503 /* if MSG_HIST flag set, add message to history */
1504 if (attr & MSG_HIST)
1505 {
1506 add_msg_hist(str, len, attr);
1507 attr &= ~MSG_HIST;
1508 }
1509
1510#ifdef FEAT_MBYTE
1511 /* If the string starts with a composing character first draw a space on
1512 * which the composing char can be drawn. */
1513 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1514 msg_puts_attr((char_u *)" ", attr);
1515#endif
1516
1517 /*
1518 * Go over the string. Special characters are translated and printed.
1519 * Normal characters are printed several at a time.
1520 */
1521 while (--len >= 0)
1522 {
1523#ifdef FEAT_MBYTE
1524 if (enc_utf8)
1525 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001526 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001528 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 else
1530 mb_l = 1;
1531 if (has_mbyte && mb_l > 1)
1532 {
1533 c = (*mb_ptr2char)(str);
1534 if (vim_isprintc(c))
1535 /* printable multi-byte char: count the cells. */
1536 retval += (*mb_ptr2cells)(str);
1537 else
1538 {
1539 /* unprintable multi-byte char: print the printable chars so
1540 * far and the translation of the unprintable char. */
1541 if (str > plain_start)
1542 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1543 attr);
1544 plain_start = str + mb_l;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001545 msg_puts_attr(transchar(c), attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 retval += char2cells(c);
1547 }
1548 len -= mb_l - 1;
1549 str += mb_l;
1550 }
1551 else
1552#endif
1553 {
1554 s = transchar_byte(*str);
1555 if (s[1] != NUL)
1556 {
1557 /* unprintable char: print the printable chars so far and the
1558 * translation of the unprintable char. */
1559 if (str > plain_start)
1560 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1561 attr);
1562 plain_start = str + 1;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001563 msg_puts_attr(s, attr == 0 ? HL_ATTR(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001564 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001566 else
1567 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 ++str;
1569 }
1570 }
1571
1572 if (str > plain_start)
1573 /* print the printable chars at the end */
1574 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1575
1576 return retval;
1577}
1578
1579#if defined(FEAT_QUICKFIX) || defined(PROTO)
1580 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001581msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582{
1583 int i;
1584 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1585
1586 arg = skipwhite(arg);
1587 for (i = 5; *arg && i >= 0; --i)
1588 if (*arg++ != str[i])
1589 break;
1590 if (i < 0)
1591 {
1592 msg_putchar('\n');
1593 for (i = 0; rs[i]; ++i)
1594 msg_putchar(rs[i] - 3);
1595 }
1596}
1597#endif
1598
1599/*
1600 * Output the string 'str' upto a NUL character.
1601 * Return the number of characters it takes on the screen.
1602 *
1603 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1604 * following character and shown as <F1>, <S-Up> etc. Any other character
1605 * which is not printable shown in <> form.
1606 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1607 * If a character is displayed in one of these special ways, is also
1608 * highlighted (its highlight name is '8' in the p_hl variable).
1609 * Otherwise characters are not highlighted.
1610 * This function is used to show mappings, where we want to see how to type
1611 * the character/string -- webb
1612 */
1613 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001614msg_outtrans_special(
1615 char_u *strstart,
1616 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617{
1618 char_u *str = strstart;
1619 int retval = 0;
1620 char_u *string;
1621 int attr;
1622 int len;
1623
Bram Moolenaar8820b482017-03-16 17:23:31 +01001624 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 while (*str != NUL)
1626 {
1627 /* Leading and trailing spaces need to be displayed in <> form. */
1628 if ((str == strstart || str[1] == NUL) && *str == ' ')
1629 {
1630 string = (char_u *)"<Space>";
1631 ++str;
1632 }
1633 else
1634 string = str2special(&str, from);
1635 len = vim_strsize(string);
1636 /* Highlight special keys */
1637 msg_puts_attr(string, len > 1
1638#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001639 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640#endif
1641 ? attr : 0);
1642 retval += len;
1643 }
1644 return retval;
1645}
1646
Bram Moolenaarbd743252010-10-20 21:23:33 +02001647#if defined(FEAT_EVAL) || defined(PROTO)
1648/*
1649 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1650 * strings, in an allocated string.
1651 */
1652 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001653str2special_save(
1654 char_u *str,
1655 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001656{
1657 garray_T ga;
1658 char_u *p = str;
1659
1660 ga_init2(&ga, 1, 40);
1661 while (*p != NUL)
1662 ga_concat(&ga, str2special(&p, is_lhs));
1663 ga_append(&ga, NUL);
1664 return (char_u *)ga.ga_data;
1665}
1666#endif
1667
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668/*
1669 * Return the printable string for the key codes at "*sp".
1670 * Used for translating the lhs or rhs of a mapping to printable chars.
1671 * Advances "sp" to the next code.
1672 */
1673 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001674str2special(
1675 char_u **sp,
1676 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677{
1678 int c;
1679 static char_u buf[7];
1680 char_u *str = *sp;
1681 int modifiers = 0;
1682 int special = FALSE;
1683
1684#ifdef FEAT_MBYTE
1685 if (has_mbyte)
1686 {
1687 char_u *p;
1688
1689 /* Try to un-escape a multi-byte character. Return the un-escaped
1690 * string if it is a multi-byte character. */
1691 p = mb_unescape(sp);
1692 if (p != NULL)
1693 return p;
1694 }
1695#endif
1696
1697 c = *str;
1698 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1699 {
1700 if (str[1] == KS_MODIFIER)
1701 {
1702 modifiers = str[2];
1703 str += 3;
1704 c = *str;
1705 }
1706 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1707 {
1708 c = TO_SPECIAL(str[1], str[2]);
1709 str += 2;
Bram Moolenaar37985192013-06-07 19:53:10 +02001710 if (c == KS_ZERO) /* display <Nul> as ^@ or <Nul> */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 c = NUL;
1712 }
1713 if (IS_SPECIAL(c) || modifiers) /* special key */
1714 special = TRUE;
1715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716
1717#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001718 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001720 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001721
1722 /* For multi-byte characters check for an illegal byte. */
1723 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1724 {
1725 transchar_nonprint(buf, c);
1726 *sp = str + 1;
1727 return buf;
1728 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001729 /* Since 'special' is TRUE the multi-byte character 'c' will be
1730 * processed by get_special_key_name() */
1731 c = (*mb_ptr2char)(str);
1732 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001734 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001736 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1739 * Use <Space> only for lhs of a mapping. */
1740 if (special || char2cells(c) > 1 || (from && c == ' '))
1741 return get_special_key_name(c, modifiers);
1742 buf[0] = c;
1743 buf[1] = NUL;
1744 return buf;
1745}
1746
1747/*
1748 * Translate a key sequence into special key names.
1749 */
1750 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001751str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752{
1753 char_u *s;
1754
1755 *buf = NUL;
1756 while (*sp)
1757 {
1758 s = str2special(&sp, FALSE);
1759 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1760 STRCAT(buf, s);
1761 }
1762}
1763
1764/*
1765 * print line for :print or :list command
1766 */
1767 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001768msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769{
1770 int c;
1771 int col = 0;
1772 int n_extra = 0;
1773 int c_extra = 0;
1774 char_u *p_extra = NULL; /* init to make SASC shut up */
1775 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001776 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 char_u *trail = NULL;
1778#ifdef FEAT_MBYTE
1779 int l;
1780 char_u buf[MB_MAXBYTES + 1];
1781#endif
1782
Bram Moolenaardf177f62005-02-22 08:39:57 +00001783 if (curwin->w_p_list)
1784 list = TRUE;
1785
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001787 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 {
1789 trail = s + STRLEN(s);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001790 while (trail > s && VIM_ISWHITE(trail[-1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 --trail;
1792 }
1793
1794 /* output a space for an empty line, otherwise the line will be
1795 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001796 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 msg_putchar(' ');
1798
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001799 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001801 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
1803 --n_extra;
1804 if (c_extra)
1805 c = c_extra;
1806 else
1807 c = *p_extra++;
1808 }
1809#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001810 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 {
1812 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001813 if (lcs_nbsp != NUL && list
1814 && (mb_ptr2char(s) == 160
1815 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001816 {
1817 mb_char2bytes(lcs_nbsp, buf);
1818 buf[(*mb_ptr2len)(buf)] = NUL;
1819 }
1820 else
1821 {
1822 mch_memmove(buf, s, (size_t)l);
1823 buf[l] = NUL;
1824 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001825 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 s += l;
1827 continue;
1828 }
1829#endif
1830 else
1831 {
1832 attr = 0;
1833 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001834 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 {
1836 /* tab amount depends on current column */
1837 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001838 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 {
1840 c = ' ';
1841 c_extra = ' ';
1842 }
1843 else
1844 {
1845 c = lcs_tab1;
1846 c_extra = lcs_tab2;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001847 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 }
1849 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001850 else if (c == 160 && list && lcs_nbsp != NUL)
1851 {
1852 c = lcs_nbsp;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001853 attr = HL_ATTR(HLF_8);
Bram Moolenaaracf17282011-02-01 17:12:25 +01001854 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001855 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 {
1857 p_extra = (char_u *)"";
1858 c_extra = NUL;
1859 n_extra = 1;
1860 c = lcs_eol;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001861 attr = HL_ATTR(HLF_AT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 --s;
1863 }
1864 else if (c != NUL && (n = byte2cells(c)) > 1)
1865 {
1866 n_extra = n - 1;
1867 p_extra = transchar_byte(c);
1868 c_extra = NUL;
1869 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001870 /* Use special coloring to be able to distinguish <hex> from
1871 * the same in plain text. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001872 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 }
1874 else if (c == ' ' && trail != NULL && s > trail)
1875 {
1876 c = lcs_trail;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001877 attr = HL_ATTR(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001879 else if (c == ' ' && list && lcs_space != NUL)
1880 {
1881 c = lcs_space;
Bram Moolenaar8820b482017-03-16 17:23:31 +01001882 attr = HL_ATTR(HLF_8);
Bram Moolenaar1510f992015-04-22 22:18:22 +02001883 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 }
1885
1886 if (c == NUL)
1887 break;
1888
1889 msg_putchar_attr(c, attr);
1890 col++;
1891 }
1892 msg_clr_eos();
1893}
1894
1895#ifdef FEAT_MBYTE
1896/*
1897 * Use screen_puts() to output one multi-byte character.
1898 * Return the pointer "s" advanced to the next character.
1899 */
1900 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001901screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902{
1903 int cw;
1904
1905 msg_didout = TRUE; /* remember that line is not empty */
1906 cw = (*mb_ptr2cells)(s);
1907 if (cw > 1 && (
1908#ifdef FEAT_RIGHTLEFT
1909 cmdmsg_rl ? msg_col <= 1 :
1910#endif
1911 msg_col == Columns - 1))
1912 {
1913 /* Doesn't fit, print a highlighted '>' to fill it up. */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001914 msg_screen_putchar('>', HL_ATTR(HLF_AT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 return s;
1916 }
1917
1918 screen_puts_len(s, l, msg_row, msg_col, attr);
1919#ifdef FEAT_RIGHTLEFT
1920 if (cmdmsg_rl)
1921 {
1922 msg_col -= cw;
1923 if (msg_col == 0)
1924 {
1925 msg_col = Columns;
1926 ++msg_row;
1927 }
1928 }
1929 else
1930#endif
1931 {
1932 msg_col += cw;
1933 if (msg_col >= Columns)
1934 {
1935 msg_col = 0;
1936 ++msg_row;
1937 }
1938 }
1939 return s + l;
1940}
1941#endif
1942
1943/*
1944 * Output a string to the screen at position msg_row, msg_col.
1945 * Update msg_row and msg_col for the next message.
1946 */
1947 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001948msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949{
Bram Moolenaaraeac9002016-09-06 22:15:08 +02001950 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951}
1952
1953 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001954msg_puts_title(
1955 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956{
Bram Moolenaar8820b482017-03-16 17:23:31 +01001957 msg_puts_attr(s, HL_ATTR(HLF_T));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958}
1959
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960/*
1961 * Show a message in such a way that it always fits in the line. Cut out a
1962 * part in the middle and replace it with "..." when necessary.
1963 * Does not handle multi-byte characters!
1964 */
1965 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001966msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001968 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969}
1970
1971 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001972msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973{
1974 int slen = len;
1975 int room;
1976
1977 room = Columns - msg_col;
1978 if (len > room && room >= 20)
1979 {
1980 slen = (room - 3) / 2;
1981 msg_outtrans_len_attr(longstr, slen, attr);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001982 msg_puts_attr((char_u *)"...", HL_ATTR(HLF_8));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 }
1984 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1985}
1986
1987/*
1988 * Basic function for writing a message with highlight attributes.
1989 */
1990 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001991msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992{
1993 msg_puts_attr_len(s, -1, attr);
1994}
1995
1996/*
1997 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1998 * When "maxlen" is -1 there is no maximum length.
1999 * When "maxlen" is >= 0 the message is not put in the history.
2000 */
2001 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002002msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 /*
2005 * If redirection is on, also write to the redirection file.
2006 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002007 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008
2009 /*
2010 * Don't print anything when using ":silent cmd".
2011 */
2012 if (msg_silent != 0)
2013 return;
2014
2015 /* if MSG_HIST flag set, add message to history */
2016 if ((attr & MSG_HIST) && maxlen < 0)
2017 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002018 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 attr &= ~MSG_HIST;
2020 }
2021
2022 /*
2023 * When writing something to the screen after it has scrolled, requires a
2024 * wait-return prompt later. Needed when scrolling, resetting
2025 * need_wait_return after some prompt, and then outputting something
2026 * without scrolling
2027 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002028 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 need_wait_return = TRUE;
2030 msg_didany = TRUE; /* remember that something was outputted */
2031
2032 /*
2033 * If there is no valid screen, use fprintf so we can see error messages.
2034 * If termcap is not active, we may be writing in an alternate console
2035 * window, cursor positioning may not work correctly (window size may be
2036 * different, e.g. for Win32 console) or we just don't know where the
2037 * cursor is.
2038 */
2039 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002040 msg_puts_printf(str, maxlen);
2041 else
2042 msg_puts_display(str, maxlen, attr, FALSE);
2043}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002045/*
2046 * The display part of msg_puts_attr_len().
2047 * May be called recursively to display scroll-back text.
2048 */
2049 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002050msg_puts_display(
2051 char_u *str,
2052 int maxlen,
2053 int attr,
2054 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002055{
2056 char_u *s = str;
2057 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
2058 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
2059#ifdef FEAT_MBYTE
2060 int l;
2061 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002063 char_u *sb_str = str;
2064 int sb_col = msg_col;
2065 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002066 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067
2068 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00002069 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 {
2071 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002072 * We are at the end of the screen line when:
2073 * - When outputting a newline.
2074 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002076 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077#ifdef FEAT_RIGHTLEFT
2078 cmdmsg_rl
2079 ? (
2080 msg_col <= 1
2081 || (*s == TAB && msg_col <= 7)
2082# ifdef FEAT_MBYTE
2083 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
2084# endif
2085 )
2086 :
2087#endif
2088 (msg_col + t_col >= Columns - 1
2089 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
2090# ifdef FEAT_MBYTE
2091 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2092 && msg_col + t_col >= Columns - 2)
2093# endif
2094 ))))
2095 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002096 /*
2097 * The screen is scrolled up when at the last row (some terminals
2098 * scroll automatically, some don't. To avoid problems we scroll
2099 * ourselves).
2100 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002103 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002105 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 if (msg_no_more && lines_left == 0)
2107 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002109 /* Scroll the screen up one line. */
2110 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111
2112 msg_row = Rows - 2;
2113 if (msg_col >= Columns) /* can happen after screen resize */
2114 msg_col = Columns - 1;
2115
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002116 /* Display char in last column before showing more-prompt. */
2117 if (*s >= ' '
2118#ifdef FEAT_RIGHTLEFT
2119 && !cmdmsg_rl
2120#endif
2121 )
2122 {
2123#ifdef FEAT_MBYTE
2124 if (has_mbyte)
2125 {
2126 if (enc_utf8 && maxlen >= 0)
2127 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002128 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002129 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002130 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002131 s = screen_puts_mbyte(s, l, attr);
2132 }
2133 else
2134#endif
2135 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002136 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002137 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002138 else
2139 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002140
2141 if (p_more)
2142 /* store text for scrolling back */
2143 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
2144
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002145 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002146 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 redraw_cmdline = TRUE;
2148 if (cmdline_row > 0 && !exmode_active)
2149 --cmdline_row;
2150
2151 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002152 * If screen is completely filled and 'more' is set then wait
2153 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002155 if (lines_left > 0)
2156 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00002157 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 && !msg_no_more && !exmode_active)
2159 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002161 if (do_more_prompt(NUL))
2162 s = confirm_msg_tail;
2163#else
2164 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165#endif
2166 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002167 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002169
2170 /* When we displayed a char in last column need to check if there
2171 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002172 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002173 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 }
2175
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002176 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 || msg_col + t_col >= Columns
2178#ifdef FEAT_MBYTE
2179 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2180 && msg_col + t_col >= Columns - 1)
2181#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002182 ;
2183 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2184 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002186 t_puts(&t_col, t_s, s, attr);
2187
2188 if (wrap && p_more && !recurse)
2189 /* store text for scrolling back */
2190 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191
2192 if (*s == '\n') /* go to next line */
2193 {
2194 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002195#ifdef FEAT_RIGHTLEFT
2196 if (cmdmsg_rl)
2197 msg_col = Columns - 1;
2198 else
2199#endif
2200 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 if (++msg_row >= Rows) /* safety check */
2202 msg_row = Rows - 1;
2203 }
2204 else if (*s == '\r') /* go to column 0 */
2205 {
2206 msg_col = 0;
2207 }
2208 else if (*s == '\b') /* go to previous char */
2209 {
2210 if (msg_col)
2211 --msg_col;
2212 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002213 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 {
2215 do
2216 msg_screen_putchar(' ', attr);
2217 while (msg_col & 7);
2218 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002219 else if (*s == BELL) /* beep (from ":sh") */
2220 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 else
2222 {
2223#ifdef FEAT_MBYTE
2224 if (has_mbyte)
2225 {
2226 cw = (*mb_ptr2cells)(s);
2227 if (enc_utf8 && maxlen >= 0)
2228 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002229 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002231 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 }
2233 else
2234 {
2235 cw = 1;
2236 l = 1;
2237 }
2238#endif
2239 /* When drawing from right to left or when a double-wide character
2240 * doesn't fit, draw a single character here. Otherwise collect
2241 * characters and draw them all at once later. */
2242#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2243 if (
2244# ifdef FEAT_RIGHTLEFT
2245 cmdmsg_rl
2246# ifdef FEAT_MBYTE
2247 ||
2248# endif
2249# endif
2250# ifdef FEAT_MBYTE
2251 (cw > 1 && msg_col + t_col >= Columns - 1)
2252# endif
2253 )
2254 {
2255# ifdef FEAT_MBYTE
2256 if (l > 1)
2257 s = screen_puts_mbyte(s, l, attr) - 1;
2258 else
2259# endif
2260 msg_screen_putchar(*s, attr);
2261 }
2262 else
2263#endif
2264 {
2265 /* postpone this character until later */
2266 if (t_col == 0)
2267 t_s = s;
2268#ifdef FEAT_MBYTE
2269 t_col += cw;
2270 s += l - 1;
2271#else
2272 ++t_col;
2273#endif
2274 }
2275 }
2276 ++s;
2277 }
2278
2279 /* output any postponed text */
2280 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002281 t_puts(&t_col, t_s, s, attr);
2282 if (p_more && !recurse)
2283 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284
2285 msg_check();
2286}
2287
2288/*
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002289 * Return TRUE when ":filter pattern" was used and "msg" does not match
2290 * "pattern".
2291 */
2292 int
2293message_filtered(char_u *msg)
2294{
Bram Moolenaard29459b2016-08-26 22:29:11 +02002295 int match;
2296
2297 if (cmdmod.filter_regmatch.regprog == NULL)
2298 return FALSE;
2299 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0);
2300 return cmdmod.filter_force ? match : !match;
Bram Moolenaar7b668e82016-08-23 23:51:21 +02002301}
2302
2303/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002304 * Scroll the screen up one line for displaying the next message line.
2305 */
2306 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002307msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002308{
2309#ifdef FEAT_GUI
2310 /* Remove the cursor before scrolling, ScreenLines[] is going
2311 * to become invalid. */
2312 if (gui.in_use)
2313 gui_undraw_cursor();
2314#endif
2315 /* scrolling up always works */
2316 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2317
2318 if (!can_clear((char_u *)" "))
2319 {
2320 /* Scrolling up doesn't result in the right background. Set the
2321 * background here. It's not efficient, but avoids that we have to do
2322 * it all over the code. */
2323 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2324
2325 /* Also clear the last char of the last but one line if it was not
2326 * cleared before to avoid a scroll-up. */
2327 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2328 screen_fill((int)Rows - 2, (int)Rows - 1,
2329 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2330 }
2331}
2332
2333/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002334 * Increment "msg_scrolled".
2335 */
2336 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002337inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002338{
2339#ifdef FEAT_EVAL
2340 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2341 {
2342 char_u *p = sourcing_name;
2343 char_u *tofree = NULL;
2344 int len;
2345
2346 /* v:scrollstart is empty, set it to the script/function name and line
2347 * number */
2348 if (p == NULL)
2349 p = (char_u *)_("Unknown");
2350 else
2351 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002352 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002353 tofree = alloc(len);
2354 if (tofree != NULL)
2355 {
2356 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2357 p, (long)sourcing_lnum);
2358 p = tofree;
2359 }
2360 }
2361 set_vim_var_string(VV_SCROLLSTART, p, -1);
2362 vim_free(tofree);
2363 }
2364#endif
2365 ++msg_scrolled;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002366 if (must_redraw < VALID)
2367 must_redraw = VALID;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002368}
2369
2370/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002371 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2372 * store the displayed text and remember where screen lines start.
2373 */
2374typedef struct msgchunk_S msgchunk_T;
2375struct msgchunk_S
2376{
2377 msgchunk_T *sb_next;
2378 msgchunk_T *sb_prev;
2379 char sb_eol; /* TRUE when line ends after this text */
2380 int sb_msg_col; /* column in which text starts */
2381 int sb_attr; /* text attributes */
2382 char_u sb_text[1]; /* text to be displayed, actually longer */
2383};
2384
2385static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2386
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002387static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2388static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002389
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002390typedef enum {
2391 SB_CLEAR_NONE = 0,
2392 SB_CLEAR_ALL,
2393 SB_CLEAR_CMDLINE_BUSY,
2394 SB_CLEAR_CMDLINE_DONE
2395} sb_clear_T;
2396
2397/* When to clear text on next msg. */
2398static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002399
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002400/*
2401 * Store part of a printed message for displaying when scrolling back.
2402 */
2403 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002404store_sb_text(
2405 char_u **sb_str, /* start of string */
2406 char_u *s, /* just after string */
2407 int attr,
2408 int *sb_col,
2409 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002410{
2411 msgchunk_T *mp;
2412
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002413 if (do_clear_sb_text == SB_CLEAR_ALL
2414 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002415 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002416 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL);
2417 do_clear_sb_text = SB_CLEAR_NONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002418 }
2419
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002420 if (s > *sb_str)
2421 {
2422 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2423 if (mp != NULL)
2424 {
2425 mp->sb_eol = finish;
2426 mp->sb_msg_col = *sb_col;
2427 mp->sb_attr = attr;
2428 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2429
2430 if (last_msgchunk == NULL)
2431 {
2432 last_msgchunk = mp;
2433 mp->sb_prev = NULL;
2434 }
2435 else
2436 {
2437 mp->sb_prev = last_msgchunk;
2438 last_msgchunk->sb_next = mp;
2439 last_msgchunk = mp;
2440 }
2441 mp->sb_next = NULL;
2442 }
2443 }
2444 else if (finish && last_msgchunk != NULL)
2445 last_msgchunk->sb_eol = TRUE;
2446
2447 *sb_str = s;
2448 *sb_col = 0;
2449}
2450
2451/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002452 * Finished showing messages, clear the scroll-back text on the next message.
2453 */
2454 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002455may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002456{
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002457 do_clear_sb_text = SB_CLEAR_ALL;
2458}
2459
2460/*
2461 * Starting to edit the command line, do not clear messages now.
2462 */
2463 void
2464sb_text_start_cmdline(void)
2465{
2466 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY;
2467 msg_sb_eol();
2468}
2469
2470/*
2471 * Ending to edit the command line. Clear old lines but the last one later.
2472 */
2473 void
2474sb_text_end_cmdline(void)
2475{
2476 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002477}
2478
2479/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002480 * Clear any text remembered for scrolling back.
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002481 * When "all" is FALSE keep the last line.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002482 * Called when redrawing the screen.
2483 */
2484 void
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002485clear_sb_text(int all)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002486{
2487 msgchunk_T *mp;
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002488 msgchunk_T **lastp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002489
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002490 if (all)
2491 lastp = &last_msgchunk;
2492 else
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002493 {
Bram Moolenaarf2405ed2017-03-16 19:58:25 +01002494 if (last_msgchunk == NULL)
2495 return;
2496 lastp = &last_msgchunk->sb_prev;
2497 }
2498
2499 while (*lastp != NULL)
2500 {
2501 mp = (*lastp)->sb_prev;
2502 vim_free(*lastp);
2503 *lastp = mp;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002504 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002505}
2506
2507/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002508 * "g<" command.
2509 */
2510 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002511show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002512{
2513 msgchunk_T *mp;
2514
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002515 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002516 * weird, typing a command without output results in one line. */
2517 mp = msg_sb_start(last_msgchunk);
2518 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002519 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002520 else
2521 {
2522 do_more_prompt('G');
2523 wait_return(FALSE);
2524 }
2525}
2526
2527/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002528 * Move to the start of screen line in already displayed text.
2529 */
2530 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002531msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002532{
2533 msgchunk_T *mp = mps;
2534
2535 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2536 mp = mp->sb_prev;
2537 return mp;
2538}
2539
2540/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002541 * Mark the last message chunk as finishing the line.
2542 */
2543 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002544msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002545{
2546 if (last_msgchunk != NULL)
2547 last_msgchunk->sb_eol = TRUE;
2548}
2549
2550/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002551 * Display a screen line from previously displayed text at row "row".
2552 * Returns a pointer to the text for the next line (can be NULL).
2553 */
2554 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002555disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002556{
2557 msgchunk_T *mp = smp;
2558 char_u *p;
2559
2560 for (;;)
2561 {
2562 msg_row = row;
2563 msg_col = mp->sb_msg_col;
2564 p = mp->sb_text;
2565 if (*p == '\n') /* don't display the line break */
2566 ++p;
2567 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2568 if (mp->sb_eol || mp->sb_next == NULL)
2569 break;
2570 mp = mp->sb_next;
2571 }
2572 return mp->sb_next;
2573}
2574
2575/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 * Output any postponed text for msg_puts_attr_len().
2577 */
2578 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002579t_puts(
2580 int *t_col,
2581 char_u *t_s,
2582 char_u *s,
2583 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584{
2585 /* output postponed text */
2586 msg_didout = TRUE; /* remember that line is not empty */
2587 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002588 msg_col += *t_col;
2589 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590#ifdef FEAT_MBYTE
2591 /* If the string starts with a composing character don't increment the
2592 * column position for it. */
2593 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2594 --msg_col;
2595#endif
2596 if (msg_col >= Columns)
2597 {
2598 msg_col = 0;
2599 ++msg_row;
2600 }
2601}
2602
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603/*
2604 * Returns TRUE when messages should be printed with mch_errmsg().
2605 * This is used when there is no valid screen, so we can see error messages.
2606 * If termcap is not active, we may be writing in an alternate console
2607 * window, cursor positioning may not work correctly (window size may be
2608 * different, e.g. for Win32 console) or we just don't know where the
2609 * cursor is.
2610 */
2611 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002612msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613{
2614 return (!msg_check_screen()
2615#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2616 || !termcap_active
2617#endif
2618 || (swapping_screen() && !termcap_active)
2619 );
2620}
2621
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002622/*
2623 * Print a message when there is no valid screen.
2624 */
2625 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002626msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002627{
2628 char_u *s = str;
2629 char_u buf[4];
2630 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002631#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002632# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2633 char_u *ccp = NULL;
2634
2635# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002636 if (!(silent_mode && p_verbose == 0))
2637 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002638
2639# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2640 if (enc_codepage >= 0 && (int)GetConsoleCP() != enc_codepage)
2641 {
Bram Moolenaar116a0f82017-08-07 21:17:57 +02002642 int inlen = (int)STRLEN(str);
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002643 int outlen;
2644 WCHAR *widestr = (WCHAR *)enc_to_utf16(str, &inlen);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002645
2646 if (widestr != NULL)
2647 {
Bram Moolenaar1b66c002017-08-03 18:55:00 +02002648 WideCharToMultiByte_alloc(GetConsoleCP(), 0, widestr, inlen,
2649 (LPSTR *)&ccp, &outlen, 0, 0);
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002650 vim_free(widestr);
2651 s = str = ccp;
2652 }
2653 }
2654# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002655#endif
Bram Moolenaar2321ca22016-09-09 14:17:18 +02002656 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002657 {
2658 if (!(silent_mode && p_verbose == 0))
2659 {
2660 /* NL --> CR NL translation (for Unix, not for "--version") */
2661 /* NL --> CR translation (for Mac) */
2662 p = &buf[0];
2663 if (*s == '\n' && !info_message)
2664 *p++ = '\r';
2665#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2666 else
2667#endif
2668 *p++ = *s;
2669 *p = '\0';
2670 if (info_message) /* informative message, not an error */
2671 mch_msg((char *)buf);
2672 else
2673 mch_errmsg((char *)buf);
2674 }
2675
2676 /* primitive way to compute the current column */
2677#ifdef FEAT_RIGHTLEFT
2678 if (cmdmsg_rl)
2679 {
2680 if (*s == '\r' || *s == '\n')
2681 msg_col = Columns - 1;
2682 else
2683 --msg_col;
2684 }
2685 else
2686#endif
2687 {
2688 if (*s == '\r' || *s == '\n')
2689 msg_col = 0;
2690 else
2691 ++msg_col;
2692 }
2693 ++s;
2694 }
2695 msg_didout = TRUE; /* assume that line is not empty */
2696
2697#ifdef WIN3264
Bram Moolenaar01efafa2017-08-03 17:37:48 +02002698# if defined(FEAT_MBYTE) && !defined(FEAT_GUI_MSWIN)
2699 vim_free(ccp);
2700# endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002701 if (!(silent_mode && p_verbose == 0))
2702 mch_settmode(TMODE_RAW);
2703#endif
2704}
2705
2706/*
2707 * Show the more-prompt and handle the user response.
2708 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002709 * When at hit-enter prompt "typed_char" is the already typed character,
2710 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002711 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2712 */
2713 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002714do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002715{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002716 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002717 int used_typed_char = typed_char;
2718 int oldState = State;
2719 int c;
2720#ifdef FEAT_CON_DIALOG
2721 int retval = FALSE;
2722#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002723 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002724 msgchunk_T *mp_last = NULL;
2725 msgchunk_T *mp;
2726 int i;
2727
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002728 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002729 * that case don't show another prompt. Also when at the hit-Enter prompt
2730 * and nothing was typed. */
2731 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002732 return FALSE;
2733 entered = TRUE;
2734
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002735 if (typed_char == 'G')
2736 {
2737 /* "g<": Find first line on the last page. */
2738 mp_last = msg_sb_start(last_msgchunk);
2739 for (i = 0; i < Rows - 2 && mp_last != NULL
2740 && mp_last->sb_prev != NULL; ++i)
2741 mp_last = msg_sb_start(mp_last->sb_prev);
2742 }
2743
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002744 State = ASKMORE;
2745#ifdef FEAT_MOUSE
2746 setmouse();
2747#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002748 if (typed_char == NUL)
2749 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002750 for (;;)
2751 {
2752 /*
2753 * Get a typed character directly from the user.
2754 */
2755 if (used_typed_char != NUL)
2756 {
2757 c = used_typed_char; /* was typed at hit-enter prompt */
2758 used_typed_char = NUL;
2759 }
2760 else
2761 c = get_keystroke();
2762
2763#if defined(FEAT_MENU) && defined(FEAT_GUI)
2764 if (c == K_MENU)
2765 {
2766 int idx = get_menu_index(current_menu, ASKMORE);
2767
2768 /* Used a menu. If it starts with CTRL-Y, it must
2769 * be a "Copy" for the clipboard. Otherwise
2770 * assume that we end */
2771 if (idx == MENU_INDEX_INVALID)
2772 continue;
2773 c = *current_menu->strings[idx];
2774 if (c != NUL && current_menu->strings[idx][1] != NUL)
2775 ins_typebuf(current_menu->strings[idx] + 1,
2776 current_menu->noremap[idx], 0, TRUE,
2777 current_menu->silent[idx]);
2778 }
2779#endif
2780
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002781 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002782 switch (c)
2783 {
2784 case BS: /* scroll one line back */
2785 case K_BS:
2786 case 'k':
2787 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002788 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002789 break;
2790
2791 case CAR: /* one extra line */
2792 case NL:
2793 case 'j':
2794 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002795 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002796 break;
2797
2798 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002799 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002800 break;
2801
2802 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002803 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002804 break;
2805
2806 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002807 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002808 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002809 break;
2810
2811 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002812 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002813 case K_PAGEDOWN:
2814 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002815 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002816 break;
2817
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002818 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002819 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002820 break;
2821
2822 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002823 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002824 lines_left = 999999;
2825 break;
2826
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002827 case ':': /* start new command line */
2828#ifdef FEAT_CON_DIALOG
2829 if (!confirm_msg_used)
2830#endif
2831 {
2832 /* Since got_int is set all typeahead will be flushed, but we
2833 * want to keep this ':', remember that in a special way. */
2834 typeahead_noflush(':');
2835 cmdline_row = Rows - 1; /* put ':' on this line */
2836 skip_redraw = TRUE; /* skip redraw once */
2837 need_wait_return = FALSE; /* don't wait in main() */
2838 }
2839 /*FALLTHROUGH*/
2840 case 'q': /* quit */
2841 case Ctrl_C:
2842 case ESC:
2843#ifdef FEAT_CON_DIALOG
2844 if (confirm_msg_used)
2845 {
2846 /* Jump to the choices of the dialog. */
2847 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002848 }
2849 else
2850#endif
2851 {
2852 got_int = TRUE;
2853 quit_more = TRUE;
2854 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002855 /* When there is some more output (wrapping line) display that
2856 * without another prompt. */
2857 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002858 break;
2859
2860#ifdef FEAT_CLIPBOARD
2861 case Ctrl_Y:
2862 /* Strange way to allow copying (yanking) a modeless
2863 * selection at the more prompt. Use CTRL-Y,
2864 * because the same is used in Cmdline-mode and at the
2865 * hit-enter prompt. However, scrolling one line up
2866 * might be expected... */
2867 if (clip_star.state == SELECT_DONE)
2868 clip_copy_modeless_selection(TRUE);
2869 continue;
2870#endif
2871 default: /* no valid response */
2872 msg_moremsg(TRUE);
2873 continue;
2874 }
2875
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002876 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002877 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002878 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002879 {
2880 /* go to start of last line */
2881 if (mp_last == NULL)
2882 mp = msg_sb_start(last_msgchunk);
2883 else if (mp_last->sb_prev != NULL)
2884 mp = msg_sb_start(mp_last->sb_prev);
2885 else
2886 mp = NULL;
2887
2888 /* go to start of line at top of the screen */
2889 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2890 ++i)
2891 mp = msg_sb_start(mp->sb_prev);
2892
2893 if (mp != NULL && mp->sb_prev != NULL)
2894 {
2895 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002896 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002897 {
2898 if (mp == NULL || mp->sb_prev == NULL)
2899 break;
2900 mp = msg_sb_start(mp->sb_prev);
2901 if (mp_last == NULL)
2902 mp_last = msg_sb_start(last_msgchunk);
2903 else
2904 mp_last = msg_sb_start(mp_last->sb_prev);
2905 }
2906
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002907 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002908 (int)Rows, NULL) == OK)
2909 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002910 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002911 (void)disp_sb_line(0, mp);
2912 }
2913 else
2914 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002915 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002916 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002917 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2918 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002919 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002920 ++msg_scrolled;
2921 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002922 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002923 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002924 }
2925 }
2926 else
2927 {
2928 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002929 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002930 {
2931 /* scroll up, display line at bottom */
2932 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002933 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002934 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2935 (int)Columns, ' ', ' ', 0);
2936 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002937 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002938 }
2939 }
2940
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002941 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002942 {
2943 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002944 screen_fill((int)Rows - 1, (int)Rows, 0,
2945 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002946 msg_moremsg(FALSE);
2947 continue;
2948 }
2949
2950 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002951 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002952 }
2953
2954 break;
2955 }
2956
2957 /* clear the --more-- message */
2958 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2959 State = oldState;
2960#ifdef FEAT_MOUSE
2961 setmouse();
2962#endif
2963 if (quit_more)
2964 {
2965 msg_row = Rows - 1;
2966 msg_col = 0;
2967 }
2968#ifdef FEAT_RIGHTLEFT
2969 else if (cmdmsg_rl)
2970 msg_col = Columns - 1;
2971#endif
2972
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002973 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002974#ifdef FEAT_CON_DIALOG
2975 return retval;
2976#else
2977 return FALSE;
2978#endif
2979}
2980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2982
2983#ifdef mch_errmsg
2984# undef mch_errmsg
2985#endif
2986#ifdef mch_msg
2987# undef mch_msg
2988#endif
2989
2990/*
2991 * Give an error message. To be used when the screen hasn't been initialized
2992 * yet. When stderr can't be used, collect error messages until the GUI has
2993 * started and they can be displayed in a message box.
2994 */
2995 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002996mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997{
2998 int len;
2999
3000#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3001 /* On Unix use stderr if it's a tty.
3002 * When not going to start the GUI also use stderr.
3003 * On Mac, when started from Finder, stderr is the console. */
3004 if (
3005# ifdef UNIX
3006# ifdef MACOS_X_UNIX
3007 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3008# else
3009 isatty(2)
3010# endif
3011# ifdef FEAT_GUI
3012 ||
3013# endif
3014# endif
3015# ifdef FEAT_GUI
3016 !(gui.in_use || gui.starting)
3017# endif
3018 )
3019 {
3020 fprintf(stderr, "%s", str);
3021 return;
3022 }
3023#endif
3024
3025 /* avoid a delay for a message that isn't there */
3026 emsg_on_display = FALSE;
3027
3028 len = (int)STRLEN(str) + 1;
3029 if (error_ga.ga_growsize == 0)
3030 {
3031 error_ga.ga_growsize = 80;
3032 error_ga.ga_itemsize = 1;
3033 }
3034 if (ga_grow(&error_ga, len) == OK)
3035 {
3036 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
3037 (char_u *)str, len);
3038#ifdef UNIX
3039 /* remove CR characters, they are displayed */
3040 {
3041 char_u *p;
3042
3043 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
3044 for (;;)
3045 {
3046 p = vim_strchr(p, '\r');
3047 if (p == NULL)
3048 break;
3049 *p = ' ';
3050 }
3051 }
3052#endif
3053 --len; /* don't count the NUL at the end */
3054 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 }
3056}
3057
3058/*
3059 * Give a message. To be used when the screen hasn't been initialized yet.
3060 * When there is no tty, collect messages until the GUI has started and they
3061 * can be displayed in a message box.
3062 */
3063 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003064mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065{
3066#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
3067 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
3068 * uses mch_errmsg() when started from the desktop.
3069 * When not going to start the GUI also use stdout.
3070 * On Mac, when started from Finder, stderr is the console. */
3071 if (
3072# ifdef UNIX
3073# ifdef MACOS_X_UNIX
3074 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
3075# else
3076 isatty(2)
3077# endif
3078# ifdef FEAT_GUI
3079 ||
3080# endif
3081# endif
3082# ifdef FEAT_GUI
3083 !(gui.in_use || gui.starting)
3084# endif
3085 )
3086 {
3087 printf("%s", str);
3088 return;
3089 }
3090# endif
3091 mch_errmsg(str);
3092}
3093#endif /* USE_MCH_ERRMSG */
3094
3095/*
3096 * Put a character on the screen at the current message position and advance
3097 * to the next position. Only for printable ASCII!
3098 */
3099 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003100msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101{
3102 msg_didout = TRUE; /* remember that line is not empty */
3103 screen_putchar(c, msg_row, msg_col, attr);
3104#ifdef FEAT_RIGHTLEFT
3105 if (cmdmsg_rl)
3106 {
3107 if (--msg_col == 0)
3108 {
3109 msg_col = Columns;
3110 ++msg_row;
3111 }
3112 }
3113 else
3114#endif
3115 {
3116 if (++msg_col >= Columns)
3117 {
3118 msg_col = 0;
3119 ++msg_row;
3120 }
3121 }
3122}
3123
3124 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003125msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003127 int attr;
3128 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129
Bram Moolenaar8820b482017-03-16 17:23:31 +01003130 attr = HL_ATTR(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003131 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003133 screen_puts((char_u *)
3134 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
3135 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136}
3137
3138/*
3139 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
3140 * exmode_active.
3141 */
3142 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003143repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144{
3145 if (State == ASKMORE)
3146 {
3147 msg_moremsg(TRUE); /* display --more-- message again */
3148 msg_row = Rows - 1;
3149 }
3150#ifdef FEAT_CON_DIALOG
3151 else if (State == CONFIRM)
3152 {
3153 display_confirm_msg(); /* display ":confirm" message again */
3154 msg_row = Rows - 1;
3155 }
3156#endif
3157 else if (State == EXTERNCMD)
3158 {
3159 windgoto(msg_row, msg_col); /* put cursor back */
3160 }
3161 else if (State == HITRETURN || State == SETWSIZE)
3162 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00003163 if (msg_row == Rows - 1)
3164 {
3165 /* Avoid drawing the "hit-enter" prompt below the previous one,
3166 * overwrite it. Esp. useful when regaining focus and a
3167 * FocusGained autocmd exists but didn't draw anything. */
3168 msg_didout = FALSE;
3169 msg_col = 0;
3170 msg_clr_eos();
3171 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 hit_return_msg();
3173 msg_row = Rows - 1;
3174 }
3175}
3176
3177/*
3178 * msg_check_screen - check if the screen is initialized.
3179 * Also check msg_row and msg_col, if they are too big it may cause a crash.
3180 * While starting the GUI the terminal codes will be set for the GUI, but the
3181 * output goes to the terminal. Don't use the terminal codes then.
3182 */
3183 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003184msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185{
3186 if (!full_screen || !screen_valid(FALSE))
3187 return FALSE;
3188
3189 if (msg_row >= Rows)
3190 msg_row = Rows - 1;
3191 if (msg_col >= Columns)
3192 msg_col = Columns - 1;
3193 return TRUE;
3194}
3195
3196/*
3197 * Clear from current message position to end of screen.
3198 * Skip this when ":silent" was used, no need to clear for redirection.
3199 */
3200 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003201msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202{
3203 if (msg_silent == 0)
3204 msg_clr_eos_force();
3205}
3206
3207/*
3208 * Clear from current message position to end of screen.
3209 * Note: msg_col is not updated, so we remember the end of the message
3210 * for msg_check().
3211 */
3212 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003213msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214{
3215 if (msg_use_printf())
3216 {
3217 if (full_screen) /* only when termcap codes are valid */
3218 {
3219 if (*T_CD)
3220 out_str(T_CD); /* clear to end of display */
3221 else if (*T_CE)
3222 out_str(T_CE); /* clear to end of line */
3223 }
3224 }
3225 else
3226 {
3227#ifdef FEAT_RIGHTLEFT
3228 if (cmdmsg_rl)
3229 {
3230 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
3231 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3232 }
3233 else
3234#endif
3235 {
3236 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
3237 ' ', ' ', 0);
3238 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
3239 }
3240 }
3241}
3242
3243/*
3244 * Clear the command line.
3245 */
3246 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003247msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248{
3249 msg_row = cmdline_row;
3250 msg_col = 0;
3251 msg_clr_eos_force();
3252}
3253
3254/*
3255 * end putting a message on the screen
3256 * call wait_return if the message does not fit in the available space
3257 * return TRUE if wait_return not called.
3258 */
3259 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003260msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261{
3262 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003263 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 * or the ruler option is set and we run into it,
3265 * we have to redraw the window.
3266 * Do not do this if we are abandoning the file or editing the command line.
3267 */
3268 if (!exiting && need_wait_return && !(State & CMDLINE))
3269 {
3270 wait_return(FALSE);
3271 return FALSE;
3272 }
3273 out_flush();
3274 return TRUE;
3275}
3276
3277/*
3278 * If the written message runs into the shown command or ruler, we have to
3279 * wait for hit-return and redraw the window later.
3280 */
3281 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003282msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283{
3284 if (msg_row == Rows - 1 && msg_col >= sc_col)
3285 {
3286 need_wait_return = TRUE;
3287 redraw_cmdline = TRUE;
3288 }
3289}
3290
3291/*
3292 * May write a string to the redirection file.
3293 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3294 */
3295 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003296redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297{
3298 char_u *s = str;
3299 static int cur_col = 0;
3300
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003301 /* Don't do anything for displaying prompts and the like. */
3302 if (redir_off)
3303 return;
3304
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003305 /* If 'verbosefile' is set prepare for writing in that file. */
3306 if (*p_vfile != NUL && verbose_fd == NULL)
3307 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003308
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003309 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 {
3311 /* If the string doesn't start with CR or NL, go to msg_col */
3312 if (*s != '\n' && *s != '\r')
3313 {
3314 while (cur_col < msg_col)
3315 {
3316#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003317 if (redir_execute)
3318 execute_redir_str((char_u *)" ", -1);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003319 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003321 else if (redir_vname)
3322 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003323 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003325 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003327 if (verbose_fd != NULL)
3328 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 ++cur_col;
3330 }
3331 }
3332
3333#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003334 if (redir_execute)
3335 execute_redir_str(s, maxlen);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003336 else if (redir_reg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaarbc5d6dd2016-07-07 23:04:18 +02003338 else if (redir_vname)
Bram Moolenaardf177f62005-02-22 08:39:57 +00003339 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340#endif
3341
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003342 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3344 {
3345#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003346 if (!redir_reg && !redir_vname && !redir_execute)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003348 if (redir_fd != NULL)
3349 putc(*s, redir_fd);
3350 if (verbose_fd != NULL)
3351 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 if (*s == '\r' || *s == '\n')
3353 cur_col = 0;
3354 else if (*s == '\t')
3355 cur_col += (8 - cur_col % 8);
3356 else
3357 ++cur_col;
3358 ++s;
3359 }
3360
3361 if (msg_silent != 0) /* should update msg_col */
3362 msg_col = cur_col;
3363 }
3364}
3365
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003366 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003367redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003368{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003369 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003370#ifdef FEAT_EVAL
Bram Moolenaar79815f12016-07-09 17:07:29 +02003371 || redir_reg || redir_vname || redir_execute
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003372#endif
3373 ;
3374}
3375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003377 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003378 * Must always be called paired with verbose_leave()!
3379 */
3380 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003381verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003382{
3383 if (*p_vfile != NUL)
3384 ++msg_silent;
3385}
3386
3387/*
3388 * After giving verbose message.
3389 * Must always be called paired with verbose_enter()!
3390 */
3391 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003392verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003393{
3394 if (*p_vfile != NUL)
3395 if (--msg_silent < 0)
3396 msg_silent = 0;
3397}
3398
3399/*
3400 * Like verbose_enter() and set msg_scroll when displaying the message.
3401 */
3402 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003403verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003404{
3405 if (*p_vfile != NUL)
3406 ++msg_silent;
3407 else
3408 /* always scroll up, don't overwrite */
3409 msg_scroll = TRUE;
3410}
3411
3412/*
3413 * Like verbose_leave() and set cmdline_row when displaying the message.
3414 */
3415 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003416verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003417{
3418 if (*p_vfile != NUL)
3419 {
3420 if (--msg_silent < 0)
3421 msg_silent = 0;
3422 }
3423 else
3424 cmdline_row = msg_row;
3425}
3426
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003427/*
3428 * Called when 'verbosefile' is set: stop writing to the file.
3429 */
3430 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003431verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003432{
3433 if (verbose_fd != NULL)
3434 {
3435 fclose(verbose_fd);
3436 verbose_fd = NULL;
3437 }
3438 verbose_did_open = FALSE;
3439}
3440
3441/*
3442 * Open the file 'verbosefile'.
3443 * Return FAIL or OK.
3444 */
3445 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003446verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003447{
3448 if (verbose_fd == NULL && !verbose_did_open)
3449 {
3450 /* Only give the error message once. */
3451 verbose_did_open = TRUE;
3452
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003453 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003454 if (verbose_fd == NULL)
3455 {
3456 EMSG2(_(e_notopen), p_vfile);
3457 return FAIL;
3458 }
3459 }
3460 return OK;
3461}
3462
3463/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 * Give a warning message (for searching).
3465 * Use 'w' highlighting and may repeat the message after redrawing
3466 */
3467 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003468give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469{
3470 /* Don't do this for ":silent". */
3471 if (msg_silent != 0)
3472 return;
3473
3474 /* Don't want a hit-enter prompt here. */
3475 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003476
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477#ifdef FEAT_EVAL
3478 set_vim_var_string(VV_WARNINGMSG, message, -1);
3479#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 vim_free(keep_msg);
3481 keep_msg = NULL;
3482 if (hl)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003483 keep_msg_attr = HL_ATTR(HLF_W);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 else
3485 keep_msg_attr = 0;
3486 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003487 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 msg_didout = FALSE; /* overwrite this message */
3489 msg_nowait = TRUE; /* don't wait for this message */
3490 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003491
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 --no_wait_return;
3493}
3494
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003495 void
3496give_warning2(char_u *message, char_u *a1, int hl)
3497{
3498 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1);
3499 give_warning(IObuff, hl);
3500}
3501
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502/*
3503 * Advance msg cursor to column "col".
3504 */
3505 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003506msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507{
3508 if (msg_silent != 0) /* nothing to advance to */
3509 {
3510 msg_col = col; /* for redirection, may fill it up later */
3511 return;
3512 }
3513 if (col >= Columns) /* not enough room */
3514 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003515#ifdef FEAT_RIGHTLEFT
3516 if (cmdmsg_rl)
3517 while (msg_col > Columns - col)
3518 msg_putchar(' ');
3519 else
3520#endif
3521 while (msg_col < col)
3522 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523}
3524
3525#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3526/*
3527 * Used for "confirm()" function, and the :confirm command prefix.
3528 * Versions which haven't got flexible dialogs yet, and console
3529 * versions, get this generic handler which uses the command line.
3530 *
3531 * type = one of:
3532 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3533 * title = title string (can be NULL for default)
3534 * (neither used in console dialogs at the moment)
3535 *
3536 * Format of the "buttons" string:
3537 * "Button1Name\nButton2Name\nButton3Name"
3538 * The first button should normally be the default/accept
3539 * The second button should be the 'Cancel' button
3540 * Other buttons- use your imagination!
3541 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3542 * different letter.
3543 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003545do_dialog(
3546 int type UNUSED,
3547 char_u *title UNUSED,
3548 char_u *message,
3549 char_u *buttons,
3550 int dfltbutton,
3551 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003552 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003553 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003554 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555{
3556 int oldState;
3557 int retval = 0;
3558 char_u *hotkeys;
3559 int c;
3560 int i;
3561
3562#ifndef NO_CONSOLE
3563 /* Don't output anything in silent mode ("ex -s") */
3564 if (silent_mode)
3565 return dfltbutton; /* return default option */
3566#endif
3567
3568#ifdef FEAT_GUI_DIALOG
3569 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3570 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3571 {
3572 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003573 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003574 /* avoid a hit-enter prompt without clearing the cmdline */
3575 need_wait_return = FALSE;
3576 emsg_on_display = FALSE;
3577 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
3579 /* Flush output to avoid that further messages and redrawing is done
3580 * in the wrong order. */
3581 out_flush();
3582 gui_mch_update();
3583
3584 return c;
3585 }
3586#endif
3587
3588 oldState = State;
3589 State = CONFIRM;
3590#ifdef FEAT_MOUSE
3591 setmouse();
3592#endif
3593
3594 /*
3595 * Since we wait for a keypress, don't make the
3596 * user press RETURN as well afterwards.
3597 */
3598 ++no_wait_return;
3599 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3600
3601 if (hotkeys != NULL)
3602 {
3603 for (;;)
3604 {
3605 /* Get a typed character directly from the user. */
3606 c = get_keystroke();
3607 switch (c)
3608 {
3609 case CAR: /* User accepts default option */
3610 case NL:
3611 retval = dfltbutton;
3612 break;
3613 case Ctrl_C: /* User aborts/cancels */
3614 case ESC:
3615 retval = 0;
3616 break;
3617 default: /* Could be a hotkey? */
3618 if (c < 0) /* special keys are ignored here */
3619 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003620 if (c == ':' && ex_cmd)
3621 {
3622 retval = dfltbutton;
3623 ins_char_typebuf(':');
3624 break;
3625 }
3626
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 /* Make the character lowercase, as chars in "hotkeys" are. */
3628 c = MB_TOLOWER(c);
3629 retval = 1;
3630 for (i = 0; hotkeys[i]; ++i)
3631 {
3632#ifdef FEAT_MBYTE
3633 if (has_mbyte)
3634 {
3635 if ((*mb_ptr2char)(hotkeys + i) == c)
3636 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003637 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 }
3639 else
3640#endif
3641 if (hotkeys[i] == c)
3642 break;
3643 ++retval;
3644 }
3645 if (hotkeys[i])
3646 break;
3647 /* No hotkey match, so keep waiting */
3648 continue;
3649 }
3650 break;
3651 }
3652
3653 vim_free(hotkeys);
3654 }
3655
3656 State = oldState;
3657#ifdef FEAT_MOUSE
3658 setmouse();
3659#endif
3660 --no_wait_return;
3661 msg_end_prompt();
3662
3663 return retval;
3664}
3665
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003666static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667
3668/*
3669 * Copy one character from "*from" to "*to", taking care of multi-byte
3670 * characters. Return the length of the character in bytes.
3671 */
3672 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003673copy_char(
3674 char_u *from,
3675 char_u *to,
3676 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677{
3678#ifdef FEAT_MBYTE
3679 int len;
3680 int c;
3681
3682 if (has_mbyte)
3683 {
3684 if (lowercase)
3685 {
3686 c = MB_TOLOWER((*mb_ptr2char)(from));
3687 return (*mb_char2bytes)(c, to);
3688 }
3689 else
3690 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003691 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 mch_memmove(to, from, (size_t)len);
3693 return len;
3694 }
3695 }
3696 else
3697#endif
3698 {
3699 if (lowercase)
3700 *to = (char_u)TOLOWER_LOC(*from);
3701 else
3702 *to = *from;
3703 return 1;
3704 }
3705}
3706
3707/*
3708 * Format the dialog string, and display it at the bottom of
3709 * the screen. Return a string of hotkey chars (if defined) for
3710 * each 'button'. If a button has no hotkey defined, the first character of
3711 * the button is used.
3712 * The hotkeys can be multi-byte characters, but without combining chars.
3713 *
3714 * Returns an allocated string with hotkeys, or NULL for error.
3715 */
3716 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003717msg_show_console_dialog(
3718 char_u *message,
3719 char_u *buttons,
3720 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721{
3722 int len = 0;
3723#ifdef FEAT_MBYTE
3724# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3725#else
3726# define HOTK_LEN 1
3727#endif
3728 int lenhotkey = HOTK_LEN; /* count first button */
3729 char_u *hotk = NULL;
3730 char_u *msgp = NULL;
3731 char_u *hotkp = NULL;
3732 char_u *r;
3733 int copy;
3734#define HAS_HOTKEY_LEN 30
3735 char_u has_hotkey[HAS_HOTKEY_LEN];
3736 int first_hotkey = FALSE; /* first char of button is hotkey */
3737 int idx;
3738
3739 has_hotkey[0] = FALSE;
3740
3741 /*
3742 * First loop: compute the size of memory to allocate.
3743 * Second loop: copy to the allocated memory.
3744 */
3745 for (copy = 0; copy <= 1; ++copy)
3746 {
3747 r = buttons;
3748 idx = 0;
3749 while (*r)
3750 {
3751 if (*r == DLG_BUTTON_SEP)
3752 {
3753 if (copy)
3754 {
3755 *msgp++ = ',';
3756 *msgp++ = ' '; /* '\n' -> ', ' */
3757
3758 /* advance to next hotkey and set default hotkey */
3759#ifdef FEAT_MBYTE
3760 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003761 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 else
3763#endif
3764 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003765 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 if (dfltbutton)
3767 --dfltbutton;
3768
3769 /* If no hotkey is specified first char is used. */
3770 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3771 first_hotkey = TRUE;
3772 }
3773 else
3774 {
3775 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3776 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3777 if (idx < HAS_HOTKEY_LEN - 1)
3778 has_hotkey[++idx] = FALSE;
3779 }
3780 }
3781 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3782 {
3783 if (*r == DLG_HOTKEY_CHAR)
3784 ++r;
3785 first_hotkey = FALSE;
3786 if (copy)
3787 {
3788 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3789 *msgp++ = *r;
3790 else
3791 {
3792 /* '&a' -> '[a]' */
3793 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3794 msgp += copy_char(r, msgp, FALSE);
3795 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3796
3797 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003798 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 }
3800 }
3801 else
3802 {
3803 ++len; /* '&a' -> '[a]' */
3804 if (idx < HAS_HOTKEY_LEN - 1)
3805 has_hotkey[idx] = TRUE;
3806 }
3807 }
3808 else
3809 {
3810 /* everything else copy literally */
3811 if (copy)
3812 msgp += copy_char(r, msgp, FALSE);
3813 }
3814
3815 /* advance to the next character */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003816 MB_PTR_ADV(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 }
3818
3819 if (copy)
3820 {
3821 *msgp++ = ':';
3822 *msgp++ = ' ';
3823 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 }
3825 else
3826 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003827 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003828 + 2 /* for the NL's */
3829 + STRLEN(buttons)
3830 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003831 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832
3833 /* If no hotkey is specified first char is used. */
3834 if (!has_hotkey[0])
3835 {
3836 first_hotkey = TRUE;
3837 len += 2; /* "x" -> "[x]" */
3838 }
3839
3840 /*
3841 * Now allocate and load the strings
3842 */
3843 vim_free(confirm_msg);
3844 confirm_msg = alloc(len);
3845 if (confirm_msg == NULL)
3846 return NULL;
3847 *confirm_msg = NUL;
3848 hotk = alloc(lenhotkey);
3849 if (hotk == NULL)
3850 return NULL;
3851
3852 *confirm_msg = '\n';
3853 STRCPY(confirm_msg + 1, message);
3854
3855 msgp = confirm_msg + 1 + STRLEN(message);
3856 hotkp = hotk;
3857
Bram Moolenaar6a516062007-07-05 08:11:42 +00003858 /* Define first default hotkey. Keep the hotkey string NUL
3859 * terminated to avoid reading past the end. */
3860 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861
3862 /* Remember where the choices start, displaying starts here when
3863 * "hotkp" typed at the more prompt. */
3864 confirm_msg_tail = msgp;
3865 *msgp++ = '\n';
3866 }
3867 }
3868
3869 display_confirm_msg();
3870 return hotk;
3871}
3872
3873/*
3874 * Display the ":confirm" message. Also called when screen resized.
3875 */
3876 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003877display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878{
3879 /* avoid that 'q' at the more prompt truncates the message here */
3880 ++confirm_msg_used;
3881 if (confirm_msg != NULL)
Bram Moolenaar8820b482017-03-16 17:23:31 +01003882 msg_puts_attr(confirm_msg, HL_ATTR(HLF_M));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 --confirm_msg_used;
3884}
3885
3886#endif /* FEAT_CON_DIALOG */
3887
3888#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3889
3890 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003891vim_dialog_yesno(
3892 int type,
3893 char_u *title,
3894 char_u *message,
3895 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896{
3897 if (do_dialog(type,
3898 title == NULL ? (char_u *)_("Question") : title,
3899 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003900 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 return VIM_YES;
3902 return VIM_NO;
3903}
3904
3905 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003906vim_dialog_yesnocancel(
3907 int type,
3908 char_u *title,
3909 char_u *message,
3910 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911{
3912 switch (do_dialog(type,
3913 title == NULL ? (char_u *)_("Question") : title,
3914 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003915 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 {
3917 case 1: return VIM_YES;
3918 case 2: return VIM_NO;
3919 }
3920 return VIM_CANCEL;
3921}
3922
3923 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003924vim_dialog_yesnoallcancel(
3925 int type,
3926 char_u *title,
3927 char_u *message,
3928 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929{
3930 switch (do_dialog(type,
3931 title == NULL ? (char_u *)"Question" : title,
3932 message,
3933 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003934 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 {
3936 case 1: return VIM_YES;
3937 case 2: return VIM_NO;
3938 case 3: return VIM_ALL;
3939 case 4: return VIM_DISCARDALL;
3940 }
3941 return VIM_CANCEL;
3942}
3943
3944#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3945
3946#if defined(FEAT_BROWSE) || defined(PROTO)
3947/*
3948 * Generic browse function. Calls gui_mch_browse() when possible.
3949 * Later this may pop-up a non-GUI file selector (external command?).
3950 */
3951 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003952do_browse(
3953 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3954 char_u *title, /* title for the window */
3955 char_u *dflt, /* default file name (may include directory) */
3956 char_u *ext, /* extension added */
3957 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003959 char_u *filter, /* file name filter */
3960 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961{
3962 char_u *fname;
3963 static char_u *last_dir = NULL; /* last used directory */
3964 char_u *tofree = NULL;
3965 int save_browse = cmdmod.browse;
3966
3967 /* Must turn off browse to avoid that autocommands will get the
3968 * flag too! */
3969 cmdmod.browse = FALSE;
3970
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003971 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003973 if (flags & BROWSE_DIR)
3974 title = (char_u *)_("Select Directory dialog");
3975 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 title = (char_u *)_("Save File dialog");
3977 else
3978 title = (char_u *)_("Open File dialog");
3979 }
3980
3981 /* When no directory specified, use default file name, default dir, buffer
3982 * dir, last dir or current dir */
3983 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3984 {
3985 if (mch_isdir(dflt)) /* default file name is a directory */
3986 {
3987 initdir = dflt;
3988 dflt = NULL;
3989 }
3990 else if (gettail(dflt) != dflt) /* default file name includes a path */
3991 {
3992 tofree = vim_strsave(dflt);
3993 if (tofree != NULL)
3994 {
3995 initdir = tofree;
3996 *gettail(initdir) = NUL;
3997 dflt = gettail(dflt);
3998 }
3999 }
4000 }
4001
4002 if (initdir == NULL || *initdir == NUL)
4003 {
4004 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004005 if (STRCMP(p_bsdir, "last") != 0
4006 && STRCMP(p_bsdir, "buffer") != 0
4007 && STRCMP(p_bsdir, "current") != 0
4008 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 initdir = p_bsdir;
4010 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004011 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 && buf != NULL && buf->b_ffname != NULL)
4013 {
4014 if (dflt == NULL || *dflt == NUL)
4015 dflt = gettail(curbuf->b_ffname);
4016 tofree = vim_strsave(curbuf->b_ffname);
4017 if (tofree != NULL)
4018 {
4019 initdir = tofree;
4020 *gettail(initdir) = NUL;
4021 }
4022 }
4023 /* When 'browsedir' is "last", use dir from last browse */
4024 else if (*p_bsdir == 'l')
4025 initdir = last_dir;
4026 /* When 'browsedir is "current", use current directory. This is the
4027 * default already, leave initdir empty. */
4028 }
4029
4030# ifdef FEAT_GUI
4031 if (gui.in_use) /* when this changes, also adjust f_has()! */
4032 {
4033 if (filter == NULL
4034# ifdef FEAT_EVAL
4035 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
4036 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
4037# endif
4038 )
4039 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004040 if (flags & BROWSE_DIR)
4041 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004042# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004043 /* For systems that have a directory dialog. */
4044 fname = gui_mch_browsedir(title, initdir);
4045# else
4046 /* Generic solution for selecting a directory: select a file and
4047 * remove the file name. */
4048 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
4049# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02004050# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004051 /* Win32 adds a dummy file name, others return an arbitrary file
4052 * name. GTK+ 2 returns only the directory, */
4053 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
4054 {
4055 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004056 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004057
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004058 if (tail == fname)
4059 *tail++ = '.'; /* use current dir */
4060 *tail = NUL;
4061 }
4062# endif
4063 }
4064 else
4065 fname = gui_mch_browse(flags & BROWSE_SAVE,
4066 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067
4068 /* We hang around in the dialog for a while, the user might do some
4069 * things to our files. The Win32 dialog allows deleting or renaming
4070 * a file, check timestamps. */
4071 need_check_timestamps = TRUE;
4072 did_check_timestamps = FALSE;
4073 }
4074 else
4075# endif
4076 {
4077 /* TODO: non-GUI file selector here */
4078 EMSG(_("E338: Sorry, no file browser in console mode"));
4079 fname = NULL;
4080 }
4081
4082 /* keep the directory for next time */
4083 if (fname != NULL)
4084 {
4085 vim_free(last_dir);
4086 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00004087 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 {
4089 *gettail(last_dir) = NUL;
4090 if (*last_dir == NUL)
4091 {
4092 /* filename only returned, must be in current dir */
4093 vim_free(last_dir);
4094 last_dir = alloc(MAXPATHL);
4095 if (last_dir != NULL)
4096 mch_dirname(last_dir, MAXPATHL);
4097 }
4098 }
4099 }
4100
4101 vim_free(tofree);
4102 cmdmod.browse = save_browse;
4103
4104 return fname;
4105}
4106#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004107
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004108#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004109static char *e_printf = N_("E766: Insufficient arguments for printf()");
4110
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004111static varnumber_T tv_nr(typval_T *tvs, int *idxp);
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004112static char *tv_str(typval_T *tvs, int *idxp, char_u **tofree);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004113# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004114static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004115# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004116
4117/*
4118 * Get number argument from "idxp" entry in "tvs". First entry is 1.
4119 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004120 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004121tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004122{
4123 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004124 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004125 int err = FALSE;
4126
4127 if (tvs[idx].v_type == VAR_UNKNOWN)
4128 EMSG(_(e_printf));
4129 else
4130 {
4131 ++*idxp;
4132 n = get_tv_number_chk(&tvs[idx], &err);
4133 if (err)
4134 n = 0;
4135 }
4136 return n;
4137}
4138
4139/*
4140 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004141 * If "tofree" is NULL get_tv_string_chk() is used. Some types (e.g. List)
4142 * are not converted to a string.
4143 * If "tofree" is not NULL echo_string() is used. All types are converted to
4144 * a string with the same format as ":echo". The caller must free "*tofree".
Bram Moolenaar1e015462005-09-25 22:16:38 +00004145 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004146 */
4147 static char *
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004148tv_str(typval_T *tvs, int *idxp, char_u **tofree)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004149{
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004150 int idx = *idxp - 1;
4151 char *s = NULL;
4152 static char_u numbuf[NUMBUFLEN];
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004153
4154 if (tvs[idx].v_type == VAR_UNKNOWN)
4155 EMSG(_(e_printf));
4156 else
4157 {
4158 ++*idxp;
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004159 if (tofree != NULL)
4160 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID());
4161 else
4162 s = (char *)get_tv_string_chk(&tvs[idx]);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004163 }
4164 return s;
4165}
Bram Moolenaara7241f52008-06-24 20:39:31 +00004166
4167# ifdef FEAT_FLOAT
4168/*
4169 * Get float argument from "idxp" entry in "tvs". First entry is 1.
4170 */
4171 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004172tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004173{
4174 int idx = *idxp - 1;
4175 double f = 0;
4176
4177 if (tvs[idx].v_type == VAR_UNKNOWN)
4178 EMSG(_(e_printf));
4179 else
4180 {
4181 ++*idxp;
4182 if (tvs[idx].v_type == VAR_FLOAT)
4183 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00004184 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004185 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004186 else
4187 EMSG(_("E807: Expected Float argument for printf()"));
4188 }
4189 return f;
4190}
4191# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004192#endif
4193
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004194#ifdef FEAT_FLOAT
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004195/*
Bram Moolenaare9997822016-08-28 16:03:38 +02004196 * Return the representation of infinity for printf() function:
4197 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF".
4198 */
4199 static const char *
4200infinity_str(int positive,
4201 char fmt_spec,
4202 int force_sign,
4203 int space_for_positive)
4204{
4205 static const char *table[] =
4206 {
4207 "-inf", "inf", "+inf", " inf",
4208 "-INF", "INF", "+INF", " INF"
4209 };
4210 int idx = positive * (1 + force_sign + force_sign * space_for_positive);
4211
4212 if (ASCII_ISUPPER(fmt_spec))
4213 idx += 4;
4214 return table[idx];
4215}
Bram Moolenaar7f7bd292016-08-28 21:21:31 +02004216#endif
Bram Moolenaare9997822016-08-28 16:03:38 +02004217
4218/*
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004219 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00004220 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004221 * consistency.
4222 *
4223 * This code is based on snprintf.c - a portable implementation of snprintf
4224 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004225 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004226 * The original code, including useful comments, can be found here:
4227 * http://www.ijs.si/software/snprintf/
4228 *
4229 * This snprintf() only supports the following conversion specifiers:
4230 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
4231 * with flags: '-', '+', ' ', '0' and '#'.
4232 * An asterisk is supported for field width as well as precision.
4233 *
Bram Moolenaar04186092016-08-29 21:55:35 +02004234 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004235 *
Bram Moolenaare9997822016-08-28 16:03:38 +02004236 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int)
4237 * are supported.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004238 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004239 * The locale is not used, the string is used as a byte string. This is only
4240 * relevant for double-byte encodings where the second byte may be '%'.
4241 *
Bram Moolenaara2031822006-03-07 22:29:51 +00004242 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
4243 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004244 *
4245 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004246 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00004247 * is greater or equal to "str_m", not all characters from the result
4248 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
4249 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01004250 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004251 */
4252
4253/*
4254 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004255 *
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004256 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004257 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004258 */
4259
4260/* When generating prototypes all of this is skipped, cproto doesn't
4261 * understand this. */
4262#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02004263
Bram Moolenaara800b422010-06-27 01:15:55 +02004264/* Like vim_vsnprintf() but append to the string. */
4265 int
4266vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
4267{
4268 va_list ap;
4269 int str_l;
4270 size_t len = STRLEN(str);
4271 size_t space;
4272
4273 if (str_m <= len)
4274 space = 0;
4275 else
4276 space = str_m - len;
4277 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004278 str_l = vim_vsnprintf(str + len, space, fmt, ap);
Bram Moolenaara800b422010-06-27 01:15:55 +02004279 va_end(ap);
4280 return str_l;
4281}
Bram Moolenaara800b422010-06-27 01:15:55 +02004282
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004283 int
4284vim_snprintf(char *str, size_t str_m, char *fmt, ...)
4285{
4286 va_list ap;
4287 int str_l;
4288
4289 va_start(ap, fmt);
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004290 str_l = vim_vsnprintf(str, str_m, fmt, ap);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004291 va_end(ap);
4292 return str_l;
4293}
4294
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004295 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004296vim_vsnprintf(
4297 char *str,
4298 size_t str_m,
4299 char *fmt,
Bram Moolenaar8327d1d2017-07-11 22:34:51 +02004300 va_list ap)
4301{
4302 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL);
4303}
4304
4305 int
4306vim_vsnprintf_typval(
4307 char *str,
4308 size_t str_m,
4309 char *fmt,
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004310 va_list ap,
4311 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004312{
4313 size_t str_l = 0;
4314 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004315 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004316
4317 if (p == NULL)
4318 p = "";
4319 while (*p != NUL)
4320 {
4321 if (*p != '%')
4322 {
4323 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004324 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004325
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004326 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004327 if (str_l < str_m)
4328 {
4329 size_t avail = str_m - str_l;
4330
4331 mch_memmove(str + str_l, p, n > avail ? avail : n);
4332 }
4333 p += n;
4334 str_l += n;
4335 }
4336 else
4337 {
4338 size_t min_field_width = 0, precision = 0;
4339 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4340 int alternate_form = 0, force_sign = 0;
4341
4342 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4343 * ignored. */
4344 int space_for_positive = 1;
4345
4346 /* allowed values: \0, h, l, L */
4347 char length_modifier = '\0';
4348
4349 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004350# if defined(FEAT_FLOAT)
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004351# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004352 * That sounds reasonable to use as the maximum
4353 * printable. */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004354# elif defined(FEAT_NUM64)
4355# define TMP_LEN 66
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004356# else
Bram Moolenaar91984b92016-08-16 21:58:41 +02004357# define TMP_LEN 34
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004358# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004359 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004360
4361 /* string address in case of string argument */
4362 char *str_arg;
4363
4364 /* natural field width of arg without padding and sign */
4365 size_t str_arg_l;
4366
4367 /* unsigned char argument value - only defined for c conversion.
4368 * N.B. standard explicitly states the char argument for the c
4369 * conversion is unsigned */
4370 unsigned char uchar_arg;
4371
4372 /* number of zeros to be inserted for numeric conversions as
4373 * required by the precision or minimal field width */
4374 size_t number_of_zeros_to_pad = 0;
4375
4376 /* index into tmp where zero padding is to be inserted */
4377 size_t zero_padding_insertion_ind = 0;
4378
4379 /* current conversion specifier character */
4380 char fmt_spec = '\0';
4381
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004382 /* buffer for 's' and 'S' specs */
4383 char_u *tofree = NULL;
4384
4385
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004386 str_arg = NULL;
4387 p++; /* skip '%' */
4388
4389 /* parse flags */
4390 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4391 || *p == '#' || *p == '\'')
4392 {
4393 switch (*p)
4394 {
4395 case '0': zero_padding = 1; break;
4396 case '-': justify_left = 1; break;
4397 case '+': force_sign = 1; space_for_positive = 0; break;
4398 case ' ': force_sign = 1;
4399 /* If both the ' ' and '+' flags appear, the ' '
4400 * flag should be ignored */
4401 break;
4402 case '#': alternate_form = 1; break;
4403 case '\'': break;
4404 }
4405 p++;
4406 }
4407 /* If the '0' and '-' flags both appear, the '0' flag should be
4408 * ignored. */
4409
4410 /* parse field width */
4411 if (*p == '*')
4412 {
4413 int j;
4414
4415 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004416 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004417# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004418 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004419# endif
4420 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004421 if (j >= 0)
4422 min_field_width = j;
4423 else
4424 {
4425 min_field_width = -j;
4426 justify_left = 1;
4427 }
4428 }
4429 else if (VIM_ISDIGIT((int)(*p)))
4430 {
4431 /* size_t could be wider than unsigned int; make sure we treat
4432 * argument like common implementations do */
4433 unsigned int uj = *p++ - '0';
4434
4435 while (VIM_ISDIGIT((int)(*p)))
4436 uj = 10 * uj + (unsigned int)(*p++ - '0');
4437 min_field_width = uj;
4438 }
4439
4440 /* parse precision */
4441 if (*p == '.')
4442 {
4443 p++;
4444 precision_specified = 1;
4445 if (*p == '*')
4446 {
4447 int j;
4448
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004449 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004450# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004451 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004452# endif
4453 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004454 p++;
4455 if (j >= 0)
4456 precision = j;
4457 else
4458 {
4459 precision_specified = 0;
4460 precision = 0;
4461 }
4462 }
4463 else if (VIM_ISDIGIT((int)(*p)))
4464 {
4465 /* size_t could be wider than unsigned int; make sure we
4466 * treat argument like common implementations do */
4467 unsigned int uj = *p++ - '0';
4468
4469 while (VIM_ISDIGIT((int)(*p)))
4470 uj = 10 * uj + (unsigned int)(*p++ - '0');
4471 precision = uj;
4472 }
4473 }
4474
4475 /* parse 'h', 'l' and 'll' length modifiers */
4476 if (*p == 'h' || *p == 'l')
4477 {
4478 length_modifier = *p;
4479 p++;
4480 if (length_modifier == 'l' && *p == 'l')
4481 {
4482 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004483# ifdef FEAT_NUM64
4484 length_modifier = 'L';
4485# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004486 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004487# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004488 p++;
4489 }
4490 }
4491 fmt_spec = *p;
4492
4493 /* common synonyms: */
4494 switch (fmt_spec)
4495 {
4496 case 'i': fmt_spec = 'd'; break;
4497 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4498 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4499 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
4500 default: break;
4501 }
4502
Bram Moolenaar38ee6b02016-07-12 21:11:33 +02004503# if defined(FEAT_EVAL) && defined(FEAT_NUM64)
4504 switch (fmt_spec)
4505 {
4506 case 'd': case 'u': case 'o': case 'x': case 'X':
4507 if (tvs != NULL && length_modifier == '\0')
4508 length_modifier = 'L';
4509 }
4510# endif
4511
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004512 /* get parameter value, do initial processing */
4513 switch (fmt_spec)
4514 {
4515 /* '%' and 'c' behave similar to 's' regarding flags and field
4516 * widths */
4517 case '%':
4518 case 'c':
4519 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004520 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004521 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004522 str_arg_l = 1;
4523 switch (fmt_spec)
4524 {
4525 case '%':
4526 str_arg = p;
4527 break;
4528
4529 case 'c':
4530 {
4531 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004532
4533 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004534# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004535 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004536# endif
4537 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004538 /* standard demands unsigned char */
4539 uchar_arg = (unsigned char)j;
4540 str_arg = (char *)&uchar_arg;
4541 break;
4542 }
4543
4544 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004545 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004546 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004547# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004548 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004549# endif
4550 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004551 if (str_arg == NULL)
4552 {
4553 str_arg = "[NULL]";
4554 str_arg_l = 6;
4555 }
4556 /* make sure not to address string beyond the specified
4557 * precision !!! */
4558 else if (!precision_specified)
4559 str_arg_l = strlen(str_arg);
4560 /* truncate string if necessary as requested by precision */
4561 else if (precision == 0)
4562 str_arg_l = 0;
4563 else
4564 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004565 /* Don't put the #if inside memchr(), it can be a
4566 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004567# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004568 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004569# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004570 /* memchr on HP does not like n > 2^31 !!! */
4571 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004572 precision <= (size_t)0x7fffffffL ? precision
4573 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004574# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004575 str_arg_l = (q == NULL) ? precision
4576 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004577 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004578# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004579 if (fmt_spec == 'S')
4580 {
4581 if (min_field_width != 0)
4582 min_field_width += STRLEN(str_arg)
4583 - mb_string2cells((char_u *)str_arg, -1);
4584 if (precision)
4585 {
4586 char_u *p1 = (char_u *)str_arg;
4587 size_t i;
4588
4589 for (i = 0; i < precision && *p1; i++)
4590 p1 += mb_ptr2len(p1);
4591
4592 str_arg_l = precision = p1 - (char_u *)str_arg;
4593 }
4594 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004595# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004596 break;
4597
4598 default:
4599 break;
4600 }
4601 break;
4602
Bram Moolenaar91984b92016-08-16 21:58:41 +02004603 case 'd': case 'u':
4604 case 'b': case 'B':
4605 case 'o':
4606 case 'x': case 'X':
4607 case 'p':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004608 {
Bram Moolenaar91984b92016-08-16 21:58:41 +02004609 /* NOTE: the u, b, o, x, X and p conversion specifiers
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004610 * imply the value is unsigned; d implies a signed
4611 * value */
4612
4613 /* 0 if numeric argument is zero (or if pointer is
4614 * NULL for 'p'), +1 if greater than zero (or nonzero
4615 * for unsigned arguments), -1 if negative (unsigned
4616 * argument is never negative) */
4617 int arg_sign = 0;
4618
4619 /* only defined for length modifier h, or for no
4620 * length modifiers */
4621 int int_arg = 0;
4622 unsigned int uint_arg = 0;
4623
4624 /* only defined for length modifier l */
4625 long int long_arg = 0;
4626 unsigned long int ulong_arg = 0;
4627
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004628# ifdef FEAT_NUM64
4629 /* only defined for length modifier ll */
4630 varnumber_T llong_arg = 0;
4631 uvarnumber_T ullong_arg = 0;
4632# endif
4633
Bram Moolenaare9997822016-08-28 16:03:38 +02004634 /* only defined for b conversion */
Bram Moolenaar91984b92016-08-16 21:58:41 +02004635 uvarnumber_T bin_arg = 0;
4636
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004637 /* pointer argument value -only defined for p
4638 * conversion */
4639 void *ptr_arg = NULL;
4640
4641 if (fmt_spec == 'p')
4642 {
4643 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004644 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004645# if defined(FEAT_EVAL)
Bram Moolenaare5a8f352016-08-16 21:30:54 +02004646 tvs != NULL ? (void *)tv_str(tvs, &arg_idx,
4647 NULL) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004648# endif
4649 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004650 if (ptr_arg != NULL)
4651 arg_sign = 1;
4652 }
Bram Moolenaar91984b92016-08-16 21:58:41 +02004653 else if (fmt_spec == 'b' || fmt_spec == 'B')
4654 {
4655 bin_arg =
4656# if defined(FEAT_EVAL)
4657 tvs != NULL ?
4658 (uvarnumber_T)tv_nr(tvs, &arg_idx) :
4659# endif
4660 va_arg(ap, uvarnumber_T);
4661 if (bin_arg != 0)
4662 arg_sign = 1;
4663 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004664 else if (fmt_spec == 'd')
4665 {
4666 /* signed */
4667 switch (length_modifier)
4668 {
4669 case '\0':
4670 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004671 /* char and short arguments are passed as int. */
4672 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004673# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004674 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004675# endif
4676 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004677 if (int_arg > 0)
4678 arg_sign = 1;
4679 else if (int_arg < 0)
4680 arg_sign = -1;
4681 break;
4682 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004683 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004684# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004685 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004686# endif
4687 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004688 if (long_arg > 0)
4689 arg_sign = 1;
4690 else if (long_arg < 0)
4691 arg_sign = -1;
4692 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004693# ifdef FEAT_NUM64
4694 case 'L':
4695 llong_arg =
4696# if defined(FEAT_EVAL)
4697 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4698# endif
4699 va_arg(ap, varnumber_T);
4700 if (llong_arg > 0)
4701 arg_sign = 1;
4702 else if (llong_arg < 0)
4703 arg_sign = -1;
4704 break;
4705# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004706 }
4707 }
4708 else
4709 {
4710 /* unsigned */
4711 switch (length_modifier)
4712 {
4713 case '\0':
4714 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004715 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004716# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004717 tvs != NULL ? (unsigned)
4718 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004719# endif
4720 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004721 if (uint_arg != 0)
4722 arg_sign = 1;
4723 break;
4724 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004725 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004726# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004727 tvs != NULL ? (unsigned long)
4728 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004729# endif
4730 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004731 if (ulong_arg != 0)
4732 arg_sign = 1;
4733 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004734# ifdef FEAT_NUM64
4735 case 'L':
4736 ullong_arg =
4737# if defined(FEAT_EVAL)
4738 tvs != NULL ? (uvarnumber_T)
4739 tv_nr(tvs, &arg_idx) :
4740# endif
4741 va_arg(ap, uvarnumber_T);
4742 if (ullong_arg != 0)
4743 arg_sign = 1;
4744 break;
4745# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004746 }
4747 }
4748
4749 str_arg = tmp;
4750 str_arg_l = 0;
4751
4752 /* NOTE:
4753 * For d, i, u, o, x, and X conversions, if precision is
4754 * specified, the '0' flag should be ignored. This is so
4755 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4756 * FreeBSD, NetBSD; but not with Perl.
4757 */
4758 if (precision_specified)
4759 zero_padding = 0;
4760 if (fmt_spec == 'd')
4761 {
4762 if (force_sign && arg_sign >= 0)
4763 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4764 /* leave negative numbers for sprintf to handle, to
4765 * avoid handling tricky cases like (short int)-32768 */
4766 }
4767 else if (alternate_form)
4768 {
4769 if (arg_sign != 0
Bram Moolenaar91984b92016-08-16 21:58:41 +02004770 && (fmt_spec == 'b' || fmt_spec == 'B'
4771 || fmt_spec == 'x' || fmt_spec == 'X') )
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004772 {
4773 tmp[str_arg_l++] = '0';
4774 tmp[str_arg_l++] = fmt_spec;
4775 }
4776 /* alternate form should have no effect for p
4777 * conversion, but ... */
4778 }
4779
4780 zero_padding_insertion_ind = str_arg_l;
4781 if (!precision_specified)
4782 precision = 1; /* default precision is 1 */
4783 if (precision == 0 && arg_sign == 0)
4784 {
4785 /* When zero value is formatted with an explicit
4786 * precision 0, the resulting formatted string is
Bram Moolenaar91984b92016-08-16 21:58:41 +02004787 * empty (d, i, u, b, B, o, x, X, p). */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004788 }
4789 else
4790 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004791 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004792 int f_l = 0;
4793
4794 /* construct a simple format string for sprintf */
4795 f[f_l++] = '%';
4796 if (!length_modifier)
4797 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004798 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004799 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004800# ifdef FEAT_NUM64
4801# ifdef WIN3264
4802 f[f_l++] = 'I';
4803 f[f_l++] = '6';
4804 f[f_l++] = '4';
4805# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004806 f[f_l++] = 'l';
4807 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004808# endif
4809# else
4810 f[f_l++] = 'l';
4811# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004812 }
4813 else
4814 f[f_l++] = length_modifier;
4815 f[f_l++] = fmt_spec;
4816 f[f_l++] = '\0';
4817
4818 if (fmt_spec == 'p')
4819 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
Bram Moolenaar91984b92016-08-16 21:58:41 +02004820 else if (fmt_spec == 'b' || fmt_spec == 'B')
4821 {
4822 char b[8 * sizeof(uvarnumber_T)];
4823 size_t b_l = 0;
4824 uvarnumber_T bn = bin_arg;
4825
4826 do
4827 {
4828 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1);
4829 bn >>= 1;
4830 }
4831 while (bn != 0);
4832
4833 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l);
4834 str_arg_l += b_l;
4835 }
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004836 else if (fmt_spec == 'd')
4837 {
4838 /* signed */
4839 switch (length_modifier)
4840 {
4841 case '\0':
4842 case 'h': str_arg_l += sprintf(
4843 tmp + str_arg_l, f, int_arg);
4844 break;
4845 case 'l': str_arg_l += sprintf(
4846 tmp + str_arg_l, f, long_arg);
4847 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004848# ifdef FEAT_NUM64
4849 case 'L': str_arg_l += sprintf(
4850 tmp + str_arg_l, f, llong_arg);
4851 break;
4852# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004853 }
4854 }
4855 else
4856 {
4857 /* unsigned */
4858 switch (length_modifier)
4859 {
4860 case '\0':
4861 case 'h': str_arg_l += sprintf(
4862 tmp + str_arg_l, f, uint_arg);
4863 break;
4864 case 'l': str_arg_l += sprintf(
4865 tmp + str_arg_l, f, ulong_arg);
4866 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004867# ifdef FEAT_NUM64
4868 case 'L': str_arg_l += sprintf(
4869 tmp + str_arg_l, f, ullong_arg);
4870 break;
4871# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004872 }
4873 }
4874
4875 /* include the optional minus sign and possible
4876 * "0x" in the region before the zero padding
4877 * insertion point */
4878 if (zero_padding_insertion_ind < str_arg_l
4879 && tmp[zero_padding_insertion_ind] == '-')
4880 zero_padding_insertion_ind++;
4881 if (zero_padding_insertion_ind + 1 < str_arg_l
4882 && tmp[zero_padding_insertion_ind] == '0'
4883 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4884 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4885 zero_padding_insertion_ind += 2;
4886 }
4887
4888 {
4889 size_t num_of_digits = str_arg_l
4890 - zero_padding_insertion_ind;
4891
4892 if (alternate_form && fmt_spec == 'o'
4893 /* unless zero is already the first
4894 * character */
4895 && !(zero_padding_insertion_ind < str_arg_l
4896 && tmp[zero_padding_insertion_ind] == '0'))
4897 {
4898 /* assure leading zero for alternate-form
4899 * octal numbers */
4900 if (!precision_specified
4901 || precision < num_of_digits + 1)
4902 {
4903 /* precision is increased to force the
4904 * first character to be zero, except if a
4905 * zero value is formatted with an
4906 * explicit precision of zero */
4907 precision = num_of_digits + 1;
4908 precision_specified = 1;
4909 }
4910 }
4911 /* zero padding to specified precision? */
4912 if (num_of_digits < precision)
4913 number_of_zeros_to_pad = precision - num_of_digits;
4914 }
4915 /* zero padding to specified minimal field width? */
4916 if (!justify_left && zero_padding)
4917 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004918 int n = (int)(min_field_width - (str_arg_l
4919 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004920 if (n > 0)
4921 number_of_zeros_to_pad += n;
4922 }
4923 break;
4924 }
4925
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004926# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004927 case 'f':
Bram Moolenaar04186092016-08-29 21:55:35 +02004928 case 'F':
Bram Moolenaara7241f52008-06-24 20:39:31 +00004929 case 'e':
4930 case 'E':
4931 case 'g':
4932 case 'G':
4933 {
4934 /* Floating point. */
4935 double f;
4936 double abs_f;
4937 char format[40];
4938 int l;
4939 int remove_trailing_zeroes = FALSE;
4940
4941 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004942# if defined(FEAT_EVAL)
4943 tvs != NULL ? tv_float(tvs, &arg_idx) :
4944# endif
4945 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004946 abs_f = f < 0 ? -f : f;
4947
4948 if (fmt_spec == 'g' || fmt_spec == 'G')
4949 {
4950 /* Would be nice to use %g directly, but it prints
4951 * "1.0" as "1", we don't want that. */
4952 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4953 || abs_f == 0.0)
Bram Moolenaar04186092016-08-29 21:55:35 +02004954 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f';
Bram Moolenaara7241f52008-06-24 20:39:31 +00004955 else
4956 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4957 remove_trailing_zeroes = TRUE;
4958 }
4959
Bram Moolenaar04186092016-08-29 21:55:35 +02004960 if ((fmt_spec == 'f' || fmt_spec == 'F') &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004961# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004962 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004963# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004964 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004965# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004966 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004967 {
4968 /* Avoid a buffer overflow */
Bram Moolenaare9997822016-08-28 16:03:38 +02004969 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4970 force_sign, space_for_positive));
4971 str_arg_l = STRLEN(tmp);
4972 zero_padding = 0;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004973 }
4974 else
4975 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004976 if (isnan(f))
4977 {
4978 /* Not a number: nan or NAN */
4979 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN"
4980 : "nan");
4981 str_arg_l = 3;
4982 zero_padding = 0;
4983 }
4984 else if (isinf(f))
4985 {
4986 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec,
4987 force_sign, space_for_positive));
4988 str_arg_l = STRLEN(tmp);
4989 zero_padding = 0;
4990 }
4991 else
Bram Moolenaar04186092016-08-29 21:55:35 +02004992 {
Bram Moolenaare9997822016-08-28 16:03:38 +02004993 /* Regular float number */
Bram Moolenaar04186092016-08-29 21:55:35 +02004994 format[0] = '%';
4995 l = 1;
4996 if (force_sign)
4997 format[l++] = space_for_positive ? ' ' : '+';
4998 if (precision_specified)
4999 {
5000 size_t max_prec = TMP_LEN - 10;
5001
5002 /* Make sure we don't get more digits than we
5003 * have room for. */
5004 if ((fmt_spec == 'f' || fmt_spec == 'F')
5005 && abs_f > 1.0)
5006 max_prec -= (size_t)log10(abs_f);
5007 if (precision > max_prec)
5008 precision = max_prec;
5009 l += sprintf(format + l, ".%d", (int)precision);
5010 }
Bram Moolenaar965ed142016-08-29 22:31:24 +02005011 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec;
Bram Moolenaar04186092016-08-29 21:55:35 +02005012 format[l + 1] = NUL;
5013
Bram Moolenaare9997822016-08-28 16:03:38 +02005014 str_arg_l = sprintf(tmp, format, f);
Bram Moolenaar04186092016-08-29 21:55:35 +02005015 }
Bram Moolenaar99922372016-08-27 15:26:35 +02005016
Bram Moolenaara7241f52008-06-24 20:39:31 +00005017 if (remove_trailing_zeroes)
5018 {
5019 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005020 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005021
5022 /* Using %g or %G: remove superfluous zeroes. */
Bram Moolenaar04186092016-08-29 21:55:35 +02005023 if (fmt_spec == 'f' || fmt_spec == 'F')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005024 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005025 else
5026 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005027 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005028 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005029 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005030 {
5031 /* Remove superfluous '+' and leading
5032 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005033 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005034 {
5035 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005036 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005037 --str_arg_l;
5038 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005039 i = (tp[1] == '-') ? 2 : 1;
5040 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005041 {
5042 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005043 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005044 --str_arg_l;
5045 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005046 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005047 }
5048 }
5049
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005050 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00005051 /* Remove trailing zeroes, but keep the one
5052 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005053 while (tp > tmp + 2 && *tp == '0'
5054 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00005055 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005056 STRMOVE(tp, tp + 1);
5057 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005058 --str_arg_l;
5059 }
5060 }
5061 else
5062 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005063 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00005064
5065 /* Be consistent: some printf("%e") use 1.0e+12
5066 * and some 1.0e+012. Remove one zero in the last
5067 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005068 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00005069 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005070 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
5071 && tp[2] == '0'
5072 && vim_isdigit(tp[3])
5073 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00005074 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00005075 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00005076 --str_arg_l;
5077 }
5078 }
5079 }
Bram Moolenaar04186092016-08-29 21:55:35 +02005080 if (zero_padding && min_field_width > str_arg_l
5081 && (tmp[0] == '-' || force_sign))
5082 {
5083 /* padding 0's should be inserted after the sign */
5084 number_of_zeros_to_pad = min_field_width - str_arg_l;
5085 zero_padding_insertion_ind = 1;
5086 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00005087 str_arg = tmp;
5088 break;
5089 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01005090# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00005091
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005092 default:
5093 /* unrecognized conversion specifier, keep format string
5094 * as-is */
5095 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00005096 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005097 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005098 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005099
5100 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005101 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005102 str_arg = p;
5103 str_arg_l = 0;
5104 if (*p != NUL)
5105 str_arg_l++; /* include invalid conversion specifier
5106 unchanged if not at end-of-string */
5107 break;
5108 }
5109
5110 if (*p != NUL)
5111 p++; /* step over the just processed conversion specifier */
5112
5113 /* insert padding to the left as requested by min_field_width;
5114 * this does not include the zero padding in case of numerical
5115 * conversions*/
5116 if (!justify_left)
5117 {
5118 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005119 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005120
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005121 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005122 {
5123 if (str_l < str_m)
5124 {
5125 size_t avail = str_m - str_l;
5126
5127 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005128 (size_t)pn > avail ? avail
5129 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005130 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005131 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005132 }
5133 }
5134
5135 /* zero padding as requested by the precision or by the minimal
5136 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00005137 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005138 {
5139 /* will not copy first part of numeric right now, *
5140 * force it to be copied later in its entirety */
5141 zero_padding_insertion_ind = 0;
5142 }
5143 else
5144 {
5145 /* insert first part of numerics (sign or '0x') before zero
5146 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005147 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005148
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005149 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005150 {
5151 if (str_l < str_m)
5152 {
5153 size_t avail = str_m - str_l;
5154
5155 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005156 (size_t)zn > avail ? avail
5157 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005158 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005159 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005160 }
5161
5162 /* insert zero padding as requested by the precision or min
5163 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005164 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005165 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005166 {
5167 if (str_l < str_m)
5168 {
Bram Moolenaar2f3a90a2017-08-03 14:49:29 +02005169 size_t avail = str_m - str_l;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005170
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005171 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005172 (size_t)zn > avail ? avail
5173 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005174 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005175 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005176 }
5177 }
5178
5179 /* insert formatted string
5180 * (or as-is conversion specifier for unknown conversions) */
5181 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005182 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005183
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005184 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005185 {
5186 if (str_l < str_m)
5187 {
5188 size_t avail = str_m - str_l;
5189
5190 mch_memmove(str + str_l,
5191 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005192 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005193 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005194 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005195 }
5196 }
5197
5198 /* insert right padding */
5199 if (justify_left)
5200 {
5201 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00005202 int pn = (int)(min_field_width
5203 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005204
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005205 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005206 {
5207 if (str_l < str_m)
5208 {
5209 size_t avail = str_m - str_l;
5210
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005211 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00005212 (size_t)pn > avail ? avail
5213 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005214 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00005215 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005216 }
5217 }
Bram Moolenaare5a8f352016-08-16 21:30:54 +02005218 vim_free(tofree);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005219 }
5220 }
5221
5222 if (str_m > 0)
5223 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005224 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005225 * overwriting the last character (shouldn't happen, but just in case)
5226 * */
5227 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
5228 }
5229
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00005230 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005231 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00005232
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00005233 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00005234 * character), that is, the number of characters that would have been
5235 * written to the buffer if it were large enough. */
5236 return (int)str_l;
5237}
5238
5239#endif /* PROTO */