blob: da10c1291a76c302486a0bf11fa10187ce3d3d82 [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{
299 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100300 union {
301 struct
302 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200303 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 Moolenaar22fcfad2016-07-01 18:17:26 +0200306 varnumber_T value; /* value if sorting by integer */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100307#ifdef FEAT_FLOAT
308 float_T value_flt; /* value if sorting by float */
309#endif
310 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000311} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000312
313static int
314#ifdef __BORLANDC__
315_RTLENTRYF
316#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100317sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000318
319 static int
320#ifdef __BORLANDC__
321_RTLENTRYF
322#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100323sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000324{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000325 sorti_T l1 = *(sorti_T *)s1;
326 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000327 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000328
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000329 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000330 * if we return 0 every time, qsort will assume it's done sorting and
331 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000332 if (sort_abort)
333 return 0;
334 fast_breakcheck();
335 if (got_int)
336 sort_abort = TRUE;
337
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000338 /* When sorting numbers "start_col_nr" is the number, not the column
339 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000340 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100341 result = l1.st_u.value == l2.st_u.value ? 0
342 : l1.st_u.value > l2.st_u.value ? 1 : -1;
343#ifdef FEAT_FLOAT
344 else if (sort_flt)
345 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
346 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
347#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000348 else
349 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000350 /* We need to copy one line into "sortbuf1", because there is no
351 * guarantee that the first pointer becomes invalid when obtaining the
352 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100353 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
354 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
355 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
356 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
357 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
358 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000359
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000360 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
361 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000362 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000363
364 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000365 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000366 return (int)(l1.lnum - l2.lnum);
367 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000368}
369
370/*
371 * ":sort".
372 */
373 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100374ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000375{
376 regmatch_T regmatch;
377 int len;
378 linenr_T lnum;
379 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000380 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000381 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000382 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000383 char_u *p;
384 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000385 char_u *s2;
386 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387 int unique = FALSE;
388 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000389 colnr_T start_col;
390 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100391 int sort_what = 0;
392 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200393 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000394
Bram Moolenaar48c99162008-02-18 18:42:52 +0000395 /* Sorting one line is really quick! */
396 if (count <= 1)
397 return;
398
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000399 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
400 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000401 sortbuf1 = NULL;
402 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000403 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000404 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000405 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000406 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000407
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100408 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100409#ifdef FEAT_FLOAT
410 sort_flt = 0;
411#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000412
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000413 for (p = eap->arg; *p != NUL; ++p)
414 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100415 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000416 ;
417 else if (*p == 'i')
418 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000419 else if (*p == 'r')
420 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000421 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100422 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100423 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100424 ++format_found;
425 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100426#ifdef FEAT_FLOAT
427 else if (*p == 'f')
428 {
429 sort_flt = 1;
430 ++format_found;
431 }
432#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100433 else if (*p == 'b')
434 {
435 sort_what = STR2NR_BIN + STR2NR_FORCE;
436 ++format_found;
437 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000438 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100439 {
440 sort_what = STR2NR_OCT + STR2NR_FORCE;
441 ++format_found;
442 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000443 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100444 {
445 sort_what = STR2NR_HEX + STR2NR_FORCE;
446 ++format_found;
447 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000448 else if (*p == 'u')
449 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000450 else if (*p == '"') /* comment start */
451 break;
452 else if (check_nextcmd(p) != NULL)
453 {
454 eap->nextcmd = check_nextcmd(p);
455 break;
456 }
457 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000458 {
459 s = skip_regexp(p + 1, *p, TRUE, NULL);
460 if (*s != *p)
461 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100462 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000463 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000464 }
465 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000466 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100467 if (s == p + 1)
468 {
469 if (last_search_pat() == NULL)
470 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100471 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100472 goto sortend;
473 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000474 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100475 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000476 else
477 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000478 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000479 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000480 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000481 regmatch.rm_ic = p_ic;
482 }
483 else
484 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100485 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000487 }
488 }
489
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100490 /* Can only have one of 'n', 'b', 'o' and 'x'. */
491 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000492 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100493 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000494 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495 }
496
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100497 /* From here on "sort_nr" is used as a flag for any integer number
498 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100499 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000500
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000503 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 * When sorting on strings "start_col_nr" is the offset in the line, for
505 * numbers sorting it's the number to sort on. This means the pattern
506 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 */
509 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
510 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000511 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000512 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000513 if (maxlen < len)
514 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000515
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000516 start_col = 0;
517 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000518 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 {
520 if (sort_rx)
521 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000522 start_col = (colnr_T)(regmatch.startp[0] - s);
523 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000524 }
525 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000526 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000527 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000528 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000529 if (regmatch.regprog != NULL)
530 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000531
Bram Moolenaar937204a2016-01-30 23:37:38 +0100532 if (sort_nr
533#ifdef FEAT_FLOAT
534 || sort_flt
535#endif
536 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000537 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000538 /* Make sure vim_str2nr doesn't read any digits past the end
539 * of the match, by temporarily terminating the string there */
540 s2 = s + end_col;
541 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200542 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000543 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000544 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100545 if (sort_nr)
546 {
547 if (sort_what & STR2NR_HEX)
548 s = skiptohex(p);
549 else if (sort_what & STR2NR_BIN)
550 s = skiptobin(p);
551 else
552 s = skiptodigit(p);
553 if (s > p && s[-1] == '-')
554 --s; /* include preceding negative sign */
555 if (*s == NUL)
556 /* empty line should sort before any number */
557 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
558 else
559 vim_str2nr(s, NULL, NULL, sort_what,
560 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
561 }
562#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000563 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100564 {
565 s = skipwhite(p);
566 if (*s == '+')
567 s = skipwhite(s + 1);
568
569 if (*s == NUL)
570 /* empty line should sort before any number */
571 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
572 else
573 nrs[lnum - eap->line1].st_u.value_flt =
574 strtod((char *)s, NULL);
575 }
576#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200577 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000578 }
579 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000580 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000581 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100582 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
583 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000584 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000585
586 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000587
588 if (regmatch.regprog != NULL)
589 fast_breakcheck();
590 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000591 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000592 }
593
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000594 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000595 sortbuf1 = alloc((unsigned)maxlen + 1);
596 if (sortbuf1 == NULL)
597 goto sortend;
598 sortbuf2 = alloc((unsigned)maxlen + 1);
599 if (sortbuf2 == NULL)
600 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000601
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000602 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000603 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000604
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000605 if (sort_abort)
606 goto sortend;
607
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 /* Insert the lines in the sorted order below the last one. */
609 lnum = eap->line2;
610 for (i = 0; i < count; ++i)
611 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200612 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
613
614 // If the original line number of the line being placed is not the same
615 // as "lnum" (accounting for offset), we know that the buffer changed.
616 if (get_lnum + ((linenr_T)count - 1) != lnum)
617 change_occurred = TRUE;
618
619 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000620 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000621 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000622 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200623 // Copy the line into a buffer, it may become invalid in
624 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100625 STRCPY(sortbuf1, s);
626 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000627 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000628 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000629 fast_breakcheck();
630 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000631 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000632 }
633
634 /* delete the original lines if appending worked */
635 if (i == count)
636 for (i = 0; i < count; ++i)
637 ml_delete(eap->line1, FALSE);
638 else
639 count = 0;
640
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000641 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000642 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000643 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200644 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200646 msgmore(-deleted);
647 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000648 else if (deleted < 0)
649 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200650
651 if (change_occurred || deleted != 0)
652 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000653
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000654 curwin->w_cursor.lnum = eap->line1;
655 beginline(BL_WHITE | BL_FIX);
656
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000657sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000658 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000659 vim_free(sortbuf1);
660 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200661 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000662 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100663 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000664}
665
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666/*
667 * ":retab".
668 */
669 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100670ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671{
672 linenr_T lnum;
673 int got_tab = FALSE;
674 long num_spaces = 0;
675 long num_tabs;
676 long len;
677 long col;
678 long vcol;
679 long start_col = 0; /* For start of white-space string */
680 long start_vcol = 0; /* For start of white-space string */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 long old_len;
682 char_u *ptr;
683 char_u *new_line = (char_u *)1; /* init to non-NULL */
684 int did_undo; /* called u_save for current line */
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200685#ifdef FEAT_VARTABS
Bram Moolenaar0119a592018-06-24 23:53:28 +0200686 int *new_vts_array = NULL;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200687 char_u *new_ts_str; /* string value of tab argument */
688#else
689 int temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 int new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200691#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 int save_list;
693 linenr_T first_line = 0; /* first changed line */
694 linenr_T last_line = 0; /* last changed line */
695
696 save_list = curwin->w_p_list;
697 curwin->w_p_list = 0; /* don't want list mode here */
698
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200699#ifdef FEAT_VARTABS
700 new_ts_str = eap->arg;
Bram Moolenaar0119a592018-06-24 23:53:28 +0200701 if (!tabstop_set(eap->arg, &new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200702 return;
703 while (vim_isdigit(*(eap->arg)) || *(eap->arg) == ',')
704 ++(eap->arg);
705
Bram Moolenaar0119a592018-06-24 23:53:28 +0200706 // This ensures that either new_vts_array and new_ts_str are freshly
707 // allocated, or new_vts_array points to an existing array and new_ts_str
708 // is null.
709 if (new_vts_array == NULL)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200710 {
Bram Moolenaar0119a592018-06-24 23:53:28 +0200711 new_vts_array = curbuf->b_p_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200712 new_ts_str = NULL;
713 }
714 else
715 new_ts_str = vim_strnsave(new_ts_str, eap->arg - new_ts_str);
716#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 new_ts = getdigits(&(eap->arg));
718 if (new_ts < 0)
719 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100720 emsg(_(e_positive));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 return;
722 }
723 if (new_ts == 0)
724 new_ts = curbuf->b_p_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200725#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
727 {
728 ptr = ml_get(lnum);
729 col = 0;
730 vcol = 0;
731 did_undo = FALSE;
732 for (;;)
733 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100734 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 {
736 if (!got_tab && num_spaces == 0)
737 {
738 /* First consecutive white-space */
739 start_vcol = vcol;
740 start_col = col;
741 }
742 if (ptr[col] == ' ')
743 num_spaces++;
744 else
745 got_tab = TRUE;
746 }
747 else
748 {
749 if (got_tab || (eap->forceit && num_spaces > 1))
750 {
751 /* Retabulate this string of white-space */
752
753 /* len is virtual length of white string */
754 len = num_spaces = vcol - start_vcol;
755 num_tabs = 0;
756 if (!curbuf->b_p_et)
757 {
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200758#ifdef FEAT_VARTABS
759 int t, s;
760
761 tabstop_fromto(start_vcol, vcol,
Bram Moolenaar0119a592018-06-24 23:53:28 +0200762 curbuf->b_p_ts, new_vts_array, &t, &s);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200763 num_tabs = t;
764 num_spaces = s;
765#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 temp = new_ts - (start_vcol % new_ts);
767 if (num_spaces >= temp)
768 {
769 num_spaces -= temp;
770 num_tabs++;
771 }
772 num_tabs += num_spaces / new_ts;
773 num_spaces -= (num_spaces / new_ts) * new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200774#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 }
776 if (curbuf->b_p_et || got_tab ||
777 (num_spaces + num_tabs < len))
778 {
779 if (did_undo == FALSE)
780 {
781 did_undo = TRUE;
782 if (u_save((linenr_T)(lnum - 1),
783 (linenr_T)(lnum + 1)) == FAIL)
784 {
785 new_line = NULL; /* flag out-of-memory */
786 break;
787 }
788 }
789
790 /* len is actual number of white characters used */
791 len = num_spaces + num_tabs;
792 old_len = (long)STRLEN(ptr);
793 new_line = lalloc(old_len - col + start_col + len + 1,
794 TRUE);
795 if (new_line == NULL)
796 break;
797 if (start_col > 0)
798 mch_memmove(new_line, ptr, (size_t)start_col);
799 mch_memmove(new_line + start_col + len,
800 ptr + col, (size_t)(old_len - col + 1));
801 ptr = new_line + start_col;
802 for (col = 0; col < len; col++)
803 ptr[col] = (col < num_tabs) ? '\t' : ' ';
804 ml_replace(lnum, new_line, FALSE);
805 if (first_line == 0)
806 first_line = lnum;
807 last_line = lnum;
808 ptr = new_line;
809 col = start_col + len;
810 }
811 }
812 got_tab = FALSE;
813 num_spaces = 0;
814 }
815 if (ptr[col] == NUL)
816 break;
817 vcol += chartabsize(ptr + col, (colnr_T)vcol);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000819 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 ++col;
822 }
823 if (new_line == NULL) /* out of memory */
824 break;
825 line_breakcheck();
826 }
827 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100828 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200830#ifdef FEAT_VARTABS
831 // If a single value was given then it can be considered equal to
832 // either the value of 'tabstop' or the value of 'vartabstop'.
833 if (tabstop_count(curbuf->b_p_vts_array) == 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200834 && tabstop_count(new_vts_array) == 1
835 && curbuf->b_p_ts == tabstop_first(new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200836 ; /* not changed */
837 else if (tabstop_count(curbuf->b_p_vts_array) > 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200838 && tabstop_eq(curbuf->b_p_vts_array, new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200839 ; /* not changed */
840 else
841 redraw_curbuf_later(NOT_VALID);
842#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 if (curbuf->b_p_ts != new_ts)
844 redraw_curbuf_later(NOT_VALID);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200845#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 if (first_line != 0)
847 changed_lines(first_line, 0, last_line + 1, 0L);
848
849 curwin->w_p_list = save_list; /* restore 'list' */
850
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200851#ifdef FEAT_VARTABS
852 if (new_ts_str != NULL) /* set the new tabstop */
853 {
854 // If 'vartabstop' is in use or if the value given to retab has more
855 // than one tabstop then update 'vartabstop'.
856 int *old_vts_ary = curbuf->b_p_vts_array;
857
Bram Moolenaar0119a592018-06-24 23:53:28 +0200858 if (tabstop_count(old_vts_ary) > 0 || tabstop_count(new_vts_array) > 1)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200859 {
860 set_string_option_direct((char_u *)"vts", -1, new_ts_str,
861 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0119a592018-06-24 23:53:28 +0200862 curbuf->b_p_vts_array = new_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200863 vim_free(old_vts_ary);
864 }
865 else
866 {
867 // 'vartabstop' wasn't in use and a single value was given to
868 // retab then update 'tabstop'.
Bram Moolenaar0119a592018-06-24 23:53:28 +0200869 curbuf->b_p_ts = tabstop_first(new_vts_array);
870 vim_free(new_vts_array);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200871 }
Bram Moolenaar307ac5c2018-06-28 22:23:00 +0200872 vim_free(new_ts_str);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200873 }
874#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 curbuf->b_p_ts = new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200876#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 coladvance(curwin->w_curswant);
878
879 u_clearline();
880}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
882/*
883 * :move command - move lines line1-line2 to line dest
884 *
885 * return FAIL for failure, OK otherwise
886 */
887 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100888do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889{
890 char_u *str;
891 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100892 linenr_T extra; // Num lines added before line1
893 linenr_T num_lines; // Num lines moved
894 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200895#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100896 win_T *win;
897 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200898#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 if (dest >= line1 && dest < line2)
901 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100902 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 return FAIL;
904 }
905
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100906 // Do nothing if we are not actually moving any lines. This will prevent
907 // the 'modified' flag from being set without cause.
908 if (dest == line1 - 1 || dest == line2)
909 {
910 // Move the cursor as if lines were moved (see below) to be backwards
911 // compatible.
912 if (dest >= line1)
913 curwin->w_cursor.lnum = dest;
914 else
915 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
916
917 return OK;
918 }
919
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 num_lines = line2 - line1 + 1;
921
922 /*
923 * First we copy the old text to its new location -- webb
924 * Also copy the flag that ":global" command uses.
925 */
926 if (u_save(dest, dest + 1) == FAIL)
927 return FAIL;
928 for (extra = 0, l = line1; l <= line2; l++)
929 {
930 str = vim_strsave(ml_get(l + extra));
931 if (str != NULL)
932 {
933 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
934 vim_free(str);
935 if (dest < line1)
936 extra++;
937 }
938 }
939
940 /*
941 * Now we must be careful adjusting our marks so that we don't overlap our
942 * mark_adjust() calls.
943 *
944 * We adjust the marks within the old text so that they refer to the
945 * last lines of the file (temporarily), because we know no other marks
946 * will be set there since these line numbers did not exist until we added
947 * our new lines.
948 *
949 * Then we adjust the marks on lines between the old and new text positions
950 * (either forwards or backwards).
951 *
952 * And Finally we adjust the marks we put at the end of the file back to
953 * their final destination at the new text position -- webb
954 */
955 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100956 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 if (dest >= line2)
958 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100959 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
960#ifdef FEAT_FOLDING
961 FOR_ALL_TAB_WINDOWS(tp, win) {
962 if (win->w_buffer == curbuf)
963 foldMoveRange(&win->w_folds, line1, line2, dest);
964 }
965#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 curbuf->b_op_start.lnum = dest - num_lines + 1;
967 curbuf->b_op_end.lnum = dest;
968 }
969 else
970 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100971 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
972#ifdef FEAT_FOLDING
973 FOR_ALL_TAB_WINDOWS(tp, win) {
974 if (win->w_buffer == curbuf)
975 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
976 }
977#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 curbuf->b_op_start.lnum = dest + 1;
979 curbuf->b_op_end.lnum = dest + num_lines;
980 }
981 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100982 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 -(last_line - dest - extra), 0L);
984
985 /*
986 * Now we delete the original text -- webb
987 */
988 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
989 return FAIL;
990
991 for (l = line1; l <= line2; l++)
992 ml_delete(line1 + extra, TRUE);
993
994 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100995 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200996 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
998 /*
999 * Leave the cursor on the last of the moved lines.
1000 */
1001 if (dest >= line1)
1002 curwin->w_cursor.lnum = dest;
1003 else
1004 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
1005
1006 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +01001007 {
1008 dest += num_lines + 1;
1009 last_line = curbuf->b_ml.ml_line_count;
1010 if (dest > last_line + 1)
1011 dest = last_line + 1;
1012 changed_lines(line1, 0, dest, 0L);
1013 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 else
1015 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
1016
1017 return OK;
1018}
1019
1020/*
1021 * ":copy"
1022 */
1023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001024ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025{
1026 linenr_T count;
1027 char_u *p;
1028
1029 count = line2 - line1 + 1;
1030 curbuf->b_op_start.lnum = n + 1;
1031 curbuf->b_op_end.lnum = n + count;
1032 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
1033
1034 /*
1035 * there are three situations:
1036 * 1. destination is above line1
1037 * 2. destination is between line1 and line2
1038 * 3. destination is below line2
1039 *
1040 * n = destination (when starting)
1041 * curwin->w_cursor.lnum = destination (while copying)
1042 * line1 = start of source (while copying)
1043 * line2 = end of source (while copying)
1044 */
1045 if (u_save(n, n + 1) == FAIL)
1046 return;
1047
1048 curwin->w_cursor.lnum = n;
1049 while (line1 <= line2)
1050 {
1051 /* need to use vim_strsave() because the line will be unlocked within
1052 * ml_append() */
1053 p = vim_strsave(ml_get(line1));
1054 if (p != NULL)
1055 {
1056 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
1057 vim_free(p);
1058 }
1059 /* situation 2: skip already copied lines */
1060 if (line1 == n)
1061 line1 = curwin->w_cursor.lnum;
1062 ++line1;
1063 if (curwin->w_cursor.lnum < line1)
1064 ++line1;
1065 if (curwin->w_cursor.lnum < line2)
1066 ++line2;
1067 ++curwin->w_cursor.lnum;
1068 }
1069
1070 appended_lines_mark(n, count);
1071
1072 msgmore((long)count);
1073}
1074
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001075static char_u *prevcmd = NULL; /* the previous command */
1076
1077#if defined(EXITFREE) || defined(PROTO)
1078 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001079free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001080{
1081 vim_free(prevcmd);
1082}
1083#endif
1084
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085/*
1086 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1087 * Bangs in the argument are replaced with the previously entered command.
1088 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 */
1090 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001091do_bang(
1092 int addr_count,
1093 exarg_T *eap,
1094 int forceit,
1095 int do_in,
1096 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097{
1098 char_u *arg = eap->arg; /* command */
1099 linenr_T line1 = eap->line1; /* start of range */
1100 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 char_u *newcmd = NULL; /* the new command */
1102 int free_newcmd = FALSE; /* need to free() newcmd */
1103 int ins_prevcmd;
1104 char_u *t;
1105 char_u *p;
1106 char_u *trailarg;
1107 int len;
1108 int scroll_save = msg_scroll;
1109
1110 /*
1111 * Disallow shell commands for "rvim".
1112 * Disallow shell commands from .exrc and .vimrc in current directory for
1113 * security reasons.
1114 */
1115 if (check_restricted() || check_secure())
1116 return;
1117
1118 if (addr_count == 0) /* :! */
1119 {
1120 msg_scroll = FALSE; /* don't scroll here */
1121 autowrite_all();
1122 msg_scroll = scroll_save;
1123 }
1124
1125 /*
1126 * Try to find an embedded bang, like in :!<cmd> ! [args]
1127 * (:!! is indicated by the 'forceit' variable)
1128 */
1129 ins_prevcmd = forceit;
1130 trailarg = arg;
1131 do
1132 {
1133 len = (int)STRLEN(trailarg) + 1;
1134 if (newcmd != NULL)
1135 len += (int)STRLEN(newcmd);
1136 if (ins_prevcmd)
1137 {
1138 if (prevcmd == NULL)
1139 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001140 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 vim_free(newcmd);
1142 return;
1143 }
1144 len += (int)STRLEN(prevcmd);
1145 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001146 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 {
1148 vim_free(newcmd);
1149 return;
1150 }
1151 *t = NUL;
1152 if (newcmd != NULL)
1153 STRCAT(t, newcmd);
1154 if (ins_prevcmd)
1155 STRCAT(t, prevcmd);
1156 p = t + STRLEN(t);
1157 STRCAT(t, trailarg);
1158 vim_free(newcmd);
1159 newcmd = t;
1160
1161 /*
1162 * Scan the rest of the argument for '!', which is replaced by the
1163 * previous command. "\!" is replaced by "!" (this is vi compatible).
1164 */
1165 trailarg = NULL;
1166 while (*p)
1167 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001168 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 {
1170 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001171 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 else
1173 {
1174 trailarg = p;
1175 *trailarg++ = NUL;
1176 ins_prevcmd = TRUE;
1177 break;
1178 }
1179 }
1180 ++p;
1181 }
1182 } while (trailarg != NULL);
1183
1184 vim_free(prevcmd);
1185 prevcmd = newcmd;
1186
1187 if (bangredo) /* put cmd in redo buffer for ! command */
1188 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001189 /* If % or # appears in the command, it must have been escaped.
1190 * Reescape them, so that redoing them does not substitute them by the
1191 * buffername. */
1192 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1193
1194 if (cmd != NULL)
1195 {
1196 AppendToRedobuffLit(cmd, -1);
1197 vim_free(cmd);
1198 }
1199 else
1200 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 AppendToRedobuff((char_u *)"\n");
1202 bangredo = FALSE;
1203 }
1204 /*
1205 * Add quotes around the command, for shells that need them.
1206 */
1207 if (*p_shq != NUL)
1208 {
1209 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1210 if (newcmd == NULL)
1211 return;
1212 STRCPY(newcmd, p_shq);
1213 STRCAT(newcmd, prevcmd);
1214 STRCAT(newcmd, p_shq);
1215 free_newcmd = TRUE;
1216 }
1217 if (addr_count == 0) /* :! */
1218 {
1219 /* echo the command */
1220 msg_start();
1221 msg_putchar(':');
1222 msg_putchar('!');
1223 msg_outtrans(newcmd);
1224 msg_clr_eos();
1225 windgoto(msg_row, msg_col);
1226
1227 do_shell(newcmd, 0);
1228 }
1229 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001230 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 /* Careful: This may recursively call do_bang() again! (because of
1232 * autocommands) */
1233 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001234 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001235 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 if (free_newcmd)
1237 vim_free(newcmd);
1238}
1239
1240/*
1241 * do_filter: filter lines through a command given by the user
1242 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001243 * We mostly use temp files and the call_shell() routine here. This would
1244 * normally be done using pipes on a UNIX machine, but this is more portable
1245 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 * to deal with redirection somehow, and should handle things like looking
1247 * at the PATH env. variable, and adding reasonable extensions to the
1248 * command name given by the user. All reasonable versions of call_shell()
1249 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001250 * Alternatively, if on Unix and redirecting input or output, but not both,
1251 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 * We use input redirection if do_in is TRUE.
1253 * We use output redirection if do_out is TRUE.
1254 */
1255 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001256do_filter(
1257 linenr_T line1,
1258 linenr_T line2,
1259 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1260 char_u *cmd,
1261 int do_in,
1262 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263{
1264 char_u *itmp = NULL;
1265 char_u *otmp = NULL;
1266 linenr_T linecount;
1267 linenr_T read_linecount;
1268 pos_T cursor_save;
1269 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001271 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
1273 if (*cmd == NUL) /* no filter command */
1274 return;
1275
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 cursor_save = curwin->w_cursor;
1277 linecount = line2 - line1 + 1;
1278 curwin->w_cursor.lnum = line1;
1279 curwin->w_cursor.col = 0;
1280 changed_line_abv_curs();
1281 invalidate_botline();
1282
1283 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001284 * When using temp files:
1285 * 1. * Form temp file names
1286 * 2. * Write the lines to a temp file
1287 * 3. Run the filter command on the temp file
1288 * 4. * Read the output of the command into the buffer
1289 * 5. * Delete the original lines to be filtered
1290 * 6. * Remove the temp files
1291 *
1292 * When writing the input with a pipe or when catching the output with a
1293 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 */
1295
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001296 if (do_out)
1297 shell_flags |= SHELL_DOOUT;
1298
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001299#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001300 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001302 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1303 shell_flags |= SHELL_READ;
1304 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001306 else if (do_in && !do_out && !p_stmp)
1307 {
1308 /* Use a pipe to write stdin of the command, do not use a temp file. */
1309 shell_flags |= SHELL_WRITE;
1310 curbuf->b_op_start.lnum = line1;
1311 curbuf->b_op_end.lnum = line2;
1312 }
1313 else if (do_in && do_out && !p_stmp)
1314 {
1315 /* Use a pipe to write stdin and fetch stdout of the command, do not
1316 * use a temp file. */
1317 shell_flags |= SHELL_READ|SHELL_WRITE;
1318 curbuf->b_op_start.lnum = line1;
1319 curbuf->b_op_end.lnum = line2;
1320 curwin->w_cursor.lnum = line2;
1321 }
1322 else
1323#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001324 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1325 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001326 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001327 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001328 goto filterend;
1329 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330
1331/*
1332 * The writing and reading of temp files will not be shown.
1333 * Vi also doesn't do this and the messages are not very informative.
1334 */
1335 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001336 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 FALSE, FALSE, FALSE, TRUE) == FAIL)
1338 {
1339 msg_putchar('\n'); /* keep message from buf_write() */
1340 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001341#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 if (!aborting())
1343#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001344 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 goto filterend;
1346 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 if (curbuf != old_curbuf)
1348 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349
1350 if (!do_out)
1351 msg_putchar('\n');
1352
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001353 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1355 if (cmd_buf == NULL)
1356 goto filterend;
1357
1358 windgoto((int)Rows - 1, 0);
1359 cursor_on();
1360
1361 /*
1362 * When not redirecting the output the command can write anything to the
1363 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1364 * stderr output of external command. Clear the screen later.
1365 * If do_in is FALSE, this could be something like ":r !cat", which may
1366 * also mess up the screen, clear it later.
1367 */
1368 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1369 redraw_later_clear();
1370
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001371 if (do_out)
1372 {
1373 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001374 {
1375 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001376 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001377 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001378 redraw_curbuf_later(VALID);
1379 }
1380 read_linecount = curbuf->b_ml.ml_line_count;
1381
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 /*
1383 * When call_shell() fails wait_return() is called to give the user a
1384 * chance to read the error messages. Otherwise errors are ignored, so you
1385 * can see the error messages from the command that appear on stdout; use
1386 * 'u' to fix the text
1387 * Switch to cooked mode when not redirecting stdin, avoids that something
1388 * like ":r !cat" hangs.
1389 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1390 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001391 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 {
1393 redraw_later_clear();
1394 wait_return(FALSE);
1395 }
1396 vim_free(cmd_buf);
1397
1398 did_check_timestamps = FALSE;
1399 need_check_timestamps = TRUE;
1400
1401 /* When interrupting the shell command, it may still have produced some
1402 * useful output. Reset got_int here, so that readfile() won't cancel
1403 * reading. */
1404 ui_breakcheck();
1405 got_int = FALSE;
1406
1407 if (do_out)
1408 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001409 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001411 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001412 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001414#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001415 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001417 {
1418 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001419 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001420 }
1421 goto error;
1422 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001423 if (curbuf != old_curbuf)
1424 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001425 }
1426
1427 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1428
1429 if (shell_flags & SHELL_READ)
1430 {
1431 curbuf->b_op_start.lnum = line2 + 1;
1432 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1433 appended_lines_mark(line2, read_linecount);
1434 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435
1436 if (do_in)
1437 {
1438 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1439 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 if (read_linecount >= linecount)
1441 /* move all marks from old lines to new lines */
1442 mark_adjust(line1, line2, linecount, 0L);
1443 else
1444 {
1445 /* move marks from old lines to new lines, delete marks
1446 * that are in deleted lines */
1447 mark_adjust(line1, line1 + read_linecount - 1,
1448 linecount, 0L);
1449 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1450 }
1451 }
1452
1453 /*
1454 * Put cursor on first filtered line for ":range!cmd".
1455 * Adjust '[ and '] (set by buf_write()).
1456 */
1457 curwin->w_cursor.lnum = line1;
1458 del_lines(linecount, TRUE);
1459 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1460 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1461 write_lnum_adjust(-linecount); /* adjust last line
1462 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001463#ifdef FEAT_FOLDING
1464 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1465#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 }
1467 else
1468 {
1469 /*
1470 * Put cursor on last new line for ":r !cmd".
1471 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001473 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001475
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1477 --no_wait_return;
1478
1479 if (linecount > p_report)
1480 {
1481 if (do_in)
1482 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001483 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001484 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001487 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 }
1489 else
1490 msgmore((long)linecount);
1491 }
1492 }
1493 else
1494 {
1495error:
1496 /* put cursor back in same position for ":w !cmd" */
1497 curwin->w_cursor = cursor_save;
1498 --no_wait_return;
1499 wait_return(FALSE);
1500 }
1501
1502filterend:
1503
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 if (curbuf != old_curbuf)
1505 {
1506 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001507 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 if (itmp != NULL)
1510 mch_remove(itmp);
1511 if (otmp != NULL)
1512 mch_remove(otmp);
1513 vim_free(itmp);
1514 vim_free(otmp);
1515}
1516
1517/*
1518 * Call a shell to execute a command.
1519 * When "cmd" is NULL start an interactive shell.
1520 */
1521 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001522do_shell(
1523 char_u *cmd,
1524 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525{
1526 buf_T *buf;
1527#ifndef FEAT_GUI_MSWIN
1528 int save_nwr;
1529#endif
1530#ifdef MSWIN
1531 int winstart = FALSE;
1532#endif
1533
1534 /*
1535 * Disallow shell commands for "rvim".
1536 * Disallow shell commands from .exrc and .vimrc in current directory for
1537 * security reasons.
1538 */
1539 if (check_restricted() || check_secure())
1540 {
1541 msg_end();
1542 return;
1543 }
1544
1545#ifdef MSWIN
1546 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 * Check if ":!start" is used.
1548 */
1549 if (cmd != NULL)
1550 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1551#endif
1552
1553 /*
1554 * For autocommands we want to get the output on the current screen, to
1555 * avoid having to type return below.
1556 */
1557 msg_putchar('\r'); /* put cursor at start of line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 {
1560#ifdef MSWIN
1561 if (!winstart)
1562#endif
1563 stoptermcap();
1564 }
1565#ifdef MSWIN
1566 if (!winstart)
1567#endif
1568 msg_putchar('\n'); /* may shift screen one line up */
1569
1570 /* warning message before calling the shell */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001571 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001572 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001573 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 {
1575#ifdef FEAT_GUI_MSWIN
1576 if (!winstart)
1577 starttermcap(); /* don't want a message box here */
1578#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001579 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580#ifdef FEAT_GUI_MSWIN
1581 if (!winstart)
1582 stoptermcap();
1583#endif
1584 break;
1585 }
1586
1587 /* This windgoto is required for when the '\n' resulted in a "delete line
1588 * 1" command to the terminal. */
1589 if (!swapping_screen())
1590 windgoto(msg_row, msg_col);
1591 cursor_on();
1592 (void)call_shell(cmd, SHELL_COOKED | flags);
1593 did_check_timestamps = FALSE;
1594 need_check_timestamps = TRUE;
1595
1596 /*
1597 * put the message cursor at the end of the screen, avoids wait_return()
1598 * to overwrite the text that the external command showed
1599 */
1600 if (!swapping_screen())
1601 {
1602 msg_row = Rows - 1;
1603 msg_col = 0;
1604 }
1605
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 if (autocmd_busy)
1607 {
1608 if (msg_silent == 0)
1609 redraw_later_clear();
1610 }
1611 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 {
1613 /*
1614 * For ":sh" there is no need to call wait_return(), just redraw.
1615 * Also for the Win32 GUI (the output is in a console window).
1616 * Otherwise there is probably text on the screen that the user wants
1617 * to read before redrawing, so call wait_return().
1618 */
1619#ifndef FEAT_GUI_MSWIN
1620 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001621# ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 || (winstart && !need_wait_return)
1623# endif
1624 )
1625 {
1626 if (msg_silent == 0)
1627 redraw_later_clear();
1628 need_wait_return = FALSE;
1629 }
1630 else
1631 {
1632 /*
1633 * If we switch screens when starttermcap() is called, we really
1634 * want to wait for "hit return to continue".
1635 */
1636 save_nwr = no_wait_return;
1637 if (swapping_screen())
1638 no_wait_return = FALSE;
1639# ifdef AMIGA
1640 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1641# else
1642 wait_return(msg_silent == 0);
1643# endif
1644 no_wait_return = save_nwr;
1645 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001646#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647
1648#ifdef MSWIN
1649 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1650#endif
1651 starttermcap(); /* start termcap if not done by wait_return() */
1652
1653 /*
1654 * In an Amiga window redrawing is caused by asking the window size.
1655 * If we got an interrupt this will not work. The chance that the
1656 * window size is wrong is very small, but we need to redraw the
1657 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1658 * but it saves an extra redraw.
1659 */
1660#ifdef AMIGA
1661 if (skip_redraw) /* ':' hit in wait_return() */
1662 {
1663 if (msg_silent == 0)
1664 redraw_later_clear();
1665 }
1666 else if (term_console)
1667 {
1668 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1669 if (got_int && msg_silent == 0)
1670 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1671 else
1672 must_redraw = 0; /* no extra redraw needed */
1673 }
1674#endif
1675 }
1676
1677 /* display any error messages now */
1678 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001679
Bram Moolenaarade00832006-03-10 21:46:58 +00001680 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681}
1682
Bram Moolenaar06640892018-10-09 21:49:33 +02001683#if !defined(UNIX)
1684 static char_u *
1685find_pipe(char_u *cmd)
1686{
1687 char_u *p;
1688 int inquote = FALSE;
1689
1690 for (p = cmd; *p != NUL; ++p)
1691 {
1692 if (!inquote && *p == '|')
1693 return p;
1694 if (*p == '"')
1695 inquote = !inquote;
1696 else if (rem_backslash(p))
1697 ++p;
1698 }
1699 return NULL;
1700}
1701#endif
1702
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703/*
1704 * Create a shell command from a command string, input redirection file and
1705 * output redirection file.
1706 * Returns an allocated string with the shell command, or NULL for failure.
1707 */
1708 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001709make_filter_cmd(
1710 char_u *cmd, /* command */
1711 char_u *itmp, /* NULL or name of input file */
1712 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713{
1714 char_u *buf;
1715 long_u len;
1716
Bram Moolenaar53076832015-12-31 19:53:21 +01001717#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001718 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001719 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001720
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001721 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001722 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1723 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001724 if (is_fish_shell)
1725 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1726 else
1727#endif
1728 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 if (itmp != NULL)
1730 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1731 if (otmp != NULL)
1732 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1733 buf = lalloc(len, TRUE);
1734 if (buf == NULL)
1735 return NULL;
1736
Bram Moolenaar53076832015-12-31 19:53:21 +01001737#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001739 * Put braces around the command (for concatenated commands) when
1740 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001742 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001743 {
1744 if (is_fish_shell)
1745 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1746 else
1747 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1748 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001749 else
1750 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 if (itmp != NULL)
1752 {
1753 STRCAT(buf, " < ");
1754 STRCAT(buf, itmp);
1755 }
1756#else
1757 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001758 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 * the use of commands in a pipe.
1760 */
1761 STRCPY(buf, cmd);
1762 if (itmp != NULL)
1763 {
1764 char_u *p;
1765
1766 /*
1767 * If there is a pipe, we have to put the '<' in front of it.
1768 * Don't do this when 'shellquote' is not empty, otherwise the
1769 * redirection would be inside the quotes.
1770 */
1771 if (*p_shq == NUL)
1772 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001773 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 if (p != NULL)
1775 *p = NUL;
1776 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1778 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 if (*p_shq == NUL)
1780 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001781 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 if (p != NULL)
1783 {
1784 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1785 STRCAT(buf, p);
1786 }
1787 }
1788 }
1789#endif
1790 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001791 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792
1793 return buf;
1794}
1795
1796/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001797 * Append output redirection for file "fname" to the end of string buffer
1798 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 * Works with the 'shellredir' and 'shellpipe' options.
1800 * The caller should make sure that there is enough room:
1801 * STRLEN(opt) + STRLEN(fname) + 3
1802 */
1803 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001804append_redir(
1805 char_u *buf,
1806 int buflen,
1807 char_u *opt,
1808 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809{
1810 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001811 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001813 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001814 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001816 {
1817 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001819 if (p[1] == '%') /* skip %% */
1820 ++p;
1821 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 if (p != NULL)
1823 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001824 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1825 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1826 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 }
1828 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001829 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 " %s %s",
1832#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834#endif
1835 (char *)opt, (char *)fname);
1836}
1837
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001838#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001840static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001841static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001842static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843static int viminfo_errcnt;
1844
1845 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001846no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847{
1848 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001849 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850}
1851
1852/*
1853 * Report an error for reading a viminfo file.
1854 * Count the number of errors. When there are more than 10, return TRUE.
1855 */
1856 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001857viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001859 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1860 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001861 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001862 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1863 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001864 emsg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 if (++viminfo_errcnt >= 10)
1866 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001867 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 return TRUE;
1869 }
1870 return FALSE;
1871}
1872
1873/*
1874 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001875 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 */
1877 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001878read_viminfo(
1879 char_u *file, /* file name or NULL to use default name */
1880 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881{
1882 FILE *fp;
1883 char_u *fname;
1884
1885 if (no_viminfo())
1886 return FAIL;
1887
Bram Moolenaard812df62008-11-09 12:46:09 +00001888 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 if (fname == NULL)
1890 return FAIL;
1891 fp = mch_fopen((char *)fname, READBIN);
1892
1893 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001894 {
1895 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001896 smsg(_("Reading viminfo file \"%s\"%s%s%s"),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001897 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001898 (flags & VIF_WANT_INFO) ? _(" info") : "",
1899 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1900 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001901 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001902 verbose_leave();
1903 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
1905 vim_free(fname);
1906 if (fp == NULL)
1907 return FAIL;
1908
1909 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001910 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911
1912 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 return OK;
1914}
1915
1916/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001917 * Write the viminfo file. The old one is read in first so that effectively a
1918 * merge of current info and old info is done. This allows multiple vims to
1919 * run simultaneously, without losing any marks etc.
1920 * If "forceit" is TRUE, then the old file is not read in, and only internal
1921 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 */
1923 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001924write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925{
1926 char_u *fname;
1927 FILE *fp_in = NULL; /* input viminfo file, if any */
1928 FILE *fp_out = NULL; /* output viminfo file */
1929 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001930 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931#if defined(UNIX) || defined(VMS)
1932 mode_t umask_save;
1933#endif
1934#ifdef UNIX
1935 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001936 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001938#ifdef MSWIN
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001939 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001940#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941
1942 if (no_viminfo())
1943 return;
1944
1945 fname = viminfo_filename(file); /* may set to default if NULL */
1946 if (fname == NULL)
1947 return;
1948
1949 fp_in = mch_fopen((char *)fname, READBIN);
1950 if (fp_in == NULL)
1951 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001952 int fd;
1953
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 /* if it does exist, but we can't read it, don't try writing */
1955 if (mch_stat((char *)fname, &st_new) == 0)
1956 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001957
1958 /* Create the new .viminfo non-accessible for others, because it may
1959 * contain text from non-accessible documents. It is up to the user to
1960 * widen access (e.g. to a group). This may also fail if there is a
1961 * race condition, then just give up. */
1962 fd = mch_open((char *)fname,
1963 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1964 if (fd < 0)
1965 goto end;
1966 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 }
1968 else
1969 {
1970 /*
1971 * There is an existing viminfo file. Create a temporary file to
1972 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001973 * existing viminfo file, which will be renamed once all writing is
1974 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 */
1976#ifdef UNIX
1977 /*
1978 * For Unix we check the owner of the file. It's not very nice to
1979 * overwrite a user's viminfo file after a "su root", with a
1980 * viminfo file that the user can't read.
1981 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001982 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001983 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001985 if (mch_stat((char *)fname, &st_old) == 0
1986 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001987 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 ? (st_old.st_mode & 0200)
1989 : (st_old.st_gid == getgid()
1990 ? (st_old.st_mode & 0020)
1991 : (st_old.st_mode & 0002))))
1992 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001993 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994
1995 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001996 semsg(_("E137: Viminfo file is not writable: %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001998 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 goto end;
2000 }
2001#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002002#ifdef MSWIN
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002003 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01002004 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002005#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006
2007 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002008 * Make tempname, find one that does not exist yet.
2009 * Beware of a race condition: If someone logs out and all Vim
2010 * instances exit at the same time a temp file might be created between
2011 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 * May try twice: Once normal and once with shortname set, just in
2013 * case somebody puts his viminfo file in an 8.3 filesystem.
2014 */
2015 for (;;)
2016 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002017 int next_char = 'z';
2018 char_u *wp;
2019
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 tempname = buf_modname(
2021#ifdef UNIX
2022 shortname,
2023#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025#endif
2026 fname,
2027#ifdef VMS
2028 (char_u *)"-tmp",
2029#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031#endif
2032 FALSE);
2033 if (tempname == NULL) /* out of memory */
2034 break;
2035
2036 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002037 * Try a series of names. Change one character, just before
2038 * the extension. This should also work for an 8.3
2039 * file name, when after adding the extension it still is
2040 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002042 wp = tempname + STRLEN(tempname) - 5;
2043 if (wp < gettail(tempname)) /* empty file name? */
2044 wp = gettail(tempname);
2045 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002047 /*
2048 * Check if tempfile already exists. Never overwrite an
2049 * existing file!
2050 */
2051 if (mch_stat((char *)tempname, &st_new) == 0)
2052 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002055 * Check if tempfile is same as original file. May happen
2056 * when modname() gave the same file back. E.g. silly
2057 * link, or file name-length reached. Try again with
2058 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002060 if (!shortname && st_new.st_dev == st_old.st_dev
2061 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01002063 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002064 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 break;
2066 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002067#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002069 else
2070 {
2071 /* Try creating the file exclusively. This may fail if
2072 * another Vim tries to do it at the same time. */
2073#ifdef VMS
2074 /* fdopen() fails for some reason */
2075 umask_save = umask(077);
2076 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2077 (void)umask(umask_save);
2078#else
2079 int fd;
2080
2081 /* Use mch_open() to be able to use O_NOFOLLOW and set file
2082 * protection:
2083 * Unix: same as original file, but strip s-bit. Reset
2084 * umask to avoid it getting in the way.
2085 * Others: r&w for user only. */
2086# ifdef UNIX
2087 umask_save = umask(0);
2088 fd = mch_open((char *)tempname,
2089 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
2090 (int)((st_old.st_mode & 0777) | 0600));
2091 (void)umask(umask_save);
2092# else
2093 fd = mch_open((char *)tempname,
2094 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
2095# endif
2096 if (fd < 0)
2097 {
2098 fp_out = NULL;
2099# ifdef EEXIST
2100 /* Avoid trying lots of names while the problem is lack
Bram Moolenaar94747162019-02-10 21:55:26 +01002101 * of permission, only retry if the file already
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002102 * exists. */
2103 if (errno != EEXIST)
2104 break;
2105# endif
2106 }
2107 else
2108 fp_out = fdopen(fd, WRITEBIN);
2109#endif /* VMS */
2110 if (fp_out != NULL)
2111 break;
2112 }
2113
2114 /* Assume file exists, try again with another name. */
2115 if (next_char == 'a' - 1)
2116 {
2117 /* They all exist? Must be something wrong! Don't write
2118 * the viminfo file then. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002119 semsg(_("E929: Too many viminfo temp files, like %s!"),
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002120 tempname);
2121 break;
2122 }
2123 *wp = next_char;
2124 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002126
2127 if (tempname != NULL)
2128 break;
2129 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 }
2131
Bram Moolenaara5792f52005-11-23 21:25:05 +00002132#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002133 if (tempname != NULL && fp_out != NULL)
2134 {
2135 stat_T tmp_st;
2136
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002138 * Make sure the original owner can read/write the tempfile and
2139 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002141 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002142 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002143 if (st_old.st_uid != tmp_st.st_uid)
2144 /* Changing the owner might fail, in which case the
2145 * file will now owned by the current user, oh well. */
Bram Moolenaar42335f52018-09-13 15:33:43 +02002146 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002147 if (st_old.st_gid != tmp_st.st_gid
2148 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2149 /* can't set the group to what it should be, remove
2150 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002151 (void)mch_setperm(tempname, 0600);
2152 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002153 else
2154 /* can't stat the file, set conservative permissions */
2155 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002157#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002158 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
2160 /*
2161 * Check if the new viminfo file can be written to.
2162 */
2163 if (fp_out == NULL)
2164 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002165 semsg(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002166 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 if (fp_in != NULL)
2168 fclose(fp_in);
2169 goto end;
2170 }
2171
2172 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002173 {
2174 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002175 smsg(_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002176 verbose_leave();
2177 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
2179 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002180 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181
Bram Moolenaar927030a2016-03-15 18:23:55 +01002182 if (fclose(fp_out) == EOF)
2183 ++viminfo_errcnt;
2184
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 if (fp_in != NULL)
2186 {
2187 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002188
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002189 /* In case of an error keep the original viminfo file. Otherwise
2190 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002191 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002192 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002193 if (vim_rename(tempname, fname) == -1)
2194 {
2195 ++viminfo_errcnt;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002196 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
Bram Moolenaar927030a2016-03-15 18:23:55 +01002197 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002198# ifdef MSWIN
Bram Moolenaar927030a2016-03-15 18:23:55 +01002199 /* If the viminfo file was hidden then also hide the new file. */
2200 else if (hidden)
2201 mch_hide(fname);
2202# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002203 }
2204 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 mch_remove(tempname);
2206 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002207
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208end:
2209 vim_free(fname);
2210 vim_free(tempname);
2211}
2212
2213/*
2214 * Get the viminfo file name to use.
2215 * If "file" is given and not empty, use it (has already been expanded by
2216 * cmdline functions).
2217 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2218 * expand environment variables.
2219 * Returns an allocated string. NULL when out of memory.
2220 */
2221 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002222viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223{
2224 if (file == NULL || *file == NUL)
2225 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002226 if (*p_viminfofile != NUL)
2227 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2229 {
2230#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231# ifdef VMS
2232 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2233# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002234# ifdef MSWIN
2235 /* Use $VIM only if $HOME is the default "C:/". */
2236 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2237 && mch_getenv((char_u *)"HOME") == NULL)
2238# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002240# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241# endif
2242 {
2243 /* don't use $VIM when not available. */
2244 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2245 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2246 file = (char_u *)VIMINFO_FILE2;
2247 else
2248 file = (char_u *)VIMINFO_FILE;
2249 }
2250 else
2251#endif
2252 file = (char_u *)VIMINFO_FILE;
2253 }
2254 expand_env(file, NameBuff, MAXPATHL);
2255 file = NameBuff;
2256 }
2257 return vim_strsave(file);
2258}
2259
2260/*
2261 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2262 */
2263 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002264do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 int eof = FALSE;
2267 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002268 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002269 int do_copy_marks = FALSE;
2270 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271
2272 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2273 return;
2274 vir.vir_fd = fp_in;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002276 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002277 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278
2279 if (fp_in != NULL)
2280 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002281 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002282 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002283 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002284 {
2285 /* Registers and marks are read and kept separate from what
2286 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002287 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002288 prepare_viminfo_marks();
2289 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002290
Bram Moolenaard812df62008-11-09 12:46:09 +00002291 eof = read_viminfo_up_to_marks(&vir,
2292 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002293 merge = TRUE;
2294 }
2295 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 /* Skip info, find start of marks */
2297 while (!(eof = viminfo_readline(&vir))
2298 && vir.vir_line[0] != '>')
2299 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002300
2301 do_copy_marks = (flags &
2302 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002304
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 if (fp_out != NULL)
2306 {
2307 /* Write the info: */
2308 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2309 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002310 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002311 write_viminfo_version(fp_out);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002312 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 write_viminfo_search_pattern(fp_out);
2315 write_viminfo_sub_string(fp_out);
2316#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002317 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318#endif
2319 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002320 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321#ifdef FEAT_EVAL
2322 write_viminfo_varlist(fp_out);
2323#endif
2324 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002325 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002327 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002328
2329 if (do_copy_marks)
2330 ga_init2(&buflist, sizeof(buf_T *), 50);
2331 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002333
2334 if (do_copy_marks)
2335 {
2336 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2337 if (fp_out != NULL)
2338 ga_clear(&buflist);
2339 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340
2341 vim_free(vir.vir_line);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 if (vir.vir_conv.vc_type != CONV_NONE)
2343 convert_setup(&vir.vir_conv, NULL, NULL);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002344 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345}
2346
2347/*
2348 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2349 * first part of the viminfo file which contains everything but the marks that
2350 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2351 */
2352 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002353read_viminfo_up_to_marks(
2354 vir_T *virp,
2355 int forceit,
2356 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357{
2358 int eof;
2359 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002360 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361
2362#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002363 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002365
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 eof = viminfo_readline(virp);
2367 while (!eof && virp->vir_line[0] != '>')
2368 {
2369 switch (virp->vir_line[0])
2370 {
2371 /* Characters reserved for future expansion, ignored now */
2372 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 case '^': /* to be defined */
2374 case '<': /* long line - ignored */
2375 /* A comment or empty line. */
2376 case NUL:
2377 case '\r':
2378 case '\n':
2379 case '#':
2380 eof = viminfo_readline(virp);
2381 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002382 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002383 eof = read_viminfo_barline(virp, got_encoding,
2384 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002385 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002387 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 eof = viminfo_encoding(virp);
2389 break;
2390 case '!': /* global variable */
2391#ifdef FEAT_EVAL
2392 eof = read_viminfo_varlist(virp, writing);
2393#else
2394 eof = viminfo_readline(virp);
2395#endif
2396 break;
2397 case '%': /* entry for buffer list */
2398 eof = read_viminfo_bufferlist(virp, writing);
2399 break;
2400 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002401 /* When registers are in bar lines skip the old style register
2402 * lines. */
2403 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2404 eof = read_viminfo_register(virp, forceit);
2405 else
2406 do {
2407 eof = viminfo_readline(virp);
2408 } while (!eof && (virp->vir_line[0] == TAB
2409 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 break;
2411 case '/': /* Search string */
2412 case '&': /* Substitute search string */
2413 case '~': /* Last search string, followed by '/' or '&' */
2414 eof = read_viminfo_search_pattern(virp, forceit);
2415 break;
2416 case '$':
2417 eof = read_viminfo_sub_string(virp, forceit);
2418 break;
2419 case ':':
2420 case '?':
2421 case '=':
2422 case '@':
2423#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002424 /* When history is in bar lines skip the old style history
2425 * lines. */
2426 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2427 eof = read_viminfo_history(virp, writing);
2428 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002430 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 break;
2432 case '-':
2433 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002434 /* When file marks are in bar lines skip the old style lines. */
2435 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2436 eof = read_viminfo_filemark(virp, forceit);
2437 else
2438 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 break;
2440 default:
2441 if (viminfo_error("E575: ", _("Illegal starting char"),
2442 virp->vir_line))
2443 eof = TRUE;
2444 else
2445 eof = viminfo_readline(virp);
2446 break;
2447 }
2448 }
2449
2450#ifdef FEAT_CMDHIST
2451 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002452 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002453 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454#endif
2455
2456 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002457 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 fmarks_check_names(buf);
2459
2460 return eof;
2461}
2462
2463/*
2464 * Compare the 'encoding' value in the viminfo file with the current value of
2465 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2466 * conversion of text with iconv() in viminfo_readstring().
2467 */
2468 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002469viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 char_u *p;
2472 int i;
2473
2474 if (get_viminfo_parameter('c') != 0)
2475 {
2476 p = vim_strchr(virp->vir_line, '=');
2477 if (p != NULL)
2478 {
2479 /* remove trailing newline */
2480 ++p;
2481 for (i = 0; vim_isprintc(p[i]); ++i)
2482 ;
2483 p[i] = NUL;
2484
2485 convert_setup(&virp->vir_conv, p, p_enc);
2486 }
2487 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 return viminfo_readline(virp);
2489}
2490
2491/*
2492 * Read a line from the viminfo file.
2493 * Returns TRUE for end-of-file;
2494 */
2495 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002496viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497{
2498 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2499}
2500
2501/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002502 * Check string read from viminfo file.
2503 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 * - replace CTRL-V CTRL-V with CTRL-V
2505 * - replace CTRL-V 'n' with '\n'
2506 *
2507 * Check for a long line as written by viminfo_writestring().
2508 *
2509 * Return the string in allocated memory (NULL when out of memory).
2510 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002512viminfo_readstring(
2513 vir_T *virp,
2514 int off, /* offset for virp->vir_line */
2515 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516{
2517 char_u *retval;
2518 char_u *s, *d;
2519 long len;
2520
2521 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2522 {
2523 len = atol((char *)virp->vir_line + off + 1);
2524 retval = lalloc(len, TRUE);
2525 if (retval == NULL)
2526 {
2527 /* Line too long? File messed up? Skip next line. */
2528 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2529 return NULL;
2530 }
2531 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2532 s = retval + 1; /* Skip the leading '<' */
2533 }
2534 else
2535 {
2536 retval = vim_strsave(virp->vir_line + off);
2537 if (retval == NULL)
2538 return NULL;
2539 s = retval;
2540 }
2541
2542 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2543 d = retval;
2544 while (*s != NUL && *s != '\n')
2545 {
2546 if (s[0] == Ctrl_V && s[1] != NUL)
2547 {
2548 if (s[1] == 'n')
2549 *d++ = '\n';
2550 else
2551 *d++ = Ctrl_V;
2552 s += 2;
2553 }
2554 else
2555 *d++ = *s++;
2556 }
2557 *d = NUL;
2558
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2560 {
2561 d = string_convert(&virp->vir_conv, retval, NULL);
2562 if (d != NULL)
2563 {
2564 vim_free(retval);
2565 retval = d;
2566 }
2567 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568
2569 return retval;
2570}
2571
2572/*
2573 * write string to viminfo file
2574 * - replace CTRL-V with CTRL-V CTRL-V
2575 * - replace '\n' with CTRL-V 'n'
2576 * - add a '\n' at the end
2577 *
2578 * For a long line:
2579 * - write " CTRL-V <length> \n " in first line
2580 * - write " < <string> \n " in second line
2581 */
2582 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002583viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584{
2585 int c;
2586 char_u *s;
2587 int len = 0;
2588
2589 for (s = p; *s != NUL; ++s)
2590 {
2591 if (*s == Ctrl_V || *s == '\n')
2592 ++len;
2593 ++len;
2594 }
2595
2596 /* If the string will be too long, write its length and put it in the next
2597 * line. Take into account that some room is needed for what comes before
2598 * the string (e.g., variable name). Add something to the length for the
2599 * '<', NL and trailing NUL. */
2600 if (len > LSIZE / 2)
2601 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2602
2603 while ((c = *p++) != NUL)
2604 {
2605 if (c == Ctrl_V || c == '\n')
2606 {
2607 putc(Ctrl_V, fd);
2608 if (c == '\n')
2609 c = 'n';
2610 }
2611 putc(c, fd);
2612 }
2613 putc('\n', fd);
2614}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002615
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002616/*
2617 * Write a string in quotes that barline_parse() can read back.
2618 * Breaks the line in less than LSIZE pieces when needed.
2619 * Returns remaining characters in the line.
2620 */
2621 int
2622barline_writestring(FILE *fd, char_u *s, int remaining_start)
2623{
2624 char_u *p;
2625 int remaining = remaining_start;
2626 int len = 2;
2627
2628 /* Count the number of characters produced, including quotes. */
2629 for (p = s; *p != NUL; ++p)
2630 {
2631 if (*p == NL)
2632 len += 2;
2633 else if (*p == '"' || *p == '\\')
2634 len += 2;
2635 else
2636 ++len;
2637 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002638 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002639 {
2640 fprintf(fd, ">%d\n|<", len);
2641 remaining = LSIZE - 20;
2642 }
2643
2644 putc('"', fd);
2645 for (p = s; *p != NUL; ++p)
2646 {
2647 if (*p == NL)
2648 {
2649 putc('\\', fd);
2650 putc('n', fd);
2651 --remaining;
2652 }
2653 else if (*p == '"' || *p == '\\')
2654 {
2655 putc('\\', fd);
2656 putc(*p, fd);
2657 --remaining;
2658 }
2659 else
2660 putc(*p, fd);
2661 --remaining;
2662
2663 if (remaining < 3)
2664 {
2665 putc('\n', fd);
2666 putc('|', fd);
2667 putc('<', fd);
2668 /* Leave enough space for another continuation. */
2669 remaining = LSIZE - 20;
2670 }
2671 }
2672 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002673 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002674}
2675
2676/*
2677 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002678 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002679 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002680 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002681 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002682barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002683{
2684 char_u *p = text;
2685 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002686 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002687 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002688 int i;
2689 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002690 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002691 char_u *sconv;
2692 int converted;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002693
2694 while (*p == ',')
2695 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002696 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002697 if (ga_grow(values, 1) == FAIL)
2698 break;
2699 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002700
2701 if (*p == '>')
2702 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002703 /* Need to read a continuation line. Put strings in allocated
2704 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002705 if (!allocated)
2706 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002707 for (i = 0; i < values->ga_len; ++i)
2708 {
2709 bval_T *vp = (bval_T *)(values->ga_data) + i;
2710
2711 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002712 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002713 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2714 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002715 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002716 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002717 allocated = TRUE;
2718 }
2719
2720 if (vim_isdigit(p[1]))
2721 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002722 size_t len;
2723 size_t todo;
2724 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002725
2726 /* String value was split into lines that are each shorter
2727 * than LSIZE:
2728 * |{bartype},>{length of "{text}{text2}"}
2729 * |<"{text1}
2730 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002731 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002732 */
2733 ++p;
2734 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002735 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002736 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002737 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002738 p = buf;
2739 for (todo = len; todo > 0; todo -= n)
2740 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002741 eof = viminfo_readline(virp);
2742 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002743 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002744 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002745 /* File was truncated or garbled. Read another line if
2746 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002747 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002748 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002749 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002750 /* Get length of text, excluding |< and NL chars. */
2751 n = STRLEN(virp->vir_line);
2752 while (n > 0 && (virp->vir_line[n - 1] == NL
2753 || virp->vir_line[n - 1] == CAR))
2754 --n;
2755 n -= 2;
2756 if (n > todo)
2757 {
2758 /* more values follow after the string */
2759 nextp = virp->vir_line + 2 + todo;
2760 n = todo;
2761 }
2762 mch_memmove(p, virp->vir_line + 2, n);
2763 p += n;
2764 }
2765 *p = NUL;
2766 p = buf;
2767 }
2768 else
2769 {
2770 /* Line ending in ">" continues in the next line:
2771 * |{bartype},{lots of values},>
2772 * |<{value},{value}
2773 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002774 eof = viminfo_readline(virp);
2775 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002776 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002777 /* File was truncated or garbled. Read another line if
2778 * this one starts with '|'. */
2779 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002780 p = virp->vir_line + 2;
2781 }
2782 }
2783
2784 if (isdigit(*p))
2785 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002786 value->bv_type = BVAL_NR;
2787 value->bv_nr = getdigits(&p);
2788 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002789 }
2790 else if (*p == '"')
2791 {
2792 int len = 0;
2793 char_u *s = p;
2794
2795 /* Unescape special characters in-place. */
2796 ++p;
2797 while (*p != '"')
2798 {
2799 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002800 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002801 if (*p == '\\')
2802 {
2803 ++p;
2804 if (*p == 'n')
2805 s[len++] = '\n';
2806 else
2807 s[len++] = *p;
2808 ++p;
2809 }
2810 else
2811 s[len++] = *p++;
2812 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002813 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002814 s[len] = NUL;
2815
Bram Moolenaar01227092016-06-11 14:47:40 +02002816 converted = FALSE;
2817 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2818 {
2819 sconv = string_convert(&virp->vir_conv, s, NULL);
2820 if (sconv != NULL)
2821 {
2822 if (s == buf)
2823 vim_free(s);
2824 s = sconv;
2825 buf = s;
2826 converted = TRUE;
2827 }
2828 }
Bram Moolenaar13505972019-01-24 15:04:48 +01002829
Bram Moolenaar01227092016-06-11 14:47:40 +02002830 /* Need to copy in allocated memory if the string wasn't allocated
2831 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002832 if (s != buf && allocated)
2833 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002834 value->bv_string = s;
2835 value->bv_type = BVAL_STRING;
2836 value->bv_len = len;
Bram Moolenaar13505972019-01-24 15:04:48 +01002837 value->bv_allocated = allocated || converted;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002838 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002839 if (nextp != NULL)
2840 {
2841 /* values following a long string */
2842 p = nextp;
2843 nextp = NULL;
2844 }
2845 }
2846 else if (*p == ',')
2847 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002848 value->bv_type = BVAL_EMPTY;
2849 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002850 }
2851 else
2852 break;
2853 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002854 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002855}
2856
2857 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002858read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002859{
2860 char_u *p = virp->vir_line + 1;
2861 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002862 garray_T values;
2863 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002864 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002865 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002866
2867 /* The format is: |{bartype},{value},...
2868 * For a very long string:
2869 * |{bartype},>{length of "{text}{text2}"}
2870 * |<{text1}
2871 * |<{text2},{value}
2872 * For a long line not using a string
2873 * |{bartype},{lots of values},>
2874 * |<{value},{value}
2875 */
2876 if (*p == '<')
2877 {
2878 /* Continuation line of an unrecognized item. */
2879 if (writing)
2880 ga_add_string(&virp->vir_barlines, virp->vir_line);
2881 }
2882 else
2883 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002884 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002885 bartype = getdigits(&p);
2886 switch (bartype)
2887 {
2888 case BARTYPE_VERSION:
2889 /* Only use the version when it comes before the encoding.
2890 * If it comes later it was copied by a Vim version that
2891 * doesn't understand the version. */
2892 if (!got_encoding)
2893 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002894 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002895 vp = (bval_T *)values.ga_data;
2896 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2897 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002898 }
2899 break;
2900
2901 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002902 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002903 handle_viminfo_history(&values, writing);
2904 break;
2905
2906 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002907 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002908 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002909 break;
2910
Bram Moolenaar2d358992016-06-12 21:20:54 +02002911 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002912 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002913 handle_viminfo_mark(&values, force);
2914 break;
2915
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002916 default:
2917 /* copy unrecognized line (for future use) */
2918 if (writing)
2919 ga_add_string(&virp->vir_barlines, virp->vir_line);
2920 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002921 for (i = 0; i < values.ga_len; ++i)
2922 {
2923 vp = (bval_T *)values.ga_data + i;
2924 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2925 vim_free(vp->bv_string);
2926 }
2927 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002928 }
2929
Bram Moolenaarecefe712016-06-20 12:50:17 +02002930 if (read_next)
2931 return viminfo_readline(virp);
2932 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002933}
2934
2935 static void
2936write_viminfo_version(FILE *fp_out)
2937{
2938 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2939 BARTYPE_VERSION, VIMINFO_VERSION);
2940}
2941
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002942 static void
2943write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2944{
2945 int i;
2946 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002947 int seen_useful = FALSE;
2948 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002949
2950 if (gap->ga_len > 0)
2951 {
2952 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2953
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002954 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002955 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002956 {
2957 line = ((char **)(gap->ga_data))[i];
2958 if (seen_useful || line[1] != '<')
2959 {
2960 fputs(line, fp_out);
2961 seen_useful = TRUE;
2962 }
2963 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002964 }
2965}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966#endif /* FEAT_VIMINFO */
2967
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002968/*
2969 * Return the current time in seconds. Calls time(), unless test_settime()
2970 * was used.
2971 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002972 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002973vim_time(void)
2974{
2975# ifdef FEAT_EVAL
2976 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2977# else
2978 return time(NULL);
2979# endif
2980}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002981
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982/*
2983 * Implementation of ":fixdel", also used by get_stty().
2984 * <BS> resulting <Del>
2985 * ^? ^H
2986 * not ^? ^?
2987 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002989do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990{
2991 char_u *p;
2992
2993 p = find_termcode((char_u *)"kb");
2994 add_termcode((char_u *)"kD", p != NULL
2995 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2996}
2997
2998 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002999print_line_no_prefix(
3000 linenr_T lnum,
3001 int use_number,
3002 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003{
Bram Moolenaar32526b32019-01-19 17:43:09 +01003004 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005
3006 if (curwin->w_p_nu || use_number)
3007 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01003008 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003009 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01003010 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003012 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013}
3014
3015/*
3016 * Print a text line. Also in silent mode ("ex -s").
3017 */
3018 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003019print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020{
3021 int save_silent = silent_mode;
3022
Bram Moolenaard29459b2016-08-26 22:29:11 +02003023 /* apply :filter /pat/ */
3024 if (message_filtered(ml_get(lnum)))
3025 return;
3026
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003028 silent_mode = FALSE;
3029 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
3030 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 if (save_silent)
3032 {
3033 msg_putchar('\n');
3034 cursor_on(); /* msg_start() switches it off */
3035 out_flush();
3036 silent_mode = save_silent;
3037 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00003038 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039}
3040
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003041 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003042rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003043{
3044 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02003045 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003046
Bram Moolenaar7e283842013-05-30 11:43:15 +02003047 buf = curbuf;
3048 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003049 /* buffer changed, don't change name now */
3050 if (buf != curbuf)
3051 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003052#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003053 if (aborting()) /* autocmds may abort script processing */
3054 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003055#endif
3056 /*
3057 * The name of the current buffer will be changed.
3058 * A new (unlisted) buffer entry needs to be made to hold the old file
3059 * name, which will become the alternate file name.
3060 * But don't set the alternate file name if the buffer didn't have a
3061 * name.
3062 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02003063 fname = curbuf->b_ffname;
3064 sfname = curbuf->b_sfname;
3065 xfname = curbuf->b_fname;
3066 curbuf->b_ffname = NULL;
3067 curbuf->b_sfname = NULL;
3068 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003069 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02003070 curbuf->b_ffname = fname;
3071 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003072 return FAIL;
3073 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02003074 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003075 if (xfname != NULL && *xfname != NUL)
3076 {
3077 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
3078 if (buf != NULL && !cmdmod.keepalt)
3079 curwin->w_alt_fnum = buf->b_fnum;
3080 }
3081 vim_free(fname);
3082 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02003083 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003084
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003085 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003086 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003087 return OK;
3088}
3089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090/*
3091 * ":file[!] [fname]".
3092 */
3093 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003094ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003096 /* ":0file" removes the file name. Check for illegal uses ":3file",
3097 * "0file name", etc. */
3098 if (eap->addr_count > 0
3099 && (*eap->arg != NUL
3100 || eap->line2 > 0
3101 || eap->addr_count > 1))
3102 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003103 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003104 return;
3105 }
3106
3107 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003109 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02003111 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02003113
3114 // print file name if no argument or 'F' is not in 'shortmess'
3115 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01003116 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117}
3118
3119/*
3120 * ":update".
3121 */
3122 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003123ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124{
3125 if (curbufIsChanged())
3126 (void)do_write(eap);
3127}
3128
3129/*
3130 * ":write" and ":saveas".
3131 */
3132 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003133ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134{
3135 if (eap->usefilter) /* input lines to shell command */
3136 do_bang(1, eap, FALSE, TRUE, FALSE);
3137 else
3138 (void)do_write(eap);
3139}
3140
3141/*
3142 * write current buffer to file 'eap->arg'
3143 * if 'eap->append' is TRUE, append to the file
3144 *
3145 * if *eap->arg == NUL write to current file
3146 *
3147 * return FAIL for failure, OK otherwise
3148 */
3149 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003150do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151{
3152 int other;
3153 char_u *fname = NULL; /* init to shut up gcc */
3154 char_u *ffname;
3155 int retval = FAIL;
3156 char_u *free_fname = NULL;
3157#ifdef FEAT_BROWSE
3158 char_u *browse_file = NULL;
3159#endif
3160 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003161 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162
3163 if (not_writing()) /* check 'write' option */
3164 return FAIL;
3165
3166 ffname = eap->arg;
3167#ifdef FEAT_BROWSE
3168 if (cmdmod.browse)
3169 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003170 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 NULL, NULL, NULL, curbuf);
3172 if (browse_file == NULL)
3173 goto theend;
3174 ffname = browse_file;
3175 }
3176#endif
3177 if (*ffname == NUL)
3178 {
3179 if (eap->cmdidx == CMD_saveas)
3180 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003181 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 goto theend;
3183 }
3184 other = FALSE;
3185 }
3186 else
3187 {
3188 fname = ffname;
3189 free_fname = fix_fname(ffname);
3190 /*
3191 * When out-of-memory, keep unexpanded file name, because we MUST be
3192 * able to write the file in this situation.
3193 */
3194 if (free_fname != NULL)
3195 ffname = free_fname;
3196 other = otherfile(ffname);
3197 }
3198
3199 /*
3200 * If we have a new file, put its name in the list of alternate file names.
3201 */
3202 if (other)
3203 {
3204 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3205 || eap->cmdidx == CMD_saveas)
3206 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3207 else
3208 alt_buf = buflist_findname(ffname);
3209 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3210 {
3211 /* Overwriting a file that is loaded in another buffer is not a
3212 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003213 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 goto theend;
3215 }
3216 }
3217
3218 /*
3219 * Writing to the current file is not allowed in readonly mode
3220 * and a file name is required.
3221 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3222 */
3223 if (!other && (
3224#ifdef FEAT_QUICKFIX
3225 bt_dontwrite_msg(curbuf) ||
3226#endif
3227 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3228 goto theend;
3229
3230 if (!other)
3231 {
3232 ffname = curbuf->b_ffname;
3233 fname = curbuf->b_fname;
3234 /*
3235 * Not writing the whole file is only allowed with '!'.
3236 */
3237 if ( (eap->line1 != 1
3238 || eap->line2 != curbuf->b_ml.ml_line_count)
3239 && !eap->forceit
3240 && !eap->append
3241 && !p_wa)
3242 {
3243#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3244 if (p_confirm || cmdmod.confirm)
3245 {
3246 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3247 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3248 goto theend;
3249 eap->forceit = TRUE;
3250 }
3251 else
3252#endif
3253 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003254 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 goto theend;
3256 }
3257 }
3258 }
3259
3260 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3261 {
3262 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3263 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 buf_T *was_curbuf = curbuf;
3265
3266 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003267 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003268#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003270#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003272#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 {
3274 /* buffer changed, don't change name now */
3275 retval = FAIL;
3276 goto theend;
3277 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 /* Exchange the file names for the current and the alternate
3279 * buffer. This makes it look like we are now editing the buffer
3280 * under the new name. Must be done before buf_write(), because
3281 * if there is no file name and 'cpo' contains 'F', it will set
3282 * the file name. */
3283 fname = alt_buf->b_fname;
3284 alt_buf->b_fname = curbuf->b_fname;
3285 curbuf->b_fname = fname;
3286 fname = alt_buf->b_ffname;
3287 alt_buf->b_ffname = curbuf->b_ffname;
3288 curbuf->b_ffname = fname;
3289 fname = alt_buf->b_sfname;
3290 alt_buf->b_sfname = curbuf->b_sfname;
3291 curbuf->b_sfname = fname;
3292 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003295 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 if (!alt_buf->b_p_bl)
3297 {
3298 alt_buf->b_p_bl = TRUE;
3299 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3300 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003301#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003303#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003305#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 {
3307 /* buffer changed, don't write the file */
3308 retval = FAIL;
3309 goto theend;
3310 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003311
3312 /* If 'filetype' was empty try detecting it now. */
3313 if (*curbuf->b_p_ft == NUL)
3314 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003315 if (au_has_group((char_u *)"filetypedetect"))
3316 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003317 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003318 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003319 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003320
3321 /* Autocommands may have changed buffer names, esp. when
3322 * 'autochdir' is set. */
3323 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 }
3325
Bram Moolenaar5c719942016-07-09 23:40:45 +02003326 name_was_missing = curbuf->b_ffname == NULL;
3327
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3329 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003330
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003331 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003332 if (eap->cmdidx == CMD_saveas)
3333 {
3334 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003335 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003336 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003337 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003338 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003339 }
3340
3341 /* Change directories when the 'acd' option is set and the file name
3342 * got changed or set. */
3343 if (eap->cmdidx == CMD_saveas || name_was_missing)
3344 {
Bram Moolenaar6f470022018-04-10 18:47:20 +02003345 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003346 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 }
3348
3349theend:
3350#ifdef FEAT_BROWSE
3351 vim_free(browse_file);
3352#endif
3353 vim_free(free_fname);
3354 return retval;
3355}
3356
3357/*
3358 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3359 * BF_NEW or BF_READERR, check for overwriting current file.
3360 * May set eap->forceit if a dialog says it's OK to overwrite.
3361 * Return OK if it's OK, FAIL if it is not.
3362 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003363 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003364check_overwrite(
3365 exarg_T *eap,
3366 buf_T *buf,
3367 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003369 char_u *ffname, /* full path version of fname */
3370 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371{
3372 /*
3373 * write to other file or b_flags set or not writing the whole file:
3374 * overwriting only allowed with '!'
3375 */
3376 if ( (other
3377 || (buf->b_flags & BF_NOTEDITED)
3378 || ((buf->b_flags & BF_NEW)
3379 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3380 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003382#ifdef FEAT_QUICKFIX
3383 && !bt_nofile(buf)
3384#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 && vim_fexists(ffname))
3386 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003387 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003389#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003390 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003391 if (mch_isdir(ffname))
3392 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003393 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003394 return FAIL;
3395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396#endif
3397#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003398 if (p_confirm || cmdmod.confirm)
3399 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003400 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003402 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3403 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3404 return FAIL;
3405 eap->forceit = TRUE;
3406 }
3407 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003409 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003410 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003411 return FAIL;
3412 }
3413 }
3414
3415 /* For ":w! filename" check that no swap file exists for "filename". */
3416 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003418 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003419 char_u *p;
3420 int r;
3421 char_u *swapname;
3422
3423 /* We only try the first entry in 'directory', without checking if
3424 * it's writable. If the "." directory is not writable the write
3425 * will probably fail anyway.
3426 * Use 'shortname' of the current buffer, since there is no buffer
3427 * for the written file. */
3428 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003429 {
3430 dir = alloc(5);
3431 if (dir == NULL)
3432 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003433 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003434 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003435 else
3436 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003437 dir = alloc(MAXPATHL);
3438 if (dir == NULL)
3439 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003440 p = p_dir;
3441 copy_option_part(&p, dir, MAXPATHL, ",");
3442 }
3443 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003444 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003445 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003446 if (r)
3447 {
3448#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3449 if (p_confirm || cmdmod.confirm)
3450 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003451 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003452
3453 dialog_msg(buff,
3454 _("Swap file \"%s\" exists, overwrite anyway?"),
3455 swapname);
3456 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3457 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003458 {
3459 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003460 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003461 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003462 eap->forceit = TRUE;
3463 }
3464 else
3465#endif
3466 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003467 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003468 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003469 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003470 return FAIL;
3471 }
3472 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003473 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 }
3475 }
3476 return OK;
3477}
3478
3479/*
3480 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3481 */
3482 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003483ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484{
3485 int i;
3486
3487 if (eap->cmd[1] == 'n')
3488 i = curwin->w_arg_idx + (int)eap->line2;
3489 else
3490 i = curwin->w_arg_idx - (int)eap->line2;
3491 eap->line1 = 1;
3492 eap->line2 = curbuf->b_ml.ml_line_count;
3493 if (do_write(eap) != FAIL)
3494 do_argfile(eap, i);
3495}
3496
3497/*
3498 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3499 */
3500 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003501do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502{
3503 buf_T *buf;
3504 int error = 0;
3505 int save_forceit = eap->forceit;
3506
3507 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3508 exiting = TRUE;
3509
Bram Moolenaar29323592016-07-24 22:04:11 +02003510 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003512#ifdef FEAT_TERMINAL
3513 if (exiting && term_job_running(buf->b_term))
3514 {
3515 no_write_message_nobang(buf);
3516 ++error;
3517 }
3518 else
3519#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003520 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 {
3522 /*
3523 * Check if there is a reason the buffer cannot be written:
3524 * 1. if the 'write' option is set
3525 * 2. if there is no file name (even after browsing)
3526 * 3. if the 'readonly' is set (even after a dialog)
3527 * 4. if overwriting is allowed (even after a dialog)
3528 */
3529 if (not_writing())
3530 {
3531 ++error;
3532 break;
3533 }
3534#ifdef FEAT_BROWSE
3535 /* ":browse wall": ask for file name if there isn't one */
3536 if (buf->b_ffname == NULL && cmdmod.browse)
3537 browse_save_fname(buf);
3538#endif
3539 if (buf->b_ffname == NULL)
3540 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003541 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 ++error;
3543 }
3544 else if (check_readonly(&eap->forceit, buf)
3545 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3546 FALSE) == FAIL)
3547 {
3548 ++error;
3549 }
3550 else
3551 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003552 bufref_T bufref;
3553
3554 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 if (buf_write_all(buf, eap->forceit) == FAIL)
3556 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003558 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 }
3561 eap->forceit = save_forceit; /* check_overwrite() may set it */
3562 }
3563 }
3564 if (exiting)
3565 {
3566 if (!error)
3567 getout(0); /* exit Vim */
3568 not_exiting();
3569 }
3570}
3571
3572/*
3573 * Check the 'write' option.
3574 * Return TRUE and give a message when it's not st.
3575 */
3576 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003577not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578{
3579 if (p_write)
3580 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003581 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 return TRUE;
3583}
3584
3585/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003586 * Check if a buffer is read-only (either 'readonly' option is set or file is
3587 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3588 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 */
3590 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003591check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003593 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003594
3595 /* Handle a file being readonly when the 'readonly' option is set or when
3596 * the file exists and permissions are read-only.
3597 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3598 * important for device checks but not here. */
3599 if (!*forceit && (buf->b_p_ro
3600 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3601 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 {
3603#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3604 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3605 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003606 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607
Bram Moolenaar5386a122007-06-28 20:02:32 +00003608 if (buf->b_p_ro)
3609 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3610 buf->b_fname);
3611 else
3612 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 +00003613 buf->b_fname);
3614
3615 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3616 {
3617 /* Set forceit, to force the writing of a readonly file */
3618 *forceit = TRUE;
3619 return FALSE;
3620 }
3621 else
3622 return TRUE;
3623 }
3624 else
3625#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003626 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003627 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003628 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003629 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00003630 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 return TRUE;
3632 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003633
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 return FALSE;
3635}
3636
3637/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003638 * Try to abandon the current file and edit a new or existing file.
3639 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003640 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003642 * Return:
3643 * GETFILE_ERROR for "normal" error,
3644 * GETFILE_NOT_WRITTEN for "not written" error,
3645 * GETFILE_SAME_FILE for success
3646 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 */
3648 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003649getfile(
3650 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003651 char_u *ffname_arg,
3652 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003653 int setpm,
3654 linenr_T lnum,
3655 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003657 char_u *ffname = ffname_arg;
3658 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 int other;
3660 int retval;
3661 char_u *free_me = NULL;
3662
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003663 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003664 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003665 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003666 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667
3668 if (fnum == 0)
3669 {
3670 /* make ffname full path, set sfname */
3671 fname_expand(curbuf, &ffname, &sfname);
3672 other = otherfile(ffname);
3673 free_me = ffname; /* has been allocated, free() later */
3674 }
3675 else
3676 other = (fnum != curbuf->b_fnum);
3677
3678 if (other)
3679 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003680 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3682 {
3683#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3684 if (p_confirm && p_write)
3685 dialog_changed(curbuf, FALSE);
3686 if (curbufIsChanged())
3687#endif
3688 {
3689 if (other)
3690 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003691 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003692 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 goto theend;
3694 }
3695 }
3696 if (other)
3697 --no_wait_return;
3698 if (setpm)
3699 setpcmark();
3700 if (!other)
3701 {
3702 if (lnum != 0)
3703 curwin->w_cursor.lnum = lnum;
3704 check_cursor_lnum();
3705 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003706 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 }
3708 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003709 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003710 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003711 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003713 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714
3715theend:
3716 vim_free(free_me);
3717 return retval;
3718}
3719
3720/*
3721 * start editing a new file
3722 *
3723 * fnum: file number; if zero use ffname/sfname
3724 * ffname: the file name
3725 * - full path if sfname used,
3726 * - any file name if sfname is NULL
3727 * - empty string to re-edit with the same file name (but may be
3728 * in a different directory)
3729 * - NULL to start an empty buffer
3730 * sfname: the short file name (or NULL)
3731 * eap: contains the command to be executed after loading the file and
3732 * forced 'ff' and 'fenc'
3733 * newlnum: if > 0: put cursor on this line number (if possible)
3734 * if ECMD_LASTL: use last position in loaded file
3735 * if ECMD_LAST: use last position in all files
3736 * if ECMD_ONE: use first line
3737 * flags:
3738 * ECMD_HIDE: if TRUE don't free the current buffer
3739 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3740 * ECMD_OLDBUF: use existing buffer if it exists
3741 * ECMD_FORCEIT: ! used for Ex command
3742 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003743 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003744 * window, NULL when splitting the window first. When not NULL info
3745 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 *
3747 * return FAIL for failure, OK otherwise
3748 */
3749 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003750do_ecmd(
3751 int fnum,
3752 char_u *ffname,
3753 char_u *sfname,
3754 exarg_T *eap, /* can be NULL! */
3755 linenr_T newlnum,
3756 int flags,
3757 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758{
3759 int other_file; /* TRUE if editing another file */
3760 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 int auto_buf = FALSE; /* TRUE if autocommands brought us
3762 into the buffer unexpectedly */
3763 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003764#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003765 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766#endif
3767 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003768 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003769 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 char_u *free_fname = NULL;
3771#ifdef FEAT_BROWSE
3772 char_u *browse_file = NULL;
3773#endif
3774 int retval = FAIL;
3775 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003776 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 linenr_T topline = 0;
3778 int newcol = -1;
3779 int solcol = -1;
3780 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003782#ifdef FEAT_SPELL
3783 int did_get_winopts = FALSE;
3784#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003785 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003786 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003787 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788
3789 if (eap != NULL)
3790 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003791 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792
3793 if (fnum != 0)
3794 {
3795 if (fnum == curbuf->b_fnum) /* file is already being edited */
3796 return OK; /* nothing to do */
3797 other_file = TRUE;
3798 }
3799 else
3800 {
3801#ifdef FEAT_BROWSE
3802 if (cmdmod.browse)
3803 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003804 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003805# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003806 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003807# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003808 au_has_group((char_u *)"FileExplorer"))
3809 {
3810 /* No browsing supported but we do have the file explorer:
3811 * Edit the directory. */
3812 if (ffname == NULL || !mch_isdir(ffname))
3813 ffname = (char_u *)".";
3814 }
3815 else
3816 {
3817 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003819 if (browse_file == NULL)
3820 goto theend;
3821 ffname = browse_file;
3822 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 }
3824#endif
3825 /* if no short name given, use ffname for short name */
3826 if (sfname == NULL)
3827 sfname = ffname;
3828#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01003829 if (sfname != NULL)
3830 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831#endif
3832
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3834 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835
3836 if (ffname == NULL)
3837 other_file = TRUE;
3838 /* there is no file name */
3839 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3840 other_file = FALSE;
3841 else
3842 {
3843 if (*ffname == NUL) /* re-edit with same file name */
3844 {
3845 ffname = curbuf->b_ffname;
3846 sfname = curbuf->b_fname;
3847 }
3848 free_fname = fix_fname(ffname); /* may expand to full path name */
3849 if (free_fname != NULL)
3850 ffname = free_fname;
3851 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 }
3853 }
3854
3855 /*
3856 * if the file was changed we may not be allowed to abandon it
3857 * - if we are going to re-edit the same file
3858 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3859 */
3860 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3861 || (curbuf->b_nwindows == 1
3862 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003863 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3864 | (other_file ? 0 : CCGD_MULTWIN)
3865 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3866 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 {
3868 if (fnum == 0 && other_file && ffname != NULL)
3869 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3870 goto theend;
3871 }
3872
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 /*
3874 * End Visual mode before switching to another buffer, so the text can be
3875 * copied into the GUI selection buffer.
3876 */
3877 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003879#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003880 if ((command != NULL || newlnum > (linenr_T)0)
3881 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3882 {
3883 int len;
3884 char_u *p;
3885
3886 /* Set v:swapcommand for the SwapExists autocommands. */
3887 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003888 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003889 else
3890 len = 30;
3891 p = alloc((unsigned)len);
3892 if (p != NULL)
3893 {
3894 if (command != NULL)
3895 vim_snprintf((char *)p, len, ":%s\r", command);
3896 else
3897 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3898 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3899 did_set_swapcommand = TRUE;
3900 vim_free(p);
3901 }
3902 }
3903#endif
3904
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 /*
3906 * If we are starting to edit another file, open a (new) buffer.
3907 * Otherwise we re-use the current buffer.
3908 */
3909 if (other_file)
3910 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003913 if (!cmdmod.keepalt)
3914 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003915 if (oldwin != NULL)
3916 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 }
3918
3919 if (fnum)
3920 buf = buflist_findnr(fnum);
3921 else
3922 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 if (flags & ECMD_ADDBUF)
3924 {
3925 linenr_T tlnum = 1L;
3926
3927 if (command != NULL)
3928 {
3929 tlnum = atol((char *)command);
3930 if (tlnum <= 0)
3931 tlnum = 1L;
3932 }
3933 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3934 goto theend;
3935 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 buf = buflist_new(ffname, sfname, 0L,
3937 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003938
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003939 /* autocommands may change curwin and curbuf */
3940 if (oldwin != NULL)
3941 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003942 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 }
3944 if (buf == NULL)
3945 goto theend;
3946 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3947 {
3948 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 }
3950 else /* existing memfile */
3951 {
3952 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003953 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003955 /* Check if autocommands made the buffer invalid or changed the
3956 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003957 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 goto theend;
3959#ifdef FEAT_EVAL
3960 if (aborting()) /* autocmds may abort script processing */
3961 goto theend;
3962#endif
3963 }
3964
3965 /* May jump to last used line number for a loaded buffer or when asked
3966 * for explicitly */
3967 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3968 {
3969 pos = buflist_findfpos(buf);
3970 newlnum = pos->lnum;
3971 solcol = pos->col;
3972 }
3973
3974 /*
3975 * Make the (new) buffer the one used by the current window.
3976 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3977 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003978 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 */
3980 if (buf != curbuf)
3981 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 /*
3983 * Be careful: The autocommands may delete any buffer and change
3984 * the current buffer.
3985 * - If the buffer we are going to edit is deleted, give up.
3986 * - If the current buffer is deleted, prefer to load the new
3987 * buffer when loading a buffer is required. This avoids
3988 * loading another buffer which then must be closed again.
3989 * - If we ended up in the new buffer already, need to skip a few
3990 * things, set auto_buf.
3991 */
3992 if (buf->b_fname != NULL)
3993 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003994 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003996 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003998 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 delbuf_msg(new_name); /* frees new_name */
4000 goto theend;
4001 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004002#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 if (aborting()) /* autocmds may abort script processing */
4004 {
4005 vim_free(new_name);
4006 goto theend;
4007 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004008#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 if (buf == curbuf) /* already in new buffer */
4010 auto_buf = TRUE;
4011 else
4012 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02004013 win_T *the_curwin = curwin;
4014
4015 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004016 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02004017 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004018 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02004019
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004020 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 buf_copy_options(buf, BCO_ENTER);
4022
Bram Moolenaar5a497892016-09-03 16:29:04 +02004023 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02004024 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004025 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00004026 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01004027 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028
Bram Moolenaar5a497892016-09-03 16:29:04 +02004029 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004030 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01004031
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004032#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02004033 /* autocmds may abort script processing */
4034 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 {
4036 vim_free(new_name);
4037 goto theend;
4038 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004039#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004041 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004043 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 delbuf_msg(new_name); /* frees new_name */
4045 goto theend;
4046 }
4047 if (buf == curbuf) /* already in new buffer */
4048 auto_buf = TRUE;
4049 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02004051#ifdef FEAT_SYN_HL
4052 /*
4053 * <VN> We could instead free the synblock
4054 * and re-attach to buffer, perhaps.
4055 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02004056 if (curwin->w_buffer == NULL
4057 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02004058 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02004059#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 curwin->w_buffer = buf;
4061 curbuf = buf;
4062 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02004063
4064 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
4065 if (!oldbuf && eap != NULL)
4066 {
4067 set_file_options(TRUE, eap);
4068 set_forced_fenc(eap);
4069 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 }
4071
4072 /* May get the window options from the last time this buffer
4073 * was in this window (or another window). If not used
4074 * before, reset the local window options to the global
4075 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004076 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004077#ifdef FEAT_SPELL
4078 did_get_winopts = TRUE;
4079#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 }
4081 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004082 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004083 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 curwin->w_pcmark.lnum = 1;
4087 curwin->w_pcmark.col = 0;
4088 }
4089 else /* !other_file */
4090 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02004091 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004093
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 oldbuf = (flags & ECMD_OLDBUF);
4095 }
4096
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004097 /* Don't redraw until the cursor is in the right line, otherwise
4098 * autocommands may cause ml_get errors. */
4099 ++RedrawingDisabled;
4100 did_inc_redrawing_disabled = TRUE;
4101
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004102 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4104 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004105 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 }
4107 else
4108 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 /* Don't make a buffer listed if it's a help buffer. Useful when
4110 * using CTRL-O to go back to a help file. */
4111 if (!curbuf->b_help)
4112 set_buflisted(TRUE);
4113 }
4114
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 /* If autocommands change buffers under our fingers, forget about
4116 * editing the file. */
4117 if (buf != curbuf)
4118 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004119#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 if (aborting()) /* autocmds may abort script processing */
4121 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004122#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123
4124 /* Since we are starting to edit a file, consider the filetype to be
4125 * unset. Helps for when an autocommand changes files and expects syntax
4126 * highlighting to work in the other file. */
4127 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128
4129/*
4130 * other_file oldbuf
4131 * FALSE FALSE re-edit same file, buffer is re-used
4132 * FALSE TRUE re-edit same file, nothing changes
4133 * TRUE FALSE start editing new file, new buffer
4134 * TRUE TRUE start editing in existing buffer (nothing to do)
4135 */
4136 if (!other_file && !oldbuf) /* re-use the buffer */
4137 {
4138 set_last_cursor(curwin); /* may set b_last_cursor */
4139 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4140 {
4141 newlnum = curwin->w_cursor.lnum;
4142 solcol = curwin->w_cursor.col;
4143 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 buf = curbuf;
4145 if (buf->b_fname != NULL)
4146 new_name = vim_strsave(buf->b_fname);
4147 else
4148 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004149 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004150
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004151 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4152 {
4153 /* Save all the text, so that the reload can be undone.
4154 * Sync first so that this is a separate undo-able action. */
4155 u_sync(FALSE);
4156 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4157 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004158 {
4159 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004160 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004161 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004162 u_unchanged(curbuf);
4163 buf_freeall(curbuf, BFA_KEEP_UNDO);
4164
4165 /* tell readfile() not to clear or reload undo info */
4166 readfile_flags = READ_KEEP_UNDO;
4167 }
4168 else
4169 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004170
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 /* If autocommands deleted the buffer we were going to re-edit, give
4172 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004173 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 {
4175 delbuf_msg(new_name); /* frees new_name */
4176 goto theend;
4177 }
4178 vim_free(new_name);
4179
4180 /* If autocommands change buffers under our fingers, forget about
4181 * re-editing the file. Should do the buf_clear_file(), but perhaps
4182 * the autocommands changed the buffer... */
4183 if (buf != curbuf)
4184 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004185#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 if (aborting()) /* autocmds may abort script processing */
4187 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188#endif
4189 buf_clear_file(curbuf);
4190 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4191 curbuf->b_op_end.lnum = 0;
4192 }
4193
4194/*
4195 * If we get here we are sure to start editing
4196 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 /* Assume success now */
4198 retval = OK;
4199
4200 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 * Check if we are editing the w_arg_idx file in the argument list.
4202 */
4203 check_arg_idx(curwin);
4204
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 {
4207 /*
4208 * Set cursor and init window before reading the file and executing
4209 * autocommands. This allows for the autocommands to position the
4210 * cursor.
4211 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004212 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213
4214#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004215 /* It's possible that all lines in the buffer changed. Need to update
4216 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004217 {
4218 win_T *win;
4219 tabpage_T *tp;
4220
4221 FOR_ALL_TAB_WINDOWS(tp, win)
4222 if (win->w_buffer == curbuf)
4223 foldUpdateAll(win);
4224 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225#endif
4226
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004227 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02004228 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004229
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 /*
4231 * Careful: open_buffer() and apply_autocmds() may change the current
4232 * buffer and window.
4233 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004234 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 topline = curwin->w_topline;
4236 if (!oldbuf) /* need to read the file */
4237 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004238#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 swap_exists_action = SEA_DIALOG;
4240#endif
4241 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4242
4243 /*
4244 * Open the buffer and read the file.
4245 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004246#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004247 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 retval = FAIL;
4249#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004250 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251#endif
4252
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004253#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 if (swap_exists_action == SEA_QUIT)
4255 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004256 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257#endif
4258 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 else
4260 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004261 /* Read the modelines, but only to set window-local options. Any
4262 * buffer-local options have already been set and may have been
4263 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004264 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004265
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4267 &retval);
4268 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4269 &retval);
4270 }
4271 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272
Bram Moolenaareab316b2015-03-24 11:46:30 +01004273 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004274 * keep it. Also when it moves within a line. But not when it moves
4275 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004276 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004278 char_u *text = ml_get_curline();
4279
4280 if (curwin->w_cursor.lnum != orig_pos.lnum
4281 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
4282 {
4283 newlnum = curwin->w_cursor.lnum;
4284 newcol = curwin->w_cursor.col;
4285 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 }
4287 if (curwin->w_topline == topline)
4288 topline = 0;
4289
4290 /* Even when cursor didn't move we need to recompute topline. */
4291 changed_line_abv_curs();
4292
4293#ifdef FEAT_TITLE
4294 maketitle();
4295#endif
4296 }
4297
4298#ifdef FEAT_DIFF
4299 /* Tell the diff stuff that this buffer is new and/or needs updating.
4300 * Also needed when re-editing the same buffer, because unloading will
4301 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004302 if (curwin->w_p_diff)
4303 {
4304 diff_buf_add(curbuf);
4305 diff_invalidate(curbuf);
4306 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307#endif
4308
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004309#ifdef FEAT_SPELL
4310 /* If the window options were changed may need to set the spell language.
4311 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004312 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4313 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004314#endif
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 if (command == NULL)
4317 {
4318 if (newcol >= 0) /* position set by autocommands */
4319 {
4320 curwin->w_cursor.lnum = newlnum;
4321 curwin->w_cursor.col = newcol;
4322 check_cursor();
4323 }
4324 else if (newlnum > 0) /* line number from caller or old position */
4325 {
4326 curwin->w_cursor.lnum = newlnum;
4327 check_cursor_lnum();
4328 if (solcol >= 0 && !p_sol)
4329 {
4330 /* 'sol' is off: Use last known column. */
4331 curwin->w_cursor.col = solcol;
4332 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 curwin->w_set_curswant = TRUE;
4335 }
4336 else
4337 beginline(BL_SOL | BL_FIX);
4338 }
4339 else /* no line number, go to last line in Ex mode */
4340 {
4341 if (exmode_active)
4342 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4343 beginline(BL_WHITE | BL_FIX);
4344 }
4345 }
4346
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 /* Check if cursors in other windows on the same buffer are still valid */
4348 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349
4350 /*
4351 * Did not read the file, need to show some info about the file.
4352 * Do this after setting the cursor.
4353 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004354 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 {
4356 int msg_scroll_save = msg_scroll;
4357
4358 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4359 * message. */
4360 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4361 msg_scroll = FALSE;
4362 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4363 check_for_delay(FALSE);
4364 msg_start();
4365 msg_scroll = msg_scroll_save;
4366 msg_scrolled_ign = TRUE;
4367
Bram Moolenaar426dd022016-03-15 15:09:29 +01004368 if (!shortmess(SHM_FILEINFO))
4369 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370
4371 msg_scrolled_ign = FALSE;
4372 }
4373
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004374#ifdef FEAT_VIMINFO
4375 curbuf->b_last_used = vim_time();
4376#endif
4377
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 if (command != NULL)
4379 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4380
4381#ifdef FEAT_KEYMAP
4382 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004383 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384#endif
4385
4386 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004387 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 if (!skip_redraw)
4389 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01004390 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01004392 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01004395 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4397 }
4398
4399 if (p_im)
4400 need_start_insertmode = TRUE;
4401
Bram Moolenaar15833232018-02-03 18:33:17 +01004402#ifdef FEAT_AUTOCHDIR
4403 /* Change directories when the 'acd' option is set and we aren't already in
4404 * that directory (should already be done above). Expect getcwd() to be
4405 * faster than calling shorten_fnames() unnecessarily. */
4406 if (p_acd && curbuf->b_ffname != NULL)
4407 {
4408 char_u curdir[MAXPATHL];
4409 char_u filedir[MAXPATHL];
4410
4411 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4412 *gettail_sep(filedir) = NUL;
4413 if (mch_dirname(curdir, MAXPATHL) != FAIL
4414 && vim_fnamecmp(curdir, filedir) != 0)
4415 do_autochdir();
4416 }
4417#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01004419#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004420 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004423 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004424 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425# endif
4426 }
4427#endif
4428
4429theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004430 if (did_inc_redrawing_disabled)
4431 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004432#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004433 if (did_set_swapcommand)
4434 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4435#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436#ifdef FEAT_BROWSE
4437 vim_free(browse_file);
4438#endif
4439 vim_free(free_fname);
4440 return retval;
4441}
4442
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004444delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004446 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 name == NULL ? (char_u *)"" : name);
4448 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004449 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004450 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004453static int append_indent = 0; /* autoindent for first line */
4454
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455/*
4456 * ":insert" and ":append", also used by ":change"
4457 */
4458 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004459ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460{
4461 char_u *theline;
4462 int did_undo = FALSE;
4463 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004464 int indent = 0;
4465 char_u *p;
4466 int vcol;
4467 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004469 /* the ! flag toggles autoindent */
4470 if (eap->forceit)
4471 curbuf->b_p_ai = !curbuf->b_p_ai;
4472
4473 /* First autoindent comes from the line we start on */
4474 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4475 append_indent = get_indent_lnum(lnum);
4476
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 if (eap->cmdidx != CMD_append)
4478 --lnum;
4479
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004480 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004481 if (empty && lnum == 1)
4482 lnum = 0;
4483
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 State = INSERT; /* behave like in Insert mode */
4485 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4486 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004487
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004488 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 {
4490 msg_scroll = TRUE;
4491 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004492 if (curbuf->b_p_ai)
4493 {
4494 if (append_indent >= 0)
4495 {
4496 indent = append_indent;
4497 append_indent = -1;
4498 }
4499 else if (lnum > 0)
4500 indent = get_indent_lnum(lnum);
4501 }
4502 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004504 {
4505 /* No getline() function, use the lines that follow. This ends
4506 * when there is no more. */
4507 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4508 break;
4509 p = vim_strchr(eap->nextcmd, NL);
4510 if (p == NULL)
4511 p = eap->nextcmd + STRLEN(eap->nextcmd);
4512 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4513 if (*p != NUL)
4514 ++p;
4515 eap->nextcmd = p;
4516 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004518 {
4519 int save_State = State;
4520
4521 /* Set State to avoid the cursor shape to be set to INSERT mode
4522 * when getline() returns. */
4523 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 theline = eap->getline(
4525#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004526 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004528 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004529 State = save_State;
4530 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004532 if (theline == NULL)
4533 break;
4534
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004535 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4536 if (ex_keep_indent)
4537 append_indent = indent;
4538
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004539 /* Look for the "." after automatic indent. */
4540 vcol = 0;
4541 for (p = theline; indent > vcol; ++p)
4542 {
4543 if (*p == ' ')
4544 ++vcol;
4545 else if (*p == TAB)
4546 vcol += 8 - vcol % 8;
4547 else
4548 break;
4549 }
4550 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004551 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4552 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 {
4554 vim_free(theline);
4555 break;
4556 }
4557
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004558 /* don't use autoindent if nothing was typed. */
4559 if (p[0] == NUL)
4560 theline[0] = NUL;
4561
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 did_undo = TRUE;
4563 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004564 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565
4566 vim_free(theline);
4567 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004568
4569 if (empty)
4570 {
4571 ml_delete(2L, FALSE);
4572 empty = FALSE;
4573 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 }
4575 State = NORMAL;
4576
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004577 if (eap->forceit)
4578 curbuf->b_p_ai = !curbuf->b_p_ai;
4579
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004581 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 * "end" is set to lnum when something has been appended, otherwise
4583 * it is the same than "start" -- Acevedo */
4584 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4585 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4586 if (eap->cmdidx != CMD_append)
4587 --curbuf->b_op_start.lnum;
4588 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4589 ? lnum : curbuf->b_op_start.lnum;
4590 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4591 curwin->w_cursor.lnum = lnum;
4592 check_cursor_lnum();
4593 beginline(BL_SOL | BL_FIX);
4594
4595 need_wait_return = FALSE; /* don't use wait_return() now */
4596 ex_no_reprint = TRUE;
4597}
4598
4599/*
4600 * ":change"
4601 */
4602 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004603ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604{
4605 linenr_T lnum;
4606
4607 if (eap->line2 >= eap->line1
4608 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4609 return;
4610
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004611 /* the ! flag toggles autoindent */
4612 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4613 append_indent = get_indent_lnum(eap->line1);
4614
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4616 {
4617 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4618 break;
4619 ml_delete(eap->line1, FALSE);
4620 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004621
4622 /* make sure the cursor is not beyond the end of the file now */
4623 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4625
4626 /* ":append" on the line above the deleted lines. */
4627 eap->line2 = eap->line1;
4628 ex_append(eap);
4629}
4630
4631 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004632ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633{
4634 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004635 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004636 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 int minus = 0;
4638 linenr_T start, end, curs, i;
4639 int j;
4640 linenr_T lnum = eap->line2;
4641
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004642 /* Vi compatible: ":z!" uses display height, without a count uses
4643 * 'scroll' */
4644 if (eap->forceit)
4645 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004646 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004647 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004648 else
4649 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 if (bigness < 1)
4651 bigness = 1;
4652
4653 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004654 kind = x;
4655 if (*kind == '-' || *kind == '+' || *kind == '='
4656 || *kind == '^' || *kind == '.')
4657 ++x;
4658 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 ++x;
4660
4661 if (*x != 0)
4662 {
4663 if (!VIM_ISDIGIT(*x))
4664 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004665 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 return;
4667 }
4668 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004669 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004670 bigness = atol((char *)x);
4671
4672 /* bigness could be < 0 if atol(x) overflows. */
4673 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4674 bigness = 2 * curbuf->b_ml.ml_line_count;
4675
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004676 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004677 if (*kind == '=')
4678 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004679 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 }
4681
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004682 /* the number of '-' and '+' multiplies the distance */
4683 if (*kind == '-' || *kind == '+')
4684 for (x = kind + 1; *x == *kind; ++x)
4685 ;
4686
4687 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 {
4689 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004690 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4691 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004692 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 break;
4694
4695 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004696 start = lnum - (bigness + 1) / 2 + 1;
4697 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 curs = lnum;
4699 minus = 1;
4700 break;
4701
4702 case '^':
4703 start = lnum - bigness * 2;
4704 end = lnum - bigness;
4705 curs = lnum - bigness;
4706 break;
4707
4708 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004709 start = lnum - (bigness + 1) / 2 + 1;
4710 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 curs = end;
4712 break;
4713
4714 default: /* '+' */
4715 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004716 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004717 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004718 else if (eap->addr_count == 0)
4719 ++start;
4720 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 curs = end;
4722 break;
4723 }
4724
4725 if (start < 1)
4726 start = 1;
4727
4728 if (end > curbuf->b_ml.ml_line_count)
4729 end = curbuf->b_ml.ml_line_count;
4730
4731 if (curs > curbuf->b_ml.ml_line_count)
4732 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004733 else if (curs < 1)
4734 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735
4736 for (i = start; i <= end; i++)
4737 {
4738 if (minus && i == lnum)
4739 {
4740 msg_putchar('\n');
4741
4742 for (j = 1; j < Columns; j++)
4743 msg_putchar('-');
4744 }
4745
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004746 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
4748 if (minus && i == lnum)
4749 {
4750 msg_putchar('\n');
4751
4752 for (j = 1; j < Columns; j++)
4753 msg_putchar('-');
4754 }
4755 }
4756
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004757 if (curwin->w_cursor.lnum != curs)
4758 {
4759 curwin->w_cursor.lnum = curs;
4760 curwin->w_cursor.col = 0;
4761 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 ex_no_reprint = TRUE;
4763}
4764
4765/*
4766 * Check if the restricted flag is set.
4767 * If so, give an error message and return TRUE.
4768 * Otherwise, return FALSE.
4769 */
4770 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004771check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772{
4773 if (restricted)
4774 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01004775 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 return TRUE;
4777 }
4778 return FALSE;
4779}
4780
4781/*
4782 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4783 * If so, give an error message and return TRUE.
4784 * Otherwise, return FALSE.
4785 */
4786 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004787check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788{
4789 if (secure)
4790 {
4791 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004792 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 return TRUE;
4794 }
4795#ifdef HAVE_SANDBOX
4796 /*
4797 * In the sandbox more things are not allowed, including the things
4798 * disallowed in secure mode.
4799 */
4800 if (sandbox != 0)
4801 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004802 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 return TRUE;
4804 }
4805#endif
4806 return FALSE;
4807}
4808
4809static char_u *old_sub = NULL; /* previous substitute pattern */
4810static int global_need_beginline; /* call beginline() after ":g" */
4811
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004812/*
4813 * Flags that are kept between calls to :substitute.
4814 */
4815typedef struct {
4816 int do_all; /* do multiple substitutions per line */
4817 int do_ask; /* ask for confirmation */
4818 int do_count; /* count only */
4819 int do_error; /* if false, ignore errors */
4820 int do_print; /* print last line with subs. */
4821 int do_list; /* list last line with subs. */
4822 int do_number; /* list last line with line nr*/
4823 int do_ic; /* ignore case flag */
4824} subflags_T;
4825
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826/* do_sub()
4827 *
4828 * Perform a substitution from line eap->line1 to line eap->line2 using the
4829 * command pointed to by eap->arg which should be of the form:
4830 *
4831 * /pattern/substitution/{flags}
4832 *
4833 * The usual escapes are supported as described in the regexp docs.
4834 */
4835 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004836do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837{
4838 linenr_T lnum;
4839 long i = 0;
4840 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004841 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4842 FALSE, FALSE, 0};
4843#ifdef FEAT_EVAL
4844 subflags_T subflags_save;
4845#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004846 int save_do_all; /* remember user specified 'g' flag */
4847 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4849 int delimiter;
4850 int sublen;
4851 int got_quit = FALSE;
4852 int got_match = FALSE;
4853 int temp;
4854 int which_pat;
4855 char_u *cmd;
4856 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004857 linenr_T first_line = 0; /* first changed line */
4858 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 * change */
4860 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4861 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004862 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004863 char_u *sub_firstline; /* allocated copy of first sub line */
4864 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004865 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004866 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004867#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004868 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004869#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870
4871 cmd = eap->arg;
4872 if (!global_busy)
4873 {
4874 sub_nsubs = 0;
4875 sub_nlines = 0;
4876 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004877 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 if (eap->cmdidx == CMD_tilde)
4880 which_pat = RE_LAST; /* use last used regexp */
4881 else
4882 which_pat = RE_SUBST; /* use last substitute regexp */
4883
4884 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004885 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4887 {
4888 /* don't accept alphanumeric for separator */
4889 if (isalpha(*cmd))
4890 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004891 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 return;
4893 }
4894 /*
4895 * undocumented vi feature:
4896 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4897 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4898 */
4899 if (*cmd == '\\')
4900 {
4901 ++cmd;
4902 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4903 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004904 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 return;
4906 }
4907 if (*cmd != '&')
4908 which_pat = RE_SEARCH; /* use last '/' pattern */
4909 pat = (char_u *)""; /* empty search pattern */
4910 delimiter = *cmd++; /* remember delimiter character */
4911 }
4912 else /* find the end of the regexp */
4913 {
4914 which_pat = RE_LAST; /* use last used regexp */
4915 delimiter = *cmd++; /* remember delimiter character */
4916 pat = cmd; /* remember start of search pat */
4917 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4918 if (cmd[0] == delimiter) /* end delimiter found */
4919 *cmd++ = NUL; /* replace it with a NUL */
4920 }
4921
4922 /*
4923 * Small incompatibility: vi sees '\n' as end of the command, but in
4924 * Vim we want to use '\n' to find/substitute a NUL.
4925 */
4926 sub = cmd; /* remember the start of the substitution */
4927
4928 while (cmd[0])
4929 {
4930 if (cmd[0] == delimiter) /* end delimiter found */
4931 {
4932 *cmd++ = NUL; /* replace it with a NUL */
4933 break;
4934 }
4935 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4936 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004937 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 }
4939
4940 if (!eap->skip)
4941 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004942 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4943 if (STRCMP(sub, "%") == 0
4944 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4945 {
4946 if (old_sub == NULL) /* there is no previous command */
4947 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004948 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004949 return;
4950 }
4951 sub = old_sub;
4952 }
4953 else
4954 {
4955 vim_free(old_sub);
4956 old_sub = vim_strsave(sub);
4957 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 }
4959 }
4960 else if (!eap->skip) /* use previous pattern and substitution */
4961 {
4962 if (old_sub == NULL) /* there is no previous command */
4963 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004964 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 return;
4966 }
4967 pat = NULL; /* search_regcomp() will use previous pattern */
4968 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004969
4970 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4971 * last column after using "$". */
4972 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 }
4974
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004975 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4976 * more efficient.
4977 * TODO: find a generic solution to make line-joining operations more
4978 * efficient, avoid allocating a string that grows in size.
4979 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004980 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004981 && *sub == NUL
4982 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4983 || *cmd == 'p' || *cmd == '#'))))
4984 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004985 linenr_T joined_lines_count;
4986
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004987 curwin->w_cursor.lnum = eap->line1;
4988 if (*cmd == 'l')
4989 eap->flags = EXFLAG_LIST;
4990 else if (*cmd == '#')
4991 eap->flags = EXFLAG_NR;
4992 else if (*cmd == 'p')
4993 eap->flags = EXFLAG_PRINT;
4994
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004995 /* The number of lines joined is the number of lines in the range plus
4996 * one. One less when the last line is included. */
4997 joined_lines_count = eap->line2 - eap->line1 + 1;
4998 if (eap->line2 < curbuf->b_ml.ml_line_count)
4999 ++joined_lines_count;
5000 if (joined_lines_count > 1)
5001 {
5002 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
5003 sub_nsubs = joined_lines_count - 1;
5004 sub_nlines = 1;
5005 (void)do_sub_msg(FALSE);
5006 ex_may_print(eap);
5007 }
5008
5009 if (!cmdmod.keeppatterns)
5010 save_re_pat(RE_SUBST, pat, p_magic);
5011#ifdef FEAT_CMDHIST
5012 /* put pattern in history */
5013 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
5014#endif
5015
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005016 return;
5017 }
5018
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 /*
5020 * Find trailing options. When '&' is used, keep old options.
5021 */
5022 if (*cmd == '&')
5023 ++cmd;
5024 else
5025 {
5026 if (!p_ed)
5027 {
5028 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005029 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005031 subflags.do_all = FALSE;
5032 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005034 subflags.do_error = TRUE;
5035 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01005036 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005037 subflags.do_count = FALSE;
5038 subflags.do_number = FALSE;
5039 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 }
5041 while (*cmd)
5042 {
5043 /*
5044 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
5045 * 'r' is never inverted.
5046 */
5047 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005048 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005050 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005051 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005052 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005054 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 else if (*cmd == 'r') /* use last used regexp */
5056 which_pat = RE_LAST;
5057 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005058 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005059 else if (*cmd == '#')
5060 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005061 subflags.do_print = TRUE;
5062 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005063 }
5064 else if (*cmd == 'l')
5065 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005066 subflags.do_print = TRUE;
5067 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005068 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005070 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005072 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 else
5074 break;
5075 ++cmd;
5076 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005077 if (subflags.do_count)
5078 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005080 save_do_all = subflags.do_all;
5081 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005082
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 /*
5084 * check for a trailing count
5085 */
5086 cmd = skipwhite(cmd);
5087 if (VIM_ISDIGIT(*cmd))
5088 {
5089 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005090 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005092 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 return;
5094 }
5095 eap->line1 = eap->line2;
5096 eap->line2 += i - 1;
5097 if (eap->line2 > curbuf->b_ml.ml_line_count)
5098 eap->line2 = curbuf->b_ml.ml_line_count;
5099 }
5100
5101 /*
5102 * check for trailing command or garbage
5103 */
5104 cmd = skipwhite(cmd);
5105 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5106 {
5107 eap->nextcmd = check_nextcmd(cmd);
5108 if (eap->nextcmd == NULL)
5109 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005110 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 return;
5112 }
5113 }
5114
5115 if (eap->skip) /* not executing commands, only parsing */
5116 return;
5117
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005118 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005119 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005120 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005121 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005122 return;
5123 }
5124
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5126 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005127 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005128 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 return;
5130 }
5131
5132 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005133 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005135 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 regmatch.rmm_ic = FALSE;
5137
5138 sub_firstline = NULL;
5139
5140 /*
5141 * ~ in the substitute pattern is replaced with the old pattern.
5142 * We do it here once to avoid it to be replaced over and over again.
5143 * But don't do it when it starts with "\=", then it's an expression.
5144 */
5145 if (!(sub[0] == '\\' && sub[1] == '='))
5146 sub = regtilde(sub, p_magic);
5147
5148 /*
5149 * Check for a match on each line.
5150 */
5151 line2 = eap->line2;
5152 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005153#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 || aborting()
5155#endif
5156 ); ++lnum)
5157 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005158 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005159 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 if (nmatch)
5161 {
5162 colnr_T copycol;
5163 colnr_T matchcol;
5164 colnr_T prev_matchcol = MAXCOL;
5165 char_u *new_end, *new_start = NULL;
5166 unsigned new_start_len = 0;
5167 char_u *p1;
5168 int did_sub = FALSE;
5169 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005170 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 long nmatch_tl = 0; /* nr of lines matched below lnum */
5172 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005173 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005174 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 /*
5177 * The new text is build up step by step, to avoid too much
5178 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005179 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 * copycol Column in the old text where we started
5181 * looking for a match; from here old text still
5182 * needs to be copied to the new text.
5183 * matchcol Column number of the old text where to look
5184 * for the next match. It's just after the
5185 * previous match or one further.
5186 * prev_matchcol Column just after the previous match (if any).
5187 * Mostly equal to matchcol, except for the first
5188 * match and after skipping an empty match.
5189 * regmatch.*pos Where the pattern matched in the old text.
5190 * new_start The new text, all that has been produced so
5191 * far.
5192 * new_end The new text, where to append new text.
5193 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005194 * lnum The line number where we found the start of
5195 * the match. Can be below the line we searched
5196 * when there is a \n before a \zs in the
5197 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 * sub_firstlnum The line number in the buffer where to look
5199 * for a match. Can be different from "lnum"
5200 * when the pattern or substitute string contains
5201 * line breaks.
5202 *
5203 * Special situations:
5204 * - When the substitute string contains a line break, the part up
5205 * to the line break is inserted in the text, but the copy of
5206 * the original line is kept. "sub_firstlnum" is adjusted for
5207 * the inserted lines.
5208 * - When the matched pattern contains a line break, the old line
5209 * is taken from the line at the end of the pattern. The lines
5210 * in the match are deleted later, "sub_firstlnum" is adjusted
5211 * accordingly.
5212 *
5213 * The new text is built up in new_start[]. It has some extra
5214 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005215 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 *
5217 * Make a copy of the old line, so it won't be taken away when
5218 * updating the screen or handling a multi-line match. The "old_"
5219 * pointers point into this copy.
5220 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005221 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 copycol = 0;
5223 matchcol = 0;
5224
5225 /* At first match, remember current cursor position. */
5226 if (!got_match)
5227 {
5228 setpcmark();
5229 got_match = TRUE;
5230 }
5231
5232 /*
5233 * Loop until nothing more to replace in this line.
5234 * 1. Handle match with empty string.
5235 * 2. If do_ask is set, ask for confirmation.
5236 * 3. substitute the string.
5237 * 4. if do_all is set, find next match
5238 * 5. break if there isn't another match in this line
5239 */
5240 for (;;)
5241 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005242 /* Advance "lnum" to the line where the match starts. The
5243 * match does not start in the first line when there is a line
5244 * break before \zs. */
5245 if (regmatch.startpos[0].lnum > 0)
5246 {
5247 lnum += regmatch.startpos[0].lnum;
5248 sub_firstlnum += regmatch.startpos[0].lnum;
5249 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005250 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005251 }
5252
5253 if (sub_firstline == NULL)
5254 {
5255 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5256 if (sub_firstline == NULL)
5257 {
5258 vim_free(new_start);
5259 goto outofmem;
5260 }
5261 }
5262
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 /* Save the line number of the last change for the final
5264 * cursor position (just like Vi). */
5265 curwin->w_cursor.lnum = lnum;
5266 do_again = FALSE;
5267
5268 /*
5269 * 1. Match empty string does not count, except for first
5270 * match. This reproduces the strange vi behaviour.
5271 * This also catches endless loops.
5272 */
5273 if (matchcol == prev_matchcol
5274 && regmatch.endpos[0].lnum == 0
5275 && matchcol == regmatch.endpos[0].col)
5276 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005277 if (sub_firstline[matchcol] == NUL)
5278 /* We already were at the end of the line. Don't look
5279 * for a match in this line again. */
5280 skip_match = TRUE;
5281 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005282 {
5283 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02005284 if (has_mbyte)
5285 matchcol += mb_ptr2len(sub_firstline + matchcol);
5286 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005287 ++matchcol;
5288 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 goto skip;
5290 }
5291
5292 /* Normally we continue searching for a match just after the
5293 * previous match. */
5294 matchcol = regmatch.endpos[0].col;
5295 prev_matchcol = matchcol;
5296
5297 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005298 * 2. If do_count is set only increase the counter.
5299 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005301 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005302 {
5303 /* For a multi-line match, put matchcol at the NUL at
5304 * the end of the line and set nmatch to one, so that
5305 * we continue looking for a match on the next line.
5306 * Avoids that ":s/\nB\@=//gc" get stuck. */
5307 if (nmatch > 1)
5308 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005309 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005310 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005311 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005312 }
5313 sub_nsubs++;
5314 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005315#ifdef FEAT_EVAL
5316 /* Skip the substitution, unless an expression is used,
5317 * then it is evaluated in the sandbox. */
5318 if (!(sub[0] == '\\' && sub[1] == '='))
5319#endif
5320 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005321 }
5322
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005323 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005325 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005326
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 /* change State to CONFIRM, so that the mouse works
5328 * properly */
5329 save_State = State;
5330 State = CONFIRM;
5331#ifdef FEAT_MOUSE
5332 setmouse(); /* disable mouse in xterm */
5333#endif
5334 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005335 if (curwin->w_p_crb)
5336 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337
5338 /* When 'cpoptions' contains "u" don't sync undo when
5339 * asking for confirmation. */
5340 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5341 ++no_u_sync;
5342
5343 /*
5344 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5345 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005346 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005348 if (exmode_active)
5349 {
5350 char_u *resp;
5351 colnr_T sc, ec;
5352
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005353 print_line_no_prefix(lnum,
5354 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005355
5356 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5357 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005358 if (curwin->w_cursor.col < 0)
5359 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005360 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005361 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005362 {
5363 int numw = number_width(curwin) + 1;
5364 sc += numw;
5365 ec += numw;
5366 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005367 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005368 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005369 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005370 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005371 msg_putchar('^');
5372
5373 resp = getexmodeline('?', NULL, 0);
5374 if (resp != NULL)
5375 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005376 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005377 vim_free(resp);
5378 }
5379 }
5380 else
5381 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005382 char_u *orig_line = NULL;
5383 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005385 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005387 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005389 /* Invert the matched string.
5390 * Remove the inversion afterwards. */
5391 temp = RedrawingDisabled;
5392 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005394 if (new_start != NULL)
5395 {
5396 /* There already was a substitution, we would
5397 * like to show this to the user. We cannot
5398 * really update the line, it would change
5399 * what matches. Temporarily replace the line
5400 * and change it back afterwards. */
5401 orig_line = vim_strsave(ml_get(lnum));
5402 if (orig_line != NULL)
5403 {
5404 char_u *new_line = concat_str(new_start,
5405 sub_firstline + copycol);
5406
5407 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005408 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005409 else
5410 {
5411 /* Position the cursor relative to the
5412 * end of the line, the previous
5413 * substitute may have inserted or
5414 * deleted characters before the
5415 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005416 len_change = (int)STRLEN(new_line)
5417 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005418 curwin->w_cursor.col += len_change;
5419 ml_replace(lnum, new_line, FALSE);
5420 }
5421 }
5422 }
5423
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005424 search_match_lines = regmatch.endpos[0].lnum
5425 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005426 search_match_endcol = regmatch.endpos[0].col
5427 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005428 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005430 update_topline();
5431 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005432 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005433 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005434 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435
5436#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005437 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005439 if (msg_row == Rows - 1)
5440 msg_didout = FALSE; /* avoid a scroll-up */
5441 msg_starthere();
5442 i = msg_scroll;
5443 msg_scroll = 0; /* truncate msg when
5444 needed */
5445 msg_no_more = TRUE;
5446 /* write message same highlighting as for
5447 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005448 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005449 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005450 msg_no_more = FALSE;
5451 msg_scroll = i;
5452 showruler(TRUE);
5453 windgoto(msg_row, msg_col);
5454 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
5456#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005457 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005459 ++no_mapping; /* don't map this key */
5460 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005461 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005462 --allow_keys;
5463 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005465 /* clear the question */
5466 msg_didout = FALSE; /* don't scroll up */
5467 msg_col = 0;
5468 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005469
5470 /* restore the line */
5471 if (orig_line != NULL)
5472 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005473 }
5474
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005476 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005478 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479#endif
5480 )
5481 {
5482 got_quit = TRUE;
5483 break;
5484 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005485 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005487 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005489 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 {
5491 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005492 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 line2 = lnum;
5494 break;
5495 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005496 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005498 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 break;
5500 }
5501#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005502 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005504 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 scrolldown_clamp();
5506#endif
5507 }
5508 State = save_State;
5509#ifdef FEAT_MOUSE
5510 setmouse();
5511#endif
5512 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5513 --no_u_sync;
5514
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005515 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 {
5517 /* For a multi-line match, put matchcol at the NUL at
5518 * the end of the line and set nmatch to one, so that
5519 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005520 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5521 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 if (nmatch > 1)
5523 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005524 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005525 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 }
5527 goto skip;
5528 }
5529 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005530 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 }
5532
5533 /* Move the cursor to the start of the match, so that we can
5534 * use "\=col("."). */
5535 curwin->w_cursor.col = regmatch.startpos[0].col;
5536
5537 /*
5538 * 3. substitute the string.
5539 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005540#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005541 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005542 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005543 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005544 save_ma = curbuf->b_p_ma;
5545 curbuf->b_p_ma = FALSE;
5546 sandbox++;
5547 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005548 /* Save flags for recursion. They can change for e.g.
5549 * :s/^/\=execute("s#^##gn") */
5550 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005551#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005553 sublen = vim_regsub_multi(&regmatch,
5554 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005556#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005557 /* Don't keep flags set by a recursive call. */
5558 subflags = subflags_save;
5559 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005560 {
5561 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005562 if (sandbox > 0)
5563 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005564 goto skip;
5565 }
5566#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567
Bram Moolenaar4463f292005-09-25 22:20:24 +00005568 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005569 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005570 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5571 {
5572 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5573 skip_match = TRUE;
5574 }
5575
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 /* Need room for:
5577 * - result so far in new_start (not for first sub in line)
5578 * - original text up to match
5579 * - length of substituted part
5580 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005581 * Adjust text properties here, since we have all information
5582 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 */
5584 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005585 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005587#ifdef FEAT_TEXT_PROP
5588 if (curbuf->b_has_textprop)
5589 adjust_prop_columns(lnum, regmatch.startpos[0].col,
5590 sublen - 1 - (regmatch.endpos[0].col
5591 - regmatch.startpos[0].col));
5592#endif
5593 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 else
5595 {
5596 p1 = ml_get(sub_firstlnum + nmatch - 1);
5597 nmatch_tl += nmatch - 1;
5598 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005599 copy_len = regmatch.startpos[0].col - copycol;
5600 needed_len = copy_len + ((unsigned)STRLEN(p1)
5601 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 if (new_start == NULL)
5603 {
5604 /*
5605 * Get some space for a temporary buffer to do the
5606 * substitution into (and some extra space to avoid
5607 * too many calls to alloc()/free()).
5608 */
5609 new_start_len = needed_len + 50;
5610 if ((new_start = alloc_check(new_start_len)) == NULL)
5611 goto outofmem;
5612 *new_start = NUL;
5613 new_end = new_start;
5614 }
5615 else
5616 {
5617 /*
5618 * Check if the temporary buffer is long enough to do the
5619 * substitution into. If not, make it larger (with a bit
5620 * extra to avoid too many calls to alloc()/free()).
5621 */
5622 len = (unsigned)STRLEN(new_start);
5623 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005624 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 {
5626 new_start_len = needed_len + 50;
5627 if ((p1 = alloc_check(new_start_len)) == NULL)
5628 {
5629 vim_free(new_start);
5630 goto outofmem;
5631 }
5632 mch_memmove(p1, new_start, (size_t)(len + 1));
5633 vim_free(new_start);
5634 new_start = p1;
5635 }
5636 new_end = new_start + len;
5637 }
5638
5639 /*
5640 * copy the text up to the part that matched
5641 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005642 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5643 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005645 (void)vim_regsub_multi(&regmatch,
5646 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 sub, new_end, TRUE, p_magic, TRUE);
5648 sub_nsubs++;
5649 did_sub = TRUE;
5650
5651 /* Move the cursor to the start of the line, to avoid that it
5652 * is beyond the end of the line after the substitution. */
5653 curwin->w_cursor.col = 0;
5654
5655 /* For a multi-line match, make a copy of the last matched
5656 * line and continue in that one. */
5657 if (nmatch > 1)
5658 {
5659 sub_firstlnum += nmatch - 1;
5660 vim_free(sub_firstline);
5661 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5662 /* When going beyond the last line, stop substituting. */
5663 if (sub_firstlnum <= line2)
5664 do_again = TRUE;
5665 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005666 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 }
5668
5669 /* Remember next character to be copied. */
5670 copycol = regmatch.endpos[0].col;
5671
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005672 if (skip_match)
5673 {
5674 /* Already hit end of the buffer, sub_firstlnum is one
5675 * less than what it ought to be. */
5676 vim_free(sub_firstline);
5677 sub_firstline = vim_strsave((char_u *)"");
5678 copycol = 0;
5679 }
5680
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 /*
5682 * Now the trick is to replace CTRL-M chars with a real line
5683 * break. This would make it impossible to insert a CTRL-M in
5684 * the text. The line break can be avoided by preceding the
5685 * CTRL-M with a backslash. To be able to insert a backslash,
5686 * they must be doubled in the string and are halved here.
5687 * That is Vi compatible.
5688 */
5689 for (p1 = new_end; *p1; ++p1)
5690 {
5691 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005692 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 else if (*p1 == CAR)
5694 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005695 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005697 colnr_T plen = (colnr_T)(p1 - new_start + 1);
5698
5699 *p1 = NUL; // truncate up to the CR
5700 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005702 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 appended_lines(lnum - 1, 1L);
5704 else
5705 {
5706 if (first_line == 0)
5707 first_line = lnum;
5708 last_line = lnum + 1;
5709 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005710#ifdef FEAT_TEXT_PROP
5711 adjust_props_for_split(lnum, plen, 1);
5712#endif
5713 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 ++sub_firstlnum;
5715 ++lnum;
5716 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005717 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005719 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005720 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 p1 = new_start - 1;
5722 }
5723 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005725 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 }
5727
5728 /*
5729 * 4. If do_all is set, find next match.
5730 * Prevent endless loop with patterns that match empty
5731 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5732 * But ":s/\n/#/" is OK.
5733 */
5734skip:
5735 /* We already know that we did the last subst when we are at
5736 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005737 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5738 * "line2" when there is a \zs in the pattern after a line
5739 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005740 lastone = (skip_match
5741 || got_int
5742 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005743 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005744 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005745 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5746 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 nmatch = -1;
5748
5749 /*
5750 * Replace the line in the buffer when needed. This is
5751 * skipped when there are more matches.
5752 * The check for nmatch_tl is needed for when multi-line
5753 * matching must replace the lines before trying to do another
5754 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005755 * When the match starts below where we start searching also
5756 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 */
5758 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 || nmatch_tl > 0
5760 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005761 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005762 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005763 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 {
5765 if (new_start != NULL)
5766 {
5767 /*
5768 * Copy the rest of the line, that didn't match.
5769 * "matchcol" has to be adjusted, we use the end of
5770 * the line as reference, because the substitute may
5771 * have changed the number of characters. Same for
5772 * "prev_matchcol".
5773 */
5774 STRCAT(new_start, sub_firstline + copycol);
5775 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5776 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5777 - prev_matchcol;
5778
5779 if (u_savesub(lnum) != OK)
5780 break;
5781 ml_replace(lnum, new_start, TRUE);
5782
5783 if (nmatch_tl > 0)
5784 {
5785 /*
5786 * Matched lines have now been substituted and are
5787 * useless, delete them. The part after the match
5788 * has been appended to new_start, we don't need
5789 * it in the buffer.
5790 */
5791 ++lnum;
5792 if (u_savedel(lnum, nmatch_tl) != OK)
5793 break;
5794 for (i = 0; i < nmatch_tl; ++i)
5795 ml_delete(lnum, (int)FALSE);
5796 mark_adjust(lnum, lnum + nmatch_tl - 1,
5797 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005798 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 deleted_lines(lnum, nmatch_tl);
5800 --lnum;
5801 line2 -= nmatch_tl; /* nr of lines decreases */
5802 nmatch_tl = 0;
5803 }
5804
5805 /* When asking, undo is saved each time, must also set
5806 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005807 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 changed_bytes(lnum, 0);
5809 else
5810 {
5811 if (first_line == 0)
5812 first_line = lnum;
5813 last_line = lnum + 1;
5814 }
5815
5816 sub_firstlnum = lnum;
5817 vim_free(sub_firstline); /* free the temp buffer */
5818 sub_firstline = new_start;
5819 new_start = NULL;
5820 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5821 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5822 - prev_matchcol;
5823 copycol = 0;
5824 }
5825 if (nmatch == -1 && !lastone)
5826 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005827 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828
5829 /*
5830 * 5. break if there isn't another match in this line
5831 */
5832 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005833 {
5834 /* If the match found didn't start where we were
5835 * searching, do the next search in the line where we
5836 * found the match. */
5837 if (nmatch == -1)
5838 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005840 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 }
5842
5843 line_breakcheck();
5844 }
5845
5846 if (did_sub)
5847 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005848 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005849 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 }
5851
5852 line_breakcheck();
5853 }
5854
5855 if (first_line != 0)
5856 {
5857 /* Need to subtract the number of added lines from "last_line" to get
5858 * the line number before the change (same as adding the number of
5859 * deleted lines). */
5860 i = curbuf->b_ml.ml_line_count - old_line_count;
5861 changed_lines(first_line, 0, last_line - i, i);
5862 }
5863
5864outofmem:
5865 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005866
5867 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005868 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005869 curwin->w_cursor = old_cursor;
5870
Bram Moolenaar46475522010-03-23 17:36:29 +01005871 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 {
5873 /* Set the '[ and '] marks. */
5874 curbuf->b_op_start.lnum = eap->line1;
5875 curbuf->b_op_end.lnum = line2;
5876 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5877
5878 if (!global_busy)
5879 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005880 /* when interactive leave cursor on the match */
5881 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005882 {
5883 if (endcolumn)
5884 coladvance((colnr_T)MAXCOL);
5885 else
5886 beginline(BL_WHITE | BL_FIX);
5887 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005888 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005889 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 }
5891 else
5892 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005893 if (subflags.do_print)
5894 print_line(curwin->w_cursor.lnum,
5895 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 }
5897 else if (!global_busy)
5898 {
5899 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005900 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005902 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005903 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005904 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 }
5906
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005907#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005908 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005909 /* Cursor position may require updating */
5910 changed_window_setting();
5911#endif
5912
Bram Moolenaar473de612013-06-08 18:19:48 +02005913 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005914
5915 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005916 subflags.do_all = save_do_all;
5917 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918}
5919
5920/*
5921 * Give message for number of substitutions.
5922 * Can also be used after a ":global" command.
5923 * Return TRUE if a message was given.
5924 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005925 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005926do_sub_msg(
5927 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928{
5929 /*
5930 * Only report substitutions when:
5931 * - more than 'report' substitutions
5932 * - command was typed by user, or number of changed lines > 'report'
5933 * - giving messages is not disabled by 'lazyredraw'
5934 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005935 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5936 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 && messaging())
5938 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005939 char *msg_single;
5940 char *msg_plural;
5941
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 if (got_int)
5943 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005944 else
5945 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005946
5947 msg_single = count_only
5948 ? NGETTEXT("%ld match on %ld line",
5949 "%ld matches on %ld line", sub_nsubs)
5950 : NGETTEXT("%ld substitution on %ld line",
5951 "%ld substitutions on %ld line", sub_nsubs);
5952 msg_plural = count_only
5953 ? NGETTEXT("%ld match on %ld lines",
5954 "%ld matches on %ld lines", sub_nsubs)
5955 : NGETTEXT("%ld substitution on %ld lines",
5956 "%ld substitutions on %ld lines", sub_nsubs);
5957
Bram Moolenaar32526b32019-01-19 17:43:09 +01005958 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005959 NGETTEXT(msg_single, msg_plural, sub_nlines),
5960 sub_nsubs, (long)sub_nlines);
5961
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005964 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 return TRUE;
5966 }
5967 if (got_int)
5968 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005969 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 return TRUE;
5971 }
5972 return FALSE;
5973}
5974
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005975 static void
5976global_exe_one(char_u *cmd, linenr_T lnum)
5977{
5978 curwin->w_cursor.lnum = lnum;
5979 curwin->w_cursor.col = 0;
5980 if (*cmd == NUL || *cmd == '\n')
5981 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5982 else
5983 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5984}
5985
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986/*
5987 * Execute a global command of the form:
5988 *
5989 * g/pattern/X : execute X on all lines where pattern matches
5990 * v/pattern/X : execute X on all lines where pattern does not match
5991 *
5992 * where 'X' is an EX command
5993 *
5994 * The command character (as well as the trailing slash) is optional, and
5995 * is assumed to be 'p' if missing.
5996 *
5997 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005998 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 * for each line that has a mark. This is required because after deleting
6000 * lines we do not know where to search for the next match.
6001 */
6002 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006003ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004{
6005 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006006 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 int type; /* first char of cmd: 'v' or 'g' */
6008 char_u *cmd; /* command argument */
6009
6010 char_u delim; /* delimiter, normally '/' */
6011 char_u *pat;
6012 regmmatch_T regmatch;
6013 int match;
6014 int which_pat;
6015
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006016 /* When nesting the command works on one line. This allows for
6017 * ":g/found/v/notfound/command". */
6018 if (global_busy && (eap->line1 != 1
6019 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006021 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006022 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 return;
6024 }
6025
6026 if (eap->forceit) /* ":global!" is like ":vglobal" */
6027 type = 'v';
6028 else
6029 type = *eap->cmd;
6030 cmd = eap->arg;
6031 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032
6033 /*
6034 * undocumented vi feature:
6035 * "\/" and "\?": use previous search pattern.
6036 * "\&": use previous substitute pattern.
6037 */
6038 if (*cmd == '\\')
6039 {
6040 ++cmd;
6041 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
6042 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006043 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 return;
6045 }
6046 if (*cmd == '&')
6047 which_pat = RE_SUBST; /* use previous substitute pattern */
6048 else
6049 which_pat = RE_SEARCH; /* use previous search pattern */
6050 ++cmd;
6051 pat = (char_u *)"";
6052 }
6053 else if (*cmd == NUL)
6054 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006055 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 return;
6057 }
6058 else
6059 {
6060 delim = *cmd; /* get the delimiter */
6061 if (delim)
6062 ++cmd; /* skip delimiter if there is one */
6063 pat = cmd; /* remember start of pattern */
6064 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
6065 if (cmd[0] == delim) /* end delimiter found */
6066 *cmd++ = NUL; /* replace it with a NUL */
6067 }
6068
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6070 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006071 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 return;
6073 }
6074
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006075 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006077 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006078 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006079 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006081 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 }
6083 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006084 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006085 /*
6086 * pass 1: set marks for each (not) matching line
6087 */
6088 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6089 {
6090 /* a match on this line? */
6091 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006092 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006093 if ((type == 'g' && match) || (type == 'v' && !match))
6094 {
6095 ml_setmarked(lnum);
6096 ndone++;
6097 }
6098 line_breakcheck();
6099 }
6100
6101 /*
6102 * pass 2: execute the command for each line that has been marked
6103 */
6104 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006105 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006106 else if (ndone == 0)
6107 {
6108 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006109 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006110 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006111 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006112 }
6113 else
6114 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006115#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006116 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006117#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006118 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006119#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006120 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006121#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006122 }
6123
6124 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006125 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126
Bram Moolenaar473de612013-06-08 18:19:48 +02006127 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128}
6129
6130/*
6131 * Execute "cmd" on lines marked with ml_setmarked().
6132 */
6133 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006134global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006136 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6137 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6138 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139
6140 /*
6141 * Set current position only once for a global command.
6142 * If global_busy is set, setpcmark() will not do anything.
6143 * If there is an error, global_busy will be incremented.
6144 */
6145 setpcmark();
6146
6147 /* When the command writes a message, don't overwrite the command. */
6148 msg_didout = TRUE;
6149
Bram Moolenaard25bc232010-03-23 17:49:24 +01006150 sub_nsubs = 0;
6151 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 global_need_beginline = FALSE;
6153 global_busy = 1;
6154 old_lcount = curbuf->b_ml.ml_line_count;
6155 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6156 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006157 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 ui_breakcheck();
6159 }
6160
6161 global_busy = 0;
6162 if (global_need_beginline)
6163 beginline(BL_WHITE | BL_FIX);
6164 else
6165 check_cursor(); /* cursor may be beyond the end of the line */
6166
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006167 /* the cursor may not have moved in the text but a change in a previous
6168 * line may move it on the screen */
6169 changed_line_abv_curs();
6170
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 /* If it looks like no message was written, allow overwriting the
6172 * command with the report for number of changes. */
6173 if (msg_col == 0 && msg_scrolled == 0)
6174 msg_didout = FALSE;
6175
Bram Moolenaar45667512007-05-10 19:24:43 +00006176 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006177 * number of extra or deleted lines.
6178 * Don't report extra or deleted lines in the edge case where the buffer
6179 * we are in after execution is different from the buffer we started in. */
6180 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6182}
6183
6184#ifdef FEAT_VIMINFO
6185 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006186read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006188 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 vim_free(old_sub);
6190 if (force || old_sub == NULL)
6191 old_sub = viminfo_readstring(virp, 1, TRUE);
6192 return viminfo_readline(virp);
6193}
6194
6195 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006196write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197{
6198 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6199 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006200 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 viminfo_writestring(fp, old_sub);
6202 }
6203}
6204#endif /* FEAT_VIMINFO */
6205
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006206#if defined(EXITFREE) || defined(PROTO)
6207 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006208free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006209{
6210 vim_free(old_sub);
6211}
6212#endif
6213
Bram Moolenaar4033c552017-09-16 20:54:51 +02006214#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215/*
6216 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006217 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006219 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006220prepare_tagpreview(
6221 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222{
6223 win_T *wp;
6224
6225# ifdef FEAT_GUI
6226 need_mouse_correct = TRUE;
6227# endif
6228
6229 /*
6230 * If there is already a preview window open, use that one.
6231 */
6232 if (!curwin->w_p_pvw)
6233 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006234 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 if (wp->w_p_pvw)
6236 break;
6237 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006238 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 else
6240 {
6241 /*
6242 * There is no preview window open yet. Create one.
6243 */
6244 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6245 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006246 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 curwin->w_p_pvw = TRUE;
6248 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006249 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6250 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251# ifdef FEAT_DIFF
6252 curwin->w_p_diff = FALSE; /* no 'diff' */
6253# endif
6254# ifdef FEAT_FOLDING
6255 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6256# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006257 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 }
6259 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006260 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261}
6262
6263#endif
6264
6265
6266/*
6267 * ":help": open a read-only window on a help file
6268 */
6269 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006270ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271{
6272 char_u *arg;
6273 char_u *tag;
6274 FILE *helpfd; /* file descriptor of help file */
6275 int n;
6276 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 int num_matches;
6279 char_u **matches;
6280 char_u *p;
6281 int empty_fnum = 0;
6282 int alt_fnum = 0;
6283 buf_T *buf;
6284#ifdef FEAT_MULTI_LANG
6285 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006286 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006288#ifdef FEAT_FOLDING
6289 int old_KeyTyped = KeyTyped;
6290#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291
6292 if (eap != NULL)
6293 {
6294 /*
6295 * A ":help" command ends at the first LF, or at a '|' that is
6296 * followed by some text. Set nextcmd to the following command.
6297 */
6298 for (arg = eap->arg; *arg; ++arg)
6299 {
6300 if (*arg == '\n' || *arg == '\r'
6301 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6302 {
6303 *arg++ = NUL;
6304 eap->nextcmd = arg;
6305 break;
6306 }
6307 }
6308 arg = eap->arg;
6309
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006310 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006312 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 return;
6314 }
6315
6316 if (eap->skip) /* not executing commands */
6317 return;
6318 }
6319 else
6320 arg = (char_u *)"";
6321
6322 /* remove trailing blanks */
6323 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006324 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 *p-- = NUL;
6326
6327#ifdef FEAT_MULTI_LANG
6328 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006329 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330#endif
6331
6332 /* When no argument given go to the index. */
6333 if (*arg == NUL)
6334 arg = (char_u *)"help.txt";
6335
6336 /*
6337 * Check if there is a match for the argument.
6338 */
6339 n = find_help_tags(arg, &num_matches, &matches,
6340 eap != NULL && eap->forceit);
6341
6342 i = 0;
6343#ifdef FEAT_MULTI_LANG
6344 if (n != FAIL && lang != NULL)
6345 /* Find first item with the requested language. */
6346 for (i = 0; i < num_matches; ++i)
6347 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006348 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 if (len > 3 && matches[i][len - 3] == '@'
6350 && STRICMP(matches[i] + len - 2, lang) == 0)
6351 break;
6352 }
6353#endif
6354 if (i >= num_matches || n == FAIL)
6355 {
6356#ifdef FEAT_MULTI_LANG
6357 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006358 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 else
6360#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006361 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 if (n != FAIL)
6363 FreeWild(num_matches, matches);
6364 return;
6365 }
6366
6367 /* The first match (in the requested language) is the best match. */
6368 tag = vim_strsave(matches[i]);
6369 FreeWild(num_matches, matches);
6370
6371#ifdef FEAT_GUI
6372 need_mouse_correct = TRUE;
6373#endif
6374
6375 /*
6376 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006377 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006379 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006381 if (cmdmod.tab != 0)
6382 wp = NULL;
6383 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006384 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006385 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006386 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6388 win_enter(wp, TRUE);
6389 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 {
6391 /*
6392 * There is no help window yet.
6393 * Try to open the file specified by the "helpfile" option.
6394 */
6395 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6396 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006397 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 goto erret;
6399 }
6400 fclose(helpfd);
6401
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006403 * specified, the current window is vertically split and
6404 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006407 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006410 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 if (curwin->w_height < p_hh)
6413 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414
6415 /*
6416 * Open help file (do_ecmd() will set b_help flag, readfile() will
6417 * set b_p_ro flag).
6418 * Set the alternate file to the previously edited file.
6419 */
6420 alt_fnum = curbuf->b_fnum;
6421 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006422 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006423 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006424 if (!cmdmod.keepalt)
6425 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 empty_fnum = curbuf->b_fnum;
6427 }
6428 }
6429
6430 if (!p_im)
6431 restart_edit = 0; /* don't want insert mode in help file */
6432
Bram Moolenaar8f535582011-09-30 17:30:31 +02006433#ifdef FEAT_FOLDING
6434 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6435 * It is needed for do_tag top open folds under the cursor. */
6436 KeyTyped = old_KeyTyped;
6437#endif
6438
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 if (tag != NULL)
6440 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6441
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006442 /* Delete the empty buffer if we're not using it. Careful: autocommands
6443 * may have jumped to another window, check that the buffer is not in a
6444 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6446 {
6447 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006448 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 wipe_buffer(buf, TRUE);
6450 }
6451
6452 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006453 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 curwin->w_alt_fnum = alt_fnum;
6455
6456erret:
6457 vim_free(tag);
6458}
6459
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006460/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006461 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006462 */
6463 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006464ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006465{
6466 win_T *win;
6467
6468 FOR_ALL_WINDOWS(win)
6469 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006470 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006471 {
6472 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006473 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006474 }
6475 }
6476}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006478#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6479/*
6480 * In an argument search for a language specifiers in the form "@xx".
6481 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6482 * Returns NULL if not found.
6483 */
6484 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006485check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006486{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006487 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006488
6489 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6490 && ASCII_ISALPHA(arg[len - 1]))
6491 {
6492 arg[len - 3] = NUL; /* remove the '@' */
6493 return arg + len - 2;
6494 }
6495 return NULL;
6496}
6497#endif
6498
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499/*
6500 * Return a heuristic indicating how well the given string matches. The
6501 * smaller the number, the better the match. This is the order of priorities,
6502 * from best match to worst match:
6503 * - Match with least alpha-numeric characters is better.
6504 * - Match with least total characters is better.
6505 * - Match towards the start is better.
6506 * - Match starting with "+" is worse (feature instead of command)
6507 * Assumption is made that the matched_string passed has already been found to
6508 * match some string for which help is requested. webb.
6509 */
6510 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006511help_heuristic(
6512 char_u *matched_string,
6513 int offset, /* offset for match */
6514 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515{
6516 int num_letters;
6517 char_u *p;
6518
6519 num_letters = 0;
6520 for (p = matched_string; *p; p++)
6521 if (ASCII_ISALNUM(*p))
6522 num_letters++;
6523
6524 /*
6525 * Multiply the number of letters by 100 to give it a much bigger
6526 * weighting than the number of characters.
6527 * If there only is a match while ignoring case, add 5000.
6528 * If the match starts in the middle of a word, add 10000 to put it
6529 * somewhere in the last half.
6530 * If the match is more than 2 chars from the start, multiply by 200 to
6531 * put it after matches at the start.
6532 */
6533 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6534 && ASCII_ISALNUM(matched_string[offset - 1]))
6535 offset += 10000;
6536 else if (offset > 2)
6537 offset *= 200;
6538 if (wrong_case)
6539 offset += 5000;
6540 /* Features are less interesting than the subjects themselves, but "+"
6541 * alone is not a feature. */
6542 if (matched_string[0] == '+' && matched_string[1] != NUL)
6543 offset += 100;
6544 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6545}
6546
6547/*
6548 * Compare functions for qsort() below, that checks the help heuristics number
6549 * that has been put after the tagname by find_tags().
6550 */
6551 static int
6552#ifdef __BORLANDC__
6553_RTLENTRYF
6554#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006555help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556{
6557 char *p1;
6558 char *p2;
6559
6560 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6561 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6562 return strcmp(p1, p2);
6563}
6564
6565/*
6566 * Find all help tags matching "arg", sort them and return in matches[], with
6567 * the number of matches in num_matches.
6568 * The matches will be sorted with a "best" match algorithm.
6569 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6570 */
6571 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006572find_help_tags(
6573 char_u *arg,
6574 int *num_matches,
6575 char_u ***matches,
6576 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577{
6578 char_u *s, *d;
6579 int i;
6580 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006581 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006582 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006583 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6584 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006585 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006586 "[count]", "[quotex]",
6587 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006588 "[pattern]", "\\|", "\\%$",
6589 "s/\\~", "s/\\U", "s/\\L",
6590 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006592 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006593 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006594 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6595 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006596 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006597 "\\[count]", "\\[quotex]",
6598 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006599 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006600 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006601 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006602 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
6603 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 int flags;
6605
6606 d = IObuff; /* assume IObuff is long enough! */
6607
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006608 if (STRNICMP(arg, "expr-", 5) == 0)
6609 {
6610 // When the string starting with "expr-" and containing '?' and matches
6611 // the table, it is taken literally. Otherwise '?' is recognized as a
6612 // wildcard.
6613 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
6614 if (STRCMP(arg + 5, expr_table[i]) == 0)
6615 {
6616 STRCPY(d, arg);
6617 break;
6618 }
6619 }
6620 else
6621 {
6622 // Recognize a few exceptions to the rule. Some strings that contain
6623 // '*' with "star". Otherwise '*' is recognized as a wildcard.
6624 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
6625 if (STRCMP(arg, mtable[i]) == 0)
6626 {
6627 STRCPY(d, rtable[i]);
6628 break;
6629 }
6630 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631
6632 if (i < 0) /* no match in table */
6633 {
6634 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6635 * Also replace "\%^" and "\%(", they match every tag too.
6636 * Also "\zs", "\z1", etc.
6637 * Also "\@<", "\@=", "\@<=", etc.
6638 * And also "\_$" and "\_^". */
6639 if (arg[0] == '\\'
6640 && ((arg[1] != NUL && arg[2] == NUL)
6641 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6642 && arg[2] != NUL)))
6643 {
6644 STRCPY(d, "/\\\\");
6645 STRCPY(d + 3, arg + 1);
6646 /* Check for "/\\_$", should be "/\\_\$" */
6647 if (d[3] == '_' && d[4] == '$')
6648 STRCPY(d + 4, "\\$");
6649 }
6650 else
6651 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006652 /* Replace:
6653 * "[:...:]" with "\[:...:]"
6654 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006655 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006656 */
6657 if ((arg[0] == '[' && (arg[1] == ':'
6658 || (arg[1] == '+' && arg[2] == '+')))
6659 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 *d++ = '\\';
6661
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006662 /*
6663 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6664 */
6665 if (*arg == '(' && arg[1] == '\'')
6666 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 for (s = arg; *s; ++s)
6668 {
6669 /*
6670 * Replace "|" with "bar" and '"' with "quote" to match the name of
6671 * the tags for these commands.
6672 * Replace "*" with ".*" and "?" with "." to match command line
6673 * completion.
6674 * Insert a backslash before '~', '$' and '.' to avoid their
6675 * special meaning.
6676 */
6677 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6678 break;
6679 switch (*s)
6680 {
6681 case '|': STRCPY(d, "bar");
6682 d += 3;
6683 continue;
6684 case '"': STRCPY(d, "quote");
6685 d += 5;
6686 continue;
6687 case '*': *d++ = '.';
6688 break;
6689 case '?': *d++ = '.';
6690 continue;
6691 case '$':
6692 case '.':
6693 case '~': *d++ = '\\';
6694 break;
6695 }
6696
6697 /*
6698 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6699 * ":help i_^_CTRL-D" work.
6700 * Insert '-' before and after "CTRL-X" when applicable.
6701 */
6702 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6703 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6704 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006705 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6706 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 STRCPY(d, "CTRL-");
6708 d += 5;
6709 if (*s < ' ')
6710 {
6711#ifdef EBCDIC
6712 *d++ = CtrlChar(*s);
6713#else
6714 *d++ = *s + '@';
6715#endif
6716 if (d[-1] == '\\')
6717 *d++ = '\\'; /* double a backslash */
6718 }
6719 else
6720 *d++ = *++s;
6721 if (s[1] != NUL && s[1] != '_')
6722 *d++ = '_'; /* append a '_' */
6723 continue;
6724 }
6725 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6726 *d++ = '\\';
6727
6728 /*
6729 * Insert a backslash before a backslash after a slash, for search
6730 * pattern tags: "/\|" --> "/\\|".
6731 */
6732 else if (s[0] == '\\' && s[1] != '\\'
6733 && *arg == '/' && s == arg + 1)
6734 *d++ = '\\';
6735
6736 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6737 * "CTRL-\_CTRL-N" */
6738 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6739 {
6740 STRCPY(d, "CTRL-\\\\");
6741 d += 7;
6742 s += 6;
6743 }
6744
6745 *d++ = *s;
6746
6747 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006748 * If tag contains "({" or "([", tag terminates at the "(".
6749 * This is for help on functions, e.g.: abs({expr}).
6750 */
6751 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6752 break;
6753
6754 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 * If tag starts with ', toss everything after a second '. Fixes
6756 * CTRL-] on 'option'. (would include the trailing '.').
6757 */
6758 if (*s == '\'' && s > arg && *arg == '\'')
6759 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006760 /* Also '{' and '}'. */
6761 if (*s == '}' && s > arg && *arg == '{')
6762 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 }
6764 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006765
6766 if (*IObuff == '`')
6767 {
6768 if (d > IObuff + 2 && d[-1] == '`')
6769 {
6770 /* remove the backticks from `command` */
6771 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6772 d[-2] = NUL;
6773 }
6774 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6775 {
6776 /* remove the backticks and comma from `command`, */
6777 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6778 d[-3] = NUL;
6779 }
6780 else if (d > IObuff + 4 && d[-3] == '`'
6781 && d[-2] == '\\' && d[-1] == '.')
6782 {
6783 /* remove the backticks and dot from `command`\. */
6784 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6785 d[-4] = NUL;
6786 }
6787 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 }
6789 }
6790
6791 *matches = (char_u **)"";
6792 *num_matches = 0;
6793 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6794 if (keep_lang)
6795 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006796 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006798 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 /* Sort the matches found on the heuristic number that is after the
6800 * tag name. */
6801 qsort((void *)*matches, (size_t)*num_matches,
6802 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006803 /* Delete more than TAG_MANY to reduce the size of the listing. */
6804 while (*num_matches > TAG_MANY)
6805 vim_free((*matches)[--*num_matches]);
6806 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 return OK;
6808}
6809
6810/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006811 * Called when starting to edit a buffer for a help file.
6812 */
6813 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006814prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006815{
6816 char_u *p;
6817
6818 curbuf->b_help = TRUE;
6819#ifdef FEAT_QUICKFIX
6820 set_string_option_direct((char_u *)"buftype", -1,
6821 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6822#endif
6823
6824 /*
6825 * Always set these options after jumping to a help tag, because the
6826 * user may have an autocommand that gets in the way.
6827 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6828 * latin1 word characters (for translated help files).
6829 * Only set it when needed, buf_init_chartab() is some work.
6830 */
6831 p =
6832#ifdef EBCDIC
6833 (char_u *)"65-255,^*,^|,^\"";
6834#else
6835 (char_u *)"!-~,^*,^|,^\",192-255";
6836#endif
6837 if (STRCMP(curbuf->b_p_isk, p) != 0)
6838 {
6839 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6840 check_buf_options(curbuf);
6841 (void)buf_init_chartab(curbuf, FALSE);
6842 }
6843
Bram Moolenaar0b105412014-11-30 13:34:23 +01006844#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006845 /* Don't use the global foldmethod.*/
6846 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6847 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006848#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006849
6850 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6851 curwin->w_p_list = FALSE; /* no list mode */
6852
6853 curbuf->b_p_ma = FALSE; /* not modifiable */
6854 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6855 curwin->w_p_nu = 0; /* no line numbers */
6856 curwin->w_p_rnu = 0; /* no relative line numbers */
6857 RESET_BINDING(curwin); /* no scroll or cursor binding */
6858#ifdef FEAT_ARABIC
6859 curwin->w_p_arab = FALSE; /* no arabic mode */
6860#endif
6861#ifdef FEAT_RIGHTLEFT
6862 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6863#endif
6864#ifdef FEAT_FOLDING
6865 curwin->w_p_fen = FALSE; /* No folding in the help window */
6866#endif
6867#ifdef FEAT_DIFF
6868 curwin->w_p_diff = FALSE; /* No 'diff' */
6869#endif
6870#ifdef FEAT_SPELL
6871 curwin->w_p_spell = FALSE; /* No spell checking */
6872#endif
6873
6874 set_buflisted(FALSE);
6875}
6876
6877/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 * After reading a help file: May cleanup a help buffer when syntax
6879 * highlighting is not used.
6880 */
6881 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006882fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883{
6884 linenr_T lnum;
6885 char_u *line;
6886 int in_example = FALSE;
6887 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006888 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 char_u *p;
6890 char_u *rt;
6891 int mustfree;
6892
Bram Moolenaar90492982017-06-22 14:16:31 +02006893 /* Set filetype to "help" if still needed. */
6894 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006895 {
6896 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006897 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006898 --curbuf_lock;
6899 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900
6901#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006902 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903#endif
6904 {
6905 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6906 {
6907 line = ml_get_buf(curbuf, lnum, FALSE);
6908 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006909 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 {
6911 /* End of example: non-white or '<' in first column. */
6912 if (line[0] == '<')
6913 {
6914 /* blank-out a '<' in the first column */
6915 line = ml_get_buf(curbuf, lnum, TRUE);
6916 line[0] = ' ';
6917 }
6918 in_example = FALSE;
6919 }
6920 if (!in_example && len > 0)
6921 {
6922 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6923 {
6924 /* blank-out a '>' in the last column (start of example) */
6925 line = ml_get_buf(curbuf, lnum, TRUE);
6926 line[len - 1] = ' ';
6927 in_example = TRUE;
6928 }
6929 else if (line[len - 1] == '~')
6930 {
6931 /* blank-out a '~' at the end of line (header marker) */
6932 line = ml_get_buf(curbuf, lnum, TRUE);
6933 line[len - 1] = ' ';
6934 }
6935 }
6936 }
6937 }
6938
6939 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006940 * In the "help.txt" and "help.abx" file, add the locally added help
6941 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006943 fname = gettail(curbuf->b_fname);
6944 if (fnamecmp(fname, "help.txt") == 0
6945#ifdef FEAT_MULTI_LANG
6946 || (fnamencmp(fname, "help.", 5) == 0
6947 && ASCII_ISALPHA(fname[5])
6948 && ASCII_ISALPHA(fname[6])
6949 && TOLOWER_ASC(fname[7]) == 'x'
6950 && fname[8] == NUL)
6951#endif
6952 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 {
6954 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6955 {
6956 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006957 if (strstr((char *)line, "*local-additions*") == NULL)
6958 continue;
6959
6960 /* Go through all directories in 'runtimepath', skipping
6961 * $VIMRUNTIME. */
6962 p = p_rtp;
6963 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006965 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6966 mustfree = FALSE;
6967 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006968 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006970 int fcount;
6971 char_u **fnames;
6972 FILE *fd;
6973 char_u *s;
6974 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006975 vimconv_T vc;
6976 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006978 /* Find all "doc/ *.txt" files in this directory. */
6979 add_pathsep(NameBuff);
6980#ifdef FEAT_MULTI_LANG
6981 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006983 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006985 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6986 &fnames, EW_FILE|EW_SILENT) == OK
6987 && fcount > 0)
6988 {
6989#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01006990 int i1, i2;
6991 char_u *f1, *f2;
6992 char_u *t1, *t2;
6993 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006994
6995 /* If foo.abx is found use it instead of foo.txt in
6996 * the same directory. */
6997 for (i1 = 0; i1 < fcount; ++i1)
6998 {
6999 for (i2 = 0; i2 < fcount; ++i2)
7000 {
7001 if (i1 == i2)
7002 continue;
7003 if (fnames[i1] == NULL || fnames[i2] == NULL)
7004 continue;
7005 f1 = fnames[i1];
7006 f2 = fnames[i2];
7007 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007008 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007009 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007010 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02007011 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007012 continue;
7013 if (fnamecmp(e1, ".txt") != 0
7014 && fnamecmp(e1, fname + 4) != 0)
7015 {
7016 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007017 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007018 continue;
7019 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007020 if (e1 - f1 != e2 - f2
7021 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007022 continue;
7023 if (fnamecmp(e1, ".txt") == 0
7024 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007025 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007026 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007029#endif
7030 for (fi = 0; fi < fcount; ++fi)
7031 {
7032 if (fnames[fi] == NULL)
7033 continue;
7034 fd = mch_fopen((char *)fnames[fi], "r");
7035 if (fd != NULL)
7036 {
7037 vim_fgets(IObuff, IOSIZE, fd);
7038 if (IObuff[0] == '*'
7039 && (s = vim_strchr(IObuff + 1, '*'))
7040 != NULL)
7041 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007042 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01007043
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007044 /* Change tag definition to a
7045 * reference and remove <CR>/<NL>. */
7046 IObuff[0] = '|';
7047 *s = '|';
7048 while (*s != NUL)
7049 {
7050 if (*s == '\r' || *s == '\n')
7051 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007052 /* The text is utf-8 when a byte
7053 * above 127 is found and no
7054 * illegal byte sequence is found.
7055 */
7056 if (*s >= 0x80 && this_utf != FALSE)
7057 {
7058 int l;
7059
7060 this_utf = TRUE;
7061 l = utf_ptr2len(s);
7062 if (l == 1)
7063 this_utf = FALSE;
7064 s += l - 1;
7065 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007066 ++s;
7067 }
Bram Moolenaar13505972019-01-24 15:04:48 +01007068
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007069 /* The help file is latin1 or utf-8;
7070 * conversion to the current
7071 * 'encoding' may be required. */
7072 vc.vc_type = CONV_NONE;
7073 convert_setup(&vc, (char_u *)(
7074 this_utf == TRUE ? "utf-8"
7075 : "latin1"), p_enc);
7076 if (vc.vc_type == CONV_NONE)
7077 /* No conversion needed. */
7078 cp = IObuff;
7079 else
7080 {
7081 /* Do the conversion. If it fails
7082 * use the unconverted text. */
7083 cp = string_convert(&vc, IObuff,
7084 NULL);
7085 if (cp == NULL)
7086 cp = IObuff;
7087 }
7088 convert_setup(&vc, NULL, NULL);
7089
7090 ml_append(lnum, cp, (colnr_T)0, FALSE);
7091 if (cp != IObuff)
7092 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007093 ++lnum;
7094 }
7095 fclose(fd);
7096 }
7097 }
7098 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007101 if (mustfree)
7102 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007104 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 }
7106 }
7107}
7108
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007109/*
7110 * ":exusage"
7111 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007112 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007113ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007114{
7115 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7116}
7117
7118/*
7119 * ":viusage"
7120 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007121 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007122ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007123{
7124 do_cmdline_cmd((char_u *)"help normal-index");
7125}
7126
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007128 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007131helptags_one(
7132 char_u *dir, /* doc directory */
7133 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7134 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7135 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136{
7137 FILE *fd_tags;
7138 FILE *fd;
7139 garray_T ga;
7140 int filecount;
7141 char_u **files;
7142 char_u *p1, *p2;
7143 int fi;
7144 char_u *s;
7145 int i;
7146 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007147 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 int utf8 = MAYBE;
7149 int this_utf8;
7150 int firstline;
7151 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152
7153 /*
7154 * Find all *.txt files.
7155 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007156 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007158 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 STRCAT(NameBuff, ext);
7160 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7161 EW_FILE|EW_SILENT) == FAIL
7162 || filecount == 0)
7163 {
7164 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007165 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 return;
7167 }
7168
7169 /*
7170 * Open the tags file for writing.
7171 * Do this before scanning through all the files.
7172 */
7173 STRCPY(NameBuff, dir);
7174 add_pathsep(NameBuff);
7175 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007176 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 if (fd_tags == NULL)
7178 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007179 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 FreeWild(filecount, files);
7181 return;
7182 }
7183
7184 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007185 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7186 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 */
7188 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007189 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7190 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 {
7192 if (ga_grow(&ga, 1) == FAIL)
7193 got_int = TRUE;
7194 else
7195 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007196 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 if (s == NULL)
7198 got_int = TRUE;
7199 else
7200 {
7201 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7202 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7203 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 }
7205 }
7206 }
7207
7208 /*
7209 * Go over all the files and extract the tags.
7210 */
7211 for (fi = 0; fi < filecount && !got_int; ++fi)
7212 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007213 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 if (fd == NULL)
7215 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007216 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 continue;
7218 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007219 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7223 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 if (firstline)
7225 {
7226 /* Detect utf-8 file by a non-ASCII char in the first line. */
7227 this_utf8 = MAYBE;
7228 for (s = IObuff; *s != NUL; ++s)
7229 if (*s >= 0x80)
7230 {
7231 int l;
7232
7233 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007234 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 if (l == 1)
7236 {
7237 /* Illegal UTF-8 byte sequence. */
7238 this_utf8 = FALSE;
7239 break;
7240 }
7241 s += l - 1;
7242 }
7243 if (this_utf8 == MAYBE) /* only ASCII characters found */
7244 this_utf8 = FALSE;
7245 if (utf8 == MAYBE) /* first file */
7246 utf8 = this_utf8;
7247 else if (utf8 != this_utf8)
7248 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007249 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 mix = !got_int;
7251 got_int = TRUE;
7252 }
7253 firstline = FALSE;
7254 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7256 while (p1 != NULL)
7257 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007258 /* Use vim_strbyte() instead of vim_strchr() so that when
7259 * 'encoding' is dbcs it still works, don't find '*' in the
7260 * second byte. */
7261 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7263 {
7264 for (s = p1 + 1; s < p2; ++s)
7265 if (*s == ' ' || *s == '\t' || *s == '|')
7266 break;
7267
7268 /*
7269 * Only accept a *tag* when it consists of valid
7270 * characters, there is white space before it and is
7271 * followed by a white character or end-of-line.
7272 */
7273 if (s == p2
7274 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7275 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7276 || s[1] == '\0'))
7277 {
7278 *p2 = '\0';
7279 ++p1;
7280 if (ga_grow(&ga, 1) == FAIL)
7281 {
7282 got_int = TRUE;
7283 break;
7284 }
7285 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7286 if (s == NULL)
7287 {
7288 got_int = TRUE;
7289 break;
7290 }
7291 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7292 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 sprintf((char *)s, "%s\t%s", p1, fname);
7294
7295 /* find next '*' */
7296 p2 = vim_strchr(p2 + 1, '*');
7297 }
7298 }
7299 p1 = p2;
7300 }
7301 line_breakcheck();
7302 }
7303
7304 fclose(fd);
7305 }
7306
7307 FreeWild(filecount, files);
7308
7309 if (!got_int)
7310 {
7311 /*
7312 * Sort the tags.
7313 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007314 if (ga.ga_data != NULL)
7315 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316
7317 /*
7318 * Check for duplicates.
7319 */
7320 for (i = 1; i < ga.ga_len; ++i)
7321 {
7322 p1 = ((char_u **)ga.ga_data)[i - 1];
7323 p2 = ((char_u **)ga.ga_data)[i];
7324 while (*p1 == *p2)
7325 {
7326 if (*p2 == '\t')
7327 {
7328 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007329 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7331 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007332 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 *p2 = '\t';
7334 break;
7335 }
7336 ++p1;
7337 ++p2;
7338 }
7339 }
7340
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 if (utf8 == TRUE)
7342 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343
7344 /*
7345 * Write the tags into the file.
7346 */
7347 for (i = 0; i < ga.ga_len; ++i)
7348 {
7349 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007350 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007352 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 else
7354 {
7355 fprintf(fd_tags, "%s\t/*", s);
7356 for (p1 = s; *p1 != '\t'; ++p1)
7357 {
7358 /* insert backslash before '\\' and '/' */
7359 if (*p1 == '\\' || *p1 == '/')
7360 putc('\\', fd_tags);
7361 putc(*p1, fd_tags);
7362 }
7363 fprintf(fd_tags, "*\n");
7364 }
7365 }
7366 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 if (mix)
7368 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369
7370 for (i = 0; i < ga.ga_len; ++i)
7371 vim_free(((char_u **)ga.ga_data)[i]);
7372 ga_clear(&ga);
7373 fclose(fd_tags); /* there is no check for an error... */
7374}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007376/*
7377 * Generate tags in one help directory, taking care of translations.
7378 */
7379 static void
7380do_helptags(char_u *dirname, int add_help_tags)
7381{
7382#ifdef FEAT_MULTI_LANG
7383 int len;
7384 int i, j;
7385 garray_T ga;
7386 char_u lang[2];
7387 char_u ext[5];
7388 char_u fname[8];
7389 int filecount;
7390 char_u **files;
7391
7392 /* Get a list of all files in the help directory and in subdirectories. */
7393 STRCPY(NameBuff, dirname);
7394 add_pathsep(NameBuff);
7395 STRCAT(NameBuff, "**");
7396 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7397 EW_FILE|EW_SILENT) == FAIL
7398 || filecount == 0)
7399 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007400 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007401 return;
7402 }
7403
7404 /* Go over all files in the directory to find out what languages are
7405 * present. */
7406 ga_init2(&ga, 1, 10);
7407 for (i = 0; i < filecount; ++i)
7408 {
7409 len = (int)STRLEN(files[i]);
7410 if (len > 4)
7411 {
7412 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7413 {
7414 /* ".txt" -> language "en" */
7415 lang[0] = 'e';
7416 lang[1] = 'n';
7417 }
7418 else if (files[i][len - 4] == '.'
7419 && ASCII_ISALPHA(files[i][len - 3])
7420 && ASCII_ISALPHA(files[i][len - 2])
7421 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7422 {
7423 /* ".abx" -> language "ab" */
7424 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7425 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7426 }
7427 else
7428 continue;
7429
7430 /* Did we find this language already? */
7431 for (j = 0; j < ga.ga_len; j += 2)
7432 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7433 break;
7434 if (j == ga.ga_len)
7435 {
7436 /* New language, add it. */
7437 if (ga_grow(&ga, 2) == FAIL)
7438 break;
7439 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7440 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7441 }
7442 }
7443 }
7444
7445 /*
7446 * Loop over the found languages to generate a tags file for each one.
7447 */
7448 for (j = 0; j < ga.ga_len; j += 2)
7449 {
7450 STRCPY(fname, "tags-xx");
7451 fname[5] = ((char_u *)ga.ga_data)[j];
7452 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7453 if (fname[5] == 'e' && fname[6] == 'n')
7454 {
7455 /* English is an exception: use ".txt" and "tags". */
7456 fname[4] = NUL;
7457 STRCPY(ext, ".txt");
7458 }
7459 else
7460 {
7461 /* Language "ab" uses ".abx" and "tags-ab". */
7462 STRCPY(ext, ".xxx");
7463 ext[1] = fname[5];
7464 ext[2] = fname[6];
7465 }
7466 helptags_one(dirname, ext, fname, add_help_tags);
7467 }
7468
7469 ga_clear(&ga);
7470 FreeWild(filecount, files);
7471
7472#else
7473 /* No language support, just use "*.txt" and "tags". */
7474 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7475#endif
7476}
7477
7478 static void
7479helptags_cb(char_u *fname, void *cookie)
7480{
7481 do_helptags(fname, *(int *)cookie);
7482}
7483
7484/*
7485 * ":helptags"
7486 */
7487 void
7488ex_helptags(exarg_T *eap)
7489{
7490 expand_T xpc;
7491 char_u *dirname;
7492 int add_help_tags = FALSE;
7493
7494 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007495 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007496 {
7497 add_help_tags = TRUE;
7498 eap->arg = skipwhite(eap->arg + 3);
7499 }
7500
7501 if (STRCMP(eap->arg, "ALL") == 0)
7502 {
7503 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7504 helptags_cb, &add_help_tags);
7505 }
7506 else
7507 {
7508 ExpandInit(&xpc);
7509 xpc.xp_context = EXPAND_DIRECTORIES;
7510 dirname = ExpandOne(&xpc, eap->arg, NULL,
7511 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7512 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007513 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007514 else
7515 do_helptags(dirname, add_help_tags);
7516 vim_free(dirname);
7517 }
7518}
7519
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007520/*
7521 * Make the user happy.
7522 */
7523 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007524ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007525{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007526 static char *code[] = {
7527 "\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$",
7528 "\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"
7529 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007530 char *p;
7531 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007532 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007533
7534 msg_start();
7535 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007536 for (i = 0; i < 2; ++i)
7537 for (p = code[i]; *p != NUL; ++p)
7538 if (*p == 'x')
7539 msg_putchar('\n');
7540 else
7541 for (n = *p++; n > 0; --n)
7542 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01007543 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007544 else
7545 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007546 msg_clr_eos();
7547}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549/*
7550 * ":drop"
7551 * Opens the first argument in a window. When there are two or more arguments
7552 * the argument list is redefined.
7553 */
7554 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007555ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556{
7557 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 win_T *wp;
7559 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007560 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561
7562 /*
7563 * Check if the first argument is already being edited in a window. If
7564 * so, jump to that window.
7565 * We would actually need to check all arguments, but that's complicated
7566 * and mostly only one file is dropped.
7567 * This also ignores wildcards, since it is very unlikely the user is
7568 * editing a file name with a wildcard character.
7569 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007570 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007572 /*
7573 * Expanding wildcards may result in an empty argument list. E.g. when
7574 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7575 * already did an error message for this.
7576 */
7577 if (ARGCOUNT == 0)
7578 return;
7579
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007580 if (cmdmod.tab)
7581 {
7582 /* ":tab drop file ...": open a tab for each argument that isn't
7583 * edited in a window yet. It's like ":tab all" but without closing
7584 * windows or tabs. */
7585 ex_all(eap);
7586 }
7587 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007588 {
7589 /* ":drop file ...": Edit the first argument. Jump to an existing
7590 * window if possible, edit in current window if the current buffer
7591 * can be abandoned, otherwise open a new window. */
7592 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7593
7594 FOR_ALL_TAB_WINDOWS(tp, wp)
7595 {
7596 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007598 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 return;
7601 }
7602 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007604 /*
7605 * Check whether the current buffer is changed. If so, we will need
7606 * to split the current window or data could be lost.
7607 * Skip the check if the 'hidden' option is set, as in this case the
7608 * buffer won't be lost.
7609 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02007610 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007611 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007612 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01007613 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007614 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007615 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007617 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7618 if (split)
7619 {
7620 eap->cmdidx = CMD_sfirst;
7621 eap->cmd[0] = 's';
7622 }
7623 else
7624 eap->cmdidx = CMD_first;
7625 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007628
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007629/*
7630 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
7631 * Put the start of the pattern in "*s", unless "s" is NULL.
7632 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
7633 * If "s" is not NULL terminate the pattern with a NUL.
7634 * Return a pointer to the char just past the pattern plus flags.
7635 */
7636 char_u *
7637skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
7638{
7639 int c;
7640
7641 if (vim_isIDc(*p))
7642 {
7643 /* ":vimgrep pattern fname" */
7644 if (s != NULL)
7645 *s = p;
7646 p = skiptowhite(p);
7647 if (s != NULL && *p != NUL)
7648 *p++ = NUL;
7649 }
7650 else
7651 {
7652 /* ":vimgrep /pattern/[g][j] fname" */
7653 if (s != NULL)
7654 *s = p + 1;
7655 c = *p;
7656 p = skip_regexp(p + 1, c, TRUE, NULL);
7657 if (*p != c)
7658 return NULL;
7659
7660 /* Truncate the pattern. */
7661 if (s != NULL)
7662 *p = NUL;
7663 ++p;
7664
7665 /* Find the flags */
7666 while (*p == 'g' || *p == 'j')
7667 {
7668 if (flags != NULL)
7669 {
7670 if (*p == 'g')
7671 *flags |= VGR_GLOBAL;
7672 else
7673 *flags |= VGR_NOJUMP;
7674 }
7675 ++p;
7676 }
7677 }
7678 return p;
7679}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007680
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007681#if defined(FEAT_EVAL) || defined(PROTO)
7682/*
7683 * List v:oldfiles in a nice way.
7684 */
7685 void
7686ex_oldfiles(exarg_T *eap UNUSED)
7687{
7688 list_T *l = get_vim_var_list(VV_OLDFILES);
7689 listitem_T *li;
7690 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007691 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007692
7693 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007694 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007695 else
7696 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007697 msg_start();
7698 msg_scroll = TRUE;
7699 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
7700 {
7701 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007702 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02007703 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007704 {
7705 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01007706 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007707 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02007708 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007709 msg_putchar('\n');
7710 out_flush(); /* output one line at a time */
7711 ui_breakcheck();
7712 }
7713 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007714
7715 /* Assume "got_int" was set to truncate the listing. */
7716 got_int = FALSE;
7717
7718# ifdef FEAT_BROWSE_CMD
7719 if (cmdmod.browse)
7720 {
7721 quit_more = FALSE;
7722 nr = prompt_for_number(FALSE);
7723 msg_starthere();
7724 if (nr > 0)
7725 {
7726 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
7727 (long)nr);
7728
7729 if (p != NULL)
7730 {
7731 p = expand_env_save(p);
7732 eap->arg = p;
7733 eap->cmdidx = CMD_edit;
7734 cmdmod.browse = FALSE;
7735 do_exedit(eap, NULL);
7736 vim_free(p);
7737 }
7738 }
7739 }
7740# endif
7741 }
7742}
7743#endif