blob: 689a79cd497d5a89a365814014eb50ec153b6fe9 [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 Moolenaar52ea13d2016-01-30 18:51:09 +0100769ex_messages(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770{
771 struct msg_hist *p;
772 char_u *s;
773
774 msg_hist_off = TRUE;
775
776 s = mch_getenv((char_u *)"LANG");
777 if (s != NULL && *s != NUL)
778 msg_attr((char_u *)
779 _("Messages maintainer: Bram Moolenaar <Bram@vim.org>"),
780 hl_attr(HLF_T));
781
Bram Moolenaar5c2e0f22007-09-13 20:05:18 +0000782 for (p = first_msg_hist; p != NULL && !got_int; p = p->next)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 if (p->msg != NULL)
784 msg_attr(p->msg, p->attr);
785
786 msg_hist_off = FALSE;
787}
788
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000789#if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790/*
791 * Call this after prompting the user. This will avoid a hit-return message
792 * and a delay.
793 */
Bram Moolenaar7171abe2004-10-11 10:06:20 +0000794 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100795msg_end_prompt(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796{
797 need_wait_return = FALSE;
798 emsg_on_display = FALSE;
799 cmdline_row = msg_row;
800 msg_col = 0;
801 msg_clr_eos();
Bram Moolenaar5d6f75e2011-12-30 14:14:29 +0100802 lines_left = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803}
804#endif
805
806/*
807 * wait for the user to hit a key (normally a return)
808 * if 'redraw' is TRUE, clear and redraw the screen
809 * if 'redraw' is FALSE, just redraw the screen
810 * if 'redraw' is -1, don't redraw at all
811 */
812 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +0100813wait_return(int redraw)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814{
815 int c;
816 int oldState;
817 int tmpState;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 int had_got_int;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100819 int save_Recording;
820 FILE *save_scriptout;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821
822 if (redraw == TRUE)
823 must_redraw = CLEAR;
824
825 /* If using ":silent cmd", don't wait for a return. Also don't set
826 * need_wait_return to do it later. */
827 if (msg_silent != 0)
828 return;
829
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100830 /*
831 * When inside vgetc(), we can't wait for a typed character at all.
832 * With the global command (and some others) we only need one return at
833 * the end. Adjust cmdline_row to avoid the next message overwriting the
834 * last one.
835 */
Bram Moolenaar5555acc2006-04-07 21:33:12 +0000836 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 return;
Bram Moolenaarfd30cd42011-03-22 13:07:26 +0100838 need_wait_return = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 if (no_wait_return)
840 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 if (!exmode_active)
842 cmdline_row = msg_row;
843 return;
844 }
845
846 redir_off = TRUE; /* don't redirect this message */
847 oldState = State;
848 if (quit_more)
849 {
850 c = CAR; /* just pretend CR was hit */
851 quit_more = FALSE;
852 got_int = FALSE;
853 }
854 else if (exmode_active)
855 {
856 MSG_PUTS(" "); /* make sure the cursor is on the right line */
857 c = CAR; /* no need for a return in ex mode */
858 got_int = FALSE;
859 }
860 else
861 {
862 /* Make sure the hit-return prompt is on screen when 'guioptions' was
863 * just changed. */
864 screenalloc(FALSE);
865
866 State = HITRETURN;
867#ifdef FEAT_MOUSE
868 setmouse();
869#endif
870#ifdef USE_ON_FLY_SCROLL
871 dont_scroll = TRUE; /* disallow scrolling here */
872#endif
Bram Moolenaarec38d692013-04-24 15:12:32 +0200873 /* Avoid the sequence that the user types ":" at the hit-return prompt
874 * to start an Ex command, but the file-changed dialog gets in the
875 * way. */
876 if (need_check_timestamps)
877 check_timestamps(FALSE);
878
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 hit_return_msg();
880
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 do
882 {
883 /* Remember "got_int", if it is set vgetc() probably returns a
884 * CTRL-C, but we need to loop then. */
885 had_got_int = got_int;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000886
887 /* Don't do mappings here, we put the character back in the
888 * typeahead buffer. */
889 ++no_mapping;
890 ++allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100891
892 /* Temporarily disable Recording. If Recording is active, the
893 * character will be recorded later, since it will be added to the
894 * typebuf after the loop */
895 save_Recording = Recording;
896 save_scriptout = scriptout;
897 Recording = FALSE;
898 scriptout = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 c = safe_vgetc();
Bram Moolenaar4317d9b2005-03-18 20:25:31 +0000900 if (had_got_int && !global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 got_int = FALSE;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000902 --no_mapping;
903 --allow_keys;
Bram Moolenaar332a2ca2013-11-04 02:01:01 +0100904 Recording = save_Recording;
905 scriptout = save_scriptout;
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000906
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907#ifdef FEAT_CLIPBOARD
908 /* Strange way to allow copying (yanking) a modeless selection at
909 * the hit-enter prompt. Use CTRL-Y, because the same is used in
910 * Cmdline-mode and it's harmless when there is no selection. */
911 if (c == Ctrl_Y && clip_star.state == SELECT_DONE)
912 {
913 clip_copy_modeless_selection(TRUE);
914 c = K_IGNORE;
915 }
916#endif
Bram Moolenaarc27c8d52007-09-06 10:54:51 +0000917
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000918 /*
919 * Allow scrolling back in the messages.
920 * Also accept scroll-down commands when messages fill the screen,
921 * to avoid that typing one 'j' too many makes the messages
922 * disappear.
923 */
924 if (p_more && !p_cp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000925 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100926 if (c == 'b' || c == 'k' || c == 'u' || c == 'g'
927 || c == K_UP || c == K_PAGEUP)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000928 {
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100929 if (msg_scrolled > Rows)
930 /* scroll back to show older messages */
931 do_more_prompt(c);
932 else
933 {
934 msg_didout = FALSE;
935 c = K_IGNORE;
936 msg_col =
937#ifdef FEAT_RIGHTLEFT
938 cmdmsg_rl ? Columns - 1 :
939#endif
940 0;
941 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000942 if (quit_more)
943 {
944 c = CAR; /* just pretend CR was hit */
945 quit_more = FALSE;
946 got_int = FALSE;
947 }
Bram Moolenaarb0912962013-08-09 20:38:26 +0200948 else if (c != K_IGNORE)
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000949 {
950 c = K_IGNORE;
951 hit_return_msg();
952 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000953 }
Bram Moolenaare1438bb2006-03-01 22:01:55 +0000954 else if (msg_scrolled > Rows - 2
Bram Moolenaarb59494c2013-03-19 13:56:08 +0100955 && (c == 'j' || c == 'd' || c == 'f'
956 || c == K_DOWN || c == K_PAGEDOWN))
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000957 c = K_IGNORE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000958 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 } while ((had_got_int && c == Ctrl_C)
960 || c == K_IGNORE
961#ifdef FEAT_GUI
962 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR
963#endif
964#ifdef FEAT_MOUSE
965 || c == K_LEFTDRAG || c == K_LEFTRELEASE
966 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE
967 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +0200968 || c == K_MOUSELEFT || c == K_MOUSERIGHT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 || c == K_MOUSEDOWN || c == K_MOUSEUP
970 || (!mouse_has(MOUSE_RETURN)
971 && mouse_row < msg_row
972 && (c == K_LEFTMOUSE
973 || c == K_MIDDLEMOUSE
974 || c == K_RIGHTMOUSE
975 || c == K_X1MOUSE
976 || c == K_X2MOUSE))
977#endif
978 );
979 ui_breakcheck();
980#ifdef FEAT_MOUSE
981 /*
982 * Avoid that the mouse-up event causes visual mode to start.
983 */
984 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE
985 || c == K_X1MOUSE || c == K_X2MOUSE)
986 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0);
987 else
988#endif
989 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C)
990 {
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000991 /* Put the character back in the typeahead buffer. Don't use the
992 * stuff buffer, because lmaps wouldn't work. */
Bram Moolenaard8fc5c02006-04-29 21:55:22 +0000993 ins_char_typebuf(c);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 do_redraw = TRUE; /* need a redraw even though there is
Bram Moolenaarf95dc3b2005-05-22 22:02:25 +0000995 typeahead */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 }
998 redir_off = FALSE;
999
1000 /*
1001 * If the user hits ':', '?' or '/' we get a command line from the next
1002 * line.
1003 */
1004 if (c == ':' || c == '?' || c == '/')
1005 {
1006 if (!exmode_active)
1007 cmdline_row = msg_row;
1008 skip_redraw = TRUE; /* skip redraw once */
1009 do_redraw = FALSE;
1010 }
1011
1012 /*
1013 * If the window size changed set_shellsize() will redraw the screen.
1014 * Otherwise the screen is only redrawn if 'redraw' is set and no ':'
1015 * typed.
1016 */
1017 tmpState = State;
1018 State = oldState; /* restore State before set_shellsize */
1019#ifdef FEAT_MOUSE
1020 setmouse();
1021#endif
1022 msg_check();
1023
1024#if defined(UNIX) || defined(VMS)
1025 /*
1026 * When switching screens, we need to output an extra newline on exit.
1027 */
1028 if (swapping_screen() && !termcap_active)
1029 newline_on_exit = TRUE;
1030#endif
1031
1032 need_wait_return = FALSE;
1033 did_wait_return = TRUE;
1034 emsg_on_display = FALSE; /* can delete error message now */
1035 lines_left = -1; /* reset lines_left at next msg_start() */
1036 reset_last_sourcing();
1037 if (keep_msg != NULL && vim_strsize(keep_msg) >=
1038 (Rows - cmdline_row - 1) * Columns + sc_col)
1039 {
1040 vim_free(keep_msg);
1041 keep_msg = NULL; /* don't redisplay message, it's too long */
1042 }
1043
1044 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */
1045 {
1046 starttermcap(); /* start termcap before redrawing */
1047 shell_resized();
1048 }
1049 else if (!skip_redraw
1050 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1)))
1051 {
1052 starttermcap(); /* start termcap before redrawing */
1053 redraw_later(VALID);
1054 }
1055}
1056
1057/*
1058 * Write the hit-return prompt.
1059 */
1060 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001061hit_return_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001063 int save_p_more = p_more;
1064
1065 p_more = FALSE; /* don't want see this message when scrolling back */
1066 if (msg_didout) /* start on a new line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 msg_putchar('\n');
1068 if (got_int)
1069 MSG_PUTS(_("Interrupt: "));
1070
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001071 MSG_PUTS_ATTR(_("Press ENTER or type command to continue"), hl_attr(HLF_R));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 if (!msg_use_printf())
1073 msg_clr_eos();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001074 p_more = save_p_more;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075}
1076
1077/*
1078 * Set "keep_msg" to "s". Free the old value and check for NULL pointer.
1079 */
1080 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001081set_keep_msg(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082{
1083 vim_free(keep_msg);
1084 if (s != NULL && msg_silent == 0)
1085 keep_msg = vim_strsave(s);
1086 else
1087 keep_msg = NULL;
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001088 keep_msg_more = FALSE;
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001089 keep_msg_attr = attr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090}
1091
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001092#if defined(FEAT_TERMRESPONSE) || defined(PROTO)
1093/*
1094 * If there currently is a message being displayed, set "keep_msg" to it, so
1095 * that it will be displayed again after redraw.
1096 */
1097 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001098set_keep_msg_from_hist(void)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00001099{
1100 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0
1101 && (State & NORMAL))
1102 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr);
1103}
1104#endif
1105
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106/*
1107 * Prepare for outputting characters in the command line.
1108 */
1109 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001110msg_start(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111{
1112 int did_return = FALSE;
1113
Bram Moolenaare4ce65d2010-08-04 20:12:32 +02001114 if (!msg_silent)
1115 {
1116 vim_free(keep_msg);
1117 keep_msg = NULL; /* don't display old message now */
1118 }
Bram Moolenaara7241f52008-06-24 20:39:31 +00001119
1120#ifdef FEAT_EVAL
1121 if (need_clr_eos)
1122 {
1123 /* Halfway an ":echo" command and getting an (error) message: clear
1124 * any text from the command. */
1125 need_clr_eos = FALSE;
1126 msg_clr_eos();
1127 }
1128#endif
1129
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130 if (!msg_scroll && full_screen) /* overwrite last message */
1131 {
1132 msg_row = cmdline_row;
1133 msg_col =
1134#ifdef FEAT_RIGHTLEFT
1135 cmdmsg_rl ? Columns - 1 :
1136#endif
1137 0;
1138 }
1139 else if (msg_didout) /* start message on next line */
1140 {
1141 msg_putchar('\n');
1142 did_return = TRUE;
1143 if (exmode_active != EXMODE_NORMAL)
1144 cmdline_row = msg_row;
1145 }
1146 if (!msg_didany || lines_left < 0)
1147 msg_starthere();
1148 if (msg_silent == 0)
1149 {
1150 msg_didout = FALSE; /* no output on current line yet */
1151 cursor_off();
1152 }
1153
1154 /* when redirecting, may need to start a new line. */
1155 if (!did_return)
1156 redir_write((char_u *)"\n", -1);
1157}
1158
1159/*
1160 * Note that the current msg position is where messages start.
1161 */
1162 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001163msg_starthere(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164{
1165 lines_left = cmdline_row;
1166 msg_didany = FALSE;
1167}
1168
1169 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001170msg_putchar(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171{
1172 msg_putchar_attr(c, 0);
1173}
1174
1175 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001176msg_putchar_attr(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177{
1178#ifdef FEAT_MBYTE
1179 char_u buf[MB_MAXBYTES + 1];
1180#else
1181 char_u buf[4];
1182#endif
1183
1184 if (IS_SPECIAL(c))
1185 {
1186 buf[0] = K_SPECIAL;
1187 buf[1] = K_SECOND(c);
1188 buf[2] = K_THIRD(c);
1189 buf[3] = NUL;
1190 }
1191 else
1192 {
1193#ifdef FEAT_MBYTE
1194 buf[(*mb_char2bytes)(c, buf)] = NUL;
1195#else
1196 buf[0] = c;
1197 buf[1] = NUL;
1198#endif
1199 }
1200 msg_puts_attr(buf, attr);
1201}
1202
1203 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001204msg_outnum(long n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205{
1206 char_u buf[20];
1207
1208 sprintf((char *)buf, "%ld", n);
1209 msg_puts(buf);
1210}
1211
1212 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001213msg_home_replace(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214{
1215 msg_home_replace_attr(fname, 0);
1216}
1217
1218#if defined(FEAT_FIND_ID) || defined(PROTO)
1219 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001220msg_home_replace_hl(char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221{
1222 msg_home_replace_attr(fname, hl_attr(HLF_D));
1223}
1224#endif
1225
1226 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001227msg_home_replace_attr(char_u *fname, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228{
1229 char_u *name;
1230
1231 name = home_replace_save(NULL, fname);
1232 if (name != NULL)
1233 msg_outtrans_attr(name, attr);
1234 vim_free(name);
1235}
1236
1237/*
1238 * Output 'len' characters in 'str' (including NULs) with translation
1239 * if 'len' is -1, output upto a NUL character.
1240 * Use attributes 'attr'.
1241 * Return the number of characters it takes on the screen.
1242 */
1243 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001244msg_outtrans(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245{
1246 return msg_outtrans_attr(str, 0);
1247}
1248
1249 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001250msg_outtrans_attr(char_u *str, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251{
1252 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr);
1253}
1254
1255 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001256msg_outtrans_len(char_u *str, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257{
1258 return msg_outtrans_len_attr(str, len, 0);
1259}
1260
1261/*
1262 * Output one character at "p". Return pointer to the next character.
1263 * Handles multi-byte characters.
1264 */
1265 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001266msg_outtrans_one(char_u *p, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267{
1268#ifdef FEAT_MBYTE
1269 int l;
1270
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001271 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 {
1273 msg_outtrans_len_attr(p, l, attr);
1274 return p + l;
1275 }
1276#endif
1277 msg_puts_attr(transchar_byte(*p), attr);
1278 return p + 1;
1279}
1280
1281 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001282msg_outtrans_len_attr(char_u *msgstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283{
1284 int retval = 0;
1285 char_u *str = msgstr;
1286 char_u *plain_start = msgstr;
1287 char_u *s;
1288#ifdef FEAT_MBYTE
1289 int mb_l;
1290 int c;
1291#endif
1292
1293 /* if MSG_HIST flag set, add message to history */
1294 if (attr & MSG_HIST)
1295 {
1296 add_msg_hist(str, len, attr);
1297 attr &= ~MSG_HIST;
1298 }
1299
1300#ifdef FEAT_MBYTE
1301 /* If the string starts with a composing character first draw a space on
1302 * which the composing char can be drawn. */
1303 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr)))
1304 msg_puts_attr((char_u *)" ", attr);
1305#endif
1306
1307 /*
1308 * Go over the string. Special characters are translated and printed.
1309 * Normal characters are printed several at a time.
1310 */
1311 while (--len >= 0)
1312 {
1313#ifdef FEAT_MBYTE
1314 if (enc_utf8)
1315 /* Don't include composing chars after the end. */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001316 mb_l = utfc_ptr2len_len(str, len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001318 mb_l = (*mb_ptr2len)(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 else
1320 mb_l = 1;
1321 if (has_mbyte && mb_l > 1)
1322 {
1323 c = (*mb_ptr2char)(str);
1324 if (vim_isprintc(c))
1325 /* printable multi-byte char: count the cells. */
1326 retval += (*mb_ptr2cells)(str);
1327 else
1328 {
1329 /* unprintable multi-byte char: print the printable chars so
1330 * far and the translation of the unprintable char. */
1331 if (str > plain_start)
1332 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1333 attr);
1334 plain_start = str + mb_l;
1335 msg_puts_attr(transchar(c), attr == 0 ? hl_attr(HLF_8) : attr);
1336 retval += char2cells(c);
1337 }
1338 len -= mb_l - 1;
1339 str += mb_l;
1340 }
1341 else
1342#endif
1343 {
1344 s = transchar_byte(*str);
1345 if (s[1] != NUL)
1346 {
1347 /* unprintable char: print the printable chars so far and the
1348 * translation of the unprintable char. */
1349 if (str > plain_start)
1350 msg_puts_attr_len(plain_start, (int)(str - plain_start),
1351 attr);
1352 plain_start = str + 1;
1353 msg_puts_attr(s, attr == 0 ? hl_attr(HLF_8) : attr);
Bram Moolenaarc236c162008-07-13 17:41:49 +00001354 retval += (int)STRLEN(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 }
Bram Moolenaarb3c722a2008-07-06 17:16:02 +00001356 else
1357 ++retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 ++str;
1359 }
1360 }
1361
1362 if (str > plain_start)
1363 /* print the printable chars at the end */
1364 msg_puts_attr_len(plain_start, (int)(str - plain_start), attr);
1365
1366 return retval;
1367}
1368
1369#if defined(FEAT_QUICKFIX) || defined(PROTO)
1370 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001371msg_make(char_u *arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372{
1373 int i;
1374 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB";
1375
1376 arg = skipwhite(arg);
1377 for (i = 5; *arg && i >= 0; --i)
1378 if (*arg++ != str[i])
1379 break;
1380 if (i < 0)
1381 {
1382 msg_putchar('\n');
1383 for (i = 0; rs[i]; ++i)
1384 msg_putchar(rs[i] - 3);
1385 }
1386}
1387#endif
1388
1389/*
1390 * Output the string 'str' upto a NUL character.
1391 * Return the number of characters it takes on the screen.
1392 *
1393 * If K_SPECIAL is encountered, then it is taken in conjunction with the
1394 * following character and shown as <F1>, <S-Up> etc. Any other character
1395 * which is not printable shown in <> form.
1396 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>.
1397 * If a character is displayed in one of these special ways, is also
1398 * highlighted (its highlight name is '8' in the p_hl variable).
1399 * Otherwise characters are not highlighted.
1400 * This function is used to show mappings, where we want to see how to type
1401 * the character/string -- webb
1402 */
1403 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001404msg_outtrans_special(
1405 char_u *strstart,
1406 int from) /* TRUE for lhs of a mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407{
1408 char_u *str = strstart;
1409 int retval = 0;
1410 char_u *string;
1411 int attr;
1412 int len;
1413
1414 attr = hl_attr(HLF_8);
1415 while (*str != NUL)
1416 {
1417 /* Leading and trailing spaces need to be displayed in <> form. */
1418 if ((str == strstart || str[1] == NUL) && *str == ' ')
1419 {
1420 string = (char_u *)"<Space>";
1421 ++str;
1422 }
1423 else
1424 string = str2special(&str, from);
1425 len = vim_strsize(string);
1426 /* Highlight special keys */
1427 msg_puts_attr(string, len > 1
1428#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001429 && (*mb_ptr2len)(string) <= 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430#endif
1431 ? attr : 0);
1432 retval += len;
1433 }
1434 return retval;
1435}
1436
Bram Moolenaarbd743252010-10-20 21:23:33 +02001437#if defined(FEAT_EVAL) || defined(PROTO)
1438/*
1439 * Return the lhs or rhs of a mapping, with the key codes turned into printable
1440 * strings, in an allocated string.
1441 */
1442 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001443str2special_save(
1444 char_u *str,
1445 int is_lhs) /* TRUE for lhs, FALSE for rhs */
Bram Moolenaarbd743252010-10-20 21:23:33 +02001446{
1447 garray_T ga;
1448 char_u *p = str;
1449
1450 ga_init2(&ga, 1, 40);
1451 while (*p != NUL)
1452 ga_concat(&ga, str2special(&p, is_lhs));
1453 ga_append(&ga, NUL);
1454 return (char_u *)ga.ga_data;
1455}
1456#endif
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458/*
1459 * Return the printable string for the key codes at "*sp".
1460 * Used for translating the lhs or rhs of a mapping to printable chars.
1461 * Advances "sp" to the next code.
1462 */
1463 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001464str2special(
1465 char_u **sp,
1466 int from) /* TRUE for lhs of mapping */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467{
1468 int c;
1469 static char_u buf[7];
1470 char_u *str = *sp;
1471 int modifiers = 0;
1472 int special = FALSE;
1473
1474#ifdef FEAT_MBYTE
1475 if (has_mbyte)
1476 {
1477 char_u *p;
1478
1479 /* Try to un-escape a multi-byte character. Return the un-escaped
1480 * string if it is a multi-byte character. */
1481 p = mb_unescape(sp);
1482 if (p != NULL)
1483 return p;
1484 }
1485#endif
1486
1487 c = *str;
1488 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1489 {
1490 if (str[1] == KS_MODIFIER)
1491 {
1492 modifiers = str[2];
1493 str += 3;
1494 c = *str;
1495 }
1496 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL)
1497 {
1498 c = TO_SPECIAL(str[1], str[2]);
1499 str += 2;
Bram Moolenaar37985192013-06-07 19:53:10 +02001500 if (c == KS_ZERO) /* display <Nul> as ^@ or <Nul> */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 c = NUL;
1502 }
1503 if (IS_SPECIAL(c) || modifiers) /* special key */
1504 special = TRUE;
1505 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
1507#ifdef FEAT_MBYTE
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001508 if (has_mbyte && !IS_SPECIAL(c))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 {
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001510 int len = (*mb_ptr2len)(str);
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001511
1512 /* For multi-byte characters check for an illegal byte. */
1513 if (has_mbyte && MB_BYTE2LEN(*str) > len)
1514 {
1515 transchar_nonprint(buf, c);
1516 *sp = str + 1;
1517 return buf;
1518 }
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02001519 /* Since 'special' is TRUE the multi-byte character 'c' will be
1520 * processed by get_special_key_name() */
1521 c = (*mb_ptr2char)(str);
1522 *sp = str + len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523 }
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001524 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525#endif
Bram Moolenaarb8bf5412011-08-17 20:33:22 +02001526 *sp = str + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527
1528 /* Make unprintable characters in <> form, also <M-Space> and <Tab>.
1529 * Use <Space> only for lhs of a mapping. */
1530 if (special || char2cells(c) > 1 || (from && c == ' '))
1531 return get_special_key_name(c, modifiers);
1532 buf[0] = c;
1533 buf[1] = NUL;
1534 return buf;
1535}
1536
1537/*
1538 * Translate a key sequence into special key names.
1539 */
1540 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001541str2specialbuf(char_u *sp, char_u *buf, int len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542{
1543 char_u *s;
1544
1545 *buf = NUL;
1546 while (*sp)
1547 {
1548 s = str2special(&sp, FALSE);
1549 if ((int)(STRLEN(s) + STRLEN(buf)) < len)
1550 STRCAT(buf, s);
1551 }
1552}
1553
1554/*
1555 * print line for :print or :list command
1556 */
1557 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001558msg_prt_line(char_u *s, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559{
1560 int c;
1561 int col = 0;
1562 int n_extra = 0;
1563 int c_extra = 0;
1564 char_u *p_extra = NULL; /* init to make SASC shut up */
1565 int n;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001566 int attr = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 char_u *trail = NULL;
1568#ifdef FEAT_MBYTE
1569 int l;
1570 char_u buf[MB_MAXBYTES + 1];
1571#endif
1572
Bram Moolenaardf177f62005-02-22 08:39:57 +00001573 if (curwin->w_p_list)
1574 list = TRUE;
1575
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 /* find start of trailing whitespace */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001577 if (list && lcs_trail)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 {
1579 trail = s + STRLEN(s);
1580 while (trail > s && vim_iswhite(trail[-1]))
1581 --trail;
1582 }
1583
1584 /* output a space for an empty line, otherwise the line will be
1585 * overwritten */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001586 if (*s == NUL && !(list && lcs_eol != NUL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 msg_putchar(' ');
1588
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001589 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 {
Bram Moolenaar56da7972007-01-16 14:46:32 +00001591 if (n_extra > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 {
1593 --n_extra;
1594 if (c_extra)
1595 c = c_extra;
1596 else
1597 c = *p_extra++;
1598 }
1599#ifdef FEAT_MBYTE
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001600 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 {
1602 col += (*mb_ptr2cells)(s);
Bram Moolenaar73284b92015-05-04 17:28:22 +02001603 if (lcs_nbsp != NUL && list
1604 && (mb_ptr2char(s) == 160
1605 || mb_ptr2char(s) == 0x202f))
Bram Moolenaaracf17282011-02-01 17:12:25 +01001606 {
1607 mb_char2bytes(lcs_nbsp, buf);
1608 buf[(*mb_ptr2len)(buf)] = NUL;
1609 }
1610 else
1611 {
1612 mch_memmove(buf, s, (size_t)l);
1613 buf[l] = NUL;
1614 }
Bram Moolenaar56da7972007-01-16 14:46:32 +00001615 msg_puts(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 s += l;
1617 continue;
1618 }
1619#endif
1620 else
1621 {
1622 attr = 0;
1623 c = *s++;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001624 if (c == TAB && (!list || lcs_tab1))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 {
1626 /* tab amount depends on current column */
1627 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1;
Bram Moolenaardf177f62005-02-22 08:39:57 +00001628 if (!list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 {
1630 c = ' ';
1631 c_extra = ' ';
1632 }
1633 else
1634 {
1635 c = lcs_tab1;
1636 c_extra = lcs_tab2;
1637 attr = hl_attr(HLF_8);
1638 }
1639 }
Bram Moolenaaracf17282011-02-01 17:12:25 +01001640 else if (c == 160 && list && lcs_nbsp != NUL)
1641 {
1642 c = lcs_nbsp;
1643 attr = hl_attr(HLF_8);
1644 }
Bram Moolenaardf177f62005-02-22 08:39:57 +00001645 else if (c == NUL && list && lcs_eol != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 {
1647 p_extra = (char_u *)"";
1648 c_extra = NUL;
1649 n_extra = 1;
1650 c = lcs_eol;
1651 attr = hl_attr(HLF_AT);
1652 --s;
1653 }
1654 else if (c != NUL && (n = byte2cells(c)) > 1)
1655 {
1656 n_extra = n - 1;
1657 p_extra = transchar_byte(c);
1658 c_extra = NUL;
1659 c = *p_extra++;
Bram Moolenaar56da7972007-01-16 14:46:32 +00001660 /* Use special coloring to be able to distinguish <hex> from
1661 * the same in plain text. */
1662 attr = hl_attr(HLF_8);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 }
1664 else if (c == ' ' && trail != NULL && s > trail)
1665 {
1666 c = lcs_trail;
1667 attr = hl_attr(HLF_8);
1668 }
Bram Moolenaar1510f992015-04-22 22:18:22 +02001669 else if (c == ' ' && list && lcs_space != NUL)
1670 {
1671 c = lcs_space;
1672 attr = hl_attr(HLF_8);
1673 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 }
1675
1676 if (c == NUL)
1677 break;
1678
1679 msg_putchar_attr(c, attr);
1680 col++;
1681 }
1682 msg_clr_eos();
1683}
1684
1685#ifdef FEAT_MBYTE
1686/*
1687 * Use screen_puts() to output one multi-byte character.
1688 * Return the pointer "s" advanced to the next character.
1689 */
1690 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001691screen_puts_mbyte(char_u *s, int l, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692{
1693 int cw;
1694
1695 msg_didout = TRUE; /* remember that line is not empty */
1696 cw = (*mb_ptr2cells)(s);
1697 if (cw > 1 && (
1698#ifdef FEAT_RIGHTLEFT
1699 cmdmsg_rl ? msg_col <= 1 :
1700#endif
1701 msg_col == Columns - 1))
1702 {
1703 /* Doesn't fit, print a highlighted '>' to fill it up. */
1704 msg_screen_putchar('>', hl_attr(HLF_AT));
1705 return s;
1706 }
1707
1708 screen_puts_len(s, l, msg_row, msg_col, attr);
1709#ifdef FEAT_RIGHTLEFT
1710 if (cmdmsg_rl)
1711 {
1712 msg_col -= cw;
1713 if (msg_col == 0)
1714 {
1715 msg_col = Columns;
1716 ++msg_row;
1717 }
1718 }
1719 else
1720#endif
1721 {
1722 msg_col += cw;
1723 if (msg_col >= Columns)
1724 {
1725 msg_col = 0;
1726 ++msg_row;
1727 }
1728 }
1729 return s + l;
1730}
1731#endif
1732
1733/*
1734 * Output a string to the screen at position msg_row, msg_col.
1735 * Update msg_row and msg_col for the next message.
1736 */
1737 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001738msg_puts(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739{
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001740 msg_puts_attr(s, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741}
1742
1743 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001744msg_puts_title(
1745 char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746{
1747 msg_puts_attr(s, hl_attr(HLF_T));
1748}
1749
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750/*
1751 * Show a message in such a way that it always fits in the line. Cut out a
1752 * part in the middle and replace it with "..." when necessary.
1753 * Does not handle multi-byte characters!
1754 */
1755 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001756msg_puts_long_attr(char_u *longstr, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757{
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001758 msg_puts_long_len_attr(longstr, (int)STRLEN(longstr), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759}
1760
1761 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001762msg_puts_long_len_attr(char_u *longstr, int len, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763{
1764 int slen = len;
1765 int room;
1766
1767 room = Columns - msg_col;
1768 if (len > room && room >= 20)
1769 {
1770 slen = (room - 3) / 2;
1771 msg_outtrans_len_attr(longstr, slen, attr);
1772 msg_puts_attr((char_u *)"...", hl_attr(HLF_8));
1773 }
1774 msg_outtrans_len_attr(longstr + len - slen, slen, attr);
1775}
1776
1777/*
1778 * Basic function for writing a message with highlight attributes.
1779 */
1780 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001781msg_puts_attr(char_u *s, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782{
1783 msg_puts_attr_len(s, -1, attr);
1784}
1785
1786/*
1787 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes).
1788 * When "maxlen" is -1 there is no maximum length.
1789 * When "maxlen" is >= 0 the message is not put in the history.
1790 */
1791 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001792msg_puts_attr_len(char_u *str, int maxlen, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 /*
1795 * If redirection is on, also write to the redirection file.
1796 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001797 redir_write(str, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798
1799 /*
1800 * Don't print anything when using ":silent cmd".
1801 */
1802 if (msg_silent != 0)
1803 return;
1804
1805 /* if MSG_HIST flag set, add message to history */
1806 if ((attr & MSG_HIST) && maxlen < 0)
1807 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001808 add_msg_hist(str, -1, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 attr &= ~MSG_HIST;
1810 }
1811
1812 /*
1813 * When writing something to the screen after it has scrolled, requires a
1814 * wait-return prompt later. Needed when scrolling, resetting
1815 * need_wait_return after some prompt, and then outputting something
1816 * without scrolling
1817 */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001818 if (msg_scrolled != 0 && !msg_scrolled_ign)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 need_wait_return = TRUE;
1820 msg_didany = TRUE; /* remember that something was outputted */
1821
1822 /*
1823 * If there is no valid screen, use fprintf so we can see error messages.
1824 * If termcap is not active, we may be writing in an alternate console
1825 * window, cursor positioning may not work correctly (window size may be
1826 * different, e.g. for Win32 console) or we just don't know where the
1827 * cursor is.
1828 */
1829 if (msg_use_printf())
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001830 msg_puts_printf(str, maxlen);
1831 else
1832 msg_puts_display(str, maxlen, attr, FALSE);
1833}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001835/*
1836 * The display part of msg_puts_attr_len().
1837 * May be called recursively to display scroll-back text.
1838 */
1839 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01001840msg_puts_display(
1841 char_u *str,
1842 int maxlen,
1843 int attr,
1844 int recurse)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001845{
1846 char_u *s = str;
1847 char_u *t_s = str; /* string from "t_s" to "s" is still todo */
1848 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */
1849#ifdef FEAT_MBYTE
1850 int l;
1851 int cw;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001853 char_u *sb_str = str;
1854 int sb_col = msg_col;
1855 int wrap;
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001856 int did_last_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857
1858 did_wait_return = FALSE;
Bram Moolenaar57b7fe82007-08-05 17:20:43 +00001859 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 {
1861 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001862 * We are at the end of the screen line when:
1863 * - When outputting a newline.
1864 * - When outputting a character in the last column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001866 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || (
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867#ifdef FEAT_RIGHTLEFT
1868 cmdmsg_rl
1869 ? (
1870 msg_col <= 1
1871 || (*s == TAB && msg_col <= 7)
1872# ifdef FEAT_MBYTE
1873 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)
1874# endif
1875 )
1876 :
1877#endif
1878 (msg_col + t_col >= Columns - 1
1879 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7))
1880# ifdef FEAT_MBYTE
1881 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1882 && msg_col + t_col >= Columns - 2)
1883# endif
1884 ))))
1885 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001886 /*
1887 * The screen is scrolled up when at the last row (some terminals
1888 * scroll automatically, some don't. To avoid problems we scroll
1889 * ourselves).
1890 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 if (t_col > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 /* output postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001893 t_puts(&t_col, t_s, s, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001895 /* When no more prompt and no more room, truncate here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 if (msg_no_more && lines_left == 0)
1897 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001899 /* Scroll the screen up one line. */
1900 msg_scroll_up();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901
1902 msg_row = Rows - 2;
1903 if (msg_col >= Columns) /* can happen after screen resize */
1904 msg_col = Columns - 1;
1905
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001906 /* Display char in last column before showing more-prompt. */
1907 if (*s >= ' '
1908#ifdef FEAT_RIGHTLEFT
1909 && !cmdmsg_rl
1910#endif
1911 )
1912 {
1913#ifdef FEAT_MBYTE
1914 if (has_mbyte)
1915 {
1916 if (enc_utf8 && maxlen >= 0)
1917 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001918 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001919 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001920 l = (*mb_ptr2len)(s);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001921 s = screen_puts_mbyte(s, l, attr);
1922 }
1923 else
1924#endif
1925 msg_screen_putchar(*s++, attr);
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001926 did_last_char = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001927 }
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001928 else
1929 did_last_char = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001930
1931 if (p_more)
1932 /* store text for scrolling back */
1933 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
1934
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001935 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001936 need_wait_return = TRUE; /* may need wait_return in main() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 if (must_redraw < VALID)
1938 must_redraw = VALID;
1939 redraw_cmdline = TRUE;
1940 if (cmdline_row > 0 && !exmode_active)
1941 --cmdline_row;
1942
1943 /*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001944 * If screen is completely filled and 'more' is set then wait
1945 * for a character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 */
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00001947 if (lines_left > 0)
1948 --lines_left;
Bram Moolenaar203335e2006-09-03 14:35:42 +00001949 if (p_more && lines_left == 0 && State != HITRETURN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 && !msg_no_more && !exmode_active)
1951 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952#ifdef FEAT_CON_DIALOG
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001953 if (do_more_prompt(NUL))
1954 s = confirm_msg_tail;
1955#else
1956 (void)do_more_prompt(NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957#endif
1958 if (quit_more)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001959 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 }
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001961
1962 /* When we displayed a char in last column need to check if there
1963 * is still more. */
Bram Moolenaarc27c8d52007-09-06 10:54:51 +00001964 if (did_last_char)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001965 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 }
1967
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001968 wrap = *s == '\n'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969 || msg_col + t_col >= Columns
1970#ifdef FEAT_MBYTE
1971 || (has_mbyte && (*mb_ptr2cells)(s) > 1
1972 && msg_col + t_col >= Columns - 1)
1973#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001974 ;
1975 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b'
1976 || *s == '\t' || *s == BELL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 /* output any postponed text */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001978 t_puts(&t_col, t_s, s, attr);
1979
1980 if (wrap && p_more && !recurse)
1981 /* store text for scrolling back */
1982 store_sb_text(&sb_str, s, attr, &sb_col, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983
1984 if (*s == '\n') /* go to next line */
1985 {
1986 msg_didout = FALSE; /* remember that line is empty */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00001987#ifdef FEAT_RIGHTLEFT
1988 if (cmdmsg_rl)
1989 msg_col = Columns - 1;
1990 else
1991#endif
1992 msg_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 if (++msg_row >= Rows) /* safety check */
1994 msg_row = Rows - 1;
1995 }
1996 else if (*s == '\r') /* go to column 0 */
1997 {
1998 msg_col = 0;
1999 }
2000 else if (*s == '\b') /* go to previous char */
2001 {
2002 if (msg_col)
2003 --msg_col;
2004 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002005 else if (*s == TAB) /* translate Tab into spaces */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 {
2007 do
2008 msg_screen_putchar(' ', attr);
2009 while (msg_col & 7);
2010 }
Bram Moolenaar165bc692015-07-21 17:53:25 +02002011 else if (*s == BELL) /* beep (from ":sh") */
2012 vim_beep(BO_SH);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 else
2014 {
2015#ifdef FEAT_MBYTE
2016 if (has_mbyte)
2017 {
2018 cw = (*mb_ptr2cells)(s);
2019 if (enc_utf8 && maxlen >= 0)
2020 /* avoid including composing chars after the end */
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002021 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 else
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00002023 l = (*mb_ptr2len)(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 }
2025 else
2026 {
2027 cw = 1;
2028 l = 1;
2029 }
2030#endif
2031 /* When drawing from right to left or when a double-wide character
2032 * doesn't fit, draw a single character here. Otherwise collect
2033 * characters and draw them all at once later. */
2034#if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
2035 if (
2036# ifdef FEAT_RIGHTLEFT
2037 cmdmsg_rl
2038# ifdef FEAT_MBYTE
2039 ||
2040# endif
2041# endif
2042# ifdef FEAT_MBYTE
2043 (cw > 1 && msg_col + t_col >= Columns - 1)
2044# endif
2045 )
2046 {
2047# ifdef FEAT_MBYTE
2048 if (l > 1)
2049 s = screen_puts_mbyte(s, l, attr) - 1;
2050 else
2051# endif
2052 msg_screen_putchar(*s, attr);
2053 }
2054 else
2055#endif
2056 {
2057 /* postpone this character until later */
2058 if (t_col == 0)
2059 t_s = s;
2060#ifdef FEAT_MBYTE
2061 t_col += cw;
2062 s += l - 1;
2063#else
2064 ++t_col;
2065#endif
2066 }
2067 }
2068 ++s;
2069 }
2070
2071 /* output any postponed text */
2072 if (t_col > 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002073 t_puts(&t_col, t_s, s, attr);
2074 if (p_more && !recurse)
2075 store_sb_text(&sb_str, s, attr, &sb_col, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076
2077 msg_check();
2078}
2079
2080/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002081 * Scroll the screen up one line for displaying the next message line.
2082 */
2083 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002084msg_scroll_up(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002085{
2086#ifdef FEAT_GUI
2087 /* Remove the cursor before scrolling, ScreenLines[] is going
2088 * to become invalid. */
2089 if (gui.in_use)
2090 gui_undraw_cursor();
2091#endif
2092 /* scrolling up always works */
2093 screen_del_lines(0, 0, 1, (int)Rows, TRUE, NULL);
2094
2095 if (!can_clear((char_u *)" "))
2096 {
2097 /* Scrolling up doesn't result in the right background. Set the
2098 * background here. It's not efficient, but avoids that we have to do
2099 * it all over the code. */
2100 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2101
2102 /* Also clear the last char of the last but one line if it was not
2103 * cleared before to avoid a scroll-up. */
2104 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1)
2105 screen_fill((int)Rows - 2, (int)Rows - 1,
2106 (int)Columns - 1, (int)Columns, ' ', ' ', 0);
2107 }
2108}
2109
2110/*
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002111 * Increment "msg_scrolled".
2112 */
2113 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002114inc_msg_scrolled(void)
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002115{
2116#ifdef FEAT_EVAL
2117 if (*get_vim_var_str(VV_SCROLLSTART) == NUL)
2118 {
2119 char_u *p = sourcing_name;
2120 char_u *tofree = NULL;
2121 int len;
2122
2123 /* v:scrollstart is empty, set it to the script/function name and line
2124 * number */
2125 if (p == NULL)
2126 p = (char_u *)_("Unknown");
2127 else
2128 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002129 len = (int)STRLEN(p) + 40;
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002130 tofree = alloc(len);
2131 if (tofree != NULL)
2132 {
2133 vim_snprintf((char *)tofree, len, _("%s line %ld"),
2134 p, (long)sourcing_lnum);
2135 p = tofree;
2136 }
2137 }
2138 set_vim_var_string(VV_SCROLLSTART, p, -1);
2139 vim_free(tofree);
2140 }
2141#endif
2142 ++msg_scrolled;
2143}
2144
2145/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002146 * To be able to scroll back at the "more" and "hit-enter" prompts we need to
2147 * store the displayed text and remember where screen lines start.
2148 */
2149typedef struct msgchunk_S msgchunk_T;
2150struct msgchunk_S
2151{
2152 msgchunk_T *sb_next;
2153 msgchunk_T *sb_prev;
2154 char sb_eol; /* TRUE when line ends after this text */
2155 int sb_msg_col; /* column in which text starts */
2156 int sb_attr; /* text attributes */
2157 char_u sb_text[1]; /* text to be displayed, actually longer */
2158};
2159
2160static msgchunk_T *last_msgchunk = NULL; /* last displayed text */
2161
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01002162static msgchunk_T *msg_sb_start(msgchunk_T *mps);
2163static msgchunk_T *disp_sb_line(int row, msgchunk_T *smp);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002164
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002165static int do_clear_sb_text = FALSE; /* clear text on next msg */
2166
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002167/*
2168 * Store part of a printed message for displaying when scrolling back.
2169 */
2170 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002171store_sb_text(
2172 char_u **sb_str, /* start of string */
2173 char_u *s, /* just after string */
2174 int attr,
2175 int *sb_col,
2176 int finish) /* line ends */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002177{
2178 msgchunk_T *mp;
2179
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002180 if (do_clear_sb_text)
2181 {
2182 clear_sb_text();
2183 do_clear_sb_text = FALSE;
2184 }
2185
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002186 if (s > *sb_str)
2187 {
2188 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str)));
2189 if (mp != NULL)
2190 {
2191 mp->sb_eol = finish;
2192 mp->sb_msg_col = *sb_col;
2193 mp->sb_attr = attr;
2194 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str);
2195
2196 if (last_msgchunk == NULL)
2197 {
2198 last_msgchunk = mp;
2199 mp->sb_prev = NULL;
2200 }
2201 else
2202 {
2203 mp->sb_prev = last_msgchunk;
2204 last_msgchunk->sb_next = mp;
2205 last_msgchunk = mp;
2206 }
2207 mp->sb_next = NULL;
2208 }
2209 }
2210 else if (finish && last_msgchunk != NULL)
2211 last_msgchunk->sb_eol = TRUE;
2212
2213 *sb_str = s;
2214 *sb_col = 0;
2215}
2216
2217/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002218 * Finished showing messages, clear the scroll-back text on the next message.
2219 */
2220 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002221may_clear_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002222{
2223 do_clear_sb_text = TRUE;
2224}
2225
2226/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002227 * Clear any text remembered for scrolling back.
2228 * Called when redrawing the screen.
2229 */
2230 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002231clear_sb_text(void)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002232{
2233 msgchunk_T *mp;
2234
2235 while (last_msgchunk != NULL)
2236 {
2237 mp = last_msgchunk->sb_prev;
2238 vim_free(last_msgchunk);
2239 last_msgchunk = mp;
2240 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002241}
2242
2243/*
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002244 * "g<" command.
2245 */
2246 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002247show_sb_text(void)
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002248{
2249 msgchunk_T *mp;
2250
Bram Moolenaar1b0b07f2007-08-07 20:00:31 +00002251 /* Only show something if there is more than one line, otherwise it looks
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002252 * weird, typing a command without output results in one line. */
2253 mp = msg_sb_start(last_msgchunk);
2254 if (mp == NULL || mp->sb_prev == NULL)
Bram Moolenaar165bc692015-07-21 17:53:25 +02002255 vim_beep(BO_MESS);
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002256 else
2257 {
2258 do_more_prompt('G');
2259 wait_return(FALSE);
2260 }
2261}
2262
2263/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002264 * Move to the start of screen line in already displayed text.
2265 */
2266 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002267msg_sb_start(msgchunk_T *mps)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002268{
2269 msgchunk_T *mp = mps;
2270
2271 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol)
2272 mp = mp->sb_prev;
2273 return mp;
2274}
2275
2276/*
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002277 * Mark the last message chunk as finishing the line.
2278 */
2279 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002280msg_sb_eol(void)
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02002281{
2282 if (last_msgchunk != NULL)
2283 last_msgchunk->sb_eol = TRUE;
2284}
2285
2286/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002287 * Display a screen line from previously displayed text at row "row".
2288 * Returns a pointer to the text for the next line (can be NULL).
2289 */
2290 static msgchunk_T *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002291disp_sb_line(int row, msgchunk_T *smp)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002292{
2293 msgchunk_T *mp = smp;
2294 char_u *p;
2295
2296 for (;;)
2297 {
2298 msg_row = row;
2299 msg_col = mp->sb_msg_col;
2300 p = mp->sb_text;
2301 if (*p == '\n') /* don't display the line break */
2302 ++p;
2303 msg_puts_display(p, -1, mp->sb_attr, TRUE);
2304 if (mp->sb_eol || mp->sb_next == NULL)
2305 break;
2306 mp = mp->sb_next;
2307 }
2308 return mp->sb_next;
2309}
2310
2311/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 * Output any postponed text for msg_puts_attr_len().
2313 */
2314 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002315t_puts(
2316 int *t_col,
2317 char_u *t_s,
2318 char_u *s,
2319 int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320{
2321 /* output postponed text */
2322 msg_didout = TRUE; /* remember that line is not empty */
2323 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002324 msg_col += *t_col;
2325 *t_col = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326#ifdef FEAT_MBYTE
2327 /* If the string starts with a composing character don't increment the
2328 * column position for it. */
2329 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s)))
2330 --msg_col;
2331#endif
2332 if (msg_col >= Columns)
2333 {
2334 msg_col = 0;
2335 ++msg_row;
2336 }
2337}
2338
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339/*
2340 * Returns TRUE when messages should be printed with mch_errmsg().
2341 * This is used when there is no valid screen, so we can see error messages.
2342 * If termcap is not active, we may be writing in an alternate console
2343 * window, cursor positioning may not work correctly (window size may be
2344 * different, e.g. for Win32 console) or we just don't know where the
2345 * cursor is.
2346 */
2347 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002348msg_use_printf(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349{
2350 return (!msg_check_screen()
2351#if defined(WIN3264) && !defined(FEAT_GUI_MSWIN)
2352 || !termcap_active
2353#endif
2354 || (swapping_screen() && !termcap_active)
2355 );
2356}
2357
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002358/*
2359 * Print a message when there is no valid screen.
2360 */
2361 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002362msg_puts_printf(char_u *str, int maxlen)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002363{
2364 char_u *s = str;
2365 char_u buf[4];
2366 char_u *p;
2367
2368#ifdef WIN3264
2369 if (!(silent_mode && p_verbose == 0))
2370 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */
2371#endif
2372 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
2373 {
2374 if (!(silent_mode && p_verbose == 0))
2375 {
2376 /* NL --> CR NL translation (for Unix, not for "--version") */
2377 /* NL --> CR translation (for Mac) */
2378 p = &buf[0];
2379 if (*s == '\n' && !info_message)
2380 *p++ = '\r';
2381#if defined(USE_CR) && !defined(MACOS_X_UNIX)
2382 else
2383#endif
2384 *p++ = *s;
2385 *p = '\0';
2386 if (info_message) /* informative message, not an error */
2387 mch_msg((char *)buf);
2388 else
2389 mch_errmsg((char *)buf);
2390 }
2391
2392 /* primitive way to compute the current column */
2393#ifdef FEAT_RIGHTLEFT
2394 if (cmdmsg_rl)
2395 {
2396 if (*s == '\r' || *s == '\n')
2397 msg_col = Columns - 1;
2398 else
2399 --msg_col;
2400 }
2401 else
2402#endif
2403 {
2404 if (*s == '\r' || *s == '\n')
2405 msg_col = 0;
2406 else
2407 ++msg_col;
2408 }
2409 ++s;
2410 }
2411 msg_didout = TRUE; /* assume that line is not empty */
2412
2413#ifdef WIN3264
2414 if (!(silent_mode && p_verbose == 0))
2415 mch_settmode(TMODE_RAW);
2416#endif
2417}
2418
2419/*
2420 * Show the more-prompt and handle the user response.
2421 * This takes care of scrolling back and displaying previously displayed text.
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002422 * When at hit-enter prompt "typed_char" is the already typed character,
2423 * otherwise it's NUL.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002424 * Returns TRUE when jumping ahead to "confirm_msg_tail".
2425 */
2426 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002427do_more_prompt(int typed_char)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002428{
2429 int used_typed_char = typed_char;
2430 int oldState = State;
2431 int c;
2432#ifdef FEAT_CON_DIALOG
2433 int retval = FALSE;
2434#endif
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002435 int toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002436 msgchunk_T *mp_last = NULL;
2437 msgchunk_T *mp;
2438 int i;
2439
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002440 if (typed_char == 'G')
2441 {
2442 /* "g<": Find first line on the last page. */
2443 mp_last = msg_sb_start(last_msgchunk);
2444 for (i = 0; i < Rows - 2 && mp_last != NULL
2445 && mp_last->sb_prev != NULL; ++i)
2446 mp_last = msg_sb_start(mp_last->sb_prev);
2447 }
2448
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002449 State = ASKMORE;
2450#ifdef FEAT_MOUSE
2451 setmouse();
2452#endif
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002453 if (typed_char == NUL)
2454 msg_moremsg(FALSE);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002455 for (;;)
2456 {
2457 /*
2458 * Get a typed character directly from the user.
2459 */
2460 if (used_typed_char != NUL)
2461 {
2462 c = used_typed_char; /* was typed at hit-enter prompt */
2463 used_typed_char = NUL;
2464 }
2465 else
2466 c = get_keystroke();
2467
2468#if defined(FEAT_MENU) && defined(FEAT_GUI)
2469 if (c == K_MENU)
2470 {
2471 int idx = get_menu_index(current_menu, ASKMORE);
2472
2473 /* Used a menu. If it starts with CTRL-Y, it must
2474 * be a "Copy" for the clipboard. Otherwise
2475 * assume that we end */
2476 if (idx == MENU_INDEX_INVALID)
2477 continue;
2478 c = *current_menu->strings[idx];
2479 if (c != NUL && current_menu->strings[idx][1] != NUL)
2480 ins_typebuf(current_menu->strings[idx] + 1,
2481 current_menu->noremap[idx], 0, TRUE,
2482 current_menu->silent[idx]);
2483 }
2484#endif
2485
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002486 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002487 switch (c)
2488 {
2489 case BS: /* scroll one line back */
2490 case K_BS:
2491 case 'k':
2492 case K_UP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002493 toscroll = -1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002494 break;
2495
2496 case CAR: /* one extra line */
2497 case NL:
2498 case 'j':
2499 case K_DOWN:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002500 toscroll = 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002501 break;
2502
2503 case 'u': /* Up half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002504 toscroll = -(Rows / 2);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002505 break;
2506
2507 case 'd': /* Down half a page */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002508 toscroll = Rows / 2;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002509 break;
2510
2511 case 'b': /* one page back */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002512 case K_PAGEUP:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002513 toscroll = -(Rows - 1);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002514 break;
2515
2516 case ' ': /* one extra page */
Bram Moolenaar2a9e4df2009-02-21 23:59:19 +00002517 case 'f':
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002518 case K_PAGEDOWN:
2519 case K_LEFTMOUSE:
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002520 toscroll = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002521 break;
2522
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002523 case 'g': /* all the way back to the start */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002524 toscroll = -999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002525 break;
2526
2527 case 'G': /* all the way to the end */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002528 toscroll = 999999;
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002529 lines_left = 999999;
2530 break;
2531
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002532 case ':': /* start new command line */
2533#ifdef FEAT_CON_DIALOG
2534 if (!confirm_msg_used)
2535#endif
2536 {
2537 /* Since got_int is set all typeahead will be flushed, but we
2538 * want to keep this ':', remember that in a special way. */
2539 typeahead_noflush(':');
2540 cmdline_row = Rows - 1; /* put ':' on this line */
2541 skip_redraw = TRUE; /* skip redraw once */
2542 need_wait_return = FALSE; /* don't wait in main() */
2543 }
2544 /*FALLTHROUGH*/
2545 case 'q': /* quit */
2546 case Ctrl_C:
2547 case ESC:
2548#ifdef FEAT_CON_DIALOG
2549 if (confirm_msg_used)
2550 {
2551 /* Jump to the choices of the dialog. */
2552 retval = TRUE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002553 }
2554 else
2555#endif
2556 {
2557 got_int = TRUE;
2558 quit_more = TRUE;
2559 }
Bram Moolenaar51306d22009-02-24 03:38:04 +00002560 /* When there is some more output (wrapping line) display that
2561 * without another prompt. */
2562 lines_left = Rows - 1;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002563 break;
2564
2565#ifdef FEAT_CLIPBOARD
2566 case Ctrl_Y:
2567 /* Strange way to allow copying (yanking) a modeless
2568 * selection at the more prompt. Use CTRL-Y,
2569 * because the same is used in Cmdline-mode and at the
2570 * hit-enter prompt. However, scrolling one line up
2571 * might be expected... */
2572 if (clip_star.state == SELECT_DONE)
2573 clip_copy_modeless_selection(TRUE);
2574 continue;
2575#endif
2576 default: /* no valid response */
2577 msg_moremsg(TRUE);
2578 continue;
2579 }
2580
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002581 if (toscroll != 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002582 {
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002583 if (toscroll < 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002584 {
2585 /* go to start of last line */
2586 if (mp_last == NULL)
2587 mp = msg_sb_start(last_msgchunk);
2588 else if (mp_last->sb_prev != NULL)
2589 mp = msg_sb_start(mp_last->sb_prev);
2590 else
2591 mp = NULL;
2592
2593 /* go to start of line at top of the screen */
2594 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL;
2595 ++i)
2596 mp = msg_sb_start(mp->sb_prev);
2597
2598 if (mp != NULL && mp->sb_prev != NULL)
2599 {
2600 /* Find line to be displayed at top. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002601 for (i = 0; i > toscroll; --i)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002602 {
2603 if (mp == NULL || mp->sb_prev == NULL)
2604 break;
2605 mp = msg_sb_start(mp->sb_prev);
2606 if (mp_last == NULL)
2607 mp_last = msg_sb_start(last_msgchunk);
2608 else
2609 mp_last = msg_sb_start(mp_last->sb_prev);
2610 }
2611
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002612 if (toscroll == -1 && screen_ins_lines(0, 0, 1,
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002613 (int)Rows, NULL) == OK)
2614 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002615 /* display line at top */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002616 (void)disp_sb_line(0, mp);
2617 }
2618 else
2619 {
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002620 /* redisplay all lines */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002621 screenclear();
Bram Moolenaar773560b2006-05-06 21:38:18 +00002622 for (i = 0; mp != NULL && i < Rows - 1; ++i)
2623 {
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002624 mp = disp_sb_line(i, mp);
Bram Moolenaar773560b2006-05-06 21:38:18 +00002625 ++msg_scrolled;
2626 }
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002627 }
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002628 toscroll = 0;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002629 }
2630 }
2631 else
2632 {
2633 /* First display any text that we scrolled back. */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002634 while (toscroll > 0 && mp_last != NULL)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002635 {
2636 /* scroll up, display line at bottom */
2637 msg_scroll_up();
Bram Moolenaarbb15b652005-10-03 21:52:09 +00002638 inc_msg_scrolled();
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002639 screen_fill((int)Rows - 2, (int)Rows - 1, 0,
2640 (int)Columns, ' ', ' ', 0);
2641 mp_last = disp_sb_line((int)Rows - 2, mp_last);
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002642 --toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002643 }
2644 }
2645
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002646 if (toscroll <= 0)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002647 {
2648 /* displayed the requested text, more prompt again */
Bram Moolenaarcfc7d632005-07-28 22:28:16 +00002649 screen_fill((int)Rows - 1, (int)Rows, 0,
2650 (int)Columns, ' ', ' ', 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002651 msg_moremsg(FALSE);
2652 continue;
2653 }
2654
2655 /* display more text, return to caller */
Bram Moolenaar70b2a562012-01-10 22:26:17 +01002656 lines_left = toscroll;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002657 }
2658
2659 break;
2660 }
2661
2662 /* clear the --more-- message */
2663 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2664 State = oldState;
2665#ifdef FEAT_MOUSE
2666 setmouse();
2667#endif
2668 if (quit_more)
2669 {
2670 msg_row = Rows - 1;
2671 msg_col = 0;
2672 }
2673#ifdef FEAT_RIGHTLEFT
2674 else if (cmdmsg_rl)
2675 msg_col = Columns - 1;
2676#endif
2677
2678#ifdef FEAT_CON_DIALOG
2679 return retval;
2680#else
2681 return FALSE;
2682#endif
2683}
2684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685#if defined(USE_MCH_ERRMSG) || defined(PROTO)
2686
2687#ifdef mch_errmsg
2688# undef mch_errmsg
2689#endif
2690#ifdef mch_msg
2691# undef mch_msg
2692#endif
2693
2694/*
2695 * Give an error message. To be used when the screen hasn't been initialized
2696 * yet. When stderr can't be used, collect error messages until the GUI has
2697 * started and they can be displayed in a message box.
2698 */
2699 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002700mch_errmsg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701{
2702 int len;
2703
2704#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2705 /* On Unix use stderr if it's a tty.
2706 * When not going to start the GUI also use stderr.
2707 * On Mac, when started from Finder, stderr is the console. */
2708 if (
2709# ifdef UNIX
2710# ifdef MACOS_X_UNIX
2711 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2712# else
2713 isatty(2)
2714# endif
2715# ifdef FEAT_GUI
2716 ||
2717# endif
2718# endif
2719# ifdef FEAT_GUI
2720 !(gui.in_use || gui.starting)
2721# endif
2722 )
2723 {
2724 fprintf(stderr, "%s", str);
2725 return;
2726 }
2727#endif
2728
2729 /* avoid a delay for a message that isn't there */
2730 emsg_on_display = FALSE;
2731
2732 len = (int)STRLEN(str) + 1;
2733 if (error_ga.ga_growsize == 0)
2734 {
2735 error_ga.ga_growsize = 80;
2736 error_ga.ga_itemsize = 1;
2737 }
2738 if (ga_grow(&error_ga, len) == OK)
2739 {
2740 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len,
2741 (char_u *)str, len);
2742#ifdef UNIX
2743 /* remove CR characters, they are displayed */
2744 {
2745 char_u *p;
2746
2747 p = (char_u *)error_ga.ga_data + error_ga.ga_len;
2748 for (;;)
2749 {
2750 p = vim_strchr(p, '\r');
2751 if (p == NULL)
2752 break;
2753 *p = ' ';
2754 }
2755 }
2756#endif
2757 --len; /* don't count the NUL at the end */
2758 error_ga.ga_len += len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 }
2760}
2761
2762/*
2763 * Give a message. To be used when the screen hasn't been initialized yet.
2764 * When there is no tty, collect messages until the GUI has started and they
2765 * can be displayed in a message box.
2766 */
2767 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002768mch_msg(char *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769{
2770#if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI)
2771 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and
2772 * uses mch_errmsg() when started from the desktop.
2773 * When not going to start the GUI also use stdout.
2774 * On Mac, when started from Finder, stderr is the console. */
2775 if (
2776# ifdef UNIX
2777# ifdef MACOS_X_UNIX
2778 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0)
2779# else
2780 isatty(2)
2781# endif
2782# ifdef FEAT_GUI
2783 ||
2784# endif
2785# endif
2786# ifdef FEAT_GUI
2787 !(gui.in_use || gui.starting)
2788# endif
2789 )
2790 {
2791 printf("%s", str);
2792 return;
2793 }
2794# endif
2795 mch_errmsg(str);
2796}
2797#endif /* USE_MCH_ERRMSG */
2798
2799/*
2800 * Put a character on the screen at the current message position and advance
2801 * to the next position. Only for printable ASCII!
2802 */
2803 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002804msg_screen_putchar(int c, int attr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805{
2806 msg_didout = TRUE; /* remember that line is not empty */
2807 screen_putchar(c, msg_row, msg_col, attr);
2808#ifdef FEAT_RIGHTLEFT
2809 if (cmdmsg_rl)
2810 {
2811 if (--msg_col == 0)
2812 {
2813 msg_col = Columns;
2814 ++msg_row;
2815 }
2816 }
2817 else
2818#endif
2819 {
2820 if (++msg_col >= Columns)
2821 {
2822 msg_col = 0;
2823 ++msg_row;
2824 }
2825 }
2826}
2827
2828 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002829msg_moremsg(int full)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830{
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002831 int attr;
2832 char_u *s = (char_u *)_("-- More --");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833
2834 attr = hl_attr(HLF_M);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002835 screen_puts(s, (int)Rows - 1, 0, attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 if (full)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00002837 screen_puts((char_u *)
2838 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "),
2839 (int)Rows - 1, vim_strsize(s), attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840}
2841
2842/*
2843 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or
2844 * exmode_active.
2845 */
2846 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002847repeat_message(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848{
2849 if (State == ASKMORE)
2850 {
2851 msg_moremsg(TRUE); /* display --more-- message again */
2852 msg_row = Rows - 1;
2853 }
2854#ifdef FEAT_CON_DIALOG
2855 else if (State == CONFIRM)
2856 {
2857 display_confirm_msg(); /* display ":confirm" message again */
2858 msg_row = Rows - 1;
2859 }
2860#endif
2861 else if (State == EXTERNCMD)
2862 {
2863 windgoto(msg_row, msg_col); /* put cursor back */
2864 }
2865 else if (State == HITRETURN || State == SETWSIZE)
2866 {
Bram Moolenaar9f108752007-11-24 14:44:58 +00002867 if (msg_row == Rows - 1)
2868 {
2869 /* Avoid drawing the "hit-enter" prompt below the previous one,
2870 * overwrite it. Esp. useful when regaining focus and a
2871 * FocusGained autocmd exists but didn't draw anything. */
2872 msg_didout = FALSE;
2873 msg_col = 0;
2874 msg_clr_eos();
2875 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 hit_return_msg();
2877 msg_row = Rows - 1;
2878 }
2879}
2880
2881/*
2882 * msg_check_screen - check if the screen is initialized.
2883 * Also check msg_row and msg_col, if they are too big it may cause a crash.
2884 * While starting the GUI the terminal codes will be set for the GUI, but the
2885 * output goes to the terminal. Don't use the terminal codes then.
2886 */
2887 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002888msg_check_screen(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889{
2890 if (!full_screen || !screen_valid(FALSE))
2891 return FALSE;
2892
2893 if (msg_row >= Rows)
2894 msg_row = Rows - 1;
2895 if (msg_col >= Columns)
2896 msg_col = Columns - 1;
2897 return TRUE;
2898}
2899
2900/*
2901 * Clear from current message position to end of screen.
2902 * Skip this when ":silent" was used, no need to clear for redirection.
2903 */
2904 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002905msg_clr_eos(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906{
2907 if (msg_silent == 0)
2908 msg_clr_eos_force();
2909}
2910
2911/*
2912 * Clear from current message position to end of screen.
2913 * Note: msg_col is not updated, so we remember the end of the message
2914 * for msg_check().
2915 */
2916 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002917msg_clr_eos_force(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918{
2919 if (msg_use_printf())
2920 {
2921 if (full_screen) /* only when termcap codes are valid */
2922 {
2923 if (*T_CD)
2924 out_str(T_CD); /* clear to end of display */
2925 else if (*T_CE)
2926 out_str(T_CE); /* clear to end of line */
2927 }
2928 }
2929 else
2930 {
2931#ifdef FEAT_RIGHTLEFT
2932 if (cmdmsg_rl)
2933 {
2934 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0);
2935 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2936 }
2937 else
2938#endif
2939 {
2940 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns,
2941 ' ', ' ', 0);
2942 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0);
2943 }
2944 }
2945}
2946
2947/*
2948 * Clear the command line.
2949 */
2950 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002951msg_clr_cmdline(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952{
2953 msg_row = cmdline_row;
2954 msg_col = 0;
2955 msg_clr_eos_force();
2956}
2957
2958/*
2959 * end putting a message on the screen
2960 * call wait_return if the message does not fit in the available space
2961 * return TRUE if wait_return not called.
2962 */
2963 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002964msg_end(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965{
2966 /*
Bram Moolenaar1a4a75c2013-07-28 16:03:06 +02002967 * If the string is larger than the window,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 * or the ruler option is set and we run into it,
2969 * we have to redraw the window.
2970 * Do not do this if we are abandoning the file or editing the command line.
2971 */
2972 if (!exiting && need_wait_return && !(State & CMDLINE))
2973 {
2974 wait_return(FALSE);
2975 return FALSE;
2976 }
2977 out_flush();
2978 return TRUE;
2979}
2980
2981/*
2982 * If the written message runs into the shown command or ruler, we have to
2983 * wait for hit-return and redraw the window later.
2984 */
2985 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01002986msg_check(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987{
2988 if (msg_row == Rows - 1 && msg_col >= sc_col)
2989 {
2990 need_wait_return = TRUE;
2991 redraw_cmdline = TRUE;
2992 }
2993}
2994
2995/*
2996 * May write a string to the redirection file.
2997 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes.
2998 */
2999 static void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003000redir_write(char_u *str, int maxlen)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001{
3002 char_u *s = str;
3003 static int cur_col = 0;
3004
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003005 /* Don't do anything for displaying prompts and the like. */
3006 if (redir_off)
3007 return;
3008
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003009 /* If 'verbosefile' is set prepare for writing in that file. */
3010 if (*p_vfile != NUL && verbose_fd == NULL)
3011 verbose_open();
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003012
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003013 if (redirecting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 {
3015 /* If the string doesn't start with CR or NL, go to msg_col */
3016 if (*s != '\n' && *s != '\r')
3017 {
3018 while (cur_col < msg_col)
3019 {
3020#ifdef FEAT_EVAL
3021 if (redir_reg)
3022 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003023 else if (redir_vname)
3024 var_redir_str((char_u *)" ", -1);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003025 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003027 if (redir_fd != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 fputs(" ", redir_fd);
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003029 if (verbose_fd != NULL)
3030 fputs(" ", verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 ++cur_col;
3032 }
3033 }
3034
3035#ifdef FEAT_EVAL
3036 if (redir_reg)
3037 write_reg_contents(redir_reg, s, maxlen, TRUE);
Bram Moolenaardf177f62005-02-22 08:39:57 +00003038 if (redir_vname)
3039 var_redir_str(s, maxlen);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040#endif
3041
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003042 /* Write and adjust the current column. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen))
3044 {
3045#ifdef FEAT_EVAL
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003046 if (!redir_reg && !redir_vname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047#endif
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003048 if (redir_fd != NULL)
3049 putc(*s, redir_fd);
3050 if (verbose_fd != NULL)
3051 putc(*s, verbose_fd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 if (*s == '\r' || *s == '\n')
3053 cur_col = 0;
3054 else if (*s == '\t')
3055 cur_col += (8 - cur_col % 8);
3056 else
3057 ++cur_col;
3058 ++s;
3059 }
3060
3061 if (msg_silent != 0) /* should update msg_col */
3062 msg_col = cur_col;
3063 }
3064}
3065
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003066 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003067redirecting(void)
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003068{
Bram Moolenaarb5b5b892011-09-14 15:39:29 +02003069 return redir_fd != NULL || *p_vfile != NUL
Bram Moolenaar77ab2802009-04-22 12:44:48 +00003070#ifdef FEAT_EVAL
3071 || redir_reg || redir_vname
3072#endif
3073 ;
3074}
3075
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076/*
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003077 * Before giving verbose message.
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003078 * Must always be called paired with verbose_leave()!
3079 */
3080 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003081verbose_enter(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003082{
3083 if (*p_vfile != NUL)
3084 ++msg_silent;
3085}
3086
3087/*
3088 * After giving verbose message.
3089 * Must always be called paired with verbose_enter()!
3090 */
3091 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003092verbose_leave(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003093{
3094 if (*p_vfile != NUL)
3095 if (--msg_silent < 0)
3096 msg_silent = 0;
3097}
3098
3099/*
3100 * Like verbose_enter() and set msg_scroll when displaying the message.
3101 */
3102 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003103verbose_enter_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003104{
3105 if (*p_vfile != NUL)
3106 ++msg_silent;
3107 else
3108 /* always scroll up, don't overwrite */
3109 msg_scroll = TRUE;
3110}
3111
3112/*
3113 * Like verbose_leave() and set cmdline_row when displaying the message.
3114 */
3115 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003116verbose_leave_scroll(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003117{
3118 if (*p_vfile != NUL)
3119 {
3120 if (--msg_silent < 0)
3121 msg_silent = 0;
3122 }
3123 else
3124 cmdline_row = msg_row;
3125}
3126
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003127/*
3128 * Called when 'verbosefile' is set: stop writing to the file.
3129 */
3130 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003131verbose_stop(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003132{
3133 if (verbose_fd != NULL)
3134 {
3135 fclose(verbose_fd);
3136 verbose_fd = NULL;
3137 }
3138 verbose_did_open = FALSE;
3139}
3140
3141/*
3142 * Open the file 'verbosefile'.
3143 * Return FAIL or OK.
3144 */
3145 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003146verbose_open(void)
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003147{
3148 if (verbose_fd == NULL && !verbose_did_open)
3149 {
3150 /* Only give the error message once. */
3151 verbose_did_open = TRUE;
3152
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003153 verbose_fd = mch_fopen((char *)p_vfile, "a");
Bram Moolenaar8b044b32005-05-31 22:05:58 +00003154 if (verbose_fd == NULL)
3155 {
3156 EMSG2(_(e_notopen), p_vfile);
3157 return FAIL;
3158 }
3159 }
3160 return OK;
3161}
3162
3163/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 * Give a warning message (for searching).
3165 * Use 'w' highlighting and may repeat the message after redrawing
3166 */
3167 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003168give_warning(char_u *message, int hl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169{
3170 /* Don't do this for ":silent". */
3171 if (msg_silent != 0)
3172 return;
3173
3174 /* Don't want a hit-enter prompt here. */
3175 ++no_wait_return;
Bram Moolenaared203462004-06-16 11:19:22 +00003176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177#ifdef FEAT_EVAL
3178 set_vim_var_string(VV_WARNINGMSG, message, -1);
3179#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 vim_free(keep_msg);
3181 keep_msg = NULL;
3182 if (hl)
3183 keep_msg_attr = hl_attr(HLF_W);
3184 else
3185 keep_msg_attr = 0;
3186 if (msg_attr(message, keep_msg_attr) && msg_scrolled == 0)
Bram Moolenaar030f0df2006-02-21 22:02:53 +00003187 set_keep_msg(message, keep_msg_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 msg_didout = FALSE; /* overwrite this message */
3189 msg_nowait = TRUE; /* don't wait for this message */
3190 msg_col = 0;
Bram Moolenaared203462004-06-16 11:19:22 +00003191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 --no_wait_return;
3193}
3194
3195/*
3196 * Advance msg cursor to column "col".
3197 */
3198 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003199msg_advance(int col)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200{
3201 if (msg_silent != 0) /* nothing to advance to */
3202 {
3203 msg_col = col; /* for redirection, may fill it up later */
3204 return;
3205 }
3206 if (col >= Columns) /* not enough room */
3207 col = Columns - 1;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003208#ifdef FEAT_RIGHTLEFT
3209 if (cmdmsg_rl)
3210 while (msg_col > Columns - col)
3211 msg_putchar(' ');
3212 else
3213#endif
3214 while (msg_col < col)
3215 msg_putchar(' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216}
3217
3218#if defined(FEAT_CON_DIALOG) || defined(PROTO)
3219/*
3220 * Used for "confirm()" function, and the :confirm command prefix.
3221 * Versions which haven't got flexible dialogs yet, and console
3222 * versions, get this generic handler which uses the command line.
3223 *
3224 * type = one of:
3225 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC
3226 * title = title string (can be NULL for default)
3227 * (neither used in console dialogs at the moment)
3228 *
3229 * Format of the "buttons" string:
3230 * "Button1Name\nButton2Name\nButton3Name"
3231 * The first button should normally be the default/accept
3232 * The second button should be the 'Cancel' button
3233 * Other buttons- use your imagination!
3234 * A '&' in a button name becomes a shortcut, so each '&' should be before a
3235 * different letter.
3236 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003238do_dialog(
3239 int type UNUSED,
3240 char_u *title UNUSED,
3241 char_u *message,
3242 char_u *buttons,
3243 int dfltbutton,
3244 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003245 otherwise */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003246 int ex_cmd) /* when TRUE pressing : accepts default and starts
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003247 Ex command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248{
3249 int oldState;
3250 int retval = 0;
3251 char_u *hotkeys;
3252 int c;
3253 int i;
3254
3255#ifndef NO_CONSOLE
3256 /* Don't output anything in silent mode ("ex -s") */
3257 if (silent_mode)
3258 return dfltbutton; /* return default option */
3259#endif
3260
3261#ifdef FEAT_GUI_DIALOG
3262 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */
3263 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
3264 {
3265 c = gui_mch_dialog(type, title, message, buttons, dfltbutton,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003266 textfield, ex_cmd);
Bram Moolenaar8de49e12009-02-11 17:47:54 +00003267 /* avoid a hit-enter prompt without clearing the cmdline */
3268 need_wait_return = FALSE;
3269 emsg_on_display = FALSE;
3270 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271
3272 /* Flush output to avoid that further messages and redrawing is done
3273 * in the wrong order. */
3274 out_flush();
3275 gui_mch_update();
3276
3277 return c;
3278 }
3279#endif
3280
3281 oldState = State;
3282 State = CONFIRM;
3283#ifdef FEAT_MOUSE
3284 setmouse();
3285#endif
3286
3287 /*
3288 * Since we wait for a keypress, don't make the
3289 * user press RETURN as well afterwards.
3290 */
3291 ++no_wait_return;
3292 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton);
3293
3294 if (hotkeys != NULL)
3295 {
3296 for (;;)
3297 {
3298 /* Get a typed character directly from the user. */
3299 c = get_keystroke();
3300 switch (c)
3301 {
3302 case CAR: /* User accepts default option */
3303 case NL:
3304 retval = dfltbutton;
3305 break;
3306 case Ctrl_C: /* User aborts/cancels */
3307 case ESC:
3308 retval = 0;
3309 break;
3310 default: /* Could be a hotkey? */
3311 if (c < 0) /* special keys are ignored here */
3312 continue;
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003313 if (c == ':' && ex_cmd)
3314 {
3315 retval = dfltbutton;
3316 ins_char_typebuf(':');
3317 break;
3318 }
3319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 /* Make the character lowercase, as chars in "hotkeys" are. */
3321 c = MB_TOLOWER(c);
3322 retval = 1;
3323 for (i = 0; hotkeys[i]; ++i)
3324 {
3325#ifdef FEAT_MBYTE
3326 if (has_mbyte)
3327 {
3328 if ((*mb_ptr2char)(hotkeys + i) == c)
3329 break;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003330 i += (*mb_ptr2len)(hotkeys + i) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 }
3332 else
3333#endif
3334 if (hotkeys[i] == c)
3335 break;
3336 ++retval;
3337 }
3338 if (hotkeys[i])
3339 break;
3340 /* No hotkey match, so keep waiting */
3341 continue;
3342 }
3343 break;
3344 }
3345
3346 vim_free(hotkeys);
3347 }
3348
3349 State = oldState;
3350#ifdef FEAT_MOUSE
3351 setmouse();
3352#endif
3353 --no_wait_return;
3354 msg_end_prompt();
3355
3356 return retval;
3357}
3358
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003359static int copy_char(char_u *from, char_u *to, int lowercase);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360
3361/*
3362 * Copy one character from "*from" to "*to", taking care of multi-byte
3363 * characters. Return the length of the character in bytes.
3364 */
3365 static int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003366copy_char(
3367 char_u *from,
3368 char_u *to,
3369 int lowercase) /* make character lower case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370{
3371#ifdef FEAT_MBYTE
3372 int len;
3373 int c;
3374
3375 if (has_mbyte)
3376 {
3377 if (lowercase)
3378 {
3379 c = MB_TOLOWER((*mb_ptr2char)(from));
3380 return (*mb_char2bytes)(c, to);
3381 }
3382 else
3383 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00003384 len = (*mb_ptr2len)(from);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 mch_memmove(to, from, (size_t)len);
3386 return len;
3387 }
3388 }
3389 else
3390#endif
3391 {
3392 if (lowercase)
3393 *to = (char_u)TOLOWER_LOC(*from);
3394 else
3395 *to = *from;
3396 return 1;
3397 }
3398}
3399
3400/*
3401 * Format the dialog string, and display it at the bottom of
3402 * the screen. Return a string of hotkey chars (if defined) for
3403 * each 'button'. If a button has no hotkey defined, the first character of
3404 * the button is used.
3405 * The hotkeys can be multi-byte characters, but without combining chars.
3406 *
3407 * Returns an allocated string with hotkeys, or NULL for error.
3408 */
3409 static char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003410msg_show_console_dialog(
3411 char_u *message,
3412 char_u *buttons,
3413 int dfltbutton)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414{
3415 int len = 0;
3416#ifdef FEAT_MBYTE
3417# define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1)
3418#else
3419# define HOTK_LEN 1
3420#endif
3421 int lenhotkey = HOTK_LEN; /* count first button */
3422 char_u *hotk = NULL;
3423 char_u *msgp = NULL;
3424 char_u *hotkp = NULL;
3425 char_u *r;
3426 int copy;
3427#define HAS_HOTKEY_LEN 30
3428 char_u has_hotkey[HAS_HOTKEY_LEN];
3429 int first_hotkey = FALSE; /* first char of button is hotkey */
3430 int idx;
3431
3432 has_hotkey[0] = FALSE;
3433
3434 /*
3435 * First loop: compute the size of memory to allocate.
3436 * Second loop: copy to the allocated memory.
3437 */
3438 for (copy = 0; copy <= 1; ++copy)
3439 {
3440 r = buttons;
3441 idx = 0;
3442 while (*r)
3443 {
3444 if (*r == DLG_BUTTON_SEP)
3445 {
3446 if (copy)
3447 {
3448 *msgp++ = ',';
3449 *msgp++ = ' '; /* '\n' -> ', ' */
3450
3451 /* advance to next hotkey and set default hotkey */
3452#ifdef FEAT_MBYTE
3453 if (has_mbyte)
Bram Moolenaar6a516062007-07-05 08:11:42 +00003454 hotkp += STRLEN(hotkp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 else
3456#endif
3457 ++hotkp;
Bram Moolenaar6a516062007-07-05 08:11:42 +00003458 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 if (dfltbutton)
3460 --dfltbutton;
3461
3462 /* If no hotkey is specified first char is used. */
3463 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx])
3464 first_hotkey = TRUE;
3465 }
3466 else
3467 {
3468 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */
3469 lenhotkey += HOTK_LEN; /* each button needs a hotkey */
3470 if (idx < HAS_HOTKEY_LEN - 1)
3471 has_hotkey[++idx] = FALSE;
3472 }
3473 }
3474 else if (*r == DLG_HOTKEY_CHAR || first_hotkey)
3475 {
3476 if (*r == DLG_HOTKEY_CHAR)
3477 ++r;
3478 first_hotkey = FALSE;
3479 if (copy)
3480 {
3481 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */
3482 *msgp++ = *r;
3483 else
3484 {
3485 /* '&a' -> '[a]' */
3486 *msgp++ = (dfltbutton == 1) ? '[' : '(';
3487 msgp += copy_char(r, msgp, FALSE);
3488 *msgp++ = (dfltbutton == 1) ? ']' : ')';
3489
3490 /* redefine hotkey */
Bram Moolenaar6a516062007-07-05 08:11:42 +00003491 hotkp[copy_char(r, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 }
3493 }
3494 else
3495 {
3496 ++len; /* '&a' -> '[a]' */
3497 if (idx < HAS_HOTKEY_LEN - 1)
3498 has_hotkey[idx] = TRUE;
3499 }
3500 }
3501 else
3502 {
3503 /* everything else copy literally */
3504 if (copy)
3505 msgp += copy_char(r, msgp, FALSE);
3506 }
3507
3508 /* advance to the next character */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003509 mb_ptr_adv(r);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 }
3511
3512 if (copy)
3513 {
3514 *msgp++ = ':';
3515 *msgp++ = ' ';
3516 *msgp = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 }
3518 else
3519 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003520 len += (int)(STRLEN(message)
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003521 + 2 /* for the NL's */
3522 + STRLEN(buttons)
3523 + 3); /* for the ": " and NUL */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003524 lenhotkey++; /* for the NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
3526 /* If no hotkey is specified first char is used. */
3527 if (!has_hotkey[0])
3528 {
3529 first_hotkey = TRUE;
3530 len += 2; /* "x" -> "[x]" */
3531 }
3532
3533 /*
3534 * Now allocate and load the strings
3535 */
3536 vim_free(confirm_msg);
3537 confirm_msg = alloc(len);
3538 if (confirm_msg == NULL)
3539 return NULL;
3540 *confirm_msg = NUL;
3541 hotk = alloc(lenhotkey);
3542 if (hotk == NULL)
3543 return NULL;
3544
3545 *confirm_msg = '\n';
3546 STRCPY(confirm_msg + 1, message);
3547
3548 msgp = confirm_msg + 1 + STRLEN(message);
3549 hotkp = hotk;
3550
Bram Moolenaar6a516062007-07-05 08:11:42 +00003551 /* Define first default hotkey. Keep the hotkey string NUL
3552 * terminated to avoid reading past the end. */
3553 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 /* Remember where the choices start, displaying starts here when
3556 * "hotkp" typed at the more prompt. */
3557 confirm_msg_tail = msgp;
3558 *msgp++ = '\n';
3559 }
3560 }
3561
3562 display_confirm_msg();
3563 return hotk;
3564}
3565
3566/*
3567 * Display the ":confirm" message. Also called when screen resized.
3568 */
3569 void
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003570display_confirm_msg(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571{
3572 /* avoid that 'q' at the more prompt truncates the message here */
3573 ++confirm_msg_used;
3574 if (confirm_msg != NULL)
3575 msg_puts_attr(confirm_msg, hl_attr(HLF_M));
3576 --confirm_msg_used;
3577}
3578
3579#endif /* FEAT_CON_DIALOG */
3580
3581#if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
3582
3583 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003584vim_dialog_yesno(
3585 int type,
3586 char_u *title,
3587 char_u *message,
3588 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589{
3590 if (do_dialog(type,
3591 title == NULL ? (char_u *)_("Question") : title,
3592 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003593 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 return VIM_YES;
3595 return VIM_NO;
3596}
3597
3598 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003599vim_dialog_yesnocancel(
3600 int type,
3601 char_u *title,
3602 char_u *message,
3603 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604{
3605 switch (do_dialog(type,
3606 title == NULL ? (char_u *)_("Question") : title,
3607 message,
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003608 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 {
3610 case 1: return VIM_YES;
3611 case 2: return VIM_NO;
3612 }
3613 return VIM_CANCEL;
3614}
3615
3616 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003617vim_dialog_yesnoallcancel(
3618 int type,
3619 char_u *title,
3620 char_u *message,
3621 int dflt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622{
3623 switch (do_dialog(type,
3624 title == NULL ? (char_u *)"Question" : title,
3625 message,
3626 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"),
Bram Moolenaard2c340a2011-01-17 20:08:11 +01003627 dflt, NULL, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 {
3629 case 1: return VIM_YES;
3630 case 2: return VIM_NO;
3631 case 3: return VIM_ALL;
3632 case 4: return VIM_DISCARDALL;
3633 }
3634 return VIM_CANCEL;
3635}
3636
3637#endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */
3638
3639#if defined(FEAT_BROWSE) || defined(PROTO)
3640/*
3641 * Generic browse function. Calls gui_mch_browse() when possible.
3642 * Later this may pop-up a non-GUI file selector (external command?).
3643 */
3644 char_u *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003645do_browse(
3646 int flags, /* BROWSE_SAVE and BROWSE_DIR */
3647 char_u *title, /* title for the window */
3648 char_u *dflt, /* default file name (may include directory) */
3649 char_u *ext, /* extension added */
3650 char_u *initdir, /* initial directory, NULL for current dir or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 when using path from "dflt" */
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003652 char_u *filter, /* file name filter */
3653 buf_T *buf) /* buffer to read/write for */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654{
3655 char_u *fname;
3656 static char_u *last_dir = NULL; /* last used directory */
3657 char_u *tofree = NULL;
3658 int save_browse = cmdmod.browse;
3659
3660 /* Must turn off browse to avoid that autocommands will get the
3661 * flag too! */
3662 cmdmod.browse = FALSE;
3663
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003664 if (title == NULL || *title == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 {
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003666 if (flags & BROWSE_DIR)
3667 title = (char_u *)_("Select Directory dialog");
3668 else if (flags & BROWSE_SAVE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 title = (char_u *)_("Save File dialog");
3670 else
3671 title = (char_u *)_("Open File dialog");
3672 }
3673
3674 /* When no directory specified, use default file name, default dir, buffer
3675 * dir, last dir or current dir */
3676 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL)
3677 {
3678 if (mch_isdir(dflt)) /* default file name is a directory */
3679 {
3680 initdir = dflt;
3681 dflt = NULL;
3682 }
3683 else if (gettail(dflt) != dflt) /* default file name includes a path */
3684 {
3685 tofree = vim_strsave(dflt);
3686 if (tofree != NULL)
3687 {
3688 initdir = tofree;
3689 *gettail(initdir) = NUL;
3690 dflt = gettail(dflt);
3691 }
3692 }
3693 }
3694
3695 if (initdir == NULL || *initdir == NUL)
3696 {
3697 /* When 'browsedir' is a directory, use it */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003698 if (STRCMP(p_bsdir, "last") != 0
3699 && STRCMP(p_bsdir, "buffer") != 0
3700 && STRCMP(p_bsdir, "current") != 0
3701 && mch_isdir(p_bsdir))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 initdir = p_bsdir;
3703 /* When saving or 'browsedir' is "buffer", use buffer fname */
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003704 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 && buf != NULL && buf->b_ffname != NULL)
3706 {
3707 if (dflt == NULL || *dflt == NUL)
3708 dflt = gettail(curbuf->b_ffname);
3709 tofree = vim_strsave(curbuf->b_ffname);
3710 if (tofree != NULL)
3711 {
3712 initdir = tofree;
3713 *gettail(initdir) = NUL;
3714 }
3715 }
3716 /* When 'browsedir' is "last", use dir from last browse */
3717 else if (*p_bsdir == 'l')
3718 initdir = last_dir;
3719 /* When 'browsedir is "current", use current directory. This is the
3720 * default already, leave initdir empty. */
3721 }
3722
3723# ifdef FEAT_GUI
3724 if (gui.in_use) /* when this changes, also adjust f_has()! */
3725 {
3726 if (filter == NULL
3727# ifdef FEAT_EVAL
3728 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL
3729 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL
3730# endif
3731 )
3732 filter = BROWSE_FILTER_DEFAULT;
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003733 if (flags & BROWSE_DIR)
3734 {
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003735# if defined(FEAT_GUI_GTK) || defined(WIN3264)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003736 /* For systems that have a directory dialog. */
3737 fname = gui_mch_browsedir(title, initdir);
3738# else
3739 /* Generic solution for selecting a directory: select a file and
3740 * remove the file name. */
3741 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)"");
3742# endif
Bram Moolenaar0eda7ac2010-06-26 05:38:18 +02003743# if !defined(FEAT_GUI_GTK)
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003744 /* Win32 adds a dummy file name, others return an arbitrary file
3745 * name. GTK+ 2 returns only the directory, */
3746 if (fname != NULL && *fname != NUL && !mch_isdir(fname))
3747 {
3748 /* Remove the file name. */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003749 char_u *tail = gettail_sep(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003750
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003751 if (tail == fname)
3752 *tail++ = '.'; /* use current dir */
3753 *tail = NUL;
3754 }
3755# endif
3756 }
3757 else
3758 fname = gui_mch_browse(flags & BROWSE_SAVE,
3759 title, dflt, ext, initdir, filter);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760
3761 /* We hang around in the dialog for a while, the user might do some
3762 * things to our files. The Win32 dialog allows deleting or renaming
3763 * a file, check timestamps. */
3764 need_check_timestamps = TRUE;
3765 did_check_timestamps = FALSE;
3766 }
3767 else
3768# endif
3769 {
3770 /* TODO: non-GUI file selector here */
3771 EMSG(_("E338: Sorry, no file browser in console mode"));
3772 fname = NULL;
3773 }
3774
3775 /* keep the directory for next time */
3776 if (fname != NULL)
3777 {
3778 vim_free(last_dir);
3779 last_dir = vim_strsave(fname);
Bram Moolenaar7171abe2004-10-11 10:06:20 +00003780 if (last_dir != NULL && !(flags & BROWSE_DIR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 {
3782 *gettail(last_dir) = NUL;
3783 if (*last_dir == NUL)
3784 {
3785 /* filename only returned, must be in current dir */
3786 vim_free(last_dir);
3787 last_dir = alloc(MAXPATHL);
3788 if (last_dir != NULL)
3789 mch_dirname(last_dir, MAXPATHL);
3790 }
3791 }
3792 }
3793
3794 vim_free(tofree);
3795 cmdmod.browse = save_browse;
3796
3797 return fname;
3798}
3799#endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003800
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003801#if defined(FEAT_EVAL)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003802static char *e_printf = N_("E766: Insufficient arguments for printf()");
3803
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003804static long tv_nr(typval_T *tvs, int *idxp);
3805static char *tv_str(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003806# ifdef FEAT_FLOAT
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01003807static double tv_float(typval_T *tvs, int *idxp);
Bram Moolenaara7241f52008-06-24 20:39:31 +00003808# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003809
3810/*
3811 * Get number argument from "idxp" entry in "tvs". First entry is 1.
3812 */
3813 static long
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003814tv_nr(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003815{
3816 int idx = *idxp - 1;
3817 long n = 0;
3818 int err = FALSE;
3819
3820 if (tvs[idx].v_type == VAR_UNKNOWN)
3821 EMSG(_(e_printf));
3822 else
3823 {
3824 ++*idxp;
3825 n = get_tv_number_chk(&tvs[idx], &err);
3826 if (err)
3827 n = 0;
3828 }
3829 return n;
3830}
3831
3832/*
3833 * Get string argument from "idxp" entry in "tvs". First entry is 1.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003834 * Returns NULL for an error.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003835 */
3836 static char *
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003837tv_str(typval_T *tvs, int *idxp)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003838{
3839 int idx = *idxp - 1;
3840 char *s = NULL;
3841
3842 if (tvs[idx].v_type == VAR_UNKNOWN)
3843 EMSG(_(e_printf));
3844 else
3845 {
3846 ++*idxp;
3847 s = (char *)get_tv_string_chk(&tvs[idx]);
3848 }
3849 return s;
3850}
Bram Moolenaara7241f52008-06-24 20:39:31 +00003851
3852# ifdef FEAT_FLOAT
3853/*
3854 * Get float argument from "idxp" entry in "tvs". First entry is 1.
3855 */
3856 static double
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003857tv_float(typval_T *tvs, int *idxp)
Bram Moolenaara7241f52008-06-24 20:39:31 +00003858{
3859 int idx = *idxp - 1;
3860 double f = 0;
3861
3862 if (tvs[idx].v_type == VAR_UNKNOWN)
3863 EMSG(_(e_printf));
3864 else
3865 {
3866 ++*idxp;
3867 if (tvs[idx].v_type == VAR_FLOAT)
3868 f = tvs[idx].vval.v_float;
Bram Moolenaarc4a87012008-06-28 14:10:11 +00003869 else if (tvs[idx].v_type == VAR_NUMBER)
3870 f = tvs[idx].vval.v_number;
Bram Moolenaara7241f52008-06-24 20:39:31 +00003871 else
3872 EMSG(_("E807: Expected Float argument for printf()"));
3873 }
3874 return f;
3875}
3876# endif
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003877#endif
3878
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003879/*
3880 * This code was included to provide a portable vsnprintf() and snprintf().
Bram Moolenaara2031822006-03-07 22:29:51 +00003881 * Some systems may provide their own, but we always use this one for
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003882 * consistency.
3883 *
3884 * This code is based on snprintf.c - a portable implementation of snprintf
3885 * by Mark Martinec <mark.martinec@ijs.si>, Version 2.2, 2000-10-06.
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00003886 * Included with permission. It was heavily modified to fit in Vim.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003887 * The original code, including useful comments, can be found here:
3888 * http://www.ijs.si/software/snprintf/
3889 *
3890 * This snprintf() only supports the following conversion specifiers:
3891 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below)
3892 * with flags: '-', '+', ' ', '0' and '#'.
3893 * An asterisk is supported for field width as well as precision.
3894 *
Bram Moolenaara7241f52008-06-24 20:39:31 +00003895 * Limited support for floating point was added: 'f', 'e', 'E', 'g', 'G'.
3896 *
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003897 * Length modifiers 'h' (short int) and 'l' (long int) are supported.
3898 * 'll' (long long int) is not supported.
3899 *
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003900 * The locale is not used, the string is used as a byte string. This is only
3901 * relevant for double-byte encodings where the second byte may be '%'.
3902 *
Bram Moolenaara2031822006-03-07 22:29:51 +00003903 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL
3904 * pointer for resulting string argument if "str_m" is zero (as per ISO C99).
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003905 *
3906 * The return value is the number of characters which would be generated
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003907 * for the given input, excluding the trailing NUL. If this value
Bram Moolenaara2031822006-03-07 22:29:51 +00003908 * is greater or equal to "str_m", not all characters from the result
3909 * have been stored in str, output bytes beyond the ("str_m"-1) -th character
3910 * are discarded. If "str_m" is greater than zero it is guaranteed
Bram Moolenaarcaad4f02014-12-17 14:36:14 +01003911 * the resulting string will be NUL-terminated.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003912 */
3913
3914/*
3915 * When va_list is not supported we only define vim_snprintf().
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003916 *
3917 * vim_vsnprintf() can be invoked with either "va_list" or a list of
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00003918 * "typval_T". When the latter is not used it must be NULL.
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003919 */
3920
3921/* When generating prototypes all of this is skipped, cproto doesn't
3922 * understand this. */
3923#ifndef PROTO
Bram Moolenaara800b422010-06-27 01:15:55 +02003924
Bram Moolenaara800b422010-06-27 01:15:55 +02003925/* Like vim_vsnprintf() but append to the string. */
3926 int
3927vim_snprintf_add(char *str, size_t str_m, char *fmt, ...)
3928{
3929 va_list ap;
3930 int str_l;
3931 size_t len = STRLEN(str);
3932 size_t space;
3933
3934 if (str_m <= len)
3935 space = 0;
3936 else
3937 space = str_m - len;
3938 va_start(ap, fmt);
3939 str_l = vim_vsnprintf(str + len, space, fmt, ap, NULL);
3940 va_end(ap);
3941 return str_l;
3942}
Bram Moolenaara800b422010-06-27 01:15:55 +02003943
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003944 int
3945vim_snprintf(char *str, size_t str_m, char *fmt, ...)
3946{
3947 va_list ap;
3948 int str_l;
3949
3950 va_start(ap, fmt);
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003951 str_l = vim_vsnprintf(str, str_m, fmt, ap, NULL);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003952 va_end(ap);
3953 return str_l;
3954}
3955
Bram Moolenaar4be06f92005-07-29 22:36:03 +00003956 int
Bram Moolenaar52ea13d2016-01-30 18:51:09 +01003957vim_vsnprintf(
3958 char *str,
3959 size_t str_m,
3960 char *fmt,
3961 va_list ap,
3962 typval_T *tvs)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003963{
3964 size_t str_l = 0;
3965 char *p = fmt;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003966 int arg_idx = 1;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003967
3968 if (p == NULL)
3969 p = "";
3970 while (*p != NUL)
3971 {
3972 if (*p != '%')
3973 {
3974 char *q = strchr(p + 1, '%');
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00003975 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003976
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00003977 /* Copy up to the next '%' or NUL without any changes. */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00003978 if (str_l < str_m)
3979 {
3980 size_t avail = str_m - str_l;
3981
3982 mch_memmove(str + str_l, p, n > avail ? avail : n);
3983 }
3984 p += n;
3985 str_l += n;
3986 }
3987 else
3988 {
3989 size_t min_field_width = 0, precision = 0;
3990 int zero_padding = 0, precision_specified = 0, justify_left = 0;
3991 int alternate_form = 0, force_sign = 0;
3992
3993 /* If both the ' ' and '+' flags appear, the ' ' flag should be
3994 * ignored. */
3995 int space_for_positive = 1;
3996
3997 /* allowed values: \0, h, l, L */
3998 char length_modifier = '\0';
3999
4000 /* temporary buffer for simple numeric->string conversion */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004001# ifdef FEAT_FLOAT
4002# define TMP_LEN 350 /* On my system 1e308 is the biggest number possible.
Bram Moolenaara7241f52008-06-24 20:39:31 +00004003 * That sounds reasonable to use as the maximum
4004 * printable. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004005# else
4006# define TMP_LEN 32
4007# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004008 char tmp[TMP_LEN];
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004009
4010 /* string address in case of string argument */
4011 char *str_arg;
4012
4013 /* natural field width of arg without padding and sign */
4014 size_t str_arg_l;
4015
4016 /* unsigned char argument value - only defined for c conversion.
4017 * N.B. standard explicitly states the char argument for the c
4018 * conversion is unsigned */
4019 unsigned char uchar_arg;
4020
4021 /* number of zeros to be inserted for numeric conversions as
4022 * required by the precision or minimal field width */
4023 size_t number_of_zeros_to_pad = 0;
4024
4025 /* index into tmp where zero padding is to be inserted */
4026 size_t zero_padding_insertion_ind = 0;
4027
4028 /* current conversion specifier character */
4029 char fmt_spec = '\0';
4030
4031 str_arg = NULL;
4032 p++; /* skip '%' */
4033
4034 /* parse flags */
4035 while (*p == '0' || *p == '-' || *p == '+' || *p == ' '
4036 || *p == '#' || *p == '\'')
4037 {
4038 switch (*p)
4039 {
4040 case '0': zero_padding = 1; break;
4041 case '-': justify_left = 1; break;
4042 case '+': force_sign = 1; space_for_positive = 0; break;
4043 case ' ': force_sign = 1;
4044 /* If both the ' ' and '+' flags appear, the ' '
4045 * flag should be ignored */
4046 break;
4047 case '#': alternate_form = 1; break;
4048 case '\'': break;
4049 }
4050 p++;
4051 }
4052 /* If the '0' and '-' flags both appear, the '0' flag should be
4053 * ignored. */
4054
4055 /* parse field width */
4056 if (*p == '*')
4057 {
4058 int j;
4059
4060 p++;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004061 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004062# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004063 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004064# endif
4065 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004066 if (j >= 0)
4067 min_field_width = j;
4068 else
4069 {
4070 min_field_width = -j;
4071 justify_left = 1;
4072 }
4073 }
4074 else if (VIM_ISDIGIT((int)(*p)))
4075 {
4076 /* size_t could be wider than unsigned int; make sure we treat
4077 * argument like common implementations do */
4078 unsigned int uj = *p++ - '0';
4079
4080 while (VIM_ISDIGIT((int)(*p)))
4081 uj = 10 * uj + (unsigned int)(*p++ - '0');
4082 min_field_width = uj;
4083 }
4084
4085 /* parse precision */
4086 if (*p == '.')
4087 {
4088 p++;
4089 precision_specified = 1;
4090 if (*p == '*')
4091 {
4092 int j;
4093
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004094 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004095# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004096 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004097# endif
4098 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004099 p++;
4100 if (j >= 0)
4101 precision = j;
4102 else
4103 {
4104 precision_specified = 0;
4105 precision = 0;
4106 }
4107 }
4108 else if (VIM_ISDIGIT((int)(*p)))
4109 {
4110 /* size_t could be wider than unsigned int; make sure we
4111 * treat argument like common implementations do */
4112 unsigned int uj = *p++ - '0';
4113
4114 while (VIM_ISDIGIT((int)(*p)))
4115 uj = 10 * uj + (unsigned int)(*p++ - '0');
4116 precision = uj;
4117 }
4118 }
4119
4120 /* parse 'h', 'l' and 'll' length modifiers */
4121 if (*p == 'h' || *p == 'l')
4122 {
4123 length_modifier = *p;
4124 p++;
4125 if (length_modifier == 'l' && *p == 'l')
4126 {
4127 /* double l = long long */
4128 length_modifier = 'l'; /* treat it as a single 'l' */
4129 p++;
4130 }
4131 }
4132 fmt_spec = *p;
4133
4134 /* common synonyms: */
4135 switch (fmt_spec)
4136 {
4137 case 'i': fmt_spec = 'd'; break;
4138 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
4139 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
4140 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004141 case 'F': fmt_spec = 'f'; break;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004142 default: break;
4143 }
4144
4145 /* get parameter value, do initial processing */
4146 switch (fmt_spec)
4147 {
4148 /* '%' and 'c' behave similar to 's' regarding flags and field
4149 * widths */
4150 case '%':
4151 case 'c':
4152 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004153 case 'S':
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004154 length_modifier = '\0';
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004155 str_arg_l = 1;
4156 switch (fmt_spec)
4157 {
4158 case '%':
4159 str_arg = p;
4160 break;
4161
4162 case 'c':
4163 {
4164 int j;
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004165
4166 j =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004167# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004168 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004169# endif
4170 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004171 /* standard demands unsigned char */
4172 uchar_arg = (unsigned char)j;
4173 str_arg = (char *)&uchar_arg;
4174 break;
4175 }
4176
4177 case 's':
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004178 case 'S':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004179 str_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004180# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004181 tvs != NULL ? tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004182# endif
4183 va_arg(ap, char *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004184 if (str_arg == NULL)
4185 {
4186 str_arg = "[NULL]";
4187 str_arg_l = 6;
4188 }
4189 /* make sure not to address string beyond the specified
4190 * precision !!! */
4191 else if (!precision_specified)
4192 str_arg_l = strlen(str_arg);
4193 /* truncate string if necessary as requested by precision */
4194 else if (precision == 0)
4195 str_arg_l = 0;
4196 else
4197 {
Bram Moolenaar223b4312006-05-13 11:09:22 +00004198 /* Don't put the #if inside memchr(), it can be a
4199 * macro. */
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004200# if VIM_SIZEOF_INT <= 2
Bram Moolenaar223b4312006-05-13 11:09:22 +00004201 char *q = memchr(str_arg, '\0', precision);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004202# else
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004203 /* memchr on HP does not like n > 2^31 !!! */
4204 char *q = memchr(str_arg, '\0',
Bram Moolenaar223b4312006-05-13 11:09:22 +00004205 precision <= (size_t)0x7fffffffL ? precision
4206 : (size_t)0x7fffffffL);
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004207# endif
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004208 str_arg_l = (q == NULL) ? precision
4209 : (size_t)(q - str_arg);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004210 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004211# ifdef FEAT_MBYTE
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004212 if (fmt_spec == 'S')
4213 {
4214 if (min_field_width != 0)
4215 min_field_width += STRLEN(str_arg)
4216 - mb_string2cells((char_u *)str_arg, -1);
4217 if (precision)
4218 {
4219 char_u *p1 = (char_u *)str_arg;
4220 size_t i;
4221
4222 for (i = 0; i < precision && *p1; i++)
4223 p1 += mb_ptr2len(p1);
4224
4225 str_arg_l = precision = p1 - (char_u *)str_arg;
4226 }
4227 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004228# endif
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004229 break;
4230
4231 default:
4232 break;
4233 }
4234 break;
4235
4236 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p':
4237 {
4238 /* NOTE: the u, o, x, X and p conversion specifiers
4239 * imply the value is unsigned; d implies a signed
4240 * value */
4241
4242 /* 0 if numeric argument is zero (or if pointer is
4243 * NULL for 'p'), +1 if greater than zero (or nonzero
4244 * for unsigned arguments), -1 if negative (unsigned
4245 * argument is never negative) */
4246 int arg_sign = 0;
4247
4248 /* only defined for length modifier h, or for no
4249 * length modifiers */
4250 int int_arg = 0;
4251 unsigned int uint_arg = 0;
4252
4253 /* only defined for length modifier l */
4254 long int long_arg = 0;
4255 unsigned long int ulong_arg = 0;
4256
4257 /* pointer argument value -only defined for p
4258 * conversion */
4259 void *ptr_arg = NULL;
4260
4261 if (fmt_spec == 'p')
4262 {
4263 length_modifier = '\0';
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004264 ptr_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004265# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004266 tvs != NULL ? (void *)tv_str(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004267# endif
4268 va_arg(ap, void *);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004269 if (ptr_arg != NULL)
4270 arg_sign = 1;
4271 }
4272 else if (fmt_spec == 'd')
4273 {
4274 /* signed */
4275 switch (length_modifier)
4276 {
4277 case '\0':
4278 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004279 /* char and short arguments are passed as int. */
4280 int_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004281# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004282 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004283# endif
4284 va_arg(ap, int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004285 if (int_arg > 0)
4286 arg_sign = 1;
4287 else if (int_arg < 0)
4288 arg_sign = -1;
4289 break;
4290 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004291 long_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004292# if defined(FEAT_EVAL)
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004293 tvs != NULL ? tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004294# endif
4295 va_arg(ap, long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004296 if (long_arg > 0)
4297 arg_sign = 1;
4298 else if (long_arg < 0)
4299 arg_sign = -1;
4300 break;
4301 }
4302 }
4303 else
4304 {
4305 /* unsigned */
4306 switch (length_modifier)
4307 {
4308 case '\0':
4309 case 'h':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004310 uint_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004311# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004312 tvs != NULL ? (unsigned)
4313 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004314# endif
4315 va_arg(ap, unsigned int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004316 if (uint_arg != 0)
4317 arg_sign = 1;
4318 break;
4319 case 'l':
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004320 ulong_arg =
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004321# if defined(FEAT_EVAL)
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004322 tvs != NULL ? (unsigned long)
4323 tv_nr(tvs, &arg_idx) :
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004324# endif
4325 va_arg(ap, unsigned long int);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004326 if (ulong_arg != 0)
4327 arg_sign = 1;
4328 break;
4329 }
4330 }
4331
4332 str_arg = tmp;
4333 str_arg_l = 0;
4334
4335 /* NOTE:
4336 * For d, i, u, o, x, and X conversions, if precision is
4337 * specified, the '0' flag should be ignored. This is so
4338 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux,
4339 * FreeBSD, NetBSD; but not with Perl.
4340 */
4341 if (precision_specified)
4342 zero_padding = 0;
4343 if (fmt_spec == 'd')
4344 {
4345 if (force_sign && arg_sign >= 0)
4346 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
4347 /* leave negative numbers for sprintf to handle, to
4348 * avoid handling tricky cases like (short int)-32768 */
4349 }
4350 else if (alternate_form)
4351 {
4352 if (arg_sign != 0
4353 && (fmt_spec == 'x' || fmt_spec == 'X') )
4354 {
4355 tmp[str_arg_l++] = '0';
4356 tmp[str_arg_l++] = fmt_spec;
4357 }
4358 /* alternate form should have no effect for p
4359 * conversion, but ... */
4360 }
4361
4362 zero_padding_insertion_ind = str_arg_l;
4363 if (!precision_specified)
4364 precision = 1; /* default precision is 1 */
4365 if (precision == 0 && arg_sign == 0)
4366 {
4367 /* When zero value is formatted with an explicit
4368 * precision 0, the resulting formatted string is
4369 * empty (d, i, u, o, x, X, p). */
4370 }
4371 else
4372 {
4373 char f[5];
4374 int f_l = 0;
4375
4376 /* construct a simple format string for sprintf */
4377 f[f_l++] = '%';
4378 if (!length_modifier)
4379 ;
4380 else if (length_modifier == '2')
4381 {
4382 f[f_l++] = 'l';
4383 f[f_l++] = 'l';
4384 }
4385 else
4386 f[f_l++] = length_modifier;
4387 f[f_l++] = fmt_spec;
4388 f[f_l++] = '\0';
4389
4390 if (fmt_spec == 'p')
4391 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
4392 else if (fmt_spec == 'd')
4393 {
4394 /* signed */
4395 switch (length_modifier)
4396 {
4397 case '\0':
4398 case 'h': str_arg_l += sprintf(
4399 tmp + str_arg_l, f, int_arg);
4400 break;
4401 case 'l': str_arg_l += sprintf(
4402 tmp + str_arg_l, f, long_arg);
4403 break;
4404 }
4405 }
4406 else
4407 {
4408 /* unsigned */
4409 switch (length_modifier)
4410 {
4411 case '\0':
4412 case 'h': str_arg_l += sprintf(
4413 tmp + str_arg_l, f, uint_arg);
4414 break;
4415 case 'l': str_arg_l += sprintf(
4416 tmp + str_arg_l, f, ulong_arg);
4417 break;
4418 }
4419 }
4420
4421 /* include the optional minus sign and possible
4422 * "0x" in the region before the zero padding
4423 * insertion point */
4424 if (zero_padding_insertion_ind < str_arg_l
4425 && tmp[zero_padding_insertion_ind] == '-')
4426 zero_padding_insertion_ind++;
4427 if (zero_padding_insertion_ind + 1 < str_arg_l
4428 && tmp[zero_padding_insertion_ind] == '0'
4429 && (tmp[zero_padding_insertion_ind + 1] == 'x'
4430 || tmp[zero_padding_insertion_ind + 1] == 'X'))
4431 zero_padding_insertion_ind += 2;
4432 }
4433
4434 {
4435 size_t num_of_digits = str_arg_l
4436 - zero_padding_insertion_ind;
4437
4438 if (alternate_form && fmt_spec == 'o'
4439 /* unless zero is already the first
4440 * character */
4441 && !(zero_padding_insertion_ind < str_arg_l
4442 && tmp[zero_padding_insertion_ind] == '0'))
4443 {
4444 /* assure leading zero for alternate-form
4445 * octal numbers */
4446 if (!precision_specified
4447 || precision < num_of_digits + 1)
4448 {
4449 /* precision is increased to force the
4450 * first character to be zero, except if a
4451 * zero value is formatted with an
4452 * explicit precision of zero */
4453 precision = num_of_digits + 1;
4454 precision_specified = 1;
4455 }
4456 }
4457 /* zero padding to specified precision? */
4458 if (num_of_digits < precision)
4459 number_of_zeros_to_pad = precision - num_of_digits;
4460 }
4461 /* zero padding to specified minimal field width? */
4462 if (!justify_left && zero_padding)
4463 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004464 int n = (int)(min_field_width - (str_arg_l
4465 + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004466 if (n > 0)
4467 number_of_zeros_to_pad += n;
4468 }
4469 break;
4470 }
4471
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004472# ifdef FEAT_FLOAT
Bram Moolenaara7241f52008-06-24 20:39:31 +00004473 case 'f':
4474 case 'e':
4475 case 'E':
4476 case 'g':
4477 case 'G':
4478 {
4479 /* Floating point. */
4480 double f;
4481 double abs_f;
4482 char format[40];
4483 int l;
4484 int remove_trailing_zeroes = FALSE;
4485
4486 f =
Bram Moolenaara7241f52008-06-24 20:39:31 +00004487# if defined(FEAT_EVAL)
4488 tvs != NULL ? tv_float(tvs, &arg_idx) :
4489# endif
4490 va_arg(ap, double);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004491 abs_f = f < 0 ? -f : f;
4492
4493 if (fmt_spec == 'g' || fmt_spec == 'G')
4494 {
4495 /* Would be nice to use %g directly, but it prints
4496 * "1.0" as "1", we don't want that. */
4497 if ((abs_f >= 0.001 && abs_f < 10000000.0)
4498 || abs_f == 0.0)
4499 fmt_spec = 'f';
4500 else
4501 fmt_spec = fmt_spec == 'g' ? 'e' : 'E';
4502 remove_trailing_zeroes = TRUE;
4503 }
4504
Bram Moolenaarc9372132009-01-13 15:38:37 +00004505 if (fmt_spec == 'f' &&
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004506# ifdef VAX
Bram Moolenaarc9372132009-01-13 15:38:37 +00004507 abs_f > 1.0e38
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004508# else
Bram Moolenaarc9372132009-01-13 15:38:37 +00004509 abs_f > 1.0e307
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004510# endif
Bram Moolenaarc9372132009-01-13 15:38:37 +00004511 )
Bram Moolenaara7241f52008-06-24 20:39:31 +00004512 {
4513 /* Avoid a buffer overflow */
4514 strcpy(tmp, "inf");
4515 str_arg_l = 3;
4516 }
4517 else
4518 {
4519 format[0] = '%';
4520 l = 1;
4521 if (precision_specified)
4522 {
4523 size_t max_prec = TMP_LEN - 10;
4524
4525 /* Make sure we don't get more digits than we
4526 * have room for. */
4527 if (fmt_spec == 'f' && abs_f > 1.0)
4528 max_prec -= (size_t)log10(abs_f);
4529 if (precision > max_prec)
4530 precision = max_prec;
4531 l += sprintf(format + 1, ".%d", (int)precision);
4532 }
4533 format[l] = fmt_spec;
4534 format[l + 1] = NUL;
4535 str_arg_l = sprintf(tmp, format, f);
4536
4537 if (remove_trailing_zeroes)
4538 {
4539 int i;
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004540 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004541
4542 /* Using %g or %G: remove superfluous zeroes. */
4543 if (fmt_spec == 'f')
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004544 tp = tmp + str_arg_l - 1;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004545 else
4546 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004547 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004548 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004549 if (tp != NULL)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004550 {
4551 /* Remove superfluous '+' and leading
4552 * zeroes from the exponent. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004553 if (tp[1] == '+')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004554 {
4555 /* Change "1.0e+07" to "1.0e07" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004556 STRMOVE(tp + 1, tp + 2);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004557 --str_arg_l;
4558 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004559 i = (tp[1] == '-') ? 2 : 1;
4560 while (tp[i] == '0')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004561 {
4562 /* Change "1.0e07" to "1.0e7" */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004563 STRMOVE(tp + i, tp + i + 1);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004564 --str_arg_l;
4565 }
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004566 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004567 }
4568 }
4569
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004570 if (tp != NULL && !precision_specified)
Bram Moolenaara7241f52008-06-24 20:39:31 +00004571 /* Remove trailing zeroes, but keep the one
4572 * just after a dot. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004573 while (tp > tmp + 2 && *tp == '0'
4574 && tp[-1] != '.')
Bram Moolenaara7241f52008-06-24 20:39:31 +00004575 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004576 STRMOVE(tp, tp + 1);
4577 --tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004578 --str_arg_l;
4579 }
4580 }
4581 else
4582 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004583 char *tp;
Bram Moolenaara7241f52008-06-24 20:39:31 +00004584
4585 /* Be consistent: some printf("%e") use 1.0e+12
4586 * and some 1.0e+012. Remove one zero in the last
4587 * case. */
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004588 tp = (char *)vim_strchr((char_u *)tmp,
Bram Moolenaara7241f52008-06-24 20:39:31 +00004589 fmt_spec == 'e' ? 'e' : 'E');
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004590 if (tp != NULL && (tp[1] == '+' || tp[1] == '-')
4591 && tp[2] == '0'
4592 && vim_isdigit(tp[3])
4593 && vim_isdigit(tp[4]))
Bram Moolenaara7241f52008-06-24 20:39:31 +00004594 {
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00004595 STRMOVE(tp + 2, tp + 3);
Bram Moolenaara7241f52008-06-24 20:39:31 +00004596 --str_arg_l;
4597 }
4598 }
4599 }
4600 str_arg = tmp;
4601 break;
4602 }
Bram Moolenaar92b8b2d2016-01-29 22:36:45 +01004603# endif
Bram Moolenaara7241f52008-06-24 20:39:31 +00004604
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004605 default:
4606 /* unrecognized conversion specifier, keep format string
4607 * as-is */
4608 zero_padding = 0; /* turn zero padding off for non-numeric
Bram Moolenaarf1dc4962007-05-10 16:50:23 +00004609 conversion */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004610 justify_left = 1;
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004611 min_field_width = 0; /* reset flags */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004612
4613 /* discard the unrecognized conversion, just keep *
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004614 * the unrecognized conversion character */
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004615 str_arg = p;
4616 str_arg_l = 0;
4617 if (*p != NUL)
4618 str_arg_l++; /* include invalid conversion specifier
4619 unchanged if not at end-of-string */
4620 break;
4621 }
4622
4623 if (*p != NUL)
4624 p++; /* step over the just processed conversion specifier */
4625
4626 /* insert padding to the left as requested by min_field_width;
4627 * this does not include the zero padding in case of numerical
4628 * conversions*/
4629 if (!justify_left)
4630 {
4631 /* left padding with blank or zero */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004632 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004633
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004634 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004635 {
4636 if (str_l < str_m)
4637 {
4638 size_t avail = str_m - str_l;
4639
4640 vim_memset(str + str_l, zero_padding ? '0' : ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004641 (size_t)pn > avail ? avail
4642 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004643 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004644 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004645 }
4646 }
4647
4648 /* zero padding as requested by the precision or by the minimal
4649 * field width for numeric conversions required? */
Bram Moolenaarea424162005-06-16 21:51:00 +00004650 if (number_of_zeros_to_pad == 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004651 {
4652 /* will not copy first part of numeric right now, *
4653 * force it to be copied later in its entirety */
4654 zero_padding_insertion_ind = 0;
4655 }
4656 else
4657 {
4658 /* insert first part of numerics (sign or '0x') before zero
4659 * padding */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004660 int zn = (int)zero_padding_insertion_ind;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004661
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004662 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004663 {
4664 if (str_l < str_m)
4665 {
4666 size_t avail = str_m - str_l;
4667
4668 mch_memmove(str + str_l, str_arg,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004669 (size_t)zn > avail ? avail
4670 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004671 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004672 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004673 }
4674
4675 /* insert zero padding as requested by the precision or min
4676 * field width */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004677 zn = (int)number_of_zeros_to_pad;
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004678 if (zn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004679 {
4680 if (str_l < str_m)
4681 {
4682 size_t avail = str_m-str_l;
4683
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004684 vim_memset(str + str_l, '0',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004685 (size_t)zn > avail ? avail
4686 : (size_t)zn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004687 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004688 str_l += zn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004689 }
4690 }
4691
4692 /* insert formatted string
4693 * (or as-is conversion specifier for unknown conversions) */
4694 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004695 int sn = (int)(str_arg_l - zero_padding_insertion_ind);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004696
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004697 if (sn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004698 {
4699 if (str_l < str_m)
4700 {
4701 size_t avail = str_m - str_l;
4702
4703 mch_memmove(str + str_l,
4704 str_arg + zero_padding_insertion_ind,
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004705 (size_t)sn > avail ? avail : (size_t)sn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004706 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004707 str_l += sn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004708 }
4709 }
4710
4711 /* insert right padding */
4712 if (justify_left)
4713 {
4714 /* right blank padding to the field width */
Bram Moolenaara7241f52008-06-24 20:39:31 +00004715 int pn = (int)(min_field_width
4716 - (str_arg_l + number_of_zeros_to_pad));
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004717
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004718 if (pn > 0)
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004719 {
4720 if (str_l < str_m)
4721 {
4722 size_t avail = str_m - str_l;
4723
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004724 vim_memset(str + str_l, ' ',
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00004725 (size_t)pn > avail ? avail
4726 : (size_t)pn);
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004727 }
Bram Moolenaar686f51e2005-05-20 21:19:57 +00004728 str_l += pn;
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004729 }
4730 }
4731 }
4732 }
4733
4734 if (str_m > 0)
4735 {
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004736 /* make sure the string is nul-terminated even at the expense of
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004737 * overwriting the last character (shouldn't happen, but just in case)
4738 * */
4739 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
4740 }
4741
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00004742 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004743 EMSG(_("E767: Too many arguments to printf()"));
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004744
Bram Moolenaar63b3ce82005-07-22 21:46:50 +00004745 /* Return the number of characters formatted (excluding trailing nul
Bram Moolenaar9c13b352005-05-19 20:53:52 +00004746 * character), that is, the number of characters that would have been
4747 * written to the buffer if it were large enough. */
4748 return (int)str_l;
4749}
4750
4751#endif /* PROTO */