blob: 7682931d86ee6a3252d937de921e13b5cc2426f6 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * 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 Moolenaarf28dbce2016-01-29 22:03:47 +010031static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000032static int
33#ifdef __BORLANDC__
34 _RTLENTRYF
35#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010036 help_compare(const void *s1, const void *s2);
37static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39/*
40 * ":ascii" and "ga".
41 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010043do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000044{
45 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000046 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 char buf1[20];
48 char buf2[20];
49 char_u buf3[7];
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050#ifdef FEAT_DIGRAPHS
51 char_u *dig;
52#endif
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
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 c = gchar_cursor();
61 if (c == NUL)
62 {
Bram Moolenaar32526b32019-01-19 17:43:09 +010063 msg("NUL");
Bram Moolenaar071d4272004-06-13 20:20:40 +000064 return;
65 }
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067 IObuff[0] = NUL;
68 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
Bram Moolenaar071d4272004-06-13 20:20:40 +000069 {
70 if (c == NL) /* NUL is stored as NL */
71 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000072 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
73 cval = NL; /* NL is stored as CR */
74 else
75 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 if (vim_isprintc_strict(c) && (c < ' '
77#ifndef EBCDIC
78 || c > '~'
79#endif
80 ))
81 {
82 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000083 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 }
85 else
86 buf1[0] = NUL;
87#ifndef EBCDIC
88 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000089 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
90 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 else
92#endif
93 buf2[0] = NUL;
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010094#ifdef FEAT_DIGRAPHS
95 dig = get_digraph_for_char(cval);
96 if (dig != NULL)
97 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Oct %03o, Digr %s"),
99 transchar(c), buf1, buf2, cval, cval, cval, dig);
100 else
101#endif
102 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar555b2802005-05-19 21:08:39 +0000103 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +0000104 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000105 if (enc_utf8)
106 c = cc[ci++];
107 else
108 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 }
110
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 /* Repeat for combining characters. */
112 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
113 {
114 len = (int)STRLEN(IObuff);
115 /* This assumes every multi-byte char is printable... */
116 if (len > 0)
117 IObuff[len++] = ' ';
118 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000119 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000122# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 )
124 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000125 len += (*mb_char2bytes)(c, IObuff + len);
Bram Moolenaar5f73ef82018-02-27 21:09:30 +0100126#ifdef FEAT_DIGRAPHS
127 dig = get_digraph_for_char(c);
128 if (dig != NULL)
129 vim_snprintf((char *)IObuff + len, IOSIZE - len,
130 c < 0x10000 ? _("> %d, Hex %04x, Oct %o, Digr %s")
131 : _("> %d, Hex %08x, Oct %o, Digr %s"),
132 c, c, c, dig);
133 else
134#endif
135 vim_snprintf((char *)IObuff + len, IOSIZE - len,
136 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
137 : _("> %d, Hex %08x, Octal %o"),
138 c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000139 if (ci == MAX_MCO)
140 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000141 if (enc_utf8)
142 c = cc[ci++];
143 else
144 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
Bram Moolenaar32526b32019-01-19 17:43:09 +0100147 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148}
149
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150/*
151 * ":left", ":center" and ":right": align text.
152 */
153 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100154ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155{
156 pos_T save_curpos;
157 int len;
158 int indent = 0;
159 int new_indent;
160 int has_tab;
161 int width;
162
163#ifdef FEAT_RIGHTLEFT
164 if (curwin->w_p_rl)
165 {
166 /* switch left and right aligning */
167 if (eap->cmdidx == CMD_right)
168 eap->cmdidx = CMD_left;
169 else if (eap->cmdidx == CMD_left)
170 eap->cmdidx = CMD_right;
171 }
172#endif
173
174 width = atoi((char *)eap->arg);
175 save_curpos = curwin->w_cursor;
176 if (eap->cmdidx == CMD_left) /* width is used for new indent */
177 {
178 if (width >= 0)
179 indent = width;
180 }
181 else
182 {
183 /*
184 * if 'textwidth' set, use it
185 * else if 'wrapmargin' set, use it
186 * if invalid value, use 80
187 */
188 if (width <= 0)
189 width = curbuf->b_p_tw;
190 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200191 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192 if (width <= 0)
193 width = 80;
194 }
195
196 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
197 return;
198
199 for (curwin->w_cursor.lnum = eap->line1;
200 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
201 {
202 if (eap->cmdidx == CMD_left) /* left align */
203 new_indent = indent;
204 else
205 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000206 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 len = linelen(eap->cmdidx == CMD_right ? &has_tab
208 : NULL) - get_indent();
209
210 if (len <= 0) /* skip blank lines */
211 continue;
212
213 if (eap->cmdidx == CMD_center)
214 new_indent = (width - len) / 2;
215 else
216 {
217 new_indent = width - len; /* right align */
218
219 /*
220 * Make sure that embedded TABs don't make the text go too far
221 * to the right.
222 */
223 if (has_tab)
224 while (new_indent > 0)
225 {
226 (void)set_indent(new_indent, 0);
227 if (linelen(NULL) <= width)
228 {
229 /*
230 * Now try to move the line as much as possible to
231 * the right. Stop when it moves too far.
232 */
233 do
234 (void)set_indent(++new_indent, 0);
235 while (linelen(NULL) <= width);
236 --new_indent;
237 break;
238 }
239 --new_indent;
240 }
241 }
242 }
243 if (new_indent < 0)
244 new_indent = 0;
245 (void)set_indent(new_indent, 0); /* set indent */
246 }
247 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
248 curwin->w_cursor = save_curpos;
249 beginline(BL_WHITE | BL_FIX);
250}
251
252/*
253 * Get the length of the current line, excluding trailing white space.
254 */
255 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100256linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257{
258 char_u *line;
259 char_u *first;
260 char_u *last;
261 int save;
262 int len;
263
264 /* find the first non-blank character */
265 line = ml_get_curline();
266 first = skipwhite(line);
267
268 /* find the character after the last non-blank character */
269 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100270 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 ;
272 save = *last;
273 *last = NUL;
274 len = linetabsize(line); /* get line length */
275 if (has_tab != NULL) /* check for embedded TAB */
Bram Moolenaarb31a3ac2018-08-11 14:41:55 +0200276 *has_tab = (vim_strchr(first, TAB) != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 *last = save;
278
279 return len;
280}
281
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282/* Buffer for two lines used during sorting. They are allocated to
283 * contain the longest line being sorted. */
284static char_u *sortbuf1;
285static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000286
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100287static int sort_ic; /* ignore case */
288static int sort_nr; /* sort on number */
289static int sort_rx; /* sort on regex instead of skipping it */
290#ifdef FEAT_FLOAT
291static int sort_flt; /* sort on floating number */
292#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000293
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000295
296/* Struct to store info to be sorted. */
297typedef struct
298{
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100299 linenr_T lnum; // line number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100300 union {
301 struct
302 {
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100303 varnumber_T start_col_nr; // starting column number
304 varnumber_T end_col_nr; // ending column number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100305 } line;
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100306 struct
307 {
308 varnumber_T value; // value if sorting by integer
309 int is_number; // TRUE when line contains a number
310 } num;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100311#ifdef FEAT_FLOAT
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100312 float_T value_flt; // value if sorting by float
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100313#endif
314 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000315} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000316
317static int
318#ifdef __BORLANDC__
319_RTLENTRYF
320#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100321sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000322
323 static int
324#ifdef __BORLANDC__
325_RTLENTRYF
326#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100327sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000328{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 sorti_T l1 = *(sorti_T *)s1;
330 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000331 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000332
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000333 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000334 * if we return 0 every time, qsort will assume it's done sorting and
335 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000336 if (sort_abort)
337 return 0;
338 fast_breakcheck();
339 if (got_int)
340 sort_abort = TRUE;
341
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000342 if (sort_nr)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100343 {
344 if (l1.st_u.num.is_number != l2.st_u.num.is_number)
345 result = l1.st_u.num.is_number - l2.st_u.num.is_number;
346 else
347 result = l1.st_u.num.value == l2.st_u.num.value ? 0
348 : l1.st_u.num.value > l2.st_u.num.value ? 1 : -1;
349 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100350#ifdef FEAT_FLOAT
351 else if (sort_flt)
352 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
353 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
354#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000355 else
356 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000357 /* We need to copy one line into "sortbuf1", because there is no
358 * guarantee that the first pointer becomes invalid when obtaining the
359 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100360 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
361 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
362 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
363 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
364 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
365 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000366
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000367 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
368 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000369 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000370
371 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000372 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000373 return (int)(l1.lnum - l2.lnum);
374 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000375}
376
377/*
378 * ":sort".
379 */
380 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100381ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382{
383 regmatch_T regmatch;
384 int len;
385 linenr_T lnum;
386 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000387 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000388 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000389 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000390 char_u *p;
391 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000392 char_u *s2;
393 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000394 int unique = FALSE;
395 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 colnr_T start_col;
397 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100398 int sort_what = 0;
399 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200400 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401
Bram Moolenaar48c99162008-02-18 18:42:52 +0000402 /* Sorting one line is really quick! */
403 if (count <= 1)
404 return;
405
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000406 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
407 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000408 sortbuf1 = NULL;
409 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000410 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000411 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000412 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000413 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000414
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100415 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100416#ifdef FEAT_FLOAT
417 sort_flt = 0;
418#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000419
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000420 for (p = eap->arg; *p != NUL; ++p)
421 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100422 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000423 ;
424 else if (*p == 'i')
425 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000426 else if (*p == 'r')
427 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000428 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100429 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100430 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100431 ++format_found;
432 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100433#ifdef FEAT_FLOAT
434 else if (*p == 'f')
435 {
436 sort_flt = 1;
437 ++format_found;
438 }
439#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100440 else if (*p == 'b')
441 {
442 sort_what = STR2NR_BIN + STR2NR_FORCE;
443 ++format_found;
444 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000445 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100446 {
447 sort_what = STR2NR_OCT + STR2NR_FORCE;
448 ++format_found;
449 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100451 {
452 sort_what = STR2NR_HEX + STR2NR_FORCE;
453 ++format_found;
454 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000455 else if (*p == 'u')
456 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000457 else if (*p == '"') /* comment start */
458 break;
459 else if (check_nextcmd(p) != NULL)
460 {
461 eap->nextcmd = check_nextcmd(p);
462 break;
463 }
464 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000465 {
466 s = skip_regexp(p + 1, *p, TRUE, NULL);
467 if (*s != *p)
468 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100469 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000470 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000471 }
472 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000473 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100474 if (s == p + 1)
475 {
476 if (last_search_pat() == NULL)
477 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100478 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100479 goto sortend;
480 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000481 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100482 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000483 else
484 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000485 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000487 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000488 regmatch.rm_ic = p_ic;
489 }
490 else
491 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100492 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000493 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000494 }
495 }
496
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100497 /* Can only have one of 'n', 'b', 'o' and 'x'. */
498 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000499 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100500 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 }
503
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100504 /* From here on "sort_nr" is used as a flag for any integer number
505 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100506 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000509 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000510 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 * When sorting on strings "start_col_nr" is the offset in the line, for
512 * numbers sorting it's the number to sort on. This means the pattern
513 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000514 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000515 */
516 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
517 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000518 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000519 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520 if (maxlen < len)
521 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000523 start_col = 0;
524 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 {
527 if (sort_rx)
528 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000529 start_col = (colnr_T)(regmatch.startp[0] - s);
530 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000531 }
532 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000533 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000534 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000535 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000536 if (regmatch.regprog != NULL)
537 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000538
Bram Moolenaar937204a2016-01-30 23:37:38 +0100539 if (sort_nr
540#ifdef FEAT_FLOAT
541 || sort_flt
542#endif
543 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000544 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000545 /* Make sure vim_str2nr doesn't read any digits past the end
546 * of the match, by temporarily terminating the string there */
547 s2 = s + end_col;
548 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200549 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000550 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000551 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 if (sort_nr)
553 {
554 if (sort_what & STR2NR_HEX)
555 s = skiptohex(p);
556 else if (sort_what & STR2NR_BIN)
557 s = skiptobin(p);
558 else
559 s = skiptodigit(p);
560 if (s > p && s[-1] == '-')
561 --s; /* include preceding negative sign */
562 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100563 {
564 /* line without number should sort before any number */
565 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
566 nrs[lnum - eap->line1].st_u.num.value = 0;
567 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100568 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100569 {
570 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100571 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100572 &nrs[lnum - eap->line1].st_u.num.value, NULL, 0);
573 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100574 }
575#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000576 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100577 {
578 s = skipwhite(p);
579 if (*s == '+')
580 s = skipwhite(s + 1);
581
582 if (*s == NUL)
583 /* empty line should sort before any number */
584 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
585 else
586 nrs[lnum - eap->line1].st_u.value_flt =
587 strtod((char *)s, NULL);
588 }
589#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200590 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 }
592 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000594 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100595 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
596 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000597 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000598
599 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000600
601 if (regmatch.regprog != NULL)
602 fast_breakcheck();
603 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000604 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000605 }
606
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000607 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000608 sortbuf1 = alloc((unsigned)maxlen + 1);
609 if (sortbuf1 == NULL)
610 goto sortend;
611 sortbuf2 = alloc((unsigned)maxlen + 1);
612 if (sortbuf2 == NULL)
613 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000614
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000615 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000616 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000617
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000618 if (sort_abort)
619 goto sortend;
620
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000621 /* Insert the lines in the sorted order below the last one. */
622 lnum = eap->line2;
623 for (i = 0; i < count; ++i)
624 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200625 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
626
627 // If the original line number of the line being placed is not the same
628 // as "lnum" (accounting for offset), we know that the buffer changed.
629 if (get_lnum + ((linenr_T)count - 1) != lnum)
630 change_occurred = TRUE;
631
632 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000633 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000634 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000635 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200636 // Copy the line into a buffer, it may become invalid in
637 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100638 STRCPY(sortbuf1, s);
639 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000641 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000642 fast_breakcheck();
643 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000644 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 }
646
647 /* delete the original lines if appending worked */
648 if (i == count)
649 for (i = 0; i < count; ++i)
650 ml_delete(eap->line1, FALSE);
651 else
652 count = 0;
653
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000654 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000655 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000656 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200657 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000658 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200659 msgmore(-deleted);
660 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000661 else if (deleted < 0)
662 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200663
664 if (change_occurred || deleted != 0)
665 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000666
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000667 curwin->w_cursor.lnum = eap->line1;
668 beginline(BL_WHITE | BL_FIX);
669
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000670sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000671 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000672 vim_free(sortbuf1);
673 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200674 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000675 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100676 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000677}
678
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679/*
680 * ":retab".
681 */
682 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100683ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684{
685 linenr_T lnum;
686 int got_tab = FALSE;
687 long num_spaces = 0;
688 long num_tabs;
689 long len;
690 long col;
691 long vcol;
692 long start_col = 0; /* For start of white-space string */
693 long start_vcol = 0; /* For start of white-space string */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 long old_len;
695 char_u *ptr;
696 char_u *new_line = (char_u *)1; /* init to non-NULL */
697 int did_undo; /* called u_save for current line */
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200698#ifdef FEAT_VARTABS
Bram Moolenaar0119a592018-06-24 23:53:28 +0200699 int *new_vts_array = NULL;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200700 char_u *new_ts_str; /* string value of tab argument */
701#else
702 int temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 int new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200704#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 int save_list;
706 linenr_T first_line = 0; /* first changed line */
707 linenr_T last_line = 0; /* last changed line */
708
709 save_list = curwin->w_p_list;
710 curwin->w_p_list = 0; /* don't want list mode here */
711
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200712#ifdef FEAT_VARTABS
713 new_ts_str = eap->arg;
Bram Moolenaar0119a592018-06-24 23:53:28 +0200714 if (!tabstop_set(eap->arg, &new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200715 return;
716 while (vim_isdigit(*(eap->arg)) || *(eap->arg) == ',')
717 ++(eap->arg);
718
Bram Moolenaar0119a592018-06-24 23:53:28 +0200719 // This ensures that either new_vts_array and new_ts_str are freshly
720 // allocated, or new_vts_array points to an existing array and new_ts_str
721 // is null.
722 if (new_vts_array == NULL)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200723 {
Bram Moolenaar0119a592018-06-24 23:53:28 +0200724 new_vts_array = curbuf->b_p_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200725 new_ts_str = NULL;
726 }
727 else
728 new_ts_str = vim_strnsave(new_ts_str, eap->arg - new_ts_str);
729#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 new_ts = getdigits(&(eap->arg));
731 if (new_ts < 0)
732 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100733 emsg(_(e_positive));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 return;
735 }
736 if (new_ts == 0)
737 new_ts = curbuf->b_p_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200738#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
740 {
741 ptr = ml_get(lnum);
742 col = 0;
743 vcol = 0;
744 did_undo = FALSE;
745 for (;;)
746 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100747 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 {
749 if (!got_tab && num_spaces == 0)
750 {
751 /* First consecutive white-space */
752 start_vcol = vcol;
753 start_col = col;
754 }
755 if (ptr[col] == ' ')
756 num_spaces++;
757 else
758 got_tab = TRUE;
759 }
760 else
761 {
762 if (got_tab || (eap->forceit && num_spaces > 1))
763 {
764 /* Retabulate this string of white-space */
765
766 /* len is virtual length of white string */
767 len = num_spaces = vcol - start_vcol;
768 num_tabs = 0;
769 if (!curbuf->b_p_et)
770 {
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200771#ifdef FEAT_VARTABS
772 int t, s;
773
774 tabstop_fromto(start_vcol, vcol,
Bram Moolenaar0119a592018-06-24 23:53:28 +0200775 curbuf->b_p_ts, new_vts_array, &t, &s);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200776 num_tabs = t;
777 num_spaces = s;
778#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 temp = new_ts - (start_vcol % new_ts);
780 if (num_spaces >= temp)
781 {
782 num_spaces -= temp;
783 num_tabs++;
784 }
785 num_tabs += num_spaces / new_ts;
786 num_spaces -= (num_spaces / new_ts) * new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200787#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 }
789 if (curbuf->b_p_et || got_tab ||
790 (num_spaces + num_tabs < len))
791 {
792 if (did_undo == FALSE)
793 {
794 did_undo = TRUE;
795 if (u_save((linenr_T)(lnum - 1),
796 (linenr_T)(lnum + 1)) == FAIL)
797 {
798 new_line = NULL; /* flag out-of-memory */
799 break;
800 }
801 }
802
803 /* len is actual number of white characters used */
804 len = num_spaces + num_tabs;
805 old_len = (long)STRLEN(ptr);
806 new_line = lalloc(old_len - col + start_col + len + 1,
807 TRUE);
808 if (new_line == NULL)
809 break;
810 if (start_col > 0)
811 mch_memmove(new_line, ptr, (size_t)start_col);
812 mch_memmove(new_line + start_col + len,
813 ptr + col, (size_t)(old_len - col + 1));
814 ptr = new_line + start_col;
815 for (col = 0; col < len; col++)
816 ptr[col] = (col < num_tabs) ? '\t' : ' ';
817 ml_replace(lnum, new_line, FALSE);
818 if (first_line == 0)
819 first_line = lnum;
820 last_line = lnum;
821 ptr = new_line;
822 col = start_col + len;
823 }
824 }
825 got_tab = FALSE;
826 num_spaces = 0;
827 }
828 if (ptr[col] == NUL)
829 break;
830 vcol += chartabsize(ptr + col, (colnr_T)vcol);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000832 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 ++col;
835 }
836 if (new_line == NULL) /* out of memory */
837 break;
838 line_breakcheck();
839 }
840 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100841 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200843#ifdef FEAT_VARTABS
844 // If a single value was given then it can be considered equal to
845 // either the value of 'tabstop' or the value of 'vartabstop'.
846 if (tabstop_count(curbuf->b_p_vts_array) == 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200847 && tabstop_count(new_vts_array) == 1
848 && curbuf->b_p_ts == tabstop_first(new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200849 ; /* not changed */
850 else if (tabstop_count(curbuf->b_p_vts_array) > 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200851 && tabstop_eq(curbuf->b_p_vts_array, new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200852 ; /* not changed */
853 else
854 redraw_curbuf_later(NOT_VALID);
855#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (curbuf->b_p_ts != new_ts)
857 redraw_curbuf_later(NOT_VALID);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200858#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 if (first_line != 0)
860 changed_lines(first_line, 0, last_line + 1, 0L);
861
862 curwin->w_p_list = save_list; /* restore 'list' */
863
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200864#ifdef FEAT_VARTABS
865 if (new_ts_str != NULL) /* set the new tabstop */
866 {
867 // If 'vartabstop' is in use or if the value given to retab has more
868 // than one tabstop then update 'vartabstop'.
869 int *old_vts_ary = curbuf->b_p_vts_array;
870
Bram Moolenaar0119a592018-06-24 23:53:28 +0200871 if (tabstop_count(old_vts_ary) > 0 || tabstop_count(new_vts_array) > 1)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200872 {
873 set_string_option_direct((char_u *)"vts", -1, new_ts_str,
874 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0119a592018-06-24 23:53:28 +0200875 curbuf->b_p_vts_array = new_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200876 vim_free(old_vts_ary);
877 }
878 else
879 {
880 // 'vartabstop' wasn't in use and a single value was given to
881 // retab then update 'tabstop'.
Bram Moolenaar0119a592018-06-24 23:53:28 +0200882 curbuf->b_p_ts = tabstop_first(new_vts_array);
883 vim_free(new_vts_array);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200884 }
Bram Moolenaar307ac5c2018-06-28 22:23:00 +0200885 vim_free(new_ts_str);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200886 }
887#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 curbuf->b_p_ts = new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200889#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 coladvance(curwin->w_curswant);
891
892 u_clearline();
893}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894
895/*
896 * :move command - move lines line1-line2 to line dest
897 *
898 * return FAIL for failure, OK otherwise
899 */
900 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100901do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902{
903 char_u *str;
904 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100905 linenr_T extra; // Num lines added before line1
906 linenr_T num_lines; // Num lines moved
907 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200908#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100909 win_T *win;
910 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
913 if (dest >= line1 && dest < line2)
914 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100915 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 return FAIL;
917 }
918
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100919 // Do nothing if we are not actually moving any lines. This will prevent
920 // the 'modified' flag from being set without cause.
921 if (dest == line1 - 1 || dest == line2)
922 {
923 // Move the cursor as if lines were moved (see below) to be backwards
924 // compatible.
925 if (dest >= line1)
926 curwin->w_cursor.lnum = dest;
927 else
928 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
929
930 return OK;
931 }
932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 num_lines = line2 - line1 + 1;
934
935 /*
936 * First we copy the old text to its new location -- webb
937 * Also copy the flag that ":global" command uses.
938 */
939 if (u_save(dest, dest + 1) == FAIL)
940 return FAIL;
941 for (extra = 0, l = line1; l <= line2; l++)
942 {
943 str = vim_strsave(ml_get(l + extra));
944 if (str != NULL)
945 {
946 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
947 vim_free(str);
948 if (dest < line1)
949 extra++;
950 }
951 }
952
953 /*
954 * Now we must be careful adjusting our marks so that we don't overlap our
955 * mark_adjust() calls.
956 *
957 * We adjust the marks within the old text so that they refer to the
958 * last lines of the file (temporarily), because we know no other marks
959 * will be set there since these line numbers did not exist until we added
960 * our new lines.
961 *
962 * Then we adjust the marks on lines between the old and new text positions
963 * (either forwards or backwards).
964 *
965 * And Finally we adjust the marks we put at the end of the file back to
966 * their final destination at the new text position -- webb
967 */
968 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100969 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 if (dest >= line2)
971 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100972 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
973#ifdef FEAT_FOLDING
974 FOR_ALL_TAB_WINDOWS(tp, win) {
975 if (win->w_buffer == curbuf)
976 foldMoveRange(&win->w_folds, line1, line2, dest);
977 }
978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 curbuf->b_op_start.lnum = dest - num_lines + 1;
980 curbuf->b_op_end.lnum = dest;
981 }
982 else
983 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100984 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
985#ifdef FEAT_FOLDING
986 FOR_ALL_TAB_WINDOWS(tp, win) {
987 if (win->w_buffer == curbuf)
988 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
989 }
990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 curbuf->b_op_start.lnum = dest + 1;
992 curbuf->b_op_end.lnum = dest + num_lines;
993 }
994 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100995 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 -(last_line - dest - extra), 0L);
997
998 /*
999 * Now we delete the original text -- webb
1000 */
1001 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
1002 return FAIL;
1003
1004 for (l = line1; l <= line2; l++)
1005 ml_delete(line1 + extra, TRUE);
1006
1007 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001008 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001009 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010
1011 /*
1012 * Leave the cursor on the last of the moved lines.
1013 */
1014 if (dest >= line1)
1015 curwin->w_cursor.lnum = dest;
1016 else
1017 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
1018
1019 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +01001020 {
1021 dest += num_lines + 1;
1022 last_line = curbuf->b_ml.ml_line_count;
1023 if (dest > last_line + 1)
1024 dest = last_line + 1;
1025 changed_lines(line1, 0, dest, 0L);
1026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 else
1028 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
1029
1030 return OK;
1031}
1032
1033/*
1034 * ":copy"
1035 */
1036 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001037ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038{
1039 linenr_T count;
1040 char_u *p;
1041
1042 count = line2 - line1 + 1;
1043 curbuf->b_op_start.lnum = n + 1;
1044 curbuf->b_op_end.lnum = n + count;
1045 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
1046
1047 /*
1048 * there are three situations:
1049 * 1. destination is above line1
1050 * 2. destination is between line1 and line2
1051 * 3. destination is below line2
1052 *
1053 * n = destination (when starting)
1054 * curwin->w_cursor.lnum = destination (while copying)
1055 * line1 = start of source (while copying)
1056 * line2 = end of source (while copying)
1057 */
1058 if (u_save(n, n + 1) == FAIL)
1059 return;
1060
1061 curwin->w_cursor.lnum = n;
1062 while (line1 <= line2)
1063 {
1064 /* need to use vim_strsave() because the line will be unlocked within
1065 * ml_append() */
1066 p = vim_strsave(ml_get(line1));
1067 if (p != NULL)
1068 {
1069 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
1070 vim_free(p);
1071 }
1072 /* situation 2: skip already copied lines */
1073 if (line1 == n)
1074 line1 = curwin->w_cursor.lnum;
1075 ++line1;
1076 if (curwin->w_cursor.lnum < line1)
1077 ++line1;
1078 if (curwin->w_cursor.lnum < line2)
1079 ++line2;
1080 ++curwin->w_cursor.lnum;
1081 }
1082
1083 appended_lines_mark(n, count);
1084
1085 msgmore((long)count);
1086}
1087
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001088static char_u *prevcmd = NULL; /* the previous command */
1089
1090#if defined(EXITFREE) || defined(PROTO)
1091 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001092free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001093{
1094 vim_free(prevcmd);
1095}
1096#endif
1097
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098/*
1099 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1100 * Bangs in the argument are replaced with the previously entered command.
1101 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 */
1103 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001104do_bang(
1105 int addr_count,
1106 exarg_T *eap,
1107 int forceit,
1108 int do_in,
1109 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110{
1111 char_u *arg = eap->arg; /* command */
1112 linenr_T line1 = eap->line1; /* start of range */
1113 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 char_u *newcmd = NULL; /* the new command */
1115 int free_newcmd = FALSE; /* need to free() newcmd */
1116 int ins_prevcmd;
1117 char_u *t;
1118 char_u *p;
1119 char_u *trailarg;
1120 int len;
1121 int scroll_save = msg_scroll;
1122
1123 /*
1124 * Disallow shell commands for "rvim".
1125 * Disallow shell commands from .exrc and .vimrc in current directory for
1126 * security reasons.
1127 */
1128 if (check_restricted() || check_secure())
1129 return;
1130
1131 if (addr_count == 0) /* :! */
1132 {
1133 msg_scroll = FALSE; /* don't scroll here */
1134 autowrite_all();
1135 msg_scroll = scroll_save;
1136 }
1137
1138 /*
1139 * Try to find an embedded bang, like in :!<cmd> ! [args]
1140 * (:!! is indicated by the 'forceit' variable)
1141 */
1142 ins_prevcmd = forceit;
1143 trailarg = arg;
1144 do
1145 {
1146 len = (int)STRLEN(trailarg) + 1;
1147 if (newcmd != NULL)
1148 len += (int)STRLEN(newcmd);
1149 if (ins_prevcmd)
1150 {
1151 if (prevcmd == NULL)
1152 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001153 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 vim_free(newcmd);
1155 return;
1156 }
1157 len += (int)STRLEN(prevcmd);
1158 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001159 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 {
1161 vim_free(newcmd);
1162 return;
1163 }
1164 *t = NUL;
1165 if (newcmd != NULL)
1166 STRCAT(t, newcmd);
1167 if (ins_prevcmd)
1168 STRCAT(t, prevcmd);
1169 p = t + STRLEN(t);
1170 STRCAT(t, trailarg);
1171 vim_free(newcmd);
1172 newcmd = t;
1173
1174 /*
1175 * Scan the rest of the argument for '!', which is replaced by the
1176 * previous command. "\!" is replaced by "!" (this is vi compatible).
1177 */
1178 trailarg = NULL;
1179 while (*p)
1180 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001181 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 {
1183 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001184 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 else
1186 {
1187 trailarg = p;
1188 *trailarg++ = NUL;
1189 ins_prevcmd = TRUE;
1190 break;
1191 }
1192 }
1193 ++p;
1194 }
1195 } while (trailarg != NULL);
1196
1197 vim_free(prevcmd);
1198 prevcmd = newcmd;
1199
1200 if (bangredo) /* put cmd in redo buffer for ! command */
1201 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001202 /* If % or # appears in the command, it must have been escaped.
1203 * Reescape them, so that redoing them does not substitute them by the
1204 * buffername. */
1205 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1206
1207 if (cmd != NULL)
1208 {
1209 AppendToRedobuffLit(cmd, -1);
1210 vim_free(cmd);
1211 }
1212 else
1213 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 AppendToRedobuff((char_u *)"\n");
1215 bangredo = FALSE;
1216 }
1217 /*
1218 * Add quotes around the command, for shells that need them.
1219 */
1220 if (*p_shq != NUL)
1221 {
1222 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1223 if (newcmd == NULL)
1224 return;
1225 STRCPY(newcmd, p_shq);
1226 STRCAT(newcmd, prevcmd);
1227 STRCAT(newcmd, p_shq);
1228 free_newcmd = TRUE;
1229 }
1230 if (addr_count == 0) /* :! */
1231 {
1232 /* echo the command */
1233 msg_start();
1234 msg_putchar(':');
1235 msg_putchar('!');
1236 msg_outtrans(newcmd);
1237 msg_clr_eos();
1238 windgoto(msg_row, msg_col);
1239
1240 do_shell(newcmd, 0);
1241 }
1242 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001243 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 /* Careful: This may recursively call do_bang() again! (because of
1245 * autocommands) */
1246 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001247 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001248 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 if (free_newcmd)
1250 vim_free(newcmd);
1251}
1252
1253/*
1254 * do_filter: filter lines through a command given by the user
1255 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001256 * We mostly use temp files and the call_shell() routine here. This would
1257 * normally be done using pipes on a UNIX machine, but this is more portable
1258 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 * to deal with redirection somehow, and should handle things like looking
1260 * at the PATH env. variable, and adding reasonable extensions to the
1261 * command name given by the user. All reasonable versions of call_shell()
1262 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001263 * Alternatively, if on Unix and redirecting input or output, but not both,
1264 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 * We use input redirection if do_in is TRUE.
1266 * We use output redirection if do_out is TRUE.
1267 */
1268 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001269do_filter(
1270 linenr_T line1,
1271 linenr_T line2,
1272 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1273 char_u *cmd,
1274 int do_in,
1275 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276{
1277 char_u *itmp = NULL;
1278 char_u *otmp = NULL;
1279 linenr_T linecount;
1280 linenr_T read_linecount;
1281 pos_T cursor_save;
1282 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001284 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
1286 if (*cmd == NUL) /* no filter command */
1287 return;
1288
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 cursor_save = curwin->w_cursor;
1290 linecount = line2 - line1 + 1;
1291 curwin->w_cursor.lnum = line1;
1292 curwin->w_cursor.col = 0;
1293 changed_line_abv_curs();
1294 invalidate_botline();
1295
1296 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001297 * When using temp files:
1298 * 1. * Form temp file names
1299 * 2. * Write the lines to a temp file
1300 * 3. Run the filter command on the temp file
1301 * 4. * Read the output of the command into the buffer
1302 * 5. * Delete the original lines to be filtered
1303 * 6. * Remove the temp files
1304 *
1305 * When writing the input with a pipe or when catching the output with a
1306 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 */
1308
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001309 if (do_out)
1310 shell_flags |= SHELL_DOOUT;
1311
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001312#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001315 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1316 shell_flags |= SHELL_READ;
1317 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001319 else if (do_in && !do_out && !p_stmp)
1320 {
1321 /* Use a pipe to write stdin of the command, do not use a temp file. */
1322 shell_flags |= SHELL_WRITE;
1323 curbuf->b_op_start.lnum = line1;
1324 curbuf->b_op_end.lnum = line2;
1325 }
1326 else if (do_in && do_out && !p_stmp)
1327 {
1328 /* Use a pipe to write stdin and fetch stdout of the command, do not
1329 * use a temp file. */
1330 shell_flags |= SHELL_READ|SHELL_WRITE;
1331 curbuf->b_op_start.lnum = line1;
1332 curbuf->b_op_end.lnum = line2;
1333 curwin->w_cursor.lnum = line2;
1334 }
1335 else
1336#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001337 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1338 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001339 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001340 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001341 goto filterend;
1342 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343
1344/*
1345 * The writing and reading of temp files will not be shown.
1346 * Vi also doesn't do this and the messages are not very informative.
1347 */
1348 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001349 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 FALSE, FALSE, FALSE, TRUE) == FAIL)
1351 {
1352 msg_putchar('\n'); /* keep message from buf_write() */
1353 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001354#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 if (!aborting())
1356#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001357 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 goto filterend;
1359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 if (curbuf != old_curbuf)
1361 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 if (!do_out)
1364 msg_putchar('\n');
1365
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001366 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1368 if (cmd_buf == NULL)
1369 goto filterend;
1370
1371 windgoto((int)Rows - 1, 0);
1372 cursor_on();
1373
1374 /*
1375 * When not redirecting the output the command can write anything to the
1376 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1377 * stderr output of external command. Clear the screen later.
1378 * If do_in is FALSE, this could be something like ":r !cat", which may
1379 * also mess up the screen, clear it later.
1380 */
1381 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1382 redraw_later_clear();
1383
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001384 if (do_out)
1385 {
1386 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001387 {
1388 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001389 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001390 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001391 redraw_curbuf_later(VALID);
1392 }
1393 read_linecount = curbuf->b_ml.ml_line_count;
1394
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 /*
1396 * When call_shell() fails wait_return() is called to give the user a
1397 * chance to read the error messages. Otherwise errors are ignored, so you
1398 * can see the error messages from the command that appear on stdout; use
1399 * 'u' to fix the text
1400 * Switch to cooked mode when not redirecting stdin, avoids that something
1401 * like ":r !cat" hangs.
1402 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1403 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001404 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 {
1406 redraw_later_clear();
1407 wait_return(FALSE);
1408 }
1409 vim_free(cmd_buf);
1410
1411 did_check_timestamps = FALSE;
1412 need_check_timestamps = TRUE;
1413
1414 /* When interrupting the shell command, it may still have produced some
1415 * useful output. Reset got_int here, so that readfile() won't cancel
1416 * reading. */
1417 ui_breakcheck();
1418 got_int = FALSE;
1419
1420 if (do_out)
1421 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001422 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001424 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001425 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001427#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001428 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001430 {
1431 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001432 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001433 }
1434 goto error;
1435 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001436 if (curbuf != old_curbuf)
1437 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001438 }
1439
1440 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1441
1442 if (shell_flags & SHELL_READ)
1443 {
1444 curbuf->b_op_start.lnum = line2 + 1;
1445 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1446 appended_lines_mark(line2, read_linecount);
1447 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 if (do_in)
1450 {
1451 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1452 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 if (read_linecount >= linecount)
1454 /* move all marks from old lines to new lines */
1455 mark_adjust(line1, line2, linecount, 0L);
1456 else
1457 {
1458 /* move marks from old lines to new lines, delete marks
1459 * that are in deleted lines */
1460 mark_adjust(line1, line1 + read_linecount - 1,
1461 linecount, 0L);
1462 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1463 }
1464 }
1465
1466 /*
1467 * Put cursor on first filtered line for ":range!cmd".
1468 * Adjust '[ and '] (set by buf_write()).
1469 */
1470 curwin->w_cursor.lnum = line1;
1471 del_lines(linecount, TRUE);
1472 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1473 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1474 write_lnum_adjust(-linecount); /* adjust last line
1475 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001476#ifdef FEAT_FOLDING
1477 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1478#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 }
1480 else
1481 {
1482 /*
1483 * Put cursor on last new line for ":r !cmd".
1484 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001486 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001488
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1490 --no_wait_return;
1491
1492 if (linecount > p_report)
1493 {
1494 if (do_in)
1495 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001496 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001497 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001500 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 }
1502 else
1503 msgmore((long)linecount);
1504 }
1505 }
1506 else
1507 {
1508error:
1509 /* put cursor back in same position for ":w !cmd" */
1510 curwin->w_cursor = cursor_save;
1511 --no_wait_return;
1512 wait_return(FALSE);
1513 }
1514
1515filterend:
1516
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 if (curbuf != old_curbuf)
1518 {
1519 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001520 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 if (itmp != NULL)
1523 mch_remove(itmp);
1524 if (otmp != NULL)
1525 mch_remove(otmp);
1526 vim_free(itmp);
1527 vim_free(otmp);
1528}
1529
1530/*
1531 * Call a shell to execute a command.
1532 * When "cmd" is NULL start an interactive shell.
1533 */
1534 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001535do_shell(
1536 char_u *cmd,
1537 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538{
1539 buf_T *buf;
1540#ifndef FEAT_GUI_MSWIN
1541 int save_nwr;
1542#endif
1543#ifdef MSWIN
1544 int winstart = FALSE;
1545#endif
1546
1547 /*
1548 * Disallow shell commands for "rvim".
1549 * Disallow shell commands from .exrc and .vimrc in current directory for
1550 * security reasons.
1551 */
1552 if (check_restricted() || check_secure())
1553 {
1554 msg_end();
1555 return;
1556 }
1557
1558#ifdef MSWIN
1559 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 * Check if ":!start" is used.
1561 */
1562 if (cmd != NULL)
1563 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1564#endif
1565
1566 /*
1567 * For autocommands we want to get the output on the current screen, to
1568 * avoid having to type return below.
1569 */
1570 msg_putchar('\r'); /* put cursor at start of line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 {
1573#ifdef MSWIN
1574 if (!winstart)
1575#endif
1576 stoptermcap();
1577 }
1578#ifdef MSWIN
1579 if (!winstart)
1580#endif
1581 msg_putchar('\n'); /* may shift screen one line up */
1582
1583 /* warning message before calling the shell */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001584 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001585 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001586 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 {
1588#ifdef FEAT_GUI_MSWIN
1589 if (!winstart)
1590 starttermcap(); /* don't want a message box here */
1591#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001592 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593#ifdef FEAT_GUI_MSWIN
1594 if (!winstart)
1595 stoptermcap();
1596#endif
1597 break;
1598 }
1599
1600 /* This windgoto is required for when the '\n' resulted in a "delete line
1601 * 1" command to the terminal. */
1602 if (!swapping_screen())
1603 windgoto(msg_row, msg_col);
1604 cursor_on();
1605 (void)call_shell(cmd, SHELL_COOKED | flags);
1606 did_check_timestamps = FALSE;
1607 need_check_timestamps = TRUE;
1608
1609 /*
1610 * put the message cursor at the end of the screen, avoids wait_return()
1611 * to overwrite the text that the external command showed
1612 */
1613 if (!swapping_screen())
1614 {
1615 msg_row = Rows - 1;
1616 msg_col = 0;
1617 }
1618
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 if (autocmd_busy)
1620 {
1621 if (msg_silent == 0)
1622 redraw_later_clear();
1623 }
1624 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 {
1626 /*
1627 * For ":sh" there is no need to call wait_return(), just redraw.
1628 * Also for the Win32 GUI (the output is in a console window).
1629 * Otherwise there is probably text on the screen that the user wants
1630 * to read before redrawing, so call wait_return().
1631 */
1632#ifndef FEAT_GUI_MSWIN
1633 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001634# ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 || (winstart && !need_wait_return)
1636# endif
1637 )
1638 {
1639 if (msg_silent == 0)
1640 redraw_later_clear();
1641 need_wait_return = FALSE;
1642 }
1643 else
1644 {
1645 /*
1646 * If we switch screens when starttermcap() is called, we really
1647 * want to wait for "hit return to continue".
1648 */
1649 save_nwr = no_wait_return;
1650 if (swapping_screen())
1651 no_wait_return = FALSE;
1652# ifdef AMIGA
1653 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1654# else
1655 wait_return(msg_silent == 0);
1656# endif
1657 no_wait_return = save_nwr;
1658 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001659#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661#ifdef MSWIN
1662 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1663#endif
1664 starttermcap(); /* start termcap if not done by wait_return() */
1665
1666 /*
1667 * In an Amiga window redrawing is caused by asking the window size.
1668 * If we got an interrupt this will not work. The chance that the
1669 * window size is wrong is very small, but we need to redraw the
1670 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1671 * but it saves an extra redraw.
1672 */
1673#ifdef AMIGA
1674 if (skip_redraw) /* ':' hit in wait_return() */
1675 {
1676 if (msg_silent == 0)
1677 redraw_later_clear();
1678 }
1679 else if (term_console)
1680 {
1681 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1682 if (got_int && msg_silent == 0)
1683 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1684 else
1685 must_redraw = 0; /* no extra redraw needed */
1686 }
1687#endif
1688 }
1689
1690 /* display any error messages now */
1691 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001692
Bram Moolenaarade00832006-03-10 21:46:58 +00001693 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694}
1695
Bram Moolenaar06640892018-10-09 21:49:33 +02001696#if !defined(UNIX)
1697 static char_u *
1698find_pipe(char_u *cmd)
1699{
1700 char_u *p;
1701 int inquote = FALSE;
1702
1703 for (p = cmd; *p != NUL; ++p)
1704 {
1705 if (!inquote && *p == '|')
1706 return p;
1707 if (*p == '"')
1708 inquote = !inquote;
1709 else if (rem_backslash(p))
1710 ++p;
1711 }
1712 return NULL;
1713}
1714#endif
1715
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716/*
1717 * Create a shell command from a command string, input redirection file and
1718 * output redirection file.
1719 * Returns an allocated string with the shell command, or NULL for failure.
1720 */
1721 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001722make_filter_cmd(
1723 char_u *cmd, /* command */
1724 char_u *itmp, /* NULL or name of input file */
1725 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726{
1727 char_u *buf;
1728 long_u len;
1729
Bram Moolenaar53076832015-12-31 19:53:21 +01001730#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001731 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001732 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001733
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001734 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001735 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1736 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001737 if (is_fish_shell)
1738 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1739 else
1740#endif
1741 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 if (itmp != NULL)
1743 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1744 if (otmp != NULL)
1745 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1746 buf = lalloc(len, TRUE);
1747 if (buf == NULL)
1748 return NULL;
1749
Bram Moolenaar53076832015-12-31 19:53:21 +01001750#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001752 * Put braces around the command (for concatenated commands) when
1753 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001755 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001756 {
1757 if (is_fish_shell)
1758 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1759 else
1760 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1761 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001762 else
1763 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 if (itmp != NULL)
1765 {
1766 STRCAT(buf, " < ");
1767 STRCAT(buf, itmp);
1768 }
1769#else
1770 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001771 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 * the use of commands in a pipe.
1773 */
1774 STRCPY(buf, cmd);
1775 if (itmp != NULL)
1776 {
1777 char_u *p;
1778
1779 /*
1780 * If there is a pipe, we have to put the '<' in front of it.
1781 * Don't do this when 'shellquote' is not empty, otherwise the
1782 * redirection would be inside the quotes.
1783 */
1784 if (*p_shq == NUL)
1785 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001786 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 if (p != NULL)
1788 *p = NUL;
1789 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1791 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 if (*p_shq == NUL)
1793 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001794 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 if (p != NULL)
1796 {
1797 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1798 STRCAT(buf, p);
1799 }
1800 }
1801 }
1802#endif
1803 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001804 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805
1806 return buf;
1807}
1808
1809/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001810 * Append output redirection for file "fname" to the end of string buffer
1811 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 * Works with the 'shellredir' and 'shellpipe' options.
1813 * The caller should make sure that there is enough room:
1814 * STRLEN(opt) + STRLEN(fname) + 3
1815 */
1816 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001817append_redir(
1818 char_u *buf,
1819 int buflen,
1820 char_u *opt,
1821 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822{
1823 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001824 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001826 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001827 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001829 {
1830 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001832 if (p[1] == '%') /* skip %% */
1833 ++p;
1834 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 if (p != NULL)
1836 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001837 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1838 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1839 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 }
1841 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001842 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 " %s %s",
1845#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847#endif
1848 (char *)opt, (char *)fname);
1849}
1850
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001851#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001853static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001854static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001855static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856static int viminfo_errcnt;
1857
1858 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001859no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860{
1861 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001862 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863}
1864
1865/*
1866 * Report an error for reading a viminfo file.
1867 * Count the number of errors. When there are more than 10, return TRUE.
1868 */
1869 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001870viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001872 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1873 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001874 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001875 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1876 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001877 emsg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 if (++viminfo_errcnt >= 10)
1879 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001880 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 return TRUE;
1882 }
1883 return FALSE;
1884}
1885
1886/*
1887 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001888 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 */
1890 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001891read_viminfo(
1892 char_u *file, /* file name or NULL to use default name */
1893 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894{
1895 FILE *fp;
1896 char_u *fname;
1897
1898 if (no_viminfo())
1899 return FAIL;
1900
Bram Moolenaard812df62008-11-09 12:46:09 +00001901 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 if (fname == NULL)
1903 return FAIL;
1904 fp = mch_fopen((char *)fname, READBIN);
1905
1906 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001907 {
1908 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001909 smsg(_("Reading viminfo file \"%s\"%s%s%s"),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001910 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001911 (flags & VIF_WANT_INFO) ? _(" info") : "",
1912 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1913 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001914 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001915 verbose_leave();
1916 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917
1918 vim_free(fname);
1919 if (fp == NULL)
1920 return FAIL;
1921
1922 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001923 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
1925 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 return OK;
1927}
1928
1929/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001930 * Write the viminfo file. The old one is read in first so that effectively a
1931 * merge of current info and old info is done. This allows multiple vims to
1932 * run simultaneously, without losing any marks etc.
1933 * If "forceit" is TRUE, then the old file is not read in, and only internal
1934 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935 */
1936 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001937write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938{
1939 char_u *fname;
1940 FILE *fp_in = NULL; /* input viminfo file, if any */
1941 FILE *fp_out = NULL; /* output viminfo file */
1942 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001943 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944#if defined(UNIX) || defined(VMS)
1945 mode_t umask_save;
1946#endif
1947#ifdef UNIX
1948 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001949 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001951#ifdef MSWIN
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001952 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001953#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954
1955 if (no_viminfo())
1956 return;
1957
1958 fname = viminfo_filename(file); /* may set to default if NULL */
1959 if (fname == NULL)
1960 return;
1961
1962 fp_in = mch_fopen((char *)fname, READBIN);
1963 if (fp_in == NULL)
1964 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001965 int fd;
1966
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 /* if it does exist, but we can't read it, don't try writing */
1968 if (mch_stat((char *)fname, &st_new) == 0)
1969 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001970
1971 /* Create the new .viminfo non-accessible for others, because it may
1972 * contain text from non-accessible documents. It is up to the user to
1973 * widen access (e.g. to a group). This may also fail if there is a
1974 * race condition, then just give up. */
1975 fd = mch_open((char *)fname,
1976 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1977 if (fd < 0)
1978 goto end;
1979 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 }
1981 else
1982 {
1983 /*
1984 * There is an existing viminfo file. Create a temporary file to
1985 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001986 * existing viminfo file, which will be renamed once all writing is
1987 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 */
1989#ifdef UNIX
1990 /*
1991 * For Unix we check the owner of the file. It's not very nice to
1992 * overwrite a user's viminfo file after a "su root", with a
1993 * viminfo file that the user can't read.
1994 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001995 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001996 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001998 if (mch_stat((char *)fname, &st_old) == 0
1999 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00002000 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 ? (st_old.st_mode & 0200)
2002 : (st_old.st_gid == getgid()
2003 ? (st_old.st_mode & 0020)
2004 : (st_old.st_mode & 0002))))
2005 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00002006 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007
2008 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002009 semsg(_("E137: Viminfo file is not writable: %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002011 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 goto end;
2013 }
2014#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002015#ifdef MSWIN
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002016 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01002017 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002018#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002021 * Make tempname, find one that does not exist yet.
2022 * Beware of a race condition: If someone logs out and all Vim
2023 * instances exit at the same time a temp file might be created between
2024 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 * May try twice: Once normal and once with shortname set, just in
2026 * case somebody puts his viminfo file in an 8.3 filesystem.
2027 */
2028 for (;;)
2029 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002030 int next_char = 'z';
2031 char_u *wp;
2032
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 tempname = buf_modname(
2034#ifdef UNIX
2035 shortname,
2036#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038#endif
2039 fname,
2040#ifdef VMS
2041 (char_u *)"-tmp",
2042#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044#endif
2045 FALSE);
2046 if (tempname == NULL) /* out of memory */
2047 break;
2048
2049 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002050 * Try a series of names. Change one character, just before
2051 * the extension. This should also work for an 8.3
2052 * file name, when after adding the extension it still is
2053 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002055 wp = tempname + STRLEN(tempname) - 5;
2056 if (wp < gettail(tempname)) /* empty file name? */
2057 wp = gettail(tempname);
2058 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002060 /*
2061 * Check if tempfile already exists. Never overwrite an
2062 * existing file!
2063 */
2064 if (mch_stat((char *)tempname, &st_new) == 0)
2065 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002068 * Check if tempfile is same as original file. May happen
2069 * when modname() gave the same file back. E.g. silly
2070 * link, or file name-length reached. Try again with
2071 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002073 if (!shortname && st_new.st_dev == st_old.st_dev
2074 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01002076 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002077 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 break;
2079 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002080#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002082 else
2083 {
2084 /* Try creating the file exclusively. This may fail if
2085 * another Vim tries to do it at the same time. */
2086#ifdef VMS
2087 /* fdopen() fails for some reason */
2088 umask_save = umask(077);
2089 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2090 (void)umask(umask_save);
2091#else
2092 int fd;
2093
2094 /* Use mch_open() to be able to use O_NOFOLLOW and set file
2095 * protection:
2096 * Unix: same as original file, but strip s-bit. Reset
2097 * umask to avoid it getting in the way.
2098 * Others: r&w for user only. */
2099# ifdef UNIX
2100 umask_save = umask(0);
2101 fd = mch_open((char *)tempname,
2102 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
2103 (int)((st_old.st_mode & 0777) | 0600));
2104 (void)umask(umask_save);
2105# else
2106 fd = mch_open((char *)tempname,
2107 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
2108# endif
2109 if (fd < 0)
2110 {
2111 fp_out = NULL;
2112# ifdef EEXIST
2113 /* Avoid trying lots of names while the problem is lack
Bram Moolenaar94747162019-02-10 21:55:26 +01002114 * of permission, only retry if the file already
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002115 * exists. */
2116 if (errno != EEXIST)
2117 break;
2118# endif
2119 }
2120 else
2121 fp_out = fdopen(fd, WRITEBIN);
2122#endif /* VMS */
2123 if (fp_out != NULL)
2124 break;
2125 }
2126
2127 /* Assume file exists, try again with another name. */
2128 if (next_char == 'a' - 1)
2129 {
2130 /* They all exist? Must be something wrong! Don't write
2131 * the viminfo file then. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002132 semsg(_("E929: Too many viminfo temp files, like %s!"),
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002133 tempname);
2134 break;
2135 }
2136 *wp = next_char;
2137 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002139
2140 if (tempname != NULL)
2141 break;
2142 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 }
2144
Bram Moolenaara5792f52005-11-23 21:25:05 +00002145#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002146 if (tempname != NULL && fp_out != NULL)
2147 {
2148 stat_T tmp_st;
2149
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002151 * Make sure the original owner can read/write the tempfile and
2152 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002154 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002155 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002156 if (st_old.st_uid != tmp_st.st_uid)
2157 /* Changing the owner might fail, in which case the
2158 * file will now owned by the current user, oh well. */
Bram Moolenaar42335f52018-09-13 15:33:43 +02002159 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002160 if (st_old.st_gid != tmp_st.st_gid
2161 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2162 /* can't set the group to what it should be, remove
2163 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002164 (void)mch_setperm(tempname, 0600);
2165 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002166 else
2167 /* can't stat the file, set conservative permissions */
2168 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002170#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002171 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172
2173 /*
2174 * Check if the new viminfo file can be written to.
2175 */
2176 if (fp_out == NULL)
2177 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002178 semsg(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002179 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 if (fp_in != NULL)
2181 fclose(fp_in);
2182 goto end;
2183 }
2184
2185 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002186 {
2187 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002188 smsg(_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002189 verbose_leave();
2190 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191
2192 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002193 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194
Bram Moolenaar927030a2016-03-15 18:23:55 +01002195 if (fclose(fp_out) == EOF)
2196 ++viminfo_errcnt;
2197
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 if (fp_in != NULL)
2199 {
2200 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002201
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002202 /* In case of an error keep the original viminfo file. Otherwise
2203 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002204 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002205 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002206 if (vim_rename(tempname, fname) == -1)
2207 {
2208 ++viminfo_errcnt;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002209 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
Bram Moolenaar927030a2016-03-15 18:23:55 +01002210 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002211# ifdef MSWIN
Bram Moolenaar927030a2016-03-15 18:23:55 +01002212 /* If the viminfo file was hidden then also hide the new file. */
2213 else if (hidden)
2214 mch_hide(fname);
2215# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002216 }
2217 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 mch_remove(tempname);
2219 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002220
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221end:
2222 vim_free(fname);
2223 vim_free(tempname);
2224}
2225
2226/*
2227 * Get the viminfo file name to use.
2228 * If "file" is given and not empty, use it (has already been expanded by
2229 * cmdline functions).
2230 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2231 * expand environment variables.
2232 * Returns an allocated string. NULL when out of memory.
2233 */
2234 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002235viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236{
2237 if (file == NULL || *file == NUL)
2238 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002239 if (*p_viminfofile != NUL)
2240 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2242 {
2243#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244# ifdef VMS
2245 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2246# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002247# ifdef MSWIN
2248 /* Use $VIM only if $HOME is the default "C:/". */
2249 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2250 && mch_getenv((char_u *)"HOME") == NULL)
2251# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002253# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254# endif
2255 {
2256 /* don't use $VIM when not available. */
2257 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2258 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2259 file = (char_u *)VIMINFO_FILE2;
2260 else
2261 file = (char_u *)VIMINFO_FILE;
2262 }
2263 else
2264#endif
2265 file = (char_u *)VIMINFO_FILE;
2266 }
2267 expand_env(file, NameBuff, MAXPATHL);
2268 file = NameBuff;
2269 }
2270 return vim_strsave(file);
2271}
2272
2273/*
2274 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2275 */
2276 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002277do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 int eof = FALSE;
2280 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002281 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002282 int do_copy_marks = FALSE;
2283 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284
2285 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2286 return;
2287 vir.vir_fd = fp_in;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002289 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002290 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291
2292 if (fp_in != NULL)
2293 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002294 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002295 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002296 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002297 {
2298 /* Registers and marks are read and kept separate from what
2299 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002300 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002301 prepare_viminfo_marks();
2302 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002303
Bram Moolenaard812df62008-11-09 12:46:09 +00002304 eof = read_viminfo_up_to_marks(&vir,
2305 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002306 merge = TRUE;
2307 }
2308 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 /* Skip info, find start of marks */
2310 while (!(eof = viminfo_readline(&vir))
2311 && vir.vir_line[0] != '>')
2312 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002313
2314 do_copy_marks = (flags &
2315 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002317
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 if (fp_out != NULL)
2319 {
2320 /* Write the info: */
2321 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2322 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002323 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002324 write_viminfo_version(fp_out);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002325 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 write_viminfo_search_pattern(fp_out);
2328 write_viminfo_sub_string(fp_out);
2329#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002330 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331#endif
2332 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002333 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334#ifdef FEAT_EVAL
2335 write_viminfo_varlist(fp_out);
2336#endif
2337 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002338 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002340 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002341
2342 if (do_copy_marks)
2343 ga_init2(&buflist, sizeof(buf_T *), 50);
2344 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002346
2347 if (do_copy_marks)
2348 {
2349 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2350 if (fp_out != NULL)
2351 ga_clear(&buflist);
2352 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353
2354 vim_free(vir.vir_line);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 if (vir.vir_conv.vc_type != CONV_NONE)
2356 convert_setup(&vir.vir_conv, NULL, NULL);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002357 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358}
2359
2360/*
2361 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2362 * first part of the viminfo file which contains everything but the marks that
2363 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2364 */
2365 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002366read_viminfo_up_to_marks(
2367 vir_T *virp,
2368 int forceit,
2369 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370{
2371 int eof;
2372 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002373 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374
2375#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002376 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002378
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 eof = viminfo_readline(virp);
2380 while (!eof && virp->vir_line[0] != '>')
2381 {
2382 switch (virp->vir_line[0])
2383 {
2384 /* Characters reserved for future expansion, ignored now */
2385 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 case '^': /* to be defined */
2387 case '<': /* long line - ignored */
2388 /* A comment or empty line. */
2389 case NUL:
2390 case '\r':
2391 case '\n':
2392 case '#':
2393 eof = viminfo_readline(virp);
2394 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002395 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002396 eof = read_viminfo_barline(virp, got_encoding,
2397 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002398 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002400 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 eof = viminfo_encoding(virp);
2402 break;
2403 case '!': /* global variable */
2404#ifdef FEAT_EVAL
2405 eof = read_viminfo_varlist(virp, writing);
2406#else
2407 eof = viminfo_readline(virp);
2408#endif
2409 break;
2410 case '%': /* entry for buffer list */
2411 eof = read_viminfo_bufferlist(virp, writing);
2412 break;
2413 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002414 /* When registers are in bar lines skip the old style register
2415 * lines. */
2416 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2417 eof = read_viminfo_register(virp, forceit);
2418 else
2419 do {
2420 eof = viminfo_readline(virp);
2421 } while (!eof && (virp->vir_line[0] == TAB
2422 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 break;
2424 case '/': /* Search string */
2425 case '&': /* Substitute search string */
2426 case '~': /* Last search string, followed by '/' or '&' */
2427 eof = read_viminfo_search_pattern(virp, forceit);
2428 break;
2429 case '$':
2430 eof = read_viminfo_sub_string(virp, forceit);
2431 break;
2432 case ':':
2433 case '?':
2434 case '=':
2435 case '@':
2436#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002437 /* When history is in bar lines skip the old style history
2438 * lines. */
2439 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2440 eof = read_viminfo_history(virp, writing);
2441 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002443 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 break;
2445 case '-':
2446 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002447 /* When file marks are in bar lines skip the old style lines. */
2448 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2449 eof = read_viminfo_filemark(virp, forceit);
2450 else
2451 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 break;
2453 default:
2454 if (viminfo_error("E575: ", _("Illegal starting char"),
2455 virp->vir_line))
2456 eof = TRUE;
2457 else
2458 eof = viminfo_readline(virp);
2459 break;
2460 }
2461 }
2462
2463#ifdef FEAT_CMDHIST
2464 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002465 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002466 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467#endif
2468
2469 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002470 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 fmarks_check_names(buf);
2472
2473 return eof;
2474}
2475
2476/*
2477 * Compare the 'encoding' value in the viminfo file with the current value of
2478 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2479 * conversion of text with iconv() in viminfo_readstring().
2480 */
2481 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002482viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 char_u *p;
2485 int i;
2486
2487 if (get_viminfo_parameter('c') != 0)
2488 {
2489 p = vim_strchr(virp->vir_line, '=');
2490 if (p != NULL)
2491 {
2492 /* remove trailing newline */
2493 ++p;
2494 for (i = 0; vim_isprintc(p[i]); ++i)
2495 ;
2496 p[i] = NUL;
2497
2498 convert_setup(&virp->vir_conv, p, p_enc);
2499 }
2500 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 return viminfo_readline(virp);
2502}
2503
2504/*
2505 * Read a line from the viminfo file.
2506 * Returns TRUE for end-of-file;
2507 */
2508 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002509viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510{
2511 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2512}
2513
2514/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002515 * Check string read from viminfo file.
2516 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 * - replace CTRL-V CTRL-V with CTRL-V
2518 * - replace CTRL-V 'n' with '\n'
2519 *
2520 * Check for a long line as written by viminfo_writestring().
2521 *
2522 * Return the string in allocated memory (NULL when out of memory).
2523 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002525viminfo_readstring(
2526 vir_T *virp,
2527 int off, /* offset for virp->vir_line */
2528 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529{
2530 char_u *retval;
2531 char_u *s, *d;
2532 long len;
2533
2534 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2535 {
2536 len = atol((char *)virp->vir_line + off + 1);
2537 retval = lalloc(len, TRUE);
2538 if (retval == NULL)
2539 {
2540 /* Line too long? File messed up? Skip next line. */
2541 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2542 return NULL;
2543 }
2544 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2545 s = retval + 1; /* Skip the leading '<' */
2546 }
2547 else
2548 {
2549 retval = vim_strsave(virp->vir_line + off);
2550 if (retval == NULL)
2551 return NULL;
2552 s = retval;
2553 }
2554
2555 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2556 d = retval;
2557 while (*s != NUL && *s != '\n')
2558 {
2559 if (s[0] == Ctrl_V && s[1] != NUL)
2560 {
2561 if (s[1] == 'n')
2562 *d++ = '\n';
2563 else
2564 *d++ = Ctrl_V;
2565 s += 2;
2566 }
2567 else
2568 *d++ = *s++;
2569 }
2570 *d = NUL;
2571
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2573 {
2574 d = string_convert(&virp->vir_conv, retval, NULL);
2575 if (d != NULL)
2576 {
2577 vim_free(retval);
2578 retval = d;
2579 }
2580 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581
2582 return retval;
2583}
2584
2585/*
2586 * write string to viminfo file
2587 * - replace CTRL-V with CTRL-V CTRL-V
2588 * - replace '\n' with CTRL-V 'n'
2589 * - add a '\n' at the end
2590 *
2591 * For a long line:
2592 * - write " CTRL-V <length> \n " in first line
2593 * - write " < <string> \n " in second line
2594 */
2595 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002596viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597{
2598 int c;
2599 char_u *s;
2600 int len = 0;
2601
2602 for (s = p; *s != NUL; ++s)
2603 {
2604 if (*s == Ctrl_V || *s == '\n')
2605 ++len;
2606 ++len;
2607 }
2608
2609 /* If the string will be too long, write its length and put it in the next
2610 * line. Take into account that some room is needed for what comes before
2611 * the string (e.g., variable name). Add something to the length for the
2612 * '<', NL and trailing NUL. */
2613 if (len > LSIZE / 2)
2614 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2615
2616 while ((c = *p++) != NUL)
2617 {
2618 if (c == Ctrl_V || c == '\n')
2619 {
2620 putc(Ctrl_V, fd);
2621 if (c == '\n')
2622 c = 'n';
2623 }
2624 putc(c, fd);
2625 }
2626 putc('\n', fd);
2627}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002628
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002629/*
2630 * Write a string in quotes that barline_parse() can read back.
2631 * Breaks the line in less than LSIZE pieces when needed.
2632 * Returns remaining characters in the line.
2633 */
2634 int
2635barline_writestring(FILE *fd, char_u *s, int remaining_start)
2636{
2637 char_u *p;
2638 int remaining = remaining_start;
2639 int len = 2;
2640
2641 /* Count the number of characters produced, including quotes. */
2642 for (p = s; *p != NUL; ++p)
2643 {
2644 if (*p == NL)
2645 len += 2;
2646 else if (*p == '"' || *p == '\\')
2647 len += 2;
2648 else
2649 ++len;
2650 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002651 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002652 {
2653 fprintf(fd, ">%d\n|<", len);
2654 remaining = LSIZE - 20;
2655 }
2656
2657 putc('"', fd);
2658 for (p = s; *p != NUL; ++p)
2659 {
2660 if (*p == NL)
2661 {
2662 putc('\\', fd);
2663 putc('n', fd);
2664 --remaining;
2665 }
2666 else if (*p == '"' || *p == '\\')
2667 {
2668 putc('\\', fd);
2669 putc(*p, fd);
2670 --remaining;
2671 }
2672 else
2673 putc(*p, fd);
2674 --remaining;
2675
2676 if (remaining < 3)
2677 {
2678 putc('\n', fd);
2679 putc('|', fd);
2680 putc('<', fd);
2681 /* Leave enough space for another continuation. */
2682 remaining = LSIZE - 20;
2683 }
2684 }
2685 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002686 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002687}
2688
2689/*
2690 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002691 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002692 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002693 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002694 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002695barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002696{
2697 char_u *p = text;
2698 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002699 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002700 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002701 int i;
2702 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002703 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002704 char_u *sconv;
2705 int converted;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002706
2707 while (*p == ',')
2708 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002709 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002710 if (ga_grow(values, 1) == FAIL)
2711 break;
2712 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002713
2714 if (*p == '>')
2715 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002716 /* Need to read a continuation line. Put strings in allocated
2717 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002718 if (!allocated)
2719 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002720 for (i = 0; i < values->ga_len; ++i)
2721 {
2722 bval_T *vp = (bval_T *)(values->ga_data) + i;
2723
2724 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002725 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002726 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2727 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002728 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002729 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002730 allocated = TRUE;
2731 }
2732
2733 if (vim_isdigit(p[1]))
2734 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002735 size_t len;
2736 size_t todo;
2737 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002738
2739 /* String value was split into lines that are each shorter
2740 * than LSIZE:
2741 * |{bartype},>{length of "{text}{text2}"}
2742 * |<"{text1}
2743 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002744 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002745 */
2746 ++p;
2747 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002748 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002749 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002750 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002751 p = buf;
2752 for (todo = len; todo > 0; todo -= n)
2753 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002754 eof = viminfo_readline(virp);
2755 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002756 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002757 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002758 /* File was truncated or garbled. Read another line if
2759 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002760 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002761 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002762 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002763 /* Get length of text, excluding |< and NL chars. */
2764 n = STRLEN(virp->vir_line);
2765 while (n > 0 && (virp->vir_line[n - 1] == NL
2766 || virp->vir_line[n - 1] == CAR))
2767 --n;
2768 n -= 2;
2769 if (n > todo)
2770 {
2771 /* more values follow after the string */
2772 nextp = virp->vir_line + 2 + todo;
2773 n = todo;
2774 }
2775 mch_memmove(p, virp->vir_line + 2, n);
2776 p += n;
2777 }
2778 *p = NUL;
2779 p = buf;
2780 }
2781 else
2782 {
2783 /* Line ending in ">" continues in the next line:
2784 * |{bartype},{lots of values},>
2785 * |<{value},{value}
2786 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002787 eof = viminfo_readline(virp);
2788 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002789 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002790 /* File was truncated or garbled. Read another line if
2791 * this one starts with '|'. */
2792 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002793 p = virp->vir_line + 2;
2794 }
2795 }
2796
2797 if (isdigit(*p))
2798 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002799 value->bv_type = BVAL_NR;
2800 value->bv_nr = getdigits(&p);
2801 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002802 }
2803 else if (*p == '"')
2804 {
2805 int len = 0;
2806 char_u *s = p;
2807
2808 /* Unescape special characters in-place. */
2809 ++p;
2810 while (*p != '"')
2811 {
2812 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002813 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002814 if (*p == '\\')
2815 {
2816 ++p;
2817 if (*p == 'n')
2818 s[len++] = '\n';
2819 else
2820 s[len++] = *p;
2821 ++p;
2822 }
2823 else
2824 s[len++] = *p++;
2825 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002826 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002827 s[len] = NUL;
2828
Bram Moolenaar01227092016-06-11 14:47:40 +02002829 converted = FALSE;
2830 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2831 {
2832 sconv = string_convert(&virp->vir_conv, s, NULL);
2833 if (sconv != NULL)
2834 {
2835 if (s == buf)
2836 vim_free(s);
2837 s = sconv;
2838 buf = s;
2839 converted = TRUE;
2840 }
2841 }
Bram Moolenaar13505972019-01-24 15:04:48 +01002842
Bram Moolenaar01227092016-06-11 14:47:40 +02002843 /* Need to copy in allocated memory if the string wasn't allocated
2844 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002845 if (s != buf && allocated)
2846 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002847 value->bv_string = s;
2848 value->bv_type = BVAL_STRING;
2849 value->bv_len = len;
Bram Moolenaar13505972019-01-24 15:04:48 +01002850 value->bv_allocated = allocated || converted;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002851 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002852 if (nextp != NULL)
2853 {
2854 /* values following a long string */
2855 p = nextp;
2856 nextp = NULL;
2857 }
2858 }
2859 else if (*p == ',')
2860 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002861 value->bv_type = BVAL_EMPTY;
2862 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002863 }
2864 else
2865 break;
2866 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002867 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002868}
2869
2870 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002871read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002872{
2873 char_u *p = virp->vir_line + 1;
2874 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002875 garray_T values;
2876 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002877 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002878 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002879
2880 /* The format is: |{bartype},{value},...
2881 * For a very long string:
2882 * |{bartype},>{length of "{text}{text2}"}
2883 * |<{text1}
2884 * |<{text2},{value}
2885 * For a long line not using a string
2886 * |{bartype},{lots of values},>
2887 * |<{value},{value}
2888 */
2889 if (*p == '<')
2890 {
2891 /* Continuation line of an unrecognized item. */
2892 if (writing)
2893 ga_add_string(&virp->vir_barlines, virp->vir_line);
2894 }
2895 else
2896 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002897 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002898 bartype = getdigits(&p);
2899 switch (bartype)
2900 {
2901 case BARTYPE_VERSION:
2902 /* Only use the version when it comes before the encoding.
2903 * If it comes later it was copied by a Vim version that
2904 * doesn't understand the version. */
2905 if (!got_encoding)
2906 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002907 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002908 vp = (bval_T *)values.ga_data;
2909 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2910 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002911 }
2912 break;
2913
2914 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002915 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002916 handle_viminfo_history(&values, writing);
2917 break;
2918
2919 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002920 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002921 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002922 break;
2923
Bram Moolenaar2d358992016-06-12 21:20:54 +02002924 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002925 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002926 handle_viminfo_mark(&values, force);
2927 break;
2928
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002929 default:
2930 /* copy unrecognized line (for future use) */
2931 if (writing)
2932 ga_add_string(&virp->vir_barlines, virp->vir_line);
2933 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002934 for (i = 0; i < values.ga_len; ++i)
2935 {
2936 vp = (bval_T *)values.ga_data + i;
2937 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2938 vim_free(vp->bv_string);
2939 }
2940 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002941 }
2942
Bram Moolenaarecefe712016-06-20 12:50:17 +02002943 if (read_next)
2944 return viminfo_readline(virp);
2945 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002946}
2947
2948 static void
2949write_viminfo_version(FILE *fp_out)
2950{
2951 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2952 BARTYPE_VERSION, VIMINFO_VERSION);
2953}
2954
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002955 static void
2956write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2957{
2958 int i;
2959 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002960 int seen_useful = FALSE;
2961 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002962
2963 if (gap->ga_len > 0)
2964 {
2965 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2966
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002967 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002968 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002969 {
2970 line = ((char **)(gap->ga_data))[i];
2971 if (seen_useful || line[1] != '<')
2972 {
2973 fputs(line, fp_out);
2974 seen_useful = TRUE;
2975 }
2976 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002977 }
2978}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979#endif /* FEAT_VIMINFO */
2980
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002981/*
2982 * Return the current time in seconds. Calls time(), unless test_settime()
2983 * was used.
2984 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002985 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002986vim_time(void)
2987{
2988# ifdef FEAT_EVAL
2989 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2990# else
2991 return time(NULL);
2992# endif
2993}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995/*
2996 * Implementation of ":fixdel", also used by get_stty().
2997 * <BS> resulting <Del>
2998 * ^? ^H
2999 * not ^? ^?
3000 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003002do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003{
3004 char_u *p;
3005
3006 p = find_termcode((char_u *)"kb");
3007 add_termcode((char_u *)"kD", p != NULL
3008 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
3009}
3010
3011 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003012print_line_no_prefix(
3013 linenr_T lnum,
3014 int use_number,
3015 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016{
Bram Moolenaar32526b32019-01-19 17:43:09 +01003017 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018
3019 if (curwin->w_p_nu || use_number)
3020 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01003021 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003022 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01003023 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003025 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026}
3027
3028/*
3029 * Print a text line. Also in silent mode ("ex -s").
3030 */
3031 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003032print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033{
3034 int save_silent = silent_mode;
3035
Bram Moolenaard29459b2016-08-26 22:29:11 +02003036 /* apply :filter /pat/ */
3037 if (message_filtered(ml_get(lnum)))
3038 return;
3039
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003041 silent_mode = FALSE;
3042 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
3043 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 if (save_silent)
3045 {
3046 msg_putchar('\n');
3047 cursor_on(); /* msg_start() switches it off */
3048 out_flush();
3049 silent_mode = save_silent;
3050 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00003051 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052}
3053
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003054 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003055rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003056{
3057 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02003058 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003059
Bram Moolenaar7e283842013-05-30 11:43:15 +02003060 buf = curbuf;
3061 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003062 /* buffer changed, don't change name now */
3063 if (buf != curbuf)
3064 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003065#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003066 if (aborting()) /* autocmds may abort script processing */
3067 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003068#endif
3069 /*
3070 * The name of the current buffer will be changed.
3071 * A new (unlisted) buffer entry needs to be made to hold the old file
3072 * name, which will become the alternate file name.
3073 * But don't set the alternate file name if the buffer didn't have a
3074 * name.
3075 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02003076 fname = curbuf->b_ffname;
3077 sfname = curbuf->b_sfname;
3078 xfname = curbuf->b_fname;
3079 curbuf->b_ffname = NULL;
3080 curbuf->b_sfname = NULL;
3081 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003082 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02003083 curbuf->b_ffname = fname;
3084 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003085 return FAIL;
3086 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02003087 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003088 if (xfname != NULL && *xfname != NUL)
3089 {
3090 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
3091 if (buf != NULL && !cmdmod.keepalt)
3092 curwin->w_alt_fnum = buf->b_fnum;
3093 }
3094 vim_free(fname);
3095 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02003096 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003097
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003098 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003099 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003100 return OK;
3101}
3102
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103/*
3104 * ":file[!] [fname]".
3105 */
3106 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003107ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003109 /* ":0file" removes the file name. Check for illegal uses ":3file",
3110 * "0file name", etc. */
3111 if (eap->addr_count > 0
3112 && (*eap->arg != NUL
3113 || eap->line2 > 0
3114 || eap->addr_count > 1))
3115 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003116 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003117 return;
3118 }
3119
3120 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003122 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02003124 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02003126
3127 // print file name if no argument or 'F' is not in 'shortmess'
3128 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01003129 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130}
3131
3132/*
3133 * ":update".
3134 */
3135 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003136ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137{
3138 if (curbufIsChanged())
3139 (void)do_write(eap);
3140}
3141
3142/*
3143 * ":write" and ":saveas".
3144 */
3145 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003146ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147{
3148 if (eap->usefilter) /* input lines to shell command */
3149 do_bang(1, eap, FALSE, TRUE, FALSE);
3150 else
3151 (void)do_write(eap);
3152}
3153
3154/*
3155 * write current buffer to file 'eap->arg'
3156 * if 'eap->append' is TRUE, append to the file
3157 *
3158 * if *eap->arg == NUL write to current file
3159 *
3160 * return FAIL for failure, OK otherwise
3161 */
3162 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003163do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164{
3165 int other;
3166 char_u *fname = NULL; /* init to shut up gcc */
3167 char_u *ffname;
3168 int retval = FAIL;
3169 char_u *free_fname = NULL;
3170#ifdef FEAT_BROWSE
3171 char_u *browse_file = NULL;
3172#endif
3173 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003174 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175
3176 if (not_writing()) /* check 'write' option */
3177 return FAIL;
3178
3179 ffname = eap->arg;
3180#ifdef FEAT_BROWSE
3181 if (cmdmod.browse)
3182 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003183 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 NULL, NULL, NULL, curbuf);
3185 if (browse_file == NULL)
3186 goto theend;
3187 ffname = browse_file;
3188 }
3189#endif
3190 if (*ffname == NUL)
3191 {
3192 if (eap->cmdidx == CMD_saveas)
3193 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003194 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 goto theend;
3196 }
3197 other = FALSE;
3198 }
3199 else
3200 {
3201 fname = ffname;
3202 free_fname = fix_fname(ffname);
3203 /*
3204 * When out-of-memory, keep unexpanded file name, because we MUST be
3205 * able to write the file in this situation.
3206 */
3207 if (free_fname != NULL)
3208 ffname = free_fname;
3209 other = otherfile(ffname);
3210 }
3211
3212 /*
3213 * If we have a new file, put its name in the list of alternate file names.
3214 */
3215 if (other)
3216 {
3217 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3218 || eap->cmdidx == CMD_saveas)
3219 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3220 else
3221 alt_buf = buflist_findname(ffname);
3222 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3223 {
3224 /* Overwriting a file that is loaded in another buffer is not a
3225 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003226 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 goto theend;
3228 }
3229 }
3230
3231 /*
3232 * Writing to the current file is not allowed in readonly mode
3233 * and a file name is required.
3234 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3235 */
3236 if (!other && (
3237#ifdef FEAT_QUICKFIX
3238 bt_dontwrite_msg(curbuf) ||
3239#endif
3240 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3241 goto theend;
3242
3243 if (!other)
3244 {
3245 ffname = curbuf->b_ffname;
3246 fname = curbuf->b_fname;
3247 /*
3248 * Not writing the whole file is only allowed with '!'.
3249 */
3250 if ( (eap->line1 != 1
3251 || eap->line2 != curbuf->b_ml.ml_line_count)
3252 && !eap->forceit
3253 && !eap->append
3254 && !p_wa)
3255 {
3256#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3257 if (p_confirm || cmdmod.confirm)
3258 {
3259 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3260 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3261 goto theend;
3262 eap->forceit = TRUE;
3263 }
3264 else
3265#endif
3266 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003267 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 goto theend;
3269 }
3270 }
3271 }
3272
3273 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3274 {
3275 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3276 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 buf_T *was_curbuf = curbuf;
3278
3279 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003280 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003281#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003283#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003285#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 {
3287 /* buffer changed, don't change name now */
3288 retval = FAIL;
3289 goto theend;
3290 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 /* Exchange the file names for the current and the alternate
3292 * buffer. This makes it look like we are now editing the buffer
3293 * under the new name. Must be done before buf_write(), because
3294 * if there is no file name and 'cpo' contains 'F', it will set
3295 * the file name. */
3296 fname = alt_buf->b_fname;
3297 alt_buf->b_fname = curbuf->b_fname;
3298 curbuf->b_fname = fname;
3299 fname = alt_buf->b_ffname;
3300 alt_buf->b_ffname = curbuf->b_ffname;
3301 curbuf->b_ffname = fname;
3302 fname = alt_buf->b_sfname;
3303 alt_buf->b_sfname = curbuf->b_sfname;
3304 curbuf->b_sfname = fname;
3305 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003306
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003308 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 if (!alt_buf->b_p_bl)
3310 {
3311 alt_buf->b_p_bl = TRUE;
3312 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3313 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003314#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003316#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003318#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 {
3320 /* buffer changed, don't write the file */
3321 retval = FAIL;
3322 goto theend;
3323 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003324
3325 /* If 'filetype' was empty try detecting it now. */
3326 if (*curbuf->b_p_ft == NUL)
3327 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003328 if (au_has_group((char_u *)"filetypedetect"))
3329 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003330 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003331 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003332 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003333
3334 /* Autocommands may have changed buffer names, esp. when
3335 * 'autochdir' is set. */
3336 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 }
3338
Bram Moolenaar5c719942016-07-09 23:40:45 +02003339 name_was_missing = curbuf->b_ffname == NULL;
3340
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3342 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003343
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003344 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003345 if (eap->cmdidx == CMD_saveas)
3346 {
3347 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003348 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003349 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003350 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003351 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003352 }
3353
3354 /* Change directories when the 'acd' option is set and the file name
3355 * got changed or set. */
3356 if (eap->cmdidx == CMD_saveas || name_was_missing)
3357 {
Bram Moolenaar6f470022018-04-10 18:47:20 +02003358 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 }
3361
3362theend:
3363#ifdef FEAT_BROWSE
3364 vim_free(browse_file);
3365#endif
3366 vim_free(free_fname);
3367 return retval;
3368}
3369
3370/*
3371 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3372 * BF_NEW or BF_READERR, check for overwriting current file.
3373 * May set eap->forceit if a dialog says it's OK to overwrite.
3374 * Return OK if it's OK, FAIL if it is not.
3375 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003376 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003377check_overwrite(
3378 exarg_T *eap,
3379 buf_T *buf,
3380 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003382 char_u *ffname, /* full path version of fname */
3383 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384{
3385 /*
3386 * write to other file or b_flags set or not writing the whole file:
3387 * overwriting only allowed with '!'
3388 */
3389 if ( (other
3390 || (buf->b_flags & BF_NOTEDITED)
3391 || ((buf->b_flags & BF_NEW)
3392 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3393 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003395#ifdef FEAT_QUICKFIX
3396 && !bt_nofile(buf)
3397#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 && vim_fexists(ffname))
3399 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003400 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003402#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003403 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003404 if (mch_isdir(ffname))
3405 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003406 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003407 return FAIL;
3408 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409#endif
3410#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003411 if (p_confirm || cmdmod.confirm)
3412 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003413 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003415 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3416 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3417 return FAIL;
3418 eap->forceit = TRUE;
3419 }
3420 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003422 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003423 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003424 return FAIL;
3425 }
3426 }
3427
3428 /* For ":w! filename" check that no swap file exists for "filename". */
3429 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003431 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003432 char_u *p;
3433 int r;
3434 char_u *swapname;
3435
3436 /* We only try the first entry in 'directory', without checking if
3437 * it's writable. If the "." directory is not writable the write
3438 * will probably fail anyway.
3439 * Use 'shortname' of the current buffer, since there is no buffer
3440 * for the written file. */
3441 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003442 {
3443 dir = alloc(5);
3444 if (dir == NULL)
3445 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003446 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003447 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003448 else
3449 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003450 dir = alloc(MAXPATHL);
3451 if (dir == NULL)
3452 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003453 p = p_dir;
3454 copy_option_part(&p, dir, MAXPATHL, ",");
3455 }
3456 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003457 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003458 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003459 if (r)
3460 {
3461#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3462 if (p_confirm || cmdmod.confirm)
3463 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003464 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003465
3466 dialog_msg(buff,
3467 _("Swap file \"%s\" exists, overwrite anyway?"),
3468 swapname);
3469 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3470 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003471 {
3472 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003473 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003474 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003475 eap->forceit = TRUE;
3476 }
3477 else
3478#endif
3479 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003480 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003481 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003482 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003483 return FAIL;
3484 }
3485 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003486 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 }
3488 }
3489 return OK;
3490}
3491
3492/*
3493 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3494 */
3495 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003496ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497{
3498 int i;
3499
3500 if (eap->cmd[1] == 'n')
3501 i = curwin->w_arg_idx + (int)eap->line2;
3502 else
3503 i = curwin->w_arg_idx - (int)eap->line2;
3504 eap->line1 = 1;
3505 eap->line2 = curbuf->b_ml.ml_line_count;
3506 if (do_write(eap) != FAIL)
3507 do_argfile(eap, i);
3508}
3509
3510/*
3511 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3512 */
3513 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003514do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515{
3516 buf_T *buf;
3517 int error = 0;
3518 int save_forceit = eap->forceit;
3519
3520 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3521 exiting = TRUE;
3522
Bram Moolenaar29323592016-07-24 22:04:11 +02003523 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003525#ifdef FEAT_TERMINAL
3526 if (exiting && term_job_running(buf->b_term))
3527 {
3528 no_write_message_nobang(buf);
3529 ++error;
3530 }
3531 else
3532#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003533 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {
3535 /*
3536 * Check if there is a reason the buffer cannot be written:
3537 * 1. if the 'write' option is set
3538 * 2. if there is no file name (even after browsing)
3539 * 3. if the 'readonly' is set (even after a dialog)
3540 * 4. if overwriting is allowed (even after a dialog)
3541 */
3542 if (not_writing())
3543 {
3544 ++error;
3545 break;
3546 }
3547#ifdef FEAT_BROWSE
3548 /* ":browse wall": ask for file name if there isn't one */
3549 if (buf->b_ffname == NULL && cmdmod.browse)
3550 browse_save_fname(buf);
3551#endif
3552 if (buf->b_ffname == NULL)
3553 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003554 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 ++error;
3556 }
3557 else if (check_readonly(&eap->forceit, buf)
3558 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3559 FALSE) == FAIL)
3560 {
3561 ++error;
3562 }
3563 else
3564 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003565 bufref_T bufref;
3566
3567 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 if (buf_write_all(buf, eap->forceit) == FAIL)
3569 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003571 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 }
3574 eap->forceit = save_forceit; /* check_overwrite() may set it */
3575 }
3576 }
3577 if (exiting)
3578 {
3579 if (!error)
3580 getout(0); /* exit Vim */
3581 not_exiting();
3582 }
3583}
3584
3585/*
3586 * Check the 'write' option.
3587 * Return TRUE and give a message when it's not st.
3588 */
3589 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003590not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591{
3592 if (p_write)
3593 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003594 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 return TRUE;
3596}
3597
3598/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003599 * Check if a buffer is read-only (either 'readonly' option is set or file is
3600 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3601 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 */
3603 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003604check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003606 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003607
3608 /* Handle a file being readonly when the 'readonly' option is set or when
3609 * the file exists and permissions are read-only.
3610 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3611 * important for device checks but not here. */
3612 if (!*forceit && (buf->b_p_ro
3613 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3614 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 {
3616#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3617 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3618 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003619 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620
Bram Moolenaar5386a122007-06-28 20:02:32 +00003621 if (buf->b_p_ro)
3622 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3623 buf->b_fname);
3624 else
3625 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 +00003626 buf->b_fname);
3627
3628 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3629 {
3630 /* Set forceit, to force the writing of a readonly file */
3631 *forceit = TRUE;
3632 return FALSE;
3633 }
3634 else
3635 return TRUE;
3636 }
3637 else
3638#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003639 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003640 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003641 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003642 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00003643 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 return TRUE;
3645 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003646
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 return FALSE;
3648}
3649
3650/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003651 * Try to abandon the current file and edit a new or existing file.
3652 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003653 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003655 * Return:
3656 * GETFILE_ERROR for "normal" error,
3657 * GETFILE_NOT_WRITTEN for "not written" error,
3658 * GETFILE_SAME_FILE for success
3659 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 */
3661 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003662getfile(
3663 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003664 char_u *ffname_arg,
3665 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003666 int setpm,
3667 linenr_T lnum,
3668 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003670 char_u *ffname = ffname_arg;
3671 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 int other;
3673 int retval;
3674 char_u *free_me = NULL;
3675
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003676 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003677 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003678 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003679 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680
3681 if (fnum == 0)
3682 {
3683 /* make ffname full path, set sfname */
3684 fname_expand(curbuf, &ffname, &sfname);
3685 other = otherfile(ffname);
3686 free_me = ffname; /* has been allocated, free() later */
3687 }
3688 else
3689 other = (fnum != curbuf->b_fnum);
3690
3691 if (other)
3692 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003693 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3695 {
3696#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3697 if (p_confirm && p_write)
3698 dialog_changed(curbuf, FALSE);
3699 if (curbufIsChanged())
3700#endif
3701 {
3702 if (other)
3703 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003704 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003705 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 goto theend;
3707 }
3708 }
3709 if (other)
3710 --no_wait_return;
3711 if (setpm)
3712 setpcmark();
3713 if (!other)
3714 {
3715 if (lnum != 0)
3716 curwin->w_cursor.lnum = lnum;
3717 check_cursor_lnum();
3718 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003719 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 }
3721 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003722 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003723 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003724 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003726 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727
3728theend:
3729 vim_free(free_me);
3730 return retval;
3731}
3732
3733/*
3734 * start editing a new file
3735 *
3736 * fnum: file number; if zero use ffname/sfname
3737 * ffname: the file name
3738 * - full path if sfname used,
3739 * - any file name if sfname is NULL
3740 * - empty string to re-edit with the same file name (but may be
3741 * in a different directory)
3742 * - NULL to start an empty buffer
3743 * sfname: the short file name (or NULL)
3744 * eap: contains the command to be executed after loading the file and
3745 * forced 'ff' and 'fenc'
3746 * newlnum: if > 0: put cursor on this line number (if possible)
3747 * if ECMD_LASTL: use last position in loaded file
3748 * if ECMD_LAST: use last position in all files
3749 * if ECMD_ONE: use first line
3750 * flags:
3751 * ECMD_HIDE: if TRUE don't free the current buffer
3752 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3753 * ECMD_OLDBUF: use existing buffer if it exists
3754 * ECMD_FORCEIT: ! used for Ex command
3755 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003756 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003757 * window, NULL when splitting the window first. When not NULL info
3758 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 *
3760 * return FAIL for failure, OK otherwise
3761 */
3762 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003763do_ecmd(
3764 int fnum,
3765 char_u *ffname,
3766 char_u *sfname,
3767 exarg_T *eap, /* can be NULL! */
3768 linenr_T newlnum,
3769 int flags,
3770 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771{
3772 int other_file; /* TRUE if editing another file */
3773 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 int auto_buf = FALSE; /* TRUE if autocommands brought us
3775 into the buffer unexpectedly */
3776 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003777#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003778 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779#endif
3780 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003781 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003782 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 char_u *free_fname = NULL;
3784#ifdef FEAT_BROWSE
3785 char_u *browse_file = NULL;
3786#endif
3787 int retval = FAIL;
3788 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003789 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 linenr_T topline = 0;
3791 int newcol = -1;
3792 int solcol = -1;
3793 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003795#ifdef FEAT_SPELL
3796 int did_get_winopts = FALSE;
3797#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003798 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003799 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003800 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801
3802 if (eap != NULL)
3803 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003804 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805
3806 if (fnum != 0)
3807 {
3808 if (fnum == curbuf->b_fnum) /* file is already being edited */
3809 return OK; /* nothing to do */
3810 other_file = TRUE;
3811 }
3812 else
3813 {
3814#ifdef FEAT_BROWSE
3815 if (cmdmod.browse)
3816 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003817 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003818# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003819 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003820# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003821 au_has_group((char_u *)"FileExplorer"))
3822 {
3823 /* No browsing supported but we do have the file explorer:
3824 * Edit the directory. */
3825 if (ffname == NULL || !mch_isdir(ffname))
3826 ffname = (char_u *)".";
3827 }
3828 else
3829 {
3830 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003832 if (browse_file == NULL)
3833 goto theend;
3834 ffname = browse_file;
3835 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 }
3837#endif
3838 /* if no short name given, use ffname for short name */
3839 if (sfname == NULL)
3840 sfname = ffname;
3841#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01003842 if (sfname != NULL)
3843 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844#endif
3845
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3847 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848
3849 if (ffname == NULL)
3850 other_file = TRUE;
3851 /* there is no file name */
3852 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3853 other_file = FALSE;
3854 else
3855 {
3856 if (*ffname == NUL) /* re-edit with same file name */
3857 {
3858 ffname = curbuf->b_ffname;
3859 sfname = curbuf->b_fname;
3860 }
3861 free_fname = fix_fname(ffname); /* may expand to full path name */
3862 if (free_fname != NULL)
3863 ffname = free_fname;
3864 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 }
3866 }
3867
3868 /*
3869 * if the file was changed we may not be allowed to abandon it
3870 * - if we are going to re-edit the same file
3871 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3872 */
3873 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3874 || (curbuf->b_nwindows == 1
3875 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003876 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3877 | (other_file ? 0 : CCGD_MULTWIN)
3878 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3879 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 {
3881 if (fnum == 0 && other_file && ffname != NULL)
3882 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3883 goto theend;
3884 }
3885
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 /*
3887 * End Visual mode before switching to another buffer, so the text can be
3888 * copied into the GUI selection buffer.
3889 */
3890 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003892#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003893 if ((command != NULL || newlnum > (linenr_T)0)
3894 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3895 {
3896 int len;
3897 char_u *p;
3898
3899 /* Set v:swapcommand for the SwapExists autocommands. */
3900 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003901 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003902 else
3903 len = 30;
3904 p = alloc((unsigned)len);
3905 if (p != NULL)
3906 {
3907 if (command != NULL)
3908 vim_snprintf((char *)p, len, ":%s\r", command);
3909 else
3910 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3911 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3912 did_set_swapcommand = TRUE;
3913 vim_free(p);
3914 }
3915 }
3916#endif
3917
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 /*
3919 * If we are starting to edit another file, open a (new) buffer.
3920 * Otherwise we re-use the current buffer.
3921 */
3922 if (other_file)
3923 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003926 if (!cmdmod.keepalt)
3927 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003928 if (oldwin != NULL)
3929 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 }
3931
3932 if (fnum)
3933 buf = buflist_findnr(fnum);
3934 else
3935 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 if (flags & ECMD_ADDBUF)
3937 {
3938 linenr_T tlnum = 1L;
3939
3940 if (command != NULL)
3941 {
3942 tlnum = atol((char *)command);
3943 if (tlnum <= 0)
3944 tlnum = 1L;
3945 }
3946 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3947 goto theend;
3948 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 buf = buflist_new(ffname, sfname, 0L,
3950 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003951
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003952 /* autocommands may change curwin and curbuf */
3953 if (oldwin != NULL)
3954 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003955 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 }
3957 if (buf == NULL)
3958 goto theend;
3959 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3960 {
3961 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 }
3963 else /* existing memfile */
3964 {
3965 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003966 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003968 /* Check if autocommands made the buffer invalid or changed the
3969 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003970 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 goto theend;
3972#ifdef FEAT_EVAL
3973 if (aborting()) /* autocmds may abort script processing */
3974 goto theend;
3975#endif
3976 }
3977
3978 /* May jump to last used line number for a loaded buffer or when asked
3979 * for explicitly */
3980 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3981 {
3982 pos = buflist_findfpos(buf);
3983 newlnum = pos->lnum;
3984 solcol = pos->col;
3985 }
3986
3987 /*
3988 * Make the (new) buffer the one used by the current window.
3989 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3990 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003991 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 */
3993 if (buf != curbuf)
3994 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 /*
3996 * Be careful: The autocommands may delete any buffer and change
3997 * the current buffer.
3998 * - If the buffer we are going to edit is deleted, give up.
3999 * - If the current buffer is deleted, prefer to load the new
4000 * buffer when loading a buffer is required. This avoids
4001 * loading another buffer which then must be closed again.
4002 * - If we ended up in the new buffer already, need to skip a few
4003 * things, set auto_buf.
4004 */
4005 if (buf->b_fname != NULL)
4006 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004007 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004009 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004011 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 delbuf_msg(new_name); /* frees new_name */
4013 goto theend;
4014 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004015#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 if (aborting()) /* autocmds may abort script processing */
4017 {
4018 vim_free(new_name);
4019 goto theend;
4020 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004021#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 if (buf == curbuf) /* already in new buffer */
4023 auto_buf = TRUE;
4024 else
4025 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02004026 win_T *the_curwin = curwin;
4027
4028 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004029 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02004030 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004031 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02004032
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004033 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 buf_copy_options(buf, BCO_ENTER);
4035
Bram Moolenaar5a497892016-09-03 16:29:04 +02004036 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02004037 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004038 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00004039 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01004040 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041
Bram Moolenaar5a497892016-09-03 16:29:04 +02004042 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004043 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01004044
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004045#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02004046 /* autocmds may abort script processing */
4047 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 {
4049 vim_free(new_name);
4050 goto theend;
4051 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004054 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004056 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 delbuf_msg(new_name); /* frees new_name */
4058 goto theend;
4059 }
4060 if (buf == curbuf) /* already in new buffer */
4061 auto_buf = TRUE;
4062 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02004064#ifdef FEAT_SYN_HL
4065 /*
4066 * <VN> We could instead free the synblock
4067 * and re-attach to buffer, perhaps.
4068 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02004069 if (curwin->w_buffer == NULL
4070 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02004071 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02004072#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 curwin->w_buffer = buf;
4074 curbuf = buf;
4075 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02004076
4077 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
4078 if (!oldbuf && eap != NULL)
4079 {
4080 set_file_options(TRUE, eap);
4081 set_forced_fenc(eap);
4082 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 }
4084
4085 /* May get the window options from the last time this buffer
4086 * was in this window (or another window). If not used
4087 * before, reset the local window options to the global
4088 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004089 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004090#ifdef FEAT_SPELL
4091 did_get_winopts = TRUE;
4092#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 }
4094 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004095 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004096 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098
4099 curwin->w_pcmark.lnum = 1;
4100 curwin->w_pcmark.col = 0;
4101 }
4102 else /* !other_file */
4103 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02004104 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004106
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 oldbuf = (flags & ECMD_OLDBUF);
4108 }
4109
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004110 /* Don't redraw until the cursor is in the right line, otherwise
4111 * autocommands may cause ml_get errors. */
4112 ++RedrawingDisabled;
4113 did_inc_redrawing_disabled = TRUE;
4114
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004115 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4117 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004118 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 }
4120 else
4121 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 /* Don't make a buffer listed if it's a help buffer. Useful when
4123 * using CTRL-O to go back to a help file. */
4124 if (!curbuf->b_help)
4125 set_buflisted(TRUE);
4126 }
4127
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 /* If autocommands change buffers under our fingers, forget about
4129 * editing the file. */
4130 if (buf != curbuf)
4131 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004132#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 if (aborting()) /* autocmds may abort script processing */
4134 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004135#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
4137 /* Since we are starting to edit a file, consider the filetype to be
4138 * unset. Helps for when an autocommand changes files and expects syntax
4139 * highlighting to work in the other file. */
4140 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141
4142/*
4143 * other_file oldbuf
4144 * FALSE FALSE re-edit same file, buffer is re-used
4145 * FALSE TRUE re-edit same file, nothing changes
4146 * TRUE FALSE start editing new file, new buffer
4147 * TRUE TRUE start editing in existing buffer (nothing to do)
4148 */
4149 if (!other_file && !oldbuf) /* re-use the buffer */
4150 {
4151 set_last_cursor(curwin); /* may set b_last_cursor */
4152 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4153 {
4154 newlnum = curwin->w_cursor.lnum;
4155 solcol = curwin->w_cursor.col;
4156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 buf = curbuf;
4158 if (buf->b_fname != NULL)
4159 new_name = vim_strsave(buf->b_fname);
4160 else
4161 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004162 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004163
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004164 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4165 {
4166 /* Save all the text, so that the reload can be undone.
4167 * Sync first so that this is a separate undo-able action. */
4168 u_sync(FALSE);
4169 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4170 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004171 {
4172 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004173 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004174 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004175 u_unchanged(curbuf);
4176 buf_freeall(curbuf, BFA_KEEP_UNDO);
4177
4178 /* tell readfile() not to clear or reload undo info */
4179 readfile_flags = READ_KEEP_UNDO;
4180 }
4181 else
4182 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004183
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 /* If autocommands deleted the buffer we were going to re-edit, give
4185 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004186 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 {
4188 delbuf_msg(new_name); /* frees new_name */
4189 goto theend;
4190 }
4191 vim_free(new_name);
4192
4193 /* If autocommands change buffers under our fingers, forget about
4194 * re-editing the file. Should do the buf_clear_file(), but perhaps
4195 * the autocommands changed the buffer... */
4196 if (buf != curbuf)
4197 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004198#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 if (aborting()) /* autocmds may abort script processing */
4200 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201#endif
4202 buf_clear_file(curbuf);
4203 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4204 curbuf->b_op_end.lnum = 0;
4205 }
4206
4207/*
4208 * If we get here we are sure to start editing
4209 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 /* Assume success now */
4211 retval = OK;
4212
4213 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 * Check if we are editing the w_arg_idx file in the argument list.
4215 */
4216 check_arg_idx(curwin);
4217
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 {
4220 /*
4221 * Set cursor and init window before reading the file and executing
4222 * autocommands. This allows for the autocommands to position the
4223 * cursor.
4224 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004225 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226
4227#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004228 /* It's possible that all lines in the buffer changed. Need to update
4229 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004230 {
4231 win_T *win;
4232 tabpage_T *tp;
4233
4234 FOR_ALL_TAB_WINDOWS(tp, win)
4235 if (win->w_buffer == curbuf)
4236 foldUpdateAll(win);
4237 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238#endif
4239
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004240 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02004241 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004242
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 /*
4244 * Careful: open_buffer() and apply_autocmds() may change the current
4245 * buffer and window.
4246 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004247 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 topline = curwin->w_topline;
4249 if (!oldbuf) /* need to read the file */
4250 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004251#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 swap_exists_action = SEA_DIALOG;
4253#endif
4254 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4255
4256 /*
4257 * Open the buffer and read the file.
4258 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004259#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004260 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 retval = FAIL;
4262#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004263 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264#endif
4265
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004266#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 if (swap_exists_action == SEA_QUIT)
4268 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004269 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270#endif
4271 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 else
4273 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004274 /* Read the modelines, but only to set window-local options. Any
4275 * buffer-local options have already been set and may have been
4276 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004277 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4280 &retval);
4281 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4282 &retval);
4283 }
4284 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285
Bram Moolenaareab316b2015-03-24 11:46:30 +01004286 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004287 * keep it. Also when it moves within a line. But not when it moves
4288 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004289 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004291 char_u *text = ml_get_curline();
4292
4293 if (curwin->w_cursor.lnum != orig_pos.lnum
4294 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
4295 {
4296 newlnum = curwin->w_cursor.lnum;
4297 newcol = curwin->w_cursor.col;
4298 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 }
4300 if (curwin->w_topline == topline)
4301 topline = 0;
4302
4303 /* Even when cursor didn't move we need to recompute topline. */
4304 changed_line_abv_curs();
4305
4306#ifdef FEAT_TITLE
4307 maketitle();
4308#endif
4309 }
4310
4311#ifdef FEAT_DIFF
4312 /* Tell the diff stuff that this buffer is new and/or needs updating.
4313 * Also needed when re-editing the same buffer, because unloading will
4314 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004315 if (curwin->w_p_diff)
4316 {
4317 diff_buf_add(curbuf);
4318 diff_invalidate(curbuf);
4319 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320#endif
4321
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004322#ifdef FEAT_SPELL
4323 /* If the window options were changed may need to set the spell language.
4324 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004325 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4326 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004327#endif
4328
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 if (command == NULL)
4330 {
4331 if (newcol >= 0) /* position set by autocommands */
4332 {
4333 curwin->w_cursor.lnum = newlnum;
4334 curwin->w_cursor.col = newcol;
4335 check_cursor();
4336 }
4337 else if (newlnum > 0) /* line number from caller or old position */
4338 {
4339 curwin->w_cursor.lnum = newlnum;
4340 check_cursor_lnum();
4341 if (solcol >= 0 && !p_sol)
4342 {
4343 /* 'sol' is off: Use last known column. */
4344 curwin->w_cursor.col = solcol;
4345 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 curwin->w_set_curswant = TRUE;
4348 }
4349 else
4350 beginline(BL_SOL | BL_FIX);
4351 }
4352 else /* no line number, go to last line in Ex mode */
4353 {
4354 if (exmode_active)
4355 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4356 beginline(BL_WHITE | BL_FIX);
4357 }
4358 }
4359
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 /* Check if cursors in other windows on the same buffer are still valid */
4361 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362
4363 /*
4364 * Did not read the file, need to show some info about the file.
4365 * Do this after setting the cursor.
4366 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004367 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 {
4369 int msg_scroll_save = msg_scroll;
4370
4371 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4372 * message. */
4373 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4374 msg_scroll = FALSE;
4375 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4376 check_for_delay(FALSE);
4377 msg_start();
4378 msg_scroll = msg_scroll_save;
4379 msg_scrolled_ign = TRUE;
4380
Bram Moolenaar426dd022016-03-15 15:09:29 +01004381 if (!shortmess(SHM_FILEINFO))
4382 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383
4384 msg_scrolled_ign = FALSE;
4385 }
4386
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004387#ifdef FEAT_VIMINFO
4388 curbuf->b_last_used = vim_time();
4389#endif
4390
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 if (command != NULL)
4392 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4393
4394#ifdef FEAT_KEYMAP
4395 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004396 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397#endif
4398
4399 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004400 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 if (!skip_redraw)
4402 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01004403 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01004405 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01004408 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4410 }
4411
4412 if (p_im)
4413 need_start_insertmode = TRUE;
4414
Bram Moolenaar15833232018-02-03 18:33:17 +01004415#ifdef FEAT_AUTOCHDIR
4416 /* Change directories when the 'acd' option is set and we aren't already in
4417 * that directory (should already be done above). Expect getcwd() to be
4418 * faster than calling shorten_fnames() unnecessarily. */
4419 if (p_acd && curbuf->b_ffname != NULL)
4420 {
4421 char_u curdir[MAXPATHL];
4422 char_u filedir[MAXPATHL];
4423
4424 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4425 *gettail_sep(filedir) = NUL;
4426 if (mch_dirname(curdir, MAXPATHL) != FAIL
4427 && vim_fnamecmp(curdir, filedir) != 0)
4428 do_autochdir();
4429 }
4430#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01004432#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004433 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004436 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004437 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438# endif
4439 }
4440#endif
4441
4442theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004443 if (did_inc_redrawing_disabled)
4444 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004445#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004446 if (did_set_swapcommand)
4447 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4448#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449#ifdef FEAT_BROWSE
4450 vim_free(browse_file);
4451#endif
4452 vim_free(free_fname);
4453 return retval;
4454}
4455
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004457delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004459 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 name == NULL ? (char_u *)"" : name);
4461 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004462 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004463 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004466static int append_indent = 0; /* autoindent for first line */
4467
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468/*
4469 * ":insert" and ":append", also used by ":change"
4470 */
4471 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004472ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473{
4474 char_u *theline;
4475 int did_undo = FALSE;
4476 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004477 int indent = 0;
4478 char_u *p;
4479 int vcol;
4480 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004482 /* the ! flag toggles autoindent */
4483 if (eap->forceit)
4484 curbuf->b_p_ai = !curbuf->b_p_ai;
4485
4486 /* First autoindent comes from the line we start on */
4487 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4488 append_indent = get_indent_lnum(lnum);
4489
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 if (eap->cmdidx != CMD_append)
4491 --lnum;
4492
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004493 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004494 if (empty && lnum == 1)
4495 lnum = 0;
4496
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 State = INSERT; /* behave like in Insert mode */
4498 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4499 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004500
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004501 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 {
4503 msg_scroll = TRUE;
4504 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004505 if (curbuf->b_p_ai)
4506 {
4507 if (append_indent >= 0)
4508 {
4509 indent = append_indent;
4510 append_indent = -1;
4511 }
4512 else if (lnum > 0)
4513 indent = get_indent_lnum(lnum);
4514 }
4515 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004517 {
4518 /* No getline() function, use the lines that follow. This ends
4519 * when there is no more. */
4520 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4521 break;
4522 p = vim_strchr(eap->nextcmd, NL);
4523 if (p == NULL)
4524 p = eap->nextcmd + STRLEN(eap->nextcmd);
4525 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4526 if (*p != NUL)
4527 ++p;
4528 eap->nextcmd = p;
4529 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004531 {
4532 int save_State = State;
4533
4534 /* Set State to avoid the cursor shape to be set to INSERT mode
4535 * when getline() returns. */
4536 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 theline = eap->getline(
4538#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004539 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004541 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004542 State = save_State;
4543 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004545 if (theline == NULL)
4546 break;
4547
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004548 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4549 if (ex_keep_indent)
4550 append_indent = indent;
4551
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004552 /* Look for the "." after automatic indent. */
4553 vcol = 0;
4554 for (p = theline; indent > vcol; ++p)
4555 {
4556 if (*p == ' ')
4557 ++vcol;
4558 else if (*p == TAB)
4559 vcol += 8 - vcol % 8;
4560 else
4561 break;
4562 }
4563 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004564 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4565 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 {
4567 vim_free(theline);
4568 break;
4569 }
4570
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004571 /* don't use autoindent if nothing was typed. */
4572 if (p[0] == NUL)
4573 theline[0] = NUL;
4574
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 did_undo = TRUE;
4576 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004577 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578
4579 vim_free(theline);
4580 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004581
4582 if (empty)
4583 {
4584 ml_delete(2L, FALSE);
4585 empty = FALSE;
4586 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 }
4588 State = NORMAL;
4589
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004590 if (eap->forceit)
4591 curbuf->b_p_ai = !curbuf->b_p_ai;
4592
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004594 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 * "end" is set to lnum when something has been appended, otherwise
4596 * it is the same than "start" -- Acevedo */
4597 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4598 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4599 if (eap->cmdidx != CMD_append)
4600 --curbuf->b_op_start.lnum;
4601 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4602 ? lnum : curbuf->b_op_start.lnum;
4603 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4604 curwin->w_cursor.lnum = lnum;
4605 check_cursor_lnum();
4606 beginline(BL_SOL | BL_FIX);
4607
4608 need_wait_return = FALSE; /* don't use wait_return() now */
4609 ex_no_reprint = TRUE;
4610}
4611
4612/*
4613 * ":change"
4614 */
4615 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004616ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617{
4618 linenr_T lnum;
4619
4620 if (eap->line2 >= eap->line1
4621 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4622 return;
4623
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004624 /* the ! flag toggles autoindent */
4625 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4626 append_indent = get_indent_lnum(eap->line1);
4627
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4629 {
4630 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4631 break;
4632 ml_delete(eap->line1, FALSE);
4633 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004634
4635 /* make sure the cursor is not beyond the end of the file now */
4636 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4638
4639 /* ":append" on the line above the deleted lines. */
4640 eap->line2 = eap->line1;
4641 ex_append(eap);
4642}
4643
4644 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004645ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646{
4647 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004648 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004649 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 int minus = 0;
4651 linenr_T start, end, curs, i;
4652 int j;
4653 linenr_T lnum = eap->line2;
4654
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004655 /* Vi compatible: ":z!" uses display height, without a count uses
4656 * 'scroll' */
4657 if (eap->forceit)
4658 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004659 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004660 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004661 else
4662 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 if (bigness < 1)
4664 bigness = 1;
4665
4666 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004667 kind = x;
4668 if (*kind == '-' || *kind == '+' || *kind == '='
4669 || *kind == '^' || *kind == '.')
4670 ++x;
4671 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 ++x;
4673
4674 if (*x != 0)
4675 {
4676 if (!VIM_ISDIGIT(*x))
4677 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004678 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 return;
4680 }
4681 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004682 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004683 bigness = atol((char *)x);
4684
4685 /* bigness could be < 0 if atol(x) overflows. */
4686 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4687 bigness = 2 * curbuf->b_ml.ml_line_count;
4688
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004689 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004690 if (*kind == '=')
4691 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004692 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 }
4694
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004695 /* the number of '-' and '+' multiplies the distance */
4696 if (*kind == '-' || *kind == '+')
4697 for (x = kind + 1; *x == *kind; ++x)
4698 ;
4699
4700 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 {
4702 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004703 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4704 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004705 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 break;
4707
4708 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004709 start = lnum - (bigness + 1) / 2 + 1;
4710 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 curs = lnum;
4712 minus = 1;
4713 break;
4714
4715 case '^':
4716 start = lnum - bigness * 2;
4717 end = lnum - bigness;
4718 curs = lnum - bigness;
4719 break;
4720
4721 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004722 start = lnum - (bigness + 1) / 2 + 1;
4723 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 curs = end;
4725 break;
4726
4727 default: /* '+' */
4728 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004729 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004730 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004731 else if (eap->addr_count == 0)
4732 ++start;
4733 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 curs = end;
4735 break;
4736 }
4737
4738 if (start < 1)
4739 start = 1;
4740
4741 if (end > curbuf->b_ml.ml_line_count)
4742 end = curbuf->b_ml.ml_line_count;
4743
4744 if (curs > curbuf->b_ml.ml_line_count)
4745 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004746 else if (curs < 1)
4747 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748
4749 for (i = start; i <= end; i++)
4750 {
4751 if (minus && i == lnum)
4752 {
4753 msg_putchar('\n');
4754
4755 for (j = 1; j < Columns; j++)
4756 msg_putchar('-');
4757 }
4758
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004759 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760
4761 if (minus && i == lnum)
4762 {
4763 msg_putchar('\n');
4764
4765 for (j = 1; j < Columns; j++)
4766 msg_putchar('-');
4767 }
4768 }
4769
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004770 if (curwin->w_cursor.lnum != curs)
4771 {
4772 curwin->w_cursor.lnum = curs;
4773 curwin->w_cursor.col = 0;
4774 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 ex_no_reprint = TRUE;
4776}
4777
4778/*
4779 * Check if the restricted flag is set.
4780 * If so, give an error message and return TRUE.
4781 * Otherwise, return FALSE.
4782 */
4783 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004784check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785{
4786 if (restricted)
4787 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01004788 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 return TRUE;
4790 }
4791 return FALSE;
4792}
4793
4794/*
4795 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4796 * If so, give an error message and return TRUE.
4797 * Otherwise, return FALSE.
4798 */
4799 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004800check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801{
4802 if (secure)
4803 {
4804 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004805 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 return TRUE;
4807 }
4808#ifdef HAVE_SANDBOX
4809 /*
4810 * In the sandbox more things are not allowed, including the things
4811 * disallowed in secure mode.
4812 */
4813 if (sandbox != 0)
4814 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004815 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 return TRUE;
4817 }
4818#endif
4819 return FALSE;
4820}
4821
4822static char_u *old_sub = NULL; /* previous substitute pattern */
4823static int global_need_beginline; /* call beginline() after ":g" */
4824
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004825/*
4826 * Flags that are kept between calls to :substitute.
4827 */
4828typedef struct {
4829 int do_all; /* do multiple substitutions per line */
4830 int do_ask; /* ask for confirmation */
4831 int do_count; /* count only */
4832 int do_error; /* if false, ignore errors */
4833 int do_print; /* print last line with subs. */
4834 int do_list; /* list last line with subs. */
4835 int do_number; /* list last line with line nr*/
4836 int do_ic; /* ignore case flag */
4837} subflags_T;
4838
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839/* do_sub()
4840 *
4841 * Perform a substitution from line eap->line1 to line eap->line2 using the
4842 * command pointed to by eap->arg which should be of the form:
4843 *
4844 * /pattern/substitution/{flags}
4845 *
4846 * The usual escapes are supported as described in the regexp docs.
4847 */
4848 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004849do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850{
4851 linenr_T lnum;
4852 long i = 0;
4853 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004854 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4855 FALSE, FALSE, 0};
4856#ifdef FEAT_EVAL
4857 subflags_T subflags_save;
4858#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004859 int save_do_all; /* remember user specified 'g' flag */
4860 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4862 int delimiter;
4863 int sublen;
4864 int got_quit = FALSE;
4865 int got_match = FALSE;
4866 int temp;
4867 int which_pat;
4868 char_u *cmd;
4869 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004870 linenr_T first_line = 0; /* first changed line */
4871 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 * change */
4873 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4874 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004875 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004876 char_u *sub_firstline; /* allocated copy of first sub line */
4877 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004878 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004879 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004880#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004881 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004882#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883
4884 cmd = eap->arg;
4885 if (!global_busy)
4886 {
4887 sub_nsubs = 0;
4888 sub_nlines = 0;
4889 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004890 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 if (eap->cmdidx == CMD_tilde)
4893 which_pat = RE_LAST; /* use last used regexp */
4894 else
4895 which_pat = RE_SUBST; /* use last substitute regexp */
4896
4897 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004898 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4900 {
4901 /* don't accept alphanumeric for separator */
4902 if (isalpha(*cmd))
4903 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004904 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 return;
4906 }
4907 /*
4908 * undocumented vi feature:
4909 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4910 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4911 */
4912 if (*cmd == '\\')
4913 {
4914 ++cmd;
4915 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4916 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004917 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 return;
4919 }
4920 if (*cmd != '&')
4921 which_pat = RE_SEARCH; /* use last '/' pattern */
4922 pat = (char_u *)""; /* empty search pattern */
4923 delimiter = *cmd++; /* remember delimiter character */
4924 }
4925 else /* find the end of the regexp */
4926 {
4927 which_pat = RE_LAST; /* use last used regexp */
4928 delimiter = *cmd++; /* remember delimiter character */
4929 pat = cmd; /* remember start of search pat */
4930 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4931 if (cmd[0] == delimiter) /* end delimiter found */
4932 *cmd++ = NUL; /* replace it with a NUL */
4933 }
4934
4935 /*
4936 * Small incompatibility: vi sees '\n' as end of the command, but in
4937 * Vim we want to use '\n' to find/substitute a NUL.
4938 */
4939 sub = cmd; /* remember the start of the substitution */
4940
4941 while (cmd[0])
4942 {
4943 if (cmd[0] == delimiter) /* end delimiter found */
4944 {
4945 *cmd++ = NUL; /* replace it with a NUL */
4946 break;
4947 }
4948 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4949 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004950 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 }
4952
4953 if (!eap->skip)
4954 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004955 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4956 if (STRCMP(sub, "%") == 0
4957 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4958 {
4959 if (old_sub == NULL) /* there is no previous command */
4960 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004961 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004962 return;
4963 }
4964 sub = old_sub;
4965 }
4966 else
4967 {
4968 vim_free(old_sub);
4969 old_sub = vim_strsave(sub);
4970 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 }
4972 }
4973 else if (!eap->skip) /* use previous pattern and substitution */
4974 {
4975 if (old_sub == NULL) /* there is no previous command */
4976 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004977 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 return;
4979 }
4980 pat = NULL; /* search_regcomp() will use previous pattern */
4981 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004982
4983 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4984 * last column after using "$". */
4985 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 }
4987
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004988 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4989 * more efficient.
4990 * TODO: find a generic solution to make line-joining operations more
4991 * efficient, avoid allocating a string that grows in size.
4992 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004993 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004994 && *sub == NUL
4995 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4996 || *cmd == 'p' || *cmd == '#'))))
4997 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004998 linenr_T joined_lines_count;
4999
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005000 curwin->w_cursor.lnum = eap->line1;
5001 if (*cmd == 'l')
5002 eap->flags = EXFLAG_LIST;
5003 else if (*cmd == '#')
5004 eap->flags = EXFLAG_NR;
5005 else if (*cmd == 'p')
5006 eap->flags = EXFLAG_PRINT;
5007
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005008 /* The number of lines joined is the number of lines in the range plus
5009 * one. One less when the last line is included. */
5010 joined_lines_count = eap->line2 - eap->line1 + 1;
5011 if (eap->line2 < curbuf->b_ml.ml_line_count)
5012 ++joined_lines_count;
5013 if (joined_lines_count > 1)
5014 {
5015 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
5016 sub_nsubs = joined_lines_count - 1;
5017 sub_nlines = 1;
5018 (void)do_sub_msg(FALSE);
5019 ex_may_print(eap);
5020 }
5021
5022 if (!cmdmod.keeppatterns)
5023 save_re_pat(RE_SUBST, pat, p_magic);
5024#ifdef FEAT_CMDHIST
5025 /* put pattern in history */
5026 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
5027#endif
5028
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005029 return;
5030 }
5031
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 /*
5033 * Find trailing options. When '&' is used, keep old options.
5034 */
5035 if (*cmd == '&')
5036 ++cmd;
5037 else
5038 {
5039 if (!p_ed)
5040 {
5041 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005042 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005044 subflags.do_all = FALSE;
5045 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005047 subflags.do_error = TRUE;
5048 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01005049 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005050 subflags.do_count = FALSE;
5051 subflags.do_number = FALSE;
5052 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 }
5054 while (*cmd)
5055 {
5056 /*
5057 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
5058 * 'r' is never inverted.
5059 */
5060 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005061 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005063 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005064 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005065 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005067 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 else if (*cmd == 'r') /* use last used regexp */
5069 which_pat = RE_LAST;
5070 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005071 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005072 else if (*cmd == '#')
5073 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005074 subflags.do_print = TRUE;
5075 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005076 }
5077 else if (*cmd == 'l')
5078 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005079 subflags.do_print = TRUE;
5080 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005081 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005083 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005085 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 else
5087 break;
5088 ++cmd;
5089 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005090 if (subflags.do_count)
5091 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005093 save_do_all = subflags.do_all;
5094 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005095
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 /*
5097 * check for a trailing count
5098 */
5099 cmd = skipwhite(cmd);
5100 if (VIM_ISDIGIT(*cmd))
5101 {
5102 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005103 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005105 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 return;
5107 }
5108 eap->line1 = eap->line2;
5109 eap->line2 += i - 1;
5110 if (eap->line2 > curbuf->b_ml.ml_line_count)
5111 eap->line2 = curbuf->b_ml.ml_line_count;
5112 }
5113
5114 /*
5115 * check for trailing command or garbage
5116 */
5117 cmd = skipwhite(cmd);
5118 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5119 {
5120 eap->nextcmd = check_nextcmd(cmd);
5121 if (eap->nextcmd == NULL)
5122 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005123 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 return;
5125 }
5126 }
5127
5128 if (eap->skip) /* not executing commands, only parsing */
5129 return;
5130
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005131 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005132 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005133 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005134 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005135 return;
5136 }
5137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5139 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005140 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005141 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 return;
5143 }
5144
5145 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005146 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005148 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 regmatch.rmm_ic = FALSE;
5150
5151 sub_firstline = NULL;
5152
5153 /*
5154 * ~ in the substitute pattern is replaced with the old pattern.
5155 * We do it here once to avoid it to be replaced over and over again.
5156 * But don't do it when it starts with "\=", then it's an expression.
5157 */
5158 if (!(sub[0] == '\\' && sub[1] == '='))
5159 sub = regtilde(sub, p_magic);
5160
5161 /*
5162 * Check for a match on each line.
5163 */
5164 line2 = eap->line2;
5165 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005166#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 || aborting()
5168#endif
5169 ); ++lnum)
5170 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005171 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005172 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 if (nmatch)
5174 {
5175 colnr_T copycol;
5176 colnr_T matchcol;
5177 colnr_T prev_matchcol = MAXCOL;
5178 char_u *new_end, *new_start = NULL;
5179 unsigned new_start_len = 0;
5180 char_u *p1;
5181 int did_sub = FALSE;
5182 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005183 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 long nmatch_tl = 0; /* nr of lines matched below lnum */
5185 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005186 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005187 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
5189 /*
5190 * The new text is build up step by step, to avoid too much
5191 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005192 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 * copycol Column in the old text where we started
5194 * looking for a match; from here old text still
5195 * needs to be copied to the new text.
5196 * matchcol Column number of the old text where to look
5197 * for the next match. It's just after the
5198 * previous match or one further.
5199 * prev_matchcol Column just after the previous match (if any).
5200 * Mostly equal to matchcol, except for the first
5201 * match and after skipping an empty match.
5202 * regmatch.*pos Where the pattern matched in the old text.
5203 * new_start The new text, all that has been produced so
5204 * far.
5205 * new_end The new text, where to append new text.
5206 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005207 * lnum The line number where we found the start of
5208 * the match. Can be below the line we searched
5209 * when there is a \n before a \zs in the
5210 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 * sub_firstlnum The line number in the buffer where to look
5212 * for a match. Can be different from "lnum"
5213 * when the pattern or substitute string contains
5214 * line breaks.
5215 *
5216 * Special situations:
5217 * - When the substitute string contains a line break, the part up
5218 * to the line break is inserted in the text, but the copy of
5219 * the original line is kept. "sub_firstlnum" is adjusted for
5220 * the inserted lines.
5221 * - When the matched pattern contains a line break, the old line
5222 * is taken from the line at the end of the pattern. The lines
5223 * in the match are deleted later, "sub_firstlnum" is adjusted
5224 * accordingly.
5225 *
5226 * The new text is built up in new_start[]. It has some extra
5227 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005228 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 *
5230 * Make a copy of the old line, so it won't be taken away when
5231 * updating the screen or handling a multi-line match. The "old_"
5232 * pointers point into this copy.
5233 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005234 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 copycol = 0;
5236 matchcol = 0;
5237
5238 /* At first match, remember current cursor position. */
5239 if (!got_match)
5240 {
5241 setpcmark();
5242 got_match = TRUE;
5243 }
5244
5245 /*
5246 * Loop until nothing more to replace in this line.
5247 * 1. Handle match with empty string.
5248 * 2. If do_ask is set, ask for confirmation.
5249 * 3. substitute the string.
5250 * 4. if do_all is set, find next match
5251 * 5. break if there isn't another match in this line
5252 */
5253 for (;;)
5254 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005255 /* Advance "lnum" to the line where the match starts. The
5256 * match does not start in the first line when there is a line
5257 * break before \zs. */
5258 if (regmatch.startpos[0].lnum > 0)
5259 {
5260 lnum += regmatch.startpos[0].lnum;
5261 sub_firstlnum += regmatch.startpos[0].lnum;
5262 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005263 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005264 }
5265
5266 if (sub_firstline == NULL)
5267 {
5268 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5269 if (sub_firstline == NULL)
5270 {
5271 vim_free(new_start);
5272 goto outofmem;
5273 }
5274 }
5275
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 /* Save the line number of the last change for the final
5277 * cursor position (just like Vi). */
5278 curwin->w_cursor.lnum = lnum;
5279 do_again = FALSE;
5280
5281 /*
5282 * 1. Match empty string does not count, except for first
5283 * match. This reproduces the strange vi behaviour.
5284 * This also catches endless loops.
5285 */
5286 if (matchcol == prev_matchcol
5287 && regmatch.endpos[0].lnum == 0
5288 && matchcol == regmatch.endpos[0].col)
5289 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005290 if (sub_firstline[matchcol] == NUL)
5291 /* We already were at the end of the line. Don't look
5292 * for a match in this line again. */
5293 skip_match = TRUE;
5294 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005295 {
5296 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02005297 if (has_mbyte)
5298 matchcol += mb_ptr2len(sub_firstline + matchcol);
5299 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005300 ++matchcol;
5301 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 goto skip;
5303 }
5304
5305 /* Normally we continue searching for a match just after the
5306 * previous match. */
5307 matchcol = regmatch.endpos[0].col;
5308 prev_matchcol = matchcol;
5309
5310 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005311 * 2. If do_count is set only increase the counter.
5312 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005314 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005315 {
5316 /* For a multi-line match, put matchcol at the NUL at
5317 * the end of the line and set nmatch to one, so that
5318 * we continue looking for a match on the next line.
5319 * Avoids that ":s/\nB\@=//gc" get stuck. */
5320 if (nmatch > 1)
5321 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005322 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005323 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005324 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005325 }
5326 sub_nsubs++;
5327 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005328#ifdef FEAT_EVAL
5329 /* Skip the substitution, unless an expression is used,
5330 * then it is evaluated in the sandbox. */
5331 if (!(sub[0] == '\\' && sub[1] == '='))
5332#endif
5333 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005334 }
5335
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005336 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005338 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005339
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 /* change State to CONFIRM, so that the mouse works
5341 * properly */
5342 save_State = State;
5343 State = CONFIRM;
5344#ifdef FEAT_MOUSE
5345 setmouse(); /* disable mouse in xterm */
5346#endif
5347 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005348 if (curwin->w_p_crb)
5349 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350
5351 /* When 'cpoptions' contains "u" don't sync undo when
5352 * asking for confirmation. */
5353 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5354 ++no_u_sync;
5355
5356 /*
5357 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5358 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005359 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005361 if (exmode_active)
5362 {
5363 char_u *resp;
5364 colnr_T sc, ec;
5365
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005366 print_line_no_prefix(lnum,
5367 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005368
5369 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5370 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005371 if (curwin->w_cursor.col < 0)
5372 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005373 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005374 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005375 {
5376 int numw = number_width(curwin) + 1;
5377 sc += numw;
5378 ec += numw;
5379 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005380 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005381 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005382 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005383 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005384 msg_putchar('^');
5385
5386 resp = getexmodeline('?', NULL, 0);
5387 if (resp != NULL)
5388 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005389 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005390 vim_free(resp);
5391 }
5392 }
5393 else
5394 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005395 char_u *orig_line = NULL;
5396 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005398 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005400 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005402 /* Invert the matched string.
5403 * Remove the inversion afterwards. */
5404 temp = RedrawingDisabled;
5405 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005407 if (new_start != NULL)
5408 {
5409 /* There already was a substitution, we would
5410 * like to show this to the user. We cannot
5411 * really update the line, it would change
5412 * what matches. Temporarily replace the line
5413 * and change it back afterwards. */
5414 orig_line = vim_strsave(ml_get(lnum));
5415 if (orig_line != NULL)
5416 {
5417 char_u *new_line = concat_str(new_start,
5418 sub_firstline + copycol);
5419
5420 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005421 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005422 else
5423 {
5424 /* Position the cursor relative to the
5425 * end of the line, the previous
5426 * substitute may have inserted or
5427 * deleted characters before the
5428 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005429 len_change = (int)STRLEN(new_line)
5430 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005431 curwin->w_cursor.col += len_change;
5432 ml_replace(lnum, new_line, FALSE);
5433 }
5434 }
5435 }
5436
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005437 search_match_lines = regmatch.endpos[0].lnum
5438 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005439 search_match_endcol = regmatch.endpos[0].col
5440 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005441 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005443 update_topline();
5444 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005445 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005446 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005447 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
5449#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005450 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005452 if (msg_row == Rows - 1)
5453 msg_didout = FALSE; /* avoid a scroll-up */
5454 msg_starthere();
5455 i = msg_scroll;
5456 msg_scroll = 0; /* truncate msg when
5457 needed */
5458 msg_no_more = TRUE;
5459 /* write message same highlighting as for
5460 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005461 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005462 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005463 msg_no_more = FALSE;
5464 msg_scroll = i;
5465 showruler(TRUE);
5466 windgoto(msg_row, msg_col);
5467 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468
5469#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005470 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005472 ++no_mapping; /* don't map this key */
5473 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005474 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005475 --allow_keys;
5476 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005478 /* clear the question */
5479 msg_didout = FALSE; /* don't scroll up */
5480 msg_col = 0;
5481 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005482
5483 /* restore the line */
5484 if (orig_line != NULL)
5485 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005486 }
5487
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005489 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005491 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492#endif
5493 )
5494 {
5495 got_quit = TRUE;
5496 break;
5497 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005498 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005500 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005502 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 {
5504 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005505 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 line2 = lnum;
5507 break;
5508 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005509 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005511 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 break;
5513 }
5514#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005515 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005517 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 scrolldown_clamp();
5519#endif
5520 }
5521 State = save_State;
5522#ifdef FEAT_MOUSE
5523 setmouse();
5524#endif
5525 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5526 --no_u_sync;
5527
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005528 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 {
5530 /* For a multi-line match, put matchcol at the NUL at
5531 * the end of the line and set nmatch to one, so that
5532 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005533 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5534 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 if (nmatch > 1)
5536 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005537 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005538 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 }
5540 goto skip;
5541 }
5542 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005543 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 }
5545
5546 /* Move the cursor to the start of the match, so that we can
5547 * use "\=col("."). */
5548 curwin->w_cursor.col = regmatch.startpos[0].col;
5549
5550 /*
5551 * 3. substitute the string.
5552 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005553#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005554 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005555 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005556 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005557 save_ma = curbuf->b_p_ma;
5558 curbuf->b_p_ma = FALSE;
5559 sandbox++;
5560 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005561 /* Save flags for recursion. They can change for e.g.
5562 * :s/^/\=execute("s#^##gn") */
5563 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005564#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005566 sublen = vim_regsub_multi(&regmatch,
5567 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005569#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005570 /* Don't keep flags set by a recursive call. */
5571 subflags = subflags_save;
5572 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005573 {
5574 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005575 if (sandbox > 0)
5576 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005577 goto skip;
5578 }
5579#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580
Bram Moolenaar4463f292005-09-25 22:20:24 +00005581 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005582 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005583 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5584 {
5585 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5586 skip_match = TRUE;
5587 }
5588
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 /* Need room for:
5590 * - result so far in new_start (not for first sub in line)
5591 * - original text up to match
5592 * - length of substituted part
5593 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005594 * Adjust text properties here, since we have all information
5595 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 */
5597 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005598 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005600#ifdef FEAT_TEXT_PROP
5601 if (curbuf->b_has_textprop)
5602 adjust_prop_columns(lnum, regmatch.startpos[0].col,
5603 sublen - 1 - (regmatch.endpos[0].col
5604 - regmatch.startpos[0].col));
5605#endif
5606 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 else
5608 {
5609 p1 = ml_get(sub_firstlnum + nmatch - 1);
5610 nmatch_tl += nmatch - 1;
5611 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005612 copy_len = regmatch.startpos[0].col - copycol;
5613 needed_len = copy_len + ((unsigned)STRLEN(p1)
5614 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 if (new_start == NULL)
5616 {
5617 /*
5618 * Get some space for a temporary buffer to do the
5619 * substitution into (and some extra space to avoid
5620 * too many calls to alloc()/free()).
5621 */
5622 new_start_len = needed_len + 50;
5623 if ((new_start = alloc_check(new_start_len)) == NULL)
5624 goto outofmem;
5625 *new_start = NUL;
5626 new_end = new_start;
5627 }
5628 else
5629 {
5630 /*
5631 * Check if the temporary buffer is long enough to do the
5632 * substitution into. If not, make it larger (with a bit
5633 * extra to avoid too many calls to alloc()/free()).
5634 */
5635 len = (unsigned)STRLEN(new_start);
5636 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005637 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 {
5639 new_start_len = needed_len + 50;
5640 if ((p1 = alloc_check(new_start_len)) == NULL)
5641 {
5642 vim_free(new_start);
5643 goto outofmem;
5644 }
5645 mch_memmove(p1, new_start, (size_t)(len + 1));
5646 vim_free(new_start);
5647 new_start = p1;
5648 }
5649 new_end = new_start + len;
5650 }
5651
5652 /*
5653 * copy the text up to the part that matched
5654 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005655 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5656 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005658 (void)vim_regsub_multi(&regmatch,
5659 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 sub, new_end, TRUE, p_magic, TRUE);
5661 sub_nsubs++;
5662 did_sub = TRUE;
5663
5664 /* Move the cursor to the start of the line, to avoid that it
5665 * is beyond the end of the line after the substitution. */
5666 curwin->w_cursor.col = 0;
5667
5668 /* For a multi-line match, make a copy of the last matched
5669 * line and continue in that one. */
5670 if (nmatch > 1)
5671 {
5672 sub_firstlnum += nmatch - 1;
5673 vim_free(sub_firstline);
5674 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5675 /* When going beyond the last line, stop substituting. */
5676 if (sub_firstlnum <= line2)
5677 do_again = TRUE;
5678 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005679 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 }
5681
5682 /* Remember next character to be copied. */
5683 copycol = regmatch.endpos[0].col;
5684
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005685 if (skip_match)
5686 {
5687 /* Already hit end of the buffer, sub_firstlnum is one
5688 * less than what it ought to be. */
5689 vim_free(sub_firstline);
5690 sub_firstline = vim_strsave((char_u *)"");
5691 copycol = 0;
5692 }
5693
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 /*
5695 * Now the trick is to replace CTRL-M chars with a real line
5696 * break. This would make it impossible to insert a CTRL-M in
5697 * the text. The line break can be avoided by preceding the
5698 * CTRL-M with a backslash. To be able to insert a backslash,
5699 * they must be doubled in the string and are halved here.
5700 * That is Vi compatible.
5701 */
5702 for (p1 = new_end; *p1; ++p1)
5703 {
5704 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005705 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 else if (*p1 == CAR)
5707 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005708 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005710 colnr_T plen = (colnr_T)(p1 - new_start + 1);
5711
5712 *p1 = NUL; // truncate up to the CR
5713 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005715 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 appended_lines(lnum - 1, 1L);
5717 else
5718 {
5719 if (first_line == 0)
5720 first_line = lnum;
5721 last_line = lnum + 1;
5722 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005723#ifdef FEAT_TEXT_PROP
5724 adjust_props_for_split(lnum, plen, 1);
5725#endif
5726 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 ++sub_firstlnum;
5728 ++lnum;
5729 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005730 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005732 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005733 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 p1 = new_start - 1;
5735 }
5736 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005738 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 }
5740
5741 /*
5742 * 4. If do_all is set, find next match.
5743 * Prevent endless loop with patterns that match empty
5744 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5745 * But ":s/\n/#/" is OK.
5746 */
5747skip:
5748 /* We already know that we did the last subst when we are at
5749 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005750 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5751 * "line2" when there is a \zs in the pattern after a line
5752 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005753 lastone = (skip_match
5754 || got_int
5755 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005756 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005757 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005758 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5759 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 nmatch = -1;
5761
5762 /*
5763 * Replace the line in the buffer when needed. This is
5764 * skipped when there are more matches.
5765 * The check for nmatch_tl is needed for when multi-line
5766 * matching must replace the lines before trying to do another
5767 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005768 * When the match starts below where we start searching also
5769 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 */
5771 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 || nmatch_tl > 0
5773 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005774 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005775 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005776 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 {
5778 if (new_start != NULL)
5779 {
5780 /*
5781 * Copy the rest of the line, that didn't match.
5782 * "matchcol" has to be adjusted, we use the end of
5783 * the line as reference, because the substitute may
5784 * have changed the number of characters. Same for
5785 * "prev_matchcol".
5786 */
5787 STRCAT(new_start, sub_firstline + copycol);
5788 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5789 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5790 - prev_matchcol;
5791
5792 if (u_savesub(lnum) != OK)
5793 break;
5794 ml_replace(lnum, new_start, TRUE);
5795
5796 if (nmatch_tl > 0)
5797 {
5798 /*
5799 * Matched lines have now been substituted and are
5800 * useless, delete them. The part after the match
5801 * has been appended to new_start, we don't need
5802 * it in the buffer.
5803 */
5804 ++lnum;
5805 if (u_savedel(lnum, nmatch_tl) != OK)
5806 break;
5807 for (i = 0; i < nmatch_tl; ++i)
5808 ml_delete(lnum, (int)FALSE);
5809 mark_adjust(lnum, lnum + nmatch_tl - 1,
5810 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005811 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 deleted_lines(lnum, nmatch_tl);
5813 --lnum;
5814 line2 -= nmatch_tl; /* nr of lines decreases */
5815 nmatch_tl = 0;
5816 }
5817
5818 /* When asking, undo is saved each time, must also set
5819 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005820 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 changed_bytes(lnum, 0);
5822 else
5823 {
5824 if (first_line == 0)
5825 first_line = lnum;
5826 last_line = lnum + 1;
5827 }
5828
5829 sub_firstlnum = lnum;
5830 vim_free(sub_firstline); /* free the temp buffer */
5831 sub_firstline = new_start;
5832 new_start = NULL;
5833 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5834 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5835 - prev_matchcol;
5836 copycol = 0;
5837 }
5838 if (nmatch == -1 && !lastone)
5839 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005840 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841
5842 /*
5843 * 5. break if there isn't another match in this line
5844 */
5845 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005846 {
5847 /* If the match found didn't start where we were
5848 * searching, do the next search in the line where we
5849 * found the match. */
5850 if (nmatch == -1)
5851 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005853 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 }
5855
5856 line_breakcheck();
5857 }
5858
5859 if (did_sub)
5860 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005861 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005862 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 }
5864
5865 line_breakcheck();
5866 }
5867
5868 if (first_line != 0)
5869 {
5870 /* Need to subtract the number of added lines from "last_line" to get
5871 * the line number before the change (same as adding the number of
5872 * deleted lines). */
5873 i = curbuf->b_ml.ml_line_count - old_line_count;
5874 changed_lines(first_line, 0, last_line - i, i);
5875 }
5876
5877outofmem:
5878 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005879
5880 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005881 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005882 curwin->w_cursor = old_cursor;
5883
Bram Moolenaar46475522010-03-23 17:36:29 +01005884 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 {
5886 /* Set the '[ and '] marks. */
5887 curbuf->b_op_start.lnum = eap->line1;
5888 curbuf->b_op_end.lnum = line2;
5889 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5890
5891 if (!global_busy)
5892 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005893 /* when interactive leave cursor on the match */
5894 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005895 {
5896 if (endcolumn)
5897 coladvance((colnr_T)MAXCOL);
5898 else
5899 beginline(BL_WHITE | BL_FIX);
5900 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005901 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005902 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 }
5904 else
5905 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005906 if (subflags.do_print)
5907 print_line(curwin->w_cursor.lnum,
5908 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 }
5910 else if (!global_busy)
5911 {
5912 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005913 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005915 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005916 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005917 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 }
5919
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005920#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005921 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005922 /* Cursor position may require updating */
5923 changed_window_setting();
5924#endif
5925
Bram Moolenaar473de612013-06-08 18:19:48 +02005926 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005927
5928 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005929 subflags.do_all = save_do_all;
5930 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931}
5932
5933/*
5934 * Give message for number of substitutions.
5935 * Can also be used after a ":global" command.
5936 * Return TRUE if a message was given.
5937 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005938 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005939do_sub_msg(
5940 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941{
5942 /*
5943 * Only report substitutions when:
5944 * - more than 'report' substitutions
5945 * - command was typed by user, or number of changed lines > 'report'
5946 * - giving messages is not disabled by 'lazyredraw'
5947 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005948 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5949 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 && messaging())
5951 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005952 char *msg_single;
5953 char *msg_plural;
5954
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 if (got_int)
5956 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005957 else
5958 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005959
5960 msg_single = count_only
5961 ? NGETTEXT("%ld match on %ld line",
5962 "%ld matches on %ld line", sub_nsubs)
5963 : NGETTEXT("%ld substitution on %ld line",
5964 "%ld substitutions on %ld line", sub_nsubs);
5965 msg_plural = count_only
5966 ? NGETTEXT("%ld match on %ld lines",
5967 "%ld matches on %ld lines", sub_nsubs)
5968 : NGETTEXT("%ld substitution on %ld lines",
5969 "%ld substitutions on %ld lines", sub_nsubs);
5970
Bram Moolenaar32526b32019-01-19 17:43:09 +01005971 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005972 NGETTEXT(msg_single, msg_plural, sub_nlines),
5973 sub_nsubs, (long)sub_nlines);
5974
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005977 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 return TRUE;
5979 }
5980 if (got_int)
5981 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005982 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 return TRUE;
5984 }
5985 return FALSE;
5986}
5987
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005988 static void
5989global_exe_one(char_u *cmd, linenr_T lnum)
5990{
5991 curwin->w_cursor.lnum = lnum;
5992 curwin->w_cursor.col = 0;
5993 if (*cmd == NUL || *cmd == '\n')
5994 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5995 else
5996 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5997}
5998
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999/*
6000 * Execute a global command of the form:
6001 *
6002 * g/pattern/X : execute X on all lines where pattern matches
6003 * v/pattern/X : execute X on all lines where pattern does not match
6004 *
6005 * where 'X' is an EX command
6006 *
6007 * The command character (as well as the trailing slash) is optional, and
6008 * is assumed to be 'p' if missing.
6009 *
6010 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006011 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 * for each line that has a mark. This is required because after deleting
6013 * lines we do not know where to search for the next match.
6014 */
6015 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006016ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017{
6018 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006019 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 int type; /* first char of cmd: 'v' or 'g' */
6021 char_u *cmd; /* command argument */
6022
6023 char_u delim; /* delimiter, normally '/' */
6024 char_u *pat;
6025 regmmatch_T regmatch;
6026 int match;
6027 int which_pat;
6028
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006029 /* When nesting the command works on one line. This allows for
6030 * ":g/found/v/notfound/command". */
6031 if (global_busy && (eap->line1 != 1
6032 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006034 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006035 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 return;
6037 }
6038
6039 if (eap->forceit) /* ":global!" is like ":vglobal" */
6040 type = 'v';
6041 else
6042 type = *eap->cmd;
6043 cmd = eap->arg;
6044 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045
6046 /*
6047 * undocumented vi feature:
6048 * "\/" and "\?": use previous search pattern.
6049 * "\&": use previous substitute pattern.
6050 */
6051 if (*cmd == '\\')
6052 {
6053 ++cmd;
6054 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
6055 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006056 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 return;
6058 }
6059 if (*cmd == '&')
6060 which_pat = RE_SUBST; /* use previous substitute pattern */
6061 else
6062 which_pat = RE_SEARCH; /* use previous search pattern */
6063 ++cmd;
6064 pat = (char_u *)"";
6065 }
6066 else if (*cmd == NUL)
6067 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006068 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 return;
6070 }
6071 else
6072 {
6073 delim = *cmd; /* get the delimiter */
6074 if (delim)
6075 ++cmd; /* skip delimiter if there is one */
6076 pat = cmd; /* remember start of pattern */
6077 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
6078 if (cmd[0] == delim) /* end delimiter found */
6079 *cmd++ = NUL; /* replace it with a NUL */
6080 }
6081
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6083 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006084 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 return;
6086 }
6087
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006088 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006090 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006091 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006092 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006094 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 }
6096 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006097 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006098 /*
6099 * pass 1: set marks for each (not) matching line
6100 */
6101 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6102 {
6103 /* a match on this line? */
6104 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006105 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006106 if ((type == 'g' && match) || (type == 'v' && !match))
6107 {
6108 ml_setmarked(lnum);
6109 ndone++;
6110 }
6111 line_breakcheck();
6112 }
6113
6114 /*
6115 * pass 2: execute the command for each line that has been marked
6116 */
6117 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006118 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006119 else if (ndone == 0)
6120 {
6121 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006122 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006123 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006124 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006125 }
6126 else
6127 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006128#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006129 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006130#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006131 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006132#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006133 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006134#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006135 }
6136
6137 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006138 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139
Bram Moolenaar473de612013-06-08 18:19:48 +02006140 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141}
6142
6143/*
6144 * Execute "cmd" on lines marked with ml_setmarked().
6145 */
6146 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006147global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006149 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6150 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6151 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152
6153 /*
6154 * Set current position only once for a global command.
6155 * If global_busy is set, setpcmark() will not do anything.
6156 * If there is an error, global_busy will be incremented.
6157 */
6158 setpcmark();
6159
6160 /* When the command writes a message, don't overwrite the command. */
6161 msg_didout = TRUE;
6162
Bram Moolenaard25bc232010-03-23 17:49:24 +01006163 sub_nsubs = 0;
6164 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 global_need_beginline = FALSE;
6166 global_busy = 1;
6167 old_lcount = curbuf->b_ml.ml_line_count;
6168 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6169 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006170 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 ui_breakcheck();
6172 }
6173
6174 global_busy = 0;
6175 if (global_need_beginline)
6176 beginline(BL_WHITE | BL_FIX);
6177 else
6178 check_cursor(); /* cursor may be beyond the end of the line */
6179
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006180 /* the cursor may not have moved in the text but a change in a previous
6181 * line may move it on the screen */
6182 changed_line_abv_curs();
6183
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 /* If it looks like no message was written, allow overwriting the
6185 * command with the report for number of changes. */
6186 if (msg_col == 0 && msg_scrolled == 0)
6187 msg_didout = FALSE;
6188
Bram Moolenaar45667512007-05-10 19:24:43 +00006189 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006190 * number of extra or deleted lines.
6191 * Don't report extra or deleted lines in the edge case where the buffer
6192 * we are in after execution is different from the buffer we started in. */
6193 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6195}
6196
6197#ifdef FEAT_VIMINFO
6198 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006199read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006201 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 vim_free(old_sub);
6203 if (force || old_sub == NULL)
6204 old_sub = viminfo_readstring(virp, 1, TRUE);
6205 return viminfo_readline(virp);
6206}
6207
6208 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006209write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210{
6211 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6212 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006213 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 viminfo_writestring(fp, old_sub);
6215 }
6216}
6217#endif /* FEAT_VIMINFO */
6218
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006219#if defined(EXITFREE) || defined(PROTO)
6220 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006221free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006222{
6223 vim_free(old_sub);
6224}
6225#endif
6226
Bram Moolenaar4033c552017-09-16 20:54:51 +02006227#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228/*
6229 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006230 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006232 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006233prepare_tagpreview(
6234 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235{
6236 win_T *wp;
6237
6238# ifdef FEAT_GUI
6239 need_mouse_correct = TRUE;
6240# endif
6241
6242 /*
6243 * If there is already a preview window open, use that one.
6244 */
6245 if (!curwin->w_p_pvw)
6246 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006247 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 if (wp->w_p_pvw)
6249 break;
6250 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006251 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 else
6253 {
6254 /*
6255 * There is no preview window open yet. Create one.
6256 */
6257 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6258 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006259 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 curwin->w_p_pvw = TRUE;
6261 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006262 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6263 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264# ifdef FEAT_DIFF
6265 curwin->w_p_diff = FALSE; /* no 'diff' */
6266# endif
6267# ifdef FEAT_FOLDING
6268 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6269# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006270 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 }
6272 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006273 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274}
6275
6276#endif
6277
6278
6279/*
6280 * ":help": open a read-only window on a help file
6281 */
6282 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006283ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284{
6285 char_u *arg;
6286 char_u *tag;
6287 FILE *helpfd; /* file descriptor of help file */
6288 int n;
6289 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 int num_matches;
6292 char_u **matches;
6293 char_u *p;
6294 int empty_fnum = 0;
6295 int alt_fnum = 0;
6296 buf_T *buf;
6297#ifdef FEAT_MULTI_LANG
6298 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006299 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006301#ifdef FEAT_FOLDING
6302 int old_KeyTyped = KeyTyped;
6303#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304
6305 if (eap != NULL)
6306 {
6307 /*
6308 * A ":help" command ends at the first LF, or at a '|' that is
6309 * followed by some text. Set nextcmd to the following command.
6310 */
6311 for (arg = eap->arg; *arg; ++arg)
6312 {
6313 if (*arg == '\n' || *arg == '\r'
6314 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6315 {
6316 *arg++ = NUL;
6317 eap->nextcmd = arg;
6318 break;
6319 }
6320 }
6321 arg = eap->arg;
6322
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006323 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006325 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 return;
6327 }
6328
6329 if (eap->skip) /* not executing commands */
6330 return;
6331 }
6332 else
6333 arg = (char_u *)"";
6334
6335 /* remove trailing blanks */
6336 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006337 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 *p-- = NUL;
6339
6340#ifdef FEAT_MULTI_LANG
6341 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006342 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343#endif
6344
6345 /* When no argument given go to the index. */
6346 if (*arg == NUL)
6347 arg = (char_u *)"help.txt";
6348
6349 /*
6350 * Check if there is a match for the argument.
6351 */
6352 n = find_help_tags(arg, &num_matches, &matches,
6353 eap != NULL && eap->forceit);
6354
6355 i = 0;
6356#ifdef FEAT_MULTI_LANG
6357 if (n != FAIL && lang != NULL)
6358 /* Find first item with the requested language. */
6359 for (i = 0; i < num_matches; ++i)
6360 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006361 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 if (len > 3 && matches[i][len - 3] == '@'
6363 && STRICMP(matches[i] + len - 2, lang) == 0)
6364 break;
6365 }
6366#endif
6367 if (i >= num_matches || n == FAIL)
6368 {
6369#ifdef FEAT_MULTI_LANG
6370 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006371 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 else
6373#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006374 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 if (n != FAIL)
6376 FreeWild(num_matches, matches);
6377 return;
6378 }
6379
6380 /* The first match (in the requested language) is the best match. */
6381 tag = vim_strsave(matches[i]);
6382 FreeWild(num_matches, matches);
6383
6384#ifdef FEAT_GUI
6385 need_mouse_correct = TRUE;
6386#endif
6387
6388 /*
6389 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006390 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006392 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006394 if (cmdmod.tab != 0)
6395 wp = NULL;
6396 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006397 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006398 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006399 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6401 win_enter(wp, TRUE);
6402 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 {
6404 /*
6405 * There is no help window yet.
6406 * Try to open the file specified by the "helpfile" option.
6407 */
6408 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6409 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006410 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 goto erret;
6412 }
6413 fclose(helpfd);
6414
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006416 * specified, the current window is vertically split and
6417 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006420 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006423 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 if (curwin->w_height < p_hh)
6426 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427
6428 /*
6429 * Open help file (do_ecmd() will set b_help flag, readfile() will
6430 * set b_p_ro flag).
6431 * Set the alternate file to the previously edited file.
6432 */
6433 alt_fnum = curbuf->b_fnum;
6434 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006435 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006436 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006437 if (!cmdmod.keepalt)
6438 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 empty_fnum = curbuf->b_fnum;
6440 }
6441 }
6442
6443 if (!p_im)
6444 restart_edit = 0; /* don't want insert mode in help file */
6445
Bram Moolenaar8f535582011-09-30 17:30:31 +02006446#ifdef FEAT_FOLDING
6447 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6448 * It is needed for do_tag top open folds under the cursor. */
6449 KeyTyped = old_KeyTyped;
6450#endif
6451
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 if (tag != NULL)
6453 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6454
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006455 /* Delete the empty buffer if we're not using it. Careful: autocommands
6456 * may have jumped to another window, check that the buffer is not in a
6457 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6459 {
6460 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006461 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 wipe_buffer(buf, TRUE);
6463 }
6464
6465 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006466 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 curwin->w_alt_fnum = alt_fnum;
6468
6469erret:
6470 vim_free(tag);
6471}
6472
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006473/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006474 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006475 */
6476 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006477ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006478{
6479 win_T *win;
6480
6481 FOR_ALL_WINDOWS(win)
6482 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006483 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006484 {
6485 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006486 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006487 }
6488 }
6489}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006491#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6492/*
6493 * In an argument search for a language specifiers in the form "@xx".
6494 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6495 * Returns NULL if not found.
6496 */
6497 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006498check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006499{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006500 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006501
6502 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6503 && ASCII_ISALPHA(arg[len - 1]))
6504 {
6505 arg[len - 3] = NUL; /* remove the '@' */
6506 return arg + len - 2;
6507 }
6508 return NULL;
6509}
6510#endif
6511
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512/*
6513 * Return a heuristic indicating how well the given string matches. The
6514 * smaller the number, the better the match. This is the order of priorities,
6515 * from best match to worst match:
6516 * - Match with least alpha-numeric characters is better.
6517 * - Match with least total characters is better.
6518 * - Match towards the start is better.
6519 * - Match starting with "+" is worse (feature instead of command)
6520 * Assumption is made that the matched_string passed has already been found to
6521 * match some string for which help is requested. webb.
6522 */
6523 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006524help_heuristic(
6525 char_u *matched_string,
6526 int offset, /* offset for match */
6527 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528{
6529 int num_letters;
6530 char_u *p;
6531
6532 num_letters = 0;
6533 for (p = matched_string; *p; p++)
6534 if (ASCII_ISALNUM(*p))
6535 num_letters++;
6536
6537 /*
6538 * Multiply the number of letters by 100 to give it a much bigger
6539 * weighting than the number of characters.
6540 * If there only is a match while ignoring case, add 5000.
6541 * If the match starts in the middle of a word, add 10000 to put it
6542 * somewhere in the last half.
6543 * If the match is more than 2 chars from the start, multiply by 200 to
6544 * put it after matches at the start.
6545 */
6546 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6547 && ASCII_ISALNUM(matched_string[offset - 1]))
6548 offset += 10000;
6549 else if (offset > 2)
6550 offset *= 200;
6551 if (wrong_case)
6552 offset += 5000;
6553 /* Features are less interesting than the subjects themselves, but "+"
6554 * alone is not a feature. */
6555 if (matched_string[0] == '+' && matched_string[1] != NUL)
6556 offset += 100;
6557 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6558}
6559
6560/*
6561 * Compare functions for qsort() below, that checks the help heuristics number
6562 * that has been put after the tagname by find_tags().
6563 */
6564 static int
6565#ifdef __BORLANDC__
6566_RTLENTRYF
6567#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006568help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569{
6570 char *p1;
6571 char *p2;
6572
6573 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6574 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6575 return strcmp(p1, p2);
6576}
6577
6578/*
6579 * Find all help tags matching "arg", sort them and return in matches[], with
6580 * the number of matches in num_matches.
6581 * The matches will be sorted with a "best" match algorithm.
6582 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6583 */
6584 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006585find_help_tags(
6586 char_u *arg,
6587 int *num_matches,
6588 char_u ***matches,
6589 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590{
6591 char_u *s, *d;
6592 int i;
6593 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006594 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006595 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006596 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6597 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006598 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006599 "[count]", "[quotex]",
6600 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006601 "[pattern]", "\\|", "\\%$",
6602 "s/\\~", "s/\\U", "s/\\L",
6603 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006605 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006606 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006607 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6608 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006609 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006610 "\\[count]", "\\[quotex]",
6611 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006612 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006613 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006614 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006615 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
6616 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 int flags;
6618
6619 d = IObuff; /* assume IObuff is long enough! */
6620
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006621 if (STRNICMP(arg, "expr-", 5) == 0)
6622 {
6623 // When the string starting with "expr-" and containing '?' and matches
6624 // the table, it is taken literally. Otherwise '?' is recognized as a
6625 // wildcard.
6626 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
6627 if (STRCMP(arg + 5, expr_table[i]) == 0)
6628 {
6629 STRCPY(d, arg);
6630 break;
6631 }
6632 }
6633 else
6634 {
6635 // Recognize a few exceptions to the rule. Some strings that contain
6636 // '*' with "star". Otherwise '*' is recognized as a wildcard.
6637 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
6638 if (STRCMP(arg, mtable[i]) == 0)
6639 {
6640 STRCPY(d, rtable[i]);
6641 break;
6642 }
6643 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644
6645 if (i < 0) /* no match in table */
6646 {
6647 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6648 * Also replace "\%^" and "\%(", they match every tag too.
6649 * Also "\zs", "\z1", etc.
6650 * Also "\@<", "\@=", "\@<=", etc.
6651 * And also "\_$" and "\_^". */
6652 if (arg[0] == '\\'
6653 && ((arg[1] != NUL && arg[2] == NUL)
6654 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6655 && arg[2] != NUL)))
6656 {
6657 STRCPY(d, "/\\\\");
6658 STRCPY(d + 3, arg + 1);
6659 /* Check for "/\\_$", should be "/\\_\$" */
6660 if (d[3] == '_' && d[4] == '$')
6661 STRCPY(d + 4, "\\$");
6662 }
6663 else
6664 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006665 /* Replace:
6666 * "[:...:]" with "\[:...:]"
6667 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006668 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006669 */
6670 if ((arg[0] == '[' && (arg[1] == ':'
6671 || (arg[1] == '+' && arg[2] == '+')))
6672 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 *d++ = '\\';
6674
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006675 /*
6676 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6677 */
6678 if (*arg == '(' && arg[1] == '\'')
6679 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 for (s = arg; *s; ++s)
6681 {
6682 /*
6683 * Replace "|" with "bar" and '"' with "quote" to match the name of
6684 * the tags for these commands.
6685 * Replace "*" with ".*" and "?" with "." to match command line
6686 * completion.
6687 * Insert a backslash before '~', '$' and '.' to avoid their
6688 * special meaning.
6689 */
6690 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6691 break;
6692 switch (*s)
6693 {
6694 case '|': STRCPY(d, "bar");
6695 d += 3;
6696 continue;
6697 case '"': STRCPY(d, "quote");
6698 d += 5;
6699 continue;
6700 case '*': *d++ = '.';
6701 break;
6702 case '?': *d++ = '.';
6703 continue;
6704 case '$':
6705 case '.':
6706 case '~': *d++ = '\\';
6707 break;
6708 }
6709
6710 /*
6711 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6712 * ":help i_^_CTRL-D" work.
6713 * Insert '-' before and after "CTRL-X" when applicable.
6714 */
6715 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6716 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6717 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006718 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6719 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 STRCPY(d, "CTRL-");
6721 d += 5;
6722 if (*s < ' ')
6723 {
6724#ifdef EBCDIC
6725 *d++ = CtrlChar(*s);
6726#else
6727 *d++ = *s + '@';
6728#endif
6729 if (d[-1] == '\\')
6730 *d++ = '\\'; /* double a backslash */
6731 }
6732 else
6733 *d++ = *++s;
6734 if (s[1] != NUL && s[1] != '_')
6735 *d++ = '_'; /* append a '_' */
6736 continue;
6737 }
6738 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6739 *d++ = '\\';
6740
6741 /*
6742 * Insert a backslash before a backslash after a slash, for search
6743 * pattern tags: "/\|" --> "/\\|".
6744 */
6745 else if (s[0] == '\\' && s[1] != '\\'
6746 && *arg == '/' && s == arg + 1)
6747 *d++ = '\\';
6748
6749 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6750 * "CTRL-\_CTRL-N" */
6751 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6752 {
6753 STRCPY(d, "CTRL-\\\\");
6754 d += 7;
6755 s += 6;
6756 }
6757
6758 *d++ = *s;
6759
6760 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006761 * If tag contains "({" or "([", tag terminates at the "(".
6762 * This is for help on functions, e.g.: abs({expr}).
6763 */
6764 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6765 break;
6766
6767 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 * If tag starts with ', toss everything after a second '. Fixes
6769 * CTRL-] on 'option'. (would include the trailing '.').
6770 */
6771 if (*s == '\'' && s > arg && *arg == '\'')
6772 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006773 /* Also '{' and '}'. */
6774 if (*s == '}' && s > arg && *arg == '{')
6775 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 }
6777 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006778
6779 if (*IObuff == '`')
6780 {
6781 if (d > IObuff + 2 && d[-1] == '`')
6782 {
6783 /* remove the backticks from `command` */
6784 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6785 d[-2] = NUL;
6786 }
6787 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6788 {
6789 /* remove the backticks and comma from `command`, */
6790 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6791 d[-3] = NUL;
6792 }
6793 else if (d > IObuff + 4 && d[-3] == '`'
6794 && d[-2] == '\\' && d[-1] == '.')
6795 {
6796 /* remove the backticks and dot from `command`\. */
6797 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6798 d[-4] = NUL;
6799 }
6800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 }
6802 }
6803
6804 *matches = (char_u **)"";
6805 *num_matches = 0;
6806 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6807 if (keep_lang)
6808 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006809 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006811 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 /* Sort the matches found on the heuristic number that is after the
6813 * tag name. */
6814 qsort((void *)*matches, (size_t)*num_matches,
6815 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006816 /* Delete more than TAG_MANY to reduce the size of the listing. */
6817 while (*num_matches > TAG_MANY)
6818 vim_free((*matches)[--*num_matches]);
6819 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 return OK;
6821}
6822
6823/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006824 * Called when starting to edit a buffer for a help file.
6825 */
6826 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006827prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006828{
6829 char_u *p;
6830
6831 curbuf->b_help = TRUE;
6832#ifdef FEAT_QUICKFIX
6833 set_string_option_direct((char_u *)"buftype", -1,
6834 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6835#endif
6836
6837 /*
6838 * Always set these options after jumping to a help tag, because the
6839 * user may have an autocommand that gets in the way.
6840 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6841 * latin1 word characters (for translated help files).
6842 * Only set it when needed, buf_init_chartab() is some work.
6843 */
6844 p =
6845#ifdef EBCDIC
6846 (char_u *)"65-255,^*,^|,^\"";
6847#else
6848 (char_u *)"!-~,^*,^|,^\",192-255";
6849#endif
6850 if (STRCMP(curbuf->b_p_isk, p) != 0)
6851 {
6852 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6853 check_buf_options(curbuf);
6854 (void)buf_init_chartab(curbuf, FALSE);
6855 }
6856
Bram Moolenaar0b105412014-11-30 13:34:23 +01006857#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006858 /* Don't use the global foldmethod.*/
6859 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6860 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006861#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006862
6863 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6864 curwin->w_p_list = FALSE; /* no list mode */
6865
6866 curbuf->b_p_ma = FALSE; /* not modifiable */
6867 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6868 curwin->w_p_nu = 0; /* no line numbers */
6869 curwin->w_p_rnu = 0; /* no relative line numbers */
6870 RESET_BINDING(curwin); /* no scroll or cursor binding */
6871#ifdef FEAT_ARABIC
6872 curwin->w_p_arab = FALSE; /* no arabic mode */
6873#endif
6874#ifdef FEAT_RIGHTLEFT
6875 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6876#endif
6877#ifdef FEAT_FOLDING
6878 curwin->w_p_fen = FALSE; /* No folding in the help window */
6879#endif
6880#ifdef FEAT_DIFF
6881 curwin->w_p_diff = FALSE; /* No 'diff' */
6882#endif
6883#ifdef FEAT_SPELL
6884 curwin->w_p_spell = FALSE; /* No spell checking */
6885#endif
6886
6887 set_buflisted(FALSE);
6888}
6889
6890/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 * After reading a help file: May cleanup a help buffer when syntax
6892 * highlighting is not used.
6893 */
6894 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006895fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896{
6897 linenr_T lnum;
6898 char_u *line;
6899 int in_example = FALSE;
6900 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006901 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 char_u *p;
6903 char_u *rt;
6904 int mustfree;
6905
Bram Moolenaar90492982017-06-22 14:16:31 +02006906 /* Set filetype to "help" if still needed. */
6907 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006908 {
6909 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006910 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006911 --curbuf_lock;
6912 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913
6914#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006915 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916#endif
6917 {
6918 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6919 {
6920 line = ml_get_buf(curbuf, lnum, FALSE);
6921 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006922 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 {
6924 /* End of example: non-white or '<' in first column. */
6925 if (line[0] == '<')
6926 {
6927 /* blank-out a '<' in the first column */
6928 line = ml_get_buf(curbuf, lnum, TRUE);
6929 line[0] = ' ';
6930 }
6931 in_example = FALSE;
6932 }
6933 if (!in_example && len > 0)
6934 {
6935 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6936 {
6937 /* blank-out a '>' in the last column (start of example) */
6938 line = ml_get_buf(curbuf, lnum, TRUE);
6939 line[len - 1] = ' ';
6940 in_example = TRUE;
6941 }
6942 else if (line[len - 1] == '~')
6943 {
6944 /* blank-out a '~' at the end of line (header marker) */
6945 line = ml_get_buf(curbuf, lnum, TRUE);
6946 line[len - 1] = ' ';
6947 }
6948 }
6949 }
6950 }
6951
6952 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006953 * In the "help.txt" and "help.abx" file, add the locally added help
6954 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006956 fname = gettail(curbuf->b_fname);
6957 if (fnamecmp(fname, "help.txt") == 0
6958#ifdef FEAT_MULTI_LANG
6959 || (fnamencmp(fname, "help.", 5) == 0
6960 && ASCII_ISALPHA(fname[5])
6961 && ASCII_ISALPHA(fname[6])
6962 && TOLOWER_ASC(fname[7]) == 'x'
6963 && fname[8] == NUL)
6964#endif
6965 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 {
6967 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6968 {
6969 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006970 if (strstr((char *)line, "*local-additions*") == NULL)
6971 continue;
6972
6973 /* Go through all directories in 'runtimepath', skipping
6974 * $VIMRUNTIME. */
6975 p = p_rtp;
6976 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006978 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6979 mustfree = FALSE;
6980 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006981 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006983 int fcount;
6984 char_u **fnames;
6985 FILE *fd;
6986 char_u *s;
6987 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006988 vimconv_T vc;
6989 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006991 /* Find all "doc/ *.txt" files in this directory. */
6992 add_pathsep(NameBuff);
6993#ifdef FEAT_MULTI_LANG
6994 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006996 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006998 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6999 &fnames, EW_FILE|EW_SILENT) == OK
7000 && fcount > 0)
7001 {
7002#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007003 int i1, i2;
7004 char_u *f1, *f2;
7005 char_u *t1, *t2;
7006 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007007
7008 /* If foo.abx is found use it instead of foo.txt in
7009 * the same directory. */
7010 for (i1 = 0; i1 < fcount; ++i1)
7011 {
7012 for (i2 = 0; i2 < fcount; ++i2)
7013 {
7014 if (i1 == i2)
7015 continue;
7016 if (fnames[i1] == NULL || fnames[i2] == NULL)
7017 continue;
7018 f1 = fnames[i1];
7019 f2 = fnames[i2];
7020 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007021 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007022 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007023 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02007024 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007025 continue;
7026 if (fnamecmp(e1, ".txt") != 0
7027 && fnamecmp(e1, fname + 4) != 0)
7028 {
7029 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007030 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007031 continue;
7032 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007033 if (e1 - f1 != e2 - f2
7034 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007035 continue;
7036 if (fnamecmp(e1, ".txt") == 0
7037 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007038 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007039 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007042#endif
7043 for (fi = 0; fi < fcount; ++fi)
7044 {
7045 if (fnames[fi] == NULL)
7046 continue;
7047 fd = mch_fopen((char *)fnames[fi], "r");
7048 if (fd != NULL)
7049 {
7050 vim_fgets(IObuff, IOSIZE, fd);
7051 if (IObuff[0] == '*'
7052 && (s = vim_strchr(IObuff + 1, '*'))
7053 != NULL)
7054 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007055 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01007056
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007057 /* Change tag definition to a
7058 * reference and remove <CR>/<NL>. */
7059 IObuff[0] = '|';
7060 *s = '|';
7061 while (*s != NUL)
7062 {
7063 if (*s == '\r' || *s == '\n')
7064 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007065 /* The text is utf-8 when a byte
7066 * above 127 is found and no
7067 * illegal byte sequence is found.
7068 */
7069 if (*s >= 0x80 && this_utf != FALSE)
7070 {
7071 int l;
7072
7073 this_utf = TRUE;
7074 l = utf_ptr2len(s);
7075 if (l == 1)
7076 this_utf = FALSE;
7077 s += l - 1;
7078 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007079 ++s;
7080 }
Bram Moolenaar13505972019-01-24 15:04:48 +01007081
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007082 /* The help file is latin1 or utf-8;
7083 * conversion to the current
7084 * 'encoding' may be required. */
7085 vc.vc_type = CONV_NONE;
7086 convert_setup(&vc, (char_u *)(
7087 this_utf == TRUE ? "utf-8"
7088 : "latin1"), p_enc);
7089 if (vc.vc_type == CONV_NONE)
7090 /* No conversion needed. */
7091 cp = IObuff;
7092 else
7093 {
7094 /* Do the conversion. If it fails
7095 * use the unconverted text. */
7096 cp = string_convert(&vc, IObuff,
7097 NULL);
7098 if (cp == NULL)
7099 cp = IObuff;
7100 }
7101 convert_setup(&vc, NULL, NULL);
7102
7103 ml_append(lnum, cp, (colnr_T)0, FALSE);
7104 if (cp != IObuff)
7105 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007106 ++lnum;
7107 }
7108 fclose(fd);
7109 }
7110 }
7111 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007114 if (mustfree)
7115 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007117 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 }
7119 }
7120}
7121
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007122/*
7123 * ":exusage"
7124 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007125 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007126ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007127{
7128 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7129}
7130
7131/*
7132 * ":viusage"
7133 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007134 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007135ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007136{
7137 do_cmdline_cmd((char_u *)"help normal-index");
7138}
7139
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007141 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007144helptags_one(
7145 char_u *dir, /* doc directory */
7146 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7147 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7148 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149{
7150 FILE *fd_tags;
7151 FILE *fd;
7152 garray_T ga;
7153 int filecount;
7154 char_u **files;
7155 char_u *p1, *p2;
7156 int fi;
7157 char_u *s;
7158 int i;
7159 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007160 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 int utf8 = MAYBE;
7162 int this_utf8;
7163 int firstline;
7164 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165
7166 /*
7167 * Find all *.txt files.
7168 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007169 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007171 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 STRCAT(NameBuff, ext);
7173 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7174 EW_FILE|EW_SILENT) == FAIL
7175 || filecount == 0)
7176 {
7177 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007178 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 return;
7180 }
7181
7182 /*
7183 * Open the tags file for writing.
7184 * Do this before scanning through all the files.
7185 */
7186 STRCPY(NameBuff, dir);
7187 add_pathsep(NameBuff);
7188 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007189 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 if (fd_tags == NULL)
7191 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007192 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 FreeWild(filecount, files);
7194 return;
7195 }
7196
7197 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007198 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7199 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 */
7201 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007202 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7203 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 {
7205 if (ga_grow(&ga, 1) == FAIL)
7206 got_int = TRUE;
7207 else
7208 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007209 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 if (s == NULL)
7211 got_int = TRUE;
7212 else
7213 {
7214 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7215 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7216 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 }
7218 }
7219 }
7220
7221 /*
7222 * Go over all the files and extract the tags.
7223 */
7224 for (fi = 0; fi < filecount && !got_int; ++fi)
7225 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007226 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 if (fd == NULL)
7228 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007229 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 continue;
7231 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007232 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7236 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 if (firstline)
7238 {
7239 /* Detect utf-8 file by a non-ASCII char in the first line. */
7240 this_utf8 = MAYBE;
7241 for (s = IObuff; *s != NUL; ++s)
7242 if (*s >= 0x80)
7243 {
7244 int l;
7245
7246 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007247 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 if (l == 1)
7249 {
7250 /* Illegal UTF-8 byte sequence. */
7251 this_utf8 = FALSE;
7252 break;
7253 }
7254 s += l - 1;
7255 }
7256 if (this_utf8 == MAYBE) /* only ASCII characters found */
7257 this_utf8 = FALSE;
7258 if (utf8 == MAYBE) /* first file */
7259 utf8 = this_utf8;
7260 else if (utf8 != this_utf8)
7261 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007262 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 mix = !got_int;
7264 got_int = TRUE;
7265 }
7266 firstline = FALSE;
7267 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7269 while (p1 != NULL)
7270 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007271 /* Use vim_strbyte() instead of vim_strchr() so that when
7272 * 'encoding' is dbcs it still works, don't find '*' in the
7273 * second byte. */
7274 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7276 {
7277 for (s = p1 + 1; s < p2; ++s)
7278 if (*s == ' ' || *s == '\t' || *s == '|')
7279 break;
7280
7281 /*
7282 * Only accept a *tag* when it consists of valid
7283 * characters, there is white space before it and is
7284 * followed by a white character or end-of-line.
7285 */
7286 if (s == p2
7287 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7288 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7289 || s[1] == '\0'))
7290 {
7291 *p2 = '\0';
7292 ++p1;
7293 if (ga_grow(&ga, 1) == FAIL)
7294 {
7295 got_int = TRUE;
7296 break;
7297 }
7298 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7299 if (s == NULL)
7300 {
7301 got_int = TRUE;
7302 break;
7303 }
7304 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7305 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 sprintf((char *)s, "%s\t%s", p1, fname);
7307
7308 /* find next '*' */
7309 p2 = vim_strchr(p2 + 1, '*');
7310 }
7311 }
7312 p1 = p2;
7313 }
7314 line_breakcheck();
7315 }
7316
7317 fclose(fd);
7318 }
7319
7320 FreeWild(filecount, files);
7321
7322 if (!got_int)
7323 {
7324 /*
7325 * Sort the tags.
7326 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007327 if (ga.ga_data != NULL)
7328 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
7330 /*
7331 * Check for duplicates.
7332 */
7333 for (i = 1; i < ga.ga_len; ++i)
7334 {
7335 p1 = ((char_u **)ga.ga_data)[i - 1];
7336 p2 = ((char_u **)ga.ga_data)[i];
7337 while (*p1 == *p2)
7338 {
7339 if (*p2 == '\t')
7340 {
7341 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007342 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7344 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007345 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 *p2 = '\t';
7347 break;
7348 }
7349 ++p1;
7350 ++p2;
7351 }
7352 }
7353
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 if (utf8 == TRUE)
7355 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356
7357 /*
7358 * Write the tags into the file.
7359 */
7360 for (i = 0; i < ga.ga_len; ++i)
7361 {
7362 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007363 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007365 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 else
7367 {
7368 fprintf(fd_tags, "%s\t/*", s);
7369 for (p1 = s; *p1 != '\t'; ++p1)
7370 {
7371 /* insert backslash before '\\' and '/' */
7372 if (*p1 == '\\' || *p1 == '/')
7373 putc('\\', fd_tags);
7374 putc(*p1, fd_tags);
7375 }
7376 fprintf(fd_tags, "*\n");
7377 }
7378 }
7379 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 if (mix)
7381 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382
7383 for (i = 0; i < ga.ga_len; ++i)
7384 vim_free(((char_u **)ga.ga_data)[i]);
7385 ga_clear(&ga);
7386 fclose(fd_tags); /* there is no check for an error... */
7387}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007389/*
7390 * Generate tags in one help directory, taking care of translations.
7391 */
7392 static void
7393do_helptags(char_u *dirname, int add_help_tags)
7394{
7395#ifdef FEAT_MULTI_LANG
7396 int len;
7397 int i, j;
7398 garray_T ga;
7399 char_u lang[2];
7400 char_u ext[5];
7401 char_u fname[8];
7402 int filecount;
7403 char_u **files;
7404
7405 /* Get a list of all files in the help directory and in subdirectories. */
7406 STRCPY(NameBuff, dirname);
7407 add_pathsep(NameBuff);
7408 STRCAT(NameBuff, "**");
7409 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7410 EW_FILE|EW_SILENT) == FAIL
7411 || filecount == 0)
7412 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007413 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007414 return;
7415 }
7416
7417 /* Go over all files in the directory to find out what languages are
7418 * present. */
7419 ga_init2(&ga, 1, 10);
7420 for (i = 0; i < filecount; ++i)
7421 {
7422 len = (int)STRLEN(files[i]);
7423 if (len > 4)
7424 {
7425 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7426 {
7427 /* ".txt" -> language "en" */
7428 lang[0] = 'e';
7429 lang[1] = 'n';
7430 }
7431 else if (files[i][len - 4] == '.'
7432 && ASCII_ISALPHA(files[i][len - 3])
7433 && ASCII_ISALPHA(files[i][len - 2])
7434 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7435 {
7436 /* ".abx" -> language "ab" */
7437 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7438 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7439 }
7440 else
7441 continue;
7442
7443 /* Did we find this language already? */
7444 for (j = 0; j < ga.ga_len; j += 2)
7445 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7446 break;
7447 if (j == ga.ga_len)
7448 {
7449 /* New language, add it. */
7450 if (ga_grow(&ga, 2) == FAIL)
7451 break;
7452 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7453 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7454 }
7455 }
7456 }
7457
7458 /*
7459 * Loop over the found languages to generate a tags file for each one.
7460 */
7461 for (j = 0; j < ga.ga_len; j += 2)
7462 {
7463 STRCPY(fname, "tags-xx");
7464 fname[5] = ((char_u *)ga.ga_data)[j];
7465 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7466 if (fname[5] == 'e' && fname[6] == 'n')
7467 {
7468 /* English is an exception: use ".txt" and "tags". */
7469 fname[4] = NUL;
7470 STRCPY(ext, ".txt");
7471 }
7472 else
7473 {
7474 /* Language "ab" uses ".abx" and "tags-ab". */
7475 STRCPY(ext, ".xxx");
7476 ext[1] = fname[5];
7477 ext[2] = fname[6];
7478 }
7479 helptags_one(dirname, ext, fname, add_help_tags);
7480 }
7481
7482 ga_clear(&ga);
7483 FreeWild(filecount, files);
7484
7485#else
7486 /* No language support, just use "*.txt" and "tags". */
7487 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7488#endif
7489}
7490
7491 static void
7492helptags_cb(char_u *fname, void *cookie)
7493{
7494 do_helptags(fname, *(int *)cookie);
7495}
7496
7497/*
7498 * ":helptags"
7499 */
7500 void
7501ex_helptags(exarg_T *eap)
7502{
7503 expand_T xpc;
7504 char_u *dirname;
7505 int add_help_tags = FALSE;
7506
7507 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007508 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007509 {
7510 add_help_tags = TRUE;
7511 eap->arg = skipwhite(eap->arg + 3);
7512 }
7513
7514 if (STRCMP(eap->arg, "ALL") == 0)
7515 {
7516 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7517 helptags_cb, &add_help_tags);
7518 }
7519 else
7520 {
7521 ExpandInit(&xpc);
7522 xpc.xp_context = EXPAND_DIRECTORIES;
7523 dirname = ExpandOne(&xpc, eap->arg, NULL,
7524 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7525 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007526 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007527 else
7528 do_helptags(dirname, add_help_tags);
7529 vim_free(dirname);
7530 }
7531}
7532
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007533/*
7534 * Make the user happy.
7535 */
7536 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007537ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007538{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007539 static char *code[] = {
7540 "\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$",
7541 "\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"
7542 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007543 char *p;
7544 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007545 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007546
7547 msg_start();
7548 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007549 for (i = 0; i < 2; ++i)
7550 for (p = code[i]; *p != NUL; ++p)
7551 if (*p == 'x')
7552 msg_putchar('\n');
7553 else
7554 for (n = *p++; n > 0; --n)
7555 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01007556 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007557 else
7558 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007559 msg_clr_eos();
7560}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562/*
7563 * ":drop"
7564 * Opens the first argument in a window. When there are two or more arguments
7565 * the argument list is redefined.
7566 */
7567 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007568ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569{
7570 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 win_T *wp;
7572 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007573 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574
7575 /*
7576 * Check if the first argument is already being edited in a window. If
7577 * so, jump to that window.
7578 * We would actually need to check all arguments, but that's complicated
7579 * and mostly only one file is dropped.
7580 * This also ignores wildcards, since it is very unlikely the user is
7581 * editing a file name with a wildcard character.
7582 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007583 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007585 /*
7586 * Expanding wildcards may result in an empty argument list. E.g. when
7587 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7588 * already did an error message for this.
7589 */
7590 if (ARGCOUNT == 0)
7591 return;
7592
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007593 if (cmdmod.tab)
7594 {
7595 /* ":tab drop file ...": open a tab for each argument that isn't
7596 * edited in a window yet. It's like ":tab all" but without closing
7597 * windows or tabs. */
7598 ex_all(eap);
7599 }
7600 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007601 {
7602 /* ":drop file ...": Edit the first argument. Jump to an existing
7603 * window if possible, edit in current window if the current buffer
7604 * can be abandoned, otherwise open a new window. */
7605 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7606
7607 FOR_ALL_TAB_WINDOWS(tp, wp)
7608 {
7609 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007611 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 return;
7614 }
7615 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007617 /*
7618 * Check whether the current buffer is changed. If so, we will need
7619 * to split the current window or data could be lost.
7620 * Skip the check if the 'hidden' option is set, as in this case the
7621 * buffer won't be lost.
7622 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02007623 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007624 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007625 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01007626 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007627 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007628 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007630 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7631 if (split)
7632 {
7633 eap->cmdidx = CMD_sfirst;
7634 eap->cmd[0] = 's';
7635 }
7636 else
7637 eap->cmdidx = CMD_first;
7638 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007641
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007642/*
7643 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
7644 * Put the start of the pattern in "*s", unless "s" is NULL.
7645 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
7646 * If "s" is not NULL terminate the pattern with a NUL.
7647 * Return a pointer to the char just past the pattern plus flags.
7648 */
7649 char_u *
7650skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
7651{
7652 int c;
7653
7654 if (vim_isIDc(*p))
7655 {
7656 /* ":vimgrep pattern fname" */
7657 if (s != NULL)
7658 *s = p;
7659 p = skiptowhite(p);
7660 if (s != NULL && *p != NUL)
7661 *p++ = NUL;
7662 }
7663 else
7664 {
7665 /* ":vimgrep /pattern/[g][j] fname" */
7666 if (s != NULL)
7667 *s = p + 1;
7668 c = *p;
7669 p = skip_regexp(p + 1, c, TRUE, NULL);
7670 if (*p != c)
7671 return NULL;
7672
7673 /* Truncate the pattern. */
7674 if (s != NULL)
7675 *p = NUL;
7676 ++p;
7677
7678 /* Find the flags */
7679 while (*p == 'g' || *p == 'j')
7680 {
7681 if (flags != NULL)
7682 {
7683 if (*p == 'g')
7684 *flags |= VGR_GLOBAL;
7685 else
7686 *flags |= VGR_NOJUMP;
7687 }
7688 ++p;
7689 }
7690 }
7691 return p;
7692}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007693
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007694#if defined(FEAT_EVAL) || defined(PROTO)
7695/*
7696 * List v:oldfiles in a nice way.
7697 */
7698 void
7699ex_oldfiles(exarg_T *eap UNUSED)
7700{
7701 list_T *l = get_vim_var_list(VV_OLDFILES);
7702 listitem_T *li;
7703 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007704 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007705
7706 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007707 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007708 else
7709 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007710 msg_start();
7711 msg_scroll = TRUE;
7712 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
7713 {
7714 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007715 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02007716 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007717 {
7718 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01007719 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007720 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02007721 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007722 msg_putchar('\n');
7723 out_flush(); /* output one line at a time */
7724 ui_breakcheck();
7725 }
7726 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007727
7728 /* Assume "got_int" was set to truncate the listing. */
7729 got_int = FALSE;
7730
7731# ifdef FEAT_BROWSE_CMD
7732 if (cmdmod.browse)
7733 {
7734 quit_more = FALSE;
7735 nr = prompt_for_number(FALSE);
7736 msg_starthere();
7737 if (nr > 0)
7738 {
7739 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
7740 (long)nr);
7741
7742 if (p != NULL)
7743 {
7744 p = expand_env_save(p);
7745 eap->arg = p;
7746 eap->cmdidx = CMD_edit;
7747 cmdmod.browse = FALSE;
7748 do_exedit(eap, NULL);
7749 vim_free(p);
7750 }
7751 }
7752 }
7753# endif
7754 }
7755}
7756#endif