blob: b86c88675096390e05773569b564ef69d9a4830b [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
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() */
15
16#include "vim.h"
17
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010018static int other_sourcing_name(void);
19static char_u *get_emsg_source(void);
20static char_u *get_emsg_lnum(void);
21static void add_msg_hist(char_u *s, int len, int attr);
22static void hit_return_msg(void);
23static void msg_home_replace_attr(char_u *fname, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000024#ifdef FEAT_MBYTE
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010025static char_u *screen_puts_mbyte(char_u *s, int l, int attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +000026#endif
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010027static void msg_puts_attr_len(char_u *str, int maxlen, int attr);
28static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse);
29static void msg_scroll_up(void);
30static void inc_msg_scrolled(void);
31static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish);
32static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr);
33static void msg_puts_printf(char_u *str, int maxlen);
34static int do_more_prompt(int typed_char);
35static void msg_screen_putchar(int c, int attr);
36static int msg_check_screen(void);
37static void redir_write(char_u *s, int maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038#ifdef FEAT_CON_DIALOG
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +010039static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040static int confirm_msg_used = FALSE; /* displaying confirm_msg */
41static char_u *confirm_msg = NULL; /* ":confirm" message */
42static char_u *confirm_msg_tail; /* tail of confirm_msg */
43#endif
44
45struct msg_hist
46{
47 struct msg_hist *next;
48 char_u *msg;
49 int attr;
50};
51
52static struct msg_hist *first_msg_hist = NULL;
53static struct msg_hist *last_msg_hist = NULL;
54static int msg_hist_len = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055
Bram Moolenaarb5b5b892011-09-14 15:39:29 +020056static FILE *verbose_fd = NULL;
57static int verbose_did_open = FALSE;
58
Bram Moolenaar071d4272004-06-13 20:20:40 +000059/*
60 * When writing messages to the screen, there are many different situations.
61 * A number of variables is used to remember the current state:
62 * msg_didany TRUE when messages were written since the last time the
63 * user reacted to a prompt.
64 * Reset: After hitting a key for the hit-return prompt,
65 * hitting <CR> for the command line or input().
66 * Set: When any message is written to the screen.
67 * msg_didout TRUE when something was written to the current line.
68 * Reset: When advancing to the next line, when the current
69 * text can be overwritten.
70 * Set: When any message is written to the screen.
71 * msg_nowait No extra delay for the last drawn message.
72 * Used in normal_cmd() before the mode message is drawn.
73 * emsg_on_display There was an error message recently. Indicates that there
74 * should be a delay before redrawing.
75 * msg_scroll The next message should not overwrite the current one.
76 * msg_scrolled How many lines the screen has been scrolled (because of
77 * messages). Used in update_screen() to scroll the screen
78 * back. Incremented each time the screen scrolls a line.
79 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr()
80 * writes something without scrolling should not make
81 * need_wait_return to be set. This is a hack to make ":ts"
82 * work without an extra prompt.
83 * lines_left Number of lines available for messages before the
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +010084 * more-prompt is to be given. -1 when not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 * need_wait_return TRUE when the hit-return prompt is needed.
86 * Reset: After giving the hit-return prompt, when the user
87 * has answered some other prompt.
88 * Set: When the ruler or typeahead display is overwritten,
89 * scrolling the screen for some message.
90 * keep_msg Message to be displayed after redrawing the screen, in
91 * main_loop().
92 * This is an allocated string or NULL when not used.
93 */
94
95/*
96 * msg(s) - displays the string 's' on the status line
97 * When terminal not initialized (yet) mch_errmsg(..) is used.
98 * return TRUE if wait_return not called
99 */
100 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100101msg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102{
103 return msg_attr_keep(s, 0, FALSE);
104}
105
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000106#if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \
Bram Moolenaarbbc936b2009-07-01 16:04:58 +0000107 || defined(FEAT_GUI_GTK) || defined(PROTO)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000108/*
109 * Like msg() but keep it silent when 'verbosefile' is set.
110 */
111 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100112verb_msg(char_u *s)
Bram Moolenaar8b044b32005-05-31 22:05:58 +0000113{
114 int n;
115
116 verbose_enter();
117 n = msg_attr_keep(s, 0, FALSE);
118 verbose_leave();
119
120 return n;
121}
122#endif
123
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100125msg_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126{
127 return msg_attr_keep(s, attr, FALSE);
128}
129
130 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100131msg_attr_keep(
132 char_u *s,
133 int attr,
134 int keep) /* TRUE: set keep_msg if it doesn't scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135{
136 static int entered = 0;
137 int retval;
138 char_u *buf = NULL;
139
140#ifdef FEAT_EVAL
141 if (attr == 0)
142 set_vim_var_string(VV_STATUSMSG, s, -1);
143#endif
144
145 /*
146 * It is possible that displaying a messages causes a problem (e.g.,
147 * when redrawing the window), which causes another message, etc.. To
148 * break this loop, limit the recursiveness to 3 levels.
149 */
150 if (entered >= 3)
151 return TRUE;
152 ++entered;
153
154 /* Add message to history (unless it's a repeated kept message or a
155 * truncated message) */
156 if (s != keep_msg
157 || (*s != '<'
158 && last_msg_hist != NULL
159 && last_msg_hist->msg != NULL
160 && STRCMP(s, last_msg_hist->msg)))
161 add_msg_hist(s, -1, attr);
162
163 /* When displaying keep_msg, don't let msg_start() free it, caller must do
164 * that. */
165 if (s == keep_msg)
166 keep_msg = NULL;
167
168 /* Truncate the message if needed. */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000169 msg_start();
170 buf = msg_strtrunc(s, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 if (buf != NULL)
172 s = buf;
173
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 msg_outtrans_attr(s, attr);
175 msg_clr_eos();
176 retval = msg_end();
177
178 if (keep && retval && vim_strsize(s) < (int)(Rows - cmdline_row - 1)
179 * Columns + sc_col)
Bram Moolenaar030f0df2006-02-21 22:02:53 +0000180 set_keep_msg(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181
182 vim_free(buf);
183 --entered;
184 return retval;
185}
186
187/*
188 * Truncate a string such that it can be printed without causing a scroll.
189 * Returns an allocated string or NULL when no truncating is done.
190 */
191 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100192msg_strtrunc(
193 char_u *s,
194 int force) /* always truncate */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195{
196 char_u *buf = NULL;
197 int len;
198 int room;
199
200 /* May truncate message to avoid a hit-return prompt */
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000201 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL)
202 && !exmode_active && msg_silent == 0) || force)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 {
204 len = vim_strsize(s);
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000205 if (msg_scrolled != 0)
Bram Moolenaar7ca30432005-09-09 19:44:31 +0000206 /* Use all the columns. */
207 room = (int)(Rows - msg_row) * Columns - 1;
208 else
209 /* Use up to 'showcmd' column. */
210 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 if (len > room && room > 0)
212 {
213#ifdef FEAT_MBYTE
214 if (enc_utf8)
215 /* may have up to 18 bytes per cell (6 per char, up to two
216 * composing chars) */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100217 len = (room + 2) * 18;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 else if (enc_dbcs == DBCS_JPNU)
219 /* may have up to 2 bytes per cell for euc-jp */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100220 len = (room + 2) * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 else
222#endif
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100223 len = room + 2;
224 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 if (buf != NULL)
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100226 trunc_string(s, buf, room, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 }
228 }
229 return buf;
230}
231
232/*
233 * Truncate a string "s" to "buf" with cell width "room".
234 * "s" and "buf" may be equal.
235 */
236 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100237trunc_string(
238 char_u *s,
239 char_u *buf,
240 int room,
241 int buflen)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242{
243 int half;
244 int len;
245 int e;
246 int i;
247 int n;
248
249 room -= 3;
250 half = room / 2;
251 len = 0;
252
253 /* First part: Start of the string. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100254 for (e = 0; len < half && e < buflen; ++e)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 {
256 if (s[e] == NUL)
257 {
258 /* text fits without truncating! */
259 buf[e] = NUL;
260 return;
261 }
262 n = ptr2cells(s + e);
263 if (len + n >= half)
264 break;
265 len += n;
266 buf[e] = s[e];
267#ifdef FEAT_MBYTE
268 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000269 for (n = (*mb_ptr2len)(s + e); --n > 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 {
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100271 if (++e == buflen)
272 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 buf[e] = s[e];
274 }
275#endif
276 }
277
278 /* Last part: End of the string. */
279 i = e;
280#ifdef FEAT_MBYTE
281 if (enc_dbcs != 0)
282 {
283 /* For DBCS going backwards in a string is slow, but
284 * computing the cell width isn't too slow: go forward
285 * until the rest fits. */
286 n = vim_strsize(s + i);
287 while (len + n > room)
288 {
289 n -= ptr2cells(s + i);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000290 i += (*mb_ptr2len)(s + i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291 }
292 }
293 else if (enc_utf8)
294 {
295 /* For UTF-8 we can go backwards easily. */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000296 half = i = (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 for (;;)
298 {
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000299 do
300 half = half - (*mb_head_off)(s, s + half - 1) - 1;
301 while (utf_iscomposing(utf_ptr2char(s + half)) && half > 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 n = ptr2cells(s + half);
303 if (len + n > room)
304 break;
305 len += n;
306 i = half;
307 }
308 }
309 else
310#endif
311 {
312 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i)
313 len += n;
314 }
315
316 /* Set the middle and copy the last part. */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100317 if (e + 3 < buflen)
318 {
319 mch_memmove(buf + e, "...", (size_t)3);
Bram Moolenaar38f5f952012-01-26 13:01:59 +0100320 len = (int)STRLEN(s + i) + 1;
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100321 if (len >= buflen - e - 3)
322 len = buflen - e - 3 - 1;
323 mch_memmove(buf + e + 3, s + i, len);
324 buf[e + 3 + len - 1] = NUL;
325 }
326 else
327 {
Bram Moolenaar33c1b192012-01-23 20:48:40 +0100328 buf[e - 1] = NUL; /* make sure it is truncated */
Bram Moolenaarf31b7642012-01-20 20:44:43 +0100329 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330}
331
332/*
333 * Automatic prototype generation does not understand this function.
334 * Note: Caller of smgs() and smsg_attr() must check the resulting string is
335 * shorter than IOSIZE!!!
336 */
337#ifndef PROTO
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000339int vim_snprintf(char *str, size_t str_m, char *fmt, ...);
Bram Moolenaar9c13b352005-05-19 20:53:52 +0000340
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100342# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000343_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100344# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345smsg(char_u *s, ...)
346{
347 va_list arglist;
348
349 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000350 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 va_end(arglist);
352 return msg(IObuff);
353}
354
355 int
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100356# ifdef __BORLANDC__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357_RTLENTRYF
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +0100358# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359smsg_attr(int attr, char_u *s, ...)
360{
361 va_list arglist;
362
363 va_start(arglist, s);
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000364 vim_vsnprintf((char *)IObuff, IOSIZE, (char *)s, arglist, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365 va_end(arglist);
366 return msg_attr(IObuff, attr);
367}
368
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369#endif
370
371/*
372 * Remember the last sourcing name/lnum used in an error message, so that it
373 * isn't printed each time when it didn't change.
374 */
375static int last_sourcing_lnum = 0;
376static char_u *last_sourcing_name = NULL;
377
378/*
379 * Reset the last used sourcing name/lnum. Makes sure it is displayed again
380 * for the next error message;
381 */
Bram Moolenaar4eec5ec2005-06-26 22:26:21 +0000382 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100383reset_last_sourcing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384{
385 vim_free(last_sourcing_name);
386 last_sourcing_name = NULL;
387 last_sourcing_lnum = 0;
388}
389
390/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000391 * Return TRUE if "sourcing_name" differs from "last_sourcing_name".
392 */
393 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100394other_sourcing_name(void)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000395{
396 if (sourcing_name != NULL)
397 {
398 if (last_sourcing_name != NULL)
399 return STRCMP(sourcing_name, last_sourcing_name) != 0;
400 return TRUE;
401 }
402 return FALSE;
403}
404
405/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 * Get the message about the source, as used for an error message.
407 * Returns an allocated string with room for one more character.
408 * Returns NULL when no message is to be given.
409 */
410 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100411get_emsg_source(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412{
413 char_u *Buf, *p;
414
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000415 if (sourcing_name != NULL && other_sourcing_name())
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 {
417 p = (char_u *)_("Error detected while processing %s:");
418 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p)));
419 if (Buf != NULL)
420 sprintf((char *)Buf, (char *)p, sourcing_name);
421 return Buf;
422 }
423 return NULL;
424}
425
426/*
427 * Get the message about the source lnum, as used for an error message.
428 * Returns an allocated string with room for one more character.
429 * Returns NULL when no message is to be given.
430 */
431 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100432get_emsg_lnum(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433{
434 char_u *Buf, *p;
435
436 /* lnum is 0 when executing a command from the command line
437 * argument, we don't want a line number then */
438 if (sourcing_name != NULL
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000439 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 && sourcing_lnum != 0)
441 {
442 p = (char_u *)_("line %4ld:");
443 Buf = alloc((unsigned)(STRLEN(p) + 20));
444 if (Buf != NULL)
445 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum);
446 return Buf;
447 }
448 return NULL;
449}
450
451/*
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000452 * Display name and line number for the source of an error.
453 * Remember the file name and line number, so that for the next error the info
454 * is only displayed if it changed.
455 */
456 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100457msg_source(int attr)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000458{
459 char_u *p;
460
461 ++no_wait_return;
462 p = get_emsg_source();
463 if (p != NULL)
464 {
465 msg_attr(p, attr);
466 vim_free(p);
467 }
468 p = get_emsg_lnum();
469 if (p != NULL)
470 {
471 msg_attr(p, hl_attr(HLF_N));
472 vim_free(p);
473 last_sourcing_lnum = sourcing_lnum; /* only once for each line */
474 }
475
476 /* remember the last sourcing name printed, also when it's empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000477 if (sourcing_name == NULL || other_sourcing_name())
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000478 {
479 vim_free(last_sourcing_name);
480 if (sourcing_name == NULL)
481 last_sourcing_name = NULL;
482 else
483 last_sourcing_name = vim_strsave(sourcing_name);
484 }
485 --no_wait_return;
486}
487
488/*
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000489 * Return TRUE if not giving error messages right now:
490 * If "emsg_off" is set: no error messages at the moment.
491 * If "msg" is in 'debug': do error message but without side effects.
492 * If "emsg_skip" is set: never do error messages.
493 */
494 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100495emsg_not_now(void)
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000496{
497 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL
498 && vim_strchr(p_debug, 't') == NULL)
499#ifdef FEAT_EVAL
500 || emsg_skip > 0
501#endif
502 )
503 return TRUE;
504 return FALSE;
505}
506
507/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508 * emsg() - display an error message
509 *
510 * Rings the bell, if appropriate, and calls message() to do the real work
511 * When terminal not initialized (yet) mch_errmsg(..) is used.
512 *
513 * return TRUE if wait_return not called
514 */
515 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100516emsg(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517{
518 int attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 char_u *p;
520#ifdef FEAT_EVAL
521 int ignore = FALSE;
522 int severe;
523#endif
524
Bram Moolenaarfd0e7562011-01-04 19:25:50 +0100525 /* Skip this if not giving error messages at the moment. */
526 if (emsg_not_now())
527 return TRUE;
528
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 called_emsg = TRUE;
Bram Moolenaar8b778d52016-02-18 20:31:34 +0100530 if (emsg_silent == 0)
531 ex_exitval = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
533 /*
Bram Moolenaar1d817d02005-01-16 21:56:27 +0000534 * If "emsg_severe" is TRUE: When an error exception is to be thrown,
535 * prefer this message over previous messages for the same command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536 */
537#ifdef FEAT_EVAL
538 severe = emsg_severe;
539 emsg_severe = FALSE;
540#endif
541
Bram Moolenaar57657d82006-04-21 22:12:41 +0000542 if (!emsg_off || vim_strchr(p_debug, 't') != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543 {
544#ifdef FEAT_EVAL
545 /*
546 * Cause a throw of an error exception if appropriate. Don't display
547 * the error message in this case. (If no matching catch clause will
548 * be found, the message will be displayed later on.) "ignore" is set
549 * when the message should be ignored completely (used for the
550 * interrupt message).
551 */
552 if (cause_errthrow(s, severe, &ignore) == TRUE)
553 {
554 if (!ignore)
555 did_emsg = TRUE;
556 return TRUE;
557 }
558
559 /* set "v:errmsg", also when using ":silent! cmd" */
560 set_vim_var_string(VV_ERRMSG, s, -1);
561#endif
562
563 /*
Bram Moolenaara7241f52008-06-24 20:39:31 +0000564 * When using ":silent! cmd" ignore error messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 * But do write it to the redirection file.
566 */
567 if (emsg_silent != 0)
568 {
569 msg_start();
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000570 p = get_emsg_source();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 if (p != NULL)
572 {
573 STRCAT(p, "\n");
574 redir_write(p, -1);
575 vim_free(p);
576 }
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000577 p = get_emsg_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 if (p != NULL)
579 {
580 STRCAT(p, "\n");
581 redir_write(p, -1);
582 vim_free(p);
583 }
584 redir_write(s, -1);
585 return TRUE;
586 }
587
588 /* Reset msg_silent, an error causes messages to be switched back on. */
589 msg_silent = 0;
590 cmd_silent = FALSE;
591
592 if (global_busy) /* break :global command */
593 ++global_busy;
594
595 if (p_eb)
596 beep_flush(); /* also includes flush_buffers() */
597 else
598 flush_buffers(FALSE); /* flush internal buffers */
599 did_emsg = TRUE; /* flag for DoOneCmd() */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000600 }
601
602 emsg_on_display = TRUE; /* remember there is an error message */
603 ++msg_scroll; /* don't overwrite a previous message */
604 attr = hl_attr(HLF_E); /* set highlight mode for error messages */
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000605 if (msg_scrolled != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606 need_wait_return = TRUE; /* needed in case emsg() is called after
607 * wait_return has reset need_wait_return
608 * and a redraw is expected because
609 * msg_scrolled is non-zero */
610
611 /*
612 * Display name and line number for the source of the error.
613 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000614 msg_source(attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615
616 /*
617 * Display the error message itself.
618 */
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +0000619 msg_nowait = FALSE; /* wait for this msg */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 return msg_attr(s, attr);
621}
622
623/*
624 * Print an error message with one "%s" and one string argument.
625 */
626 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100627emsg2(char_u *s, char_u *a1)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628{
629 return emsg3(s, a1, NULL);
630}
631
Bram Moolenaarea424162005-06-16 21:51:00 +0000632/* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
Bram Moolenaardf177f62005-02-22 08:39:57 +0000634 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100635emsg_invreg(int name)
Bram Moolenaardf177f62005-02-22 08:39:57 +0000636{
637 EMSG2(_("E354: Invalid register name: '%s'"), transchar(name));
638}
639
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640/*
641 * Like msg(), but truncate to a single line if p_shm contains 't', or when
642 * "force" is TRUE. This truncates in another way as for normal messages.
643 * Careful: The string may be changed by msg_may_trunc()!
644 * Returns a pointer to the printed message, if wait_return() not called.
645 */
646 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100647msg_trunc_attr(char_u *s, int force, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648{
649 int n;
650
651 /* Add message to history before truncating */
652 add_msg_hist(s, -1, attr);
653
654 s = msg_may_trunc(force, s);
655
656 msg_hist_off = TRUE;
657 n = msg_attr(s, attr);
658 msg_hist_off = FALSE;
659
660 if (n)
661 return s;
662 return NULL;
663}
664
665/*
666 * Check if message "s" should be truncated at the start (for filenames).
667 * Return a pointer to where the truncated message starts.
668 * Note: May change the message by replacing a character with '<'.
669 */
670 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100671msg_may_trunc(int force, char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672{
673 int n;
674 int room;
675
676 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1;
677 if ((force || (shortmess(SHM_TRUNC) && !exmode_active))
678 && (n = (int)STRLEN(s) - room) > 0)
679 {
680#ifdef FEAT_MBYTE
681 if (has_mbyte)
682 {
683 int size = vim_strsize(s);
684
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +0000685 /* There may be room anyway when there are multibyte chars. */
686 if (size <= room)
687 return s;
688
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 for (n = 0; size >= room; )
690 {
691 size -= (*mb_ptr2cells)(s + n);
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000692 n += (*mb_ptr2len)(s + n);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 }
694 --n;
695 }
696#endif
697 s += n;
698 *s = '<';
699 }
700 return s;
701}
702
703 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100704add_msg_hist(
705 char_u *s,
706 int len, /* -1 for undetermined length */
707 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708{
709 struct msg_hist *p;
710
711 if (msg_hist_off || msg_silent != 0)
712 return;
713
714 /* Don't let the message history get too big */
Bram Moolenaar4770d092006-01-12 23:22:24 +0000715 while (msg_hist_len > MAX_MSG_HIST_LEN)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000716 (void)delete_first_msg();
717
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 /* allocate an entry and add the message at the end of the history */
719 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist));
720 if (p != NULL)
721 {
722 if (len < 0)
723 len = (int)STRLEN(s);
724 /* remove leading and trailing newlines */
725 while (len > 0 && *s == '\n')
726 {
727 ++s;
728 --len;
729 }
730 while (len > 0 && s[len - 1] == '\n')
731 --len;
732 p->msg = vim_strnsave(s, len);
733 p->next = NULL;
734 p->attr = attr;
735 if (last_msg_hist != NULL)
736 last_msg_hist->next = p;
737 last_msg_hist = p;
738 if (first_msg_hist == NULL)
739 first_msg_hist = last_msg_hist;
740 ++msg_hist_len;
741 }
742}
743
744/*
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000745 * Delete the first (oldest) message from the history.
746 * Returns FAIL if there are no messages.
747 */
748 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100749delete_first_msg(void)
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000750{
751 struct msg_hist *p;
752
753 if (msg_hist_len <= 0)
754 return FAIL;
755 p = first_msg_hist;
756 first_msg_hist = p->next;
Bram Moolenaara7241f52008-06-24 20:39:31 +0000757 if (first_msg_hist == NULL)
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200758 last_msg_hist = NULL; /* history is empty */
Bram Moolenaar0a5fe212005-06-24 23:01:23 +0000759 vim_free(p->msg);
760 vim_free(p);
761 --msg_hist_len;
762 return OK;
763}
764
765/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 * ":messages" command.
767 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 void
Bram Moolenaar52196b22016-04-14 17:52:41 +0200769ex_messages(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770{
771 struct msg_hist *p;
772 char_u *s;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200773 int c = 0;
774
775 if (STRCMP(eap->arg, "clear") == 0)
776 {
777 int keep = eap->addr_count == 0 ? 0 : eap->line2;
778
779 while (msg_hist_len > keep)
780 (void)delete_first_msg();
781 return;
782 }
783
784 if (*eap->arg != NUL)
785 {
786 EMSG(_(e_invarg));
787 return;
788 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790 msg_hist_off = TRUE;
791
Bram Moolenaar451f8492016-04-14 17:16:22 +0200792 p = first_msg_hist;
Bram Moolenaar451f8492016-04-14 17:16:22 +0200793 if (eap->addr_count != 0)
794 {
795 /* Count total messages */
796 for (; p != NULL && !got_int; p = p->next)
797 c++;
798
799 c -= eap->line2;
800
801 /* Skip without number of messages specified */
802 for (p = first_msg_hist; p != NULL && !got_int && c > 0;
803 p = p->next, c--);
804 }
805
Bram Moolenaarbea1ede2016-04-14 19:44:36 +0200806 if (p == first_msg_hist)
807 {
808 s = mch_getenv((char_u *)"LANG");
809 if (s != NULL && *s != NUL)
810 msg_attr((char_u *)
811 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
812 hl_attr(HLF_T));
813 }
814
Bram Moolenaar451f8492016-04-14 17:16:22 +0200815 /* Display what was not skipped. */
816 for (; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 if (p->msg != NULL)
818 msg_attr(p->msg, p->attr);
819
820 msg_hist_off = FALSE;
821}
822
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000823#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824/*
825 * Call this after prompting the user. This will avoid a hit-return message
826 * and a delay.
827 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000828 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100829msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830{
831 need_wait_return = FALSE;
832 emsg_on_display = FALSE;
833 cmdline_row = msg_row;
834 msg_col = 0;
835 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +0100836 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837}
838#endif
839
840/*
841 * wait for the user to hit a key (normally a return)
842 * if 'redraw' is TRUE, clear and redraw the screen
843 * if 'redraw' is FALSE, just redraw the screen
844 * if 'redraw' is -1, don't redraw at all
845 */
846 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100847wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848{
849 int c;
850 int oldState;
851 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 int had_got_int;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100853 int save_Recording;
854 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856 if (redraw == TRUE)
857 must_redraw = CLEAR;
858
859 /* If using ":silent cmd", don't wait for a return. Also don't set
860 * need_wait_return to do it later. */
861 if (msg_silent != 0)
862 return;
863
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100864 /*
865 * When inside vgetc(), we can't wait for a typed character at all.
866 * With the global command (and some others) we only need one return at
867 * the end. Adjust cmdline_row to avoid the next message overwriting the
868 * last one.
869 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000870 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100872 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 if (no_wait_return)
874 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 if (!exmode_active)
876 cmdline_row = msg_row;
877 return;
878 }
879
880 redir_off = TRUE; /* don't redirect this message */
881 oldState = State;
882 if (quit_more)
883 {
884 c = CAR; /* just pretend CR was hit */
885 quit_more = FALSE;
886 got_int = FALSE;
887 }
888 else if (exmode_active)
889 {
890 MSG_PUTS(" "); /* make sure the cursor is on the right line */
891 c = CAR; /* no need for a return in ex mode */
892 got_int = FALSE;
893 }
894 else
895 {
896 /* Make sure the hit-return prompt is on screen when 'guioptions' was
897 * just changed. */
898 screenalloc(FALSE);
899
900 State = HITRETURN;
901#ifdef FEAT_MOUSE
902 setmouse();
903#endif
904#ifdef USE_ON_FLY_SCROLL
905 dont_scroll = TRUE; /* disallow scrolling here */
906#endif
Bram Moolenaarbfb96c02016-03-19 17:05:20 +0100907 cmdline_row = msg_row;
908
Bram Moolenaarec38d692013-04-24 15:12:32 +0200909 /* Avoid the sequence that the user types ":" at the hit-return prompt
910 * to start an Ex command, but the file-changed dialog gets in the
911 * way. */
912 if (need_check_timestamps)
913 check_timestamps(FALSE);
914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 hit_return_msg();
916
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 do
918 {
919 /* Remember "got_int", if it is set vgetc() probably returns a
920 * CTRL-C, but we need to loop then. */
921 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000922
923 /* Don't do mappings here, we put the character back in the
924 * typeahead buffer. */
925 ++no_mapping;
926 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100927
928 /* Temporarily disable Recording. If Recording is active, the
929 * character will be recorded later, since it will be added to the
930 * typebuf after the loop */
931 save_Recording = Recording;
932 save_scriptout = scriptout;
933 Recording = FALSE;
934 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000936 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000938 --no_mapping;
939 --allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100940 Recording = save_Recording;
941 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000942
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943#ifdef FEAT_CLIPBOARD
944 /* Strange way to allow copying (yanking) a modeless selection at
945 * the hit-enter prompt. Use CTRL-Y, because the same is used in
946 * Cmdline-mode and it's harmless when there is no selection. */
947 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
948 {
949 clip_copy_modeless_selection(TRUE);
950 c = K_IGNORE;
951 }
952#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000953
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000954 /*
955 * Allow scrolling back in the messages.
956 * Also accept scroll-down commands when messages fill the screen,
957 * to avoid that typing one 'j' too many makes the messages
958 * disappear.
959 */
960 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000961 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100962 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
963 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000964 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100965 if (msg_scrolled > Rows)
966 /* scroll back to show older messages */
967 do_more_prompt(c);
968 else
969 {
970 msg_didout = FALSE;
971 c = K_IGNORE;
972 msg_col =
973#ifdef FEAT_RIGHTLEFT
974 cmdmsg_rl ? Columns - 1 :
975#endif
976 0;
977 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000978 if (quit_more)
979 {
980 c = CAR; /* just pretend CR was hit */
981 quit_more = FALSE;
982 got_int = FALSE;
983 }
Bram Moolenaarb0912962013-08-09 20:38:26 +0200984 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000985 {
986 c = K_IGNORE;
987 hit_return_msg();
988 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000989 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000990 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100991 && (c == 'j' || c == 'd' || c == 'f'
992 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000993 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000994 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 } while ((had_got_int && c == Ctrl_C)
996 || c == K_IGNORE
997#ifdef FEAT_GUI
998 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
999#endif
1000#ifdef FEAT_MOUSE
1001 || c == K_LEFTDRAG || c == K_LEFTRELEASE
1002 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
1003 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001004 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 || c == K_MOUSEDOWN || c == K_MOUSEUP
1006 || (!mouse_has(MOUSE_RETURN)
1007 && mouse_row < msg_row
1008 && (c == K_LEFTMOUSE
1009 || c == K_MIDDLEMOUSE
1010 || c == K_RIGHTMOUSE
1011 || c == K_X1MOUSE
1012 || c == K_X2MOUSE))
1013#endif
1014 );
1015 ui_breakcheck();
1016#ifdef FEAT_MOUSE
1017 /*
1018 * Avoid that the mouse-up event causes visual mode to start.
1019 */
1020 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
1021 || c == K_X1MOUSE || c == K_X2MOUSE)
1022 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
1023 else
1024#endif
1025 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
1026 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001027 /* Put the character back in the typeahead buffer. Don't use the
1028 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +00001029 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +00001031 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033 }
1034 redir_off = FALSE;
1035
1036 /*
1037 * If the user hits ':', '?' or '/' we get a command line from the next
1038 * line.
1039 */
1040 if (c == ':' || c == '?' || c == '/')
1041 {
1042 if (!exmode_active)
1043 cmdline_row = msg_row;
1044 skip_redraw = TRUE; /* skip redraw once */
1045 do_redraw = FALSE;
1046 }
1047
1048 /*
1049 * If the window size changed set_shellsize() will redraw the screen.
1050 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1051 * typed.
1052 */
1053 tmpState = State;
1054 State = oldState; /* restore State before set_shellsize */
1055#ifdef FEAT_MOUSE
1056 setmouse();
1057#endif
1058 msg_check();
1059
1060#if defined(UNIX) || defined(VMS)
1061 /*
1062 * When switching screens, we need to output an extra newline on exit.
1063 */
1064 if (swapping_screen() && !termcap_active)
1065 newline_on_exit = TRUE;
1066#endif
1067
1068 need_wait_return = FALSE;
1069 did_wait_return = TRUE;
1070 emsg_on_display = FALSE; /* can delete error message now */
1071 lines_left = -1; /* reset lines_left at next msg_start() */
1072 reset_last_sourcing();
1073 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1074 (Rows - cmdline_row - 1) * Columns + sc_col)
1075 {
1076 vim_free(keep_msg);
1077 keep_msg = NULL; /* don't redisplay message, it's too long */
1078 }
1079
1080 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1081 {
1082 starttermcap(); /* start termcap before redrawing */
1083 shell_resized();
1084 }
1085 else if (!skip_redraw
1086 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1087 {
1088 starttermcap(); /* start termcap before redrawing */
1089 redraw_later(VALID);
1090 }
1091}
1092
1093/*
1094 * Write the hit-return prompt.
1095 */
1096 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001097hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001099 int save_p_more = p_more;
1100
1101 p_more = FALSE; /* don't want see this message when scrolling back */
1102 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 msg_putchar('\n');
1104 if (got_int)
1105 MSG_PUTS(_("Interrupt: "));
1106
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001107 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 if (!msg_use_printf())
1109 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001110 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111}
1112
1113/*
1114 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1115 */
1116 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001117set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118{
1119 vim_free(keep_msg);
1120 if (s != NULL && msg_silent == 0)
1121 keep_msg = vim_strsave(s);
1122 else
1123 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001124 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001125 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126}
1127
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001128#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1129/*
1130 * If there currently is a message being displayed, set "keep_msg" to it, so
1131 * that it will be displayed again after redraw.
1132 */
1133 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001134set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001135{
1136 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1137 && (State & NORMAL))
1138 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1139}
1140#endif
1141
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142/*
1143 * Prepare for outputting characters in the command line.
1144 */
1145 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001146msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147{
1148 int did_return = FALSE;
1149
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001150 if (!msg_silent)
1151 {
1152 vim_free(keep_msg);
1153 keep_msg = NULL; /* don't display old message now */
1154 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001155
1156#ifdef FEAT_EVAL
1157 if (need_clr_eos)
1158 {
1159 /* Halfway an ":echo" command and getting an (error) message: clear
1160 * any text from the command. */
1161 need_clr_eos = FALSE;
1162 msg_clr_eos();
1163 }
1164#endif
1165
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 if (!msg_scroll && full_screen) /* overwrite last message */
1167 {
1168 msg_row = cmdline_row;
1169 msg_col =
1170#ifdef FEAT_RIGHTLEFT
1171 cmdmsg_rl ? Columns - 1 :
1172#endif
1173 0;
1174 }
1175 else if (msg_didout) /* start message on next line */
1176 {
1177 msg_putchar('\n');
1178 did_return = TRUE;
1179 if (exmode_active != EXMODE_NORMAL)
1180 cmdline_row = msg_row;
1181 }
1182 if (!msg_didany || lines_left < 0)
1183 msg_starthere();
1184 if (msg_silent == 0)
1185 {
1186 msg_didout = FALSE; /* no output on current line yet */
1187 cursor_off();
1188 }
1189
1190 /* when redirecting, may need to start a new line. */
1191 if (!did_return)
1192 redir_write((char_u *)"\n", -1);
1193}
1194
1195/*
1196 * Note that the current msg position is where messages start.
1197 */
1198 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001199msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200{
1201 lines_left = cmdline_row;
1202 msg_didany = FALSE;
1203}
1204
1205 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001206msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207{
1208 msg_putchar_attr(c, 0);
1209}
1210
1211 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001212msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213{
1214#ifdef FEAT_MBYTE
1215 char_u buf[MB_MAXBYTES + 1];
1216#else
1217 char_u buf[4];
1218#endif
1219
1220 if (IS_SPECIAL(c))
1221 {
1222 buf[0] = K_SPECIAL;
1223 buf[1] = K_SECOND(c);
1224 buf[2] = K_THIRD(c);
1225 buf[3] = NUL;
1226 }
1227 else
1228 {
1229#ifdef FEAT_MBYTE
1230 buf[(*mb_char2bytes)(c, buf)] = NUL;
1231#else
1232 buf[0] = c;
1233 buf[1] = NUL;
1234#endif
1235 }
1236 msg_puts_attr(buf, attr);
1237}
1238
1239 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001240msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241{
1242 char_u buf[20];
1243
1244 sprintf((char *)buf, "%ld", n);
1245 msg_puts(buf);
1246}
1247
1248 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001249msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250{
1251 msg_home_replace_attr(fname, 0);
1252}
1253
1254#if defined(FEAT_FIND_ID) || defined(PROTO)
1255 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001256msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257{
1258 msg_home_replace_attr(fname, hl_attr(HLF_D));
1259}
1260#endif
1261
1262 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001263msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264{
1265 char_u *name;
1266
1267 name = home_replace_save(NULL, fname);
1268 if (name != NULL)
1269 msg_outtrans_attr(name, attr);
1270 vim_free(name);
1271}
1272
1273/*
1274 * Output 'len' characters in 'str' (including NULs) with translation
1275 * if 'len' is -1, output upto a NUL character.
1276 * Use attributes 'attr'.
1277 * Return the number of characters it takes on the screen.
1278 */
1279 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001280msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281{
1282 return msg_outtrans_attr(str, 0);
1283}
1284
1285 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001286msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287{
1288 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1289}
1290
1291 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001292msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293{
1294 return msg_outtrans_len_attr(str, len, 0);
1295}
1296
1297/*
1298 * Output one character at "p". Return pointer to the next character.
1299 * Handles multi-byte characters.
1300 */
1301 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001302msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303{
1304#ifdef FEAT_MBYTE
1305 int l;
1306
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001307 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 {
1309 msg_outtrans_len_attr(p, l, attr);
1310 return p + l;
1311 }
1312#endif
1313 msg_puts_attr(transchar_byte(*p), attr);
1314 return p + 1;
1315}
1316
1317 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001318msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319{
1320 int retval = 0;
1321 char_u *str = msgstr;
1322 char_u *plain_start = msgstr;
1323 char_u *s;
1324#ifdef FEAT_MBYTE
1325 int mb_l;
1326 int c;
1327#endif
1328
1329 /* if MSG_HIST flag set, add message to history */
1330 if (attr & MSG_HIST)
1331 {
1332 add_msg_hist(str, len, attr);
1333 attr &= ~MSG_HIST;
1334 }
1335
1336#ifdef FEAT_MBYTE
1337 /* If the string starts with a composing character first draw a space on
1338 * which the composing char can be drawn. */
1339 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1340 msg_puts_attr((char_u *)" ", attr);
1341#endif
1342
1343 /*
1344 * Go over the string. Special characters are translated and printed.
1345 * Normal characters are printed several at a time.
1346 */
1347 while (--len >= 0)
1348 {
1349#ifdef FEAT_MBYTE
1350 if (enc_utf8)
1351 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001352 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001354 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 else
1356 mb_l = 1;
1357 if (has_mbyte && mb_l > 1)
1358 {
1359 c = (*mb_ptr2char)(str);
1360 if (vim_isprintc(c))
1361 /* printable multi-byte char: count the cells. */
1362 retval += (*mb_ptr2cells)(str);
1363 else
1364 {
1365 /* unprintable multi-byte char: print the printable chars so
1366 * far and the translation of the unprintable char. */
1367 if (str > plain_start)
1368 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1369 attr);
1370 plain_start = str + mb_l;
1371 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1372 retval += char2cells(c);
1373 }
1374 len -= mb_l - 1;
1375 str += mb_l;
1376 }
1377 else
1378#endif
1379 {
1380 s = transchar_byte(*str);
1381 if (s[1] != NUL)
1382 {
1383 /* unprintable char: print the printable chars so far and the
1384 * translation of the unprintable char. */
1385 if (str > plain_start)
1386 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1387 attr);
1388 plain_start = str + 1;
1389 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001390 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001392 else
1393 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 ++str;
1395 }
1396 }
1397
1398 if (str > plain_start)
1399 /* print the printable chars at the end */
1400 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1401
1402 return retval;
1403}
1404
1405#if defined(FEAT_QUICKFIX) || defined(PROTO)
1406 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001407msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408{
1409 int i;
1410 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1411
1412 arg = skipwhite(arg);
1413 for (i = 5; *arg && i >= 0; --i)
1414 if (*arg++ != str[i])
1415 break;
1416 if (i < 0)
1417 {
1418 msg_putchar('\n');
1419 for (i = 0; rs[i]; ++i)
1420 msg_putchar(rs[i] - 3);
1421 }
1422}
1423#endif
1424
1425/*
1426 * Output the string 'str' upto a NUL character.
1427 * Return the number of characters it takes on the screen.
1428 *
1429 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1430 * following character and shown as <F1>, <S-Up> etc. Any other character
1431 * which is not printable shown in <> form.
1432 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1433 * If a character is displayed in one of these special ways, is also
1434 * highlighted (its highlight name is '8' in the p_hl variable).
1435 * Otherwise characters are not highlighted.
1436 * This function is used to show mappings, where we want to see how to type
1437 * the character/string -- webb
1438 */
1439 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001440msg_outtrans_special(
1441 char_u *strstart,
1442 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443{
1444 char_u *str = strstart;
1445 int retval = 0;
1446 char_u *string;
1447 int attr;
1448 int len;
1449
1450 attr = hl_attr(HLF_8);
1451 while (*str != NUL)
1452 {
1453 /* Leading and trailing spaces need to be displayed in <> form. */
1454 if ((str == strstart || str[1] == NUL) && *str == ' ')
1455 {
1456 string = (char_u *)"<Space>";
1457 ++str;
1458 }
1459 else
1460 string = str2special(&str, from);
1461 len = vim_strsize(string);
1462 /* Highlight special keys */
1463 msg_puts_attr(string, len > 1
1464#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001465 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466#endif
1467 ? attr : 0);
1468 retval += len;
1469 }
1470 return retval;
1471}
1472
Bram Moolenaarbd743252010-10-20 21:23:33 +02001473#if defined(FEAT_EVAL) || defined(PROTO)
1474/*
1475 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1476 * strings, in an allocated string.
1477 */
1478 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001479str2special_save(
1480 char_u *str,
1481 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001482{
1483 garray_T ga;
1484 char_u *p = str;
1485
1486 ga_init2(&ga, 1, 40);
1487 while (*p != NUL)
1488 ga_concat(&ga, str2special(&p, is_lhs));
1489 ga_append(&ga, NUL);
1490 return (char_u *)ga.ga_data;
1491}
1492#endif
1493
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494/*
1495 * Return the printable string for the key codes at "*sp".
1496 * Used for translating the lhs or rhs of a mapping to printable chars.
1497 * Advances "sp" to the next code.
1498 */
1499 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001500str2special(
1501 char_u **sp,
1502 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503{
1504 int c;
1505 static char_u buf[7];
1506 char_u *str = *sp;
1507 int modifiers = 0;
1508 int special = FALSE;
1509
1510#ifdef FEAT_MBYTE
1511 if (has_mbyte)
1512 {
1513 char_u *p;
1514
1515 /* Try to un-escape a multi-byte character. Return the un-escaped
1516 * string if it is a multi-byte character. */
1517 p = mb_unescape(sp);
1518 if (p != NULL)
1519 return p;
1520 }
1521#endif
1522
1523 c = *str;
1524 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1525 {
1526 if (str[1] == KS_MODIFIER)
1527 {
1528 modifiers = str[2];
1529 str += 3;
1530 c = *str;
1531 }
1532 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1533 {
1534 c = TO_SPECIAL(str[1], str[2]);
1535 str += 2;
Bram Moolenaar37985192013-06-07 19:53:10 +02001536 if (c == KS_ZERO) /* display <Nul> as ^@ or <Nul> */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 c = NUL;
1538 }
1539 if (IS_SPECIAL(c) || modifiers) /* special key */
1540 special = TRUE;
1541 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542
1543#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001544 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001546 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001547
1548 /* For multi-byte characters check for an illegal byte. */
1549 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1550 {
1551 transchar_nonprint(buf, c);
1552 *sp = str + 1;
1553 return buf;
1554 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001555 /* Since 'special' is TRUE the multi-byte character 'c' will be
1556 * processed by get_special_key_name() */
1557 c = (*mb_ptr2char)(str);
1558 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001560 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001562 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563
1564 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1565 * Use <Space> only for lhs of a mapping. */
1566 if (special || char2cells(c) > 1 || (from && c == ' '))
1567 return get_special_key_name(c, modifiers);
1568 buf[0] = c;
1569 buf[1] = NUL;
1570 return buf;
1571}
1572
1573/*
1574 * Translate a key sequence into special key names.
1575 */
1576 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001577str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578{
1579 char_u *s;
1580
1581 *buf = NUL;
1582 while (*sp)
1583 {
1584 s = str2special(&sp, FALSE);
1585 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1586 STRCAT(buf, s);
1587 }
1588}
1589
1590/*
1591 * print line for :print or :list command
1592 */
1593 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001594msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595{
1596 int c;
1597 int col = 0;
1598 int n_extra = 0;
1599 int c_extra = 0;
1600 char_u *p_extra = NULL; /* init to make SASC shut up */
1601 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001602 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 char_u *trail = NULL;
1604#ifdef FEAT_MBYTE
1605 int l;
1606 char_u buf[MB_MAXBYTES + 1];
1607#endif
1608
Bram Moolenaardf177f62005-02-22 08:39:57 +00001609 if (curwin->w_p_list)
1610 list = TRUE;
1611
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001613 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 {
1615 trail = s + STRLEN(s);
1616 while (trail > s && vim_iswhite(trail[-1]))
1617 --trail;
1618 }
1619
1620 /* output a space for an empty line, otherwise the line will be
1621 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001622 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 msg_putchar(' ');
1624
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001625 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001627 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 {
1629 --n_extra;
1630 if (c_extra)
1631 c = c_extra;
1632 else
1633 c = *p_extra++;
1634 }
1635#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001636 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 {
1638 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001639 if (lcs_nbsp != NUL && list
1640 && (mb_ptr2char(s) == 160
1641 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001642 {
1643 mb_char2bytes(lcs_nbsp, buf);
1644 buf[(*mb_ptr2len)(buf)] = NUL;
1645 }
1646 else
1647 {
1648 mch_memmove(buf, s, (size_t)l);
1649 buf[l] = NUL;
1650 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001651 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 s += l;
1653 continue;
1654 }
1655#endif
1656 else
1657 {
1658 attr = 0;
1659 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001660 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 {
1662 /* tab amount depends on current column */
1663 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001664 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 {
1666 c = ' ';
1667 c_extra = ' ';
1668 }
1669 else
1670 {
1671 c = lcs_tab1;
1672 c_extra = lcs_tab2;
1673 attr = hl_attr(HLF_8);
1674 }
1675 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001676 else if (c == 160 && list && lcs_nbsp != NUL)
1677 {
1678 c = lcs_nbsp;
1679 attr = hl_attr(HLF_8);
1680 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001681 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 {
1683 p_extra = (char_u *)"";
1684 c_extra = NUL;
1685 n_extra = 1;
1686 c = lcs_eol;
1687 attr = hl_attr(HLF_AT);
1688 --s;
1689 }
1690 else if (c != NUL && (n = byte2cells(c)) > 1)
1691 {
1692 n_extra = n - 1;
1693 p_extra = transchar_byte(c);
1694 c_extra = NUL;
1695 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001696 /* Use special coloring to be able to distinguish <hex> from
1697 * the same in plain text. */
1698 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 }
1700 else if (c == ' ' && trail != NULL && s > trail)
1701 {
1702 c = lcs_trail;
1703 attr = hl_attr(HLF_8);
1704 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001705 else if (c == ' ' && list && lcs_space != NUL)
1706 {
1707 c = lcs_space;
1708 attr = hl_attr(HLF_8);
1709 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 }
1711
1712 if (c == NUL)
1713 break;
1714
1715 msg_putchar_attr(c, attr);
1716 col++;
1717 }
1718 msg_clr_eos();
1719}
1720
1721#ifdef FEAT_MBYTE
1722/*
1723 * Use screen_puts() to output one multi-byte character.
1724 * Return the pointer "s" advanced to the next character.
1725 */
1726 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001727screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728{
1729 int cw;
1730
1731 msg_didout = TRUE; /* remember that line is not empty */
1732 cw = (*mb_ptr2cells)(s);
1733 if (cw > 1 && (
1734#ifdef FEAT_RIGHTLEFT
1735 cmdmsg_rl ? msg_col <= 1 :
1736#endif
1737 msg_col == Columns - 1))
1738 {
1739 /* Doesn't fit, print a highlighted '>' to fill it up. */
1740 msg_screen_putchar('>', hl_attr(HLF_AT));
1741 return s;
1742 }
1743
1744 screen_puts_len(s, l, msg_row, msg_col, attr);
1745#ifdef FEAT_RIGHTLEFT
1746 if (cmdmsg_rl)
1747 {
1748 msg_col -= cw;
1749 if (msg_col == 0)
1750 {
1751 msg_col = Columns;
1752 ++msg_row;
1753 }
1754 }
1755 else
1756#endif
1757 {
1758 msg_col += cw;
1759 if (msg_col >= Columns)
1760 {
1761 msg_col = 0;
1762 ++msg_row;
1763 }
1764 }
1765 return s + l;
1766}
1767#endif
1768
1769/*
1770 * Output a string to the screen at position msg_row, msg_col.
1771 * Update msg_row and msg_col for the next message.
1772 */
1773 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001774msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775{
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001776 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777}
1778
1779 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001780msg_puts_title(
1781 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782{
1783 msg_puts_attr(s, hl_attr(HLF_T));
1784}
1785
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786/*
1787 * Show a message in such a way that it always fits in the line. Cut out a
1788 * part in the middle and replace it with "..." when necessary.
1789 * Does not handle multi-byte characters!
1790 */
1791 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001792msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001794 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795}
1796
1797 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001798msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799{
1800 int slen = len;
1801 int room;
1802
1803 room = Columns - msg_col;
1804 if (len > room && room >= 20)
1805 {
1806 slen = (room - 3) / 2;
1807 msg_outtrans_len_attr(longstr, slen, attr);
1808 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1809 }
1810 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1811}
1812
1813/*
1814 * Basic function for writing a message with highlight attributes.
1815 */
1816 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001817msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818{
1819 msg_puts_attr_len(s, -1, attr);
1820}
1821
1822/*
1823 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1824 * When "maxlen" is -1 there is no maximum length.
1825 * When "maxlen" is >= 0 the message is not put in the history.
1826 */
1827 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001828msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 /*
1831 * If redirection is on, also write to the redirection file.
1832 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001833 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834
1835 /*
1836 * Don't print anything when using ":silent cmd".
1837 */
1838 if (msg_silent != 0)
1839 return;
1840
1841 /* if MSG_HIST flag set, add message to history */
1842 if ((attr & MSG_HIST) && maxlen < 0)
1843 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001844 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 attr &= ~MSG_HIST;
1846 }
1847
1848 /*
1849 * When writing something to the screen after it has scrolled, requires a
1850 * wait-return prompt later. Needed when scrolling, resetting
1851 * need_wait_return after some prompt, and then outputting something
1852 * without scrolling
1853 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001854 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 need_wait_return = TRUE;
1856 msg_didany = TRUE; /* remember that something was outputted */
1857
1858 /*
1859 * If there is no valid screen, use fprintf so we can see error messages.
1860 * If termcap is not active, we may be writing in an alternate console
1861 * window, cursor positioning may not work correctly (window size may be
1862 * different, e.g. for Win32 console) or we just don't know where the
1863 * cursor is.
1864 */
1865 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001866 msg_puts_printf(str, maxlen);
1867 else
1868 msg_puts_display(str, maxlen, attr, FALSE);
1869}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001871/*
1872 * The display part of msg_puts_attr_len().
1873 * May be called recursively to display scroll-back text.
1874 */
1875 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001876msg_puts_display(
1877 char_u *str,
1878 int maxlen,
1879 int attr,
1880 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001881{
1882 char_u *s = str;
1883 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1884 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1885#ifdef FEAT_MBYTE
1886 int l;
1887 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001889 char_u *sb_str = str;
1890 int sb_col = msg_col;
1891 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001892 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893
1894 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001895 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 {
1897 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001898 * We are at the end of the screen line when:
1899 * - When outputting a newline.
1900 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001902 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903#ifdef FEAT_RIGHTLEFT
1904 cmdmsg_rl
1905 ? (
1906 msg_col <= 1
1907 || (*s == TAB && msg_col <= 7)
1908# ifdef FEAT_MBYTE
1909 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1910# endif
1911 )
1912 :
1913#endif
1914 (msg_col + t_col >= Columns - 1
1915 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1916# ifdef FEAT_MBYTE
1917 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1918 && msg_col + t_col >= Columns - 2)
1919# endif
1920 ))))
1921 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001922 /*
1923 * The screen is scrolled up when at the last row (some terminals
1924 * scroll automatically, some don't. To avoid problems we scroll
1925 * ourselves).
1926 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001929 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001931 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 if (msg_no_more && lines_left == 0)
1933 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001935 /* Scroll the screen up one line. */
1936 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937
1938 msg_row = Rows - 2;
1939 if (msg_col >= Columns) /* can happen after screen resize */
1940 msg_col = Columns - 1;
1941
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001942 /* Display char in last column before showing more-prompt. */
1943 if (*s >= ' '
1944#ifdef FEAT_RIGHTLEFT
1945 && !cmdmsg_rl
1946#endif
1947 )
1948 {
1949#ifdef FEAT_MBYTE
1950 if (has_mbyte)
1951 {
1952 if (enc_utf8 && maxlen >= 0)
1953 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001954 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001955 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001956 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001957 s = screen_puts_mbyte(s, l, attr);
1958 }
1959 else
1960#endif
1961 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001962 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001963 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001964 else
1965 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001966
1967 if (p_more)
1968 /* store text for scrolling back */
1969 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1970
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001971 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001972 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 if (must_redraw < VALID)
1974 must_redraw = VALID;
1975 redraw_cmdline = TRUE;
1976 if (cmdline_row > 0 && !exmode_active)
1977 --cmdline_row;
1978
1979 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001980 * If screen is completely filled and 'more' is set then wait
1981 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001983 if (lines_left > 0)
1984 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001985 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 && !msg_no_more && !exmode_active)
1987 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001989 if (do_more_prompt(NUL))
1990 s = confirm_msg_tail;
1991#else
1992 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993#endif
1994 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001995 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001997
1998 /* When we displayed a char in last column need to check if there
1999 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00002000 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002001 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 }
2003
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002004 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 || msg_col + t_col >= Columns
2006#ifdef FEAT_MBYTE
2007 || (has_mbyte && (*mb_ptr2cells)(s) > 1
2008 && msg_col + t_col >= Columns - 1)
2009#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002010 ;
2011 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
2012 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002014 t_puts(&t_col, t_s, s, attr);
2015
2016 if (wrap && p_more && !recurse)
2017 /* store text for scrolling back */
2018 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020 if (*s == '\n') /* go to next line */
2021 {
2022 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002023#ifdef FEAT_RIGHTLEFT
2024 if (cmdmsg_rl)
2025 msg_col = Columns - 1;
2026 else
2027#endif
2028 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 if (++msg_row >= Rows) /* safety check */
2030 msg_row = Rows - 1;
2031 }
2032 else if (*s == '\r') /* go to column 0 */
2033 {
2034 msg_col = 0;
2035 }
2036 else if (*s == '\b') /* go to previous char */
2037 {
2038 if (msg_col)
2039 --msg_col;
2040 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002041 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 {
2043 do
2044 msg_screen_putchar(' ', attr);
2045 while (msg_col & 7);
2046 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002047 else if (*s == BELL) /* beep (from ":sh") */
2048 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 else
2050 {
2051#ifdef FEAT_MBYTE
2052 if (has_mbyte)
2053 {
2054 cw = (*mb_ptr2cells)(s);
2055 if (enc_utf8 && maxlen >= 0)
2056 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002057 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002059 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 }
2061 else
2062 {
2063 cw = 1;
2064 l = 1;
2065 }
2066#endif
2067 /* When drawing from right to left or when a double-wide character
2068 * doesn't fit, draw a single character here. Otherwise collect
2069 * characters and draw them all at once later. */
2070#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2071 if (
2072# ifdef FEAT_RIGHTLEFT
2073 cmdmsg_rl
2074# ifdef FEAT_MBYTE
2075 ||
2076# endif
2077# endif
2078# ifdef FEAT_MBYTE
2079 (cw > 1 && msg_col + t_col >= Columns - 1)
2080# endif
2081 )
2082 {
2083# ifdef FEAT_MBYTE
2084 if (l > 1)
2085 s = screen_puts_mbyte(s, l, attr) - 1;
2086 else
2087# endif
2088 msg_screen_putchar(*s, attr);
2089 }
2090 else
2091#endif
2092 {
2093 /* postpone this character until later */
2094 if (t_col == 0)
2095 t_s = s;
2096#ifdef FEAT_MBYTE
2097 t_col += cw;
2098 s += l - 1;
2099#else
2100 ++t_col;
2101#endif
2102 }
2103 }
2104 ++s;
2105 }
2106
2107 /* output any postponed text */
2108 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002109 t_puts(&t_col, t_s, s, attr);
2110 if (p_more && !recurse)
2111 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112
2113 msg_check();
2114}
2115
2116/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002117 * Scroll the screen up one line for displaying the next message line.
2118 */
2119 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002120msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002121{
2122#ifdef FEAT_GUI
2123 /* Remove the cursor before scrolling, ScreenLines[] is going
2124 * to become invalid. */
2125 if (gui.in_use)
2126 gui_undraw_cursor();
2127#endif
2128 /* scrolling up always works */
2129 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2130
2131 if (!can_clear((char_u *)" "))
2132 {
2133 /* Scrolling up doesn't result in the right background. Set the
2134 * background here. It's not efficient, but avoids that we have to do
2135 * it all over the code. */
2136 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2137
2138 /* Also clear the last char of the last but one line if it was not
2139 * cleared before to avoid a scroll-up. */
2140 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2141 screen_fill((int)Rows - 2, (int)Rows - 1,
2142 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2143 }
2144}
2145
2146/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002147 * Increment "msg_scrolled".
2148 */
2149 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002150inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002151{
2152#ifdef FEAT_EVAL
2153 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2154 {
2155 char_u *p = sourcing_name;
2156 char_u *tofree = NULL;
2157 int len;
2158
2159 /* v:scrollstart is empty, set it to the script/function name and line
2160 * number */
2161 if (p == NULL)
2162 p = (char_u *)_("Unknown");
2163 else
2164 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002165 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002166 tofree = alloc(len);
2167 if (tofree != NULL)
2168 {
2169 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2170 p, (long)sourcing_lnum);
2171 p = tofree;
2172 }
2173 }
2174 set_vim_var_string(VV_SCROLLSTART, p, -1);
2175 vim_free(tofree);
2176 }
2177#endif
2178 ++msg_scrolled;
2179}
2180
2181/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002182 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2183 * store the displayed text and remember where screen lines start.
2184 */
2185typedef struct msgchunk_S msgchunk_T;
2186struct msgchunk_S
2187{
2188 msgchunk_T *sb_next;
2189 msgchunk_T *sb_prev;
2190 char sb_eol; /* TRUE when line ends after this text */
2191 int sb_msg_col; /* column in which text starts */
2192 int sb_attr; /* text attributes */
2193 char_u sb_text[1]; /* text to be displayed, actually longer */
2194};
2195
2196static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2197
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002198static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2199static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002200
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002201static int do_clear_sb_text = FALSE; /* clear text on next msg */
2202
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002203/*
2204 * Store part of a printed message for displaying when scrolling back.
2205 */
2206 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002207store_sb_text(
2208 char_u **sb_str, /* start of string */
2209 char_u *s, /* just after string */
2210 int attr,
2211 int *sb_col,
2212 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002213{
2214 msgchunk_T *mp;
2215
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002216 if (do_clear_sb_text)
2217 {
2218 clear_sb_text();
2219 do_clear_sb_text = FALSE;
2220 }
2221
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002222 if (s > *sb_str)
2223 {
2224 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2225 if (mp != NULL)
2226 {
2227 mp->sb_eol = finish;
2228 mp->sb_msg_col = *sb_col;
2229 mp->sb_attr = attr;
2230 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2231
2232 if (last_msgchunk == NULL)
2233 {
2234 last_msgchunk = mp;
2235 mp->sb_prev = NULL;
2236 }
2237 else
2238 {
2239 mp->sb_prev = last_msgchunk;
2240 last_msgchunk->sb_next = mp;
2241 last_msgchunk = mp;
2242 }
2243 mp->sb_next = NULL;
2244 }
2245 }
2246 else if (finish && last_msgchunk != NULL)
2247 last_msgchunk->sb_eol = TRUE;
2248
2249 *sb_str = s;
2250 *sb_col = 0;
2251}
2252
2253/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002254 * Finished showing messages, clear the scroll-back text on the next message.
2255 */
2256 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002257may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002258{
2259 do_clear_sb_text = TRUE;
2260}
2261
2262/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002263 * Clear any text remembered for scrolling back.
2264 * Called when redrawing the screen.
2265 */
2266 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002267clear_sb_text(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002268{
2269 msgchunk_T *mp;
2270
2271 while (last_msgchunk != NULL)
2272 {
2273 mp = last_msgchunk->sb_prev;
2274 vim_free(last_msgchunk);
2275 last_msgchunk = mp;
2276 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002277}
2278
2279/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002280 * "g<" command.
2281 */
2282 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002283show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002284{
2285 msgchunk_T *mp;
2286
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002287 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002288 * weird, typing a command without output results in one line. */
2289 mp = msg_sb_start(last_msgchunk);
2290 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002291 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002292 else
2293 {
2294 do_more_prompt('G');
2295 wait_return(FALSE);
2296 }
2297}
2298
2299/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002300 * Move to the start of screen line in already displayed text.
2301 */
2302 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002303msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002304{
2305 msgchunk_T *mp = mps;
2306
2307 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2308 mp = mp->sb_prev;
2309 return mp;
2310}
2311
2312/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002313 * Mark the last message chunk as finishing the line.
2314 */
2315 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002316msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002317{
2318 if (last_msgchunk != NULL)
2319 last_msgchunk->sb_eol = TRUE;
2320}
2321
2322/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002323 * Display a screen line from previously displayed text at row "row".
2324 * Returns a pointer to the text for the next line (can be NULL).
2325 */
2326 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002327disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002328{
2329 msgchunk_T *mp = smp;
2330 char_u *p;
2331
2332 for (;;)
2333 {
2334 msg_row = row;
2335 msg_col = mp->sb_msg_col;
2336 p = mp->sb_text;
2337 if (*p == '\n') /* don't display the line break */
2338 ++p;
2339 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2340 if (mp->sb_eol || mp->sb_next == NULL)
2341 break;
2342 mp = mp->sb_next;
2343 }
2344 return mp->sb_next;
2345}
2346
2347/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 * Output any postponed text for msg_puts_attr_len().
2349 */
2350 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002351t_puts(
2352 int *t_col,
2353 char_u *t_s,
2354 char_u *s,
2355 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356{
2357 /* output postponed text */
2358 msg_didout = TRUE; /* remember that line is not empty */
2359 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002360 msg_col += *t_col;
2361 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362#ifdef FEAT_MBYTE
2363 /* If the string starts with a composing character don't increment the
2364 * column position for it. */
2365 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2366 --msg_col;
2367#endif
2368 if (msg_col >= Columns)
2369 {
2370 msg_col = 0;
2371 ++msg_row;
2372 }
2373}
2374
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375/*
2376 * Returns TRUE when messages should be printed with mch_errmsg().
2377 * This is used when there is no valid screen, so we can see error messages.
2378 * If termcap is not active, we may be writing in an alternate console
2379 * window, cursor positioning may not work correctly (window size may be
2380 * different, e.g. for Win32 console) or we just don't know where the
2381 * cursor is.
2382 */
2383 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002384msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 return (!msg_check_screen()
2387#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2388 || !termcap_active
2389#endif
2390 || (swapping_screen() && !termcap_active)
2391 );
2392}
2393
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002394/*
2395 * Print a message when there is no valid screen.
2396 */
2397 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002398msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002399{
2400 char_u *s = str;
2401 char_u buf[4];
2402 char_u *p;
2403
2404#ifdef WIN3264
2405 if (!(silent_mode && p_verbose == 0))
2406 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2407#endif
2408 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2409 {
2410 if (!(silent_mode && p_verbose == 0))
2411 {
2412 /* NL --> CR NL translation (for Unix, not for "--version") */
2413 /* NL --> CR translation (for Mac) */
2414 p = &buf[0];
2415 if (*s == '\n' && !info_message)
2416 *p++ = '\r';
2417#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2418 else
2419#endif
2420 *p++ = *s;
2421 *p = '\0';
2422 if (info_message) /* informative message, not an error */
2423 mch_msg((char *)buf);
2424 else
2425 mch_errmsg((char *)buf);
2426 }
2427
2428 /* primitive way to compute the current column */
2429#ifdef FEAT_RIGHTLEFT
2430 if (cmdmsg_rl)
2431 {
2432 if (*s == '\r' || *s == '\n')
2433 msg_col = Columns - 1;
2434 else
2435 --msg_col;
2436 }
2437 else
2438#endif
2439 {
2440 if (*s == '\r' || *s == '\n')
2441 msg_col = 0;
2442 else
2443 ++msg_col;
2444 }
2445 ++s;
2446 }
2447 msg_didout = TRUE; /* assume that line is not empty */
2448
2449#ifdef WIN3264
2450 if (!(silent_mode && p_verbose == 0))
2451 mch_settmode(TMODE_RAW);
2452#endif
2453}
2454
2455/*
2456 * Show the more-prompt and handle the user response.
2457 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002458 * When at hit-enter prompt "typed_char" is the already typed character,
2459 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002460 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2461 */
2462 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002463do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002464{
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002465 static int entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002466 int used_typed_char = typed_char;
2467 int oldState = State;
2468 int c;
2469#ifdef FEAT_CON_DIALOG
2470 int retval = FALSE;
2471#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002472 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002473 msgchunk_T *mp_last = NULL;
2474 msgchunk_T *mp;
2475 int i;
2476
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002477 /* We get called recursively when a timer callback outputs a message. In
Bram Moolenaara0055ad2016-06-02 18:37:05 +02002478 * that case don't show another prompt. Also when at the hit-Enter prompt
2479 * and nothing was typed. */
2480 if (entered || (State == HITRETURN && typed_char == 0))
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002481 return FALSE;
2482 entered = TRUE;
2483
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002484 if (typed_char == 'G')
2485 {
2486 /* "g<": Find first line on the last page. */
2487 mp_last = msg_sb_start(last_msgchunk);
2488 for (i = 0; i < Rows - 2 && mp_last != NULL
2489 && mp_last->sb_prev != NULL; ++i)
2490 mp_last = msg_sb_start(mp_last->sb_prev);
2491 }
2492
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002493 State = ASKMORE;
2494#ifdef FEAT_MOUSE
2495 setmouse();
2496#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002497 if (typed_char == NUL)
2498 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002499 for (;;)
2500 {
2501 /*
2502 * Get a typed character directly from the user.
2503 */
2504 if (used_typed_char != NUL)
2505 {
2506 c = used_typed_char; /* was typed at hit-enter prompt */
2507 used_typed_char = NUL;
2508 }
2509 else
2510 c = get_keystroke();
2511
2512#if defined(FEAT_MENU) && defined(FEAT_GUI)
2513 if (c == K_MENU)
2514 {
2515 int idx = get_menu_index(current_menu, ASKMORE);
2516
2517 /* Used a menu. If it starts with CTRL-Y, it must
2518 * be a "Copy" for the clipboard. Otherwise
2519 * assume that we end */
2520 if (idx == MENU_INDEX_INVALID)
2521 continue;
2522 c = *current_menu->strings[idx];
2523 if (c != NUL && current_menu->strings[idx][1] != NUL)
2524 ins_typebuf(current_menu->strings[idx] + 1,
2525 current_menu->noremap[idx], 0, TRUE,
2526 current_menu->silent[idx]);
2527 }
2528#endif
2529
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002530 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002531 switch (c)
2532 {
2533 case BS: /* scroll one line back */
2534 case K_BS:
2535 case 'k':
2536 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002537 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002538 break;
2539
2540 case CAR: /* one extra line */
2541 case NL:
2542 case 'j':
2543 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002544 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002545 break;
2546
2547 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002548 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002549 break;
2550
2551 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002552 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002553 break;
2554
2555 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002556 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002557 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002558 break;
2559
2560 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002561 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002562 case K_PAGEDOWN:
2563 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002564 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002565 break;
2566
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002567 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002568 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002569 break;
2570
2571 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002572 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002573 lines_left = 999999;
2574 break;
2575
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002576 case ':': /* start new command line */
2577#ifdef FEAT_CON_DIALOG
2578 if (!confirm_msg_used)
2579#endif
2580 {
2581 /* Since got_int is set all typeahead will be flushed, but we
2582 * want to keep this ':', remember that in a special way. */
2583 typeahead_noflush(':');
2584 cmdline_row = Rows - 1; /* put ':' on this line */
2585 skip_redraw = TRUE; /* skip redraw once */
2586 need_wait_return = FALSE; /* don't wait in main() */
2587 }
2588 /*FALLTHROUGH*/
2589 case 'q': /* quit */
2590 case Ctrl_C:
2591 case ESC:
2592#ifdef FEAT_CON_DIALOG
2593 if (confirm_msg_used)
2594 {
2595 /* Jump to the choices of the dialog. */
2596 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002597 }
2598 else
2599#endif
2600 {
2601 got_int = TRUE;
2602 quit_more = TRUE;
2603 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002604 /* When there is some more output (wrapping line) display that
2605 * without another prompt. */
2606 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002607 break;
2608
2609#ifdef FEAT_CLIPBOARD
2610 case Ctrl_Y:
2611 /* Strange way to allow copying (yanking) a modeless
2612 * selection at the more prompt. Use CTRL-Y,
2613 * because the same is used in Cmdline-mode and at the
2614 * hit-enter prompt. However, scrolling one line up
2615 * might be expected... */
2616 if (clip_star.state == SELECT_DONE)
2617 clip_copy_modeless_selection(TRUE);
2618 continue;
2619#endif
2620 default: /* no valid response */
2621 msg_moremsg(TRUE);
2622 continue;
2623 }
2624
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002625 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002626 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002627 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002628 {
2629 /* go to start of last line */
2630 if (mp_last == NULL)
2631 mp = msg_sb_start(last_msgchunk);
2632 else if (mp_last->sb_prev != NULL)
2633 mp = msg_sb_start(mp_last->sb_prev);
2634 else
2635 mp = NULL;
2636
2637 /* go to start of line at top of the screen */
2638 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2639 ++i)
2640 mp = msg_sb_start(mp->sb_prev);
2641
2642 if (mp != NULL && mp->sb_prev != NULL)
2643 {
2644 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002645 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002646 {
2647 if (mp == NULL || mp->sb_prev == NULL)
2648 break;
2649 mp = msg_sb_start(mp->sb_prev);
2650 if (mp_last == NULL)
2651 mp_last = msg_sb_start(last_msgchunk);
2652 else
2653 mp_last = msg_sb_start(mp_last->sb_prev);
2654 }
2655
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002656 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002657 (int)Rows, NULL) == OK)
2658 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002659 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002660 (void)disp_sb_line(0, mp);
2661 }
2662 else
2663 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002664 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002665 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002666 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2667 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002668 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002669 ++msg_scrolled;
2670 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002671 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002672 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002673 }
2674 }
2675 else
2676 {
2677 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002678 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002679 {
2680 /* scroll up, display line at bottom */
2681 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002682 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002683 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2684 (int)Columns, ' ', ' ', 0);
2685 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002686 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002687 }
2688 }
2689
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002690 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002691 {
2692 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002693 screen_fill((int)Rows - 1, (int)Rows, 0,
2694 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002695 msg_moremsg(FALSE);
2696 continue;
2697 }
2698
2699 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002700 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002701 }
2702
2703 break;
2704 }
2705
2706 /* clear the --more-- message */
2707 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2708 State = oldState;
2709#ifdef FEAT_MOUSE
2710 setmouse();
2711#endif
2712 if (quit_more)
2713 {
2714 msg_row = Rows - 1;
2715 msg_col = 0;
2716 }
2717#ifdef FEAT_RIGHTLEFT
2718 else if (cmdmsg_rl)
2719 msg_col = Columns - 1;
2720#endif
2721
Bram Moolenaarbfb96c02016-03-19 17:05:20 +01002722 entered = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002723#ifdef FEAT_CON_DIALOG
2724 return retval;
2725#else
2726 return FALSE;
2727#endif
2728}
2729
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2731
2732#ifdef mch_errmsg
2733# undef mch_errmsg
2734#endif
2735#ifdef mch_msg
2736# undef mch_msg
2737#endif
2738
2739/*
2740 * Give an error message. To be used when the screen hasn't been initialized
2741 * yet. When stderr can't be used, collect error messages until the GUI has
2742 * started and they can be displayed in a message box.
2743 */
2744 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002745mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746{
2747 int len;
2748
2749#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2750 /* On Unix use stderr if it's a tty.
2751 * When not going to start the GUI also use stderr.
2752 * On Mac, when started from Finder, stderr is the console. */
2753 if (
2754# ifdef UNIX
2755# ifdef MACOS_X_UNIX
2756 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2757# else
2758 isatty(2)
2759# endif
2760# ifdef FEAT_GUI
2761 ||
2762# endif
2763# endif
2764# ifdef FEAT_GUI
2765 !(gui.in_use || gui.starting)
2766# endif
2767 )
2768 {
2769 fprintf(stderr, "%s", str);
2770 return;
2771 }
2772#endif
2773
2774 /* avoid a delay for a message that isn't there */
2775 emsg_on_display = FALSE;
2776
2777 len = (int)STRLEN(str) + 1;
2778 if (error_ga.ga_growsize == 0)
2779 {
2780 error_ga.ga_growsize = 80;
2781 error_ga.ga_itemsize = 1;
2782 }
2783 if (ga_grow(&error_ga, len) == OK)
2784 {
2785 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2786 (char_u *)str, len);
2787#ifdef UNIX
2788 /* remove CR characters, they are displayed */
2789 {
2790 char_u *p;
2791
2792 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2793 for (;;)
2794 {
2795 p = vim_strchr(p, '\r');
2796 if (p == NULL)
2797 break;
2798 *p = ' ';
2799 }
2800 }
2801#endif
2802 --len; /* don't count the NUL at the end */
2803 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 }
2805}
2806
2807/*
2808 * Give a message. To be used when the screen hasn't been initialized yet.
2809 * When there is no tty, collect messages until the GUI has started and they
2810 * can be displayed in a message box.
2811 */
2812 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002813mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814{
2815#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2816 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2817 * uses mch_errmsg() when started from the desktop.
2818 * When not going to start the GUI also use stdout.
2819 * On Mac, when started from Finder, stderr is the console. */
2820 if (
2821# ifdef UNIX
2822# ifdef MACOS_X_UNIX
2823 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2824# else
2825 isatty(2)
2826# endif
2827# ifdef FEAT_GUI
2828 ||
2829# endif
2830# endif
2831# ifdef FEAT_GUI
2832 !(gui.in_use || gui.starting)
2833# endif
2834 )
2835 {
2836 printf("%s", str);
2837 return;
2838 }
2839# endif
2840 mch_errmsg(str);
2841}
2842#endif /* USE_MCH_ERRMSG */
2843
2844/*
2845 * Put a character on the screen at the current message position and advance
2846 * to the next position. Only for printable ASCII!
2847 */
2848 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002849msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850{
2851 msg_didout = TRUE; /* remember that line is not empty */
2852 screen_putchar(c, msg_row, msg_col, attr);
2853#ifdef FEAT_RIGHTLEFT
2854 if (cmdmsg_rl)
2855 {
2856 if (--msg_col == 0)
2857 {
2858 msg_col = Columns;
2859 ++msg_row;
2860 }
2861 }
2862 else
2863#endif
2864 {
2865 if (++msg_col >= Columns)
2866 {
2867 msg_col = 0;
2868 ++msg_row;
2869 }
2870 }
2871}
2872
2873 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002874msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002876 int attr;
2877 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878
2879 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002880 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002882 screen_puts((char_u *)
2883 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2884 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885}
2886
2887/*
2888 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2889 * exmode_active.
2890 */
2891 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002892repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893{
2894 if (State == ASKMORE)
2895 {
2896 msg_moremsg(TRUE); /* display --more-- message again */
2897 msg_row = Rows - 1;
2898 }
2899#ifdef FEAT_CON_DIALOG
2900 else if (State == CONFIRM)
2901 {
2902 display_confirm_msg(); /* display ":confirm" message again */
2903 msg_row = Rows - 1;
2904 }
2905#endif
2906 else if (State == EXTERNCMD)
2907 {
2908 windgoto(msg_row, msg_col); /* put cursor back */
2909 }
2910 else if (State == HITRETURN || State == SETWSIZE)
2911 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002912 if (msg_row == Rows - 1)
2913 {
2914 /* Avoid drawing the "hit-enter" prompt below the previous one,
2915 * overwrite it. Esp. useful when regaining focus and a
2916 * FocusGained autocmd exists but didn't draw anything. */
2917 msg_didout = FALSE;
2918 msg_col = 0;
2919 msg_clr_eos();
2920 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 hit_return_msg();
2922 msg_row = Rows - 1;
2923 }
2924}
2925
2926/*
2927 * msg_check_screen - check if the screen is initialized.
2928 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2929 * While starting the GUI the terminal codes will be set for the GUI, but the
2930 * output goes to the terminal. Don't use the terminal codes then.
2931 */
2932 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002933msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934{
2935 if (!full_screen || !screen_valid(FALSE))
2936 return FALSE;
2937
2938 if (msg_row >= Rows)
2939 msg_row = Rows - 1;
2940 if (msg_col >= Columns)
2941 msg_col = Columns - 1;
2942 return TRUE;
2943}
2944
2945/*
2946 * Clear from current message position to end of screen.
2947 * Skip this when ":silent" was used, no need to clear for redirection.
2948 */
2949 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002950msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951{
2952 if (msg_silent == 0)
2953 msg_clr_eos_force();
2954}
2955
2956/*
2957 * Clear from current message position to end of screen.
2958 * Note: msg_col is not updated, so we remember the end of the message
2959 * for msg_check().
2960 */
2961 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002962msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963{
2964 if (msg_use_printf())
2965 {
2966 if (full_screen) /* only when termcap codes are valid */
2967 {
2968 if (*T_CD)
2969 out_str(T_CD); /* clear to end of display */
2970 else if (*T_CE)
2971 out_str(T_CE); /* clear to end of line */
2972 }
2973 }
2974 else
2975 {
2976#ifdef FEAT_RIGHTLEFT
2977 if (cmdmsg_rl)
2978 {
2979 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2980 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2981 }
2982 else
2983#endif
2984 {
2985 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2986 ' ', ' ', 0);
2987 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2988 }
2989 }
2990}
2991
2992/*
2993 * Clear the command line.
2994 */
2995 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002996msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997{
2998 msg_row = cmdline_row;
2999 msg_col = 0;
3000 msg_clr_eos_force();
3001}
3002
3003/*
3004 * end putting a message on the screen
3005 * call wait_return if the message does not fit in the available space
3006 * return TRUE if wait_return not called.
3007 */
3008 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003009msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010{
3011 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02003012 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 * or the ruler option is set and we run into it,
3014 * we have to redraw the window.
3015 * Do not do this if we are abandoning the file or editing the command line.
3016 */
3017 if (!exiting && need_wait_return && !(State & CMDLINE))
3018 {
3019 wait_return(FALSE);
3020 return FALSE;
3021 }
3022 out_flush();
3023 return TRUE;
3024}
3025
3026/*
3027 * If the written message runs into the shown command or ruler, we have to
3028 * wait for hit-return and redraw the window later.
3029 */
3030 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003031msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032{
3033 if (msg_row == Rows - 1 && msg_col >= sc_col)
3034 {
3035 need_wait_return = TRUE;
3036 redraw_cmdline = TRUE;
3037 }
3038}
3039
3040/*
3041 * May write a string to the redirection file.
3042 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
3043 */
3044 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003045redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046{
3047 char_u *s = str;
3048 static int cur_col = 0;
3049
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003050 /* Don't do anything for displaying prompts and the like. */
3051 if (redir_off)
3052 return;
3053
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003054 /* If 'verbosefile' is set prepare for writing in that file. */
3055 if (*p_vfile != NUL && verbose_fd == NULL)
3056 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003057
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003058 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 {
3060 /* If the string doesn't start with CR or NL, go to msg_col */
3061 if (*s != '\n' && *s != '\r')
3062 {
3063 while (cur_col < msg_col)
3064 {
3065#ifdef FEAT_EVAL
3066 if (redir_reg)
3067 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003068 else if (redir_vname)
3069 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003070 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003072 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003074 if (verbose_fd != NULL)
3075 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 ++cur_col;
3077 }
3078 }
3079
3080#ifdef FEAT_EVAL
3081 if (redir_reg)
3082 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003083 if (redir_vname)
3084 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085#endif
3086
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003087 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3089 {
3090#ifdef FEAT_EVAL
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003091 if (!redir_reg && !redir_vname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003093 if (redir_fd != NULL)
3094 putc(*s, redir_fd);
3095 if (verbose_fd != NULL)
3096 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 if (*s == '\r' || *s == '\n')
3098 cur_col = 0;
3099 else if (*s == '\t')
3100 cur_col += (8 - cur_col % 8);
3101 else
3102 ++cur_col;
3103 ++s;
3104 }
3105
3106 if (msg_silent != 0) /* should update msg_col */
3107 msg_col = cur_col;
3108 }
3109}
3110
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003111 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003112redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003113{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003114 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003115#ifdef FEAT_EVAL
3116 || redir_reg || redir_vname
3117#endif
3118 ;
3119}
3120
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003122 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003123 * Must always be called paired with verbose_leave()!
3124 */
3125 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003126verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003127{
3128 if (*p_vfile != NUL)
3129 ++msg_silent;
3130}
3131
3132/*
3133 * After giving verbose message.
3134 * Must always be called paired with verbose_enter()!
3135 */
3136 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003137verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003138{
3139 if (*p_vfile != NUL)
3140 if (--msg_silent < 0)
3141 msg_silent = 0;
3142}
3143
3144/*
3145 * Like verbose_enter() and set msg_scroll when displaying the message.
3146 */
3147 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003148verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003149{
3150 if (*p_vfile != NUL)
3151 ++msg_silent;
3152 else
3153 /* always scroll up, don't overwrite */
3154 msg_scroll = TRUE;
3155}
3156
3157/*
3158 * Like verbose_leave() and set cmdline_row when displaying the message.
3159 */
3160 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003161verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003162{
3163 if (*p_vfile != NUL)
3164 {
3165 if (--msg_silent < 0)
3166 msg_silent = 0;
3167 }
3168 else
3169 cmdline_row = msg_row;
3170}
3171
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003172/*
3173 * Called when 'verbosefile' is set: stop writing to the file.
3174 */
3175 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003176verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003177{
3178 if (verbose_fd != NULL)
3179 {
3180 fclose(verbose_fd);
3181 verbose_fd = NULL;
3182 }
3183 verbose_did_open = FALSE;
3184}
3185
3186/*
3187 * Open the file 'verbosefile'.
3188 * Return FAIL or OK.
3189 */
3190 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003191verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003192{
3193 if (verbose_fd == NULL && !verbose_did_open)
3194 {
3195 /* Only give the error message once. */
3196 verbose_did_open = TRUE;
3197
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003198 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003199 if (verbose_fd == NULL)
3200 {
3201 EMSG2(_(e_notopen), p_vfile);
3202 return FAIL;
3203 }
3204 }
3205 return OK;
3206}
3207
3208/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 * Give a warning message (for searching).
3210 * Use 'w' highlighting and may repeat the message after redrawing
3211 */
3212 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003213give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214{
3215 /* Don't do this for ":silent". */
3216 if (msg_silent != 0)
3217 return;
3218
3219 /* Don't want a hit-enter prompt here. */
3220 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222#ifdef FEAT_EVAL
3223 set_vim_var_string(VV_WARNINGMSG, message, -1);
3224#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 vim_free(keep_msg);
3226 keep_msg = NULL;
3227 if (hl)
3228 keep_msg_attr = hl_attr(HLF_W);
3229 else
3230 keep_msg_attr = 0;
3231 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003232 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 msg_didout = FALSE; /* overwrite this message */
3234 msg_nowait = TRUE; /* don't wait for this message */
3235 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003236
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 --no_wait_return;
3238}
3239
3240/*
3241 * Advance msg cursor to column "col".
3242 */
3243 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003244msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245{
3246 if (msg_silent != 0) /* nothing to advance to */
3247 {
3248 msg_col = col; /* for redirection, may fill it up later */
3249 return;
3250 }
3251 if (col >= Columns) /* not enough room */
3252 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003253#ifdef FEAT_RIGHTLEFT
3254 if (cmdmsg_rl)
3255 while (msg_col > Columns - col)
3256 msg_putchar(' ');
3257 else
3258#endif
3259 while (msg_col < col)
3260 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261}
3262
3263#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3264/*
3265 * Used for "confirm()" function, and the :confirm command prefix.
3266 * Versions which haven't got flexible dialogs yet, and console
3267 * versions, get this generic handler which uses the command line.
3268 *
3269 * type = one of:
3270 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3271 * title = title string (can be NULL for default)
3272 * (neither used in console dialogs at the moment)
3273 *
3274 * Format of the "buttons" string:
3275 * "Button1Name\nButton2Name\nButton3Name"
3276 * The first button should normally be the default/accept
3277 * The second button should be the 'Cancel' button
3278 * Other buttons- use your imagination!
3279 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3280 * different letter.
3281 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003283do_dialog(
3284 int type UNUSED,
3285 char_u *title UNUSED,
3286 char_u *message,
3287 char_u *buttons,
3288 int dfltbutton,
3289 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003290 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003291 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003292 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293{
3294 int oldState;
3295 int retval = 0;
3296 char_u *hotkeys;
3297 int c;
3298 int i;
3299
3300#ifndef NO_CONSOLE
3301 /* Don't output anything in silent mode ("ex -s") */
3302 if (silent_mode)
3303 return dfltbutton; /* return default option */
3304#endif
3305
3306#ifdef FEAT_GUI_DIALOG
3307 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3308 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3309 {
3310 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003311 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003312 /* avoid a hit-enter prompt without clearing the cmdline */
3313 need_wait_return = FALSE;
3314 emsg_on_display = FALSE;
3315 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316
3317 /* Flush output to avoid that further messages and redrawing is done
3318 * in the wrong order. */
3319 out_flush();
3320 gui_mch_update();
3321
3322 return c;
3323 }
3324#endif
3325
3326 oldState = State;
3327 State = CONFIRM;
3328#ifdef FEAT_MOUSE
3329 setmouse();
3330#endif
3331
3332 /*
3333 * Since we wait for a keypress, don't make the
3334 * user press RETURN as well afterwards.
3335 */
3336 ++no_wait_return;
3337 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3338
3339 if (hotkeys != NULL)
3340 {
3341 for (;;)
3342 {
3343 /* Get a typed character directly from the user. */
3344 c = get_keystroke();
3345 switch (c)
3346 {
3347 case CAR: /* User accepts default option */
3348 case NL:
3349 retval = dfltbutton;
3350 break;
3351 case Ctrl_C: /* User aborts/cancels */
3352 case ESC:
3353 retval = 0;
3354 break;
3355 default: /* Could be a hotkey? */
3356 if (c < 0) /* special keys are ignored here */
3357 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003358 if (c == ':' && ex_cmd)
3359 {
3360 retval = dfltbutton;
3361 ins_char_typebuf(':');
3362 break;
3363 }
3364
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 /* Make the character lowercase, as chars in "hotkeys" are. */
3366 c = MB_TOLOWER(c);
3367 retval = 1;
3368 for (i = 0; hotkeys[i]; ++i)
3369 {
3370#ifdef FEAT_MBYTE
3371 if (has_mbyte)
3372 {
3373 if ((*mb_ptr2char)(hotkeys + i) == c)
3374 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003375 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 }
3377 else
3378#endif
3379 if (hotkeys[i] == c)
3380 break;
3381 ++retval;
3382 }
3383 if (hotkeys[i])
3384 break;
3385 /* No hotkey match, so keep waiting */
3386 continue;
3387 }
3388 break;
3389 }
3390
3391 vim_free(hotkeys);
3392 }
3393
3394 State = oldState;
3395#ifdef FEAT_MOUSE
3396 setmouse();
3397#endif
3398 --no_wait_return;
3399 msg_end_prompt();
3400
3401 return retval;
3402}
3403
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003404static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405
3406/*
3407 * Copy one character from "*from" to "*to", taking care of multi-byte
3408 * characters. Return the length of the character in bytes.
3409 */
3410 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003411copy_char(
3412 char_u *from,
3413 char_u *to,
3414 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415{
3416#ifdef FEAT_MBYTE
3417 int len;
3418 int c;
3419
3420 if (has_mbyte)
3421 {
3422 if (lowercase)
3423 {
3424 c = MB_TOLOWER((*mb_ptr2char)(from));
3425 return (*mb_char2bytes)(c, to);
3426 }
3427 else
3428 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003429 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 mch_memmove(to, from, (size_t)len);
3431 return len;
3432 }
3433 }
3434 else
3435#endif
3436 {
3437 if (lowercase)
3438 *to = (char_u)TOLOWER_LOC(*from);
3439 else
3440 *to = *from;
3441 return 1;
3442 }
3443}
3444
3445/*
3446 * Format the dialog string, and display it at the bottom of
3447 * the screen. Return a string of hotkey chars (if defined) for
3448 * each 'button'. If a button has no hotkey defined, the first character of
3449 * the button is used.
3450 * The hotkeys can be multi-byte characters, but without combining chars.
3451 *
3452 * Returns an allocated string with hotkeys, or NULL for error.
3453 */
3454 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003455msg_show_console_dialog(
3456 char_u *message,
3457 char_u *buttons,
3458 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459{
3460 int len = 0;
3461#ifdef FEAT_MBYTE
3462# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3463#else
3464# define HOTK_LEN 1
3465#endif
3466 int lenhotkey = HOTK_LEN; /* count first button */
3467 char_u *hotk = NULL;
3468 char_u *msgp = NULL;
3469 char_u *hotkp = NULL;
3470 char_u *r;
3471 int copy;
3472#define HAS_HOTKEY_LEN 30
3473 char_u has_hotkey[HAS_HOTKEY_LEN];
3474 int first_hotkey = FALSE; /* first char of button is hotkey */
3475 int idx;
3476
3477 has_hotkey[0] = FALSE;
3478
3479 /*
3480 * First loop: compute the size of memory to allocate.
3481 * Second loop: copy to the allocated memory.
3482 */
3483 for (copy = 0; copy <= 1; ++copy)
3484 {
3485 r = buttons;
3486 idx = 0;
3487 while (*r)
3488 {
3489 if (*r == DLG_BUTTON_SEP)
3490 {
3491 if (copy)
3492 {
3493 *msgp++ = ',';
3494 *msgp++ = ' '; /* '\n' -> ', ' */
3495
3496 /* advance to next hotkey and set default hotkey */
3497#ifdef FEAT_MBYTE
3498 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003499 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 else
3501#endif
3502 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003503 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 if (dfltbutton)
3505 --dfltbutton;
3506
3507 /* If no hotkey is specified first char is used. */
3508 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3509 first_hotkey = TRUE;
3510 }
3511 else
3512 {
3513 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3514 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3515 if (idx < HAS_HOTKEY_LEN - 1)
3516 has_hotkey[++idx] = FALSE;
3517 }
3518 }
3519 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3520 {
3521 if (*r == DLG_HOTKEY_CHAR)
3522 ++r;
3523 first_hotkey = FALSE;
3524 if (copy)
3525 {
3526 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3527 *msgp++ = *r;
3528 else
3529 {
3530 /* '&a' -> '[a]' */
3531 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3532 msgp += copy_char(r, msgp, FALSE);
3533 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3534
3535 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003536 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 }
3538 }
3539 else
3540 {
3541 ++len; /* '&a' -> '[a]' */
3542 if (idx < HAS_HOTKEY_LEN - 1)
3543 has_hotkey[idx] = TRUE;
3544 }
3545 }
3546 else
3547 {
3548 /* everything else copy literally */
3549 if (copy)
3550 msgp += copy_char(r, msgp, FALSE);
3551 }
3552
3553 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003554 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 }
3556
3557 if (copy)
3558 {
3559 *msgp++ = ':';
3560 *msgp++ = ' ';
3561 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 }
3563 else
3564 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003565 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003566 + 2 /* for the NL's */
3567 + STRLEN(buttons)
3568 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003569 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570
3571 /* If no hotkey is specified first char is used. */
3572 if (!has_hotkey[0])
3573 {
3574 first_hotkey = TRUE;
3575 len += 2; /* "x" -> "[x]" */
3576 }
3577
3578 /*
3579 * Now allocate and load the strings
3580 */
3581 vim_free(confirm_msg);
3582 confirm_msg = alloc(len);
3583 if (confirm_msg == NULL)
3584 return NULL;
3585 *confirm_msg = NUL;
3586 hotk = alloc(lenhotkey);
3587 if (hotk == NULL)
3588 return NULL;
3589
3590 *confirm_msg = '\n';
3591 STRCPY(confirm_msg + 1, message);
3592
3593 msgp = confirm_msg + 1 + STRLEN(message);
3594 hotkp = hotk;
3595
Bram Moolenaar6a516062007-07-05 08:11:42 +00003596 /* Define first default hotkey. Keep the hotkey string NUL
3597 * terminated to avoid reading past the end. */
3598 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
3600 /* Remember where the choices start, displaying starts here when
3601 * "hotkp" typed at the more prompt. */
3602 confirm_msg_tail = msgp;
3603 *msgp++ = '\n';
3604 }
3605 }
3606
3607 display_confirm_msg();
3608 return hotk;
3609}
3610
3611/*
3612 * Display the ":confirm" message. Also called when screen resized.
3613 */
3614 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003615display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616{
3617 /* avoid that 'q' at the more prompt truncates the message here */
3618 ++confirm_msg_used;
3619 if (confirm_msg != NULL)
3620 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3621 --confirm_msg_used;
3622}
3623
3624#endif /* FEAT_CON_DIALOG */
3625
3626#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3627
3628 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003629vim_dialog_yesno(
3630 int type,
3631 char_u *title,
3632 char_u *message,
3633 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634{
3635 if (do_dialog(type,
3636 title == NULL ? (char_u *)_("Question") : title,
3637 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003638 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 return VIM_YES;
3640 return VIM_NO;
3641}
3642
3643 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003644vim_dialog_yesnocancel(
3645 int type,
3646 char_u *title,
3647 char_u *message,
3648 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649{
3650 switch (do_dialog(type,
3651 title == NULL ? (char_u *)_("Question") : title,
3652 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003653 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 {
3655 case 1: return VIM_YES;
3656 case 2: return VIM_NO;
3657 }
3658 return VIM_CANCEL;
3659}
3660
3661 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003662vim_dialog_yesnoallcancel(
3663 int type,
3664 char_u *title,
3665 char_u *message,
3666 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667{
3668 switch (do_dialog(type,
3669 title == NULL ? (char_u *)"Question" : title,
3670 message,
3671 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003672 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {
3674 case 1: return VIM_YES;
3675 case 2: return VIM_NO;
3676 case 3: return VIM_ALL;
3677 case 4: return VIM_DISCARDALL;
3678 }
3679 return VIM_CANCEL;
3680}
3681
3682#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3683
3684#if defined(FEAT_BROWSE) || defined(PROTO)
3685/*
3686 * Generic browse function. Calls gui_mch_browse() when possible.
3687 * Later this may pop-up a non-GUI file selector (external command?).
3688 */
3689 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003690do_browse(
3691 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3692 char_u *title, /* title for the window */
3693 char_u *dflt, /* default file name (may include directory) */
3694 char_u *ext, /* extension added */
3695 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003697 char_u *filter, /* file name filter */
3698 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699{
3700 char_u *fname;
3701 static char_u *last_dir = NULL; /* last used directory */
3702 char_u *tofree = NULL;
3703 int save_browse = cmdmod.browse;
3704
3705 /* Must turn off browse to avoid that autocommands will get the
3706 * flag too! */
3707 cmdmod.browse = FALSE;
3708
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003709 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003711 if (flags & BROWSE_DIR)
3712 title = (char_u *)_("Select Directory dialog");
3713 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 title = (char_u *)_("Save File dialog");
3715 else
3716 title = (char_u *)_("Open File dialog");
3717 }
3718
3719 /* When no directory specified, use default file name, default dir, buffer
3720 * dir, last dir or current dir */
3721 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3722 {
3723 if (mch_isdir(dflt)) /* default file name is a directory */
3724 {
3725 initdir = dflt;
3726 dflt = NULL;
3727 }
3728 else if (gettail(dflt) != dflt) /* default file name includes a path */
3729 {
3730 tofree = vim_strsave(dflt);
3731 if (tofree != NULL)
3732 {
3733 initdir = tofree;
3734 *gettail(initdir) = NUL;
3735 dflt = gettail(dflt);
3736 }
3737 }
3738 }
3739
3740 if (initdir == NULL || *initdir == NUL)
3741 {
3742 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003743 if (STRCMP(p_bsdir, "last") != 0
3744 && STRCMP(p_bsdir, "buffer") != 0
3745 && STRCMP(p_bsdir, "current") != 0
3746 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 initdir = p_bsdir;
3748 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003749 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 && buf != NULL && buf->b_ffname != NULL)
3751 {
3752 if (dflt == NULL || *dflt == NUL)
3753 dflt = gettail(curbuf->b_ffname);
3754 tofree = vim_strsave(curbuf->b_ffname);
3755 if (tofree != NULL)
3756 {
3757 initdir = tofree;
3758 *gettail(initdir) = NUL;
3759 }
3760 }
3761 /* When 'browsedir' is "last", use dir from last browse */
3762 else if (*p_bsdir == 'l')
3763 initdir = last_dir;
3764 /* When 'browsedir is "current", use current directory. This is the
3765 * default already, leave initdir empty. */
3766 }
3767
3768# ifdef FEAT_GUI
3769 if (gui.in_use) /* when this changes, also adjust f_has()! */
3770 {
3771 if (filter == NULL
3772# ifdef FEAT_EVAL
3773 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3774 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3775# endif
3776 )
3777 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003778 if (flags & BROWSE_DIR)
3779 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003780# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003781 /* For systems that have a directory dialog. */
3782 fname = gui_mch_browsedir(title, initdir);
3783# else
3784 /* Generic solution for selecting a directory: select a file and
3785 * remove the file name. */
3786 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3787# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003788# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003789 /* Win32 adds a dummy file name, others return an arbitrary file
3790 * name. GTK+ 2 returns only the directory, */
3791 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3792 {
3793 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003794 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003795
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003796 if (tail == fname)
3797 *tail++ = '.'; /* use current dir */
3798 *tail = NUL;
3799 }
3800# endif
3801 }
3802 else
3803 fname = gui_mch_browse(flags & BROWSE_SAVE,
3804 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805
3806 /* We hang around in the dialog for a while, the user might do some
3807 * things to our files. The Win32 dialog allows deleting or renaming
3808 * a file, check timestamps. */
3809 need_check_timestamps = TRUE;
3810 did_check_timestamps = FALSE;
3811 }
3812 else
3813# endif
3814 {
3815 /* TODO: non-GUI file selector here */
3816 EMSG(_("E338: Sorry, no file browser in console mode"));
3817 fname = NULL;
3818 }
3819
3820 /* keep the directory for next time */
3821 if (fname != NULL)
3822 {
3823 vim_free(last_dir);
3824 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003825 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 {
3827 *gettail(last_dir) = NUL;
3828 if (*last_dir == NUL)
3829 {
3830 /* filename only returned, must be in current dir */
3831 vim_free(last_dir);
3832 last_dir = alloc(MAXPATHL);
3833 if (last_dir != NULL)
3834 mch_dirname(last_dir, MAXPATHL);
3835 }
3836 }
3837 }
3838
3839 vim_free(tofree);
3840 cmdmod.browse = save_browse;
3841
3842 return fname;
3843}
3844#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003845
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003846#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003847static char *e_printf = N_("E766: Insufficient arguments for printf()");
3848
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003849static varnumber_T tv_nr(typval_T *tvs, int *idxp);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003850static char *tv_str(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003851# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003852static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003853# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003854
3855/*
3856 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3857 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003858 static varnumber_T
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003859tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003860{
3861 int idx = *idxp - 1;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003862 varnumber_T n = 0;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003863 int err = FALSE;
3864
3865 if (tvs[idx].v_type == VAR_UNKNOWN)
3866 EMSG(_(e_printf));
3867 else
3868 {
3869 ++*idxp;
3870 n = get_tv_number_chk(&tvs[idx], &err);
3871 if (err)
3872 n = 0;
3873 }
3874 return n;
3875}
3876
3877/*
3878 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003879 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003880 */
3881 static char *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003882tv_str(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003883{
3884 int idx = *idxp - 1;
3885 char *s = NULL;
3886
3887 if (tvs[idx].v_type == VAR_UNKNOWN)
3888 EMSG(_(e_printf));
3889 else
3890 {
3891 ++*idxp;
3892 s = (char *)get_tv_string_chk(&tvs[idx]);
3893 }
3894 return s;
3895}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003896
3897# ifdef FEAT_FLOAT
3898/*
3899 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3900 */
3901 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003902tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00003903{
3904 int idx = *idxp - 1;
3905 double f = 0;
3906
3907 if (tvs[idx].v_type == VAR_UNKNOWN)
3908 EMSG(_(e_printf));
3909 else
3910 {
3911 ++*idxp;
3912 if (tvs[idx].v_type == VAR_FLOAT)
3913 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003914 else if (tvs[idx].v_type == VAR_NUMBER)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003915 f = (double)tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003916 else
3917 EMSG(_("E807: Expected Float argument for printf()"));
3918 }
3919 return f;
3920}
3921# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003922#endif
3923
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003924/*
3925 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003926 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003927 * consistency.
3928 *
3929 * This code is based on snprintf.c - a portable implementation of snprintf
3930 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003931 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003932 * The original code, including useful comments, can be found here:
3933 * http://www.ijs.si/software/snprintf/
3934 *
3935 * This snprintf() only supports the following conversion specifiers:
3936 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3937 * with flags: '-', '+', ' ', '0' and '#'.
3938 * An asterisk is supported for field width as well as precision.
3939 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00003940 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3941 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003942 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3943 * 'll' (long long int) is not supported.
3944 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003945 * The locale is not used, the string is used as a byte string. This is only
3946 * relevant for double-byte encodings where the second byte may be '%'.
3947 *
Bram Moolenaara2031822006-03-07 22:29:51 +00003948 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3949 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003950 *
3951 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003952 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00003953 * is greater or equal to "str_m", not all characters from the result
3954 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3955 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003956 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003957 */
3958
3959/*
3960 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003961 *
3962 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003963 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003964 */
3965
3966/* When generating prototypes all of this is skipped, cproto doesn't
3967 * understand this. */
3968#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02003969
Bram Moolenaara800b422010-06-27 01:15:55 +02003970/* Like vim_vsnprintf() but append to the string. */
3971 int
3972vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
3973{
3974 va_list ap;
3975 int str_l;
3976 size_t len = STRLEN(str);
3977 size_t space;
3978
3979 if (str_m <= len)
3980 space = 0;
3981 else
3982 space = str_m - len;
3983 va_start(ap, fmt);
3984 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
3985 va_end(ap);
3986 return str_l;
3987}
Bram Moolenaara800b422010-06-27 01:15:55 +02003988
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003989 int
3990vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3991{
3992 va_list ap;
3993 int str_l;
3994
3995 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003996 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003997 va_end(ap);
3998 return str_l;
3999}
4000
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004001 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01004002vim_vsnprintf(
4003 char *str,
4004 size_t str_m,
4005 char *fmt,
4006 va_list ap,
4007 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004008{
4009 size_t str_l = 0;
4010 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004011 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004012
4013 if (p == NULL)
4014 p = "";
4015 while (*p != NUL)
4016 {
4017 if (*p != '%')
4018 {
4019 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004020 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004021
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004022 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004023 if (str_l < str_m)
4024 {
4025 size_t avail = str_m - str_l;
4026
4027 mch_memmove(str + str_l, p, n > avail ? avail : n);
4028 }
4029 p += n;
4030 str_l += n;
4031 }
4032 else
4033 {
4034 size_t min_field_width = 0, precision = 0;
4035 int zero_padding = 0, precision_specified = 0, justify_left = 0;
4036 int alternate_form = 0, force_sign = 0;
4037
4038 /* If both the ' ' and '+' flags appear, the ' ' flag should be
4039 * ignored. */
4040 int space_for_positive = 1;
4041
4042 /* allowed values: \0, h, l, L */
4043 char length_modifier = '\0';
4044
4045 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004046# ifdef FEAT_FLOAT
4047# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004048 * That sounds reasonable to use as the maximum
4049 * printable. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004050# else
4051# define TMP_LEN 32
4052# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004053 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004054
4055 /* string address in case of string argument */
4056 char *str_arg;
4057
4058 /* natural field width of arg without padding and sign */
4059 size_t str_arg_l;
4060
4061 /* unsigned char argument value - only defined for c conversion.
4062 * N.B. standard explicitly states the char argument for the c
4063 * conversion is unsigned */
4064 unsigned char uchar_arg;
4065
4066 /* number of zeros to be inserted for numeric conversions as
4067 * required by the precision or minimal field width */
4068 size_t number_of_zeros_to_pad = 0;
4069
4070 /* index into tmp where zero padding is to be inserted */
4071 size_t zero_padding_insertion_ind = 0;
4072
4073 /* current conversion specifier character */
4074 char fmt_spec = '\0';
4075
4076 str_arg = NULL;
4077 p++; /* skip '%' */
4078
4079 /* parse flags */
4080 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4081 || *p == '#' || *p == '\'')
4082 {
4083 switch (*p)
4084 {
4085 case '0': zero_padding = 1; break;
4086 case '-': justify_left = 1; break;
4087 case '+': force_sign = 1; space_for_positive = 0; break;
4088 case ' ': force_sign = 1;
4089 /* If both the ' ' and '+' flags appear, the ' '
4090 * flag should be ignored */
4091 break;
4092 case '#': alternate_form = 1; break;
4093 case '\'': break;
4094 }
4095 p++;
4096 }
4097 /* If the '0' and '-' flags both appear, the '0' flag should be
4098 * ignored. */
4099
4100 /* parse field width */
4101 if (*p == '*')
4102 {
4103 int j;
4104
4105 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004106 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004107# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004108 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004109# endif
4110 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004111 if (j >= 0)
4112 min_field_width = j;
4113 else
4114 {
4115 min_field_width = -j;
4116 justify_left = 1;
4117 }
4118 }
4119 else if (VIM_ISDIGIT((int)(*p)))
4120 {
4121 /* size_t could be wider than unsigned int; make sure we treat
4122 * argument like common implementations do */
4123 unsigned int uj = *p++ - '0';
4124
4125 while (VIM_ISDIGIT((int)(*p)))
4126 uj = 10 * uj + (unsigned int)(*p++ - '0');
4127 min_field_width = uj;
4128 }
4129
4130 /* parse precision */
4131 if (*p == '.')
4132 {
4133 p++;
4134 precision_specified = 1;
4135 if (*p == '*')
4136 {
4137 int j;
4138
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004139 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004140# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004141 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004142# endif
4143 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004144 p++;
4145 if (j >= 0)
4146 precision = j;
4147 else
4148 {
4149 precision_specified = 0;
4150 precision = 0;
4151 }
4152 }
4153 else if (VIM_ISDIGIT((int)(*p)))
4154 {
4155 /* size_t could be wider than unsigned int; make sure we
4156 * treat argument like common implementations do */
4157 unsigned int uj = *p++ - '0';
4158
4159 while (VIM_ISDIGIT((int)(*p)))
4160 uj = 10 * uj + (unsigned int)(*p++ - '0');
4161 precision = uj;
4162 }
4163 }
4164
4165 /* parse 'h', 'l' and 'll' length modifiers */
4166 if (*p == 'h' || *p == 'l')
4167 {
4168 length_modifier = *p;
4169 p++;
4170 if (length_modifier == 'l' && *p == 'l')
4171 {
4172 /* double l = long long */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004173# ifdef FEAT_NUM64
4174 length_modifier = 'L';
4175# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004176 length_modifier = 'l'; /* treat it as a single 'l' */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004177# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004178 p++;
4179 }
4180 }
4181 fmt_spec = *p;
4182
4183 /* common synonyms: */
4184 switch (fmt_spec)
4185 {
4186 case 'i': fmt_spec = 'd'; break;
4187 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4188 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4189 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004190 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004191 default: break;
4192 }
4193
4194 /* get parameter value, do initial processing */
4195 switch (fmt_spec)
4196 {
4197 /* '%' and 'c' behave similar to 's' regarding flags and field
4198 * widths */
4199 case '%':
4200 case 'c':
4201 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004202 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004203 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004204 str_arg_l = 1;
4205 switch (fmt_spec)
4206 {
4207 case '%':
4208 str_arg = p;
4209 break;
4210
4211 case 'c':
4212 {
4213 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004214
4215 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004216# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004217 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004218# endif
4219 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004220 /* standard demands unsigned char */
4221 uchar_arg = (unsigned char)j;
4222 str_arg = (char *)&uchar_arg;
4223 break;
4224 }
4225
4226 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004227 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004228 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004229# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004230 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004231# endif
4232 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004233 if (str_arg == NULL)
4234 {
4235 str_arg = "[NULL]";
4236 str_arg_l = 6;
4237 }
4238 /* make sure not to address string beyond the specified
4239 * precision !!! */
4240 else if (!precision_specified)
4241 str_arg_l = strlen(str_arg);
4242 /* truncate string if necessary as requested by precision */
4243 else if (precision == 0)
4244 str_arg_l = 0;
4245 else
4246 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004247 /* Don't put the #if inside memchr(), it can be a
4248 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004249# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004250 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004251# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004252 /* memchr on HP does not like n > 2^31 !!! */
4253 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004254 precision <= (size_t)0x7fffffffL ? precision
4255 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004256# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004257 str_arg_l = (q == NULL) ? precision
4258 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004259 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004260# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004261 if (fmt_spec == 'S')
4262 {
4263 if (min_field_width != 0)
4264 min_field_width += STRLEN(str_arg)
4265 - mb_string2cells((char_u *)str_arg, -1);
4266 if (precision)
4267 {
4268 char_u *p1 = (char_u *)str_arg;
4269 size_t i;
4270
4271 for (i = 0; i < precision && *p1; i++)
4272 p1 += mb_ptr2len(p1);
4273
4274 str_arg_l = precision = p1 - (char_u *)str_arg;
4275 }
4276 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004277# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004278 break;
4279
4280 default:
4281 break;
4282 }
4283 break;
4284
4285 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4286 {
4287 /* NOTE: the u, o, x, X and p conversion specifiers
4288 * imply the value is unsigned; d implies a signed
4289 * value */
4290
4291 /* 0 if numeric argument is zero (or if pointer is
4292 * NULL for 'p'), +1 if greater than zero (or nonzero
4293 * for unsigned arguments), -1 if negative (unsigned
4294 * argument is never negative) */
4295 int arg_sign = 0;
4296
4297 /* only defined for length modifier h, or for no
4298 * length modifiers */
4299 int int_arg = 0;
4300 unsigned int uint_arg = 0;
4301
4302 /* only defined for length modifier l */
4303 long int long_arg = 0;
4304 unsigned long int ulong_arg = 0;
4305
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004306# ifdef FEAT_NUM64
4307 /* only defined for length modifier ll */
4308 varnumber_T llong_arg = 0;
4309 uvarnumber_T ullong_arg = 0;
4310# endif
4311
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004312 /* pointer argument value -only defined for p
4313 * conversion */
4314 void *ptr_arg = NULL;
4315
4316 if (fmt_spec == 'p')
4317 {
4318 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004319 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004320# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004321 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004322# endif
4323 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004324 if (ptr_arg != NULL)
4325 arg_sign = 1;
4326 }
4327 else if (fmt_spec == 'd')
4328 {
4329 /* signed */
4330 switch (length_modifier)
4331 {
4332 case '\0':
4333 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004334 /* char and short arguments are passed as int. */
4335 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004336# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004337 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004338# endif
4339 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004340 if (int_arg > 0)
4341 arg_sign = 1;
4342 else if (int_arg < 0)
4343 arg_sign = -1;
4344 break;
4345 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004346 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004347# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004348 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004349# endif
4350 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004351 if (long_arg > 0)
4352 arg_sign = 1;
4353 else if (long_arg < 0)
4354 arg_sign = -1;
4355 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004356# ifdef FEAT_NUM64
4357 case 'L':
4358 llong_arg =
4359# if defined(FEAT_EVAL)
4360 tvs != NULL ? tv_nr(tvs, &arg_idx) :
4361# endif
4362 va_arg(ap, varnumber_T);
4363 if (llong_arg > 0)
4364 arg_sign = 1;
4365 else if (llong_arg < 0)
4366 arg_sign = -1;
4367 break;
4368# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004369 }
4370 }
4371 else
4372 {
4373 /* unsigned */
4374 switch (length_modifier)
4375 {
4376 case '\0':
4377 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004378 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004379# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004380 tvs != NULL ? (unsigned)
4381 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004382# endif
4383 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004384 if (uint_arg != 0)
4385 arg_sign = 1;
4386 break;
4387 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004388 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004389# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004390 tvs != NULL ? (unsigned long)
4391 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004392# endif
4393 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004394 if (ulong_arg != 0)
4395 arg_sign = 1;
4396 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004397# ifdef FEAT_NUM64
4398 case 'L':
4399 ullong_arg =
4400# if defined(FEAT_EVAL)
4401 tvs != NULL ? (uvarnumber_T)
4402 tv_nr(tvs, &arg_idx) :
4403# endif
4404 va_arg(ap, uvarnumber_T);
4405 if (ullong_arg != 0)
4406 arg_sign = 1;
4407 break;
4408# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004409 }
4410 }
4411
4412 str_arg = tmp;
4413 str_arg_l = 0;
4414
4415 /* NOTE:
4416 * For d, i, u, o, x, and X conversions, if precision is
4417 * specified, the '0' flag should be ignored. This is so
4418 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4419 * FreeBSD, NetBSD; but not with Perl.
4420 */
4421 if (precision_specified)
4422 zero_padding = 0;
4423 if (fmt_spec == 'd')
4424 {
4425 if (force_sign && arg_sign >= 0)
4426 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4427 /* leave negative numbers for sprintf to handle, to
4428 * avoid handling tricky cases like (short int)-32768 */
4429 }
4430 else if (alternate_form)
4431 {
4432 if (arg_sign != 0
4433 && (fmt_spec == 'x' || fmt_spec == 'X') )
4434 {
4435 tmp[str_arg_l++] = '0';
4436 tmp[str_arg_l++] = fmt_spec;
4437 }
4438 /* alternate form should have no effect for p
4439 * conversion, but ... */
4440 }
4441
4442 zero_padding_insertion_ind = str_arg_l;
4443 if (!precision_specified)
4444 precision = 1; /* default precision is 1 */
4445 if (precision == 0 && arg_sign == 0)
4446 {
4447 /* When zero value is formatted with an explicit
4448 * precision 0, the resulting formatted string is
4449 * empty (d, i, u, o, x, X, p). */
4450 }
4451 else
4452 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004453 char f[6];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004454 int f_l = 0;
4455
4456 /* construct a simple format string for sprintf */
4457 f[f_l++] = '%';
4458 if (!length_modifier)
4459 ;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004460 else if (length_modifier == 'L')
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004461 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004462# ifdef FEAT_NUM64
4463# ifdef WIN3264
4464 f[f_l++] = 'I';
4465 f[f_l++] = '6';
4466 f[f_l++] = '4';
4467# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004468 f[f_l++] = 'l';
4469 f[f_l++] = 'l';
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004470# endif
4471# else
4472 f[f_l++] = 'l';
4473# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004474 }
4475 else
4476 f[f_l++] = length_modifier;
4477 f[f_l++] = fmt_spec;
4478 f[f_l++] = '\0';
4479
4480 if (fmt_spec == 'p')
4481 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4482 else if (fmt_spec == 'd')
4483 {
4484 /* signed */
4485 switch (length_modifier)
4486 {
4487 case '\0':
4488 case 'h': str_arg_l += sprintf(
4489 tmp + str_arg_l, f, int_arg);
4490 break;
4491 case 'l': str_arg_l += sprintf(
4492 tmp + str_arg_l, f, long_arg);
4493 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004494# ifdef FEAT_NUM64
4495 case 'L': str_arg_l += sprintf(
4496 tmp + str_arg_l, f, llong_arg);
4497 break;
4498# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004499 }
4500 }
4501 else
4502 {
4503 /* unsigned */
4504 switch (length_modifier)
4505 {
4506 case '\0':
4507 case 'h': str_arg_l += sprintf(
4508 tmp + str_arg_l, f, uint_arg);
4509 break;
4510 case 'l': str_arg_l += sprintf(
4511 tmp + str_arg_l, f, ulong_arg);
4512 break;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004513# ifdef FEAT_NUM64
4514 case 'L': str_arg_l += sprintf(
4515 tmp + str_arg_l, f, ullong_arg);
4516 break;
4517# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004518 }
4519 }
4520
4521 /* include the optional minus sign and possible
4522 * "0x" in the region before the zero padding
4523 * insertion point */
4524 if (zero_padding_insertion_ind < str_arg_l
4525 && tmp[zero_padding_insertion_ind] == '-')
4526 zero_padding_insertion_ind++;
4527 if (zero_padding_insertion_ind + 1 < str_arg_l
4528 && tmp[zero_padding_insertion_ind] == '0'
4529 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4530 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4531 zero_padding_insertion_ind += 2;
4532 }
4533
4534 {
4535 size_t num_of_digits = str_arg_l
4536 - zero_padding_insertion_ind;
4537
4538 if (alternate_form && fmt_spec == 'o'
4539 /* unless zero is already the first
4540 * character */
4541 && !(zero_padding_insertion_ind < str_arg_l
4542 && tmp[zero_padding_insertion_ind] == '0'))
4543 {
4544 /* assure leading zero for alternate-form
4545 * octal numbers */
4546 if (!precision_specified
4547 || precision < num_of_digits + 1)
4548 {
4549 /* precision is increased to force the
4550 * first character to be zero, except if a
4551 * zero value is formatted with an
4552 * explicit precision of zero */
4553 precision = num_of_digits + 1;
4554 precision_specified = 1;
4555 }
4556 }
4557 /* zero padding to specified precision? */
4558 if (num_of_digits < precision)
4559 number_of_zeros_to_pad = precision - num_of_digits;
4560 }
4561 /* zero padding to specified minimal field width? */
4562 if (!justify_left && zero_padding)
4563 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004564 int n = (int)(min_field_width - (str_arg_l
4565 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004566 if (n > 0)
4567 number_of_zeros_to_pad += n;
4568 }
4569 break;
4570 }
4571
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004572# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004573 case 'f':
4574 case 'e':
4575 case 'E':
4576 case 'g':
4577 case 'G':
4578 {
4579 /* Floating point. */
4580 double f;
4581 double abs_f;
4582 char format[40];
4583 int l;
4584 int remove_trailing_zeroes = FALSE;
4585
4586 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004587# if defined(FEAT_EVAL)
4588 tvs != NULL ? tv_float(tvs, &arg_idx) :
4589# endif
4590 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004591 abs_f = f < 0 ? -f : f;
4592
4593 if (fmt_spec == 'g' || fmt_spec == 'G')
4594 {
4595 /* Would be nice to use %g directly, but it prints
4596 * "1.0" as "1", we don't want that. */
4597 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4598 || abs_f == 0.0)
4599 fmt_spec = 'f';
4600 else
4601 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4602 remove_trailing_zeroes = TRUE;
4603 }
4604
Bram Moolenaarc9372132009-01-13 15:38:37 +00004605 if (fmt_spec == 'f' &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004606# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004607 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004608# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004609 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004610# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004611 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004612 {
4613 /* Avoid a buffer overflow */
4614 strcpy(tmp, "inf");
4615 str_arg_l = 3;
4616 }
4617 else
4618 {
4619 format[0] = '%';
4620 l = 1;
4621 if (precision_specified)
4622 {
4623 size_t max_prec = TMP_LEN - 10;
4624
4625 /* Make sure we don't get more digits than we
4626 * have room for. */
4627 if (fmt_spec == 'f' && abs_f > 1.0)
4628 max_prec -= (size_t)log10(abs_f);
4629 if (precision > max_prec)
4630 precision = max_prec;
4631 l += sprintf(format + 1, ".%d", (int)precision);
4632 }
4633 format[l] = fmt_spec;
4634 format[l + 1] = NUL;
4635 str_arg_l = sprintf(tmp, format, f);
4636
4637 if (remove_trailing_zeroes)
4638 {
4639 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004640 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004641
4642 /* Using %g or %G: remove superfluous zeroes. */
4643 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004644 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004645 else
4646 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004647 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004648 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004649 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004650 {
4651 /* Remove superfluous '+' and leading
4652 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004653 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004654 {
4655 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004656 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004657 --str_arg_l;
4658 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004659 i = (tp[1] == '-') ? 2 : 1;
4660 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004661 {
4662 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004663 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004664 --str_arg_l;
4665 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004666 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004667 }
4668 }
4669
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004670 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004671 /* Remove trailing zeroes, but keep the one
4672 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004673 while (tp > tmp + 2 && *tp == '0'
4674 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004675 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004676 STRMOVE(tp, tp + 1);
4677 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004678 --str_arg_l;
4679 }
4680 }
4681 else
4682 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004683 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004684
4685 /* Be consistent: some printf("%e") use 1.0e+12
4686 * and some 1.0e+012. Remove one zero in the last
4687 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004688 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004689 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004690 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4691 && tp[2] == '0'
4692 && vim_isdigit(tp[3])
4693 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004694 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004695 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004696 --str_arg_l;
4697 }
4698 }
4699 }
4700 str_arg = tmp;
4701 break;
4702 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004703# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004704
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004705 default:
4706 /* unrecognized conversion specifier, keep format string
4707 * as-is */
4708 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004709 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004710 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004711 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004712
4713 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004714 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004715 str_arg = p;
4716 str_arg_l = 0;
4717 if (*p != NUL)
4718 str_arg_l++; /* include invalid conversion specifier
4719 unchanged if not at end-of-string */
4720 break;
4721 }
4722
4723 if (*p != NUL)
4724 p++; /* step over the just processed conversion specifier */
4725
4726 /* insert padding to the left as requested by min_field_width;
4727 * this does not include the zero padding in case of numerical
4728 * conversions*/
4729 if (!justify_left)
4730 {
4731 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004732 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004733
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004734 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004735 {
4736 if (str_l < str_m)
4737 {
4738 size_t avail = str_m - str_l;
4739
4740 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004741 (size_t)pn > avail ? avail
4742 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004743 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004744 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004745 }
4746 }
4747
4748 /* zero padding as requested by the precision or by the minimal
4749 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004750 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004751 {
4752 /* will not copy first part of numeric right now, *
4753 * force it to be copied later in its entirety */
4754 zero_padding_insertion_ind = 0;
4755 }
4756 else
4757 {
4758 /* insert first part of numerics (sign or '0x') before zero
4759 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004760 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004761
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004762 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004763 {
4764 if (str_l < str_m)
4765 {
4766 size_t avail = str_m - str_l;
4767
4768 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004769 (size_t)zn > avail ? avail
4770 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004771 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004772 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004773 }
4774
4775 /* insert zero padding as requested by the precision or min
4776 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004777 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004778 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004779 {
4780 if (str_l < str_m)
4781 {
4782 size_t avail = str_m-str_l;
4783
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004784 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004785 (size_t)zn > avail ? avail
4786 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004787 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004788 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004789 }
4790 }
4791
4792 /* insert formatted string
4793 * (or as-is conversion specifier for unknown conversions) */
4794 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004795 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004796
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004797 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004798 {
4799 if (str_l < str_m)
4800 {
4801 size_t avail = str_m - str_l;
4802
4803 mch_memmove(str + str_l,
4804 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004805 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004806 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004807 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004808 }
4809 }
4810
4811 /* insert right padding */
4812 if (justify_left)
4813 {
4814 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004815 int pn = (int)(min_field_width
4816 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004817
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004818 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004819 {
4820 if (str_l < str_m)
4821 {
4822 size_t avail = str_m - str_l;
4823
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004824 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004825 (size_t)pn > avail ? avail
4826 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004827 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004828 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004829 }
4830 }
4831 }
4832 }
4833
4834 if (str_m > 0)
4835 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004836 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004837 * overwriting the last character (shouldn't happen, but just in case)
4838 * */
4839 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4840 }
4841
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004842 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004843 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004844
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004845 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004846 * character), that is, the number of characters that would have been
4847 * written to the buffer if it were large enough. */
4848 return (int)str_l;
4849}
4850
4851#endif /* PROTO */