blob: 64d14aedd2a566199d99d4c14a746b9fc8bd6e0b [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 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +000031#ifdef FEAT_AUTOCMD
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010032static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000033#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000034static int
35#ifdef __BORLANDC__
36 _RTLENTRYF
37#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010038 help_compare(const void *s1, const void *s2);
39static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040
41/*
42 * ":ascii" and "ga".
43 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010045do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000046{
47 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000048 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000049 char buf1[20];
50 char buf2[20];
51 char_u buf3[7];
52#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
60#endif
61 c = gchar_cursor();
62 if (c == NUL)
63 {
64 MSG("NUL");
65 return;
66 }
67
68#ifdef FEAT_MBYTE
69 IObuff[0] = NUL;
70 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
71#endif
72 {
73 if (c == NL) /* NUL is stored as NL */
74 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000075 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
76 cval = NL; /* NL is stored as CR */
77 else
78 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 if (vim_isprintc_strict(c) && (c < ' '
80#ifndef EBCDIC
81 || c > '~'
82#endif
83 ))
84 {
85 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000086 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 }
88 else
89 buf1[0] = NUL;
90#ifndef EBCDIC
91 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000092 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
93 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 else
95#endif
96 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +000097 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000099 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000101 if (enc_utf8)
102 c = cc[ci++];
103 else
104 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105#endif
106 }
107
108#ifdef FEAT_MBYTE
109 /* Repeat for combining characters. */
110 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
111 {
112 len = (int)STRLEN(IObuff);
113 /* This assumes every multi-byte char is printable... */
114 if (len > 0)
115 IObuff[len++] = ' ';
116 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000117 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000118# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 )
122 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000123 len += (*mb_char2bytes)(c, IObuff + len);
124 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
126 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000127 if (ci == MAX_MCO)
128 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000129 if (enc_utf8)
130 c = cc[ci++];
131 else
132 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 }
134#endif
135
136 msg(IObuff);
137}
138
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139/*
140 * ":left", ":center" and ":right": align text.
141 */
142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100143ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
151
152#ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
154 {
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
160 }
161#endif
162
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 {
167 if (width >= 0)
168 indent = width;
169 }
170 else
171 {
172 /*
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
176 */
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
180 width = W_WIDTH(curwin) - curbuf->b_p_wm;
181 if (width <= 0)
182 width = 80;
183 }
184
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
187
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 {
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
194 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000195 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
198
199 if (len <= 0) /* skip blank lines */
200 continue;
201
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
205 {
206 new_indent = width - len; /* right align */
207
208 /*
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
211 */
212 if (has_tab)
213 while (new_indent > 0)
214 {
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
217 {
218 /*
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
221 */
222 do
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
227 }
228 --new_indent;
229 }
230 }
231 }
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
235 }
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
239}
240
241/*
242 * Get the length of the current line, excluding trailing white space.
243 */
244 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100245linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246{
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
252
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
256
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
259 last > first && vim_iswhite(last[-1]); --last)
260 ;
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
267
268 return len;
269}
270
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000271/* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273static char_u *sortbuf1;
274static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000275
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100276static int sort_ic; /* ignore case */
277static int sort_nr; /* sort on number */
278static int sort_rx; /* sort on regex instead of skipping it */
279#ifdef FEAT_FLOAT
280static int sort_flt; /* sort on floating number */
281#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100283static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000284
285/* Struct to store info to be sorted. */
286typedef struct
287{
288 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100289 union {
290 struct
291 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200292 varnumber_T start_col_nr; /* starting column number */
293 varnumber_T end_col_nr; /* ending column number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294 } line;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200295 varnumber_T value; /* value if sorting by integer */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100296#ifdef FEAT_FLOAT
297 float_T value_flt; /* value if sorting by float */
298#endif
299 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000300} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000301
302static int
303#ifdef __BORLANDC__
304_RTLENTRYF
305#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100306sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000307
308 static int
309#ifdef __BORLANDC__
310_RTLENTRYF
311#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100312sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000314 sorti_T l1 = *(sorti_T *)s1;
315 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000316 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000317
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000318 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000319 * if we return 0 every time, qsort will assume it's done sorting and
320 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000321 if (sort_abort)
322 return 0;
323 fast_breakcheck();
324 if (got_int)
325 sort_abort = TRUE;
326
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000327 /* When sorting numbers "start_col_nr" is the number, not the column
328 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100330 result = l1.st_u.value == l2.st_u.value ? 0
331 : l1.st_u.value > l2.st_u.value ? 1 : -1;
332#ifdef FEAT_FLOAT
333 else if (sort_flt)
334 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
335 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
336#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 else
338 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000339 /* We need to copy one line into "sortbuf1", because there is no
340 * guarantee that the first pointer becomes invalid when obtaining the
341 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100342 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
343 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
344 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
345 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
346 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
347 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000348
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000349 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
350 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000351 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000352
353 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000354 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000355 return (int)(l1.lnum - l2.lnum);
356 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000357}
358
359/*
360 * ":sort".
361 */
362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100363ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000364{
365 regmatch_T regmatch;
366 int len;
367 linenr_T lnum;
368 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000369 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000370 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000371 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000372 char_u *p;
373 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000374 char_u *s2;
375 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000376 int unique = FALSE;
377 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000378 colnr_T start_col;
379 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100380 int sort_what = 0;
381 int format_found = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382
Bram Moolenaar48c99162008-02-18 18:42:52 +0000383 /* Sorting one line is really quick! */
384 if (count <= 1)
385 return;
386
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
388 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000389 sortbuf1 = NULL;
390 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000391 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000392 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000393 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000394 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100396 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100397#ifdef FEAT_FLOAT
398 sort_flt = 0;
399#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000400
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401 for (p = eap->arg; *p != NUL; ++p)
402 {
403 if (vim_iswhite(*p))
404 ;
405 else if (*p == 'i')
406 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000407 else if (*p == 'r')
408 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000409 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100410 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100411 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100412 ++format_found;
413 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100414#ifdef FEAT_FLOAT
415 else if (*p == 'f')
416 {
417 sort_flt = 1;
418 ++format_found;
419 }
420#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100421 else if (*p == 'b')
422 {
423 sort_what = STR2NR_BIN + STR2NR_FORCE;
424 ++format_found;
425 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000426 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100427 {
428 sort_what = STR2NR_OCT + STR2NR_FORCE;
429 ++format_found;
430 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000431 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100432 {
433 sort_what = STR2NR_HEX + STR2NR_FORCE;
434 ++format_found;
435 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000436 else if (*p == 'u')
437 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000438 else if (*p == '"') /* comment start */
439 break;
440 else if (check_nextcmd(p) != NULL)
441 {
442 eap->nextcmd = check_nextcmd(p);
443 break;
444 }
445 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000446 {
447 s = skip_regexp(p + 1, *p, TRUE, NULL);
448 if (*s != *p)
449 {
450 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000451 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000452 }
453 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000454 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100455 if (s == p + 1)
456 {
457 if (last_search_pat() == NULL)
458 {
459 EMSG(_(e_noprevre));
460 goto sortend;
461 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000462 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100463 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000464 else
465 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000466 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000468 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000469 regmatch.rm_ic = p_ic;
470 }
471 else
472 {
473 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000475 }
476 }
477
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100478 /* Can only have one of 'n', 'b', 'o' and 'x'. */
479 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000480 {
481 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000482 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000483 }
484
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100485 /* From here on "sort_nr" is used as a flag for any integer number
486 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100487 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000488
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000489 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000491 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000492 * When sorting on strings "start_col_nr" is the offset in the line, for
493 * numbers sorting it's the number to sort on. This means the pattern
494 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 */
497 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
498 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000499 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000500 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 if (maxlen < len)
502 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000503
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 start_col = 0;
505 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000506 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000507 {
508 if (sort_rx)
509 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000510 start_col = (colnr_T)(regmatch.startp[0] - s);
511 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000512 }
513 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000514 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000516 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 if (regmatch.regprog != NULL)
518 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000519
Bram Moolenaar937204a2016-01-30 23:37:38 +0100520 if (sort_nr
521#ifdef FEAT_FLOAT
522 || sort_flt
523#endif
524 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 /* Make sure vim_str2nr doesn't read any digits past the end
527 * of the match, by temporarily terminating the string there */
528 s2 = s + end_col;
529 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200530 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000531 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000532 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100533 if (sort_nr)
534 {
535 if (sort_what & STR2NR_HEX)
536 s = skiptohex(p);
537 else if (sort_what & STR2NR_BIN)
538 s = skiptobin(p);
539 else
540 s = skiptodigit(p);
541 if (s > p && s[-1] == '-')
542 --s; /* include preceding negative sign */
543 if (*s == NUL)
544 /* empty line should sort before any number */
545 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
546 else
547 vim_str2nr(s, NULL, NULL, sort_what,
548 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
549 }
550#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000551 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 {
553 s = skipwhite(p);
554 if (*s == '+')
555 s = skipwhite(s + 1);
556
557 if (*s == NUL)
558 /* empty line should sort before any number */
559 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
560 else
561 nrs[lnum - eap->line1].st_u.value_flt =
562 strtod((char *)s, NULL);
563 }
564#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200565 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000566 }
567 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000568 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000569 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100570 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
571 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000572 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000573
574 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000575
576 if (regmatch.regprog != NULL)
577 fast_breakcheck();
578 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000579 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000580 }
581
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000583 sortbuf1 = alloc((unsigned)maxlen + 1);
584 if (sortbuf1 == NULL)
585 goto sortend;
586 sortbuf2 = alloc((unsigned)maxlen + 1);
587 if (sortbuf2 == NULL)
588 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000589
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000590 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000592
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 if (sort_abort)
594 goto sortend;
595
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000596 /* Insert the lines in the sorted order below the last one. */
597 lnum = eap->line2;
598 for (i = 0; i < count; ++i)
599 {
600 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
601 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603 {
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100604 /* Copy the line into a buffer, it may become invalid in
605 * ml_append(). And it's needed for "unique". */
606 STRCPY(sortbuf1, s);
607 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000609 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000610 fast_breakcheck();
611 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000612 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000613 }
614
615 /* delete the original lines if appending worked */
616 if (i == count)
617 for (i = 0; i < count; ++i)
618 ml_delete(eap->line1, FALSE);
619 else
620 count = 0;
621
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000622 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000623 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 if (deleted > 0)
625 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
626 else if (deleted < 0)
627 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
628 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000629
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 curwin->w_cursor.lnum = eap->line1;
631 beginline(BL_WHITE | BL_FIX);
632
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000635 vim_free(sortbuf1);
636 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200637 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000638 if (got_int)
639 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640}
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642/*
643 * ":retab".
644 */
645 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100646ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647{
648 linenr_T lnum;
649 int got_tab = FALSE;
650 long num_spaces = 0;
651 long num_tabs;
652 long len;
653 long col;
654 long vcol;
655 long start_col = 0; /* For start of white-space string */
656 long start_vcol = 0; /* For start of white-space string */
657 int temp;
658 long old_len;
659 char_u *ptr;
660 char_u *new_line = (char_u *)1; /* init to non-NULL */
661 int did_undo; /* called u_save for current line */
662 int new_ts;
663 int save_list;
664 linenr_T first_line = 0; /* first changed line */
665 linenr_T last_line = 0; /* last changed line */
666
667 save_list = curwin->w_p_list;
668 curwin->w_p_list = 0; /* don't want list mode here */
669
670 new_ts = getdigits(&(eap->arg));
671 if (new_ts < 0)
672 {
673 EMSG(_(e_positive));
674 return;
675 }
676 if (new_ts == 0)
677 new_ts = curbuf->b_p_ts;
678 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
679 {
680 ptr = ml_get(lnum);
681 col = 0;
682 vcol = 0;
683 did_undo = FALSE;
684 for (;;)
685 {
686 if (vim_iswhite(ptr[col]))
687 {
688 if (!got_tab && num_spaces == 0)
689 {
690 /* First consecutive white-space */
691 start_vcol = vcol;
692 start_col = col;
693 }
694 if (ptr[col] == ' ')
695 num_spaces++;
696 else
697 got_tab = TRUE;
698 }
699 else
700 {
701 if (got_tab || (eap->forceit && num_spaces > 1))
702 {
703 /* Retabulate this string of white-space */
704
705 /* len is virtual length of white string */
706 len = num_spaces = vcol - start_vcol;
707 num_tabs = 0;
708 if (!curbuf->b_p_et)
709 {
710 temp = new_ts - (start_vcol % new_ts);
711 if (num_spaces >= temp)
712 {
713 num_spaces -= temp;
714 num_tabs++;
715 }
716 num_tabs += num_spaces / new_ts;
717 num_spaces -= (num_spaces / new_ts) * new_ts;
718 }
719 if (curbuf->b_p_et || got_tab ||
720 (num_spaces + num_tabs < len))
721 {
722 if (did_undo == FALSE)
723 {
724 did_undo = TRUE;
725 if (u_save((linenr_T)(lnum - 1),
726 (linenr_T)(lnum + 1)) == FAIL)
727 {
728 new_line = NULL; /* flag out-of-memory */
729 break;
730 }
731 }
732
733 /* len is actual number of white characters used */
734 len = num_spaces + num_tabs;
735 old_len = (long)STRLEN(ptr);
736 new_line = lalloc(old_len - col + start_col + len + 1,
737 TRUE);
738 if (new_line == NULL)
739 break;
740 if (start_col > 0)
741 mch_memmove(new_line, ptr, (size_t)start_col);
742 mch_memmove(new_line + start_col + len,
743 ptr + col, (size_t)(old_len - col + 1));
744 ptr = new_line + start_col;
745 for (col = 0; col < len; col++)
746 ptr[col] = (col < num_tabs) ? '\t' : ' ';
747 ml_replace(lnum, new_line, FALSE);
748 if (first_line == 0)
749 first_line = lnum;
750 last_line = lnum;
751 ptr = new_line;
752 col = start_col + len;
753 }
754 }
755 got_tab = FALSE;
756 num_spaces = 0;
757 }
758 if (ptr[col] == NUL)
759 break;
760 vcol += chartabsize(ptr + col, (colnr_T)vcol);
761#ifdef FEAT_MBYTE
762 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000763 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 else
765#endif
766 ++col;
767 }
768 if (new_line == NULL) /* out of memory */
769 break;
770 line_breakcheck();
771 }
772 if (got_int)
773 EMSG(_(e_interr));
774
775 if (curbuf->b_p_ts != new_ts)
776 redraw_curbuf_later(NOT_VALID);
777 if (first_line != 0)
778 changed_lines(first_line, 0, last_line + 1, 0L);
779
780 curwin->w_p_list = save_list; /* restore 'list' */
781
782 curbuf->b_p_ts = new_ts;
783 coladvance(curwin->w_curswant);
784
785 u_clearline();
786}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788/*
789 * :move command - move lines line1-line2 to line dest
790 *
791 * return FAIL for failure, OK otherwise
792 */
793 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100794do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795{
796 char_u *str;
797 linenr_T l;
798 linenr_T extra; /* Num lines added before line1 */
799 linenr_T num_lines; /* Num lines moved */
800 linenr_T last_line; /* Last line in file after adding new text */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200801#ifdef FEAT_FOLDING
802 int isFolded;
803
804 /* Moving lines seems to corrupt the folds, delete folding info now
805 * and recreate it when finished. Don't do this for manual folding, it
806 * would delete all folds. */
807 isFolded = hasAnyFolding(curwin) && !foldmethodIsManual(curwin);
808 if (isFolded)
809 deleteFoldRecurse(&curwin->w_folds);
810#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812 if (dest >= line1 && dest < line2)
813 {
814 EMSG(_("E134: Move lines into themselves"));
815 return FAIL;
816 }
817
818 num_lines = line2 - line1 + 1;
819
820 /*
821 * First we copy the old text to its new location -- webb
822 * Also copy the flag that ":global" command uses.
823 */
824 if (u_save(dest, dest + 1) == FAIL)
825 return FAIL;
826 for (extra = 0, l = line1; l <= line2; l++)
827 {
828 str = vim_strsave(ml_get(l + extra));
829 if (str != NULL)
830 {
831 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
832 vim_free(str);
833 if (dest < line1)
834 extra++;
835 }
836 }
837
838 /*
839 * Now we must be careful adjusting our marks so that we don't overlap our
840 * mark_adjust() calls.
841 *
842 * We adjust the marks within the old text so that they refer to the
843 * last lines of the file (temporarily), because we know no other marks
844 * will be set there since these line numbers did not exist until we added
845 * our new lines.
846 *
847 * Then we adjust the marks on lines between the old and new text positions
848 * (either forwards or backwards).
849 *
850 * And Finally we adjust the marks we put at the end of the file back to
851 * their final destination at the new text position -- webb
852 */
853 last_line = curbuf->b_ml.ml_line_count;
854 mark_adjust(line1, line2, last_line - line2, 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200855 changed_lines(last_line - num_lines + 1, 0, last_line + 1, num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (dest >= line2)
857 {
858 mark_adjust(line2 + 1, dest, -num_lines, 0L);
859 curbuf->b_op_start.lnum = dest - num_lines + 1;
860 curbuf->b_op_end.lnum = dest;
861 }
862 else
863 {
864 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
865 curbuf->b_op_start.lnum = dest + 1;
866 curbuf->b_op_end.lnum = dest + num_lines;
867 }
868 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
869 mark_adjust(last_line - num_lines + 1, last_line,
870 -(last_line - dest - extra), 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200871 changed_lines(last_line - num_lines + 1, 0, last_line + 1, -extra);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 /*
874 * Now we delete the original text -- webb
875 */
876 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
877 return FAIL;
878
879 for (l = line1; l <= line2; l++)
880 ml_delete(line1 + extra, TRUE);
881
882 if (!global_busy && num_lines > p_report)
883 {
884 if (num_lines == 1)
885 MSG(_("1 line moved"));
886 else
887 smsg((char_u *)_("%ld lines moved"), num_lines);
888 }
889
890 /*
891 * Leave the cursor on the last of the moved lines.
892 */
893 if (dest >= line1)
894 curwin->w_cursor.lnum = dest;
895 else
896 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
897
898 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100899 {
900 dest += num_lines + 1;
901 last_line = curbuf->b_ml.ml_line_count;
902 if (dest > last_line + 1)
903 dest = last_line + 1;
904 changed_lines(line1, 0, dest, 0L);
905 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 else
907 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
908
Bram Moolenaard5f69332015-04-15 12:43:50 +0200909#ifdef FEAT_FOLDING
910 /* recreate folds */
911 if (isFolded)
912 foldUpdateAll(curwin);
913#endif
914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 return OK;
916}
917
918/*
919 * ":copy"
920 */
921 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100922ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923{
924 linenr_T count;
925 char_u *p;
926
927 count = line2 - line1 + 1;
928 curbuf->b_op_start.lnum = n + 1;
929 curbuf->b_op_end.lnum = n + count;
930 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
931
932 /*
933 * there are three situations:
934 * 1. destination is above line1
935 * 2. destination is between line1 and line2
936 * 3. destination is below line2
937 *
938 * n = destination (when starting)
939 * curwin->w_cursor.lnum = destination (while copying)
940 * line1 = start of source (while copying)
941 * line2 = end of source (while copying)
942 */
943 if (u_save(n, n + 1) == FAIL)
944 return;
945
946 curwin->w_cursor.lnum = n;
947 while (line1 <= line2)
948 {
949 /* need to use vim_strsave() because the line will be unlocked within
950 * ml_append() */
951 p = vim_strsave(ml_get(line1));
952 if (p != NULL)
953 {
954 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
955 vim_free(p);
956 }
957 /* situation 2: skip already copied lines */
958 if (line1 == n)
959 line1 = curwin->w_cursor.lnum;
960 ++line1;
961 if (curwin->w_cursor.lnum < line1)
962 ++line1;
963 if (curwin->w_cursor.lnum < line2)
964 ++line2;
965 ++curwin->w_cursor.lnum;
966 }
967
968 appended_lines_mark(n, count);
969
970 msgmore((long)count);
971}
972
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000973static char_u *prevcmd = NULL; /* the previous command */
974
975#if defined(EXITFREE) || defined(PROTO)
976 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100977free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000978{
979 vim_free(prevcmd);
980}
981#endif
982
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983/*
984 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
985 * Bangs in the argument are replaced with the previously entered command.
986 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 */
988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100989do_bang(
990 int addr_count,
991 exarg_T *eap,
992 int forceit,
993 int do_in,
994 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995{
996 char_u *arg = eap->arg; /* command */
997 linenr_T line1 = eap->line1; /* start of range */
998 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 char_u *newcmd = NULL; /* the new command */
1000 int free_newcmd = FALSE; /* need to free() newcmd */
1001 int ins_prevcmd;
1002 char_u *t;
1003 char_u *p;
1004 char_u *trailarg;
1005 int len;
1006 int scroll_save = msg_scroll;
1007
1008 /*
1009 * Disallow shell commands for "rvim".
1010 * Disallow shell commands from .exrc and .vimrc in current directory for
1011 * security reasons.
1012 */
1013 if (check_restricted() || check_secure())
1014 return;
1015
1016 if (addr_count == 0) /* :! */
1017 {
1018 msg_scroll = FALSE; /* don't scroll here */
1019 autowrite_all();
1020 msg_scroll = scroll_save;
1021 }
1022
1023 /*
1024 * Try to find an embedded bang, like in :!<cmd> ! [args]
1025 * (:!! is indicated by the 'forceit' variable)
1026 */
1027 ins_prevcmd = forceit;
1028 trailarg = arg;
1029 do
1030 {
1031 len = (int)STRLEN(trailarg) + 1;
1032 if (newcmd != NULL)
1033 len += (int)STRLEN(newcmd);
1034 if (ins_prevcmd)
1035 {
1036 if (prevcmd == NULL)
1037 {
1038 EMSG(_(e_noprev));
1039 vim_free(newcmd);
1040 return;
1041 }
1042 len += (int)STRLEN(prevcmd);
1043 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001044 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 {
1046 vim_free(newcmd);
1047 return;
1048 }
1049 *t = NUL;
1050 if (newcmd != NULL)
1051 STRCAT(t, newcmd);
1052 if (ins_prevcmd)
1053 STRCAT(t, prevcmd);
1054 p = t + STRLEN(t);
1055 STRCAT(t, trailarg);
1056 vim_free(newcmd);
1057 newcmd = t;
1058
1059 /*
1060 * Scan the rest of the argument for '!', which is replaced by the
1061 * previous command. "\!" is replaced by "!" (this is vi compatible).
1062 */
1063 trailarg = NULL;
1064 while (*p)
1065 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001066 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 {
1068 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001069 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 else
1071 {
1072 trailarg = p;
1073 *trailarg++ = NUL;
1074 ins_prevcmd = TRUE;
1075 break;
1076 }
1077 }
1078 ++p;
1079 }
1080 } while (trailarg != NULL);
1081
1082 vim_free(prevcmd);
1083 prevcmd = newcmd;
1084
1085 if (bangredo) /* put cmd in redo buffer for ! command */
1086 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001087 /* If % or # appears in the command, it must have been escaped.
1088 * Reescape them, so that redoing them does not substitute them by the
1089 * buffername. */
1090 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1091
1092 if (cmd != NULL)
1093 {
1094 AppendToRedobuffLit(cmd, -1);
1095 vim_free(cmd);
1096 }
1097 else
1098 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 AppendToRedobuff((char_u *)"\n");
1100 bangredo = FALSE;
1101 }
1102 /*
1103 * Add quotes around the command, for shells that need them.
1104 */
1105 if (*p_shq != NUL)
1106 {
1107 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1108 if (newcmd == NULL)
1109 return;
1110 STRCPY(newcmd, p_shq);
1111 STRCAT(newcmd, prevcmd);
1112 STRCAT(newcmd, p_shq);
1113 free_newcmd = TRUE;
1114 }
1115 if (addr_count == 0) /* :! */
1116 {
1117 /* echo the command */
1118 msg_start();
1119 msg_putchar(':');
1120 msg_putchar('!');
1121 msg_outtrans(newcmd);
1122 msg_clr_eos();
1123 windgoto(msg_row, msg_col);
1124
1125 do_shell(newcmd, 0);
1126 }
1127 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001128 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 /* Careful: This may recursively call do_bang() again! (because of
1130 * autocommands) */
1131 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001132#ifdef FEAT_AUTOCMD
1133 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1134#endif
1135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 if (free_newcmd)
1137 vim_free(newcmd);
1138}
1139
1140/*
1141 * do_filter: filter lines through a command given by the user
1142 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001143 * We mostly use temp files and the call_shell() routine here. This would
1144 * normally be done using pipes on a UNIX machine, but this is more portable
1145 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 * to deal with redirection somehow, and should handle things like looking
1147 * at the PATH env. variable, and adding reasonable extensions to the
1148 * command name given by the user. All reasonable versions of call_shell()
1149 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001150 * Alternatively, if on Unix and redirecting input or output, but not both,
1151 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 * We use input redirection if do_in is TRUE.
1153 * We use output redirection if do_out is TRUE.
1154 */
1155 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001156do_filter(
1157 linenr_T line1,
1158 linenr_T line2,
1159 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1160 char_u *cmd,
1161 int do_in,
1162 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163{
1164 char_u *itmp = NULL;
1165 char_u *otmp = NULL;
1166 linenr_T linecount;
1167 linenr_T read_linecount;
1168 pos_T cursor_save;
1169 char_u *cmd_buf;
1170#ifdef FEAT_AUTOCMD
1171 buf_T *old_curbuf = curbuf;
1172#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001173 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174
1175 if (*cmd == NUL) /* no filter command */
1176 return;
1177
1178#ifdef WIN3264
1179 /*
1180 * Check if external commands are allowed now.
1181 */
1182 if (can_end_termcap_mode(TRUE) == FALSE)
1183 return;
1184#endif
1185
1186 cursor_save = curwin->w_cursor;
1187 linecount = line2 - line1 + 1;
1188 curwin->w_cursor.lnum = line1;
1189 curwin->w_cursor.col = 0;
1190 changed_line_abv_curs();
1191 invalidate_botline();
1192
1193 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001194 * When using temp files:
1195 * 1. * Form temp file names
1196 * 2. * Write the lines to a temp file
1197 * 3. Run the filter command on the temp file
1198 * 4. * Read the output of the command into the buffer
1199 * 5. * Delete the original lines to be filtered
1200 * 6. * Remove the temp files
1201 *
1202 * When writing the input with a pipe or when catching the output with a
1203 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 */
1205
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 if (do_out)
1207 shell_flags |= SHELL_DOOUT;
1208
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001209#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001210 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001212 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1213 shell_flags |= SHELL_READ;
1214 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001216 else if (do_in && !do_out && !p_stmp)
1217 {
1218 /* Use a pipe to write stdin of the command, do not use a temp file. */
1219 shell_flags |= SHELL_WRITE;
1220 curbuf->b_op_start.lnum = line1;
1221 curbuf->b_op_end.lnum = line2;
1222 }
1223 else if (do_in && do_out && !p_stmp)
1224 {
1225 /* Use a pipe to write stdin and fetch stdout of the command, do not
1226 * use a temp file. */
1227 shell_flags |= SHELL_READ|SHELL_WRITE;
1228 curbuf->b_op_start.lnum = line1;
1229 curbuf->b_op_end.lnum = line2;
1230 curwin->w_cursor.lnum = line2;
1231 }
1232 else
1233#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001234 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1235 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 {
1237 EMSG(_(e_notmp));
1238 goto filterend;
1239 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241/*
1242 * The writing and reading of temp files will not be shown.
1243 * Vi also doesn't do this and the messages are not very informative.
1244 */
1245 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001246 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 FALSE, FALSE, FALSE, TRUE) == FAIL)
1248 {
1249 msg_putchar('\n'); /* keep message from buf_write() */
1250 --no_wait_return;
1251#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1252 if (!aborting())
1253#endif
1254 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1255 goto filterend;
1256 }
1257#ifdef FEAT_AUTOCMD
1258 if (curbuf != old_curbuf)
1259 goto filterend;
1260#endif
1261
1262 if (!do_out)
1263 msg_putchar('\n');
1264
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001265 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1267 if (cmd_buf == NULL)
1268 goto filterend;
1269
1270 windgoto((int)Rows - 1, 0);
1271 cursor_on();
1272
1273 /*
1274 * When not redirecting the output the command can write anything to the
1275 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1276 * stderr output of external command. Clear the screen later.
1277 * If do_in is FALSE, this could be something like ":r !cat", which may
1278 * also mess up the screen, clear it later.
1279 */
1280 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1281 redraw_later_clear();
1282
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001283 if (do_out)
1284 {
1285 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001286 {
1287 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001288 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001289 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001290 redraw_curbuf_later(VALID);
1291 }
1292 read_linecount = curbuf->b_ml.ml_line_count;
1293
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 /*
1295 * When call_shell() fails wait_return() is called to give the user a
1296 * chance to read the error messages. Otherwise errors are ignored, so you
1297 * can see the error messages from the command that appear on stdout; use
1298 * 'u' to fix the text
1299 * Switch to cooked mode when not redirecting stdin, avoids that something
1300 * like ":r !cat" hangs.
1301 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1302 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001303 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 {
1305 redraw_later_clear();
1306 wait_return(FALSE);
1307 }
1308 vim_free(cmd_buf);
1309
1310 did_check_timestamps = FALSE;
1311 need_check_timestamps = TRUE;
1312
1313 /* When interrupting the shell command, it may still have produced some
1314 * useful output. Reset got_int here, so that readfile() won't cancel
1315 * reading. */
1316 ui_breakcheck();
1317 got_int = FALSE;
1318
1319 if (do_out)
1320 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001321 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001323 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1324 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001326#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1327 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001329 {
1330 msg_putchar('\n');
1331 EMSG2(_(e_notread), otmp);
1332 }
1333 goto error;
1334 }
1335#ifdef FEAT_AUTOCMD
1336 if (curbuf != old_curbuf)
1337 goto filterend;
1338#endif
1339 }
1340
1341 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1342
1343 if (shell_flags & SHELL_READ)
1344 {
1345 curbuf->b_op_start.lnum = line2 + 1;
1346 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1347 appended_lines_mark(line2, read_linecount);
1348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349
1350 if (do_in)
1351 {
1352 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1353 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 if (read_linecount >= linecount)
1355 /* move all marks from old lines to new lines */
1356 mark_adjust(line1, line2, linecount, 0L);
1357 else
1358 {
1359 /* move marks from old lines to new lines, delete marks
1360 * that are in deleted lines */
1361 mark_adjust(line1, line1 + read_linecount - 1,
1362 linecount, 0L);
1363 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1364 }
1365 }
1366
1367 /*
1368 * Put cursor on first filtered line for ":range!cmd".
1369 * Adjust '[ and '] (set by buf_write()).
1370 */
1371 curwin->w_cursor.lnum = line1;
1372 del_lines(linecount, TRUE);
1373 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1374 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1375 write_lnum_adjust(-linecount); /* adjust last line
1376 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001377#ifdef FEAT_FOLDING
1378 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1379#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 }
1381 else
1382 {
1383 /*
1384 * Put cursor on last new line for ":r !cmd".
1385 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001387 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001389
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1391 --no_wait_return;
1392
1393 if (linecount > p_report)
1394 {
1395 if (do_in)
1396 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001397 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1398 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001401 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 }
1403 else
1404 msgmore((long)linecount);
1405 }
1406 }
1407 else
1408 {
1409error:
1410 /* put cursor back in same position for ":w !cmd" */
1411 curwin->w_cursor = cursor_save;
1412 --no_wait_return;
1413 wait_return(FALSE);
1414 }
1415
1416filterend:
1417
1418#ifdef FEAT_AUTOCMD
1419 if (curbuf != old_curbuf)
1420 {
1421 --no_wait_return;
1422 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1423 }
1424#endif
1425 if (itmp != NULL)
1426 mch_remove(itmp);
1427 if (otmp != NULL)
1428 mch_remove(otmp);
1429 vim_free(itmp);
1430 vim_free(otmp);
1431}
1432
1433/*
1434 * Call a shell to execute a command.
1435 * When "cmd" is NULL start an interactive shell.
1436 */
1437 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001438do_shell(
1439 char_u *cmd,
1440 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441{
1442 buf_T *buf;
1443#ifndef FEAT_GUI_MSWIN
1444 int save_nwr;
1445#endif
1446#ifdef MSWIN
1447 int winstart = FALSE;
1448#endif
1449
1450 /*
1451 * Disallow shell commands for "rvim".
1452 * Disallow shell commands from .exrc and .vimrc in current directory for
1453 * security reasons.
1454 */
1455 if (check_restricted() || check_secure())
1456 {
1457 msg_end();
1458 return;
1459 }
1460
1461#ifdef MSWIN
1462 /*
1463 * Check if external commands are allowed now.
1464 */
1465 if (can_end_termcap_mode(TRUE) == FALSE)
1466 return;
1467
1468 /*
1469 * Check if ":!start" is used.
1470 */
1471 if (cmd != NULL)
1472 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1473#endif
1474
1475 /*
1476 * For autocommands we want to get the output on the current screen, to
1477 * avoid having to type return below.
1478 */
1479 msg_putchar('\r'); /* put cursor at start of line */
1480#ifdef FEAT_AUTOCMD
1481 if (!autocmd_busy)
1482#endif
1483 {
1484#ifdef MSWIN
1485 if (!winstart)
1486#endif
1487 stoptermcap();
1488 }
1489#ifdef MSWIN
1490 if (!winstart)
1491#endif
1492 msg_putchar('\n'); /* may shift screen one line up */
1493
1494 /* warning message before calling the shell */
1495 if (p_warn
1496#ifdef FEAT_AUTOCMD
1497 && !autocmd_busy
1498#endif
1499 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001500 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 if (bufIsChanged(buf))
1502 {
1503#ifdef FEAT_GUI_MSWIN
1504 if (!winstart)
1505 starttermcap(); /* don't want a message box here */
1506#endif
1507 MSG_PUTS(_("[No write since last change]\n"));
1508#ifdef FEAT_GUI_MSWIN
1509 if (!winstart)
1510 stoptermcap();
1511#endif
1512 break;
1513 }
1514
1515 /* This windgoto is required for when the '\n' resulted in a "delete line
1516 * 1" command to the terminal. */
1517 if (!swapping_screen())
1518 windgoto(msg_row, msg_col);
1519 cursor_on();
1520 (void)call_shell(cmd, SHELL_COOKED | flags);
1521 did_check_timestamps = FALSE;
1522 need_check_timestamps = TRUE;
1523
1524 /*
1525 * put the message cursor at the end of the screen, avoids wait_return()
1526 * to overwrite the text that the external command showed
1527 */
1528 if (!swapping_screen())
1529 {
1530 msg_row = Rows - 1;
1531 msg_col = 0;
1532 }
1533
1534#ifdef FEAT_AUTOCMD
1535 if (autocmd_busy)
1536 {
1537 if (msg_silent == 0)
1538 redraw_later_clear();
1539 }
1540 else
1541#endif
1542 {
1543 /*
1544 * For ":sh" there is no need to call wait_return(), just redraw.
1545 * Also for the Win32 GUI (the output is in a console window).
1546 * Otherwise there is probably text on the screen that the user wants
1547 * to read before redrawing, so call wait_return().
1548 */
1549#ifndef FEAT_GUI_MSWIN
1550 if (cmd == NULL
1551# ifdef WIN3264
1552 || (winstart && !need_wait_return)
1553# endif
1554 )
1555 {
1556 if (msg_silent == 0)
1557 redraw_later_clear();
1558 need_wait_return = FALSE;
1559 }
1560 else
1561 {
1562 /*
1563 * If we switch screens when starttermcap() is called, we really
1564 * want to wait for "hit return to continue".
1565 */
1566 save_nwr = no_wait_return;
1567 if (swapping_screen())
1568 no_wait_return = FALSE;
1569# ifdef AMIGA
1570 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1571# else
1572 wait_return(msg_silent == 0);
1573# endif
1574 no_wait_return = save_nwr;
1575 }
1576#endif /* FEAT_GUI_W32 */
1577
1578#ifdef MSWIN
1579 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1580#endif
1581 starttermcap(); /* start termcap if not done by wait_return() */
1582
1583 /*
1584 * In an Amiga window redrawing is caused by asking the window size.
1585 * If we got an interrupt this will not work. The chance that the
1586 * window size is wrong is very small, but we need to redraw the
1587 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1588 * but it saves an extra redraw.
1589 */
1590#ifdef AMIGA
1591 if (skip_redraw) /* ':' hit in wait_return() */
1592 {
1593 if (msg_silent == 0)
1594 redraw_later_clear();
1595 }
1596 else if (term_console)
1597 {
1598 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1599 if (got_int && msg_silent == 0)
1600 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1601 else
1602 must_redraw = 0; /* no extra redraw needed */
1603 }
1604#endif
1605 }
1606
1607 /* display any error messages now */
1608 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001609
1610#ifdef FEAT_AUTOCMD
1611 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1612#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613}
1614
1615/*
1616 * Create a shell command from a command string, input redirection file and
1617 * output redirection file.
1618 * Returns an allocated string with the shell command, or NULL for failure.
1619 */
1620 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001621make_filter_cmd(
1622 char_u *cmd, /* command */
1623 char_u *itmp, /* NULL or name of input file */
1624 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625{
1626 char_u *buf;
1627 long_u len;
1628
Bram Moolenaar53076832015-12-31 19:53:21 +01001629#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001630 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001631 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001632
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001633 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001634 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1635 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001636 if (is_fish_shell)
1637 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1638 else
1639#endif
1640 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 if (itmp != NULL)
1642 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1643 if (otmp != NULL)
1644 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1645 buf = lalloc(len, TRUE);
1646 if (buf == NULL)
1647 return NULL;
1648
Bram Moolenaar53076832015-12-31 19:53:21 +01001649#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001651 * Put braces around the command (for concatenated commands) when
1652 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001654 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001655 {
1656 if (is_fish_shell)
1657 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1658 else
1659 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1660 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001661 else
1662 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 if (itmp != NULL)
1664 {
1665 STRCAT(buf, " < ");
1666 STRCAT(buf, itmp);
1667 }
1668#else
1669 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001670 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 * the use of commands in a pipe.
1672 */
1673 STRCPY(buf, cmd);
1674 if (itmp != NULL)
1675 {
1676 char_u *p;
1677
1678 /*
1679 * If there is a pipe, we have to put the '<' in front of it.
1680 * Don't do this when 'shellquote' is not empty, otherwise the
1681 * redirection would be inside the quotes.
1682 */
1683 if (*p_shq == NUL)
1684 {
1685 p = vim_strchr(buf, '|');
1686 if (p != NULL)
1687 *p = NUL;
1688 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1690 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 if (*p_shq == NUL)
1692 {
1693 p = vim_strchr(cmd, '|');
1694 if (p != NULL)
1695 {
1696 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1697 STRCAT(buf, p);
1698 }
1699 }
1700 }
1701#endif
1702 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001703 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 return buf;
1706}
1707
1708/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 * Append output redirection for file "fname" to the end of string buffer
1710 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 * Works with the 'shellredir' and 'shellpipe' options.
1712 * The caller should make sure that there is enough room:
1713 * STRLEN(opt) + STRLEN(fname) + 3
1714 */
1715 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001716append_redir(
1717 char_u *buf,
1718 int buflen,
1719 char_u *opt,
1720 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721{
1722 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001723 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001725 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001726 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001728 {
1729 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001731 if (p[1] == '%') /* skip %% */
1732 ++p;
1733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 if (p != NULL)
1735 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001736 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1737 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1738 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 }
1740 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001741 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 " %s %s",
1744#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746#endif
1747 (char *)opt, (char *)fname);
1748}
1749
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001750#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001752static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001753static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001754static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001755static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756static int viminfo_errcnt;
1757
1758 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001759no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760{
1761 /* "vim -i NONE" does not read or write a viminfo file */
1762 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1763}
1764
1765/*
1766 * Report an error for reading a viminfo file.
1767 * Count the number of errors. When there are more than 10, return TRUE.
1768 */
1769 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001770viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001772 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1773 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001774 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001775 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1776 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 emsg(IObuff);
1778 if (++viminfo_errcnt >= 10)
1779 {
1780 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1781 return TRUE;
1782 }
1783 return FALSE;
1784}
1785
1786/*
1787 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001788 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 */
1790 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001791read_viminfo(
1792 char_u *file, /* file name or NULL to use default name */
1793 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794{
1795 FILE *fp;
1796 char_u *fname;
1797
1798 if (no_viminfo())
1799 return FAIL;
1800
Bram Moolenaard812df62008-11-09 12:46:09 +00001801 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 if (fname == NULL)
1803 return FAIL;
1804 fp = mch_fopen((char *)fname, READBIN);
1805
1806 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001807 {
1808 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001809 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1810 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001811 (flags & VIF_WANT_INFO) ? _(" info") : "",
1812 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1813 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001814 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001815 verbose_leave();
1816 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 vim_free(fname);
1819 if (fp == NULL)
1820 return FAIL;
1821
1822 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001823 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824
1825 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 return OK;
1827}
1828
1829/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001830 * Write the viminfo file. The old one is read in first so that effectively a
1831 * merge of current info and old info is done. This allows multiple vims to
1832 * run simultaneously, without losing any marks etc.
1833 * If "forceit" is TRUE, then the old file is not read in, and only internal
1834 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 */
1836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001837write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838{
1839 char_u *fname;
1840 FILE *fp_in = NULL; /* input viminfo file, if any */
1841 FILE *fp_out = NULL; /* output viminfo file */
1842 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001843 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 char_u *wp;
1845#if defined(UNIX) || defined(VMS)
1846 mode_t umask_save;
1847#endif
1848#ifdef UNIX
1849 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001850 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001852#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001853 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001854#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855
1856 if (no_viminfo())
1857 return;
1858
1859 fname = viminfo_filename(file); /* may set to default if NULL */
1860 if (fname == NULL)
1861 return;
1862
1863 fp_in = mch_fopen((char *)fname, READBIN);
1864 if (fp_in == NULL)
1865 {
1866 /* if it does exist, but we can't read it, don't try writing */
1867 if (mch_stat((char *)fname, &st_new) == 0)
1868 goto end;
1869#if defined(UNIX) || defined(VMS)
1870 /*
1871 * For Unix we create the .viminfo non-accessible for others,
1872 * because it may contain text from non-accessible documents.
1873 */
1874 umask_save = umask(077);
1875#endif
1876 fp_out = mch_fopen((char *)fname, WRITEBIN);
1877#if defined(UNIX) || defined(VMS)
1878 (void)umask(umask_save);
1879#endif
1880 }
1881 else
1882 {
1883 /*
1884 * There is an existing viminfo file. Create a temporary file to
1885 * write the new viminfo into, in the same directory as the
1886 * existing viminfo file, which will be renamed later.
1887 */
1888#ifdef UNIX
1889 /*
1890 * For Unix we check the owner of the file. It's not very nice to
1891 * overwrite a user's viminfo file after a "su root", with a
1892 * viminfo file that the user can't read.
1893 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001894 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001895 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001897 if (mch_stat((char *)fname, &st_old) == 0
1898 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001899 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 ? (st_old.st_mode & 0200)
1901 : (st_old.st_gid == getgid()
1902 ? (st_old.st_mode & 0020)
1903 : (st_old.st_mode & 0002))))
1904 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001905 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906
1907 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1909 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001910 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 goto end;
1912 }
1913#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001914#ifdef WIN3264
1915 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001916 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001917#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918
1919 /*
1920 * Make tempname.
1921 * May try twice: Once normal and once with shortname set, just in
1922 * case somebody puts his viminfo file in an 8.3 filesystem.
1923 */
1924 for (;;)
1925 {
1926 tempname = buf_modname(
1927#ifdef UNIX
1928 shortname,
1929#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931#endif
1932 fname,
1933#ifdef VMS
1934 (char_u *)"-tmp",
1935#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937#endif
1938 FALSE);
1939 if (tempname == NULL) /* out of memory */
1940 break;
1941
1942 /*
1943 * Check if tempfile already exists. Never overwrite an
1944 * existing file!
1945 */
1946 if (mch_stat((char *)tempname, &st_new) == 0)
1947 {
1948#ifdef UNIX
1949 /*
1950 * Check if tempfile is same as original file. May happen
1951 * when modname() gave the same file back. E.g. silly
1952 * link, or file name-length reached. Try again with
1953 * shortname set.
1954 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001955 if (!shortname && st_new.st_dev == st_old.st_dev
1956 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 {
1958 vim_free(tempname);
1959 tempname = NULL;
1960 shortname = TRUE;
1961 continue;
1962 }
1963#endif
1964 /*
1965 * Try another name. Change one character, just before
1966 * the extension. This should also work for an 8.3
1967 * file name, when after adding the extension it still is
1968 * the same file as the original.
1969 */
1970 wp = tempname + STRLEN(tempname) - 5;
1971 if (wp < gettail(tempname)) /* empty file name? */
1972 wp = gettail(tempname);
1973 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1974 --*wp)
1975 {
1976 /*
1977 * They all exist? Must be something wrong! Don't
1978 * write the viminfo file then.
1979 */
1980 if (*wp == 'a')
1981 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001982 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1983 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 vim_free(tempname);
1985 tempname = NULL;
1986 break;
1987 }
1988 }
1989 }
1990 break;
1991 }
1992
1993 if (tempname != NULL)
1994 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001995#ifdef VMS
1996 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001997 umask_save = umask(077);
1998 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1999 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002000#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00002001 int fd;
2002
2003 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002004 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002005 * Unix: same as original file, but strip s-bit. Reset umask to
2006 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002007 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00002008# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002009 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00002010 fd = mch_open((char *)tempname,
2011 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002012 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002013 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002014# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002015 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002016 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002017# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002018 if (fd < 0)
2019 fp_out = NULL;
2020 else
2021 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002022#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023
2024 /*
2025 * If we can't create in the same directory, try creating a
2026 * "normal" temp file.
2027 */
2028 if (fp_out == NULL)
2029 {
2030 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002031 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2033 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002034
2035#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002037 * Make sure the owner can read/write it. This only works for
2038 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 */
2040 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002041 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042#endif
2043 }
2044 }
2045
2046 /*
2047 * Check if the new viminfo file can be written to.
2048 */
2049 if (fp_out == NULL)
2050 {
2051 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002052 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 if (fp_in != NULL)
2054 fclose(fp_in);
2055 goto end;
2056 }
2057
2058 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002059 {
2060 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002061 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002062 verbose_leave();
2063 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064
2065 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002066 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067
Bram Moolenaar927030a2016-03-15 18:23:55 +01002068 if (fclose(fp_out) == EOF)
2069 ++viminfo_errcnt;
2070
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 if (fp_in != NULL)
2072 {
2073 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002074
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002075 /* In case of an error keep the original viminfo file. Otherwise
2076 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002077 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002078 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002079 if (vim_rename(tempname, fname) == -1)
2080 {
2081 ++viminfo_errcnt;
2082 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2083 }
2084# ifdef WIN3264
2085 /* If the viminfo file was hidden then also hide the new file. */
2086 else if (hidden)
2087 mch_hide(fname);
2088# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002089 }
2090 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 mch_remove(tempname);
2092 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002093
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094end:
2095 vim_free(fname);
2096 vim_free(tempname);
2097}
2098
2099/*
2100 * Get the viminfo file name to use.
2101 * If "file" is given and not empty, use it (has already been expanded by
2102 * cmdline functions).
2103 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2104 * expand environment variables.
2105 * Returns an allocated string. NULL when out of memory.
2106 */
2107 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002108viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109{
2110 if (file == NULL || *file == NUL)
2111 {
2112 if (use_viminfo != NULL)
2113 file = use_viminfo;
2114 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2115 {
2116#ifdef VIMINFO_FILE2
2117 /* don't use $HOME when not defined (turned into "c:/"!). */
2118# ifdef VMS
2119 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2120# else
2121 if (mch_getenv((char_u *)"HOME") == NULL)
2122# endif
2123 {
2124 /* don't use $VIM when not available. */
2125 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2126 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2127 file = (char_u *)VIMINFO_FILE2;
2128 else
2129 file = (char_u *)VIMINFO_FILE;
2130 }
2131 else
2132#endif
2133 file = (char_u *)VIMINFO_FILE;
2134 }
2135 expand_env(file, NameBuff, MAXPATHL);
2136 file = NameBuff;
2137 }
2138 return vim_strsave(file);
2139}
2140
2141/*
2142 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2143 */
2144 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002145do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 int eof = FALSE;
2148 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002149 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002150 int do_copy_marks = FALSE;
2151 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152
2153 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2154 return;
2155 vir.vir_fd = fp_in;
2156#ifdef FEAT_MBYTE
2157 vir.vir_conv.vc_type = CONV_NONE;
2158#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002159 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002160 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161
2162 if (fp_in != NULL)
2163 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002164 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002165 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002166 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002167 {
2168 /* Registers and marks are read and kept separate from what
2169 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002170 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002171 prepare_viminfo_marks();
2172 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002173
Bram Moolenaard812df62008-11-09 12:46:09 +00002174 eof = read_viminfo_up_to_marks(&vir,
2175 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002176 merge = TRUE;
2177 }
2178 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 /* Skip info, find start of marks */
2180 while (!(eof = viminfo_readline(&vir))
2181 && vir.vir_line[0] != '>')
2182 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002183
2184 do_copy_marks = (flags &
2185 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002187
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 if (fp_out != NULL)
2189 {
2190 /* Write the info: */
2191 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2192 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002193 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002194 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002196 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2198#endif
2199 write_viminfo_search_pattern(fp_out);
2200 write_viminfo_sub_string(fp_out);
2201#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002202 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203#endif
2204 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002205 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206#ifdef FEAT_EVAL
2207 write_viminfo_varlist(fp_out);
2208#endif
2209 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002210 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002212 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002213
2214 if (do_copy_marks)
2215 ga_init2(&buflist, sizeof(buf_T *), 50);
2216 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002218
2219 if (do_copy_marks)
2220 {
2221 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2222 if (fp_out != NULL)
2223 ga_clear(&buflist);
2224 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225
2226 vim_free(vir.vir_line);
2227#ifdef FEAT_MBYTE
2228 if (vir.vir_conv.vc_type != CONV_NONE)
2229 convert_setup(&vir.vir_conv, NULL, NULL);
2230#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002231 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232}
2233
2234/*
2235 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2236 * first part of the viminfo file which contains everything but the marks that
2237 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2238 */
2239 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002240read_viminfo_up_to_marks(
2241 vir_T *virp,
2242 int forceit,
2243 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244{
2245 int eof;
2246 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002247 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248
2249#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002250 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002252
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 eof = viminfo_readline(virp);
2254 while (!eof && virp->vir_line[0] != '>')
2255 {
2256 switch (virp->vir_line[0])
2257 {
2258 /* Characters reserved for future expansion, ignored now */
2259 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 case '^': /* to be defined */
2261 case '<': /* long line - ignored */
2262 /* A comment or empty line. */
2263 case NUL:
2264 case '\r':
2265 case '\n':
2266 case '#':
2267 eof = viminfo_readline(virp);
2268 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002269 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002270 eof = read_viminfo_barline(virp, got_encoding,
2271 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002272 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002274 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 eof = viminfo_encoding(virp);
2276 break;
2277 case '!': /* global variable */
2278#ifdef FEAT_EVAL
2279 eof = read_viminfo_varlist(virp, writing);
2280#else
2281 eof = viminfo_readline(virp);
2282#endif
2283 break;
2284 case '%': /* entry for buffer list */
2285 eof = read_viminfo_bufferlist(virp, writing);
2286 break;
2287 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002288 /* When registers are in bar lines skip the old style register
2289 * lines. */
2290 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2291 eof = read_viminfo_register(virp, forceit);
2292 else
2293 do {
2294 eof = viminfo_readline(virp);
2295 } while (!eof && (virp->vir_line[0] == TAB
2296 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 break;
2298 case '/': /* Search string */
2299 case '&': /* Substitute search string */
2300 case '~': /* Last search string, followed by '/' or '&' */
2301 eof = read_viminfo_search_pattern(virp, forceit);
2302 break;
2303 case '$':
2304 eof = read_viminfo_sub_string(virp, forceit);
2305 break;
2306 case ':':
2307 case '?':
2308 case '=':
2309 case '@':
2310#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002311 /* When history is in bar lines skip the old style history
2312 * lines. */
2313 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2314 eof = read_viminfo_history(virp, writing);
2315 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002317 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 break;
2319 case '-':
2320 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002321 /* When file marks are in bar lines skip the old style lines. */
2322 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2323 eof = read_viminfo_filemark(virp, forceit);
2324 else
2325 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 break;
2327 default:
2328 if (viminfo_error("E575: ", _("Illegal starting char"),
2329 virp->vir_line))
2330 eof = TRUE;
2331 else
2332 eof = viminfo_readline(virp);
2333 break;
2334 }
2335 }
2336
2337#ifdef FEAT_CMDHIST
2338 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002339 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002340 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341#endif
2342
2343 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002344 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 fmarks_check_names(buf);
2346
2347 return eof;
2348}
2349
2350/*
2351 * Compare the 'encoding' value in the viminfo file with the current value of
2352 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2353 * conversion of text with iconv() in viminfo_readstring().
2354 */
2355 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002356viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357{
2358#ifdef FEAT_MBYTE
2359 char_u *p;
2360 int i;
2361
2362 if (get_viminfo_parameter('c') != 0)
2363 {
2364 p = vim_strchr(virp->vir_line, '=');
2365 if (p != NULL)
2366 {
2367 /* remove trailing newline */
2368 ++p;
2369 for (i = 0; vim_isprintc(p[i]); ++i)
2370 ;
2371 p[i] = NUL;
2372
2373 convert_setup(&virp->vir_conv, p, p_enc);
2374 }
2375 }
2376#endif
2377 return viminfo_readline(virp);
2378}
2379
2380/*
2381 * Read a line from the viminfo file.
2382 * Returns TRUE for end-of-file;
2383 */
2384 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002385viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386{
2387 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2388}
2389
2390/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002391 * Check string read from viminfo file.
2392 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 * - replace CTRL-V CTRL-V with CTRL-V
2394 * - replace CTRL-V 'n' with '\n'
2395 *
2396 * Check for a long line as written by viminfo_writestring().
2397 *
2398 * Return the string in allocated memory (NULL when out of memory).
2399 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002401viminfo_readstring(
2402 vir_T *virp,
2403 int off, /* offset for virp->vir_line */
2404 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405{
2406 char_u *retval;
2407 char_u *s, *d;
2408 long len;
2409
2410 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2411 {
2412 len = atol((char *)virp->vir_line + off + 1);
2413 retval = lalloc(len, TRUE);
2414 if (retval == NULL)
2415 {
2416 /* Line too long? File messed up? Skip next line. */
2417 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2418 return NULL;
2419 }
2420 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2421 s = retval + 1; /* Skip the leading '<' */
2422 }
2423 else
2424 {
2425 retval = vim_strsave(virp->vir_line + off);
2426 if (retval == NULL)
2427 return NULL;
2428 s = retval;
2429 }
2430
2431 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2432 d = retval;
2433 while (*s != NUL && *s != '\n')
2434 {
2435 if (s[0] == Ctrl_V && s[1] != NUL)
2436 {
2437 if (s[1] == 'n')
2438 *d++ = '\n';
2439 else
2440 *d++ = Ctrl_V;
2441 s += 2;
2442 }
2443 else
2444 *d++ = *s++;
2445 }
2446 *d = NUL;
2447
2448#ifdef FEAT_MBYTE
2449 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2450 {
2451 d = string_convert(&virp->vir_conv, retval, NULL);
2452 if (d != NULL)
2453 {
2454 vim_free(retval);
2455 retval = d;
2456 }
2457 }
2458#endif
2459
2460 return retval;
2461}
2462
2463/*
2464 * write string to viminfo file
2465 * - replace CTRL-V with CTRL-V CTRL-V
2466 * - replace '\n' with CTRL-V 'n'
2467 * - add a '\n' at the end
2468 *
2469 * For a long line:
2470 * - write " CTRL-V <length> \n " in first line
2471 * - write " < <string> \n " in second line
2472 */
2473 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002474viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475{
2476 int c;
2477 char_u *s;
2478 int len = 0;
2479
2480 for (s = p; *s != NUL; ++s)
2481 {
2482 if (*s == Ctrl_V || *s == '\n')
2483 ++len;
2484 ++len;
2485 }
2486
2487 /* If the string will be too long, write its length and put it in the next
2488 * line. Take into account that some room is needed for what comes before
2489 * the string (e.g., variable name). Add something to the length for the
2490 * '<', NL and trailing NUL. */
2491 if (len > LSIZE / 2)
2492 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2493
2494 while ((c = *p++) != NUL)
2495 {
2496 if (c == Ctrl_V || c == '\n')
2497 {
2498 putc(Ctrl_V, fd);
2499 if (c == '\n')
2500 c = 'n';
2501 }
2502 putc(c, fd);
2503 }
2504 putc('\n', fd);
2505}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002506
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002507/*
2508 * Write a string in quotes that barline_parse() can read back.
2509 * Breaks the line in less than LSIZE pieces when needed.
2510 * Returns remaining characters in the line.
2511 */
2512 int
2513barline_writestring(FILE *fd, char_u *s, int remaining_start)
2514{
2515 char_u *p;
2516 int remaining = remaining_start;
2517 int len = 2;
2518
2519 /* Count the number of characters produced, including quotes. */
2520 for (p = s; *p != NUL; ++p)
2521 {
2522 if (*p == NL)
2523 len += 2;
2524 else if (*p == '"' || *p == '\\')
2525 len += 2;
2526 else
2527 ++len;
2528 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002529 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002530 {
2531 fprintf(fd, ">%d\n|<", len);
2532 remaining = LSIZE - 20;
2533 }
2534
2535 putc('"', fd);
2536 for (p = s; *p != NUL; ++p)
2537 {
2538 if (*p == NL)
2539 {
2540 putc('\\', fd);
2541 putc('n', fd);
2542 --remaining;
2543 }
2544 else if (*p == '"' || *p == '\\')
2545 {
2546 putc('\\', fd);
2547 putc(*p, fd);
2548 --remaining;
2549 }
2550 else
2551 putc(*p, fd);
2552 --remaining;
2553
2554 if (remaining < 3)
2555 {
2556 putc('\n', fd);
2557 putc('|', fd);
2558 putc('<', fd);
2559 /* Leave enough space for another continuation. */
2560 remaining = LSIZE - 20;
2561 }
2562 }
2563 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002564 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002565}
2566
2567/*
2568 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002569 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002570 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002571 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002572 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002573barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002574{
2575 char_u *p = text;
2576 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002577 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002578 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002579 int i;
2580 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002581 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002582#ifdef FEAT_MBYTE
2583 char_u *sconv;
2584 int converted;
2585#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002586
2587 while (*p == ',')
2588 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002589 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002590 if (ga_grow(values, 1) == FAIL)
2591 break;
2592 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002593
2594 if (*p == '>')
2595 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002596 /* Need to read a continuation line. Put strings in allocated
2597 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002598 if (!allocated)
2599 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002600 for (i = 0; i < values->ga_len; ++i)
2601 {
2602 bval_T *vp = (bval_T *)(values->ga_data) + i;
2603
2604 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002605 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002606 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2607 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002608 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002609 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002610 allocated = TRUE;
2611 }
2612
2613 if (vim_isdigit(p[1]))
2614 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002615 size_t len;
2616 size_t todo;
2617 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002618
2619 /* String value was split into lines that are each shorter
2620 * than LSIZE:
2621 * |{bartype},>{length of "{text}{text2}"}
2622 * |<"{text1}
2623 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002624 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002625 */
2626 ++p;
2627 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002628 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002629 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002630 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002631 p = buf;
2632 for (todo = len; todo > 0; todo -= n)
2633 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002634 eof = viminfo_readline(virp);
2635 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002636 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002637 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002638 /* File was truncated or garbled. Read another line if
2639 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002640 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002641 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002642 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002643 /* Get length of text, excluding |< and NL chars. */
2644 n = STRLEN(virp->vir_line);
2645 while (n > 0 && (virp->vir_line[n - 1] == NL
2646 || virp->vir_line[n - 1] == CAR))
2647 --n;
2648 n -= 2;
2649 if (n > todo)
2650 {
2651 /* more values follow after the string */
2652 nextp = virp->vir_line + 2 + todo;
2653 n = todo;
2654 }
2655 mch_memmove(p, virp->vir_line + 2, n);
2656 p += n;
2657 }
2658 *p = NUL;
2659 p = buf;
2660 }
2661 else
2662 {
2663 /* Line ending in ">" continues in the next line:
2664 * |{bartype},{lots of values},>
2665 * |<{value},{value}
2666 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002667 eof = viminfo_readline(virp);
2668 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002669 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002670 /* File was truncated or garbled. Read another line if
2671 * this one starts with '|'. */
2672 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002673 p = virp->vir_line + 2;
2674 }
2675 }
2676
2677 if (isdigit(*p))
2678 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002679 value->bv_type = BVAL_NR;
2680 value->bv_nr = getdigits(&p);
2681 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002682 }
2683 else if (*p == '"')
2684 {
2685 int len = 0;
2686 char_u *s = p;
2687
2688 /* Unescape special characters in-place. */
2689 ++p;
2690 while (*p != '"')
2691 {
2692 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002693 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002694 if (*p == '\\')
2695 {
2696 ++p;
2697 if (*p == 'n')
2698 s[len++] = '\n';
2699 else
2700 s[len++] = *p;
2701 ++p;
2702 }
2703 else
2704 s[len++] = *p++;
2705 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002706 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002707 s[len] = NUL;
2708
Bram Moolenaar01227092016-06-11 14:47:40 +02002709#ifdef FEAT_MBYTE
2710 converted = FALSE;
2711 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2712 {
2713 sconv = string_convert(&virp->vir_conv, s, NULL);
2714 if (sconv != NULL)
2715 {
2716 if (s == buf)
2717 vim_free(s);
2718 s = sconv;
2719 buf = s;
2720 converted = TRUE;
2721 }
2722 }
2723#endif
2724 /* Need to copy in allocated memory if the string wasn't allocated
2725 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002726 if (s != buf && allocated)
2727 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002728 value->bv_string = s;
2729 value->bv_type = BVAL_STRING;
2730 value->bv_len = len;
2731 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002732#ifdef FEAT_MBYTE
2733 || converted
2734#endif
2735 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002736 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737 if (nextp != NULL)
2738 {
2739 /* values following a long string */
2740 p = nextp;
2741 nextp = NULL;
2742 }
2743 }
2744 else if (*p == ',')
2745 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002746 value->bv_type = BVAL_EMPTY;
2747 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002748 }
2749 else
2750 break;
2751 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002752 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002753}
2754
2755 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002756read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002757{
2758 char_u *p = virp->vir_line + 1;
2759 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002760 garray_T values;
2761 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002762 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002763 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002764
2765 /* The format is: |{bartype},{value},...
2766 * For a very long string:
2767 * |{bartype},>{length of "{text}{text2}"}
2768 * |<{text1}
2769 * |<{text2},{value}
2770 * For a long line not using a string
2771 * |{bartype},{lots of values},>
2772 * |<{value},{value}
2773 */
2774 if (*p == '<')
2775 {
2776 /* Continuation line of an unrecognized item. */
2777 if (writing)
2778 ga_add_string(&virp->vir_barlines, virp->vir_line);
2779 }
2780 else
2781 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002782 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002783 bartype = getdigits(&p);
2784 switch (bartype)
2785 {
2786 case BARTYPE_VERSION:
2787 /* Only use the version when it comes before the encoding.
2788 * If it comes later it was copied by a Vim version that
2789 * doesn't understand the version. */
2790 if (!got_encoding)
2791 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002792 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002793 vp = (bval_T *)values.ga_data;
2794 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2795 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002796 }
2797 break;
2798
2799 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002800 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002801 handle_viminfo_history(&values, writing);
2802 break;
2803
2804 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002805 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002806 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002807 break;
2808
Bram Moolenaar2d358992016-06-12 21:20:54 +02002809 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002810 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002811 handle_viminfo_mark(&values, force);
2812 break;
2813
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002814 default:
2815 /* copy unrecognized line (for future use) */
2816 if (writing)
2817 ga_add_string(&virp->vir_barlines, virp->vir_line);
2818 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002819 for (i = 0; i < values.ga_len; ++i)
2820 {
2821 vp = (bval_T *)values.ga_data + i;
2822 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2823 vim_free(vp->bv_string);
2824 }
2825 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002826 }
2827
Bram Moolenaarecefe712016-06-20 12:50:17 +02002828 if (read_next)
2829 return viminfo_readline(virp);
2830 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002831}
2832
2833 static void
2834write_viminfo_version(FILE *fp_out)
2835{
2836 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2837 BARTYPE_VERSION, VIMINFO_VERSION);
2838}
2839
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002840 static void
2841write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2842{
2843 int i;
2844 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002845 int seen_useful = FALSE;
2846 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002847
2848 if (gap->ga_len > 0)
2849 {
2850 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2851
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002852 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002853 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002854 {
2855 line = ((char **)(gap->ga_data))[i];
2856 if (seen_useful || line[1] != '<')
2857 {
2858 fputs(line, fp_out);
2859 seen_useful = TRUE;
2860 }
2861 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002862 }
2863}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864#endif /* FEAT_VIMINFO */
2865
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002866/*
2867 * Return the current time in seconds. Calls time(), unless test_settime()
2868 * was used.
2869 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002870 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002871vim_time(void)
2872{
2873# ifdef FEAT_EVAL
2874 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2875# else
2876 return time(NULL);
2877# endif
2878}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002879
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880/*
2881 * Implementation of ":fixdel", also used by get_stty().
2882 * <BS> resulting <Del>
2883 * ^? ^H
2884 * not ^? ^?
2885 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002887do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888{
2889 char_u *p;
2890
2891 p = find_termcode((char_u *)"kb");
2892 add_termcode((char_u *)"kD", p != NULL
2893 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2894}
2895
2896 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002897print_line_no_prefix(
2898 linenr_T lnum,
2899 int use_number,
2900 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002902 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903
2904 if (curwin->w_p_nu || use_number)
2905 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002906 vim_snprintf((char *)numbuf, sizeof(numbuf),
2907 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2909 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002910 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911}
2912
2913/*
2914 * Print a text line. Also in silent mode ("ex -s").
2915 */
2916 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002917print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918{
2919 int save_silent = silent_mode;
2920
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002922 silent_mode = FALSE;
2923 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2924 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 if (save_silent)
2926 {
2927 msg_putchar('\n');
2928 cursor_on(); /* msg_start() switches it off */
2929 out_flush();
2930 silent_mode = save_silent;
2931 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002932 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933}
2934
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002935 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002936rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002937{
2938 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002939 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002940
Bram Moolenaar7e283842013-05-30 11:43:15 +02002941#ifdef FEAT_AUTOCMD
2942 buf = curbuf;
2943 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002944 /* buffer changed, don't change name now */
2945 if (buf != curbuf)
2946 return FAIL;
2947# ifdef FEAT_EVAL
2948 if (aborting()) /* autocmds may abort script processing */
2949 return FAIL;
2950# endif
2951#endif
2952 /*
2953 * The name of the current buffer will be changed.
2954 * A new (unlisted) buffer entry needs to be made to hold the old file
2955 * name, which will become the alternate file name.
2956 * But don't set the alternate file name if the buffer didn't have a
2957 * name.
2958 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002959 fname = curbuf->b_ffname;
2960 sfname = curbuf->b_sfname;
2961 xfname = curbuf->b_fname;
2962 curbuf->b_ffname = NULL;
2963 curbuf->b_sfname = NULL;
2964 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002965 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002966 curbuf->b_ffname = fname;
2967 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002968 return FAIL;
2969 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002970 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002971 if (xfname != NULL && *xfname != NUL)
2972 {
2973 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2974 if (buf != NULL && !cmdmod.keepalt)
2975 curwin->w_alt_fnum = buf->b_fnum;
2976 }
2977 vim_free(fname);
2978 vim_free(sfname);
2979#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002980 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002981#endif
2982 /* Change directories when the 'acd' option is set. */
2983 DO_AUTOCHDIR
2984 return OK;
2985}
2986
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987/*
2988 * ":file[!] [fname]".
2989 */
2990 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002991ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002993 /* ":0file" removes the file name. Check for illegal uses ":3file",
2994 * "0file name", etc. */
2995 if (eap->addr_count > 0
2996 && (*eap->arg != NUL
2997 || eap->line2 > 0
2998 || eap->addr_count > 1))
2999 {
3000 EMSG(_(e_invarg));
3001 return;
3002 }
3003
3004 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003006 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 }
3009 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003010 if (!shortmess(SHM_FILEINFO))
3011 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012}
3013
3014/*
3015 * ":update".
3016 */
3017 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003018ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019{
3020 if (curbufIsChanged())
3021 (void)do_write(eap);
3022}
3023
3024/*
3025 * ":write" and ":saveas".
3026 */
3027 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003028ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029{
3030 if (eap->usefilter) /* input lines to shell command */
3031 do_bang(1, eap, FALSE, TRUE, FALSE);
3032 else
3033 (void)do_write(eap);
3034}
3035
3036/*
3037 * write current buffer to file 'eap->arg'
3038 * if 'eap->append' is TRUE, append to the file
3039 *
3040 * if *eap->arg == NUL write to current file
3041 *
3042 * return FAIL for failure, OK otherwise
3043 */
3044 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003045do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046{
3047 int other;
3048 char_u *fname = NULL; /* init to shut up gcc */
3049 char_u *ffname;
3050 int retval = FAIL;
3051 char_u *free_fname = NULL;
3052#ifdef FEAT_BROWSE
3053 char_u *browse_file = NULL;
3054#endif
3055 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003056 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057
3058 if (not_writing()) /* check 'write' option */
3059 return FAIL;
3060
3061 ffname = eap->arg;
3062#ifdef FEAT_BROWSE
3063 if (cmdmod.browse)
3064 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003065 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 NULL, NULL, NULL, curbuf);
3067 if (browse_file == NULL)
3068 goto theend;
3069 ffname = browse_file;
3070 }
3071#endif
3072 if (*ffname == NUL)
3073 {
3074 if (eap->cmdidx == CMD_saveas)
3075 {
3076 EMSG(_(e_argreq));
3077 goto theend;
3078 }
3079 other = FALSE;
3080 }
3081 else
3082 {
3083 fname = ffname;
3084 free_fname = fix_fname(ffname);
3085 /*
3086 * When out-of-memory, keep unexpanded file name, because we MUST be
3087 * able to write the file in this situation.
3088 */
3089 if (free_fname != NULL)
3090 ffname = free_fname;
3091 other = otherfile(ffname);
3092 }
3093
3094 /*
3095 * If we have a new file, put its name in the list of alternate file names.
3096 */
3097 if (other)
3098 {
3099 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3100 || eap->cmdidx == CMD_saveas)
3101 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3102 else
3103 alt_buf = buflist_findname(ffname);
3104 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3105 {
3106 /* Overwriting a file that is loaded in another buffer is not a
3107 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003108 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 goto theend;
3110 }
3111 }
3112
3113 /*
3114 * Writing to the current file is not allowed in readonly mode
3115 * and a file name is required.
3116 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3117 */
3118 if (!other && (
3119#ifdef FEAT_QUICKFIX
3120 bt_dontwrite_msg(curbuf) ||
3121#endif
3122 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3123 goto theend;
3124
3125 if (!other)
3126 {
3127 ffname = curbuf->b_ffname;
3128 fname = curbuf->b_fname;
3129 /*
3130 * Not writing the whole file is only allowed with '!'.
3131 */
3132 if ( (eap->line1 != 1
3133 || eap->line2 != curbuf->b_ml.ml_line_count)
3134 && !eap->forceit
3135 && !eap->append
3136 && !p_wa)
3137 {
3138#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3139 if (p_confirm || cmdmod.confirm)
3140 {
3141 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3142 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3143 goto theend;
3144 eap->forceit = TRUE;
3145 }
3146 else
3147#endif
3148 {
3149 EMSG(_("E140: Use ! to write partial buffer"));
3150 goto theend;
3151 }
3152 }
3153 }
3154
3155 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3156 {
3157 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3158 {
3159#ifdef FEAT_AUTOCMD
3160 buf_T *was_curbuf = curbuf;
3161
3162 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003163 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164# ifdef FEAT_EVAL
3165 if (curbuf != was_curbuf || aborting())
3166# else
3167 if (curbuf != was_curbuf)
3168# endif
3169 {
3170 /* buffer changed, don't change name now */
3171 retval = FAIL;
3172 goto theend;
3173 }
3174#endif
3175 /* Exchange the file names for the current and the alternate
3176 * buffer. This makes it look like we are now editing the buffer
3177 * under the new name. Must be done before buf_write(), because
3178 * if there is no file name and 'cpo' contains 'F', it will set
3179 * the file name. */
3180 fname = alt_buf->b_fname;
3181 alt_buf->b_fname = curbuf->b_fname;
3182 curbuf->b_fname = fname;
3183 fname = alt_buf->b_ffname;
3184 alt_buf->b_ffname = curbuf->b_ffname;
3185 curbuf->b_ffname = fname;
3186 fname = alt_buf->b_sfname;
3187 alt_buf->b_sfname = curbuf->b_sfname;
3188 curbuf->b_sfname = fname;
3189 buf_name_changed(curbuf);
3190#ifdef FEAT_AUTOCMD
3191 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003192 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 if (!alt_buf->b_p_bl)
3194 {
3195 alt_buf->b_p_bl = TRUE;
3196 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3197 }
3198# ifdef FEAT_EVAL
3199 if (curbuf != was_curbuf || aborting())
3200# else
3201 if (curbuf != was_curbuf)
3202# endif
3203 {
3204 /* buffer changed, don't write the file */
3205 retval = FAIL;
3206 goto theend;
3207 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003208
3209 /* If 'filetype' was empty try detecting it now. */
3210 if (*curbuf->b_p_ft == NUL)
3211 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003212 if (au_has_group((char_u *)"filetypedetect"))
3213 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003214 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003215 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003216 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003217
3218 /* Autocommands may have changed buffer names, esp. when
3219 * 'autochdir' is set. */
3220 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221#endif
3222 }
3223
Bram Moolenaar5c719942016-07-09 23:40:45 +02003224 name_was_missing = curbuf->b_ffname == NULL;
3225
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3227 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003228
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003229 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003230 if (eap->cmdidx == CMD_saveas)
3231 {
3232 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003233 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003234 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003235#ifdef FEAT_WINDOWS
3236 redraw_tabline = TRUE;
3237#endif
3238 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003239 }
3240
3241 /* Change directories when the 'acd' option is set and the file name
3242 * got changed or set. */
3243 if (eap->cmdidx == CMD_saveas || name_was_missing)
3244 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003245 DO_AUTOCHDIR
3246 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 }
3248
3249theend:
3250#ifdef FEAT_BROWSE
3251 vim_free(browse_file);
3252#endif
3253 vim_free(free_fname);
3254 return retval;
3255}
3256
3257/*
3258 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3259 * BF_NEW or BF_READERR, check for overwriting current file.
3260 * May set eap->forceit if a dialog says it's OK to overwrite.
3261 * Return OK if it's OK, FAIL if it is not.
3262 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003263 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003264check_overwrite(
3265 exarg_T *eap,
3266 buf_T *buf,
3267 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003269 char_u *ffname, /* full path version of fname */
3270 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271{
3272 /*
3273 * write to other file or b_flags set or not writing the whole file:
3274 * overwriting only allowed with '!'
3275 */
3276 if ( (other
3277 || (buf->b_flags & BF_NOTEDITED)
3278 || ((buf->b_flags & BF_NEW)
3279 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3280 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003282#ifdef FEAT_QUICKFIX
3283 && !bt_nofile(buf)
3284#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 && vim_fexists(ffname))
3286 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003287 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003289#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003290 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003291 if (mch_isdir(ffname))
3292 {
3293 EMSG2(_(e_isadir2), ffname);
3294 return FAIL;
3295 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296#endif
3297#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003298 if (p_confirm || cmdmod.confirm)
3299 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003300 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003302 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3303 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3304 return FAIL;
3305 eap->forceit = TRUE;
3306 }
3307 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003309 {
3310 EMSG(_(e_exists));
3311 return FAIL;
3312 }
3313 }
3314
3315 /* For ":w! filename" check that no swap file exists for "filename". */
3316 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003318 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003319 char_u *p;
3320 int r;
3321 char_u *swapname;
3322
3323 /* We only try the first entry in 'directory', without checking if
3324 * it's writable. If the "." directory is not writable the write
3325 * will probably fail anyway.
3326 * Use 'shortname' of the current buffer, since there is no buffer
3327 * for the written file. */
3328 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003329 {
3330 dir = alloc(5);
3331 if (dir == NULL)
3332 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003333 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003334 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003335 else
3336 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003337 dir = alloc(MAXPATHL);
3338 if (dir == NULL)
3339 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003340 p = p_dir;
3341 copy_option_part(&p, dir, MAXPATHL, ",");
3342 }
3343 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003344 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003345 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003346 if (r)
3347 {
3348#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3349 if (p_confirm || cmdmod.confirm)
3350 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003351 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003352
3353 dialog_msg(buff,
3354 _("Swap file \"%s\" exists, overwrite anyway?"),
3355 swapname);
3356 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3357 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003358 {
3359 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003360 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003361 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003362 eap->forceit = TRUE;
3363 }
3364 else
3365#endif
3366 {
3367 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3368 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003369 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003370 return FAIL;
3371 }
3372 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003373 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 }
3375 }
3376 return OK;
3377}
3378
3379/*
3380 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3381 */
3382 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003383ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384{
3385 int i;
3386
3387 if (eap->cmd[1] == 'n')
3388 i = curwin->w_arg_idx + (int)eap->line2;
3389 else
3390 i = curwin->w_arg_idx - (int)eap->line2;
3391 eap->line1 = 1;
3392 eap->line2 = curbuf->b_ml.ml_line_count;
3393 if (do_write(eap) != FAIL)
3394 do_argfile(eap, i);
3395}
3396
3397/*
3398 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3399 */
3400 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003401do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402{
3403 buf_T *buf;
3404 int error = 0;
3405 int save_forceit = eap->forceit;
3406
3407 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3408 exiting = TRUE;
3409
Bram Moolenaar29323592016-07-24 22:04:11 +02003410 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 {
3412 if (bufIsChanged(buf))
3413 {
3414 /*
3415 * Check if there is a reason the buffer cannot be written:
3416 * 1. if the 'write' option is set
3417 * 2. if there is no file name (even after browsing)
3418 * 3. if the 'readonly' is set (even after a dialog)
3419 * 4. if overwriting is allowed (even after a dialog)
3420 */
3421 if (not_writing())
3422 {
3423 ++error;
3424 break;
3425 }
3426#ifdef FEAT_BROWSE
3427 /* ":browse wall": ask for file name if there isn't one */
3428 if (buf->b_ffname == NULL && cmdmod.browse)
3429 browse_save_fname(buf);
3430#endif
3431 if (buf->b_ffname == NULL)
3432 {
3433 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3434 ++error;
3435 }
3436 else if (check_readonly(&eap->forceit, buf)
3437 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3438 FALSE) == FAIL)
3439 {
3440 ++error;
3441 }
3442 else
3443 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003444#ifdef FEAT_AUTOCMD
3445 bufref_T bufref;
3446
3447 set_bufref(&bufref, buf);
3448#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 if (buf_write_all(buf, eap->forceit) == FAIL)
3450 ++error;
3451#ifdef FEAT_AUTOCMD
3452 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003453 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 buf = firstbuf;
3455#endif
3456 }
3457 eap->forceit = save_forceit; /* check_overwrite() may set it */
3458 }
3459 }
3460 if (exiting)
3461 {
3462 if (!error)
3463 getout(0); /* exit Vim */
3464 not_exiting();
3465 }
3466}
3467
3468/*
3469 * Check the 'write' option.
3470 * Return TRUE and give a message when it's not st.
3471 */
3472 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003473not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474{
3475 if (p_write)
3476 return FALSE;
3477 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3478 return TRUE;
3479}
3480
3481/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003482 * Check if a buffer is read-only (either 'readonly' option is set or file is
3483 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3484 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 */
3486 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003487check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003489 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003490
3491 /* Handle a file being readonly when the 'readonly' option is set or when
3492 * the file exists and permissions are read-only.
3493 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3494 * important for device checks but not here. */
3495 if (!*forceit && (buf->b_p_ro
3496 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3497 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {
3499#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3500 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3501 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003502 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503
Bram Moolenaar5386a122007-06-28 20:02:32 +00003504 if (buf->b_p_ro)
3505 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3506 buf->b_fname);
3507 else
3508 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 buf->b_fname);
3510
3511 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3512 {
3513 /* Set forceit, to force the writing of a readonly file */
3514 *forceit = TRUE;
3515 return FALSE;
3516 }
3517 else
3518 return TRUE;
3519 }
3520 else
3521#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003522 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003524 else
3525 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3526 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 return TRUE;
3528 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003529
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 return FALSE;
3531}
3532
3533/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003534 * Try to abandon current file and edit a new or existing file.
3535 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003537 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003538 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3540 */
3541 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003542getfile(
3543 int fnum,
3544 char_u *ffname,
3545 char_u *sfname,
3546 int setpm,
3547 linenr_T lnum,
3548 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549{
3550 int other;
3551 int retval;
3552 char_u *free_me = NULL;
3553
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003554 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003556#ifdef FEAT_AUTOCMD
3557 if (curbuf_locked())
3558 return 1;
3559#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 if (fnum == 0)
3562 {
3563 /* make ffname full path, set sfname */
3564 fname_expand(curbuf, &ffname, &sfname);
3565 other = otherfile(ffname);
3566 free_me = ffname; /* has been allocated, free() later */
3567 }
3568 else
3569 other = (fnum != curbuf->b_fnum);
3570
3571 if (other)
3572 ++no_wait_return; /* don't wait for autowrite message */
3573 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3574 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3575 {
3576#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3577 if (p_confirm && p_write)
3578 dialog_changed(curbuf, FALSE);
3579 if (curbufIsChanged())
3580#endif
3581 {
3582 if (other)
3583 --no_wait_return;
3584 EMSG(_(e_nowrtmsg));
3585 retval = 2; /* file has been changed */
3586 goto theend;
3587 }
3588 }
3589 if (other)
3590 --no_wait_return;
3591 if (setpm)
3592 setpcmark();
3593 if (!other)
3594 {
3595 if (lnum != 0)
3596 curwin->w_cursor.lnum = lnum;
3597 check_cursor_lnum();
3598 beginline(BL_SOL | BL_FIX);
3599 retval = 0; /* it's in the same file */
3600 }
3601 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003602 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3603 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 retval = -1; /* opened another file */
3605 else
3606 retval = 1; /* error encountered */
3607
3608theend:
3609 vim_free(free_me);
3610 return retval;
3611}
3612
3613/*
3614 * start editing a new file
3615 *
3616 * fnum: file number; if zero use ffname/sfname
3617 * ffname: the file name
3618 * - full path if sfname used,
3619 * - any file name if sfname is NULL
3620 * - empty string to re-edit with the same file name (but may be
3621 * in a different directory)
3622 * - NULL to start an empty buffer
3623 * sfname: the short file name (or NULL)
3624 * eap: contains the command to be executed after loading the file and
3625 * forced 'ff' and 'fenc'
3626 * newlnum: if > 0: put cursor on this line number (if possible)
3627 * if ECMD_LASTL: use last position in loaded file
3628 * if ECMD_LAST: use last position in all files
3629 * if ECMD_ONE: use first line
3630 * flags:
3631 * ECMD_HIDE: if TRUE don't free the current buffer
3632 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3633 * ECMD_OLDBUF: use existing buffer if it exists
3634 * ECMD_FORCEIT: ! used for Ex command
3635 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003636 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003637 * window, NULL when splitting the window first. When not NULL info
3638 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 *
3640 * return FAIL for failure, OK otherwise
3641 */
3642 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003643do_ecmd(
3644 int fnum,
3645 char_u *ffname,
3646 char_u *sfname,
3647 exarg_T *eap, /* can be NULL! */
3648 linenr_T newlnum,
3649 int flags,
3650 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651{
3652 int other_file; /* TRUE if editing another file */
3653 int oldbuf; /* TRUE if using existing buffer */
3654#ifdef FEAT_AUTOCMD
3655 int auto_buf = FALSE; /* TRUE if autocommands brought us
3656 into the buffer unexpectedly */
3657 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003658 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659#endif
3660 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003661 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003663 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664#endif
3665 char_u *free_fname = NULL;
3666#ifdef FEAT_BROWSE
3667 char_u *browse_file = NULL;
3668#endif
3669 int retval = FAIL;
3670 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003671 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 linenr_T topline = 0;
3673 int newcol = -1;
3674 int solcol = -1;
3675 pos_T *pos;
3676#ifdef FEAT_SUN_WORKSHOP
3677 char_u *cp;
3678#endif
3679 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003680#ifdef FEAT_SPELL
3681 int did_get_winopts = FALSE;
3682#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003683 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003684 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685
3686 if (eap != NULL)
3687 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003688#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3689 set_bufref(&old_curbuf, curbuf);
3690#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691
3692 if (fnum != 0)
3693 {
3694 if (fnum == curbuf->b_fnum) /* file is already being edited */
3695 return OK; /* nothing to do */
3696 other_file = TRUE;
3697 }
3698 else
3699 {
3700#ifdef FEAT_BROWSE
3701 if (cmdmod.browse)
3702 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003703# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003704 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003705# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003706 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003707# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003708 au_has_group((char_u *)"FileExplorer"))
3709 {
3710 /* No browsing supported but we do have the file explorer:
3711 * Edit the directory. */
3712 if (ffname == NULL || !mch_isdir(ffname))
3713 ffname = (char_u *)".";
3714 }
3715 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003716# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003717 {
3718 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003720 if (browse_file == NULL)
3721 goto theend;
3722 ffname = browse_file;
3723 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 }
3725#endif
3726 /* if no short name given, use ffname for short name */
3727 if (sfname == NULL)
3728 sfname = ffname;
3729#ifdef USE_FNAME_CASE
3730# ifdef USE_LONG_FNAME
3731 if (USE_LONG_FNAME)
3732# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003733 if (sfname != NULL)
3734 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735#endif
3736
3737#ifdef FEAT_LISTCMDS
3738 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3739 goto theend;
3740#endif
3741
3742 if (ffname == NULL)
3743 other_file = TRUE;
3744 /* there is no file name */
3745 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3746 other_file = FALSE;
3747 else
3748 {
3749 if (*ffname == NUL) /* re-edit with same file name */
3750 {
3751 ffname = curbuf->b_ffname;
3752 sfname = curbuf->b_fname;
3753 }
3754 free_fname = fix_fname(ffname); /* may expand to full path name */
3755 if (free_fname != NULL)
3756 ffname = free_fname;
3757 other_file = otherfile(ffname);
3758#ifdef FEAT_SUN_WORKSHOP
3759 if (usingSunWorkShop && p_acd
3760 && (cp = vim_strrchr(sfname, '/')) != NULL)
3761 sfname = ++cp;
3762#endif
3763 }
3764 }
3765
3766 /*
3767 * if the file was changed we may not be allowed to abandon it
3768 * - if we are going to re-edit the same file
3769 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3770 */
3771 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3772 || (curbuf->b_nwindows == 1
3773 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003774 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3775 | (other_file ? 0 : CCGD_MULTWIN)
3776 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3777 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 {
3779 if (fnum == 0 && other_file && ffname != NULL)
3780 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3781 goto theend;
3782 }
3783
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 /*
3785 * End Visual mode before switching to another buffer, so the text can be
3786 * copied into the GUI selection buffer.
3787 */
3788 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003790#ifdef FEAT_AUTOCMD
3791 if ((command != NULL || newlnum > (linenr_T)0)
3792 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3793 {
3794 int len;
3795 char_u *p;
3796
3797 /* Set v:swapcommand for the SwapExists autocommands. */
3798 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003799 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003800 else
3801 len = 30;
3802 p = alloc((unsigned)len);
3803 if (p != NULL)
3804 {
3805 if (command != NULL)
3806 vim_snprintf((char *)p, len, ":%s\r", command);
3807 else
3808 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3809 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3810 did_set_swapcommand = TRUE;
3811 vim_free(p);
3812 }
3813 }
3814#endif
3815
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 /*
3817 * If we are starting to edit another file, open a (new) buffer.
3818 * Otherwise we re-use the current buffer.
3819 */
3820 if (other_file)
3821 {
3822#ifdef FEAT_LISTCMDS
3823 if (!(flags & ECMD_ADDBUF))
3824#endif
3825 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003826 if (!cmdmod.keepalt)
3827 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003828 if (oldwin != NULL)
3829 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 }
3831
3832 if (fnum)
3833 buf = buflist_findnr(fnum);
3834 else
3835 {
3836#ifdef FEAT_LISTCMDS
3837 if (flags & ECMD_ADDBUF)
3838 {
3839 linenr_T tlnum = 1L;
3840
3841 if (command != NULL)
3842 {
3843 tlnum = atol((char *)command);
3844 if (tlnum <= 0)
3845 tlnum = 1L;
3846 }
3847 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3848 goto theend;
3849 }
3850#endif
3851 buf = buflist_new(ffname, sfname, 0L,
3852 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003853#ifdef FEAT_AUTOCMD
3854 /* autocommands may change curwin and curbuf */
3855 if (oldwin != NULL)
3856 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003857 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003858#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 }
3860 if (buf == NULL)
3861 goto theend;
3862 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3863 {
3864 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 }
3866 else /* existing memfile */
3867 {
3868 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003869 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 (void)buf_check_timestamp(buf, FALSE);
3871 /* Check if autocommands made buffer invalid or changed the current
3872 * buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003873 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003875 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876#endif
3877 )
3878 goto theend;
3879#ifdef FEAT_EVAL
3880 if (aborting()) /* autocmds may abort script processing */
3881 goto theend;
3882#endif
3883 }
3884
3885 /* May jump to last used line number for a loaded buffer or when asked
3886 * for explicitly */
3887 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3888 {
3889 pos = buflist_findfpos(buf);
3890 newlnum = pos->lnum;
3891 solcol = pos->col;
3892 }
3893
3894 /*
3895 * Make the (new) buffer the one used by the current window.
3896 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3897 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003898 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 */
3900 if (buf != curbuf)
3901 {
3902#ifdef FEAT_AUTOCMD
3903 /*
3904 * Be careful: The autocommands may delete any buffer and change
3905 * the current buffer.
3906 * - If the buffer we are going to edit is deleted, give up.
3907 * - If the current buffer is deleted, prefer to load the new
3908 * buffer when loading a buffer is required. This avoids
3909 * loading another buffer which then must be closed again.
3910 * - If we ended up in the new buffer already, need to skip a few
3911 * things, set auto_buf.
3912 */
3913 if (buf->b_fname != NULL)
3914 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003915 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003917 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003919 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 delbuf_msg(new_name); /* frees new_name */
3921 goto theend;
3922 }
3923# ifdef FEAT_EVAL
3924 if (aborting()) /* autocmds may abort script processing */
3925 {
3926 vim_free(new_name);
3927 goto theend;
3928 }
3929# endif
3930 if (buf == curbuf) /* already in new buffer */
3931 auto_buf = TRUE;
3932 else
3933 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003934 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935#endif
3936 buf_copy_options(buf, BCO_ENTER);
3937
3938 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003939 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003940 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003941 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942
3943#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003944 /* Autocommands may open a new window and leave oldwin open
3945 * which leads to crashes since the above call sets
3946 * oldwin->w_buffer to NULL. */
3947 if (curwin != oldwin && oldwin != aucmd_win
3948 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3949 win_close(oldwin, FALSE);
3950
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951# ifdef FEAT_EVAL
3952 if (aborting()) /* autocmds may abort script processing */
3953 {
3954 vim_free(new_name);
3955 goto theend;
3956 }
3957# endif
3958 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003959 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003961 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 delbuf_msg(new_name); /* frees new_name */
3963 goto theend;
3964 }
3965 if (buf == curbuf) /* already in new buffer */
3966 auto_buf = TRUE;
3967 else
3968#endif
3969 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003970#ifdef FEAT_SYN_HL
3971 /*
3972 * <VN> We could instead free the synblock
3973 * and re-attach to buffer, perhaps.
3974 */
3975 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003976 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003977#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 curwin->w_buffer = buf;
3979 curbuf = buf;
3980 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003981
3982 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3983 if (!oldbuf && eap != NULL)
3984 {
3985 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003986#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003987 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003988#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003989 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 }
3991
3992 /* May get the window options from the last time this buffer
3993 * was in this window (or another window). If not used
3994 * before, reset the local window options to the global
3995 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003996 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003997#ifdef FEAT_SPELL
3998 did_get_winopts = TRUE;
3999#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000
4001#ifdef FEAT_AUTOCMD
4002 }
4003 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004004 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004005 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006#endif
4007 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008
4009 curwin->w_pcmark.lnum = 1;
4010 curwin->w_pcmark.col = 0;
4011 }
4012 else /* !other_file */
4013 {
4014 if (
4015#ifdef FEAT_LISTCMDS
4016 (flags & ECMD_ADDBUF) ||
4017#endif
4018 check_fname() == FAIL)
4019 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004020
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 oldbuf = (flags & ECMD_OLDBUF);
4022 }
4023
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004024 /* Don't redraw until the cursor is in the right line, otherwise
4025 * autocommands may cause ml_get errors. */
4026 ++RedrawingDisabled;
4027 did_inc_redrawing_disabled = TRUE;
4028
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004029#ifdef FEAT_AUTOCMD
4030 buf = curbuf;
4031#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4033 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004034 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 }
4036 else
4037 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 /* Don't make a buffer listed if it's a help buffer. Useful when
4039 * using CTRL-O to go back to a help file. */
4040 if (!curbuf->b_help)
4041 set_buflisted(TRUE);
4042 }
4043
4044#ifdef FEAT_AUTOCMD
4045 /* If autocommands change buffers under our fingers, forget about
4046 * editing the file. */
4047 if (buf != curbuf)
4048 goto theend;
4049# ifdef FEAT_EVAL
4050 if (aborting()) /* autocmds may abort script processing */
4051 goto theend;
4052# endif
4053
4054 /* Since we are starting to edit a file, consider the filetype to be
4055 * unset. Helps for when an autocommand changes files and expects syntax
4056 * highlighting to work in the other file. */
4057 did_filetype = FALSE;
4058#endif
4059
4060/*
4061 * other_file oldbuf
4062 * FALSE FALSE re-edit same file, buffer is re-used
4063 * FALSE TRUE re-edit same file, nothing changes
4064 * TRUE FALSE start editing new file, new buffer
4065 * TRUE TRUE start editing in existing buffer (nothing to do)
4066 */
4067 if (!other_file && !oldbuf) /* re-use the buffer */
4068 {
4069 set_last_cursor(curwin); /* may set b_last_cursor */
4070 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4071 {
4072 newlnum = curwin->w_cursor.lnum;
4073 solcol = curwin->w_cursor.col;
4074 }
4075#ifdef FEAT_AUTOCMD
4076 buf = curbuf;
4077 if (buf->b_fname != NULL)
4078 new_name = vim_strsave(buf->b_fname);
4079 else
4080 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004081 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004083 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4084 {
4085 /* Save all the text, so that the reload can be undone.
4086 * Sync first so that this is a separate undo-able action. */
4087 u_sync(FALSE);
4088 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4089 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004090 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004091#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004092 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004093#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004094 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004095 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004096 u_unchanged(curbuf);
4097 buf_freeall(curbuf, BFA_KEEP_UNDO);
4098
4099 /* tell readfile() not to clear or reload undo info */
4100 readfile_flags = READ_KEEP_UNDO;
4101 }
4102 else
4103 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104#ifdef FEAT_AUTOCMD
4105 /* If autocommands deleted the buffer we were going to re-edit, give
4106 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004107 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 {
4109 delbuf_msg(new_name); /* frees new_name */
4110 goto theend;
4111 }
4112 vim_free(new_name);
4113
4114 /* If autocommands change buffers under our fingers, forget about
4115 * re-editing the file. Should do the buf_clear_file(), but perhaps
4116 * the autocommands changed the buffer... */
4117 if (buf != curbuf)
4118 goto theend;
4119# ifdef FEAT_EVAL
4120 if (aborting()) /* autocmds may abort script processing */
4121 goto theend;
4122# endif
4123#endif
4124 buf_clear_file(curbuf);
4125 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4126 curbuf->b_op_end.lnum = 0;
4127 }
4128
4129/*
4130 * If we get here we are sure to start editing
4131 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 /* Assume success now */
4133 retval = OK;
4134
4135 /*
4136 * Reset cursor position, could be used by autocommands.
4137 */
4138 check_cursor();
4139
4140 /*
4141 * Check if we are editing the w_arg_idx file in the argument list.
4142 */
4143 check_arg_idx(curwin);
4144
4145#ifdef FEAT_AUTOCMD
4146 if (!auto_buf)
4147#endif
4148 {
4149 /*
4150 * Set cursor and init window before reading the file and executing
4151 * autocommands. This allows for the autocommands to position the
4152 * cursor.
4153 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004154 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155
4156#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004157 /* It's possible that all lines in the buffer changed. Need to update
4158 * automatic folding for all windows where it's used. */
4159# ifdef FEAT_WINDOWS
4160 {
4161 win_T *win;
4162 tabpage_T *tp;
4163
4164 FOR_ALL_TAB_WINDOWS(tp, win)
4165 if (win->w_buffer == curbuf)
4166 foldUpdateAll(win);
4167 }
4168# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004170# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171#endif
4172
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004173 /* Change directories when the 'acd' option is set. */
4174 DO_AUTOCHDIR
4175
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 /*
4177 * Careful: open_buffer() and apply_autocmds() may change the current
4178 * buffer and window.
4179 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004180 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 topline = curwin->w_topline;
4182 if (!oldbuf) /* need to read the file */
4183 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004184#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 swap_exists_action = SEA_DIALOG;
4186#endif
4187 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4188
4189 /*
4190 * Open the buffer and read the file.
4191 */
4192#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004193 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 retval = FAIL;
4195#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004196 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197#endif
4198
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004199#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 if (swap_exists_action == SEA_QUIT)
4201 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004202 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203#endif
4204 }
4205#ifdef FEAT_AUTOCMD
4206 else
4207 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004208 /* Read the modelines, but only to set window-local options. Any
4209 * buffer-local options have already been set and may have been
4210 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004211 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004212
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4214 &retval);
4215 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4216 &retval);
4217 }
4218 check_arg_idx(curwin);
4219#endif
4220
Bram Moolenaareab316b2015-03-24 11:46:30 +01004221 /* If autocommands change the cursor position or topline, we should
4222 * keep it. Also when it moves within a line. */
4223 if (!equalpos(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 {
4225 newlnum = curwin->w_cursor.lnum;
4226 newcol = curwin->w_cursor.col;
4227 }
4228 if (curwin->w_topline == topline)
4229 topline = 0;
4230
4231 /* Even when cursor didn't move we need to recompute topline. */
4232 changed_line_abv_curs();
4233
4234#ifdef FEAT_TITLE
4235 maketitle();
4236#endif
4237 }
4238
4239#ifdef FEAT_DIFF
4240 /* Tell the diff stuff that this buffer is new and/or needs updating.
4241 * Also needed when re-editing the same buffer, because unloading will
4242 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004243 if (curwin->w_p_diff)
4244 {
4245 diff_buf_add(curbuf);
4246 diff_invalidate(curbuf);
4247 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248#endif
4249
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004250#ifdef FEAT_SPELL
4251 /* If the window options were changed may need to set the spell language.
4252 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004253 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4254 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004255#endif
4256
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 if (command == NULL)
4258 {
4259 if (newcol >= 0) /* position set by autocommands */
4260 {
4261 curwin->w_cursor.lnum = newlnum;
4262 curwin->w_cursor.col = newcol;
4263 check_cursor();
4264 }
4265 else if (newlnum > 0) /* line number from caller or old position */
4266 {
4267 curwin->w_cursor.lnum = newlnum;
4268 check_cursor_lnum();
4269 if (solcol >= 0 && !p_sol)
4270 {
4271 /* 'sol' is off: Use last known column. */
4272 curwin->w_cursor.col = solcol;
4273 check_cursor_col();
4274#ifdef FEAT_VIRTUALEDIT
4275 curwin->w_cursor.coladd = 0;
4276#endif
4277 curwin->w_set_curswant = TRUE;
4278 }
4279 else
4280 beginline(BL_SOL | BL_FIX);
4281 }
4282 else /* no line number, go to last line in Ex mode */
4283 {
4284 if (exmode_active)
4285 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4286 beginline(BL_WHITE | BL_FIX);
4287 }
4288 }
4289
4290#ifdef FEAT_WINDOWS
4291 /* Check if cursors in other windows on the same buffer are still valid */
4292 check_lnums(FALSE);
4293#endif
4294
4295 /*
4296 * Did not read the file, need to show some info about the file.
4297 * Do this after setting the cursor.
4298 */
4299 if (oldbuf
4300#ifdef FEAT_AUTOCMD
4301 && !auto_buf
4302#endif
4303 )
4304 {
4305 int msg_scroll_save = msg_scroll;
4306
4307 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4308 * message. */
4309 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4310 msg_scroll = FALSE;
4311 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4312 check_for_delay(FALSE);
4313 msg_start();
4314 msg_scroll = msg_scroll_save;
4315 msg_scrolled_ign = TRUE;
4316
Bram Moolenaar426dd022016-03-15 15:09:29 +01004317 if (!shortmess(SHM_FILEINFO))
4318 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319
4320 msg_scrolled_ign = FALSE;
4321 }
4322
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004323#ifdef FEAT_VIMINFO
4324 curbuf->b_last_used = vim_time();
4325#endif
4326
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 if (command != NULL)
4328 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4329
4330#ifdef FEAT_KEYMAP
4331 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004332 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333#endif
4334
4335 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004336 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 if (!skip_redraw)
4338 {
4339 n = p_so;
4340 if (topline == 0 && command == NULL)
4341 p_so = 999; /* force cursor halfway the window */
4342 update_topline();
4343#ifdef FEAT_SCROLLBIND
4344 curwin->w_scbind_pos = curwin->w_topline;
4345#endif
4346 p_so = n;
4347 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4348 }
4349
4350 if (p_im)
4351 need_start_insertmode = TRUE;
4352
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004353 /* Change directories when the 'acd' option is set. */
4354 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004356#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004357 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 {
4359# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004360 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4362# endif
4363# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004364 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004365 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366# endif
4367 }
4368#endif
4369
4370theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004371 if (did_inc_redrawing_disabled)
4372 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004373#ifdef FEAT_AUTOCMD
4374 if (did_set_swapcommand)
4375 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4376#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377#ifdef FEAT_BROWSE
4378 vim_free(browse_file);
4379#endif
4380 vim_free(free_fname);
4381 return retval;
4382}
4383
4384#ifdef FEAT_AUTOCMD
4385 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004386delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387{
4388 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4389 name == NULL ? (char_u *)"" : name);
4390 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004391 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004392 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393}
4394#endif
4395
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004396static int append_indent = 0; /* autoindent for first line */
4397
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398/*
4399 * ":insert" and ":append", also used by ":change"
4400 */
4401 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004402ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403{
4404 char_u *theline;
4405 int did_undo = FALSE;
4406 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004407 int indent = 0;
4408 char_u *p;
4409 int vcol;
4410 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004412 /* the ! flag toggles autoindent */
4413 if (eap->forceit)
4414 curbuf->b_p_ai = !curbuf->b_p_ai;
4415
4416 /* First autoindent comes from the line we start on */
4417 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4418 append_indent = get_indent_lnum(lnum);
4419
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 if (eap->cmdidx != CMD_append)
4421 --lnum;
4422
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004423 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004424 if (empty && lnum == 1)
4425 lnum = 0;
4426
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 State = INSERT; /* behave like in Insert mode */
4428 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4429 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004430
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004431 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 {
4433 msg_scroll = TRUE;
4434 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004435 if (curbuf->b_p_ai)
4436 {
4437 if (append_indent >= 0)
4438 {
4439 indent = append_indent;
4440 append_indent = -1;
4441 }
4442 else if (lnum > 0)
4443 indent = get_indent_lnum(lnum);
4444 }
4445 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004447 {
4448 /* No getline() function, use the lines that follow. This ends
4449 * when there is no more. */
4450 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4451 break;
4452 p = vim_strchr(eap->nextcmd, NL);
4453 if (p == NULL)
4454 p = eap->nextcmd + STRLEN(eap->nextcmd);
4455 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4456 if (*p != NUL)
4457 ++p;
4458 eap->nextcmd = p;
4459 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004461 {
4462 int save_State = State;
4463
4464 /* Set State to avoid the cursor shape to be set to INSERT mode
4465 * when getline() returns. */
4466 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 theline = eap->getline(
4468#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004469 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004471 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004472 State = save_State;
4473 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004475 if (theline == NULL)
4476 break;
4477
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004478 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4479 if (ex_keep_indent)
4480 append_indent = indent;
4481
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004482 /* Look for the "." after automatic indent. */
4483 vcol = 0;
4484 for (p = theline; indent > vcol; ++p)
4485 {
4486 if (*p == ' ')
4487 ++vcol;
4488 else if (*p == TAB)
4489 vcol += 8 - vcol % 8;
4490 else
4491 break;
4492 }
4493 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004494 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4495 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 {
4497 vim_free(theline);
4498 break;
4499 }
4500
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004501 /* don't use autoindent if nothing was typed. */
4502 if (p[0] == NUL)
4503 theline[0] = NUL;
4504
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 did_undo = TRUE;
4506 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004507 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
4509 vim_free(theline);
4510 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004511
4512 if (empty)
4513 {
4514 ml_delete(2L, FALSE);
4515 empty = FALSE;
4516 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 }
4518 State = NORMAL;
4519
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004520 if (eap->forceit)
4521 curbuf->b_p_ai = !curbuf->b_p_ai;
4522
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004524 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 * "end" is set to lnum when something has been appended, otherwise
4526 * it is the same than "start" -- Acevedo */
4527 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4528 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4529 if (eap->cmdidx != CMD_append)
4530 --curbuf->b_op_start.lnum;
4531 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4532 ? lnum : curbuf->b_op_start.lnum;
4533 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4534 curwin->w_cursor.lnum = lnum;
4535 check_cursor_lnum();
4536 beginline(BL_SOL | BL_FIX);
4537
4538 need_wait_return = FALSE; /* don't use wait_return() now */
4539 ex_no_reprint = TRUE;
4540}
4541
4542/*
4543 * ":change"
4544 */
4545 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004546ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547{
4548 linenr_T lnum;
4549
4550 if (eap->line2 >= eap->line1
4551 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4552 return;
4553
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004554 /* the ! flag toggles autoindent */
4555 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4556 append_indent = get_indent_lnum(eap->line1);
4557
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4559 {
4560 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4561 break;
4562 ml_delete(eap->line1, FALSE);
4563 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004564
4565 /* make sure the cursor is not beyond the end of the file now */
4566 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4568
4569 /* ":append" on the line above the deleted lines. */
4570 eap->line2 = eap->line1;
4571 ex_append(eap);
4572}
4573
4574 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004575ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576{
4577 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004578 int bigness;
4579 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 int minus = 0;
4581 linenr_T start, end, curs, i;
4582 int j;
4583 linenr_T lnum = eap->line2;
4584
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004585 /* Vi compatible: ":z!" uses display height, without a count uses
4586 * 'scroll' */
4587 if (eap->forceit)
4588 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004589#ifdef FEAT_WINDOWS
Bram Moolenaar631abc32014-02-22 22:27:47 +01004590 else if (firstwin != lastwin)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004591 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004592#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004593 else
4594 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 if (bigness < 1)
4596 bigness = 1;
4597
4598 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004599 kind = x;
4600 if (*kind == '-' || *kind == '+' || *kind == '='
4601 || *kind == '^' || *kind == '.')
4602 ++x;
4603 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 ++x;
4605
4606 if (*x != 0)
4607 {
4608 if (!VIM_ISDIGIT(*x))
4609 {
4610 EMSG(_("E144: non-numeric argument to :z"));
4611 return;
4612 }
4613 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004614 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004616 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004617 if (*kind == '=')
4618 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004619 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 }
4621
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004622 /* the number of '-' and '+' multiplies the distance */
4623 if (*kind == '-' || *kind == '+')
4624 for (x = kind + 1; *x == *kind; ++x)
4625 ;
4626
4627 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 {
4629 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004630 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4631 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004632 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 break;
4634
4635 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004636 start = lnum - (bigness + 1) / 2 + 1;
4637 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 curs = lnum;
4639 minus = 1;
4640 break;
4641
4642 case '^':
4643 start = lnum - bigness * 2;
4644 end = lnum - bigness;
4645 curs = lnum - bigness;
4646 break;
4647
4648 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004649 start = lnum - (bigness + 1) / 2 + 1;
4650 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 curs = end;
4652 break;
4653
4654 default: /* '+' */
4655 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004656 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004657 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004658 else if (eap->addr_count == 0)
4659 ++start;
4660 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 curs = end;
4662 break;
4663 }
4664
4665 if (start < 1)
4666 start = 1;
4667
4668 if (end > curbuf->b_ml.ml_line_count)
4669 end = curbuf->b_ml.ml_line_count;
4670
4671 if (curs > curbuf->b_ml.ml_line_count)
4672 curs = curbuf->b_ml.ml_line_count;
4673
4674 for (i = start; i <= end; i++)
4675 {
4676 if (minus && i == lnum)
4677 {
4678 msg_putchar('\n');
4679
4680 for (j = 1; j < Columns; j++)
4681 msg_putchar('-');
4682 }
4683
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004684 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
4686 if (minus && i == lnum)
4687 {
4688 msg_putchar('\n');
4689
4690 for (j = 1; j < Columns; j++)
4691 msg_putchar('-');
4692 }
4693 }
4694
4695 curwin->w_cursor.lnum = curs;
4696 ex_no_reprint = TRUE;
4697}
4698
4699/*
4700 * Check if the restricted flag is set.
4701 * If so, give an error message and return TRUE.
4702 * Otherwise, return FALSE.
4703 */
4704 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004705check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706{
4707 if (restricted)
4708 {
4709 EMSG(_("E145: Shell commands not allowed in rvim"));
4710 return TRUE;
4711 }
4712 return FALSE;
4713}
4714
4715/*
4716 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4717 * If so, give an error message and return TRUE.
4718 * Otherwise, return FALSE.
4719 */
4720 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004721check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722{
4723 if (secure)
4724 {
4725 secure = 2;
4726 EMSG(_(e_curdir));
4727 return TRUE;
4728 }
4729#ifdef HAVE_SANDBOX
4730 /*
4731 * In the sandbox more things are not allowed, including the things
4732 * disallowed in secure mode.
4733 */
4734 if (sandbox != 0)
4735 {
4736 EMSG(_(e_sandbox));
4737 return TRUE;
4738 }
4739#endif
4740 return FALSE;
4741}
4742
4743static char_u *old_sub = NULL; /* previous substitute pattern */
4744static int global_need_beginline; /* call beginline() after ":g" */
4745
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004746/*
4747 * Flags that are kept between calls to :substitute.
4748 */
4749typedef struct {
4750 int do_all; /* do multiple substitutions per line */
4751 int do_ask; /* ask for confirmation */
4752 int do_count; /* count only */
4753 int do_error; /* if false, ignore errors */
4754 int do_print; /* print last line with subs. */
4755 int do_list; /* list last line with subs. */
4756 int do_number; /* list last line with line nr*/
4757 int do_ic; /* ignore case flag */
4758} subflags_T;
4759
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760/* do_sub()
4761 *
4762 * Perform a substitution from line eap->line1 to line eap->line2 using the
4763 * command pointed to by eap->arg which should be of the form:
4764 *
4765 * /pattern/substitution/{flags}
4766 *
4767 * The usual escapes are supported as described in the regexp docs.
4768 */
4769 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004770do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771{
4772 linenr_T lnum;
4773 long i = 0;
4774 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004775 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4776 FALSE, FALSE, 0};
4777#ifdef FEAT_EVAL
4778 subflags_T subflags_save;
4779#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004780 int save_do_all; /* remember user specified 'g' flag */
4781 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4783 int delimiter;
4784 int sublen;
4785 int got_quit = FALSE;
4786 int got_match = FALSE;
4787 int temp;
4788 int which_pat;
4789 char_u *cmd;
4790 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004791 linenr_T first_line = 0; /* first changed line */
4792 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 * change */
4794 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4795 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004796 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004797 char_u *sub_firstline; /* allocated copy of first sub line */
4798 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004799 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004800 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004801#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004802 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004803#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804
4805 cmd = eap->arg;
4806 if (!global_busy)
4807 {
4808 sub_nsubs = 0;
4809 sub_nlines = 0;
4810 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004811 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 if (eap->cmdidx == CMD_tilde)
4814 which_pat = RE_LAST; /* use last used regexp */
4815 else
4816 which_pat = RE_SUBST; /* use last substitute regexp */
4817
4818 /* new pattern and substitution */
4819 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4820 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4821 {
4822 /* don't accept alphanumeric for separator */
4823 if (isalpha(*cmd))
4824 {
4825 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4826 return;
4827 }
4828 /*
4829 * undocumented vi feature:
4830 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4831 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4832 */
4833 if (*cmd == '\\')
4834 {
4835 ++cmd;
4836 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4837 {
4838 EMSG(_(e_backslash));
4839 return;
4840 }
4841 if (*cmd != '&')
4842 which_pat = RE_SEARCH; /* use last '/' pattern */
4843 pat = (char_u *)""; /* empty search pattern */
4844 delimiter = *cmd++; /* remember delimiter character */
4845 }
4846 else /* find the end of the regexp */
4847 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004848#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4849 if (p_altkeymap && curwin->w_p_rl)
4850 lrF_sub(cmd);
4851#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 which_pat = RE_LAST; /* use last used regexp */
4853 delimiter = *cmd++; /* remember delimiter character */
4854 pat = cmd; /* remember start of search pat */
4855 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4856 if (cmd[0] == delimiter) /* end delimiter found */
4857 *cmd++ = NUL; /* replace it with a NUL */
4858 }
4859
4860 /*
4861 * Small incompatibility: vi sees '\n' as end of the command, but in
4862 * Vim we want to use '\n' to find/substitute a NUL.
4863 */
4864 sub = cmd; /* remember the start of the substitution */
4865
4866 while (cmd[0])
4867 {
4868 if (cmd[0] == delimiter) /* end delimiter found */
4869 {
4870 *cmd++ = NUL; /* replace it with a NUL */
4871 break;
4872 }
4873 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4874 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004875 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 }
4877
4878 if (!eap->skip)
4879 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004880 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4881 if (STRCMP(sub, "%") == 0
4882 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4883 {
4884 if (old_sub == NULL) /* there is no previous command */
4885 {
4886 EMSG(_(e_nopresub));
4887 return;
4888 }
4889 sub = old_sub;
4890 }
4891 else
4892 {
4893 vim_free(old_sub);
4894 old_sub = vim_strsave(sub);
4895 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 }
4897 }
4898 else if (!eap->skip) /* use previous pattern and substitution */
4899 {
4900 if (old_sub == NULL) /* there is no previous command */
4901 {
4902 EMSG(_(e_nopresub));
4903 return;
4904 }
4905 pat = NULL; /* search_regcomp() will use previous pattern */
4906 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004907
4908 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4909 * last column after using "$". */
4910 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 }
4912
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004913 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4914 * more efficient.
4915 * TODO: find a generic solution to make line-joining operations more
4916 * efficient, avoid allocating a string that grows in size.
4917 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004918 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004919 && *sub == NUL
4920 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4921 || *cmd == 'p' || *cmd == '#'))))
4922 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004923 linenr_T joined_lines_count;
4924
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004925 curwin->w_cursor.lnum = eap->line1;
4926 if (*cmd == 'l')
4927 eap->flags = EXFLAG_LIST;
4928 else if (*cmd == '#')
4929 eap->flags = EXFLAG_NR;
4930 else if (*cmd == 'p')
4931 eap->flags = EXFLAG_PRINT;
4932
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004933 /* The number of lines joined is the number of lines in the range plus
4934 * one. One less when the last line is included. */
4935 joined_lines_count = eap->line2 - eap->line1 + 1;
4936 if (eap->line2 < curbuf->b_ml.ml_line_count)
4937 ++joined_lines_count;
4938 if (joined_lines_count > 1)
4939 {
4940 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4941 sub_nsubs = joined_lines_count - 1;
4942 sub_nlines = 1;
4943 (void)do_sub_msg(FALSE);
4944 ex_may_print(eap);
4945 }
4946
4947 if (!cmdmod.keeppatterns)
4948 save_re_pat(RE_SUBST, pat, p_magic);
4949#ifdef FEAT_CMDHIST
4950 /* put pattern in history */
4951 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4952#endif
4953
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004954 return;
4955 }
4956
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 /*
4958 * Find trailing options. When '&' is used, keep old options.
4959 */
4960 if (*cmd == '&')
4961 ++cmd;
4962 else
4963 {
4964 if (!p_ed)
4965 {
4966 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004967 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004969 subflags.do_all = FALSE;
4970 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004972 subflags.do_error = TRUE;
4973 subflags.do_print = FALSE;
4974 subflags.do_count = FALSE;
4975 subflags.do_number = FALSE;
4976 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 }
4978 while (*cmd)
4979 {
4980 /*
4981 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4982 * 'r' is never inverted.
4983 */
4984 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004985 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004987 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004988 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004989 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004991 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 else if (*cmd == 'r') /* use last used regexp */
4993 which_pat = RE_LAST;
4994 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004995 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004996 else if (*cmd == '#')
4997 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004998 subflags.do_print = TRUE;
4999 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005000 }
5001 else if (*cmd == 'l')
5002 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005003 subflags.do_print = TRUE;
5004 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005005 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005007 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005009 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 else
5011 break;
5012 ++cmd;
5013 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005014 if (subflags.do_count)
5015 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005017 save_do_all = subflags.do_all;
5018 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005019
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 /*
5021 * check for a trailing count
5022 */
5023 cmd = skipwhite(cmd);
5024 if (VIM_ISDIGIT(*cmd))
5025 {
5026 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005027 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 {
5029 EMSG(_(e_zerocount));
5030 return;
5031 }
5032 eap->line1 = eap->line2;
5033 eap->line2 += i - 1;
5034 if (eap->line2 > curbuf->b_ml.ml_line_count)
5035 eap->line2 = curbuf->b_ml.ml_line_count;
5036 }
5037
5038 /*
5039 * check for trailing command or garbage
5040 */
5041 cmd = skipwhite(cmd);
5042 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5043 {
5044 eap->nextcmd = check_nextcmd(cmd);
5045 if (eap->nextcmd == NULL)
5046 {
5047 EMSG(_(e_trailing));
5048 return;
5049 }
5050 }
5051
5052 if (eap->skip) /* not executing commands, only parsing */
5053 return;
5054
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005055 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005056 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005057 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005058 EMSG(_(e_modifiable));
5059 return;
5060 }
5061
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5063 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005064 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 EMSG(_(e_invcmd));
5066 return;
5067 }
5068
5069 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005070 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005072 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 regmatch.rmm_ic = FALSE;
5074
5075 sub_firstline = NULL;
5076
5077 /*
5078 * ~ in the substitute pattern is replaced with the old pattern.
5079 * We do it here once to avoid it to be replaced over and over again.
5080 * But don't do it when it starts with "\=", then it's an expression.
5081 */
5082 if (!(sub[0] == '\\' && sub[1] == '='))
5083 sub = regtilde(sub, p_magic);
5084
5085 /*
5086 * Check for a match on each line.
5087 */
5088 line2 = eap->line2;
5089 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5090#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5091 || aborting()
5092#endif
5093 ); ++lnum)
5094 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005095 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5096 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 if (nmatch)
5098 {
5099 colnr_T copycol;
5100 colnr_T matchcol;
5101 colnr_T prev_matchcol = MAXCOL;
5102 char_u *new_end, *new_start = NULL;
5103 unsigned new_start_len = 0;
5104 char_u *p1;
5105 int did_sub = FALSE;
5106 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005107 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 long nmatch_tl = 0; /* nr of lines matched below lnum */
5109 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005110 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005111 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112
5113 /*
5114 * The new text is build up step by step, to avoid too much
5115 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005116 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 * copycol Column in the old text where we started
5118 * looking for a match; from here old text still
5119 * needs to be copied to the new text.
5120 * matchcol Column number of the old text where to look
5121 * for the next match. It's just after the
5122 * previous match or one further.
5123 * prev_matchcol Column just after the previous match (if any).
5124 * Mostly equal to matchcol, except for the first
5125 * match and after skipping an empty match.
5126 * regmatch.*pos Where the pattern matched in the old text.
5127 * new_start The new text, all that has been produced so
5128 * far.
5129 * new_end The new text, where to append new text.
5130 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005131 * lnum The line number where we found the start of
5132 * the match. Can be below the line we searched
5133 * when there is a \n before a \zs in the
5134 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 * sub_firstlnum The line number in the buffer where to look
5136 * for a match. Can be different from "lnum"
5137 * when the pattern or substitute string contains
5138 * line breaks.
5139 *
5140 * Special situations:
5141 * - When the substitute string contains a line break, the part up
5142 * to the line break is inserted in the text, but the copy of
5143 * the original line is kept. "sub_firstlnum" is adjusted for
5144 * the inserted lines.
5145 * - When the matched pattern contains a line break, the old line
5146 * is taken from the line at the end of the pattern. The lines
5147 * in the match are deleted later, "sub_firstlnum" is adjusted
5148 * accordingly.
5149 *
5150 * The new text is built up in new_start[]. It has some extra
5151 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005152 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 *
5154 * Make a copy of the old line, so it won't be taken away when
5155 * updating the screen or handling a multi-line match. The "old_"
5156 * pointers point into this copy.
5157 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005158 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 copycol = 0;
5160 matchcol = 0;
5161
5162 /* At first match, remember current cursor position. */
5163 if (!got_match)
5164 {
5165 setpcmark();
5166 got_match = TRUE;
5167 }
5168
5169 /*
5170 * Loop until nothing more to replace in this line.
5171 * 1. Handle match with empty string.
5172 * 2. If do_ask is set, ask for confirmation.
5173 * 3. substitute the string.
5174 * 4. if do_all is set, find next match
5175 * 5. break if there isn't another match in this line
5176 */
5177 for (;;)
5178 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005179 /* Advance "lnum" to the line where the match starts. The
5180 * match does not start in the first line when there is a line
5181 * break before \zs. */
5182 if (regmatch.startpos[0].lnum > 0)
5183 {
5184 lnum += regmatch.startpos[0].lnum;
5185 sub_firstlnum += regmatch.startpos[0].lnum;
5186 nmatch -= regmatch.startpos[0].lnum;
5187 vim_free(sub_firstline);
5188 sub_firstline = NULL;
5189 }
5190
5191 if (sub_firstline == NULL)
5192 {
5193 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5194 if (sub_firstline == NULL)
5195 {
5196 vim_free(new_start);
5197 goto outofmem;
5198 }
5199 }
5200
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 /* Save the line number of the last change for the final
5202 * cursor position (just like Vi). */
5203 curwin->w_cursor.lnum = lnum;
5204 do_again = FALSE;
5205
5206 /*
5207 * 1. Match empty string does not count, except for first
5208 * match. This reproduces the strange vi behaviour.
5209 * This also catches endless loops.
5210 */
5211 if (matchcol == prev_matchcol
5212 && regmatch.endpos[0].lnum == 0
5213 && matchcol == regmatch.endpos[0].col)
5214 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005215 if (sub_firstline[matchcol] == NUL)
5216 /* We already were at the end of the line. Don't look
5217 * for a match in this line again. */
5218 skip_match = TRUE;
5219 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005220 {
5221 /* search for a match at next column */
5222#ifdef FEAT_MBYTE
5223 if (has_mbyte)
5224 matchcol += mb_ptr2len(sub_firstline + matchcol);
5225 else
5226#endif
5227 ++matchcol;
5228 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 goto skip;
5230 }
5231
5232 /* Normally we continue searching for a match just after the
5233 * previous match. */
5234 matchcol = regmatch.endpos[0].col;
5235 prev_matchcol = matchcol;
5236
5237 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005238 * 2. If do_count is set only increase the counter.
5239 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005241 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005242 {
5243 /* For a multi-line match, put matchcol at the NUL at
5244 * the end of the line and set nmatch to one, so that
5245 * we continue looking for a match on the next line.
5246 * Avoids that ":s/\nB\@=//gc" get stuck. */
5247 if (nmatch > 1)
5248 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005249 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005250 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005251 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005252 }
5253 sub_nsubs++;
5254 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005255#ifdef FEAT_EVAL
5256 /* Skip the substitution, unless an expression is used,
5257 * then it is evaluated in the sandbox. */
5258 if (!(sub[0] == '\\' && sub[1] == '='))
5259#endif
5260 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005261 }
5262
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005263 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005265 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005266
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 /* change State to CONFIRM, so that the mouse works
5268 * properly */
5269 save_State = State;
5270 State = CONFIRM;
5271#ifdef FEAT_MOUSE
5272 setmouse(); /* disable mouse in xterm */
5273#endif
5274 curwin->w_cursor.col = regmatch.startpos[0].col;
5275
5276 /* When 'cpoptions' contains "u" don't sync undo when
5277 * asking for confirmation. */
5278 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5279 ++no_u_sync;
5280
5281 /*
5282 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5283 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005284 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005286 if (exmode_active)
5287 {
5288 char_u *resp;
5289 colnr_T sc, ec;
5290
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005291 print_line_no_prefix(lnum,
5292 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005293
5294 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5295 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
5296 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005297 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005298 {
5299 int numw = number_width(curwin) + 1;
5300 sc += numw;
5301 ec += numw;
5302 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005303 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005304 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005305 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005306 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005307 msg_putchar('^');
5308
5309 resp = getexmodeline('?', NULL, 0);
5310 if (resp != NULL)
5311 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005312 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005313 vim_free(resp);
5314 }
5315 }
5316 else
5317 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005318 char_u *orig_line = NULL;
5319 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005321 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005323 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005325 /* Invert the matched string.
5326 * Remove the inversion afterwards. */
5327 temp = RedrawingDisabled;
5328 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005330 if (new_start != NULL)
5331 {
5332 /* There already was a substitution, we would
5333 * like to show this to the user. We cannot
5334 * really update the line, it would change
5335 * what matches. Temporarily replace the line
5336 * and change it back afterwards. */
5337 orig_line = vim_strsave(ml_get(lnum));
5338 if (orig_line != NULL)
5339 {
5340 char_u *new_line = concat_str(new_start,
5341 sub_firstline + copycol);
5342
5343 if (new_line == NULL)
5344 {
5345 vim_free(orig_line);
5346 orig_line = NULL;
5347 }
5348 else
5349 {
5350 /* Position the cursor relative to the
5351 * end of the line, the previous
5352 * substitute may have inserted or
5353 * deleted characters before the
5354 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005355 len_change = (int)STRLEN(new_line)
5356 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005357 curwin->w_cursor.col += len_change;
5358 ml_replace(lnum, new_line, FALSE);
5359 }
5360 }
5361 }
5362
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005363 search_match_lines = regmatch.endpos[0].lnum
5364 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005365 search_match_endcol = regmatch.endpos[0].col
5366 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005367 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005369 update_topline();
5370 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005371 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005372 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005373 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374
5375#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005376 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005378 if (msg_row == Rows - 1)
5379 msg_didout = FALSE; /* avoid a scroll-up */
5380 msg_starthere();
5381 i = msg_scroll;
5382 msg_scroll = 0; /* truncate msg when
5383 needed */
5384 msg_no_more = TRUE;
5385 /* write message same highlighting as for
5386 * wait_return */
5387 smsg_attr(hl_attr(HLF_R),
5388 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5389 msg_no_more = FALSE;
5390 msg_scroll = i;
5391 showruler(TRUE);
5392 windgoto(msg_row, msg_col);
5393 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394
5395#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005396 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005398 ++no_mapping; /* don't map this key */
5399 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005400 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005401 --allow_keys;
5402 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005404 /* clear the question */
5405 msg_didout = FALSE; /* don't scroll up */
5406 msg_col = 0;
5407 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005408
5409 /* restore the line */
5410 if (orig_line != NULL)
5411 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005412 }
5413
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005415 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005417 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418#endif
5419 )
5420 {
5421 got_quit = TRUE;
5422 break;
5423 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005424 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005426 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005428 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 {
5430 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005431 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 line2 = lnum;
5433 break;
5434 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005435 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005437 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 break;
5439 }
5440#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005441 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005443 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 scrolldown_clamp();
5445#endif
5446 }
5447 State = save_State;
5448#ifdef FEAT_MOUSE
5449 setmouse();
5450#endif
5451 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5452 --no_u_sync;
5453
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005454 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 {
5456 /* For a multi-line match, put matchcol at the NUL at
5457 * the end of the line and set nmatch to one, so that
5458 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005459 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5460 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 if (nmatch > 1)
5462 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005463 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005464 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 }
5466 goto skip;
5467 }
5468 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005469 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 }
5471
5472 /* Move the cursor to the start of the match, so that we can
5473 * use "\=col("."). */
5474 curwin->w_cursor.col = regmatch.startpos[0].col;
5475
5476 /*
5477 * 3. substitute the string.
5478 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005479#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005480 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005481 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005482 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005483 save_ma = curbuf->b_p_ma;
5484 curbuf->b_p_ma = FALSE;
5485 sandbox++;
5486 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005487 /* Save flags for recursion. They can change for e.g.
5488 * :s/^/\=execute("s#^##gn") */
5489 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005490#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005492 sublen = vim_regsub_multi(&regmatch,
5493 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005495#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005496 /* Don't keep flags set by a recursive call. */
5497 subflags = subflags_save;
5498 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005499 {
5500 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005501 if (sandbox > 0)
5502 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005503 goto skip;
5504 }
5505#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506
Bram Moolenaar4463f292005-09-25 22:20:24 +00005507 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005508 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005509 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5510 {
5511 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5512 skip_match = TRUE;
5513 }
5514
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 /* Need room for:
5516 * - result so far in new_start (not for first sub in line)
5517 * - original text up to match
5518 * - length of substituted part
5519 * - original text after match
5520 */
5521 if (nmatch == 1)
5522 p1 = sub_firstline;
5523 else
5524 {
5525 p1 = ml_get(sub_firstlnum + nmatch - 1);
5526 nmatch_tl += nmatch - 1;
5527 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005528 copy_len = regmatch.startpos[0].col - copycol;
5529 needed_len = copy_len + ((unsigned)STRLEN(p1)
5530 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 if (new_start == NULL)
5532 {
5533 /*
5534 * Get some space for a temporary buffer to do the
5535 * substitution into (and some extra space to avoid
5536 * too many calls to alloc()/free()).
5537 */
5538 new_start_len = needed_len + 50;
5539 if ((new_start = alloc_check(new_start_len)) == NULL)
5540 goto outofmem;
5541 *new_start = NUL;
5542 new_end = new_start;
5543 }
5544 else
5545 {
5546 /*
5547 * Check if the temporary buffer is long enough to do the
5548 * substitution into. If not, make it larger (with a bit
5549 * extra to avoid too many calls to alloc()/free()).
5550 */
5551 len = (unsigned)STRLEN(new_start);
5552 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005553 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 {
5555 new_start_len = needed_len + 50;
5556 if ((p1 = alloc_check(new_start_len)) == NULL)
5557 {
5558 vim_free(new_start);
5559 goto outofmem;
5560 }
5561 mch_memmove(p1, new_start, (size_t)(len + 1));
5562 vim_free(new_start);
5563 new_start = p1;
5564 }
5565 new_end = new_start + len;
5566 }
5567
5568 /*
5569 * copy the text up to the part that matched
5570 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005571 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5572 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005574 (void)vim_regsub_multi(&regmatch,
5575 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 sub, new_end, TRUE, p_magic, TRUE);
5577 sub_nsubs++;
5578 did_sub = TRUE;
5579
5580 /* Move the cursor to the start of the line, to avoid that it
5581 * is beyond the end of the line after the substitution. */
5582 curwin->w_cursor.col = 0;
5583
5584 /* For a multi-line match, make a copy of the last matched
5585 * line and continue in that one. */
5586 if (nmatch > 1)
5587 {
5588 sub_firstlnum += nmatch - 1;
5589 vim_free(sub_firstline);
5590 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5591 /* When going beyond the last line, stop substituting. */
5592 if (sub_firstlnum <= line2)
5593 do_again = TRUE;
5594 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005595 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 }
5597
5598 /* Remember next character to be copied. */
5599 copycol = regmatch.endpos[0].col;
5600
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005601 if (skip_match)
5602 {
5603 /* Already hit end of the buffer, sub_firstlnum is one
5604 * less than what it ought to be. */
5605 vim_free(sub_firstline);
5606 sub_firstline = vim_strsave((char_u *)"");
5607 copycol = 0;
5608 }
5609
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 /*
5611 * Now the trick is to replace CTRL-M chars with a real line
5612 * break. This would make it impossible to insert a CTRL-M in
5613 * the text. The line break can be avoided by preceding the
5614 * CTRL-M with a backslash. To be able to insert a backslash,
5615 * they must be doubled in the string and are halved here.
5616 * That is Vi compatible.
5617 */
5618 for (p1 = new_end; *p1; ++p1)
5619 {
5620 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005621 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 else if (*p1 == CAR)
5623 {
5624 if (u_inssub(lnum) == OK) /* prepare for undo */
5625 {
5626 *p1 = NUL; /* truncate up to the CR */
5627 ml_append(lnum - 1, new_start,
5628 (colnr_T)(p1 - new_start + 1), FALSE);
5629 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005630 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 appended_lines(lnum - 1, 1L);
5632 else
5633 {
5634 if (first_line == 0)
5635 first_line = lnum;
5636 last_line = lnum + 1;
5637 }
5638 /* All line numbers increase. */
5639 ++sub_firstlnum;
5640 ++lnum;
5641 ++line2;
5642 /* move the cursor to the new line, like Vi */
5643 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005644 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005645 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 p1 = new_start - 1;
5647 }
5648 }
5649#ifdef FEAT_MBYTE
5650 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005651 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652#endif
5653 }
5654
5655 /*
5656 * 4. If do_all is set, find next match.
5657 * Prevent endless loop with patterns that match empty
5658 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5659 * But ":s/\n/#/" is OK.
5660 */
5661skip:
5662 /* We already know that we did the last subst when we are at
5663 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005664 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5665 * "line2" when there is a \zs in the pattern after a line
5666 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005667 lastone = (skip_match
5668 || got_int
5669 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005670 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005671 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005672 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5673 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 nmatch = -1;
5675
5676 /*
5677 * Replace the line in the buffer when needed. This is
5678 * skipped when there are more matches.
5679 * The check for nmatch_tl is needed for when multi-line
5680 * matching must replace the lines before trying to do another
5681 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005682 * When the match starts below where we start searching also
5683 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 */
5685 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 || nmatch_tl > 0
5687 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005688 curbuf, sub_firstlnum,
5689 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005690 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 {
5692 if (new_start != NULL)
5693 {
5694 /*
5695 * Copy the rest of the line, that didn't match.
5696 * "matchcol" has to be adjusted, we use the end of
5697 * the line as reference, because the substitute may
5698 * have changed the number of characters. Same for
5699 * "prev_matchcol".
5700 */
5701 STRCAT(new_start, sub_firstline + copycol);
5702 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5703 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5704 - prev_matchcol;
5705
5706 if (u_savesub(lnum) != OK)
5707 break;
5708 ml_replace(lnum, new_start, TRUE);
5709
5710 if (nmatch_tl > 0)
5711 {
5712 /*
5713 * Matched lines have now been substituted and are
5714 * useless, delete them. The part after the match
5715 * has been appended to new_start, we don't need
5716 * it in the buffer.
5717 */
5718 ++lnum;
5719 if (u_savedel(lnum, nmatch_tl) != OK)
5720 break;
5721 for (i = 0; i < nmatch_tl; ++i)
5722 ml_delete(lnum, (int)FALSE);
5723 mark_adjust(lnum, lnum + nmatch_tl - 1,
5724 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005725 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 deleted_lines(lnum, nmatch_tl);
5727 --lnum;
5728 line2 -= nmatch_tl; /* nr of lines decreases */
5729 nmatch_tl = 0;
5730 }
5731
5732 /* When asking, undo is saved each time, must also set
5733 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005734 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 changed_bytes(lnum, 0);
5736 else
5737 {
5738 if (first_line == 0)
5739 first_line = lnum;
5740 last_line = lnum + 1;
5741 }
5742
5743 sub_firstlnum = lnum;
5744 vim_free(sub_firstline); /* free the temp buffer */
5745 sub_firstline = new_start;
5746 new_start = NULL;
5747 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5748 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5749 - prev_matchcol;
5750 copycol = 0;
5751 }
5752 if (nmatch == -1 && !lastone)
5753 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005754 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755
5756 /*
5757 * 5. break if there isn't another match in this line
5758 */
5759 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005760 {
5761 /* If the match found didn't start where we were
5762 * searching, do the next search in the line where we
5763 * found the match. */
5764 if (nmatch == -1)
5765 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005767 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 }
5769
5770 line_breakcheck();
5771 }
5772
5773 if (did_sub)
5774 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005775 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 vim_free(sub_firstline); /* free the copy of the original line */
5777 sub_firstline = NULL;
5778 }
5779
5780 line_breakcheck();
5781 }
5782
5783 if (first_line != 0)
5784 {
5785 /* Need to subtract the number of added lines from "last_line" to get
5786 * the line number before the change (same as adding the number of
5787 * deleted lines). */
5788 i = curbuf->b_ml.ml_line_count - old_line_count;
5789 changed_lines(first_line, 0, last_line - i, i);
5790 }
5791
5792outofmem:
5793 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005794
5795 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005796 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005797 curwin->w_cursor = old_cursor;
5798
Bram Moolenaar46475522010-03-23 17:36:29 +01005799 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 {
5801 /* Set the '[ and '] marks. */
5802 curbuf->b_op_start.lnum = eap->line1;
5803 curbuf->b_op_end.lnum = line2;
5804 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5805
5806 if (!global_busy)
5807 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005808 /* when interactive leave cursor on the match */
5809 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005810 {
5811 if (endcolumn)
5812 coladvance((colnr_T)MAXCOL);
5813 else
5814 beginline(BL_WHITE | BL_FIX);
5815 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005816 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 MSG("");
5818 }
5819 else
5820 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005821 if (subflags.do_print)
5822 print_line(curwin->w_cursor.lnum,
5823 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 }
5825 else if (!global_busy)
5826 {
5827 if (got_int) /* interrupted */
5828 EMSG(_(e_interr));
5829 else if (got_match) /* did find something but nothing substituted */
5830 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005831 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 EMSG2(_(e_patnotf2), get_search_pat());
5833 }
5834
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005835#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005836 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005837 /* Cursor position may require updating */
5838 changed_window_setting();
5839#endif
5840
Bram Moolenaar473de612013-06-08 18:19:48 +02005841 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005842
5843 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005844 subflags.do_all = save_do_all;
5845 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846}
5847
5848/*
5849 * Give message for number of substitutions.
5850 * Can also be used after a ":global" command.
5851 * Return TRUE if a message was given.
5852 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005853 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005854do_sub_msg(
5855 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856{
5857 /*
5858 * Only report substitutions when:
5859 * - more than 'report' substitutions
5860 * - command was typed by user, or number of changed lines > 'report'
5861 * - giving messages is not disabled by 'lazyredraw'
5862 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005863 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5864 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 && messaging())
5866 {
5867 if (got_int)
5868 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005869 else
5870 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005872 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005873 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005875 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005876 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 sub_nsubs);
5878 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005879 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005880 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005882 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005883 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005886 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 return TRUE;
5888 }
5889 if (got_int)
5890 {
5891 EMSG(_(e_interr));
5892 return TRUE;
5893 }
5894 return FALSE;
5895}
5896
5897/*
5898 * Execute a global command of the form:
5899 *
5900 * g/pattern/X : execute X on all lines where pattern matches
5901 * v/pattern/X : execute X on all lines where pattern does not match
5902 *
5903 * where 'X' is an EX command
5904 *
5905 * The command character (as well as the trailing slash) is optional, and
5906 * is assumed to be 'p' if missing.
5907 *
5908 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005909 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 * for each line that has a mark. This is required because after deleting
5911 * lines we do not know where to search for the next match.
5912 */
5913 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005914ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915{
5916 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005917 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 int type; /* first char of cmd: 'v' or 'g' */
5919 char_u *cmd; /* command argument */
5920
5921 char_u delim; /* delimiter, normally '/' */
5922 char_u *pat;
5923 regmmatch_T regmatch;
5924 int match;
5925 int which_pat;
5926
5927 if (global_busy)
5928 {
5929 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5930 return;
5931 }
5932
5933 if (eap->forceit) /* ":global!" is like ":vglobal" */
5934 type = 'v';
5935 else
5936 type = *eap->cmd;
5937 cmd = eap->arg;
5938 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939
5940 /*
5941 * undocumented vi feature:
5942 * "\/" and "\?": use previous search pattern.
5943 * "\&": use previous substitute pattern.
5944 */
5945 if (*cmd == '\\')
5946 {
5947 ++cmd;
5948 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5949 {
5950 EMSG(_(e_backslash));
5951 return;
5952 }
5953 if (*cmd == '&')
5954 which_pat = RE_SUBST; /* use previous substitute pattern */
5955 else
5956 which_pat = RE_SEARCH; /* use previous search pattern */
5957 ++cmd;
5958 pat = (char_u *)"";
5959 }
5960 else if (*cmd == NUL)
5961 {
5962 EMSG(_("E148: Regular expression missing from global"));
5963 return;
5964 }
5965 else
5966 {
5967 delim = *cmd; /* get the delimiter */
5968 if (delim)
5969 ++cmd; /* skip delimiter if there is one */
5970 pat = cmd; /* remember start of pattern */
5971 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5972 if (cmd[0] == delim) /* end delimiter found */
5973 *cmd++ = NUL; /* replace it with a NUL */
5974 }
5975
5976#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5977 if (p_altkeymap && curwin->w_p_rl)
5978 lrFswap(pat,0);
5979#endif
5980
5981 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5982 {
5983 EMSG(_(e_invcmd));
5984 return;
5985 }
5986
5987 /*
5988 * pass 1: set marks for each (not) matching line
5989 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5991 {
5992 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005993 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5994 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 if ((type == 'g' && match) || (type == 'v' && !match))
5996 {
5997 ml_setmarked(lnum);
5998 ndone++;
5999 }
6000 line_breakcheck();
6001 }
6002
6003 /*
6004 * pass 2: execute the command for each line that has been marked
6005 */
6006 if (got_int)
6007 MSG(_(e_interr));
6008 else if (ndone == 0)
6009 {
6010 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00006011 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01006013 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 }
6015 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006016 {
6017#ifdef FEAT_CLIPBOARD
6018 start_global_changes();
6019#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006021#ifdef FEAT_CLIPBOARD
6022 end_global_changes();
6023#endif
6024 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025
6026 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02006027 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028}
6029
6030/*
6031 * Execute "cmd" on lines marked with ml_setmarked().
6032 */
6033 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006034global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006036 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6037 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6038 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039
6040 /*
6041 * Set current position only once for a global command.
6042 * If global_busy is set, setpcmark() will not do anything.
6043 * If there is an error, global_busy will be incremented.
6044 */
6045 setpcmark();
6046
6047 /* When the command writes a message, don't overwrite the command. */
6048 msg_didout = TRUE;
6049
Bram Moolenaard25bc232010-03-23 17:49:24 +01006050 sub_nsubs = 0;
6051 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 global_need_beginline = FALSE;
6053 global_busy = 1;
6054 old_lcount = curbuf->b_ml.ml_line_count;
6055 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6056 {
6057 curwin->w_cursor.lnum = lnum;
6058 curwin->w_cursor.col = 0;
6059 if (*cmd == NUL || *cmd == '\n')
6060 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6061 else
6062 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6063 ui_breakcheck();
6064 }
6065
6066 global_busy = 0;
6067 if (global_need_beginline)
6068 beginline(BL_WHITE | BL_FIX);
6069 else
6070 check_cursor(); /* cursor may be beyond the end of the line */
6071
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006072 /* the cursor may not have moved in the text but a change in a previous
6073 * line may move it on the screen */
6074 changed_line_abv_curs();
6075
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 /* If it looks like no message was written, allow overwriting the
6077 * command with the report for number of changes. */
6078 if (msg_col == 0 && msg_scrolled == 0)
6079 msg_didout = FALSE;
6080
Bram Moolenaar45667512007-05-10 19:24:43 +00006081 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006082 * number of extra or deleted lines.
6083 * Don't report extra or deleted lines in the edge case where the buffer
6084 * we are in after execution is different from the buffer we started in. */
6085 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6087}
6088
6089#ifdef FEAT_VIMINFO
6090 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006091read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006093 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 vim_free(old_sub);
6095 if (force || old_sub == NULL)
6096 old_sub = viminfo_readstring(virp, 1, TRUE);
6097 return viminfo_readline(virp);
6098}
6099
6100 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006101write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102{
6103 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6104 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006105 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 viminfo_writestring(fp, old_sub);
6107 }
6108}
6109#endif /* FEAT_VIMINFO */
6110
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006111#if defined(EXITFREE) || defined(PROTO)
6112 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006113free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006114{
6115 vim_free(old_sub);
6116}
6117#endif
6118
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6120/*
6121 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006122 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006124 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006125prepare_tagpreview(
6126 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127{
6128 win_T *wp;
6129
6130# ifdef FEAT_GUI
6131 need_mouse_correct = TRUE;
6132# endif
6133
6134 /*
6135 * If there is already a preview window open, use that one.
6136 */
6137 if (!curwin->w_p_pvw)
6138 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006139 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 if (wp->w_p_pvw)
6141 break;
6142 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006143 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 else
6145 {
6146 /*
6147 * There is no preview window open yet. Create one.
6148 */
6149 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6150 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006151 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 curwin->w_p_pvw = TRUE;
6153 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006154 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6155 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156# ifdef FEAT_DIFF
6157 curwin->w_p_diff = FALSE; /* no 'diff' */
6158# endif
6159# ifdef FEAT_FOLDING
6160 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6161# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006162 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 }
6164 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006165 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166}
6167
6168#endif
6169
6170
6171/*
6172 * ":help": open a read-only window on a help file
6173 */
6174 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006175ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176{
6177 char_u *arg;
6178 char_u *tag;
6179 FILE *helpfd; /* file descriptor of help file */
6180 int n;
6181 int i;
6182#ifdef FEAT_WINDOWS
6183 win_T *wp;
6184#endif
6185 int num_matches;
6186 char_u **matches;
6187 char_u *p;
6188 int empty_fnum = 0;
6189 int alt_fnum = 0;
6190 buf_T *buf;
6191#ifdef FEAT_MULTI_LANG
6192 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006193 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006195#ifdef FEAT_FOLDING
6196 int old_KeyTyped = KeyTyped;
6197#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198
6199 if (eap != NULL)
6200 {
6201 /*
6202 * A ":help" command ends at the first LF, or at a '|' that is
6203 * followed by some text. Set nextcmd to the following command.
6204 */
6205 for (arg = eap->arg; *arg; ++arg)
6206 {
6207 if (*arg == '\n' || *arg == '\r'
6208 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6209 {
6210 *arg++ = NUL;
6211 eap->nextcmd = arg;
6212 break;
6213 }
6214 }
6215 arg = eap->arg;
6216
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006217 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 {
6219 EMSG(_("E478: Don't panic!"));
6220 return;
6221 }
6222
6223 if (eap->skip) /* not executing commands */
6224 return;
6225 }
6226 else
6227 arg = (char_u *)"";
6228
6229 /* remove trailing blanks */
6230 p = arg + STRLEN(arg) - 1;
6231 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
6232 *p-- = NUL;
6233
6234#ifdef FEAT_MULTI_LANG
6235 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006236 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237#endif
6238
6239 /* When no argument given go to the index. */
6240 if (*arg == NUL)
6241 arg = (char_u *)"help.txt";
6242
6243 /*
6244 * Check if there is a match for the argument.
6245 */
6246 n = find_help_tags(arg, &num_matches, &matches,
6247 eap != NULL && eap->forceit);
6248
6249 i = 0;
6250#ifdef FEAT_MULTI_LANG
6251 if (n != FAIL && lang != NULL)
6252 /* Find first item with the requested language. */
6253 for (i = 0; i < num_matches; ++i)
6254 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006255 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 if (len > 3 && matches[i][len - 3] == '@'
6257 && STRICMP(matches[i] + len - 2, lang) == 0)
6258 break;
6259 }
6260#endif
6261 if (i >= num_matches || n == FAIL)
6262 {
6263#ifdef FEAT_MULTI_LANG
6264 if (lang != NULL)
6265 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6266 else
6267#endif
6268 EMSG2(_("E149: Sorry, no help for %s"), arg);
6269 if (n != FAIL)
6270 FreeWild(num_matches, matches);
6271 return;
6272 }
6273
6274 /* The first match (in the requested language) is the best match. */
6275 tag = vim_strsave(matches[i]);
6276 FreeWild(num_matches, matches);
6277
6278#ifdef FEAT_GUI
6279 need_mouse_correct = TRUE;
6280#endif
6281
6282 /*
6283 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006284 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006286 if (!curwin->w_buffer->b_help
6287#ifdef FEAT_WINDOWS
6288 || cmdmod.tab != 0
6289#endif
6290 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 {
6292#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006293 if (cmdmod.tab != 0)
6294 wp = NULL;
6295 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006296 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006297 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6298 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6300 win_enter(wp, TRUE);
6301 else
6302#endif
6303 {
6304 /*
6305 * There is no help window yet.
6306 * Try to open the file specified by the "helpfile" option.
6307 */
6308 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6309 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006310 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 goto erret;
6312 }
6313 fclose(helpfd);
6314
6315#ifdef FEAT_WINDOWS
6316 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006317 * specified, the current window is vertically split and
6318 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006321 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006324 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325#else
6326 /* use current window */
6327 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006329#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330
6331#ifdef FEAT_WINDOWS
6332 if (curwin->w_height < p_hh)
6333 win_setheight((int)p_hh);
6334#endif
6335
6336 /*
6337 * Open help file (do_ecmd() will set b_help flag, readfile() will
6338 * set b_p_ro flag).
6339 * Set the alternate file to the previously edited file.
6340 */
6341 alt_fnum = curbuf->b_fnum;
6342 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006343 ECMD_HIDE + ECMD_SET_HELP,
6344#ifdef FEAT_WINDOWS
6345 NULL /* buffer is still open, don't store info */
6346#else
6347 curwin
6348#endif
6349 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006350 if (!cmdmod.keepalt)
6351 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 empty_fnum = curbuf->b_fnum;
6353 }
6354 }
6355
6356 if (!p_im)
6357 restart_edit = 0; /* don't want insert mode in help file */
6358
Bram Moolenaar8f535582011-09-30 17:30:31 +02006359#ifdef FEAT_FOLDING
6360 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6361 * It is needed for do_tag top open folds under the cursor. */
6362 KeyTyped = old_KeyTyped;
6363#endif
6364
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 if (tag != NULL)
6366 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6367
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006368 /* Delete the empty buffer if we're not using it. Careful: autocommands
6369 * may have jumped to another window, check that the buffer is not in a
6370 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6372 {
6373 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006374 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 wipe_buffer(buf, TRUE);
6376 }
6377
6378 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006379 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 curwin->w_alt_fnum = alt_fnum;
6381
6382erret:
6383 vim_free(tag);
6384}
6385
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006386/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006387 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006388 */
6389 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006390ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006391{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006392#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006393 win_T *win;
6394
6395 FOR_ALL_WINDOWS(win)
6396 {
6397 if (win->w_buffer->b_help)
6398 {
6399 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006400 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006401 }
6402 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006403#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006404}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006406#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6407/*
6408 * In an argument search for a language specifiers in the form "@xx".
6409 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6410 * Returns NULL if not found.
6411 */
6412 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006413check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006414{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006415 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006416
6417 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6418 && ASCII_ISALPHA(arg[len - 1]))
6419 {
6420 arg[len - 3] = NUL; /* remove the '@' */
6421 return arg + len - 2;
6422 }
6423 return NULL;
6424}
6425#endif
6426
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427/*
6428 * Return a heuristic indicating how well the given string matches. The
6429 * smaller the number, the better the match. This is the order of priorities,
6430 * from best match to worst match:
6431 * - Match with least alpha-numeric characters is better.
6432 * - Match with least total characters is better.
6433 * - Match towards the start is better.
6434 * - Match starting with "+" is worse (feature instead of command)
6435 * Assumption is made that the matched_string passed has already been found to
6436 * match some string for which help is requested. webb.
6437 */
6438 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006439help_heuristic(
6440 char_u *matched_string,
6441 int offset, /* offset for match */
6442 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443{
6444 int num_letters;
6445 char_u *p;
6446
6447 num_letters = 0;
6448 for (p = matched_string; *p; p++)
6449 if (ASCII_ISALNUM(*p))
6450 num_letters++;
6451
6452 /*
6453 * Multiply the number of letters by 100 to give it a much bigger
6454 * weighting than the number of characters.
6455 * If there only is a match while ignoring case, add 5000.
6456 * If the match starts in the middle of a word, add 10000 to put it
6457 * somewhere in the last half.
6458 * If the match is more than 2 chars from the start, multiply by 200 to
6459 * put it after matches at the start.
6460 */
6461 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6462 && ASCII_ISALNUM(matched_string[offset - 1]))
6463 offset += 10000;
6464 else if (offset > 2)
6465 offset *= 200;
6466 if (wrong_case)
6467 offset += 5000;
6468 /* Features are less interesting than the subjects themselves, but "+"
6469 * alone is not a feature. */
6470 if (matched_string[0] == '+' && matched_string[1] != NUL)
6471 offset += 100;
6472 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6473}
6474
6475/*
6476 * Compare functions for qsort() below, that checks the help heuristics number
6477 * that has been put after the tagname by find_tags().
6478 */
6479 static int
6480#ifdef __BORLANDC__
6481_RTLENTRYF
6482#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006483help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484{
6485 char *p1;
6486 char *p2;
6487
6488 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6489 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6490 return strcmp(p1, p2);
6491}
6492
6493/*
6494 * Find all help tags matching "arg", sort them and return in matches[], with
6495 * the number of matches in num_matches.
6496 * The matches will be sorted with a "best" match algorithm.
6497 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6498 */
6499 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006500find_help_tags(
6501 char_u *arg,
6502 int *num_matches,
6503 char_u ***matches,
6504 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505{
6506 char_u *s, *d;
6507 int i;
6508 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006509 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006510 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006511 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006512 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 "[count]", "[quotex]", "[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006514 "[pattern]", "\\|", "\\%$",
6515 "s/\\~", "s/\\U", "s/\\L",
6516 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006518 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006519 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006520 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006521 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 "\\[count]", "\\[quotex]", "\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006523 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006524 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006525 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 int flags;
6527
6528 d = IObuff; /* assume IObuff is long enough! */
6529
6530 /*
6531 * Recognize a few exceptions to the rule. Some strings that contain '*'
6532 * with "star". Otherwise '*' is recognized as a wildcard.
6533 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006534 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 if (STRCMP(arg, mtable[i]) == 0)
6536 {
6537 STRCPY(d, rtable[i]);
6538 break;
6539 }
6540
6541 if (i < 0) /* no match in table */
6542 {
6543 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6544 * Also replace "\%^" and "\%(", they match every tag too.
6545 * Also "\zs", "\z1", etc.
6546 * Also "\@<", "\@=", "\@<=", etc.
6547 * And also "\_$" and "\_^". */
6548 if (arg[0] == '\\'
6549 && ((arg[1] != NUL && arg[2] == NUL)
6550 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6551 && arg[2] != NUL)))
6552 {
6553 STRCPY(d, "/\\\\");
6554 STRCPY(d + 3, arg + 1);
6555 /* Check for "/\\_$", should be "/\\_\$" */
6556 if (d[3] == '_' && d[4] == '$')
6557 STRCPY(d + 4, "\\$");
6558 }
6559 else
6560 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006561 /* Replace:
6562 * "[:...:]" with "\[:...:]"
6563 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006564 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006565 */
6566 if ((arg[0] == '[' && (arg[1] == ':'
6567 || (arg[1] == '+' && arg[2] == '+')))
6568 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 *d++ = '\\';
6570
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006571 /*
6572 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6573 */
6574 if (*arg == '(' && arg[1] == '\'')
6575 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 for (s = arg; *s; ++s)
6577 {
6578 /*
6579 * Replace "|" with "bar" and '"' with "quote" to match the name of
6580 * the tags for these commands.
6581 * Replace "*" with ".*" and "?" with "." to match command line
6582 * completion.
6583 * Insert a backslash before '~', '$' and '.' to avoid their
6584 * special meaning.
6585 */
6586 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6587 break;
6588 switch (*s)
6589 {
6590 case '|': STRCPY(d, "bar");
6591 d += 3;
6592 continue;
6593 case '"': STRCPY(d, "quote");
6594 d += 5;
6595 continue;
6596 case '*': *d++ = '.';
6597 break;
6598 case '?': *d++ = '.';
6599 continue;
6600 case '$':
6601 case '.':
6602 case '~': *d++ = '\\';
6603 break;
6604 }
6605
6606 /*
6607 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6608 * ":help i_^_CTRL-D" work.
6609 * Insert '-' before and after "CTRL-X" when applicable.
6610 */
6611 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6612 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6613 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006614 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6615 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 STRCPY(d, "CTRL-");
6617 d += 5;
6618 if (*s < ' ')
6619 {
6620#ifdef EBCDIC
6621 *d++ = CtrlChar(*s);
6622#else
6623 *d++ = *s + '@';
6624#endif
6625 if (d[-1] == '\\')
6626 *d++ = '\\'; /* double a backslash */
6627 }
6628 else
6629 *d++ = *++s;
6630 if (s[1] != NUL && s[1] != '_')
6631 *d++ = '_'; /* append a '_' */
6632 continue;
6633 }
6634 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6635 *d++ = '\\';
6636
6637 /*
6638 * Insert a backslash before a backslash after a slash, for search
6639 * pattern tags: "/\|" --> "/\\|".
6640 */
6641 else if (s[0] == '\\' && s[1] != '\\'
6642 && *arg == '/' && s == arg + 1)
6643 *d++ = '\\';
6644
6645 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6646 * "CTRL-\_CTRL-N" */
6647 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6648 {
6649 STRCPY(d, "CTRL-\\\\");
6650 d += 7;
6651 s += 6;
6652 }
6653
6654 *d++ = *s;
6655
6656 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006657 * If tag contains "({" or "([", tag terminates at the "(".
6658 * This is for help on functions, e.g.: abs({expr}).
6659 */
6660 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6661 break;
6662
6663 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 * If tag starts with ', toss everything after a second '. Fixes
6665 * CTRL-] on 'option'. (would include the trailing '.').
6666 */
6667 if (*s == '\'' && s > arg && *arg == '\'')
6668 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006669 /* Also '{' and '}'. */
6670 if (*s == '}' && s > arg && *arg == '{')
6671 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 }
6673 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006674
6675 if (*IObuff == '`')
6676 {
6677 if (d > IObuff + 2 && d[-1] == '`')
6678 {
6679 /* remove the backticks from `command` */
6680 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6681 d[-2] = NUL;
6682 }
6683 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6684 {
6685 /* remove the backticks and comma from `command`, */
6686 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6687 d[-3] = NUL;
6688 }
6689 else if (d > IObuff + 4 && d[-3] == '`'
6690 && d[-2] == '\\' && d[-1] == '.')
6691 {
6692 /* remove the backticks and dot from `command`\. */
6693 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6694 d[-4] = NUL;
6695 }
6696 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 }
6698 }
6699
6700 *matches = (char_u **)"";
6701 *num_matches = 0;
6702 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6703 if (keep_lang)
6704 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006705 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006707 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 /* Sort the matches found on the heuristic number that is after the
6709 * tag name. */
6710 qsort((void *)*matches, (size_t)*num_matches,
6711 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006712 /* Delete more than TAG_MANY to reduce the size of the listing. */
6713 while (*num_matches > TAG_MANY)
6714 vim_free((*matches)[--*num_matches]);
6715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 return OK;
6717}
6718
6719/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006720 * Called when starting to edit a buffer for a help file.
6721 */
6722 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006723prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006724{
6725 char_u *p;
6726
6727 curbuf->b_help = TRUE;
6728#ifdef FEAT_QUICKFIX
6729 set_string_option_direct((char_u *)"buftype", -1,
6730 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6731#endif
6732
6733 /*
6734 * Always set these options after jumping to a help tag, because the
6735 * user may have an autocommand that gets in the way.
6736 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6737 * latin1 word characters (for translated help files).
6738 * Only set it when needed, buf_init_chartab() is some work.
6739 */
6740 p =
6741#ifdef EBCDIC
6742 (char_u *)"65-255,^*,^|,^\"";
6743#else
6744 (char_u *)"!-~,^*,^|,^\",192-255";
6745#endif
6746 if (STRCMP(curbuf->b_p_isk, p) != 0)
6747 {
6748 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6749 check_buf_options(curbuf);
6750 (void)buf_init_chartab(curbuf, FALSE);
6751 }
6752
Bram Moolenaar0b105412014-11-30 13:34:23 +01006753#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006754 /* Don't use the global foldmethod.*/
6755 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6756 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006757#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006758
6759 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6760 curwin->w_p_list = FALSE; /* no list mode */
6761
6762 curbuf->b_p_ma = FALSE; /* not modifiable */
6763 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6764 curwin->w_p_nu = 0; /* no line numbers */
6765 curwin->w_p_rnu = 0; /* no relative line numbers */
6766 RESET_BINDING(curwin); /* no scroll or cursor binding */
6767#ifdef FEAT_ARABIC
6768 curwin->w_p_arab = FALSE; /* no arabic mode */
6769#endif
6770#ifdef FEAT_RIGHTLEFT
6771 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6772#endif
6773#ifdef FEAT_FOLDING
6774 curwin->w_p_fen = FALSE; /* No folding in the help window */
6775#endif
6776#ifdef FEAT_DIFF
6777 curwin->w_p_diff = FALSE; /* No 'diff' */
6778#endif
6779#ifdef FEAT_SPELL
6780 curwin->w_p_spell = FALSE; /* No spell checking */
6781#endif
6782
6783 set_buflisted(FALSE);
6784}
6785
6786/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 * After reading a help file: May cleanup a help buffer when syntax
6788 * highlighting is not used.
6789 */
6790 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006791fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792{
6793 linenr_T lnum;
6794 char_u *line;
6795 int in_example = FALSE;
6796 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006797 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 char_u *p;
6799 char_u *rt;
6800 int mustfree;
6801
6802 /* set filetype to "help". */
6803 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6804
6805#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006806 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807#endif
6808 {
6809 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6810 {
6811 line = ml_get_buf(curbuf, lnum, FALSE);
6812 len = (int)STRLEN(line);
6813 if (in_example && len > 0 && !vim_iswhite(line[0]))
6814 {
6815 /* End of example: non-white or '<' in first column. */
6816 if (line[0] == '<')
6817 {
6818 /* blank-out a '<' in the first column */
6819 line = ml_get_buf(curbuf, lnum, TRUE);
6820 line[0] = ' ';
6821 }
6822 in_example = FALSE;
6823 }
6824 if (!in_example && len > 0)
6825 {
6826 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6827 {
6828 /* blank-out a '>' in the last column (start of example) */
6829 line = ml_get_buf(curbuf, lnum, TRUE);
6830 line[len - 1] = ' ';
6831 in_example = TRUE;
6832 }
6833 else if (line[len - 1] == '~')
6834 {
6835 /* blank-out a '~' at the end of line (header marker) */
6836 line = ml_get_buf(curbuf, lnum, TRUE);
6837 line[len - 1] = ' ';
6838 }
6839 }
6840 }
6841 }
6842
6843 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006844 * In the "help.txt" and "help.abx" file, add the locally added help
6845 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006847 fname = gettail(curbuf->b_fname);
6848 if (fnamecmp(fname, "help.txt") == 0
6849#ifdef FEAT_MULTI_LANG
6850 || (fnamencmp(fname, "help.", 5) == 0
6851 && ASCII_ISALPHA(fname[5])
6852 && ASCII_ISALPHA(fname[6])
6853 && TOLOWER_ASC(fname[7]) == 'x'
6854 && fname[8] == NUL)
6855#endif
6856 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 {
6858 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6859 {
6860 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006861 if (strstr((char *)line, "*local-additions*") == NULL)
6862 continue;
6863
6864 /* Go through all directories in 'runtimepath', skipping
6865 * $VIMRUNTIME. */
6866 p = p_rtp;
6867 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006869 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6870 mustfree = FALSE;
6871 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6872 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006874 int fcount;
6875 char_u **fnames;
6876 FILE *fd;
6877 char_u *s;
6878 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006880 vimconv_T vc;
6881 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882#endif
6883
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006884 /* Find all "doc/ *.txt" files in this directory. */
6885 add_pathsep(NameBuff);
6886#ifdef FEAT_MULTI_LANG
6887 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006889 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006891 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6892 &fnames, EW_FILE|EW_SILENT) == OK
6893 && fcount > 0)
6894 {
6895#ifdef FEAT_MULTI_LANG
6896 int i1;
6897 int i2;
6898 char_u *f1;
6899 char_u *f2;
6900 char_u *t1;
6901 char_u *e1;
6902 char_u *e2;
6903
6904 /* If foo.abx is found use it instead of foo.txt in
6905 * the same directory. */
6906 for (i1 = 0; i1 < fcount; ++i1)
6907 {
6908 for (i2 = 0; i2 < fcount; ++i2)
6909 {
6910 if (i1 == i2)
6911 continue;
6912 if (fnames[i1] == NULL || fnames[i2] == NULL)
6913 continue;
6914 f1 = fnames[i1];
6915 f2 = fnames[i2];
6916 t1 = gettail(f1);
6917 if (fnamencmp(f1, f2, t1 - f1) != 0)
6918 continue;
6919 e1 = vim_strrchr(t1, '.');
6920 e2 = vim_strrchr(gettail(f2), '.');
6921 if (e1 == NUL || e2 == NUL)
6922 continue;
6923 if (fnamecmp(e1, ".txt") != 0
6924 && fnamecmp(e1, fname + 4) != 0)
6925 {
6926 /* Not .txt and not .abx, remove it. */
6927 vim_free(fnames[i1]);
6928 fnames[i1] = NULL;
6929 continue;
6930 }
6931 if (fnamencmp(f1, f2, e1 - f1) != 0)
6932 continue;
6933 if (fnamecmp(e1, ".txt") == 0
6934 && fnamecmp(e2, fname + 4) == 0)
6935 {
6936 /* use .abx instead of .txt */
6937 vim_free(fnames[i1]);
6938 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 }
6940 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006942#endif
6943 for (fi = 0; fi < fcount; ++fi)
6944 {
6945 if (fnames[fi] == NULL)
6946 continue;
6947 fd = mch_fopen((char *)fnames[fi], "r");
6948 if (fd != NULL)
6949 {
6950 vim_fgets(IObuff, IOSIZE, fd);
6951 if (IObuff[0] == '*'
6952 && (s = vim_strchr(IObuff + 1, '*'))
6953 != NULL)
6954 {
6955#ifdef FEAT_MBYTE
6956 int this_utf = MAYBE;
6957#endif
6958 /* Change tag definition to a
6959 * reference and remove <CR>/<NL>. */
6960 IObuff[0] = '|';
6961 *s = '|';
6962 while (*s != NUL)
6963 {
6964 if (*s == '\r' || *s == '\n')
6965 *s = NUL;
6966#ifdef FEAT_MBYTE
6967 /* The text is utf-8 when a byte
6968 * above 127 is found and no
6969 * illegal byte sequence is found.
6970 */
6971 if (*s >= 0x80 && this_utf != FALSE)
6972 {
6973 int l;
6974
6975 this_utf = TRUE;
6976 l = utf_ptr2len(s);
6977 if (l == 1)
6978 this_utf = FALSE;
6979 s += l - 1;
6980 }
6981#endif
6982 ++s;
6983 }
6984#ifdef FEAT_MBYTE
6985 /* The help file is latin1 or utf-8;
6986 * conversion to the current
6987 * 'encoding' may be required. */
6988 vc.vc_type = CONV_NONE;
6989 convert_setup(&vc, (char_u *)(
6990 this_utf == TRUE ? "utf-8"
6991 : "latin1"), p_enc);
6992 if (vc.vc_type == CONV_NONE)
6993 /* No conversion needed. */
6994 cp = IObuff;
6995 else
6996 {
6997 /* Do the conversion. If it fails
6998 * use the unconverted text. */
6999 cp = string_convert(&vc, IObuff,
7000 NULL);
7001 if (cp == NULL)
7002 cp = IObuff;
7003 }
7004 convert_setup(&vc, NULL, NULL);
7005
7006 ml_append(lnum, cp, (colnr_T)0, FALSE);
7007 if (cp != IObuff)
7008 vim_free(cp);
7009#else
7010 ml_append(lnum, IObuff, (colnr_T)0,
7011 FALSE);
7012#endif
7013 ++lnum;
7014 }
7015 fclose(fd);
7016 }
7017 }
7018 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007021 if (mustfree)
7022 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007024 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 }
7026 }
7027}
7028
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007029/*
7030 * ":exusage"
7031 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007032 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007033ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007034{
7035 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7036}
7037
7038/*
7039 * ":viusage"
7040 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007041 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007042ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007043{
7044 do_cmdline_cmd((char_u *)"help normal-index");
7045}
7046
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007048 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007051helptags_one(
7052 char_u *dir, /* doc directory */
7053 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7054 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7055 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056{
7057 FILE *fd_tags;
7058 FILE *fd;
7059 garray_T ga;
7060 int filecount;
7061 char_u **files;
7062 char_u *p1, *p2;
7063 int fi;
7064 char_u *s;
7065 int i;
7066 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007067 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068# ifdef FEAT_MBYTE
7069 int utf8 = MAYBE;
7070 int this_utf8;
7071 int firstline;
7072 int mix = FALSE; /* detected mixed encodings */
7073# endif
7074
7075 /*
7076 * Find all *.txt files.
7077 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007078 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007080 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 STRCAT(NameBuff, ext);
7082 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7083 EW_FILE|EW_SILENT) == FAIL
7084 || filecount == 0)
7085 {
7086 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007087 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 return;
7089 }
7090
7091 /*
7092 * Open the tags file for writing.
7093 * Do this before scanning through all the files.
7094 */
7095 STRCPY(NameBuff, dir);
7096 add_pathsep(NameBuff);
7097 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007098 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 if (fd_tags == NULL)
7100 {
7101 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7102 FreeWild(filecount, files);
7103 return;
7104 }
7105
7106 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007107 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7108 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 */
7110 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007111 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7112 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 {
7114 if (ga_grow(&ga, 1) == FAIL)
7115 got_int = TRUE;
7116 else
7117 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007118 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 if (s == NULL)
7120 got_int = TRUE;
7121 else
7122 {
7123 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7124 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7125 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 }
7127 }
7128 }
7129
7130 /*
7131 * Go over all the files and extract the tags.
7132 */
7133 for (fi = 0; fi < filecount && !got_int; ++fi)
7134 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007135 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 if (fd == NULL)
7137 {
7138 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7139 continue;
7140 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007141 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142
7143# ifdef FEAT_MBYTE
7144 firstline = TRUE;
7145# endif
7146 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7147 {
7148# ifdef FEAT_MBYTE
7149 if (firstline)
7150 {
7151 /* Detect utf-8 file by a non-ASCII char in the first line. */
7152 this_utf8 = MAYBE;
7153 for (s = IObuff; *s != NUL; ++s)
7154 if (*s >= 0x80)
7155 {
7156 int l;
7157
7158 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007159 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 if (l == 1)
7161 {
7162 /* Illegal UTF-8 byte sequence. */
7163 this_utf8 = FALSE;
7164 break;
7165 }
7166 s += l - 1;
7167 }
7168 if (this_utf8 == MAYBE) /* only ASCII characters found */
7169 this_utf8 = FALSE;
7170 if (utf8 == MAYBE) /* first file */
7171 utf8 = this_utf8;
7172 else if (utf8 != this_utf8)
7173 {
7174 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7175 mix = !got_int;
7176 got_int = TRUE;
7177 }
7178 firstline = FALSE;
7179 }
7180# endif
7181 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7182 while (p1 != NULL)
7183 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007184 /* Use vim_strbyte() instead of vim_strchr() so that when
7185 * 'encoding' is dbcs it still works, don't find '*' in the
7186 * second byte. */
7187 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7189 {
7190 for (s = p1 + 1; s < p2; ++s)
7191 if (*s == ' ' || *s == '\t' || *s == '|')
7192 break;
7193
7194 /*
7195 * Only accept a *tag* when it consists of valid
7196 * characters, there is white space before it and is
7197 * followed by a white character or end-of-line.
7198 */
7199 if (s == p2
7200 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7201 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7202 || s[1] == '\0'))
7203 {
7204 *p2 = '\0';
7205 ++p1;
7206 if (ga_grow(&ga, 1) == FAIL)
7207 {
7208 got_int = TRUE;
7209 break;
7210 }
7211 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7212 if (s == NULL)
7213 {
7214 got_int = TRUE;
7215 break;
7216 }
7217 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7218 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 sprintf((char *)s, "%s\t%s", p1, fname);
7220
7221 /* find next '*' */
7222 p2 = vim_strchr(p2 + 1, '*');
7223 }
7224 }
7225 p1 = p2;
7226 }
7227 line_breakcheck();
7228 }
7229
7230 fclose(fd);
7231 }
7232
7233 FreeWild(filecount, files);
7234
7235 if (!got_int)
7236 {
7237 /*
7238 * Sort the tags.
7239 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007240 if (ga.ga_data != NULL)
7241 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242
7243 /*
7244 * Check for duplicates.
7245 */
7246 for (i = 1; i < ga.ga_len; ++i)
7247 {
7248 p1 = ((char_u **)ga.ga_data)[i - 1];
7249 p2 = ((char_u **)ga.ga_data)[i];
7250 while (*p1 == *p2)
7251 {
7252 if (*p2 == '\t')
7253 {
7254 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007255 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7257 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7258 EMSG(NameBuff);
7259 *p2 = '\t';
7260 break;
7261 }
7262 ++p1;
7263 ++p2;
7264 }
7265 }
7266
7267# ifdef FEAT_MBYTE
7268 if (utf8 == TRUE)
7269 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7270# endif
7271
7272 /*
7273 * Write the tags into the file.
7274 */
7275 for (i = 0; i < ga.ga_len; ++i)
7276 {
7277 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007278 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007280 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 else
7282 {
7283 fprintf(fd_tags, "%s\t/*", s);
7284 for (p1 = s; *p1 != '\t'; ++p1)
7285 {
7286 /* insert backslash before '\\' and '/' */
7287 if (*p1 == '\\' || *p1 == '/')
7288 putc('\\', fd_tags);
7289 putc(*p1, fd_tags);
7290 }
7291 fprintf(fd_tags, "*\n");
7292 }
7293 }
7294 }
7295#ifdef FEAT_MBYTE
7296 if (mix)
7297 got_int = FALSE; /* continue with other languages */
7298#endif
7299
7300 for (i = 0; i < ga.ga_len; ++i)
7301 vim_free(((char_u **)ga.ga_data)[i]);
7302 ga_clear(&ga);
7303 fclose(fd_tags); /* there is no check for an error... */
7304}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007306/*
7307 * Generate tags in one help directory, taking care of translations.
7308 */
7309 static void
7310do_helptags(char_u *dirname, int add_help_tags)
7311{
7312#ifdef FEAT_MULTI_LANG
7313 int len;
7314 int i, j;
7315 garray_T ga;
7316 char_u lang[2];
7317 char_u ext[5];
7318 char_u fname[8];
7319 int filecount;
7320 char_u **files;
7321
7322 /* Get a list of all files in the help directory and in subdirectories. */
7323 STRCPY(NameBuff, dirname);
7324 add_pathsep(NameBuff);
7325 STRCAT(NameBuff, "**");
7326 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7327 EW_FILE|EW_SILENT) == FAIL
7328 || filecount == 0)
7329 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007330 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007331 return;
7332 }
7333
7334 /* Go over all files in the directory to find out what languages are
7335 * present. */
7336 ga_init2(&ga, 1, 10);
7337 for (i = 0; i < filecount; ++i)
7338 {
7339 len = (int)STRLEN(files[i]);
7340 if (len > 4)
7341 {
7342 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7343 {
7344 /* ".txt" -> language "en" */
7345 lang[0] = 'e';
7346 lang[1] = 'n';
7347 }
7348 else if (files[i][len - 4] == '.'
7349 && ASCII_ISALPHA(files[i][len - 3])
7350 && ASCII_ISALPHA(files[i][len - 2])
7351 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7352 {
7353 /* ".abx" -> language "ab" */
7354 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7355 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7356 }
7357 else
7358 continue;
7359
7360 /* Did we find this language already? */
7361 for (j = 0; j < ga.ga_len; j += 2)
7362 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7363 break;
7364 if (j == ga.ga_len)
7365 {
7366 /* New language, add it. */
7367 if (ga_grow(&ga, 2) == FAIL)
7368 break;
7369 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7370 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7371 }
7372 }
7373 }
7374
7375 /*
7376 * Loop over the found languages to generate a tags file for each one.
7377 */
7378 for (j = 0; j < ga.ga_len; j += 2)
7379 {
7380 STRCPY(fname, "tags-xx");
7381 fname[5] = ((char_u *)ga.ga_data)[j];
7382 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7383 if (fname[5] == 'e' && fname[6] == 'n')
7384 {
7385 /* English is an exception: use ".txt" and "tags". */
7386 fname[4] = NUL;
7387 STRCPY(ext, ".txt");
7388 }
7389 else
7390 {
7391 /* Language "ab" uses ".abx" and "tags-ab". */
7392 STRCPY(ext, ".xxx");
7393 ext[1] = fname[5];
7394 ext[2] = fname[6];
7395 }
7396 helptags_one(dirname, ext, fname, add_help_tags);
7397 }
7398
7399 ga_clear(&ga);
7400 FreeWild(filecount, files);
7401
7402#else
7403 /* No language support, just use "*.txt" and "tags". */
7404 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7405#endif
7406}
7407
7408 static void
7409helptags_cb(char_u *fname, void *cookie)
7410{
7411 do_helptags(fname, *(int *)cookie);
7412}
7413
7414/*
7415 * ":helptags"
7416 */
7417 void
7418ex_helptags(exarg_T *eap)
7419{
7420 expand_T xpc;
7421 char_u *dirname;
7422 int add_help_tags = FALSE;
7423
7424 /* Check for ":helptags ++t {dir}". */
7425 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
7426 {
7427 add_help_tags = TRUE;
7428 eap->arg = skipwhite(eap->arg + 3);
7429 }
7430
7431 if (STRCMP(eap->arg, "ALL") == 0)
7432 {
7433 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7434 helptags_cb, &add_help_tags);
7435 }
7436 else
7437 {
7438 ExpandInit(&xpc);
7439 xpc.xp_context = EXPAND_DIRECTORIES;
7440 dirname = ExpandOne(&xpc, eap->arg, NULL,
7441 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7442 if (dirname == NULL || !mch_isdir(dirname))
7443 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7444 else
7445 do_helptags(dirname, add_help_tags);
7446 vim_free(dirname);
7447 }
7448}
7449
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450#if defined(FEAT_SIGNS) || defined(PROTO)
7451
7452/*
7453 * Struct to hold the sign properties.
7454 */
7455typedef struct sign sign_T;
7456
7457struct sign
7458{
7459 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007460 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 char_u *sn_name; /* name of sign */
7462 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007463# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007465# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 char_u *sn_text; /* text used instead of pixmap */
7467 int sn_line_hl; /* highlight ID for line */
7468 int sn_text_hl; /* highlight ID for text */
7469};
7470
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007472static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007474static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7475static void sign_list_defined(sign_T *sp);
7476static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007478static char *cmds[] = {
7479 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007480# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007481 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007482# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007483 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007484# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007485 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007486# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007487 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007488# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007489 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007490# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007491 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007492# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007493};
7494
7495/*
7496 * Find index of a ":sign" subcmd from its name.
7497 * "*end_cmd" must be writable.
7498 */
7499 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007500sign_cmd_idx(
7501 char_u *begin_cmd, /* begin of sign subcmd */
7502 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007503{
7504 int idx;
7505 char save = *end_cmd;
7506
7507 *end_cmd = NUL;
7508 for (idx = 0; ; ++idx)
7509 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7510 break;
7511 *end_cmd = save;
7512 return idx;
7513}
7514
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515/*
7516 * ":sign" command
7517 */
7518 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007519ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520{
7521 char_u *arg = eap->arg;
7522 char_u *p;
7523 int idx;
7524 sign_T *sp;
7525 sign_T *sp_prev;
7526 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527
7528 /* Parse the subcommand. */
7529 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007530 idx = sign_cmd_idx(arg, p);
7531 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007533 EMSG2(_("E160: Unknown sign command: %s"), arg);
7534 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 }
7536 arg = skipwhite(p);
7537
7538 if (idx <= SIGNCMD_LIST)
7539 {
7540 /*
7541 * Define, undefine or list signs.
7542 */
7543 if (idx == SIGNCMD_LIST && *arg == NUL)
7544 {
7545 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007546 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 sign_list_defined(sp);
7548 }
7549 else if (*arg == NUL)
7550 EMSG(_("E156: Missing sign name"));
7551 else
7552 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007553 /* Isolate the sign name. If it's a number skip leading zeroes,
7554 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 p = skiptowhite(arg);
7556 if (*p != NUL)
7557 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007558 while (arg[0] == '0' && arg[1] != NUL)
7559 ++arg;
7560
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 sp_prev = NULL;
7562 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7563 {
7564 if (STRCMP(sp->sn_name, arg) == 0)
7565 break;
7566 sp_prev = sp;
7567 }
7568 if (idx == SIGNCMD_DEFINE)
7569 {
7570 /* ":sign define {name} ...": define a sign */
7571 if (sp == NULL)
7572 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007573 sign_T *lp;
7574 int start = next_sign_typenr;
7575
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 /* Allocate a new sign. */
7577 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7578 if (sp == NULL)
7579 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007581 /* Check that next_sign_typenr is not already being used.
7582 * This only happens after wrapping around. Hopefully
7583 * another one got deleted and we can use its number. */
7584 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007586 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007588 ++next_sign_typenr;
7589 if (next_sign_typenr == MAX_TYPENR)
7590 next_sign_typenr = 1;
7591 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007593 vim_free(sp);
7594 EMSG(_("E612: Too many signs defined"));
7595 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007597 lp = first_sign; /* start all over */
7598 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007600 lp = lp->sn_next;
7601 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007603 sp->sn_typenr = next_sign_typenr;
7604 if (++next_sign_typenr == MAX_TYPENR)
7605 next_sign_typenr = 1; /* wrap around */
7606
7607 sp->sn_name = vim_strsave(arg);
7608 if (sp->sn_name == NULL) /* out of memory */
7609 {
7610 vim_free(sp);
7611 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007613
7614 /* add the new sign to the list of signs */
7615 if (sp_prev == NULL)
7616 first_sign = sp;
7617 else
7618 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 }
7620
7621 /* set values for a defined sign. */
7622 for (;;)
7623 {
7624 arg = skipwhite(p);
7625 if (*arg == NUL)
7626 break;
7627 p = skiptowhite_esc(arg);
7628 if (STRNCMP(arg, "icon=", 5) == 0)
7629 {
7630 arg += 5;
7631 vim_free(sp->sn_icon);
7632 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7633 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007634# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 if (gui.in_use)
7636 {
7637 out_flush();
7638 if (sp->sn_image != NULL)
7639 gui_mch_destroy_sign(sp->sn_image);
7640 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7641 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007642# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 }
7644 else if (STRNCMP(arg, "text=", 5) == 0)
7645 {
7646 char_u *s;
7647 int cells;
7648 int len;
7649
7650 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007651# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 /* Count cells and check for non-printable chars */
7653 if (has_mbyte)
7654 {
7655 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007656 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 {
7658 if (!vim_isprintc((*mb_ptr2char)(s)))
7659 break;
7660 cells += (*mb_ptr2cells)(s);
7661 }
7662 }
7663 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007664# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 {
7666 for (s = arg; s < p; ++s)
7667 if (!vim_isprintc(*s))
7668 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007669 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 }
7671 /* Currently must be one or two display cells */
7672 if (s != p || cells < 1 || cells > 2)
7673 {
7674 *p = NUL;
7675 EMSG2(_("E239: Invalid sign text: %s"), arg);
7676 return;
7677 }
7678
7679 vim_free(sp->sn_text);
7680 /* Allocate one byte more if we need to pad up
7681 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007682 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 sp->sn_text = vim_strnsave(arg, len);
7684
7685 if (sp->sn_text != NULL && cells == 1)
7686 STRCPY(sp->sn_text + len - 1, " ");
7687 }
7688 else if (STRNCMP(arg, "linehl=", 7) == 0)
7689 {
7690 arg += 7;
7691 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7692 }
7693 else if (STRNCMP(arg, "texthl=", 7) == 0)
7694 {
7695 arg += 7;
7696 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7697 }
7698 else
7699 {
7700 EMSG2(_(e_invarg2), arg);
7701 return;
7702 }
7703 }
7704 }
7705 else if (sp == NULL)
7706 EMSG2(_("E155: Unknown sign: %s"), arg);
7707 else if (idx == SIGNCMD_LIST)
7708 /* ":sign list {name}" */
7709 sign_list_defined(sp);
7710 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007712 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 }
7714 }
7715 else
7716 {
7717 int id = -1;
7718 linenr_T lnum = -1;
7719 char_u *sign_name = NULL;
7720 char_u *arg1;
7721
7722 if (*arg == NUL)
7723 {
7724 if (idx == SIGNCMD_PLACE)
7725 {
7726 /* ":sign place": list placed signs in all buffers */
7727 sign_list_placed(NULL);
7728 }
7729 else if (idx == SIGNCMD_UNPLACE)
7730 {
7731 /* ":sign unplace": remove placed sign at cursor */
7732 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7733 if (id > 0)
7734 {
7735 buf_delsign(curwin->w_buffer, id);
7736 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7737 }
7738 else
7739 EMSG(_("E159: Missing sign number"));
7740 }
7741 else
7742 EMSG(_(e_argreq));
7743 return;
7744 }
7745
7746 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7747 {
7748 /* ":sign unplace *": remove all placed signs */
7749 buf_delete_all_signs();
7750 return;
7751 }
7752
7753 /* first arg could be placed sign id */
7754 arg1 = arg;
7755 if (VIM_ISDIGIT(*arg))
7756 {
7757 id = getdigits(&arg);
7758 if (!vim_iswhite(*arg) && *arg != NUL)
7759 {
7760 id = -1;
7761 arg = arg1;
7762 }
7763 else
7764 {
7765 arg = skipwhite(arg);
7766 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7767 {
7768 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007769 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 if ((lnum = buf_delsign(buf, id)) != 0)
7771 update_debug_sign(buf, lnum);
7772 return;
7773 }
7774 }
7775 }
7776
7777 /*
7778 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7779 * Leave "arg" pointing to {fname}.
7780 */
7781 for (;;)
7782 {
7783 if (STRNCMP(arg, "line=", 5) == 0)
7784 {
7785 arg += 5;
7786 lnum = atoi((char *)arg);
7787 arg = skiptowhite(arg);
7788 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007789 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7790 {
7791 if (id != -1)
7792 {
7793 EMSG(_(e_invarg));
7794 return;
7795 }
7796 id = -2;
7797 arg = skiptowhite(arg + 1);
7798 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 else if (STRNCMP(arg, "name=", 5) == 0)
7800 {
7801 arg += 5;
7802 sign_name = arg;
7803 arg = skiptowhite(arg);
7804 if (*arg != NUL)
7805 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007806 while (sign_name[0] == '0' && sign_name[1] != NUL)
7807 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 }
7809 else if (STRNCMP(arg, "file=", 5) == 0)
7810 {
7811 arg += 5;
7812 buf = buflist_findname(arg);
7813 break;
7814 }
7815 else if (STRNCMP(arg, "buffer=", 7) == 0)
7816 {
7817 arg += 7;
7818 buf = buflist_findnr((int)getdigits(&arg));
7819 if (*skipwhite(arg) != NUL)
7820 EMSG(_(e_trailing));
7821 break;
7822 }
7823 else
7824 {
7825 EMSG(_(e_invarg));
7826 return;
7827 }
7828 arg = skipwhite(arg);
7829 }
7830
7831 if (buf == NULL)
7832 {
7833 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7834 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007835 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 {
7837 if (lnum >= 0 || sign_name != NULL)
7838 EMSG(_(e_invarg));
7839 else
7840 /* ":sign place file={fname}": list placed signs in one file */
7841 sign_list_placed(buf);
7842 }
7843 else if (idx == SIGNCMD_JUMP)
7844 {
7845 /* ":sign jump {id} file={fname}" */
7846 if (lnum >= 0 || sign_name != NULL)
7847 EMSG(_(e_invarg));
7848 else if ((lnum = buf_findsign(buf, id)) > 0)
7849 { /* goto a sign ... */
7850 if (buf_jump_open_win(buf) != NULL)
7851 { /* ... in a current window */
7852 curwin->w_cursor.lnum = lnum;
7853 check_cursor_lnum();
7854 beginline(BL_WHITE);
7855 }
7856 else
7857 { /* ... not currently in a window */
7858 char_u *cmd;
7859
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007860 if (buf->b_fname == NULL)
7861 {
7862 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7863 return;
7864 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7866 if (cmd == NULL)
7867 return;
7868 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7869 do_cmdline_cmd(cmd);
7870 vim_free(cmd);
7871 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007872# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007874# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 }
7876 else
7877 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7878 }
7879 else if (idx == SIGNCMD_UNPLACE)
7880 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 if (lnum >= 0 || sign_name != NULL)
7882 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007883 else if (id == -2)
7884 {
7885 /* ":sign unplace * file={fname}" */
7886 redraw_buf_later(buf, NOT_VALID);
7887 buf_delete_signs(buf);
7888 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 else
7890 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007891 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 lnum = buf_delsign(buf, id);
7893 update_debug_sign(buf, lnum);
7894 }
7895 }
7896 /* idx == SIGNCMD_PLACE */
7897 else if (sign_name != NULL)
7898 {
7899 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7900 if (STRCMP(sp->sn_name, sign_name) == 0)
7901 break;
7902 if (sp == NULL)
7903 {
7904 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7905 return;
7906 }
7907 if (lnum > 0)
7908 /* ":sign place {id} line={lnum} name={name} file={fname}":
7909 * place a sign */
7910 buf_addsign(buf, id, lnum, sp->sn_typenr);
7911 else
7912 /* ":sign place {id} file={fname}": change sign type */
7913 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007914 if (lnum > 0)
7915 update_debug_sign(buf, lnum);
7916 else
7917 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 }
7919 else
7920 EMSG(_(e_invarg));
7921 }
7922}
7923
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007924# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925/*
7926 * Allocate the icons. Called when the GUI has started. Allows defining
7927 * signs before it starts.
7928 */
7929 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007930sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931{
7932 sign_T *sp;
7933
7934 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7935 if (sp->sn_icon != NULL)
7936 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7937}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007938# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939
7940/*
7941 * List one sign.
7942 */
7943 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007944sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945{
7946 char_u *p;
7947
Bram Moolenaar555b2802005-05-19 21:08:39 +00007948 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 if (sp->sn_icon != NULL)
7950 {
7951 MSG_PUTS(" icon=");
7952 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007953# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 if (sp->sn_image == NULL)
7955 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007956# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007958# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 }
7960 if (sp->sn_text != NULL)
7961 {
7962 MSG_PUTS(" text=");
7963 msg_outtrans(sp->sn_text);
7964 }
7965 if (sp->sn_line_hl > 0)
7966 {
7967 MSG_PUTS(" linehl=");
7968 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7969 if (p == NULL)
7970 MSG_PUTS("NONE");
7971 else
7972 msg_puts(p);
7973 }
7974 if (sp->sn_text_hl > 0)
7975 {
7976 MSG_PUTS(" texthl=");
7977 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7978 if (p == NULL)
7979 MSG_PUTS("NONE");
7980 else
7981 msg_puts(p);
7982 }
7983}
7984
7985/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007986 * Undefine a sign and free its memory.
7987 */
7988 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007989sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007990{
7991 vim_free(sp->sn_name);
7992 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007993# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007994 if (sp->sn_image != NULL)
7995 {
7996 out_flush();
7997 gui_mch_destroy_sign(sp->sn_image);
7998 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007999# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008000 vim_free(sp->sn_text);
8001 if (sp_prev == NULL)
8002 first_sign = sp->sn_next;
8003 else
8004 sp_prev->sn_next = sp->sn_next;
8005 vim_free(sp);
8006}
8007
8008/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 * Get highlighting attribute for sign "typenr".
8010 * If "line" is TRUE: line highl, if FALSE: text highl.
8011 */
8012 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008013sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014{
8015 sign_T *sp;
8016
8017 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8018 if (sp->sn_typenr == typenr)
8019 {
8020 if (line)
8021 {
8022 if (sp->sn_line_hl > 0)
8023 return syn_id2attr(sp->sn_line_hl);
8024 }
8025 else
8026 {
8027 if (sp->sn_text_hl > 0)
8028 return syn_id2attr(sp->sn_text_hl);
8029 }
8030 break;
8031 }
8032 return 0;
8033}
8034
8035/*
8036 * Get text mark for sign "typenr".
8037 * Returns NULL if there isn't one.
8038 */
8039 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008040sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041{
8042 sign_T *sp;
8043
8044 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8045 if (sp->sn_typenr == typenr)
8046 return sp->sn_text;
8047 return NULL;
8048}
8049
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008050# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008052sign_get_image(
8053 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054{
8055 sign_T *sp;
8056
8057 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8058 if (sp->sn_typenr == typenr)
8059 return sp->sn_image;
8060 return NULL;
8061}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008062# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063
8064/*
8065 * Get the name of a sign by its typenr.
8066 */
8067 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008068sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069{
8070 sign_T *sp;
8071
8072 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8073 if (sp->sn_typenr == typenr)
8074 return sp->sn_name;
8075 return (char_u *)_("[Deleted]");
8076}
8077
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008078# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008079/*
8080 * Undefine/free all signs.
8081 */
8082 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008083free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008084{
8085 while (first_sign != NULL)
8086 sign_undefine(first_sign, NULL);
8087}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008088# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008089
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008090# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008091static enum
8092{
8093 EXP_SUBCMD, /* expand :sign sub-commands */
8094 EXP_DEFINE, /* expand :sign define {name} args */
8095 EXP_PLACE, /* expand :sign place {id} args */
8096 EXP_UNPLACE, /* expand :sign unplace" */
8097 EXP_SIGN_NAMES /* expand with name of placed signs */
8098} expand_what;
8099
8100/*
8101 * Function given to ExpandGeneric() to obtain the sign command
8102 * expansion.
8103 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008104 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008105get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008106{
8107 sign_T *sp;
8108 int current_idx;
8109
8110 switch (expand_what)
8111 {
8112 case EXP_SUBCMD:
8113 return (char_u *)cmds[idx];
8114 case EXP_DEFINE:
8115 {
8116 char *define_arg[] =
8117 {
8118 "icon=", "linehl=", "text=", "texthl=", NULL
8119 };
8120 return (char_u *)define_arg[idx];
8121 }
8122 case EXP_PLACE:
8123 {
8124 char *place_arg[] =
8125 {
8126 "line=", "name=", "file=", "buffer=", NULL
8127 };
8128 return (char_u *)place_arg[idx];
8129 }
8130 case EXP_UNPLACE:
8131 {
8132 char *unplace_arg[] = { "file=", "buffer=", NULL };
8133 return (char_u *)unplace_arg[idx];
8134 }
8135 case EXP_SIGN_NAMES:
8136 /* Complete with name of signs already defined */
8137 current_idx = 0;
8138 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8139 if (current_idx++ == idx)
8140 return sp->sn_name;
8141 return NULL;
8142 default:
8143 return NULL;
8144 }
8145}
8146
8147/*
8148 * Handle command line completion for :sign command.
8149 */
8150 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008151set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008152{
8153 char_u *p;
8154 char_u *end_subcmd;
8155 char_u *last;
8156 int cmd_idx;
8157 char_u *begin_subcmd_args;
8158
8159 /* Default: expand subcommands. */
8160 xp->xp_context = EXPAND_SIGN;
8161 expand_what = EXP_SUBCMD;
8162 xp->xp_pattern = arg;
8163
8164 end_subcmd = skiptowhite(arg);
8165 if (*end_subcmd == NUL)
8166 /* expand subcmd name
8167 * :sign {subcmd}<CTRL-D>*/
8168 return;
8169
8170 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8171
8172 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008173 * |
8174 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008175 begin_subcmd_args = skipwhite(end_subcmd);
8176 p = skiptowhite(begin_subcmd_args);
8177 if (*p == NUL)
8178 {
8179 /*
8180 * Expand first argument of subcmd when possible.
8181 * For ":jump {id}" and ":unplace {id}", we could
8182 * possibly expand the ids of all signs already placed.
8183 */
8184 xp->xp_pattern = begin_subcmd_args;
8185 switch (cmd_idx)
8186 {
8187 case SIGNCMD_LIST:
8188 case SIGNCMD_UNDEFINE:
8189 /* :sign list <CTRL-D>
8190 * :sign undefine <CTRL-D> */
8191 expand_what = EXP_SIGN_NAMES;
8192 break;
8193 default:
8194 xp->xp_context = EXPAND_NOTHING;
8195 }
8196 return;
8197 }
8198
8199 /* expand last argument of subcmd */
8200
8201 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008202 * |
8203 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008204
8205 /* Loop until reaching last argument. */
8206 do
8207 {
8208 p = skipwhite(p);
8209 last = p;
8210 p = skiptowhite(p);
8211 } while (*p != NUL);
8212
8213 p = vim_strchr(last, '=');
8214
8215 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008216 * | |
8217 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008218 if (p == NUL)
8219 {
8220 /* Expand last argument name (before equal sign). */
8221 xp->xp_pattern = last;
8222 switch (cmd_idx)
8223 {
8224 case SIGNCMD_DEFINE:
8225 expand_what = EXP_DEFINE;
8226 break;
8227 case SIGNCMD_PLACE:
8228 expand_what = EXP_PLACE;
8229 break;
8230 case SIGNCMD_JUMP:
8231 case SIGNCMD_UNPLACE:
8232 expand_what = EXP_UNPLACE;
8233 break;
8234 default:
8235 xp->xp_context = EXPAND_NOTHING;
8236 }
8237 }
8238 else
8239 {
8240 /* Expand last argument value (after equal sign). */
8241 xp->xp_pattern = p + 1;
8242 switch (cmd_idx)
8243 {
8244 case SIGNCMD_DEFINE:
8245 if (STRNCMP(last, "texthl", p - last) == 0 ||
8246 STRNCMP(last, "linehl", p - last) == 0)
8247 xp->xp_context = EXPAND_HIGHLIGHT;
8248 else if (STRNCMP(last, "icon", p - last) == 0)
8249 xp->xp_context = EXPAND_FILES;
8250 else
8251 xp->xp_context = EXPAND_NOTHING;
8252 break;
8253 case SIGNCMD_PLACE:
8254 if (STRNCMP(last, "name", p - last) == 0)
8255 expand_what = EXP_SIGN_NAMES;
8256 else
8257 xp->xp_context = EXPAND_NOTHING;
8258 break;
8259 default:
8260 xp->xp_context = EXPAND_NOTHING;
8261 }
8262 }
8263}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008264# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008265#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008266
8267/*
8268 * Make the user happy.
8269 */
8270 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008271ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008272{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008273 static char *code[] = {
8274 "\34 \4o\14$\4ox\30 \2o\30$\1ox\25 \2o\36$\1o\11 \1o\1$\3 \2$\1 \1o\1$x\5 \1o\1 \1$\1 \2o\10 \1o\44$\1o\7 \2$\1 \2$\1 \2$\1o\1$x\2 \2o\1 \1$\1 \1$\1 \1\"\1$\6 \1o\11$\4 \15$\4 \11$\1o\7 \3$\1o\2$\1o\1$x\2 \1\"\6$\1o\1$\5 \1o\11$\6 \13$\6 \12$\1o\4 \10$x\4 \7$\4 \13$\6 \13$\6 \27$x\4 \27$\4 \15$\4 \16$\2 \3\"\3$x\5 \1\"\3$\4\"\61$\5 \1\"\3$x\6 \3$\3 \1o\62$\5 \1\"\3$\1ox\5 \1o\2$\1\"\3 \63$\7 \3$\1ox\5 \3$\4 \55$\1\"\1 \1\"\6$",
8275 "\5o\4$\1ox\4 \1o\3$\4o\5$\2 \45$\3 \1o\21$x\4 \10$\1\"\4$\3 \42$\5 \4$\10\"x\3 \4\"\7 \4$\4 \1\"\34$\1\"\6 \1o\3$x\16 \1\"\3$\1o\5 \3\"\22$\1\"\2$\1\"\11 \3$x\20 \3$\1o\12 \1\"\2$\2\"\6$\4\"\13 \1o\3$x\21 \4$\1o\40 \1o\3$\1\"x\22 \1\"\4$\1o\6 \1o\6$\1o\1\"\4$\1o\10 \1o\4$x\24 \1\"\5$\2o\5 \2\"\4$\1o\5$\1o\3 \1o\4$\2\"x\27 \2\"\5$\4o\2 \1\"\3$\1o\11$\3\"x\32 \2\"\7$\2o\1 \12$x\42 \4\"\13$x\46 \14$x\47 \12$\1\"x\50 \1\"\3$\4\"x"
8276 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008277 char *p;
8278 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008279 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008280
8281 msg_start();
8282 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008283 for (i = 0; i < 2; ++i)
8284 for (p = code[i]; *p != NUL; ++p)
8285 if (*p == 'x')
8286 msg_putchar('\n');
8287 else
8288 for (n = *p++; n > 0; --n)
8289 if (*p == 'o' || *p == '$')
8290 msg_putchar_attr(*p, hl_attr(HLF_L));
8291 else
8292 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008293 msg_clr_eos();
8294}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295
8296#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8297/*
8298 * ":drop"
8299 * Opens the first argument in a window. When there are two or more arguments
8300 * the argument list is redefined.
8301 */
8302 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008303ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304{
8305 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 win_T *wp;
8307 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008308# ifdef FEAT_WINDOWS
8309 tabpage_T *tp;
8310# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311
8312 /*
8313 * Check if the first argument is already being edited in a window. If
8314 * so, jump to that window.
8315 * We would actually need to check all arguments, but that's complicated
8316 * and mostly only one file is dropped.
8317 * This also ignores wildcards, since it is very unlikely the user is
8318 * editing a file name with a wildcard character.
8319 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008320 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008322 /*
8323 * Expanding wildcards may result in an empty argument list. E.g. when
8324 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8325 * already did an error message for this.
8326 */
8327 if (ARGCOUNT == 0)
8328 return;
8329
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008330# ifdef FEAT_WINDOWS
8331 if (cmdmod.tab)
8332 {
8333 /* ":tab drop file ...": open a tab for each argument that isn't
8334 * edited in a window yet. It's like ":tab all" but without closing
8335 * windows or tabs. */
8336 ex_all(eap);
8337 }
8338 else
8339# endif
8340 {
8341 /* ":drop file ...": Edit the first argument. Jump to an existing
8342 * window if possible, edit in current window if the current buffer
8343 * can be abandoned, otherwise open a new window. */
8344 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8345
8346 FOR_ALL_TAB_WINDOWS(tp, wp)
8347 {
8348 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008350# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008351 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008352# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 return;
8355 }
8356 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008358 /*
8359 * Check whether the current buffer is changed. If so, we will need
8360 * to split the current window or data could be lost.
8361 * Skip the check if the 'hidden' option is set, as in this case the
8362 * buffer won't be lost.
8363 */
8364 if (!P_HID(curbuf))
8365 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008367 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008369 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008371 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008373 if (split)
8374 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008376 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008378 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8379 if (split)
8380 {
8381 eap->cmdidx = CMD_sfirst;
8382 eap->cmd[0] = 's';
8383 }
8384 else
8385 eap->cmdidx = CMD_first;
8386 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388}
8389#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008390
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008391/*
8392 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8393 * Put the start of the pattern in "*s", unless "s" is NULL.
8394 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8395 * If "s" is not NULL terminate the pattern with a NUL.
8396 * Return a pointer to the char just past the pattern plus flags.
8397 */
8398 char_u *
8399skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8400{
8401 int c;
8402
8403 if (vim_isIDc(*p))
8404 {
8405 /* ":vimgrep pattern fname" */
8406 if (s != NULL)
8407 *s = p;
8408 p = skiptowhite(p);
8409 if (s != NULL && *p != NUL)
8410 *p++ = NUL;
8411 }
8412 else
8413 {
8414 /* ":vimgrep /pattern/[g][j] fname" */
8415 if (s != NULL)
8416 *s = p + 1;
8417 c = *p;
8418 p = skip_regexp(p + 1, c, TRUE, NULL);
8419 if (*p != c)
8420 return NULL;
8421
8422 /* Truncate the pattern. */
8423 if (s != NULL)
8424 *p = NUL;
8425 ++p;
8426
8427 /* Find the flags */
8428 while (*p == 'g' || *p == 'j')
8429 {
8430 if (flags != NULL)
8431 {
8432 if (*p == 'g')
8433 *flags |= VGR_GLOBAL;
8434 else
8435 *flags |= VGR_NOJUMP;
8436 }
8437 ++p;
8438 }
8439 }
8440 return p;
8441}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008442
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008443#if defined(FEAT_EVAL) || defined(PROTO)
8444/*
8445 * List v:oldfiles in a nice way.
8446 */
8447 void
8448ex_oldfiles(exarg_T *eap UNUSED)
8449{
8450 list_T *l = get_vim_var_list(VV_OLDFILES);
8451 listitem_T *li;
8452 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008453 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008454
8455 if (l == NULL)
8456 msg((char_u *)_("No old files"));
8457 else
8458 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008459 msg_start();
8460 msg_scroll = TRUE;
8461 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8462 {
8463 ++nr;
8464 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008465 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008466 {
8467 msg_outnum((long)nr);
8468 MSG_PUTS(": ");
8469 msg_outtrans(fname);
8470 msg_putchar('\n');
8471 out_flush(); /* output one line at a time */
8472 ui_breakcheck();
8473 }
8474 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008475
8476 /* Assume "got_int" was set to truncate the listing. */
8477 got_int = FALSE;
8478
8479# ifdef FEAT_BROWSE_CMD
8480 if (cmdmod.browse)
8481 {
8482 quit_more = FALSE;
8483 nr = prompt_for_number(FALSE);
8484 msg_starthere();
8485 if (nr > 0)
8486 {
8487 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8488 (long)nr);
8489
8490 if (p != NULL)
8491 {
8492 p = expand_env_save(p);
8493 eap->arg = p;
8494 eap->cmdidx = CMD_edit;
8495 cmdmod.browse = FALSE;
8496 do_exedit(eap, NULL);
8497 vim_free(p);
8498 }
8499 }
8500 }
8501# endif
8502 }
8503}
8504#endif
8505