blob: ebfcf54537fa6875bb68d738b1a97d2201c7c472 [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;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001540#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 int save_nwr;
1542#endif
1543#ifdef MSWIN
1544 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001545 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546#endif
1547
1548 /*
1549 * Disallow shell commands for "rvim".
1550 * Disallow shell commands from .exrc and .vimrc in current directory for
1551 * security reasons.
1552 */
1553 if (check_restricted() || check_secure())
1554 {
1555 msg_end();
1556 return;
1557 }
1558
1559#ifdef MSWIN
1560 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001561 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 */
1563 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001564 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1565
1566# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1567 // Don't stop termcap mode when using a terminal window for the shell.
1568 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1569 keep_termcap = TRUE;
1570# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571#endif
1572
1573 /*
1574 * For autocommands we want to get the output on the current screen, to
1575 * avoid having to type return below.
1576 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001577 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 {
1580#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001581 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582#endif
1583 stoptermcap();
1584 }
1585#ifdef MSWIN
1586 if (!winstart)
1587#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001588 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589
Bram Moolenaar049ca592019-03-17 16:59:44 +01001590 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001591 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001592 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001593 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 {
1595#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001596 if (!keep_termcap)
1597 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001599 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001601 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 stoptermcap();
1603#endif
1604 break;
1605 }
1606
Bram Moolenaar049ca592019-03-17 16:59:44 +01001607 // This windgoto is required for when the '\n' resulted in a "delete line
1608 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 if (!swapping_screen())
1610 windgoto(msg_row, msg_col);
1611 cursor_on();
1612 (void)call_shell(cmd, SHELL_COOKED | flags);
1613 did_check_timestamps = FALSE;
1614 need_check_timestamps = TRUE;
1615
1616 /*
1617 * put the message cursor at the end of the screen, avoids wait_return()
1618 * to overwrite the text that the external command showed
1619 */
1620 if (!swapping_screen())
1621 {
1622 msg_row = Rows - 1;
1623 msg_col = 0;
1624 }
1625
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 if (autocmd_busy)
1627 {
1628 if (msg_silent == 0)
1629 redraw_later_clear();
1630 }
1631 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 {
1633 /*
1634 * For ":sh" there is no need to call wait_return(), just redraw.
1635 * Also for the Win32 GUI (the output is in a console window).
1636 * Otherwise there is probably text on the screen that the user wants
1637 * to read before redrawing, so call wait_return().
1638 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001639#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1640# ifdef VIMDLL
1641 if (!gui.in_use)
1642# endif
1643 {
1644 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001645# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001646 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001648 )
1649 {
1650 if (msg_silent == 0)
1651 redraw_later_clear();
1652 need_wait_return = FALSE;
1653 }
1654 else
1655 {
1656 /*
1657 * If we switch screens when starttermcap() is called, we
1658 * really want to wait for "hit return to continue".
1659 */
1660 save_nwr = no_wait_return;
1661 if (swapping_screen())
1662 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001664 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001666 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001668 no_wait_return = save_nwr;
1669 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001671#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001674 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001676 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677
1678 /*
1679 * In an Amiga window redrawing is caused by asking the window size.
1680 * If we got an interrupt this will not work. The chance that the
1681 * window size is wrong is very small, but we need to redraw the
1682 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1683 * but it saves an extra redraw.
1684 */
1685#ifdef AMIGA
1686 if (skip_redraw) /* ':' hit in wait_return() */
1687 {
1688 if (msg_silent == 0)
1689 redraw_later_clear();
1690 }
1691 else if (term_console)
1692 {
1693 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1694 if (got_int && msg_silent == 0)
1695 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1696 else
1697 must_redraw = 0; /* no extra redraw needed */
1698 }
1699#endif
1700 }
1701
1702 /* display any error messages now */
1703 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001704
Bram Moolenaarade00832006-03-10 21:46:58 +00001705 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706}
1707
Bram Moolenaar06640892018-10-09 21:49:33 +02001708#if !defined(UNIX)
1709 static char_u *
1710find_pipe(char_u *cmd)
1711{
1712 char_u *p;
1713 int inquote = FALSE;
1714
1715 for (p = cmd; *p != NUL; ++p)
1716 {
1717 if (!inquote && *p == '|')
1718 return p;
1719 if (*p == '"')
1720 inquote = !inquote;
1721 else if (rem_backslash(p))
1722 ++p;
1723 }
1724 return NULL;
1725}
1726#endif
1727
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728/*
1729 * Create a shell command from a command string, input redirection file and
1730 * output redirection file.
1731 * Returns an allocated string with the shell command, or NULL for failure.
1732 */
1733 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001734make_filter_cmd(
1735 char_u *cmd, /* command */
1736 char_u *itmp, /* NULL or name of input file */
1737 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738{
1739 char_u *buf;
1740 long_u len;
1741
Bram Moolenaar53076832015-12-31 19:53:21 +01001742#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001743 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001744 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001745
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001746 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001747 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1748 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001749 if (is_fish_shell)
1750 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1751 else
1752#endif
1753 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 if (itmp != NULL)
1755 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1756 if (otmp != NULL)
1757 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1758 buf = lalloc(len, TRUE);
1759 if (buf == NULL)
1760 return NULL;
1761
Bram Moolenaar53076832015-12-31 19:53:21 +01001762#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001764 * Put braces around the command (for concatenated commands) when
1765 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001767 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001768 {
1769 if (is_fish_shell)
1770 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1771 else
1772 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1773 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001774 else
1775 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 if (itmp != NULL)
1777 {
1778 STRCAT(buf, " < ");
1779 STRCAT(buf, itmp);
1780 }
1781#else
1782 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001783 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 * the use of commands in a pipe.
1785 */
1786 STRCPY(buf, cmd);
1787 if (itmp != NULL)
1788 {
1789 char_u *p;
1790
1791 /*
1792 * If there is a pipe, we have to put the '<' in front of it.
1793 * Don't do this when 'shellquote' is not empty, otherwise the
1794 * redirection would be inside the quotes.
1795 */
1796 if (*p_shq == NUL)
1797 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001798 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 if (p != NULL)
1800 *p = NUL;
1801 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1803 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 if (*p_shq == NUL)
1805 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001806 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 if (p != NULL)
1808 {
1809 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1810 STRCAT(buf, p);
1811 }
1812 }
1813 }
1814#endif
1815 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001816 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 return buf;
1819}
1820
1821/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001822 * Append output redirection for file "fname" to the end of string buffer
1823 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 * Works with the 'shellredir' and 'shellpipe' options.
1825 * The caller should make sure that there is enough room:
1826 * STRLEN(opt) + STRLEN(fname) + 3
1827 */
1828 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001829append_redir(
1830 char_u *buf,
1831 int buflen,
1832 char_u *opt,
1833 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834{
1835 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001836 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001838 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001839 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001841 {
1842 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001844 if (p[1] == '%') /* skip %% */
1845 ++p;
1846 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 if (p != NULL)
1848 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001849 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1850 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1851 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 }
1853 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001854 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 " %s %s",
1857#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859#endif
1860 (char *)opt, (char *)fname);
1861}
1862
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001863#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001865static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001866static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001867static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868static int viminfo_errcnt;
1869
1870 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001871no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872{
1873 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001874 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875}
1876
1877/*
1878 * Report an error for reading a viminfo file.
1879 * Count the number of errors. When there are more than 10, return TRUE.
1880 */
1881 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001882viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001884 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1885 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001886 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001887 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1888 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001889 emsg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 if (++viminfo_errcnt >= 10)
1891 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001892 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 return TRUE;
1894 }
1895 return FALSE;
1896}
1897
1898/*
1899 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001900 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 */
1902 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001903read_viminfo(
1904 char_u *file, /* file name or NULL to use default name */
1905 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906{
1907 FILE *fp;
1908 char_u *fname;
1909
1910 if (no_viminfo())
1911 return FAIL;
1912
Bram Moolenaard812df62008-11-09 12:46:09 +00001913 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 if (fname == NULL)
1915 return FAIL;
1916 fp = mch_fopen((char *)fname, READBIN);
1917
1918 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001919 {
1920 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001921 smsg(_("Reading viminfo file \"%s\"%s%s%s"),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001922 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001923 (flags & VIF_WANT_INFO) ? _(" info") : "",
1924 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1925 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001926 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001927 verbose_leave();
1928 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929
1930 vim_free(fname);
1931 if (fp == NULL)
1932 return FAIL;
1933
1934 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001935 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936
1937 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 return OK;
1939}
1940
1941/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001942 * Write the viminfo file. The old one is read in first so that effectively a
1943 * merge of current info and old info is done. This allows multiple vims to
1944 * run simultaneously, without losing any marks etc.
1945 * If "forceit" is TRUE, then the old file is not read in, and only internal
1946 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 */
1948 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001949write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950{
1951 char_u *fname;
1952 FILE *fp_in = NULL; /* input viminfo file, if any */
1953 FILE *fp_out = NULL; /* output viminfo file */
1954 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001955 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956#if defined(UNIX) || defined(VMS)
1957 mode_t umask_save;
1958#endif
1959#ifdef UNIX
1960 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001961 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001963#ifdef MSWIN
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001964 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001965#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966
1967 if (no_viminfo())
1968 return;
1969
1970 fname = viminfo_filename(file); /* may set to default if NULL */
1971 if (fname == NULL)
1972 return;
1973
1974 fp_in = mch_fopen((char *)fname, READBIN);
1975 if (fp_in == NULL)
1976 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001977 int fd;
1978
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 /* if it does exist, but we can't read it, don't try writing */
1980 if (mch_stat((char *)fname, &st_new) == 0)
1981 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001982
1983 /* Create the new .viminfo non-accessible for others, because it may
1984 * contain text from non-accessible documents. It is up to the user to
1985 * widen access (e.g. to a group). This may also fail if there is a
1986 * race condition, then just give up. */
1987 fd = mch_open((char *)fname,
1988 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1989 if (fd < 0)
1990 goto end;
1991 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 }
1993 else
1994 {
1995 /*
1996 * There is an existing viminfo file. Create a temporary file to
1997 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001998 * existing viminfo file, which will be renamed once all writing is
1999 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 */
2001#ifdef UNIX
2002 /*
2003 * For Unix we check the owner of the file. It's not very nice to
2004 * overwrite a user's viminfo file after a "su root", with a
2005 * viminfo file that the user can't read.
2006 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00002007 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00002008 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00002010 if (mch_stat((char *)fname, &st_old) == 0
2011 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00002012 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 ? (st_old.st_mode & 0200)
2014 : (st_old.st_gid == getgid()
2015 ? (st_old.st_mode & 0020)
2016 : (st_old.st_mode & 0002))))
2017 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00002018 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002021 semsg(_("E137: Viminfo file is not writable: %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002023 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 goto end;
2025 }
2026#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002027#ifdef MSWIN
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002028 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01002029 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002030#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
2032 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002033 * Make tempname, find one that does not exist yet.
2034 * Beware of a race condition: If someone logs out and all Vim
2035 * instances exit at the same time a temp file might be created between
2036 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 * May try twice: Once normal and once with shortname set, just in
2038 * case somebody puts his viminfo file in an 8.3 filesystem.
2039 */
2040 for (;;)
2041 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002042 int next_char = 'z';
2043 char_u *wp;
2044
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 tempname = buf_modname(
2046#ifdef UNIX
2047 shortname,
2048#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050#endif
2051 fname,
2052#ifdef VMS
2053 (char_u *)"-tmp",
2054#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056#endif
2057 FALSE);
2058 if (tempname == NULL) /* out of memory */
2059 break;
2060
2061 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002062 * Try a series of names. Change one character, just before
2063 * the extension. This should also work for an 8.3
2064 * file name, when after adding the extension it still is
2065 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002067 wp = tempname + STRLEN(tempname) - 5;
2068 if (wp < gettail(tempname)) /* empty file name? */
2069 wp = gettail(tempname);
2070 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002072 /*
2073 * Check if tempfile already exists. Never overwrite an
2074 * existing file!
2075 */
2076 if (mch_stat((char *)tempname, &st_new) == 0)
2077 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002080 * Check if tempfile is same as original file. May happen
2081 * when modname() gave the same file back. E.g. silly
2082 * link, or file name-length reached. Try again with
2083 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002085 if (!shortname && st_new.st_dev == st_old.st_dev
2086 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01002088 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002089 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 break;
2091 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002092#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002094 else
2095 {
2096 /* Try creating the file exclusively. This may fail if
2097 * another Vim tries to do it at the same time. */
2098#ifdef VMS
2099 /* fdopen() fails for some reason */
2100 umask_save = umask(077);
2101 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2102 (void)umask(umask_save);
2103#else
2104 int fd;
2105
2106 /* Use mch_open() to be able to use O_NOFOLLOW and set file
2107 * protection:
2108 * Unix: same as original file, but strip s-bit. Reset
2109 * umask to avoid it getting in the way.
2110 * Others: r&w for user only. */
2111# ifdef UNIX
2112 umask_save = umask(0);
2113 fd = mch_open((char *)tempname,
2114 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
2115 (int)((st_old.st_mode & 0777) | 0600));
2116 (void)umask(umask_save);
2117# else
2118 fd = mch_open((char *)tempname,
2119 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
2120# endif
2121 if (fd < 0)
2122 {
2123 fp_out = NULL;
2124# ifdef EEXIST
2125 /* Avoid trying lots of names while the problem is lack
Bram Moolenaar94747162019-02-10 21:55:26 +01002126 * of permission, only retry if the file already
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002127 * exists. */
2128 if (errno != EEXIST)
2129 break;
2130# endif
2131 }
2132 else
2133 fp_out = fdopen(fd, WRITEBIN);
2134#endif /* VMS */
2135 if (fp_out != NULL)
2136 break;
2137 }
2138
2139 /* Assume file exists, try again with another name. */
2140 if (next_char == 'a' - 1)
2141 {
2142 /* They all exist? Must be something wrong! Don't write
2143 * the viminfo file then. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002144 semsg(_("E929: Too many viminfo temp files, like %s!"),
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002145 tempname);
2146 break;
2147 }
2148 *wp = next_char;
2149 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002151
2152 if (tempname != NULL)
2153 break;
2154 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 }
2156
Bram Moolenaara5792f52005-11-23 21:25:05 +00002157#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002158 if (tempname != NULL && fp_out != NULL)
2159 {
2160 stat_T tmp_st;
2161
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002163 * Make sure the original owner can read/write the tempfile and
2164 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002166 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002167 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002168 if (st_old.st_uid != tmp_st.st_uid)
2169 /* Changing the owner might fail, in which case the
2170 * file will now owned by the current user, oh well. */
Bram Moolenaar42335f52018-09-13 15:33:43 +02002171 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002172 if (st_old.st_gid != tmp_st.st_gid
2173 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2174 /* can't set the group to what it should be, remove
2175 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002176 (void)mch_setperm(tempname, 0600);
2177 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002178 else
2179 /* can't stat the file, set conservative permissions */
2180 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002182#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002183 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184
2185 /*
2186 * Check if the new viminfo file can be written to.
2187 */
2188 if (fp_out == NULL)
2189 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002190 semsg(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002191 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 if (fp_in != NULL)
2193 fclose(fp_in);
2194 goto end;
2195 }
2196
2197 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002198 {
2199 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002200 smsg(_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002201 verbose_leave();
2202 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203
2204 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002205 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206
Bram Moolenaar927030a2016-03-15 18:23:55 +01002207 if (fclose(fp_out) == EOF)
2208 ++viminfo_errcnt;
2209
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 if (fp_in != NULL)
2211 {
2212 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002213
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002214 /* In case of an error keep the original viminfo file. Otherwise
2215 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002216 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002217 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002218 if (vim_rename(tempname, fname) == -1)
2219 {
2220 ++viminfo_errcnt;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002221 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
Bram Moolenaar927030a2016-03-15 18:23:55 +01002222 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002223# ifdef MSWIN
Bram Moolenaar927030a2016-03-15 18:23:55 +01002224 /* If the viminfo file was hidden then also hide the new file. */
2225 else if (hidden)
2226 mch_hide(fname);
2227# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002228 }
2229 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 mch_remove(tempname);
2231 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002232
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233end:
2234 vim_free(fname);
2235 vim_free(tempname);
2236}
2237
2238/*
2239 * Get the viminfo file name to use.
2240 * If "file" is given and not empty, use it (has already been expanded by
2241 * cmdline functions).
2242 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2243 * expand environment variables.
2244 * Returns an allocated string. NULL when out of memory.
2245 */
2246 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002247viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248{
2249 if (file == NULL || *file == NUL)
2250 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002251 if (*p_viminfofile != NUL)
2252 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2254 {
2255#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256# ifdef VMS
2257 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2258# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002259# ifdef MSWIN
2260 /* Use $VIM only if $HOME is the default "C:/". */
2261 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2262 && mch_getenv((char_u *)"HOME") == NULL)
2263# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002265# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266# endif
2267 {
2268 /* don't use $VIM when not available. */
2269 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2270 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2271 file = (char_u *)VIMINFO_FILE2;
2272 else
2273 file = (char_u *)VIMINFO_FILE;
2274 }
2275 else
2276#endif
2277 file = (char_u *)VIMINFO_FILE;
2278 }
2279 expand_env(file, NameBuff, MAXPATHL);
2280 file = NameBuff;
2281 }
2282 return vim_strsave(file);
2283}
2284
2285/*
2286 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2287 */
2288 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002289do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 int eof = FALSE;
2292 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002293 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002294 int do_copy_marks = FALSE;
2295 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296
2297 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2298 return;
2299 vir.vir_fd = fp_in;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002301 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002302 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303
2304 if (fp_in != NULL)
2305 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002306 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002307 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002308 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002309 {
2310 /* Registers and marks are read and kept separate from what
2311 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002312 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002313 prepare_viminfo_marks();
2314 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002315
Bram Moolenaard812df62008-11-09 12:46:09 +00002316 eof = read_viminfo_up_to_marks(&vir,
2317 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002318 merge = TRUE;
2319 }
2320 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 /* Skip info, find start of marks */
2322 while (!(eof = viminfo_readline(&vir))
2323 && vir.vir_line[0] != '>')
2324 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002325
2326 do_copy_marks = (flags &
2327 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002329
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 if (fp_out != NULL)
2331 {
2332 /* Write the info: */
2333 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2334 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002335 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002336 write_viminfo_version(fp_out);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002337 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 write_viminfo_search_pattern(fp_out);
2340 write_viminfo_sub_string(fp_out);
2341#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002342 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343#endif
2344 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002345 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346#ifdef FEAT_EVAL
2347 write_viminfo_varlist(fp_out);
2348#endif
2349 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002350 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002352 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002353
2354 if (do_copy_marks)
2355 ga_init2(&buflist, sizeof(buf_T *), 50);
2356 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002358
2359 if (do_copy_marks)
2360 {
2361 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2362 if (fp_out != NULL)
2363 ga_clear(&buflist);
2364 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 vim_free(vir.vir_line);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 if (vir.vir_conv.vc_type != CONV_NONE)
2368 convert_setup(&vir.vir_conv, NULL, NULL);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002369 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370}
2371
2372/*
2373 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2374 * first part of the viminfo file which contains everything but the marks that
2375 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2376 */
2377 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002378read_viminfo_up_to_marks(
2379 vir_T *virp,
2380 int forceit,
2381 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382{
2383 int eof;
2384 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002385 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386
2387#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002388 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002390
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 eof = viminfo_readline(virp);
2392 while (!eof && virp->vir_line[0] != '>')
2393 {
2394 switch (virp->vir_line[0])
2395 {
2396 /* Characters reserved for future expansion, ignored now */
2397 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 case '^': /* to be defined */
2399 case '<': /* long line - ignored */
2400 /* A comment or empty line. */
2401 case NUL:
2402 case '\r':
2403 case '\n':
2404 case '#':
2405 eof = viminfo_readline(virp);
2406 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002407 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002408 eof = read_viminfo_barline(virp, got_encoding,
2409 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002410 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002412 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 eof = viminfo_encoding(virp);
2414 break;
2415 case '!': /* global variable */
2416#ifdef FEAT_EVAL
2417 eof = read_viminfo_varlist(virp, writing);
2418#else
2419 eof = viminfo_readline(virp);
2420#endif
2421 break;
2422 case '%': /* entry for buffer list */
2423 eof = read_viminfo_bufferlist(virp, writing);
2424 break;
2425 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002426 /* When registers are in bar lines skip the old style register
2427 * lines. */
2428 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2429 eof = read_viminfo_register(virp, forceit);
2430 else
2431 do {
2432 eof = viminfo_readline(virp);
2433 } while (!eof && (virp->vir_line[0] == TAB
2434 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 break;
2436 case '/': /* Search string */
2437 case '&': /* Substitute search string */
2438 case '~': /* Last search string, followed by '/' or '&' */
2439 eof = read_viminfo_search_pattern(virp, forceit);
2440 break;
2441 case '$':
2442 eof = read_viminfo_sub_string(virp, forceit);
2443 break;
2444 case ':':
2445 case '?':
2446 case '=':
2447 case '@':
2448#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002449 /* When history is in bar lines skip the old style history
2450 * lines. */
2451 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2452 eof = read_viminfo_history(virp, writing);
2453 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002455 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 break;
2457 case '-':
2458 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002459 /* When file marks are in bar lines skip the old style lines. */
2460 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2461 eof = read_viminfo_filemark(virp, forceit);
2462 else
2463 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 break;
2465 default:
2466 if (viminfo_error("E575: ", _("Illegal starting char"),
2467 virp->vir_line))
2468 eof = TRUE;
2469 else
2470 eof = viminfo_readline(virp);
2471 break;
2472 }
2473 }
2474
2475#ifdef FEAT_CMDHIST
2476 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002477 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002478 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479#endif
2480
2481 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002482 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 fmarks_check_names(buf);
2484
2485 return eof;
2486}
2487
2488/*
2489 * Compare the 'encoding' value in the viminfo file with the current value of
2490 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2491 * conversion of text with iconv() in viminfo_readstring().
2492 */
2493 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002494viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 char_u *p;
2497 int i;
2498
2499 if (get_viminfo_parameter('c') != 0)
2500 {
2501 p = vim_strchr(virp->vir_line, '=');
2502 if (p != NULL)
2503 {
2504 /* remove trailing newline */
2505 ++p;
2506 for (i = 0; vim_isprintc(p[i]); ++i)
2507 ;
2508 p[i] = NUL;
2509
2510 convert_setup(&virp->vir_conv, p, p_enc);
2511 }
2512 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 return viminfo_readline(virp);
2514}
2515
2516/*
2517 * Read a line from the viminfo file.
2518 * Returns TRUE for end-of-file;
2519 */
2520 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002521viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522{
2523 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2524}
2525
2526/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002527 * Check string read from viminfo file.
2528 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 * - replace CTRL-V CTRL-V with CTRL-V
2530 * - replace CTRL-V 'n' with '\n'
2531 *
2532 * Check for a long line as written by viminfo_writestring().
2533 *
2534 * Return the string in allocated memory (NULL when out of memory).
2535 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002537viminfo_readstring(
2538 vir_T *virp,
2539 int off, /* offset for virp->vir_line */
2540 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541{
2542 char_u *retval;
2543 char_u *s, *d;
2544 long len;
2545
2546 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2547 {
2548 len = atol((char *)virp->vir_line + off + 1);
2549 retval = lalloc(len, TRUE);
2550 if (retval == NULL)
2551 {
2552 /* Line too long? File messed up? Skip next line. */
2553 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2554 return NULL;
2555 }
2556 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2557 s = retval + 1; /* Skip the leading '<' */
2558 }
2559 else
2560 {
2561 retval = vim_strsave(virp->vir_line + off);
2562 if (retval == NULL)
2563 return NULL;
2564 s = retval;
2565 }
2566
2567 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2568 d = retval;
2569 while (*s != NUL && *s != '\n')
2570 {
2571 if (s[0] == Ctrl_V && s[1] != NUL)
2572 {
2573 if (s[1] == 'n')
2574 *d++ = '\n';
2575 else
2576 *d++ = Ctrl_V;
2577 s += 2;
2578 }
2579 else
2580 *d++ = *s++;
2581 }
2582 *d = NUL;
2583
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2585 {
2586 d = string_convert(&virp->vir_conv, retval, NULL);
2587 if (d != NULL)
2588 {
2589 vim_free(retval);
2590 retval = d;
2591 }
2592 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 return retval;
2595}
2596
2597/*
2598 * write string to viminfo file
2599 * - replace CTRL-V with CTRL-V CTRL-V
2600 * - replace '\n' with CTRL-V 'n'
2601 * - add a '\n' at the end
2602 *
2603 * For a long line:
2604 * - write " CTRL-V <length> \n " in first line
2605 * - write " < <string> \n " in second line
2606 */
2607 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002608viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609{
2610 int c;
2611 char_u *s;
2612 int len = 0;
2613
2614 for (s = p; *s != NUL; ++s)
2615 {
2616 if (*s == Ctrl_V || *s == '\n')
2617 ++len;
2618 ++len;
2619 }
2620
2621 /* If the string will be too long, write its length and put it in the next
2622 * line. Take into account that some room is needed for what comes before
2623 * the string (e.g., variable name). Add something to the length for the
2624 * '<', NL and trailing NUL. */
2625 if (len > LSIZE / 2)
2626 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2627
2628 while ((c = *p++) != NUL)
2629 {
2630 if (c == Ctrl_V || c == '\n')
2631 {
2632 putc(Ctrl_V, fd);
2633 if (c == '\n')
2634 c = 'n';
2635 }
2636 putc(c, fd);
2637 }
2638 putc('\n', fd);
2639}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002640
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002641/*
2642 * Write a string in quotes that barline_parse() can read back.
2643 * Breaks the line in less than LSIZE pieces when needed.
2644 * Returns remaining characters in the line.
2645 */
2646 int
2647barline_writestring(FILE *fd, char_u *s, int remaining_start)
2648{
2649 char_u *p;
2650 int remaining = remaining_start;
2651 int len = 2;
2652
2653 /* Count the number of characters produced, including quotes. */
2654 for (p = s; *p != NUL; ++p)
2655 {
2656 if (*p == NL)
2657 len += 2;
2658 else if (*p == '"' || *p == '\\')
2659 len += 2;
2660 else
2661 ++len;
2662 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002663 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002664 {
2665 fprintf(fd, ">%d\n|<", len);
2666 remaining = LSIZE - 20;
2667 }
2668
2669 putc('"', fd);
2670 for (p = s; *p != NUL; ++p)
2671 {
2672 if (*p == NL)
2673 {
2674 putc('\\', fd);
2675 putc('n', fd);
2676 --remaining;
2677 }
2678 else if (*p == '"' || *p == '\\')
2679 {
2680 putc('\\', fd);
2681 putc(*p, fd);
2682 --remaining;
2683 }
2684 else
2685 putc(*p, fd);
2686 --remaining;
2687
2688 if (remaining < 3)
2689 {
2690 putc('\n', fd);
2691 putc('|', fd);
2692 putc('<', fd);
2693 /* Leave enough space for another continuation. */
2694 remaining = LSIZE - 20;
2695 }
2696 }
2697 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002698 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002699}
2700
2701/*
2702 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002703 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002704 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002705 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002706 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002707barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002708{
2709 char_u *p = text;
2710 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002711 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002712 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002713 int i;
2714 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002715 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002716 char_u *sconv;
2717 int converted;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002718
2719 while (*p == ',')
2720 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002721 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002722 if (ga_grow(values, 1) == FAIL)
2723 break;
2724 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002725
2726 if (*p == '>')
2727 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002728 /* Need to read a continuation line. Put strings in allocated
2729 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002730 if (!allocated)
2731 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002732 for (i = 0; i < values->ga_len; ++i)
2733 {
2734 bval_T *vp = (bval_T *)(values->ga_data) + i;
2735
2736 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002738 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2739 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002740 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002741 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002742 allocated = TRUE;
2743 }
2744
2745 if (vim_isdigit(p[1]))
2746 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002747 size_t len;
2748 size_t todo;
2749 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002750
2751 /* String value was split into lines that are each shorter
2752 * than LSIZE:
2753 * |{bartype},>{length of "{text}{text2}"}
2754 * |<"{text1}
2755 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002756 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002757 */
2758 ++p;
2759 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002760 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002761 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002762 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002763 p = buf;
2764 for (todo = len; todo > 0; todo -= n)
2765 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002766 eof = viminfo_readline(virp);
2767 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002768 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002769 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002770 /* File was truncated or garbled. Read another line if
2771 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002772 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002773 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002774 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002775 /* Get length of text, excluding |< and NL chars. */
2776 n = STRLEN(virp->vir_line);
2777 while (n > 0 && (virp->vir_line[n - 1] == NL
2778 || virp->vir_line[n - 1] == CAR))
2779 --n;
2780 n -= 2;
2781 if (n > todo)
2782 {
2783 /* more values follow after the string */
2784 nextp = virp->vir_line + 2 + todo;
2785 n = todo;
2786 }
2787 mch_memmove(p, virp->vir_line + 2, n);
2788 p += n;
2789 }
2790 *p = NUL;
2791 p = buf;
2792 }
2793 else
2794 {
2795 /* Line ending in ">" continues in the next line:
2796 * |{bartype},{lots of values},>
2797 * |<{value},{value}
2798 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002799 eof = viminfo_readline(virp);
2800 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002801 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002802 /* File was truncated or garbled. Read another line if
2803 * this one starts with '|'. */
2804 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002805 p = virp->vir_line + 2;
2806 }
2807 }
2808
2809 if (isdigit(*p))
2810 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002811 value->bv_type = BVAL_NR;
2812 value->bv_nr = getdigits(&p);
2813 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002814 }
2815 else if (*p == '"')
2816 {
2817 int len = 0;
2818 char_u *s = p;
2819
2820 /* Unescape special characters in-place. */
2821 ++p;
2822 while (*p != '"')
2823 {
2824 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002825 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002826 if (*p == '\\')
2827 {
2828 ++p;
2829 if (*p == 'n')
2830 s[len++] = '\n';
2831 else
2832 s[len++] = *p;
2833 ++p;
2834 }
2835 else
2836 s[len++] = *p++;
2837 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002838 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002839 s[len] = NUL;
2840
Bram Moolenaar01227092016-06-11 14:47:40 +02002841 converted = FALSE;
2842 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2843 {
2844 sconv = string_convert(&virp->vir_conv, s, NULL);
2845 if (sconv != NULL)
2846 {
2847 if (s == buf)
2848 vim_free(s);
2849 s = sconv;
2850 buf = s;
2851 converted = TRUE;
2852 }
2853 }
Bram Moolenaar13505972019-01-24 15:04:48 +01002854
Bram Moolenaar01227092016-06-11 14:47:40 +02002855 /* Need to copy in allocated memory if the string wasn't allocated
2856 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002857 if (s != buf && allocated)
2858 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002859 value->bv_string = s;
2860 value->bv_type = BVAL_STRING;
2861 value->bv_len = len;
Bram Moolenaar13505972019-01-24 15:04:48 +01002862 value->bv_allocated = allocated || converted;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002863 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002864 if (nextp != NULL)
2865 {
2866 /* values following a long string */
2867 p = nextp;
2868 nextp = NULL;
2869 }
2870 }
2871 else if (*p == ',')
2872 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002873 value->bv_type = BVAL_EMPTY;
2874 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002875 }
2876 else
2877 break;
2878 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002879 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002880}
2881
2882 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002883read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002884{
2885 char_u *p = virp->vir_line + 1;
2886 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002887 garray_T values;
2888 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002889 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002890 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002891
2892 /* The format is: |{bartype},{value},...
2893 * For a very long string:
2894 * |{bartype},>{length of "{text}{text2}"}
2895 * |<{text1}
2896 * |<{text2},{value}
2897 * For a long line not using a string
2898 * |{bartype},{lots of values},>
2899 * |<{value},{value}
2900 */
2901 if (*p == '<')
2902 {
2903 /* Continuation line of an unrecognized item. */
2904 if (writing)
2905 ga_add_string(&virp->vir_barlines, virp->vir_line);
2906 }
2907 else
2908 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002909 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002910 bartype = getdigits(&p);
2911 switch (bartype)
2912 {
2913 case BARTYPE_VERSION:
2914 /* Only use the version when it comes before the encoding.
2915 * If it comes later it was copied by a Vim version that
2916 * doesn't understand the version. */
2917 if (!got_encoding)
2918 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002919 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002920 vp = (bval_T *)values.ga_data;
2921 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2922 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002923 }
2924 break;
2925
2926 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002927 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002928 handle_viminfo_history(&values, writing);
2929 break;
2930
2931 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002932 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002933 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002934 break;
2935
Bram Moolenaar2d358992016-06-12 21:20:54 +02002936 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002937 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002938 handle_viminfo_mark(&values, force);
2939 break;
2940
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002941 default:
2942 /* copy unrecognized line (for future use) */
2943 if (writing)
2944 ga_add_string(&virp->vir_barlines, virp->vir_line);
2945 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002946 for (i = 0; i < values.ga_len; ++i)
2947 {
2948 vp = (bval_T *)values.ga_data + i;
2949 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2950 vim_free(vp->bv_string);
2951 }
2952 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002953 }
2954
Bram Moolenaarecefe712016-06-20 12:50:17 +02002955 if (read_next)
2956 return viminfo_readline(virp);
2957 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002958}
2959
2960 static void
2961write_viminfo_version(FILE *fp_out)
2962{
2963 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2964 BARTYPE_VERSION, VIMINFO_VERSION);
2965}
2966
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002967 static void
2968write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2969{
2970 int i;
2971 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002972 int seen_useful = FALSE;
2973 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002974
2975 if (gap->ga_len > 0)
2976 {
2977 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2978
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002979 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002980 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002981 {
2982 line = ((char **)(gap->ga_data))[i];
2983 if (seen_useful || line[1] != '<')
2984 {
2985 fputs(line, fp_out);
2986 seen_useful = TRUE;
2987 }
2988 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002989 }
2990}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991#endif /* FEAT_VIMINFO */
2992
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002993/*
2994 * Return the current time in seconds. Calls time(), unless test_settime()
2995 * was used.
2996 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002997 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002998vim_time(void)
2999{
3000# ifdef FEAT_EVAL
3001 return time_for_testing == 0 ? time(NULL) : time_for_testing;
3002# else
3003 return time(NULL);
3004# endif
3005}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02003006
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007/*
3008 * Implementation of ":fixdel", also used by get_stty().
3009 * <BS> resulting <Del>
3010 * ^? ^H
3011 * not ^? ^?
3012 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003014do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015{
3016 char_u *p;
3017
3018 p = find_termcode((char_u *)"kb");
3019 add_termcode((char_u *)"kD", p != NULL
3020 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
3021}
3022
3023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003024print_line_no_prefix(
3025 linenr_T lnum,
3026 int use_number,
3027 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028{
Bram Moolenaar32526b32019-01-19 17:43:09 +01003029 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030
3031 if (curwin->w_p_nu || use_number)
3032 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01003033 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003034 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01003035 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003037 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038}
3039
3040/*
3041 * Print a text line. Also in silent mode ("ex -s").
3042 */
3043 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003044print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045{
3046 int save_silent = silent_mode;
3047
Bram Moolenaard29459b2016-08-26 22:29:11 +02003048 /* apply :filter /pat/ */
3049 if (message_filtered(ml_get(lnum)))
3050 return;
3051
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003053 silent_mode = FALSE;
3054 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
3055 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 if (save_silent)
3057 {
3058 msg_putchar('\n');
3059 cursor_on(); /* msg_start() switches it off */
3060 out_flush();
3061 silent_mode = save_silent;
3062 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00003063 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064}
3065
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003066 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003067rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003068{
3069 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02003070 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003071
Bram Moolenaar7e283842013-05-30 11:43:15 +02003072 buf = curbuf;
3073 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003074 /* buffer changed, don't change name now */
3075 if (buf != curbuf)
3076 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003077#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003078 if (aborting()) /* autocmds may abort script processing */
3079 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003080#endif
3081 /*
3082 * The name of the current buffer will be changed.
3083 * A new (unlisted) buffer entry needs to be made to hold the old file
3084 * name, which will become the alternate file name.
3085 * But don't set the alternate file name if the buffer didn't have a
3086 * name.
3087 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02003088 fname = curbuf->b_ffname;
3089 sfname = curbuf->b_sfname;
3090 xfname = curbuf->b_fname;
3091 curbuf->b_ffname = NULL;
3092 curbuf->b_sfname = NULL;
3093 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003094 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02003095 curbuf->b_ffname = fname;
3096 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003097 return FAIL;
3098 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02003099 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003100 if (xfname != NULL && *xfname != NUL)
3101 {
3102 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
3103 if (buf != NULL && !cmdmod.keepalt)
3104 curwin->w_alt_fnum = buf->b_fnum;
3105 }
3106 vim_free(fname);
3107 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02003108 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003109
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003110 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003111 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003112 return OK;
3113}
3114
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115/*
3116 * ":file[!] [fname]".
3117 */
3118 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003119ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003121 /* ":0file" removes the file name. Check for illegal uses ":3file",
3122 * "0file name", etc. */
3123 if (eap->addr_count > 0
3124 && (*eap->arg != NUL
3125 || eap->line2 > 0
3126 || eap->addr_count > 1))
3127 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003128 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003129 return;
3130 }
3131
3132 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003134 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02003136 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02003138
3139 // print file name if no argument or 'F' is not in 'shortmess'
3140 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01003141 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142}
3143
3144/*
3145 * ":update".
3146 */
3147 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003148ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149{
3150 if (curbufIsChanged())
3151 (void)do_write(eap);
3152}
3153
3154/*
3155 * ":write" and ":saveas".
3156 */
3157 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003158ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159{
Bram Moolenaarb7316892019-05-01 18:08:42 +02003160 if (eap->cmdidx == CMD_saveas)
3161 {
3162 // :saveas does not take a range, uses all lines.
3163 eap->line1 = 1;
3164 eap->line2 = curbuf->b_ml.ml_line_count;
3165 }
3166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 if (eap->usefilter) /* input lines to shell command */
3168 do_bang(1, eap, FALSE, TRUE, FALSE);
3169 else
3170 (void)do_write(eap);
3171}
3172
3173/*
3174 * write current buffer to file 'eap->arg'
3175 * if 'eap->append' is TRUE, append to the file
3176 *
3177 * if *eap->arg == NUL write to current file
3178 *
3179 * return FAIL for failure, OK otherwise
3180 */
3181 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003182do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183{
3184 int other;
3185 char_u *fname = NULL; /* init to shut up gcc */
3186 char_u *ffname;
3187 int retval = FAIL;
3188 char_u *free_fname = NULL;
3189#ifdef FEAT_BROWSE
3190 char_u *browse_file = NULL;
3191#endif
3192 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003193 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194
3195 if (not_writing()) /* check 'write' option */
3196 return FAIL;
3197
3198 ffname = eap->arg;
3199#ifdef FEAT_BROWSE
3200 if (cmdmod.browse)
3201 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003202 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 NULL, NULL, NULL, curbuf);
3204 if (browse_file == NULL)
3205 goto theend;
3206 ffname = browse_file;
3207 }
3208#endif
3209 if (*ffname == NUL)
3210 {
3211 if (eap->cmdidx == CMD_saveas)
3212 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003213 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 goto theend;
3215 }
3216 other = FALSE;
3217 }
3218 else
3219 {
3220 fname = ffname;
3221 free_fname = fix_fname(ffname);
3222 /*
3223 * When out-of-memory, keep unexpanded file name, because we MUST be
3224 * able to write the file in this situation.
3225 */
3226 if (free_fname != NULL)
3227 ffname = free_fname;
3228 other = otherfile(ffname);
3229 }
3230
3231 /*
3232 * If we have a new file, put its name in the list of alternate file names.
3233 */
3234 if (other)
3235 {
3236 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3237 || eap->cmdidx == CMD_saveas)
3238 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3239 else
3240 alt_buf = buflist_findname(ffname);
3241 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3242 {
3243 /* Overwriting a file that is loaded in another buffer is not a
3244 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003245 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 goto theend;
3247 }
3248 }
3249
3250 /*
3251 * Writing to the current file is not allowed in readonly mode
3252 * and a file name is required.
3253 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3254 */
3255 if (!other && (
3256#ifdef FEAT_QUICKFIX
3257 bt_dontwrite_msg(curbuf) ||
3258#endif
3259 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3260 goto theend;
3261
3262 if (!other)
3263 {
3264 ffname = curbuf->b_ffname;
3265 fname = curbuf->b_fname;
3266 /*
3267 * Not writing the whole file is only allowed with '!'.
3268 */
3269 if ( (eap->line1 != 1
3270 || eap->line2 != curbuf->b_ml.ml_line_count)
3271 && !eap->forceit
3272 && !eap->append
3273 && !p_wa)
3274 {
3275#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3276 if (p_confirm || cmdmod.confirm)
3277 {
3278 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3279 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3280 goto theend;
3281 eap->forceit = TRUE;
3282 }
3283 else
3284#endif
3285 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003286 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 goto theend;
3288 }
3289 }
3290 }
3291
3292 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3293 {
3294 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3295 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 buf_T *was_curbuf = curbuf;
3297
3298 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003299 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003300#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003302#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003304#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 {
3306 /* buffer changed, don't change name now */
3307 retval = FAIL;
3308 goto theend;
3309 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 /* Exchange the file names for the current and the alternate
3311 * buffer. This makes it look like we are now editing the buffer
3312 * under the new name. Must be done before buf_write(), because
3313 * if there is no file name and 'cpo' contains 'F', it will set
3314 * the file name. */
3315 fname = alt_buf->b_fname;
3316 alt_buf->b_fname = curbuf->b_fname;
3317 curbuf->b_fname = fname;
3318 fname = alt_buf->b_ffname;
3319 alt_buf->b_ffname = curbuf->b_ffname;
3320 curbuf->b_ffname = fname;
3321 fname = alt_buf->b_sfname;
3322 alt_buf->b_sfname = curbuf->b_sfname;
3323 curbuf->b_sfname = fname;
3324 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003325
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003327 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 if (!alt_buf->b_p_bl)
3329 {
3330 alt_buf->b_p_bl = TRUE;
3331 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3332 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003333#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003335#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003337#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 {
3339 /* buffer changed, don't write the file */
3340 retval = FAIL;
3341 goto theend;
3342 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003343
3344 /* If 'filetype' was empty try detecting it now. */
3345 if (*curbuf->b_p_ft == NUL)
3346 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003347 if (au_has_group((char_u *)"filetypedetect"))
3348 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003349 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003350 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003351 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003352
3353 /* Autocommands may have changed buffer names, esp. when
3354 * 'autochdir' is set. */
3355 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 }
3357
Bram Moolenaar5c719942016-07-09 23:40:45 +02003358 name_was_missing = curbuf->b_ffname == NULL;
3359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3361 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003362
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003363 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003364 if (eap->cmdidx == CMD_saveas)
3365 {
3366 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003367 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003368 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003369 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003370 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003371 }
3372
3373 /* Change directories when the 'acd' option is set and the file name
3374 * got changed or set. */
3375 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02003376 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 }
3378
3379theend:
3380#ifdef FEAT_BROWSE
3381 vim_free(browse_file);
3382#endif
3383 vim_free(free_fname);
3384 return retval;
3385}
3386
3387/*
3388 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3389 * BF_NEW or BF_READERR, check for overwriting current file.
3390 * May set eap->forceit if a dialog says it's OK to overwrite.
3391 * Return OK if it's OK, FAIL if it is not.
3392 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003393 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003394check_overwrite(
3395 exarg_T *eap,
3396 buf_T *buf,
3397 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003399 char_u *ffname, /* full path version of fname */
3400 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401{
3402 /*
3403 * write to other file or b_flags set or not writing the whole file:
3404 * overwriting only allowed with '!'
3405 */
3406 if ( (other
3407 || (buf->b_flags & BF_NOTEDITED)
3408 || ((buf->b_flags & BF_NEW)
3409 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3410 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003412#ifdef FEAT_QUICKFIX
3413 && !bt_nofile(buf)
3414#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 && vim_fexists(ffname))
3416 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003417 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003419#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003420 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003421 if (mch_isdir(ffname))
3422 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003423 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003424 return FAIL;
3425 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426#endif
3427#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003428 if (p_confirm || cmdmod.confirm)
3429 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003430 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003432 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3433 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3434 return FAIL;
3435 eap->forceit = TRUE;
3436 }
3437 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003439 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003440 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003441 return FAIL;
3442 }
3443 }
3444
3445 /* For ":w! filename" check that no swap file exists for "filename". */
3446 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003448 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003449 char_u *p;
3450 int r;
3451 char_u *swapname;
3452
3453 /* We only try the first entry in 'directory', without checking if
3454 * it's writable. If the "." directory is not writable the write
3455 * will probably fail anyway.
3456 * Use 'shortname' of the current buffer, since there is no buffer
3457 * for the written file. */
3458 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003459 {
3460 dir = alloc(5);
3461 if (dir == NULL)
3462 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003463 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003464 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003465 else
3466 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003467 dir = alloc(MAXPATHL);
3468 if (dir == NULL)
3469 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003470 p = p_dir;
3471 copy_option_part(&p, dir, MAXPATHL, ",");
3472 }
3473 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003474 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003475 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003476 if (r)
3477 {
3478#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3479 if (p_confirm || cmdmod.confirm)
3480 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003481 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003482
3483 dialog_msg(buff,
3484 _("Swap file \"%s\" exists, overwrite anyway?"),
3485 swapname);
3486 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3487 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003488 {
3489 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003490 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003491 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003492 eap->forceit = TRUE;
3493 }
3494 else
3495#endif
3496 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003497 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003498 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003499 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003500 return FAIL;
3501 }
3502 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003503 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 }
3505 }
3506 return OK;
3507}
3508
3509/*
3510 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3511 */
3512 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003513ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514{
3515 int i;
3516
3517 if (eap->cmd[1] == 'n')
3518 i = curwin->w_arg_idx + (int)eap->line2;
3519 else
3520 i = curwin->w_arg_idx - (int)eap->line2;
3521 eap->line1 = 1;
3522 eap->line2 = curbuf->b_ml.ml_line_count;
3523 if (do_write(eap) != FAIL)
3524 do_argfile(eap, i);
3525}
3526
3527/*
3528 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3529 */
3530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003531do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532{
3533 buf_T *buf;
3534 int error = 0;
3535 int save_forceit = eap->forceit;
3536
3537 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3538 exiting = TRUE;
3539
Bram Moolenaar29323592016-07-24 22:04:11 +02003540 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003542#ifdef FEAT_TERMINAL
3543 if (exiting && term_job_running(buf->b_term))
3544 {
3545 no_write_message_nobang(buf);
3546 ++error;
3547 }
3548 else
3549#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003550 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 {
3552 /*
3553 * Check if there is a reason the buffer cannot be written:
3554 * 1. if the 'write' option is set
3555 * 2. if there is no file name (even after browsing)
3556 * 3. if the 'readonly' is set (even after a dialog)
3557 * 4. if overwriting is allowed (even after a dialog)
3558 */
3559 if (not_writing())
3560 {
3561 ++error;
3562 break;
3563 }
3564#ifdef FEAT_BROWSE
3565 /* ":browse wall": ask for file name if there isn't one */
3566 if (buf->b_ffname == NULL && cmdmod.browse)
3567 browse_save_fname(buf);
3568#endif
3569 if (buf->b_ffname == NULL)
3570 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003571 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 ++error;
3573 }
3574 else if (check_readonly(&eap->forceit, buf)
3575 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3576 FALSE) == FAIL)
3577 {
3578 ++error;
3579 }
3580 else
3581 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003582 bufref_T bufref;
3583
3584 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 if (buf_write_all(buf, eap->forceit) == FAIL)
3586 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003588 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 }
3591 eap->forceit = save_forceit; /* check_overwrite() may set it */
3592 }
3593 }
3594 if (exiting)
3595 {
3596 if (!error)
3597 getout(0); /* exit Vim */
3598 not_exiting();
3599 }
3600}
3601
3602/*
3603 * Check the 'write' option.
3604 * Return TRUE and give a message when it's not st.
3605 */
3606 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003607not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608{
3609 if (p_write)
3610 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003611 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 return TRUE;
3613}
3614
3615/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003616 * Check if a buffer is read-only (either 'readonly' option is set or file is
3617 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3618 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 */
3620 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003621check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003623 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003624
3625 /* Handle a file being readonly when the 'readonly' option is set or when
3626 * the file exists and permissions are read-only.
3627 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3628 * important for device checks but not here. */
3629 if (!*forceit && (buf->b_p_ro
3630 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3631 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 {
3633#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3634 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3635 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003636 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
Bram Moolenaar5386a122007-06-28 20:02:32 +00003638 if (buf->b_p_ro)
3639 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3640 buf->b_fname);
3641 else
3642 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 +00003643 buf->b_fname);
3644
3645 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3646 {
3647 /* Set forceit, to force the writing of a readonly file */
3648 *forceit = TRUE;
3649 return FALSE;
3650 }
3651 else
3652 return TRUE;
3653 }
3654 else
3655#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003656 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003657 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003658 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003659 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00003660 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 return TRUE;
3662 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003663
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 return FALSE;
3665}
3666
3667/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003668 * Try to abandon the current file and edit a new or existing file.
3669 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003670 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003672 * Return:
3673 * GETFILE_ERROR for "normal" error,
3674 * GETFILE_NOT_WRITTEN for "not written" error,
3675 * GETFILE_SAME_FILE for success
3676 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 */
3678 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003679getfile(
3680 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003681 char_u *ffname_arg,
3682 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003683 int setpm,
3684 linenr_T lnum,
3685 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003687 char_u *ffname = ffname_arg;
3688 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 int other;
3690 int retval;
3691 char_u *free_me = NULL;
3692
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003693 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003694 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003695 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003696 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697
3698 if (fnum == 0)
3699 {
3700 /* make ffname full path, set sfname */
3701 fname_expand(curbuf, &ffname, &sfname);
3702 other = otherfile(ffname);
3703 free_me = ffname; /* has been allocated, free() later */
3704 }
3705 else
3706 other = (fnum != curbuf->b_fnum);
3707
3708 if (other)
3709 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003710 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3712 {
3713#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3714 if (p_confirm && p_write)
3715 dialog_changed(curbuf, FALSE);
3716 if (curbufIsChanged())
3717#endif
3718 {
3719 if (other)
3720 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003721 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003722 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 goto theend;
3724 }
3725 }
3726 if (other)
3727 --no_wait_return;
3728 if (setpm)
3729 setpcmark();
3730 if (!other)
3731 {
3732 if (lnum != 0)
3733 curwin->w_cursor.lnum = lnum;
3734 check_cursor_lnum();
3735 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003736 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 }
3738 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003739 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003740 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003741 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003743 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
3745theend:
3746 vim_free(free_me);
3747 return retval;
3748}
3749
3750/*
3751 * start editing a new file
3752 *
3753 * fnum: file number; if zero use ffname/sfname
3754 * ffname: the file name
3755 * - full path if sfname used,
3756 * - any file name if sfname is NULL
3757 * - empty string to re-edit with the same file name (but may be
3758 * in a different directory)
3759 * - NULL to start an empty buffer
3760 * sfname: the short file name (or NULL)
3761 * eap: contains the command to be executed after loading the file and
3762 * forced 'ff' and 'fenc'
3763 * newlnum: if > 0: put cursor on this line number (if possible)
3764 * if ECMD_LASTL: use last position in loaded file
3765 * if ECMD_LAST: use last position in all files
3766 * if ECMD_ONE: use first line
3767 * flags:
3768 * ECMD_HIDE: if TRUE don't free the current buffer
3769 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3770 * ECMD_OLDBUF: use existing buffer if it exists
3771 * ECMD_FORCEIT: ! used for Ex command
3772 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003773 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003774 * window, NULL when splitting the window first. When not NULL info
3775 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 *
3777 * return FAIL for failure, OK otherwise
3778 */
3779 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003780do_ecmd(
3781 int fnum,
3782 char_u *ffname,
3783 char_u *sfname,
3784 exarg_T *eap, /* can be NULL! */
3785 linenr_T newlnum,
3786 int flags,
3787 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788{
3789 int other_file; /* TRUE if editing another file */
3790 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 int auto_buf = FALSE; /* TRUE if autocommands brought us
3792 into the buffer unexpectedly */
3793 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003794#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003795 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796#endif
3797 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003798 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003799 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 char_u *free_fname = NULL;
3801#ifdef FEAT_BROWSE
3802 char_u *browse_file = NULL;
3803#endif
3804 int retval = FAIL;
3805 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003806 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 linenr_T topline = 0;
3808 int newcol = -1;
3809 int solcol = -1;
3810 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003812#ifdef FEAT_SPELL
3813 int did_get_winopts = FALSE;
3814#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003815 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003816 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003817 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818
3819 if (eap != NULL)
3820 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003821 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822
3823 if (fnum != 0)
3824 {
3825 if (fnum == curbuf->b_fnum) /* file is already being edited */
3826 return OK; /* nothing to do */
3827 other_file = TRUE;
3828 }
3829 else
3830 {
3831#ifdef FEAT_BROWSE
3832 if (cmdmod.browse)
3833 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003834 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003835# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003836 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003837# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003838 au_has_group((char_u *)"FileExplorer"))
3839 {
3840 /* No browsing supported but we do have the file explorer:
3841 * Edit the directory. */
3842 if (ffname == NULL || !mch_isdir(ffname))
3843 ffname = (char_u *)".";
3844 }
3845 else
3846 {
3847 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003849 if (browse_file == NULL)
3850 goto theend;
3851 ffname = browse_file;
3852 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 }
3854#endif
3855 /* if no short name given, use ffname for short name */
3856 if (sfname == NULL)
3857 sfname = ffname;
3858#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01003859 if (sfname != NULL)
3860 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861#endif
3862
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3864 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865
3866 if (ffname == NULL)
3867 other_file = TRUE;
3868 /* there is no file name */
3869 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3870 other_file = FALSE;
3871 else
3872 {
3873 if (*ffname == NUL) /* re-edit with same file name */
3874 {
3875 ffname = curbuf->b_ffname;
3876 sfname = curbuf->b_fname;
3877 }
3878 free_fname = fix_fname(ffname); /* may expand to full path name */
3879 if (free_fname != NULL)
3880 ffname = free_fname;
3881 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 }
3883 }
3884
3885 /*
3886 * if the file was changed we may not be allowed to abandon it
3887 * - if we are going to re-edit the same file
3888 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3889 */
3890 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3891 || (curbuf->b_nwindows == 1
3892 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003893 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3894 | (other_file ? 0 : CCGD_MULTWIN)
3895 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3896 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 {
3898 if (fnum == 0 && other_file && ffname != NULL)
3899 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3900 goto theend;
3901 }
3902
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 /*
3904 * End Visual mode before switching to another buffer, so the text can be
3905 * copied into the GUI selection buffer.
3906 */
3907 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003909#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003910 if ((command != NULL || newlnum > (linenr_T)0)
3911 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3912 {
3913 int len;
3914 char_u *p;
3915
3916 /* Set v:swapcommand for the SwapExists autocommands. */
3917 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003918 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003919 else
3920 len = 30;
3921 p = alloc((unsigned)len);
3922 if (p != NULL)
3923 {
3924 if (command != NULL)
3925 vim_snprintf((char *)p, len, ":%s\r", command);
3926 else
3927 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3928 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3929 did_set_swapcommand = TRUE;
3930 vim_free(p);
3931 }
3932 }
3933#endif
3934
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 /*
3936 * If we are starting to edit another file, open a (new) buffer.
3937 * Otherwise we re-use the current buffer.
3938 */
3939 if (other_file)
3940 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003943 if (!cmdmod.keepalt)
3944 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003945 if (oldwin != NULL)
3946 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 }
3948
3949 if (fnum)
3950 buf = buflist_findnr(fnum);
3951 else
3952 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 if (flags & ECMD_ADDBUF)
3954 {
3955 linenr_T tlnum = 1L;
3956
3957 if (command != NULL)
3958 {
3959 tlnum = atol((char *)command);
3960 if (tlnum <= 0)
3961 tlnum = 1L;
3962 }
3963 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3964 goto theend;
3965 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 buf = buflist_new(ffname, sfname, 0L,
3967 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003968
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003969 /* autocommands may change curwin and curbuf */
3970 if (oldwin != NULL)
3971 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003972 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 }
3974 if (buf == NULL)
3975 goto theend;
3976 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3977 {
3978 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 }
3980 else /* existing memfile */
3981 {
3982 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003983 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003985 /* Check if autocommands made the buffer invalid or changed the
3986 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003987 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 goto theend;
3989#ifdef FEAT_EVAL
3990 if (aborting()) /* autocmds may abort script processing */
3991 goto theend;
3992#endif
3993 }
3994
3995 /* May jump to last used line number for a loaded buffer or when asked
3996 * for explicitly */
3997 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3998 {
3999 pos = buflist_findfpos(buf);
4000 newlnum = pos->lnum;
4001 solcol = pos->col;
4002 }
4003
4004 /*
4005 * Make the (new) buffer the one used by the current window.
4006 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
4007 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01004008 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 */
4010 if (buf != curbuf)
4011 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 /*
4013 * Be careful: The autocommands may delete any buffer and change
4014 * the current buffer.
4015 * - If the buffer we are going to edit is deleted, give up.
4016 * - If the current buffer is deleted, prefer to load the new
4017 * buffer when loading a buffer is required. This avoids
4018 * loading another buffer which then must be closed again.
4019 * - If we ended up in the new buffer already, need to skip a few
4020 * things, set auto_buf.
4021 */
4022 if (buf->b_fname != NULL)
4023 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004024 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004026 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004028 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 delbuf_msg(new_name); /* frees new_name */
4030 goto theend;
4031 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004032#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 if (aborting()) /* autocmds may abort script processing */
4034 {
4035 vim_free(new_name);
4036 goto theend;
4037 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004038#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 if (buf == curbuf) /* already in new buffer */
4040 auto_buf = TRUE;
4041 else
4042 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02004043 win_T *the_curwin = curwin;
4044
4045 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004046 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02004047 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004048 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02004049
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004050 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 buf_copy_options(buf, BCO_ENTER);
4052
Bram Moolenaar5a497892016-09-03 16:29:04 +02004053 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02004054 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004055 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00004056 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01004057 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058
Bram Moolenaar5a497892016-09-03 16:29:04 +02004059 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004060 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01004061
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004062#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02004063 /* autocmds may abort script processing */
4064 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 {
4066 vim_free(new_name);
4067 goto theend;
4068 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004069#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004071 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004073 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 delbuf_msg(new_name); /* frees new_name */
4075 goto theend;
4076 }
4077 if (buf == curbuf) /* already in new buffer */
4078 auto_buf = TRUE;
4079 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02004081#ifdef FEAT_SYN_HL
4082 /*
4083 * <VN> We could instead free the synblock
4084 * and re-attach to buffer, perhaps.
4085 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02004086 if (curwin->w_buffer == NULL
4087 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02004088 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02004089#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 curwin->w_buffer = buf;
4091 curbuf = buf;
4092 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02004093
4094 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
4095 if (!oldbuf && eap != NULL)
4096 {
4097 set_file_options(TRUE, eap);
4098 set_forced_fenc(eap);
4099 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 }
4101
4102 /* May get the window options from the last time this buffer
4103 * was in this window (or another window). If not used
4104 * before, reset the local window options to the global
4105 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004106 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004107#ifdef FEAT_SPELL
4108 did_get_winopts = TRUE;
4109#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 }
4111 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004112 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004113 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115
4116 curwin->w_pcmark.lnum = 1;
4117 curwin->w_pcmark.col = 0;
4118 }
4119 else /* !other_file */
4120 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02004121 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004123
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 oldbuf = (flags & ECMD_OLDBUF);
4125 }
4126
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004127 /* Don't redraw until the cursor is in the right line, otherwise
4128 * autocommands may cause ml_get errors. */
4129 ++RedrawingDisabled;
4130 did_inc_redrawing_disabled = TRUE;
4131
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004132 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4134 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004135 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 }
4137 else
4138 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 /* Don't make a buffer listed if it's a help buffer. Useful when
4140 * using CTRL-O to go back to a help file. */
4141 if (!curbuf->b_help)
4142 set_buflisted(TRUE);
4143 }
4144
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 /* If autocommands change buffers under our fingers, forget about
4146 * editing the file. */
4147 if (buf != curbuf)
4148 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004149#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 if (aborting()) /* autocmds may abort script processing */
4151 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004152#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153
4154 /* Since we are starting to edit a file, consider the filetype to be
4155 * unset. Helps for when an autocommand changes files and expects syntax
4156 * highlighting to work in the other file. */
4157 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158
4159/*
4160 * other_file oldbuf
4161 * FALSE FALSE re-edit same file, buffer is re-used
4162 * FALSE TRUE re-edit same file, nothing changes
4163 * TRUE FALSE start editing new file, new buffer
4164 * TRUE TRUE start editing in existing buffer (nothing to do)
4165 */
4166 if (!other_file && !oldbuf) /* re-use the buffer */
4167 {
4168 set_last_cursor(curwin); /* may set b_last_cursor */
4169 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4170 {
4171 newlnum = curwin->w_cursor.lnum;
4172 solcol = curwin->w_cursor.col;
4173 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 buf = curbuf;
4175 if (buf->b_fname != NULL)
4176 new_name = vim_strsave(buf->b_fname);
4177 else
4178 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004179 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004180
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004181 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4182 {
4183 /* Save all the text, so that the reload can be undone.
4184 * Sync first so that this is a separate undo-able action. */
4185 u_sync(FALSE);
4186 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4187 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004188 {
4189 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004190 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004191 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004192 u_unchanged(curbuf);
4193 buf_freeall(curbuf, BFA_KEEP_UNDO);
4194
4195 /* tell readfile() not to clear or reload undo info */
4196 readfile_flags = READ_KEEP_UNDO;
4197 }
4198 else
4199 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004200
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 /* If autocommands deleted the buffer we were going to re-edit, give
4202 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004203 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 {
4205 delbuf_msg(new_name); /* frees new_name */
4206 goto theend;
4207 }
4208 vim_free(new_name);
4209
4210 /* If autocommands change buffers under our fingers, forget about
4211 * re-editing the file. Should do the buf_clear_file(), but perhaps
4212 * the autocommands changed the buffer... */
4213 if (buf != curbuf)
4214 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004215#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 if (aborting()) /* autocmds may abort script processing */
4217 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218#endif
4219 buf_clear_file(curbuf);
4220 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4221 curbuf->b_op_end.lnum = 0;
4222 }
4223
4224/*
4225 * If we get here we are sure to start editing
4226 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 /* Assume success now */
4228 retval = OK;
4229
4230 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 * Check if we are editing the w_arg_idx file in the argument list.
4232 */
4233 check_arg_idx(curwin);
4234
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 {
4237 /*
4238 * Set cursor and init window before reading the file and executing
4239 * autocommands. This allows for the autocommands to position the
4240 * cursor.
4241 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004242 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243
4244#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004245 /* It's possible that all lines in the buffer changed. Need to update
4246 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004247 {
4248 win_T *win;
4249 tabpage_T *tp;
4250
4251 FOR_ALL_TAB_WINDOWS(tp, win)
4252 if (win->w_buffer == curbuf)
4253 foldUpdateAll(win);
4254 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255#endif
4256
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004257 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02004258 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004259
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 /*
4261 * Careful: open_buffer() and apply_autocmds() may change the current
4262 * buffer and window.
4263 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004264 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 topline = curwin->w_topline;
4266 if (!oldbuf) /* need to read the file */
4267 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 swap_exists_action = SEA_DIALOG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4270
4271 /*
4272 * Open the buffer and read the file.
4273 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004274#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004275 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 retval = FAIL;
4277#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004278 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279#endif
4280
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 if (swap_exists_action == SEA_QUIT)
4282 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004283 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 else
4286 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004287 /* Read the modelines, but only to set window-local options. Any
4288 * buffer-local options have already been set and may have been
4289 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004290 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004291
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4293 &retval);
4294 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4295 &retval);
4296 }
4297 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298
Bram Moolenaareab316b2015-03-24 11:46:30 +01004299 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004300 * keep it. Also when it moves within a line. But not when it moves
4301 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004302 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004304 char_u *text = ml_get_curline();
4305
4306 if (curwin->w_cursor.lnum != orig_pos.lnum
4307 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
4308 {
4309 newlnum = curwin->w_cursor.lnum;
4310 newcol = curwin->w_cursor.col;
4311 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 }
4313 if (curwin->w_topline == topline)
4314 topline = 0;
4315
4316 /* Even when cursor didn't move we need to recompute topline. */
4317 changed_line_abv_curs();
4318
4319#ifdef FEAT_TITLE
4320 maketitle();
4321#endif
4322 }
4323
4324#ifdef FEAT_DIFF
4325 /* Tell the diff stuff that this buffer is new and/or needs updating.
4326 * Also needed when re-editing the same buffer, because unloading will
4327 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004328 if (curwin->w_p_diff)
4329 {
4330 diff_buf_add(curbuf);
4331 diff_invalidate(curbuf);
4332 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333#endif
4334
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004335#ifdef FEAT_SPELL
4336 /* If the window options were changed may need to set the spell language.
4337 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004338 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4339 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004340#endif
4341
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 if (command == NULL)
4343 {
4344 if (newcol >= 0) /* position set by autocommands */
4345 {
4346 curwin->w_cursor.lnum = newlnum;
4347 curwin->w_cursor.col = newcol;
4348 check_cursor();
4349 }
4350 else if (newlnum > 0) /* line number from caller or old position */
4351 {
4352 curwin->w_cursor.lnum = newlnum;
4353 check_cursor_lnum();
4354 if (solcol >= 0 && !p_sol)
4355 {
4356 /* 'sol' is off: Use last known column. */
4357 curwin->w_cursor.col = solcol;
4358 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 curwin->w_set_curswant = TRUE;
4361 }
4362 else
4363 beginline(BL_SOL | BL_FIX);
4364 }
4365 else /* no line number, go to last line in Ex mode */
4366 {
4367 if (exmode_active)
4368 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4369 beginline(BL_WHITE | BL_FIX);
4370 }
4371 }
4372
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 /* Check if cursors in other windows on the same buffer are still valid */
4374 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 /*
4377 * Did not read the file, need to show some info about the file.
4378 * Do this after setting the cursor.
4379 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004380 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 {
4382 int msg_scroll_save = msg_scroll;
4383
4384 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4385 * message. */
4386 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4387 msg_scroll = FALSE;
4388 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4389 check_for_delay(FALSE);
4390 msg_start();
4391 msg_scroll = msg_scroll_save;
4392 msg_scrolled_ign = TRUE;
4393
Bram Moolenaar426dd022016-03-15 15:09:29 +01004394 if (!shortmess(SHM_FILEINFO))
4395 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396
4397 msg_scrolled_ign = FALSE;
4398 }
4399
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004400#ifdef FEAT_VIMINFO
4401 curbuf->b_last_used = vim_time();
4402#endif
4403
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 if (command != NULL)
4405 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4406
4407#ifdef FEAT_KEYMAP
4408 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004409 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410#endif
4411
4412 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004413 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 if (!skip_redraw)
4415 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01004416 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01004418 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01004421 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4423 }
4424
4425 if (p_im)
4426 need_start_insertmode = TRUE;
4427
Bram Moolenaar15833232018-02-03 18:33:17 +01004428#ifdef FEAT_AUTOCHDIR
4429 /* Change directories when the 'acd' option is set and we aren't already in
4430 * that directory (should already be done above). Expect getcwd() to be
4431 * faster than calling shorten_fnames() unnecessarily. */
4432 if (p_acd && curbuf->b_ffname != NULL)
4433 {
4434 char_u curdir[MAXPATHL];
4435 char_u filedir[MAXPATHL];
4436
4437 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4438 *gettail_sep(filedir) = NUL;
4439 if (mch_dirname(curdir, MAXPATHL) != FAIL
4440 && vim_fnamecmp(curdir, filedir) != 0)
4441 do_autochdir();
4442 }
4443#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01004445#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004446 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004449 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004450 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451# endif
4452 }
4453#endif
4454
4455theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004456 if (did_inc_redrawing_disabled)
4457 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004458#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004459 if (did_set_swapcommand)
4460 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4461#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462#ifdef FEAT_BROWSE
4463 vim_free(browse_file);
4464#endif
4465 vim_free(free_fname);
4466 return retval;
4467}
4468
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004470delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004472 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 name == NULL ? (char_u *)"" : name);
4474 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004475 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004476 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004479static int append_indent = 0; /* autoindent for first line */
4480
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481/*
4482 * ":insert" and ":append", also used by ":change"
4483 */
4484 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004485ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486{
4487 char_u *theline;
4488 int did_undo = FALSE;
4489 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004490 int indent = 0;
4491 char_u *p;
4492 int vcol;
4493 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004495 /* the ! flag toggles autoindent */
4496 if (eap->forceit)
4497 curbuf->b_p_ai = !curbuf->b_p_ai;
4498
4499 /* First autoindent comes from the line we start on */
4500 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4501 append_indent = get_indent_lnum(lnum);
4502
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 if (eap->cmdidx != CMD_append)
4504 --lnum;
4505
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004506 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004507 if (empty && lnum == 1)
4508 lnum = 0;
4509
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 State = INSERT; /* behave like in Insert mode */
4511 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4512 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004513
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004514 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 {
4516 msg_scroll = TRUE;
4517 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004518 if (curbuf->b_p_ai)
4519 {
4520 if (append_indent >= 0)
4521 {
4522 indent = append_indent;
4523 append_indent = -1;
4524 }
4525 else if (lnum > 0)
4526 indent = get_indent_lnum(lnum);
4527 }
4528 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004530 {
4531 /* No getline() function, use the lines that follow. This ends
4532 * when there is no more. */
4533 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4534 break;
4535 p = vim_strchr(eap->nextcmd, NL);
4536 if (p == NULL)
4537 p = eap->nextcmd + STRLEN(eap->nextcmd);
4538 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4539 if (*p != NUL)
4540 ++p;
4541 eap->nextcmd = p;
4542 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004544 {
4545 int save_State = State;
4546
4547 /* Set State to avoid the cursor shape to be set to INSERT mode
4548 * when getline() returns. */
4549 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 theline = eap->getline(
4551#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004552 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004554 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004555 State = save_State;
4556 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004558 if (theline == NULL)
4559 break;
4560
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004561 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4562 if (ex_keep_indent)
4563 append_indent = indent;
4564
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004565 /* Look for the "." after automatic indent. */
4566 vcol = 0;
4567 for (p = theline; indent > vcol; ++p)
4568 {
4569 if (*p == ' ')
4570 ++vcol;
4571 else if (*p == TAB)
4572 vcol += 8 - vcol % 8;
4573 else
4574 break;
4575 }
4576 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004577 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4578 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 {
4580 vim_free(theline);
4581 break;
4582 }
4583
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004584 /* don't use autoindent if nothing was typed. */
4585 if (p[0] == NUL)
4586 theline[0] = NUL;
4587
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 did_undo = TRUE;
4589 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004590 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591
4592 vim_free(theline);
4593 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004594
4595 if (empty)
4596 {
4597 ml_delete(2L, FALSE);
4598 empty = FALSE;
4599 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 }
4601 State = NORMAL;
4602
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004603 if (eap->forceit)
4604 curbuf->b_p_ai = !curbuf->b_p_ai;
4605
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004607 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 * "end" is set to lnum when something has been appended, otherwise
4609 * it is the same than "start" -- Acevedo */
4610 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4611 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4612 if (eap->cmdidx != CMD_append)
4613 --curbuf->b_op_start.lnum;
4614 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4615 ? lnum : curbuf->b_op_start.lnum;
4616 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4617 curwin->w_cursor.lnum = lnum;
4618 check_cursor_lnum();
4619 beginline(BL_SOL | BL_FIX);
4620
4621 need_wait_return = FALSE; /* don't use wait_return() now */
4622 ex_no_reprint = TRUE;
4623}
4624
4625/*
4626 * ":change"
4627 */
4628 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004629ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630{
4631 linenr_T lnum;
4632
4633 if (eap->line2 >= eap->line1
4634 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4635 return;
4636
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004637 /* the ! flag toggles autoindent */
4638 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4639 append_indent = get_indent_lnum(eap->line1);
4640
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4642 {
4643 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4644 break;
4645 ml_delete(eap->line1, FALSE);
4646 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004647
4648 /* make sure the cursor is not beyond the end of the file now */
4649 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4651
4652 /* ":append" on the line above the deleted lines. */
4653 eap->line2 = eap->line1;
4654 ex_append(eap);
4655}
4656
4657 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004658ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659{
4660 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004661 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004662 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 int minus = 0;
4664 linenr_T start, end, curs, i;
4665 int j;
4666 linenr_T lnum = eap->line2;
4667
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004668 /* Vi compatible: ":z!" uses display height, without a count uses
4669 * 'scroll' */
4670 if (eap->forceit)
4671 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004672 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004673 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004674 else
4675 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 if (bigness < 1)
4677 bigness = 1;
4678
4679 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004680 kind = x;
4681 if (*kind == '-' || *kind == '+' || *kind == '='
4682 || *kind == '^' || *kind == '.')
4683 ++x;
4684 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 ++x;
4686
4687 if (*x != 0)
4688 {
4689 if (!VIM_ISDIGIT(*x))
4690 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004691 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 return;
4693 }
4694 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004695 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004696 bigness = atol((char *)x);
4697
4698 /* bigness could be < 0 if atol(x) overflows. */
4699 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4700 bigness = 2 * curbuf->b_ml.ml_line_count;
4701
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004702 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004703 if (*kind == '=')
4704 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004705 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 }
4707
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004708 /* the number of '-' and '+' multiplies the distance */
4709 if (*kind == '-' || *kind == '+')
4710 for (x = kind + 1; *x == *kind; ++x)
4711 ;
4712
4713 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 {
4715 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004716 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4717 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004718 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 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 = lnum;
4725 minus = 1;
4726 break;
4727
4728 case '^':
4729 start = lnum - bigness * 2;
4730 end = lnum - bigness;
4731 curs = lnum - bigness;
4732 break;
4733
4734 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004735 start = lnum - (bigness + 1) / 2 + 1;
4736 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 curs = end;
4738 break;
4739
4740 default: /* '+' */
4741 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004742 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004743 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004744 else if (eap->addr_count == 0)
4745 ++start;
4746 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 curs = end;
4748 break;
4749 }
4750
4751 if (start < 1)
4752 start = 1;
4753
4754 if (end > curbuf->b_ml.ml_line_count)
4755 end = curbuf->b_ml.ml_line_count;
4756
4757 if (curs > curbuf->b_ml.ml_line_count)
4758 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004759 else if (curs < 1)
4760 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761
4762 for (i = start; i <= end; i++)
4763 {
4764 if (minus && i == lnum)
4765 {
4766 msg_putchar('\n');
4767
4768 for (j = 1; j < Columns; j++)
4769 msg_putchar('-');
4770 }
4771
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004772 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773
4774 if (minus && i == lnum)
4775 {
4776 msg_putchar('\n');
4777
4778 for (j = 1; j < Columns; j++)
4779 msg_putchar('-');
4780 }
4781 }
4782
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004783 if (curwin->w_cursor.lnum != curs)
4784 {
4785 curwin->w_cursor.lnum = curs;
4786 curwin->w_cursor.col = 0;
4787 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 ex_no_reprint = TRUE;
4789}
4790
4791/*
4792 * Check if the restricted flag is set.
4793 * If so, give an error message and return TRUE.
4794 * Otherwise, return FALSE.
4795 */
4796 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004797check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798{
4799 if (restricted)
4800 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01004801 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 return TRUE;
4803 }
4804 return FALSE;
4805}
4806
4807/*
4808 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4809 * If so, give an error message and return TRUE.
4810 * Otherwise, return FALSE.
4811 */
4812 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004813check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814{
4815 if (secure)
4816 {
4817 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004818 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 return TRUE;
4820 }
4821#ifdef HAVE_SANDBOX
4822 /*
4823 * In the sandbox more things are not allowed, including the things
4824 * disallowed in secure mode.
4825 */
4826 if (sandbox != 0)
4827 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004828 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 return TRUE;
4830 }
4831#endif
4832 return FALSE;
4833}
4834
4835static char_u *old_sub = NULL; /* previous substitute pattern */
4836static int global_need_beginline; /* call beginline() after ":g" */
4837
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004838/*
4839 * Flags that are kept between calls to :substitute.
4840 */
4841typedef struct {
4842 int do_all; /* do multiple substitutions per line */
4843 int do_ask; /* ask for confirmation */
4844 int do_count; /* count only */
4845 int do_error; /* if false, ignore errors */
4846 int do_print; /* print last line with subs. */
4847 int do_list; /* list last line with subs. */
4848 int do_number; /* list last line with line nr*/
4849 int do_ic; /* ignore case flag */
4850} subflags_T;
4851
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852/* do_sub()
4853 *
4854 * Perform a substitution from line eap->line1 to line eap->line2 using the
4855 * command pointed to by eap->arg which should be of the form:
4856 *
4857 * /pattern/substitution/{flags}
4858 *
4859 * The usual escapes are supported as described in the regexp docs.
4860 */
4861 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004862do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863{
4864 linenr_T lnum;
4865 long i = 0;
4866 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004867 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4868 FALSE, FALSE, 0};
4869#ifdef FEAT_EVAL
4870 subflags_T subflags_save;
4871#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004872 int save_do_all; /* remember user specified 'g' flag */
4873 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4875 int delimiter;
4876 int sublen;
4877 int got_quit = FALSE;
4878 int got_match = FALSE;
4879 int temp;
4880 int which_pat;
4881 char_u *cmd;
4882 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004883 linenr_T first_line = 0; /* first changed line */
4884 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 * change */
4886 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4887 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004888 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004889 char_u *sub_firstline; /* allocated copy of first sub line */
4890 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004891 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004892 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004893#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004894 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004895#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
4897 cmd = eap->arg;
4898 if (!global_busy)
4899 {
4900 sub_nsubs = 0;
4901 sub_nlines = 0;
4902 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004903 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 if (eap->cmdidx == CMD_tilde)
4906 which_pat = RE_LAST; /* use last used regexp */
4907 else
4908 which_pat = RE_SUBST; /* use last substitute regexp */
4909
4910 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004911 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4913 {
4914 /* don't accept alphanumeric for separator */
4915 if (isalpha(*cmd))
4916 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004917 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 return;
4919 }
4920 /*
4921 * undocumented vi feature:
4922 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4923 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4924 */
4925 if (*cmd == '\\')
4926 {
4927 ++cmd;
4928 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4929 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004930 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 return;
4932 }
4933 if (*cmd != '&')
4934 which_pat = RE_SEARCH; /* use last '/' pattern */
4935 pat = (char_u *)""; /* empty search pattern */
4936 delimiter = *cmd++; /* remember delimiter character */
4937 }
4938 else /* find the end of the regexp */
4939 {
4940 which_pat = RE_LAST; /* use last used regexp */
4941 delimiter = *cmd++; /* remember delimiter character */
4942 pat = cmd; /* remember start of search pat */
4943 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4944 if (cmd[0] == delimiter) /* end delimiter found */
4945 *cmd++ = NUL; /* replace it with a NUL */
4946 }
4947
4948 /*
4949 * Small incompatibility: vi sees '\n' as end of the command, but in
4950 * Vim we want to use '\n' to find/substitute a NUL.
4951 */
4952 sub = cmd; /* remember the start of the substitution */
4953
4954 while (cmd[0])
4955 {
4956 if (cmd[0] == delimiter) /* end delimiter found */
4957 {
4958 *cmd++ = NUL; /* replace it with a NUL */
4959 break;
4960 }
4961 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4962 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004963 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 }
4965
4966 if (!eap->skip)
4967 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004968 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4969 if (STRCMP(sub, "%") == 0
4970 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4971 {
4972 if (old_sub == NULL) /* there is no previous command */
4973 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004974 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004975 return;
4976 }
4977 sub = old_sub;
4978 }
4979 else
4980 {
4981 vim_free(old_sub);
4982 old_sub = vim_strsave(sub);
4983 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 }
4985 }
4986 else if (!eap->skip) /* use previous pattern and substitution */
4987 {
4988 if (old_sub == NULL) /* there is no previous command */
4989 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004990 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 return;
4992 }
4993 pat = NULL; /* search_regcomp() will use previous pattern */
4994 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004995
4996 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4997 * last column after using "$". */
4998 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 }
5000
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005001 /* Recognize ":%s/\n//" and turn it into a join command, which is much
5002 * more efficient.
5003 * TODO: find a generic solution to make line-joining operations more
5004 * efficient, avoid allocating a string that grows in size.
5005 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02005006 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005007 && *sub == NUL
5008 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
5009 || *cmd == 'p' || *cmd == '#'))))
5010 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005011 linenr_T joined_lines_count;
5012
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005013 curwin->w_cursor.lnum = eap->line1;
5014 if (*cmd == 'l')
5015 eap->flags = EXFLAG_LIST;
5016 else if (*cmd == '#')
5017 eap->flags = EXFLAG_NR;
5018 else if (*cmd == 'p')
5019 eap->flags = EXFLAG_PRINT;
5020
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005021 /* The number of lines joined is the number of lines in the range plus
5022 * one. One less when the last line is included. */
5023 joined_lines_count = eap->line2 - eap->line1 + 1;
5024 if (eap->line2 < curbuf->b_ml.ml_line_count)
5025 ++joined_lines_count;
5026 if (joined_lines_count > 1)
5027 {
5028 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
5029 sub_nsubs = joined_lines_count - 1;
5030 sub_nlines = 1;
5031 (void)do_sub_msg(FALSE);
5032 ex_may_print(eap);
5033 }
5034
5035 if (!cmdmod.keeppatterns)
5036 save_re_pat(RE_SUBST, pat, p_magic);
5037#ifdef FEAT_CMDHIST
5038 /* put pattern in history */
5039 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
5040#endif
5041
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005042 return;
5043 }
5044
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 /*
5046 * Find trailing options. When '&' is used, keep old options.
5047 */
5048 if (*cmd == '&')
5049 ++cmd;
5050 else
5051 {
5052 if (!p_ed)
5053 {
5054 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005055 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005057 subflags.do_all = FALSE;
5058 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005060 subflags.do_error = TRUE;
5061 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01005062 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005063 subflags.do_count = FALSE;
5064 subflags.do_number = FALSE;
5065 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 }
5067 while (*cmd)
5068 {
5069 /*
5070 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
5071 * 'r' is never inverted.
5072 */
5073 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005074 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005076 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005077 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005078 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005080 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 else if (*cmd == 'r') /* use last used regexp */
5082 which_pat = RE_LAST;
5083 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005084 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005085 else if (*cmd == '#')
5086 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005087 subflags.do_print = TRUE;
5088 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005089 }
5090 else if (*cmd == 'l')
5091 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005092 subflags.do_print = TRUE;
5093 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005094 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005096 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005098 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 else
5100 break;
5101 ++cmd;
5102 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005103 if (subflags.do_count)
5104 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005106 save_do_all = subflags.do_all;
5107 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005108
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 /*
5110 * check for a trailing count
5111 */
5112 cmd = skipwhite(cmd);
5113 if (VIM_ISDIGIT(*cmd))
5114 {
5115 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005116 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005118 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 return;
5120 }
5121 eap->line1 = eap->line2;
5122 eap->line2 += i - 1;
5123 if (eap->line2 > curbuf->b_ml.ml_line_count)
5124 eap->line2 = curbuf->b_ml.ml_line_count;
5125 }
5126
5127 /*
5128 * check for trailing command or garbage
5129 */
5130 cmd = skipwhite(cmd);
5131 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5132 {
5133 eap->nextcmd = check_nextcmd(cmd);
5134 if (eap->nextcmd == NULL)
5135 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005136 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 return;
5138 }
5139 }
5140
5141 if (eap->skip) /* not executing commands, only parsing */
5142 return;
5143
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005144 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005145 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005146 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005147 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005148 return;
5149 }
5150
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5152 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005153 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005154 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 return;
5156 }
5157
5158 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005159 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005161 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 regmatch.rmm_ic = FALSE;
5163
5164 sub_firstline = NULL;
5165
5166 /*
5167 * ~ in the substitute pattern is replaced with the old pattern.
5168 * We do it here once to avoid it to be replaced over and over again.
5169 * But don't do it when it starts with "\=", then it's an expression.
5170 */
5171 if (!(sub[0] == '\\' && sub[1] == '='))
5172 sub = regtilde(sub, p_magic);
5173
5174 /*
5175 * Check for a match on each line.
5176 */
5177 line2 = eap->line2;
5178 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005179#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 || aborting()
5181#endif
5182 ); ++lnum)
5183 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005184 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005185 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 if (nmatch)
5187 {
5188 colnr_T copycol;
5189 colnr_T matchcol;
5190 colnr_T prev_matchcol = MAXCOL;
5191 char_u *new_end, *new_start = NULL;
5192 unsigned new_start_len = 0;
5193 char_u *p1;
5194 int did_sub = FALSE;
5195 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005196 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 long nmatch_tl = 0; /* nr of lines matched below lnum */
5198 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005199 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005200 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201
5202 /*
5203 * The new text is build up step by step, to avoid too much
5204 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005205 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 * copycol Column in the old text where we started
5207 * looking for a match; from here old text still
5208 * needs to be copied to the new text.
5209 * matchcol Column number of the old text where to look
5210 * for the next match. It's just after the
5211 * previous match or one further.
5212 * prev_matchcol Column just after the previous match (if any).
5213 * Mostly equal to matchcol, except for the first
5214 * match and after skipping an empty match.
5215 * regmatch.*pos Where the pattern matched in the old text.
5216 * new_start The new text, all that has been produced so
5217 * far.
5218 * new_end The new text, where to append new text.
5219 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005220 * lnum The line number where we found the start of
5221 * the match. Can be below the line we searched
5222 * when there is a \n before a \zs in the
5223 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 * sub_firstlnum The line number in the buffer where to look
5225 * for a match. Can be different from "lnum"
5226 * when the pattern or substitute string contains
5227 * line breaks.
5228 *
5229 * Special situations:
5230 * - When the substitute string contains a line break, the part up
5231 * to the line break is inserted in the text, but the copy of
5232 * the original line is kept. "sub_firstlnum" is adjusted for
5233 * the inserted lines.
5234 * - When the matched pattern contains a line break, the old line
5235 * is taken from the line at the end of the pattern. The lines
5236 * in the match are deleted later, "sub_firstlnum" is adjusted
5237 * accordingly.
5238 *
5239 * The new text is built up in new_start[]. It has some extra
5240 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005241 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 *
5243 * Make a copy of the old line, so it won't be taken away when
5244 * updating the screen or handling a multi-line match. The "old_"
5245 * pointers point into this copy.
5246 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005247 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 copycol = 0;
5249 matchcol = 0;
5250
5251 /* At first match, remember current cursor position. */
5252 if (!got_match)
5253 {
5254 setpcmark();
5255 got_match = TRUE;
5256 }
5257
5258 /*
5259 * Loop until nothing more to replace in this line.
5260 * 1. Handle match with empty string.
5261 * 2. If do_ask is set, ask for confirmation.
5262 * 3. substitute the string.
5263 * 4. if do_all is set, find next match
5264 * 5. break if there isn't another match in this line
5265 */
5266 for (;;)
5267 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005268 /* Advance "lnum" to the line where the match starts. The
5269 * match does not start in the first line when there is a line
5270 * break before \zs. */
5271 if (regmatch.startpos[0].lnum > 0)
5272 {
5273 lnum += regmatch.startpos[0].lnum;
5274 sub_firstlnum += regmatch.startpos[0].lnum;
5275 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005276 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005277 }
5278
5279 if (sub_firstline == NULL)
5280 {
5281 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5282 if (sub_firstline == NULL)
5283 {
5284 vim_free(new_start);
5285 goto outofmem;
5286 }
5287 }
5288
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 /* Save the line number of the last change for the final
5290 * cursor position (just like Vi). */
5291 curwin->w_cursor.lnum = lnum;
5292 do_again = FALSE;
5293
5294 /*
5295 * 1. Match empty string does not count, except for first
5296 * match. This reproduces the strange vi behaviour.
5297 * This also catches endless loops.
5298 */
5299 if (matchcol == prev_matchcol
5300 && regmatch.endpos[0].lnum == 0
5301 && matchcol == regmatch.endpos[0].col)
5302 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005303 if (sub_firstline[matchcol] == NUL)
5304 /* We already were at the end of the line. Don't look
5305 * for a match in this line again. */
5306 skip_match = TRUE;
5307 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005308 {
5309 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02005310 if (has_mbyte)
5311 matchcol += mb_ptr2len(sub_firstline + matchcol);
5312 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005313 ++matchcol;
5314 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 goto skip;
5316 }
5317
5318 /* Normally we continue searching for a match just after the
5319 * previous match. */
5320 matchcol = regmatch.endpos[0].col;
5321 prev_matchcol = matchcol;
5322
5323 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005324 * 2. If do_count is set only increase the counter.
5325 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005327 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005328 {
5329 /* For a multi-line match, put matchcol at the NUL at
5330 * the end of the line and set nmatch to one, so that
5331 * we continue looking for a match on the next line.
5332 * Avoids that ":s/\nB\@=//gc" get stuck. */
5333 if (nmatch > 1)
5334 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005335 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005336 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005337 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005338 }
5339 sub_nsubs++;
5340 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005341#ifdef FEAT_EVAL
5342 /* Skip the substitution, unless an expression is used,
5343 * then it is evaluated in the sandbox. */
5344 if (!(sub[0] == '\\' && sub[1] == '='))
5345#endif
5346 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005347 }
5348
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005349 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005351 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005352
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 /* change State to CONFIRM, so that the mouse works
5354 * properly */
5355 save_State = State;
5356 State = CONFIRM;
5357#ifdef FEAT_MOUSE
5358 setmouse(); /* disable mouse in xterm */
5359#endif
5360 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005361 if (curwin->w_p_crb)
5362 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
5364 /* When 'cpoptions' contains "u" don't sync undo when
5365 * asking for confirmation. */
5366 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5367 ++no_u_sync;
5368
5369 /*
5370 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5371 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005372 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005374 if (exmode_active)
5375 {
5376 char_u *resp;
5377 colnr_T sc, ec;
5378
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005379 print_line_no_prefix(lnum,
5380 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005381
5382 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5383 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005384 if (curwin->w_cursor.col < 0)
5385 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005386 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005387 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005388 {
5389 int numw = number_width(curwin) + 1;
5390 sc += numw;
5391 ec += numw;
5392 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005393 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005394 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005395 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005396 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005397 msg_putchar('^');
5398
5399 resp = getexmodeline('?', NULL, 0);
5400 if (resp != NULL)
5401 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005402 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005403 vim_free(resp);
5404 }
5405 }
5406 else
5407 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005408 char_u *orig_line = NULL;
5409 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005411 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005413 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005415 /* Invert the matched string.
5416 * Remove the inversion afterwards. */
5417 temp = RedrawingDisabled;
5418 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005420 if (new_start != NULL)
5421 {
5422 /* There already was a substitution, we would
5423 * like to show this to the user. We cannot
5424 * really update the line, it would change
5425 * what matches. Temporarily replace the line
5426 * and change it back afterwards. */
5427 orig_line = vim_strsave(ml_get(lnum));
5428 if (orig_line != NULL)
5429 {
5430 char_u *new_line = concat_str(new_start,
5431 sub_firstline + copycol);
5432
5433 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005434 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005435 else
5436 {
5437 /* Position the cursor relative to the
5438 * end of the line, the previous
5439 * substitute may have inserted or
5440 * deleted characters before the
5441 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005442 len_change = (int)STRLEN(new_line)
5443 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005444 curwin->w_cursor.col += len_change;
5445 ml_replace(lnum, new_line, FALSE);
5446 }
5447 }
5448 }
5449
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005450 search_match_lines = regmatch.endpos[0].lnum
5451 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005452 search_match_endcol = regmatch.endpos[0].col
5453 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005454 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005456 update_topline();
5457 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005458 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005459 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005460 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005463 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005465 if (msg_row == Rows - 1)
5466 msg_didout = FALSE; /* avoid a scroll-up */
5467 msg_starthere();
5468 i = msg_scroll;
5469 msg_scroll = 0; /* truncate msg when
5470 needed */
5471 msg_no_more = TRUE;
5472 /* write message same highlighting as for
5473 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005474 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005475 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005476 msg_no_more = FALSE;
5477 msg_scroll = i;
5478 showruler(TRUE);
5479 windgoto(msg_row, msg_col);
5480 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481
5482#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005483 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005485 ++no_mapping; /* don't map this key */
5486 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005487 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005488 --allow_keys;
5489 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005491 /* clear the question */
5492 msg_didout = FALSE; /* don't scroll up */
5493 msg_col = 0;
5494 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005495
5496 /* restore the line */
5497 if (orig_line != NULL)
5498 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005499 }
5500
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005502 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005504 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505#endif
5506 )
5507 {
5508 got_quit = TRUE;
5509 break;
5510 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005511 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005513 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005515 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 {
5517 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005518 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 line2 = lnum;
5520 break;
5521 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005522 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005524 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 break;
5526 }
5527#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005528 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005530 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 scrolldown_clamp();
5532#endif
5533 }
5534 State = save_State;
5535#ifdef FEAT_MOUSE
5536 setmouse();
5537#endif
5538 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5539 --no_u_sync;
5540
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005541 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 {
5543 /* For a multi-line match, put matchcol at the NUL at
5544 * the end of the line and set nmatch to one, so that
5545 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005546 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5547 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 if (nmatch > 1)
5549 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005550 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005551 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 }
5553 goto skip;
5554 }
5555 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005556 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 }
5558
5559 /* Move the cursor to the start of the match, so that we can
5560 * use "\=col("."). */
5561 curwin->w_cursor.col = regmatch.startpos[0].col;
5562
5563 /*
5564 * 3. substitute the string.
5565 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005566#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005567 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005568 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005569 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005570 save_ma = curbuf->b_p_ma;
5571 curbuf->b_p_ma = FALSE;
5572 sandbox++;
5573 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005574 /* Save flags for recursion. They can change for e.g.
5575 * :s/^/\=execute("s#^##gn") */
5576 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005577#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005579 sublen = vim_regsub_multi(&regmatch,
5580 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005582#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01005583 // If getting the substitute string caused an error, don't do
5584 // the replacement.
5585 if (aborting())
5586 goto skip;
5587
5588 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005589 subflags = subflags_save;
5590 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005591 {
5592 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005593 if (sandbox > 0)
5594 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005595 goto skip;
5596 }
5597#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598
Bram Moolenaar4463f292005-09-25 22:20:24 +00005599 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005600 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005601 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5602 {
5603 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5604 skip_match = TRUE;
5605 }
5606
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 /* Need room for:
5608 * - result so far in new_start (not for first sub in line)
5609 * - original text up to match
5610 * - length of substituted part
5611 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005612 * Adjust text properties here, since we have all information
5613 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 */
5615 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005616 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005618#ifdef FEAT_TEXT_PROP
5619 if (curbuf->b_has_textprop)
5620 adjust_prop_columns(lnum, regmatch.startpos[0].col,
5621 sublen - 1 - (regmatch.endpos[0].col
5622 - regmatch.startpos[0].col));
5623#endif
5624 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 else
5626 {
5627 p1 = ml_get(sub_firstlnum + nmatch - 1);
5628 nmatch_tl += nmatch - 1;
5629 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005630 copy_len = regmatch.startpos[0].col - copycol;
5631 needed_len = copy_len + ((unsigned)STRLEN(p1)
5632 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 if (new_start == NULL)
5634 {
5635 /*
5636 * Get some space for a temporary buffer to do the
5637 * substitution into (and some extra space to avoid
5638 * too many calls to alloc()/free()).
5639 */
5640 new_start_len = needed_len + 50;
5641 if ((new_start = alloc_check(new_start_len)) == NULL)
5642 goto outofmem;
5643 *new_start = NUL;
5644 new_end = new_start;
5645 }
5646 else
5647 {
5648 /*
5649 * Check if the temporary buffer is long enough to do the
5650 * substitution into. If not, make it larger (with a bit
5651 * extra to avoid too many calls to alloc()/free()).
5652 */
5653 len = (unsigned)STRLEN(new_start);
5654 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005655 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 {
5657 new_start_len = needed_len + 50;
5658 if ((p1 = alloc_check(new_start_len)) == NULL)
5659 {
5660 vim_free(new_start);
5661 goto outofmem;
5662 }
5663 mch_memmove(p1, new_start, (size_t)(len + 1));
5664 vim_free(new_start);
5665 new_start = p1;
5666 }
5667 new_end = new_start + len;
5668 }
5669
5670 /*
5671 * copy the text up to the part that matched
5672 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005673 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5674 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005676 (void)vim_regsub_multi(&regmatch,
5677 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 sub, new_end, TRUE, p_magic, TRUE);
5679 sub_nsubs++;
5680 did_sub = TRUE;
5681
5682 /* Move the cursor to the start of the line, to avoid that it
5683 * is beyond the end of the line after the substitution. */
5684 curwin->w_cursor.col = 0;
5685
5686 /* For a multi-line match, make a copy of the last matched
5687 * line and continue in that one. */
5688 if (nmatch > 1)
5689 {
5690 sub_firstlnum += nmatch - 1;
5691 vim_free(sub_firstline);
5692 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5693 /* When going beyond the last line, stop substituting. */
5694 if (sub_firstlnum <= line2)
5695 do_again = TRUE;
5696 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005697 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 }
5699
5700 /* Remember next character to be copied. */
5701 copycol = regmatch.endpos[0].col;
5702
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005703 if (skip_match)
5704 {
5705 /* Already hit end of the buffer, sub_firstlnum is one
5706 * less than what it ought to be. */
5707 vim_free(sub_firstline);
5708 sub_firstline = vim_strsave((char_u *)"");
5709 copycol = 0;
5710 }
5711
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 /*
5713 * Now the trick is to replace CTRL-M chars with a real line
5714 * break. This would make it impossible to insert a CTRL-M in
5715 * the text. The line break can be avoided by preceding the
5716 * CTRL-M with a backslash. To be able to insert a backslash,
5717 * they must be doubled in the string and are halved here.
5718 * That is Vi compatible.
5719 */
5720 for (p1 = new_end; *p1; ++p1)
5721 {
5722 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005723 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 else if (*p1 == CAR)
5725 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005726 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005728 colnr_T plen = (colnr_T)(p1 - new_start + 1);
5729
5730 *p1 = NUL; // truncate up to the CR
5731 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005733 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 appended_lines(lnum - 1, 1L);
5735 else
5736 {
5737 if (first_line == 0)
5738 first_line = lnum;
5739 last_line = lnum + 1;
5740 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005741#ifdef FEAT_TEXT_PROP
5742 adjust_props_for_split(lnum, plen, 1);
5743#endif
5744 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 ++sub_firstlnum;
5746 ++lnum;
5747 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005748 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005750 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005751 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 p1 = new_start - 1;
5753 }
5754 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005756 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 }
5758
5759 /*
5760 * 4. If do_all is set, find next match.
5761 * Prevent endless loop with patterns that match empty
5762 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5763 * But ":s/\n/#/" is OK.
5764 */
5765skip:
5766 /* We already know that we did the last subst when we are at
5767 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005768 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5769 * "line2" when there is a \zs in the pattern after a line
5770 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005771 lastone = (skip_match
5772 || got_int
5773 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005774 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005775 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005776 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5777 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 nmatch = -1;
5779
5780 /*
5781 * Replace the line in the buffer when needed. This is
5782 * skipped when there are more matches.
5783 * The check for nmatch_tl is needed for when multi-line
5784 * matching must replace the lines before trying to do another
5785 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005786 * When the match starts below where we start searching also
5787 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 */
5789 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 || nmatch_tl > 0
5791 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005792 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005793 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005794 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 {
5796 if (new_start != NULL)
5797 {
5798 /*
5799 * Copy the rest of the line, that didn't match.
5800 * "matchcol" has to be adjusted, we use the end of
5801 * the line as reference, because the substitute may
5802 * have changed the number of characters. Same for
5803 * "prev_matchcol".
5804 */
5805 STRCAT(new_start, sub_firstline + copycol);
5806 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5807 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5808 - prev_matchcol;
5809
5810 if (u_savesub(lnum) != OK)
5811 break;
5812 ml_replace(lnum, new_start, TRUE);
5813
5814 if (nmatch_tl > 0)
5815 {
5816 /*
5817 * Matched lines have now been substituted and are
5818 * useless, delete them. The part after the match
5819 * has been appended to new_start, we don't need
5820 * it in the buffer.
5821 */
5822 ++lnum;
5823 if (u_savedel(lnum, nmatch_tl) != OK)
5824 break;
5825 for (i = 0; i < nmatch_tl; ++i)
5826 ml_delete(lnum, (int)FALSE);
5827 mark_adjust(lnum, lnum + nmatch_tl - 1,
5828 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005829 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 deleted_lines(lnum, nmatch_tl);
5831 --lnum;
5832 line2 -= nmatch_tl; /* nr of lines decreases */
5833 nmatch_tl = 0;
5834 }
5835
5836 /* When asking, undo is saved each time, must also set
5837 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005838 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 changed_bytes(lnum, 0);
5840 else
5841 {
5842 if (first_line == 0)
5843 first_line = lnum;
5844 last_line = lnum + 1;
5845 }
5846
5847 sub_firstlnum = lnum;
5848 vim_free(sub_firstline); /* free the temp buffer */
5849 sub_firstline = new_start;
5850 new_start = NULL;
5851 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5852 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5853 - prev_matchcol;
5854 copycol = 0;
5855 }
5856 if (nmatch == -1 && !lastone)
5857 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005858 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859
5860 /*
5861 * 5. break if there isn't another match in this line
5862 */
5863 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005864 {
5865 /* If the match found didn't start where we were
5866 * searching, do the next search in the line where we
5867 * found the match. */
5868 if (nmatch == -1)
5869 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005871 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 }
5873
5874 line_breakcheck();
5875 }
5876
5877 if (did_sub)
5878 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005879 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005880 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 }
5882
5883 line_breakcheck();
5884 }
5885
5886 if (first_line != 0)
5887 {
5888 /* Need to subtract the number of added lines from "last_line" to get
5889 * the line number before the change (same as adding the number of
5890 * deleted lines). */
5891 i = curbuf->b_ml.ml_line_count - old_line_count;
5892 changed_lines(first_line, 0, last_line - i, i);
5893 }
5894
5895outofmem:
5896 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005897
5898 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005899 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005900 curwin->w_cursor = old_cursor;
5901
Bram Moolenaar46475522010-03-23 17:36:29 +01005902 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 {
5904 /* Set the '[ and '] marks. */
5905 curbuf->b_op_start.lnum = eap->line1;
5906 curbuf->b_op_end.lnum = line2;
5907 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5908
5909 if (!global_busy)
5910 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005911 /* when interactive leave cursor on the match */
5912 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005913 {
5914 if (endcolumn)
5915 coladvance((colnr_T)MAXCOL);
5916 else
5917 beginline(BL_WHITE | BL_FIX);
5918 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005919 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005920 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 }
5922 else
5923 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005924 if (subflags.do_print)
5925 print_line(curwin->w_cursor.lnum,
5926 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 }
5928 else if (!global_busy)
5929 {
5930 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005931 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005933 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005934 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005935 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 }
5937
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005938#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005939 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005940 /* Cursor position may require updating */
5941 changed_window_setting();
5942#endif
5943
Bram Moolenaar473de612013-06-08 18:19:48 +02005944 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005945
5946 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005947 subflags.do_all = save_do_all;
5948 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949}
5950
5951/*
5952 * Give message for number of substitutions.
5953 * Can also be used after a ":global" command.
5954 * Return TRUE if a message was given.
5955 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005956 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005957do_sub_msg(
5958 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959{
5960 /*
5961 * Only report substitutions when:
5962 * - more than 'report' substitutions
5963 * - command was typed by user, or number of changed lines > 'report'
5964 * - giving messages is not disabled by 'lazyredraw'
5965 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005966 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5967 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 && messaging())
5969 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005970 char *msg_single;
5971 char *msg_plural;
5972
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973 if (got_int)
5974 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005975 else
5976 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005977
5978 msg_single = count_only
5979 ? NGETTEXT("%ld match on %ld line",
5980 "%ld matches on %ld line", sub_nsubs)
5981 : NGETTEXT("%ld substitution on %ld line",
5982 "%ld substitutions on %ld line", sub_nsubs);
5983 msg_plural = count_only
5984 ? NGETTEXT("%ld match on %ld lines",
5985 "%ld matches on %ld lines", sub_nsubs)
5986 : NGETTEXT("%ld substitution on %ld lines",
5987 "%ld substitutions on %ld lines", sub_nsubs);
5988
Bram Moolenaar32526b32019-01-19 17:43:09 +01005989 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005990 NGETTEXT(msg_single, msg_plural, sub_nlines),
5991 sub_nsubs, (long)sub_nlines);
5992
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005995 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 return TRUE;
5997 }
5998 if (got_int)
5999 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006000 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 return TRUE;
6002 }
6003 return FALSE;
6004}
6005
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006006 static void
6007global_exe_one(char_u *cmd, linenr_T lnum)
6008{
6009 curwin->w_cursor.lnum = lnum;
6010 curwin->w_cursor.col = 0;
6011 if (*cmd == NUL || *cmd == '\n')
6012 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6013 else
6014 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6015}
6016
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017/*
6018 * Execute a global command of the form:
6019 *
6020 * g/pattern/X : execute X on all lines where pattern matches
6021 * v/pattern/X : execute X on all lines where pattern does not match
6022 *
6023 * where 'X' is an EX command
6024 *
6025 * The command character (as well as the trailing slash) is optional, and
6026 * is assumed to be 'p' if missing.
6027 *
6028 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006029 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 * for each line that has a mark. This is required because after deleting
6031 * lines we do not know where to search for the next match.
6032 */
6033 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006034ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035{
6036 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006037 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 int type; /* first char of cmd: 'v' or 'g' */
6039 char_u *cmd; /* command argument */
6040
6041 char_u delim; /* delimiter, normally '/' */
6042 char_u *pat;
6043 regmmatch_T regmatch;
6044 int match;
6045 int which_pat;
6046
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006047 /* When nesting the command works on one line. This allows for
6048 * ":g/found/v/notfound/command". */
6049 if (global_busy && (eap->line1 != 1
6050 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006052 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006053 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 return;
6055 }
6056
6057 if (eap->forceit) /* ":global!" is like ":vglobal" */
6058 type = 'v';
6059 else
6060 type = *eap->cmd;
6061 cmd = eap->arg;
6062 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063
6064 /*
6065 * undocumented vi feature:
6066 * "\/" and "\?": use previous search pattern.
6067 * "\&": use previous substitute pattern.
6068 */
6069 if (*cmd == '\\')
6070 {
6071 ++cmd;
6072 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
6073 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006074 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 return;
6076 }
6077 if (*cmd == '&')
6078 which_pat = RE_SUBST; /* use previous substitute pattern */
6079 else
6080 which_pat = RE_SEARCH; /* use previous search pattern */
6081 ++cmd;
6082 pat = (char_u *)"";
6083 }
6084 else if (*cmd == NUL)
6085 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006086 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 return;
6088 }
6089 else
6090 {
6091 delim = *cmd; /* get the delimiter */
6092 if (delim)
6093 ++cmd; /* skip delimiter if there is one */
6094 pat = cmd; /* remember start of pattern */
6095 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
6096 if (cmd[0] == delim) /* end delimiter found */
6097 *cmd++ = NUL; /* replace it with a NUL */
6098 }
6099
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6101 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006102 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 return;
6104 }
6105
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006106 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006108 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006109 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006110 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006112 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 }
6114 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006115 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006116 /*
6117 * pass 1: set marks for each (not) matching line
6118 */
6119 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6120 {
6121 /* a match on this line? */
6122 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006123 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006124 if ((type == 'g' && match) || (type == 'v' && !match))
6125 {
6126 ml_setmarked(lnum);
6127 ndone++;
6128 }
6129 line_breakcheck();
6130 }
6131
6132 /*
6133 * pass 2: execute the command for each line that has been marked
6134 */
6135 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006136 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006137 else if (ndone == 0)
6138 {
6139 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006140 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006141 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006142 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006143 }
6144 else
6145 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006146#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006147 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006148#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006149 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006150#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006151 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006152#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006153 }
6154
6155 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157
Bram Moolenaar473de612013-06-08 18:19:48 +02006158 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159}
6160
6161/*
6162 * Execute "cmd" on lines marked with ml_setmarked().
6163 */
6164 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006165global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006167 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6168 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6169 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170
6171 /*
6172 * Set current position only once for a global command.
6173 * If global_busy is set, setpcmark() will not do anything.
6174 * If there is an error, global_busy will be incremented.
6175 */
6176 setpcmark();
6177
6178 /* When the command writes a message, don't overwrite the command. */
6179 msg_didout = TRUE;
6180
Bram Moolenaard25bc232010-03-23 17:49:24 +01006181 sub_nsubs = 0;
6182 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 global_need_beginline = FALSE;
6184 global_busy = 1;
6185 old_lcount = curbuf->b_ml.ml_line_count;
6186 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6187 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006188 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 ui_breakcheck();
6190 }
6191
6192 global_busy = 0;
6193 if (global_need_beginline)
6194 beginline(BL_WHITE | BL_FIX);
6195 else
6196 check_cursor(); /* cursor may be beyond the end of the line */
6197
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006198 /* the cursor may not have moved in the text but a change in a previous
6199 * line may move it on the screen */
6200 changed_line_abv_curs();
6201
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 /* If it looks like no message was written, allow overwriting the
6203 * command with the report for number of changes. */
6204 if (msg_col == 0 && msg_scrolled == 0)
6205 msg_didout = FALSE;
6206
Bram Moolenaar45667512007-05-10 19:24:43 +00006207 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006208 * number of extra or deleted lines.
6209 * Don't report extra or deleted lines in the edge case where the buffer
6210 * we are in after execution is different from the buffer we started in. */
6211 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6213}
6214
6215#ifdef FEAT_VIMINFO
6216 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006217read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006219 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 vim_free(old_sub);
6221 if (force || old_sub == NULL)
6222 old_sub = viminfo_readstring(virp, 1, TRUE);
6223 return viminfo_readline(virp);
6224}
6225
6226 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006227write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228{
6229 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6230 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006231 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 viminfo_writestring(fp, old_sub);
6233 }
6234}
6235#endif /* FEAT_VIMINFO */
6236
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006237#if defined(EXITFREE) || defined(PROTO)
6238 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006239free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006240{
6241 vim_free(old_sub);
6242}
6243#endif
6244
Bram Moolenaar4033c552017-09-16 20:54:51 +02006245#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246/*
6247 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006248 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006250 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006251prepare_tagpreview(
6252 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253{
6254 win_T *wp;
6255
6256# ifdef FEAT_GUI
6257 need_mouse_correct = TRUE;
6258# endif
6259
6260 /*
6261 * If there is already a preview window open, use that one.
6262 */
6263 if (!curwin->w_p_pvw)
6264 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006265 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 if (wp->w_p_pvw)
6267 break;
6268 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006269 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 else
6271 {
6272 /*
6273 * There is no preview window open yet. Create one.
6274 */
6275 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6276 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006277 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 curwin->w_p_pvw = TRUE;
6279 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006280 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6281 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282# ifdef FEAT_DIFF
6283 curwin->w_p_diff = FALSE; /* no 'diff' */
6284# endif
6285# ifdef FEAT_FOLDING
6286 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6287# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006288 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 }
6290 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006291 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292}
6293
6294#endif
6295
6296
6297/*
6298 * ":help": open a read-only window on a help file
6299 */
6300 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006301ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302{
6303 char_u *arg;
6304 char_u *tag;
6305 FILE *helpfd; /* file descriptor of help file */
6306 int n;
6307 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 int num_matches;
6310 char_u **matches;
6311 char_u *p;
6312 int empty_fnum = 0;
6313 int alt_fnum = 0;
6314 buf_T *buf;
6315#ifdef FEAT_MULTI_LANG
6316 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006317 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006319#ifdef FEAT_FOLDING
6320 int old_KeyTyped = KeyTyped;
6321#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322
6323 if (eap != NULL)
6324 {
6325 /*
6326 * A ":help" command ends at the first LF, or at a '|' that is
6327 * followed by some text. Set nextcmd to the following command.
6328 */
6329 for (arg = eap->arg; *arg; ++arg)
6330 {
6331 if (*arg == '\n' || *arg == '\r'
6332 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6333 {
6334 *arg++ = NUL;
6335 eap->nextcmd = arg;
6336 break;
6337 }
6338 }
6339 arg = eap->arg;
6340
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006341 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006343 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 return;
6345 }
6346
6347 if (eap->skip) /* not executing commands */
6348 return;
6349 }
6350 else
6351 arg = (char_u *)"";
6352
6353 /* remove trailing blanks */
6354 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006355 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 *p-- = NUL;
6357
6358#ifdef FEAT_MULTI_LANG
6359 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006360 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361#endif
6362
6363 /* When no argument given go to the index. */
6364 if (*arg == NUL)
6365 arg = (char_u *)"help.txt";
6366
6367 /*
6368 * Check if there is a match for the argument.
6369 */
6370 n = find_help_tags(arg, &num_matches, &matches,
6371 eap != NULL && eap->forceit);
6372
6373 i = 0;
6374#ifdef FEAT_MULTI_LANG
6375 if (n != FAIL && lang != NULL)
6376 /* Find first item with the requested language. */
6377 for (i = 0; i < num_matches; ++i)
6378 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006379 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 if (len > 3 && matches[i][len - 3] == '@'
6381 && STRICMP(matches[i] + len - 2, lang) == 0)
6382 break;
6383 }
6384#endif
6385 if (i >= num_matches || n == FAIL)
6386 {
6387#ifdef FEAT_MULTI_LANG
6388 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006389 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 else
6391#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006392 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 if (n != FAIL)
6394 FreeWild(num_matches, matches);
6395 return;
6396 }
6397
6398 /* The first match (in the requested language) is the best match. */
6399 tag = vim_strsave(matches[i]);
6400 FreeWild(num_matches, matches);
6401
6402#ifdef FEAT_GUI
6403 need_mouse_correct = TRUE;
6404#endif
6405
6406 /*
6407 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006408 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006410 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006412 if (cmdmod.tab != 0)
6413 wp = NULL;
6414 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006415 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006416 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006417 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6419 win_enter(wp, TRUE);
6420 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 {
6422 /*
6423 * There is no help window yet.
6424 * Try to open the file specified by the "helpfile" option.
6425 */
6426 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006428 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 goto erret;
6430 }
6431 fclose(helpfd);
6432
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006434 * specified, the current window is vertically split and
6435 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006438 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006441 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 if (curwin->w_height < p_hh)
6444 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445
6446 /*
6447 * Open help file (do_ecmd() will set b_help flag, readfile() will
6448 * set b_p_ro flag).
6449 * Set the alternate file to the previously edited file.
6450 */
6451 alt_fnum = curbuf->b_fnum;
6452 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006453 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006454 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006455 if (!cmdmod.keepalt)
6456 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 empty_fnum = curbuf->b_fnum;
6458 }
6459 }
6460
6461 if (!p_im)
6462 restart_edit = 0; /* don't want insert mode in help file */
6463
Bram Moolenaar8f535582011-09-30 17:30:31 +02006464#ifdef FEAT_FOLDING
6465 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6466 * It is needed for do_tag top open folds under the cursor. */
6467 KeyTyped = old_KeyTyped;
6468#endif
6469
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 if (tag != NULL)
6471 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6472
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006473 /* Delete the empty buffer if we're not using it. Careful: autocommands
6474 * may have jumped to another window, check that the buffer is not in a
6475 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6477 {
6478 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006479 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 wipe_buffer(buf, TRUE);
6481 }
6482
6483 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006484 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 curwin->w_alt_fnum = alt_fnum;
6486
6487erret:
6488 vim_free(tag);
6489}
6490
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006491/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006492 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006493 */
6494 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006495ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006496{
6497 win_T *win;
6498
6499 FOR_ALL_WINDOWS(win)
6500 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006501 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006502 {
6503 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006504 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006505 }
6506 }
6507}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006509#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6510/*
6511 * In an argument search for a language specifiers in the form "@xx".
6512 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6513 * Returns NULL if not found.
6514 */
6515 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006516check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006517{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006518 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006519
6520 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6521 && ASCII_ISALPHA(arg[len - 1]))
6522 {
6523 arg[len - 3] = NUL; /* remove the '@' */
6524 return arg + len - 2;
6525 }
6526 return NULL;
6527}
6528#endif
6529
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530/*
6531 * Return a heuristic indicating how well the given string matches. The
6532 * smaller the number, the better the match. This is the order of priorities,
6533 * from best match to worst match:
6534 * - Match with least alpha-numeric characters is better.
6535 * - Match with least total characters is better.
6536 * - Match towards the start is better.
6537 * - Match starting with "+" is worse (feature instead of command)
6538 * Assumption is made that the matched_string passed has already been found to
6539 * match some string for which help is requested. webb.
6540 */
6541 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006542help_heuristic(
6543 char_u *matched_string,
6544 int offset, /* offset for match */
6545 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546{
6547 int num_letters;
6548 char_u *p;
6549
6550 num_letters = 0;
6551 for (p = matched_string; *p; p++)
6552 if (ASCII_ISALNUM(*p))
6553 num_letters++;
6554
6555 /*
6556 * Multiply the number of letters by 100 to give it a much bigger
6557 * weighting than the number of characters.
6558 * If there only is a match while ignoring case, add 5000.
6559 * If the match starts in the middle of a word, add 10000 to put it
6560 * somewhere in the last half.
6561 * If the match is more than 2 chars from the start, multiply by 200 to
6562 * put it after matches at the start.
6563 */
6564 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6565 && ASCII_ISALNUM(matched_string[offset - 1]))
6566 offset += 10000;
6567 else if (offset > 2)
6568 offset *= 200;
6569 if (wrong_case)
6570 offset += 5000;
6571 /* Features are less interesting than the subjects themselves, but "+"
6572 * alone is not a feature. */
6573 if (matched_string[0] == '+' && matched_string[1] != NUL)
6574 offset += 100;
6575 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6576}
6577
6578/*
6579 * Compare functions for qsort() below, that checks the help heuristics number
6580 * that has been put after the tagname by find_tags().
6581 */
6582 static int
6583#ifdef __BORLANDC__
6584_RTLENTRYF
6585#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006586help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587{
6588 char *p1;
6589 char *p2;
6590
6591 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6592 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6593 return strcmp(p1, p2);
6594}
6595
6596/*
6597 * Find all help tags matching "arg", sort them and return in matches[], with
6598 * the number of matches in num_matches.
6599 * The matches will be sorted with a "best" match algorithm.
6600 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6601 */
6602 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006603find_help_tags(
6604 char_u *arg,
6605 int *num_matches,
6606 char_u ***matches,
6607 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608{
6609 char_u *s, *d;
6610 int i;
6611 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006612 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006613 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006614 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6615 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006616 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006617 "[count]", "[quotex]",
6618 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006619 "[pattern]", "\\|", "\\%$",
6620 "s/\\~", "s/\\U", "s/\\L",
6621 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006623 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006624 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006625 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6626 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006627 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006628 "\\[count]", "\\[quotex]",
6629 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006630 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006631 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006632 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006633 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
6634 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 int flags;
6636
6637 d = IObuff; /* assume IObuff is long enough! */
6638
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006639 if (STRNICMP(arg, "expr-", 5) == 0)
6640 {
6641 // When the string starting with "expr-" and containing '?' and matches
6642 // the table, it is taken literally. Otherwise '?' is recognized as a
6643 // wildcard.
6644 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
6645 if (STRCMP(arg + 5, expr_table[i]) == 0)
6646 {
6647 STRCPY(d, arg);
6648 break;
6649 }
6650 }
6651 else
6652 {
6653 // Recognize a few exceptions to the rule. Some strings that contain
6654 // '*' with "star". Otherwise '*' is recognized as a wildcard.
6655 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
6656 if (STRCMP(arg, mtable[i]) == 0)
6657 {
6658 STRCPY(d, rtable[i]);
6659 break;
6660 }
6661 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662
6663 if (i < 0) /* no match in table */
6664 {
6665 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6666 * Also replace "\%^" and "\%(", they match every tag too.
6667 * Also "\zs", "\z1", etc.
6668 * Also "\@<", "\@=", "\@<=", etc.
6669 * And also "\_$" and "\_^". */
6670 if (arg[0] == '\\'
6671 && ((arg[1] != NUL && arg[2] == NUL)
6672 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6673 && arg[2] != NUL)))
6674 {
6675 STRCPY(d, "/\\\\");
6676 STRCPY(d + 3, arg + 1);
6677 /* Check for "/\\_$", should be "/\\_\$" */
6678 if (d[3] == '_' && d[4] == '$')
6679 STRCPY(d + 4, "\\$");
6680 }
6681 else
6682 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006683 /* Replace:
6684 * "[:...:]" with "\[:...:]"
6685 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006686 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006687 */
6688 if ((arg[0] == '[' && (arg[1] == ':'
6689 || (arg[1] == '+' && arg[2] == '+')))
6690 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 *d++ = '\\';
6692
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006693 /*
6694 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6695 */
6696 if (*arg == '(' && arg[1] == '\'')
6697 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 for (s = arg; *s; ++s)
6699 {
6700 /*
6701 * Replace "|" with "bar" and '"' with "quote" to match the name of
6702 * the tags for these commands.
6703 * Replace "*" with ".*" and "?" with "." to match command line
6704 * completion.
6705 * Insert a backslash before '~', '$' and '.' to avoid their
6706 * special meaning.
6707 */
6708 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6709 break;
6710 switch (*s)
6711 {
6712 case '|': STRCPY(d, "bar");
6713 d += 3;
6714 continue;
6715 case '"': STRCPY(d, "quote");
6716 d += 5;
6717 continue;
6718 case '*': *d++ = '.';
6719 break;
6720 case '?': *d++ = '.';
6721 continue;
6722 case '$':
6723 case '.':
6724 case '~': *d++ = '\\';
6725 break;
6726 }
6727
6728 /*
6729 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6730 * ":help i_^_CTRL-D" work.
6731 * Insert '-' before and after "CTRL-X" when applicable.
6732 */
6733 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6734 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6735 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006736 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6737 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 STRCPY(d, "CTRL-");
6739 d += 5;
6740 if (*s < ' ')
6741 {
6742#ifdef EBCDIC
6743 *d++ = CtrlChar(*s);
6744#else
6745 *d++ = *s + '@';
6746#endif
6747 if (d[-1] == '\\')
6748 *d++ = '\\'; /* double a backslash */
6749 }
6750 else
6751 *d++ = *++s;
6752 if (s[1] != NUL && s[1] != '_')
6753 *d++ = '_'; /* append a '_' */
6754 continue;
6755 }
6756 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6757 *d++ = '\\';
6758
6759 /*
6760 * Insert a backslash before a backslash after a slash, for search
6761 * pattern tags: "/\|" --> "/\\|".
6762 */
6763 else if (s[0] == '\\' && s[1] != '\\'
6764 && *arg == '/' && s == arg + 1)
6765 *d++ = '\\';
6766
6767 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6768 * "CTRL-\_CTRL-N" */
6769 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6770 {
6771 STRCPY(d, "CTRL-\\\\");
6772 d += 7;
6773 s += 6;
6774 }
6775
6776 *d++ = *s;
6777
6778 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006779 * If tag contains "({" or "([", tag terminates at the "(".
6780 * This is for help on functions, e.g.: abs({expr}).
6781 */
6782 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6783 break;
6784
6785 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 * If tag starts with ', toss everything after a second '. Fixes
6787 * CTRL-] on 'option'. (would include the trailing '.').
6788 */
6789 if (*s == '\'' && s > arg && *arg == '\'')
6790 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006791 /* Also '{' and '}'. */
6792 if (*s == '}' && s > arg && *arg == '{')
6793 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 }
6795 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006796
6797 if (*IObuff == '`')
6798 {
6799 if (d > IObuff + 2 && d[-1] == '`')
6800 {
6801 /* remove the backticks from `command` */
6802 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6803 d[-2] = NUL;
6804 }
6805 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6806 {
6807 /* remove the backticks and comma from `command`, */
6808 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6809 d[-3] = NUL;
6810 }
6811 else if (d > IObuff + 4 && d[-3] == '`'
6812 && d[-2] == '\\' && d[-1] == '.')
6813 {
6814 /* remove the backticks and dot from `command`\. */
6815 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6816 d[-4] = NUL;
6817 }
6818 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 }
6820 }
6821
6822 *matches = (char_u **)"";
6823 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02006824 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 if (keep_lang)
6826 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006827 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006829 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 /* Sort the matches found on the heuristic number that is after the
6831 * tag name. */
6832 qsort((void *)*matches, (size_t)*num_matches,
6833 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006834 /* Delete more than TAG_MANY to reduce the size of the listing. */
6835 while (*num_matches > TAG_MANY)
6836 vim_free((*matches)[--*num_matches]);
6837 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 return OK;
6839}
6840
6841/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006842 * Called when starting to edit a buffer for a help file.
6843 */
6844 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006845prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006846{
6847 char_u *p;
6848
6849 curbuf->b_help = TRUE;
6850#ifdef FEAT_QUICKFIX
6851 set_string_option_direct((char_u *)"buftype", -1,
6852 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6853#endif
6854
6855 /*
6856 * Always set these options after jumping to a help tag, because the
6857 * user may have an autocommand that gets in the way.
6858 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6859 * latin1 word characters (for translated help files).
6860 * Only set it when needed, buf_init_chartab() is some work.
6861 */
6862 p =
6863#ifdef EBCDIC
6864 (char_u *)"65-255,^*,^|,^\"";
6865#else
6866 (char_u *)"!-~,^*,^|,^\",192-255";
6867#endif
6868 if (STRCMP(curbuf->b_p_isk, p) != 0)
6869 {
6870 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6871 check_buf_options(curbuf);
6872 (void)buf_init_chartab(curbuf, FALSE);
6873 }
6874
Bram Moolenaar0b105412014-11-30 13:34:23 +01006875#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006876 /* Don't use the global foldmethod.*/
6877 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6878 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006879#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006880
6881 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6882 curwin->w_p_list = FALSE; /* no list mode */
6883
6884 curbuf->b_p_ma = FALSE; /* not modifiable */
6885 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6886 curwin->w_p_nu = 0; /* no line numbers */
6887 curwin->w_p_rnu = 0; /* no relative line numbers */
6888 RESET_BINDING(curwin); /* no scroll or cursor binding */
6889#ifdef FEAT_ARABIC
6890 curwin->w_p_arab = FALSE; /* no arabic mode */
6891#endif
6892#ifdef FEAT_RIGHTLEFT
6893 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6894#endif
6895#ifdef FEAT_FOLDING
6896 curwin->w_p_fen = FALSE; /* No folding in the help window */
6897#endif
6898#ifdef FEAT_DIFF
6899 curwin->w_p_diff = FALSE; /* No 'diff' */
6900#endif
6901#ifdef FEAT_SPELL
6902 curwin->w_p_spell = FALSE; /* No spell checking */
6903#endif
6904
6905 set_buflisted(FALSE);
6906}
6907
6908/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 * After reading a help file: May cleanup a help buffer when syntax
6910 * highlighting is not used.
6911 */
6912 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006913fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914{
6915 linenr_T lnum;
6916 char_u *line;
6917 int in_example = FALSE;
6918 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006919 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 char_u *p;
6921 char_u *rt;
6922 int mustfree;
6923
Bram Moolenaar90492982017-06-22 14:16:31 +02006924 /* Set filetype to "help" if still needed. */
6925 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006926 {
6927 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006928 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006929 --curbuf_lock;
6930 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931
6932#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006933 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934#endif
6935 {
6936 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6937 {
6938 line = ml_get_buf(curbuf, lnum, FALSE);
6939 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006940 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 {
6942 /* End of example: non-white or '<' in first column. */
6943 if (line[0] == '<')
6944 {
6945 /* blank-out a '<' in the first column */
6946 line = ml_get_buf(curbuf, lnum, TRUE);
6947 line[0] = ' ';
6948 }
6949 in_example = FALSE;
6950 }
6951 if (!in_example && len > 0)
6952 {
6953 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6954 {
6955 /* blank-out a '>' in the last column (start of example) */
6956 line = ml_get_buf(curbuf, lnum, TRUE);
6957 line[len - 1] = ' ';
6958 in_example = TRUE;
6959 }
6960 else if (line[len - 1] == '~')
6961 {
6962 /* blank-out a '~' at the end of line (header marker) */
6963 line = ml_get_buf(curbuf, lnum, TRUE);
6964 line[len - 1] = ' ';
6965 }
6966 }
6967 }
6968 }
6969
6970 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006971 * In the "help.txt" and "help.abx" file, add the locally added help
6972 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006974 fname = gettail(curbuf->b_fname);
6975 if (fnamecmp(fname, "help.txt") == 0
6976#ifdef FEAT_MULTI_LANG
6977 || (fnamencmp(fname, "help.", 5) == 0
6978 && ASCII_ISALPHA(fname[5])
6979 && ASCII_ISALPHA(fname[6])
6980 && TOLOWER_ASC(fname[7]) == 'x'
6981 && fname[8] == NUL)
6982#endif
6983 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 {
6985 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6986 {
6987 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006988 if (strstr((char *)line, "*local-additions*") == NULL)
6989 continue;
6990
6991 /* Go through all directories in 'runtimepath', skipping
6992 * $VIMRUNTIME. */
6993 p = p_rtp;
6994 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006996 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6997 mustfree = FALSE;
6998 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006999 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007001 int fcount;
7002 char_u **fnames;
7003 FILE *fd;
7004 char_u *s;
7005 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007006 vimconv_T vc;
7007 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007009 /* Find all "doc/ *.txt" files in this directory. */
7010 add_pathsep(NameBuff);
7011#ifdef FEAT_MULTI_LANG
7012 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007014 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007016 if (gen_expand_wildcards(1, &NameBuff, &fcount,
7017 &fnames, EW_FILE|EW_SILENT) == OK
7018 && fcount > 0)
7019 {
7020#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007021 int i1, i2;
7022 char_u *f1, *f2;
7023 char_u *t1, *t2;
7024 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007025
7026 /* If foo.abx is found use it instead of foo.txt in
7027 * the same directory. */
7028 for (i1 = 0; i1 < fcount; ++i1)
7029 {
7030 for (i2 = 0; i2 < fcount; ++i2)
7031 {
7032 if (i1 == i2)
7033 continue;
7034 if (fnames[i1] == NULL || fnames[i2] == NULL)
7035 continue;
7036 f1 = fnames[i1];
7037 f2 = fnames[i2];
7038 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007039 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007040 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007041 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02007042 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007043 continue;
7044 if (fnamecmp(e1, ".txt") != 0
7045 && fnamecmp(e1, fname + 4) != 0)
7046 {
7047 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007048 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007049 continue;
7050 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007051 if (e1 - f1 != e2 - f2
7052 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007053 continue;
7054 if (fnamecmp(e1, ".txt") == 0
7055 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007056 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007057 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007060#endif
7061 for (fi = 0; fi < fcount; ++fi)
7062 {
7063 if (fnames[fi] == NULL)
7064 continue;
7065 fd = mch_fopen((char *)fnames[fi], "r");
7066 if (fd != NULL)
7067 {
7068 vim_fgets(IObuff, IOSIZE, fd);
7069 if (IObuff[0] == '*'
7070 && (s = vim_strchr(IObuff + 1, '*'))
7071 != NULL)
7072 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007073 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01007074
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007075 /* Change tag definition to a
7076 * reference and remove <CR>/<NL>. */
7077 IObuff[0] = '|';
7078 *s = '|';
7079 while (*s != NUL)
7080 {
7081 if (*s == '\r' || *s == '\n')
7082 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007083 /* The text is utf-8 when a byte
7084 * above 127 is found and no
7085 * illegal byte sequence is found.
7086 */
7087 if (*s >= 0x80 && this_utf != FALSE)
7088 {
7089 int l;
7090
7091 this_utf = TRUE;
7092 l = utf_ptr2len(s);
7093 if (l == 1)
7094 this_utf = FALSE;
7095 s += l - 1;
7096 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007097 ++s;
7098 }
Bram Moolenaar13505972019-01-24 15:04:48 +01007099
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007100 /* The help file is latin1 or utf-8;
7101 * conversion to the current
7102 * 'encoding' may be required. */
7103 vc.vc_type = CONV_NONE;
7104 convert_setup(&vc, (char_u *)(
7105 this_utf == TRUE ? "utf-8"
7106 : "latin1"), p_enc);
7107 if (vc.vc_type == CONV_NONE)
7108 /* No conversion needed. */
7109 cp = IObuff;
7110 else
7111 {
7112 /* Do the conversion. If it fails
7113 * use the unconverted text. */
7114 cp = string_convert(&vc, IObuff,
7115 NULL);
7116 if (cp == NULL)
7117 cp = IObuff;
7118 }
7119 convert_setup(&vc, NULL, NULL);
7120
7121 ml_append(lnum, cp, (colnr_T)0, FALSE);
7122 if (cp != IObuff)
7123 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007124 ++lnum;
7125 }
7126 fclose(fd);
7127 }
7128 }
7129 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007132 if (mustfree)
7133 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007135 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 }
7137 }
7138}
7139
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007140/*
7141 * ":exusage"
7142 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007143 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007144ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007145{
7146 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7147}
7148
7149/*
7150 * ":viusage"
7151 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007152 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007153ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007154{
7155 do_cmdline_cmd((char_u *)"help normal-index");
7156}
7157
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007159 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007162helptags_one(
7163 char_u *dir, /* doc directory */
7164 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7165 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7166 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167{
7168 FILE *fd_tags;
7169 FILE *fd;
7170 garray_T ga;
7171 int filecount;
7172 char_u **files;
7173 char_u *p1, *p2;
7174 int fi;
7175 char_u *s;
7176 int i;
7177 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007178 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 int utf8 = MAYBE;
7180 int this_utf8;
7181 int firstline;
7182 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183
7184 /*
7185 * Find all *.txt files.
7186 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007187 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007189 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 STRCAT(NameBuff, ext);
7191 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7192 EW_FILE|EW_SILENT) == FAIL
7193 || filecount == 0)
7194 {
7195 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007196 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 return;
7198 }
7199
7200 /*
7201 * Open the tags file for writing.
7202 * Do this before scanning through all the files.
7203 */
7204 STRCPY(NameBuff, dir);
7205 add_pathsep(NameBuff);
7206 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007207 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 if (fd_tags == NULL)
7209 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007210 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 FreeWild(filecount, files);
7212 return;
7213 }
7214
7215 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007216 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7217 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 */
7219 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007220 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7221 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 {
7223 if (ga_grow(&ga, 1) == FAIL)
7224 got_int = TRUE;
7225 else
7226 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007227 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 if (s == NULL)
7229 got_int = TRUE;
7230 else
7231 {
7232 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7233 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7234 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 }
7236 }
7237 }
7238
7239 /*
7240 * Go over all the files and extract the tags.
7241 */
7242 for (fi = 0; fi < filecount && !got_int; ++fi)
7243 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007244 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 if (fd == NULL)
7246 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007247 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 continue;
7249 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007250 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7254 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 if (firstline)
7256 {
7257 /* Detect utf-8 file by a non-ASCII char in the first line. */
7258 this_utf8 = MAYBE;
7259 for (s = IObuff; *s != NUL; ++s)
7260 if (*s >= 0x80)
7261 {
7262 int l;
7263
7264 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007265 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 if (l == 1)
7267 {
7268 /* Illegal UTF-8 byte sequence. */
7269 this_utf8 = FALSE;
7270 break;
7271 }
7272 s += l - 1;
7273 }
7274 if (this_utf8 == MAYBE) /* only ASCII characters found */
7275 this_utf8 = FALSE;
7276 if (utf8 == MAYBE) /* first file */
7277 utf8 = this_utf8;
7278 else if (utf8 != this_utf8)
7279 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007280 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 mix = !got_int;
7282 got_int = TRUE;
7283 }
7284 firstline = FALSE;
7285 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7287 while (p1 != NULL)
7288 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007289 /* Use vim_strbyte() instead of vim_strchr() so that when
7290 * 'encoding' is dbcs it still works, don't find '*' in the
7291 * second byte. */
7292 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7294 {
7295 for (s = p1 + 1; s < p2; ++s)
7296 if (*s == ' ' || *s == '\t' || *s == '|')
7297 break;
7298
7299 /*
7300 * Only accept a *tag* when it consists of valid
7301 * characters, there is white space before it and is
7302 * followed by a white character or end-of-line.
7303 */
7304 if (s == p2
7305 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7306 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7307 || s[1] == '\0'))
7308 {
7309 *p2 = '\0';
7310 ++p1;
7311 if (ga_grow(&ga, 1) == FAIL)
7312 {
7313 got_int = TRUE;
7314 break;
7315 }
7316 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7317 if (s == NULL)
7318 {
7319 got_int = TRUE;
7320 break;
7321 }
7322 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7323 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 sprintf((char *)s, "%s\t%s", p1, fname);
7325
7326 /* find next '*' */
7327 p2 = vim_strchr(p2 + 1, '*');
7328 }
7329 }
7330 p1 = p2;
7331 }
7332 line_breakcheck();
7333 }
7334
7335 fclose(fd);
7336 }
7337
7338 FreeWild(filecount, files);
7339
7340 if (!got_int)
7341 {
7342 /*
7343 * Sort the tags.
7344 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007345 if (ga.ga_data != NULL)
7346 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347
7348 /*
7349 * Check for duplicates.
7350 */
7351 for (i = 1; i < ga.ga_len; ++i)
7352 {
7353 p1 = ((char_u **)ga.ga_data)[i - 1];
7354 p2 = ((char_u **)ga.ga_data)[i];
7355 while (*p1 == *p2)
7356 {
7357 if (*p2 == '\t')
7358 {
7359 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007360 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7362 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007363 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 *p2 = '\t';
7365 break;
7366 }
7367 ++p1;
7368 ++p2;
7369 }
7370 }
7371
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 if (utf8 == TRUE)
7373 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374
7375 /*
7376 * Write the tags into the file.
7377 */
7378 for (i = 0; i < ga.ga_len; ++i)
7379 {
7380 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007381 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007383 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 else
7385 {
7386 fprintf(fd_tags, "%s\t/*", s);
7387 for (p1 = s; *p1 != '\t'; ++p1)
7388 {
7389 /* insert backslash before '\\' and '/' */
7390 if (*p1 == '\\' || *p1 == '/')
7391 putc('\\', fd_tags);
7392 putc(*p1, fd_tags);
7393 }
7394 fprintf(fd_tags, "*\n");
7395 }
7396 }
7397 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 if (mix)
7399 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400
7401 for (i = 0; i < ga.ga_len; ++i)
7402 vim_free(((char_u **)ga.ga_data)[i]);
7403 ga_clear(&ga);
7404 fclose(fd_tags); /* there is no check for an error... */
7405}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007407/*
7408 * Generate tags in one help directory, taking care of translations.
7409 */
7410 static void
7411do_helptags(char_u *dirname, int add_help_tags)
7412{
7413#ifdef FEAT_MULTI_LANG
7414 int len;
7415 int i, j;
7416 garray_T ga;
7417 char_u lang[2];
7418 char_u ext[5];
7419 char_u fname[8];
7420 int filecount;
7421 char_u **files;
7422
7423 /* Get a list of all files in the help directory and in subdirectories. */
7424 STRCPY(NameBuff, dirname);
7425 add_pathsep(NameBuff);
7426 STRCAT(NameBuff, "**");
7427 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7428 EW_FILE|EW_SILENT) == FAIL
7429 || filecount == 0)
7430 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007431 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007432 return;
7433 }
7434
7435 /* Go over all files in the directory to find out what languages are
7436 * present. */
7437 ga_init2(&ga, 1, 10);
7438 for (i = 0; i < filecount; ++i)
7439 {
7440 len = (int)STRLEN(files[i]);
7441 if (len > 4)
7442 {
7443 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7444 {
7445 /* ".txt" -> language "en" */
7446 lang[0] = 'e';
7447 lang[1] = 'n';
7448 }
7449 else if (files[i][len - 4] == '.'
7450 && ASCII_ISALPHA(files[i][len - 3])
7451 && ASCII_ISALPHA(files[i][len - 2])
7452 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7453 {
7454 /* ".abx" -> language "ab" */
7455 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7456 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7457 }
7458 else
7459 continue;
7460
7461 /* Did we find this language already? */
7462 for (j = 0; j < ga.ga_len; j += 2)
7463 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7464 break;
7465 if (j == ga.ga_len)
7466 {
7467 /* New language, add it. */
7468 if (ga_grow(&ga, 2) == FAIL)
7469 break;
7470 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7471 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7472 }
7473 }
7474 }
7475
7476 /*
7477 * Loop over the found languages to generate a tags file for each one.
7478 */
7479 for (j = 0; j < ga.ga_len; j += 2)
7480 {
7481 STRCPY(fname, "tags-xx");
7482 fname[5] = ((char_u *)ga.ga_data)[j];
7483 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7484 if (fname[5] == 'e' && fname[6] == 'n')
7485 {
7486 /* English is an exception: use ".txt" and "tags". */
7487 fname[4] = NUL;
7488 STRCPY(ext, ".txt");
7489 }
7490 else
7491 {
7492 /* Language "ab" uses ".abx" and "tags-ab". */
7493 STRCPY(ext, ".xxx");
7494 ext[1] = fname[5];
7495 ext[2] = fname[6];
7496 }
7497 helptags_one(dirname, ext, fname, add_help_tags);
7498 }
7499
7500 ga_clear(&ga);
7501 FreeWild(filecount, files);
7502
7503#else
7504 /* No language support, just use "*.txt" and "tags". */
7505 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7506#endif
7507}
7508
7509 static void
7510helptags_cb(char_u *fname, void *cookie)
7511{
7512 do_helptags(fname, *(int *)cookie);
7513}
7514
7515/*
7516 * ":helptags"
7517 */
7518 void
7519ex_helptags(exarg_T *eap)
7520{
7521 expand_T xpc;
7522 char_u *dirname;
7523 int add_help_tags = FALSE;
7524
7525 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007526 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007527 {
7528 add_help_tags = TRUE;
7529 eap->arg = skipwhite(eap->arg + 3);
7530 }
7531
7532 if (STRCMP(eap->arg, "ALL") == 0)
7533 {
7534 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7535 helptags_cb, &add_help_tags);
7536 }
7537 else
7538 {
7539 ExpandInit(&xpc);
7540 xpc.xp_context = EXPAND_DIRECTORIES;
7541 dirname = ExpandOne(&xpc, eap->arg, NULL,
7542 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7543 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007544 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007545 else
7546 do_helptags(dirname, add_help_tags);
7547 vim_free(dirname);
7548 }
7549}
7550
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007551/*
7552 * Make the user happy.
7553 */
7554 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007555ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007556{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007557 static char *code[] = {
7558 "\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$",
7559 "\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"
7560 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007561 char *p;
7562 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007563 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007564
7565 msg_start();
7566 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007567 for (i = 0; i < 2; ++i)
7568 for (p = code[i]; *p != NUL; ++p)
7569 if (*p == 'x')
7570 msg_putchar('\n');
7571 else
7572 for (n = *p++; n > 0; --n)
7573 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01007574 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007575 else
7576 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007577 msg_clr_eos();
7578}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580/*
7581 * ":drop"
7582 * Opens the first argument in a window. When there are two or more arguments
7583 * the argument list is redefined.
7584 */
7585 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007586ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587{
7588 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 win_T *wp;
7590 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007591 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
7593 /*
7594 * Check if the first argument is already being edited in a window. If
7595 * so, jump to that window.
7596 * We would actually need to check all arguments, but that's complicated
7597 * and mostly only one file is dropped.
7598 * This also ignores wildcards, since it is very unlikely the user is
7599 * editing a file name with a wildcard character.
7600 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007601 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007603 /*
7604 * Expanding wildcards may result in an empty argument list. E.g. when
7605 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7606 * already did an error message for this.
7607 */
7608 if (ARGCOUNT == 0)
7609 return;
7610
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007611 if (cmdmod.tab)
7612 {
7613 /* ":tab drop file ...": open a tab for each argument that isn't
7614 * edited in a window yet. It's like ":tab all" but without closing
7615 * windows or tabs. */
7616 ex_all(eap);
7617 }
7618 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007619 {
7620 /* ":drop file ...": Edit the first argument. Jump to an existing
7621 * window if possible, edit in current window if the current buffer
7622 * can be abandoned, otherwise open a new window. */
7623 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7624
7625 FOR_ALL_TAB_WINDOWS(tp, wp)
7626 {
7627 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007629 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 return;
7632 }
7633 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007635 /*
7636 * Check whether the current buffer is changed. If so, we will need
7637 * to split the current window or data could be lost.
7638 * Skip the check if the 'hidden' option is set, as in this case the
7639 * buffer won't be lost.
7640 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02007641 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007642 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007643 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01007644 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007645 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007646 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007648 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7649 if (split)
7650 {
7651 eap->cmdidx = CMD_sfirst;
7652 eap->cmd[0] = 's';
7653 }
7654 else
7655 eap->cmdidx = CMD_first;
7656 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007659
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007660/*
7661 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
7662 * Put the start of the pattern in "*s", unless "s" is NULL.
7663 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
7664 * If "s" is not NULL terminate the pattern with a NUL.
7665 * Return a pointer to the char just past the pattern plus flags.
7666 */
7667 char_u *
7668skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
7669{
7670 int c;
7671
7672 if (vim_isIDc(*p))
7673 {
7674 /* ":vimgrep pattern fname" */
7675 if (s != NULL)
7676 *s = p;
7677 p = skiptowhite(p);
7678 if (s != NULL && *p != NUL)
7679 *p++ = NUL;
7680 }
7681 else
7682 {
7683 /* ":vimgrep /pattern/[g][j] fname" */
7684 if (s != NULL)
7685 *s = p + 1;
7686 c = *p;
7687 p = skip_regexp(p + 1, c, TRUE, NULL);
7688 if (*p != c)
7689 return NULL;
7690
7691 /* Truncate the pattern. */
7692 if (s != NULL)
7693 *p = NUL;
7694 ++p;
7695
7696 /* Find the flags */
7697 while (*p == 'g' || *p == 'j')
7698 {
7699 if (flags != NULL)
7700 {
7701 if (*p == 'g')
7702 *flags |= VGR_GLOBAL;
7703 else
7704 *flags |= VGR_NOJUMP;
7705 }
7706 ++p;
7707 }
7708 }
7709 return p;
7710}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007711
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007712#if defined(FEAT_EVAL) || defined(PROTO)
7713/*
7714 * List v:oldfiles in a nice way.
7715 */
7716 void
7717ex_oldfiles(exarg_T *eap UNUSED)
7718{
7719 list_T *l = get_vim_var_list(VV_OLDFILES);
7720 listitem_T *li;
7721 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007722 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007723
7724 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007725 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007726 else
7727 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007728 msg_start();
7729 msg_scroll = TRUE;
7730 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
7731 {
7732 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007733 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02007734 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007735 {
7736 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01007737 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007738 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02007739 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007740 msg_putchar('\n');
7741 out_flush(); /* output one line at a time */
7742 ui_breakcheck();
7743 }
7744 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007745
7746 /* Assume "got_int" was set to truncate the listing. */
7747 got_int = FALSE;
7748
7749# ifdef FEAT_BROWSE_CMD
7750 if (cmdmod.browse)
7751 {
7752 quit_more = FALSE;
7753 nr = prompt_for_number(FALSE);
7754 msg_starthere();
7755 if (nr > 0)
7756 {
7757 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
7758 (long)nr);
7759
7760 if (p != NULL)
7761 {
7762 p = expand_env_save(p);
7763 eap->arg = p;
7764 eap->cmdidx = CMD_edit;
7765 cmdmod.browse = FALSE;
7766 do_exedit(eap, NULL);
7767 vim_free(p);
7768 }
7769 }
7770 }
7771# endif
7772 }
7773}
7774#endif