blob: 991dc458e25abc8b575646bcc79175551c332c87 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010031static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000032static int
33#ifdef __BORLANDC__
34 _RTLENTRYF
35#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010036 help_compare(const void *s1, const void *s2);
37static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39/*
40 * ":ascii" and "ga".
41 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010043do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000044{
45 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000046 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 char buf1[20];
48 char buf2[20];
49 char_u buf3[7];
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050#ifdef FEAT_DIGRAPHS
51 char_u *dig;
52#endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 c = gchar_cursor();
61 if (c == NUL)
62 {
Bram Moolenaar32526b32019-01-19 17:43:09 +010063 msg("NUL");
Bram Moolenaar071d4272004-06-13 20:20:40 +000064 return;
65 }
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067 IObuff[0] = NUL;
68 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
Bram Moolenaar071d4272004-06-13 20:20:40 +000069 {
70 if (c == NL) /* NUL is stored as NL */
71 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000072 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
73 cval = NL; /* NL is stored as CR */
74 else
75 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 if (vim_isprintc_strict(c) && (c < ' '
77#ifndef EBCDIC
78 || c > '~'
79#endif
80 ))
81 {
82 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000083 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 }
85 else
86 buf1[0] = NUL;
87#ifndef EBCDIC
88 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000089 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
90 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 else
92#endif
93 buf2[0] = NUL;
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010094#ifdef FEAT_DIGRAPHS
95 dig = get_digraph_for_char(cval);
96 if (dig != NULL)
97 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Oct %03o, Digr %s"),
99 transchar(c), buf1, buf2, cval, cval, cval, dig);
100 else
101#endif
102 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar555b2802005-05-19 21:08:39 +0000103 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +0000104 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000105 if (enc_utf8)
106 c = cc[ci++];
107 else
108 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 }
110
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 /* Repeat for combining characters. */
112 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
113 {
114 len = (int)STRLEN(IObuff);
115 /* This assumes every multi-byte char is printable... */
116 if (len > 0)
117 IObuff[len++] = ' ';
118 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000119 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000122# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 )
124 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000125 len += (*mb_char2bytes)(c, IObuff + len);
Bram Moolenaar5f73ef82018-02-27 21:09:30 +0100126#ifdef FEAT_DIGRAPHS
127 dig = get_digraph_for_char(c);
128 if (dig != NULL)
129 vim_snprintf((char *)IObuff + len, IOSIZE - len,
130 c < 0x10000 ? _("> %d, Hex %04x, Oct %o, Digr %s")
131 : _("> %d, Hex %08x, Oct %o, Digr %s"),
132 c, c, c, dig);
133 else
134#endif
135 vim_snprintf((char *)IObuff + len, IOSIZE - len,
136 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
137 : _("> %d, Hex %08x, Octal %o"),
138 c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000139 if (ci == MAX_MCO)
140 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000141 if (enc_utf8)
142 c = cc[ci++];
143 else
144 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
Bram Moolenaar32526b32019-01-19 17:43:09 +0100147 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148}
149
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150/*
151 * ":left", ":center" and ":right": align text.
152 */
153 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100154ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155{
156 pos_T save_curpos;
157 int len;
158 int indent = 0;
159 int new_indent;
160 int has_tab;
161 int width;
162
163#ifdef FEAT_RIGHTLEFT
164 if (curwin->w_p_rl)
165 {
166 /* switch left and right aligning */
167 if (eap->cmdidx == CMD_right)
168 eap->cmdidx = CMD_left;
169 else if (eap->cmdidx == CMD_left)
170 eap->cmdidx = CMD_right;
171 }
172#endif
173
174 width = atoi((char *)eap->arg);
175 save_curpos = curwin->w_cursor;
176 if (eap->cmdidx == CMD_left) /* width is used for new indent */
177 {
178 if (width >= 0)
179 indent = width;
180 }
181 else
182 {
183 /*
184 * if 'textwidth' set, use it
185 * else if 'wrapmargin' set, use it
186 * if invalid value, use 80
187 */
188 if (width <= 0)
189 width = curbuf->b_p_tw;
190 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200191 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192 if (width <= 0)
193 width = 80;
194 }
195
196 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
197 return;
198
199 for (curwin->w_cursor.lnum = eap->line1;
200 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
201 {
202 if (eap->cmdidx == CMD_left) /* left align */
203 new_indent = indent;
204 else
205 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000206 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 len = linelen(eap->cmdidx == CMD_right ? &has_tab
208 : NULL) - get_indent();
209
210 if (len <= 0) /* skip blank lines */
211 continue;
212
213 if (eap->cmdidx == CMD_center)
214 new_indent = (width - len) / 2;
215 else
216 {
217 new_indent = width - len; /* right align */
218
219 /*
220 * Make sure that embedded TABs don't make the text go too far
221 * to the right.
222 */
223 if (has_tab)
224 while (new_indent > 0)
225 {
226 (void)set_indent(new_indent, 0);
227 if (linelen(NULL) <= width)
228 {
229 /*
230 * Now try to move the line as much as possible to
231 * the right. Stop when it moves too far.
232 */
233 do
234 (void)set_indent(++new_indent, 0);
235 while (linelen(NULL) <= width);
236 --new_indent;
237 break;
238 }
239 --new_indent;
240 }
241 }
242 }
243 if (new_indent < 0)
244 new_indent = 0;
245 (void)set_indent(new_indent, 0); /* set indent */
246 }
247 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
248 curwin->w_cursor = save_curpos;
249 beginline(BL_WHITE | BL_FIX);
250}
251
252/*
253 * Get the length of the current line, excluding trailing white space.
254 */
255 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100256linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257{
258 char_u *line;
259 char_u *first;
260 char_u *last;
261 int save;
262 int len;
263
264 /* find the first non-blank character */
265 line = ml_get_curline();
266 first = skipwhite(line);
267
268 /* find the character after the last non-blank character */
269 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100270 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 ;
272 save = *last;
273 *last = NUL;
274 len = linetabsize(line); /* get line length */
275 if (has_tab != NULL) /* check for embedded TAB */
Bram Moolenaarb31a3ac2018-08-11 14:41:55 +0200276 *has_tab = (vim_strchr(first, TAB) != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 *last = save;
278
279 return len;
280}
281
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282/* Buffer for two lines used during sorting. They are allocated to
283 * contain the longest line being sorted. */
284static char_u *sortbuf1;
285static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000286
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100287static int sort_ic; /* ignore case */
288static int sort_nr; /* sort on number */
289static int sort_rx; /* sort on regex instead of skipping it */
290#ifdef FEAT_FLOAT
291static int sort_flt; /* sort on floating number */
292#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000293
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000295
296/* Struct to store info to be sorted. */
297typedef struct
298{
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100299 linenr_T lnum; // line number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100300 union {
301 struct
302 {
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100303 varnumber_T start_col_nr; // starting column number
304 varnumber_T end_col_nr; // ending column number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100305 } line;
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100306 struct
307 {
308 varnumber_T value; // value if sorting by integer
309 int is_number; // TRUE when line contains a number
310 } num;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100311#ifdef FEAT_FLOAT
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100312 float_T value_flt; // value if sorting by float
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100313#endif
314 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000315} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000316
317static int
318#ifdef __BORLANDC__
319_RTLENTRYF
320#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100321sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000322
323 static int
324#ifdef __BORLANDC__
325_RTLENTRYF
326#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100327sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000328{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 sorti_T l1 = *(sorti_T *)s1;
330 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000331 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000332
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000333 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000334 * if we return 0 every time, qsort will assume it's done sorting and
335 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000336 if (sort_abort)
337 return 0;
338 fast_breakcheck();
339 if (got_int)
340 sort_abort = TRUE;
341
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000342 if (sort_nr)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100343 {
344 if (l1.st_u.num.is_number != l2.st_u.num.is_number)
345 result = l1.st_u.num.is_number - l2.st_u.num.is_number;
346 else
347 result = l1.st_u.num.value == l2.st_u.num.value ? 0
348 : l1.st_u.num.value > l2.st_u.num.value ? 1 : -1;
349 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100350#ifdef FEAT_FLOAT
351 else if (sort_flt)
352 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
353 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
354#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000355 else
356 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000357 /* We need to copy one line into "sortbuf1", because there is no
358 * guarantee that the first pointer becomes invalid when obtaining the
359 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100360 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
361 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
362 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
363 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
364 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
365 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000366
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000367 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
368 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000369 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000370
371 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000372 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000373 return (int)(l1.lnum - l2.lnum);
374 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000375}
376
377/*
378 * ":sort".
379 */
380 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100381ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382{
383 regmatch_T regmatch;
384 int len;
385 linenr_T lnum;
386 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000387 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000388 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000389 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000390 char_u *p;
391 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000392 char_u *s2;
393 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000394 int unique = FALSE;
395 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 colnr_T start_col;
397 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100398 int sort_what = 0;
399 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200400 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401
Bram Moolenaar48c99162008-02-18 18:42:52 +0000402 /* Sorting one line is really quick! */
403 if (count <= 1)
404 return;
405
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000406 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
407 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000408 sortbuf1 = NULL;
409 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000410 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000411 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000412 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000413 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000414
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100415 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100416#ifdef FEAT_FLOAT
417 sort_flt = 0;
418#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000419
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000420 for (p = eap->arg; *p != NUL; ++p)
421 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100422 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000423 ;
424 else if (*p == 'i')
425 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000426 else if (*p == 'r')
427 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000428 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100429 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100430 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100431 ++format_found;
432 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100433#ifdef FEAT_FLOAT
434 else if (*p == 'f')
435 {
436 sort_flt = 1;
437 ++format_found;
438 }
439#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100440 else if (*p == 'b')
441 {
442 sort_what = STR2NR_BIN + STR2NR_FORCE;
443 ++format_found;
444 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000445 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100446 {
447 sort_what = STR2NR_OCT + STR2NR_FORCE;
448 ++format_found;
449 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100451 {
452 sort_what = STR2NR_HEX + STR2NR_FORCE;
453 ++format_found;
454 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000455 else if (*p == 'u')
456 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000457 else if (*p == '"') /* comment start */
458 break;
459 else if (check_nextcmd(p) != NULL)
460 {
461 eap->nextcmd = check_nextcmd(p);
462 break;
463 }
464 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000465 {
466 s = skip_regexp(p + 1, *p, TRUE, NULL);
467 if (*s != *p)
468 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100469 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000470 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000471 }
472 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000473 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100474 if (s == p + 1)
475 {
476 if (last_search_pat() == NULL)
477 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100478 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100479 goto sortend;
480 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000481 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100482 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000483 else
484 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000485 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000487 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000488 regmatch.rm_ic = p_ic;
489 }
490 else
491 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100492 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000493 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000494 }
495 }
496
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100497 /* Can only have one of 'n', 'b', 'o' and 'x'. */
498 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000499 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100500 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 }
503
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100504 /* From here on "sort_nr" is used as a flag for any integer number
505 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100506 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000509 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000510 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 * When sorting on strings "start_col_nr" is the offset in the line, for
512 * numbers sorting it's the number to sort on. This means the pattern
513 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000514 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000515 */
516 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
517 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000518 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000519 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520 if (maxlen < len)
521 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000523 start_col = 0;
524 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 {
527 if (sort_rx)
528 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000529 start_col = (colnr_T)(regmatch.startp[0] - s);
530 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000531 }
532 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000533 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000534 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000535 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000536 if (regmatch.regprog != NULL)
537 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000538
Bram Moolenaar937204a2016-01-30 23:37:38 +0100539 if (sort_nr
540#ifdef FEAT_FLOAT
541 || sort_flt
542#endif
543 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000544 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000545 /* Make sure vim_str2nr doesn't read any digits past the end
546 * of the match, by temporarily terminating the string there */
547 s2 = s + end_col;
548 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200549 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000550 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000551 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 if (sort_nr)
553 {
554 if (sort_what & STR2NR_HEX)
555 s = skiptohex(p);
556 else if (sort_what & STR2NR_BIN)
557 s = skiptobin(p);
558 else
559 s = skiptodigit(p);
560 if (s > p && s[-1] == '-')
561 --s; /* include preceding negative sign */
562 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100563 {
564 /* line without number should sort before any number */
565 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
566 nrs[lnum - eap->line1].st_u.num.value = 0;
567 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100568 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100569 {
570 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100571 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100572 &nrs[lnum - eap->line1].st_u.num.value, NULL, 0);
573 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100574 }
575#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000576 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100577 {
578 s = skipwhite(p);
579 if (*s == '+')
580 s = skipwhite(s + 1);
581
582 if (*s == NUL)
583 /* empty line should sort before any number */
584 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
585 else
586 nrs[lnum - eap->line1].st_u.value_flt =
587 strtod((char *)s, NULL);
588 }
589#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200590 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 }
592 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000594 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100595 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
596 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000597 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000598
599 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000600
601 if (regmatch.regprog != NULL)
602 fast_breakcheck();
603 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000604 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000605 }
606
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000607 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000608 sortbuf1 = alloc((unsigned)maxlen + 1);
609 if (sortbuf1 == NULL)
610 goto sortend;
611 sortbuf2 = alloc((unsigned)maxlen + 1);
612 if (sortbuf2 == NULL)
613 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000614
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000615 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000616 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000617
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000618 if (sort_abort)
619 goto sortend;
620
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000621 /* Insert the lines in the sorted order below the last one. */
622 lnum = eap->line2;
623 for (i = 0; i < count; ++i)
624 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200625 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
626
627 // If the original line number of the line being placed is not the same
628 // as "lnum" (accounting for offset), we know that the buffer changed.
629 if (get_lnum + ((linenr_T)count - 1) != lnum)
630 change_occurred = TRUE;
631
632 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000633 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000634 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000635 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200636 // Copy the line into a buffer, it may become invalid in
637 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100638 STRCPY(sortbuf1, s);
639 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000641 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000642 fast_breakcheck();
643 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000644 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 }
646
647 /* delete the original lines if appending worked */
648 if (i == count)
649 for (i = 0; i < count; ++i)
650 ml_delete(eap->line1, FALSE);
651 else
652 count = 0;
653
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000654 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000655 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000656 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200657 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000658 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200659 msgmore(-deleted);
660 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000661 else if (deleted < 0)
662 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200663
664 if (change_occurred || deleted != 0)
665 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000666
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000667 curwin->w_cursor.lnum = eap->line1;
668 beginline(BL_WHITE | BL_FIX);
669
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000670sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000671 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000672 vim_free(sortbuf1);
673 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200674 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000675 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100676 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000677}
678
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679/*
680 * ":retab".
681 */
682 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100683ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684{
685 linenr_T lnum;
686 int got_tab = FALSE;
687 long num_spaces = 0;
688 long num_tabs;
689 long len;
690 long col;
691 long vcol;
692 long start_col = 0; /* For start of white-space string */
693 long start_vcol = 0; /* For start of white-space string */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 long old_len;
695 char_u *ptr;
696 char_u *new_line = (char_u *)1; /* init to non-NULL */
697 int did_undo; /* called u_save for current line */
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200698#ifdef FEAT_VARTABS
Bram Moolenaar0119a592018-06-24 23:53:28 +0200699 int *new_vts_array = NULL;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200700 char_u *new_ts_str; /* string value of tab argument */
701#else
702 int temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 int new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200704#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 int save_list;
706 linenr_T first_line = 0; /* first changed line */
707 linenr_T last_line = 0; /* last changed line */
708
709 save_list = curwin->w_p_list;
710 curwin->w_p_list = 0; /* don't want list mode here */
711
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200712#ifdef FEAT_VARTABS
713 new_ts_str = eap->arg;
Bram Moolenaar0119a592018-06-24 23:53:28 +0200714 if (!tabstop_set(eap->arg, &new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200715 return;
716 while (vim_isdigit(*(eap->arg)) || *(eap->arg) == ',')
717 ++(eap->arg);
718
Bram Moolenaar0119a592018-06-24 23:53:28 +0200719 // This ensures that either new_vts_array and new_ts_str are freshly
720 // allocated, or new_vts_array points to an existing array and new_ts_str
721 // is null.
722 if (new_vts_array == NULL)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200723 {
Bram Moolenaar0119a592018-06-24 23:53:28 +0200724 new_vts_array = curbuf->b_p_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200725 new_ts_str = NULL;
726 }
727 else
728 new_ts_str = vim_strnsave(new_ts_str, eap->arg - new_ts_str);
729#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 new_ts = getdigits(&(eap->arg));
731 if (new_ts < 0)
732 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100733 emsg(_(e_positive));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 return;
735 }
736 if (new_ts == 0)
737 new_ts = curbuf->b_p_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200738#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
740 {
741 ptr = ml_get(lnum);
742 col = 0;
743 vcol = 0;
744 did_undo = FALSE;
745 for (;;)
746 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100747 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 {
749 if (!got_tab && num_spaces == 0)
750 {
751 /* First consecutive white-space */
752 start_vcol = vcol;
753 start_col = col;
754 }
755 if (ptr[col] == ' ')
756 num_spaces++;
757 else
758 got_tab = TRUE;
759 }
760 else
761 {
762 if (got_tab || (eap->forceit && num_spaces > 1))
763 {
764 /* Retabulate this string of white-space */
765
766 /* len is virtual length of white string */
767 len = num_spaces = vcol - start_vcol;
768 num_tabs = 0;
769 if (!curbuf->b_p_et)
770 {
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200771#ifdef FEAT_VARTABS
772 int t, s;
773
774 tabstop_fromto(start_vcol, vcol,
Bram Moolenaar0119a592018-06-24 23:53:28 +0200775 curbuf->b_p_ts, new_vts_array, &t, &s);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200776 num_tabs = t;
777 num_spaces = s;
778#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 temp = new_ts - (start_vcol % new_ts);
780 if (num_spaces >= temp)
781 {
782 num_spaces -= temp;
783 num_tabs++;
784 }
785 num_tabs += num_spaces / new_ts;
786 num_spaces -= (num_spaces / new_ts) * new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200787#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 }
789 if (curbuf->b_p_et || got_tab ||
790 (num_spaces + num_tabs < len))
791 {
792 if (did_undo == FALSE)
793 {
794 did_undo = TRUE;
795 if (u_save((linenr_T)(lnum - 1),
796 (linenr_T)(lnum + 1)) == FAIL)
797 {
798 new_line = NULL; /* flag out-of-memory */
799 break;
800 }
801 }
802
803 /* len is actual number of white characters used */
804 len = num_spaces + num_tabs;
805 old_len = (long)STRLEN(ptr);
806 new_line = lalloc(old_len - col + start_col + len + 1,
807 TRUE);
808 if (new_line == NULL)
809 break;
810 if (start_col > 0)
811 mch_memmove(new_line, ptr, (size_t)start_col);
812 mch_memmove(new_line + start_col + len,
813 ptr + col, (size_t)(old_len - col + 1));
814 ptr = new_line + start_col;
815 for (col = 0; col < len; col++)
816 ptr[col] = (col < num_tabs) ? '\t' : ' ';
817 ml_replace(lnum, new_line, FALSE);
818 if (first_line == 0)
819 first_line = lnum;
820 last_line = lnum;
821 ptr = new_line;
822 col = start_col + len;
823 }
824 }
825 got_tab = FALSE;
826 num_spaces = 0;
827 }
828 if (ptr[col] == NUL)
829 break;
830 vcol += chartabsize(ptr + col, (colnr_T)vcol);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000832 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 ++col;
835 }
836 if (new_line == NULL) /* out of memory */
837 break;
838 line_breakcheck();
839 }
840 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100841 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200843#ifdef FEAT_VARTABS
844 // If a single value was given then it can be considered equal to
845 // either the value of 'tabstop' or the value of 'vartabstop'.
846 if (tabstop_count(curbuf->b_p_vts_array) == 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200847 && tabstop_count(new_vts_array) == 1
848 && curbuf->b_p_ts == tabstop_first(new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200849 ; /* not changed */
850 else if (tabstop_count(curbuf->b_p_vts_array) > 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200851 && tabstop_eq(curbuf->b_p_vts_array, new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200852 ; /* not changed */
853 else
854 redraw_curbuf_later(NOT_VALID);
855#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (curbuf->b_p_ts != new_ts)
857 redraw_curbuf_later(NOT_VALID);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200858#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 if (first_line != 0)
860 changed_lines(first_line, 0, last_line + 1, 0L);
861
862 curwin->w_p_list = save_list; /* restore 'list' */
863
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200864#ifdef FEAT_VARTABS
865 if (new_ts_str != NULL) /* set the new tabstop */
866 {
867 // If 'vartabstop' is in use or if the value given to retab has more
868 // than one tabstop then update 'vartabstop'.
869 int *old_vts_ary = curbuf->b_p_vts_array;
870
Bram Moolenaar0119a592018-06-24 23:53:28 +0200871 if (tabstop_count(old_vts_ary) > 0 || tabstop_count(new_vts_array) > 1)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200872 {
873 set_string_option_direct((char_u *)"vts", -1, new_ts_str,
874 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0119a592018-06-24 23:53:28 +0200875 curbuf->b_p_vts_array = new_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200876 vim_free(old_vts_ary);
877 }
878 else
879 {
880 // 'vartabstop' wasn't in use and a single value was given to
881 // retab then update 'tabstop'.
Bram Moolenaar0119a592018-06-24 23:53:28 +0200882 curbuf->b_p_ts = tabstop_first(new_vts_array);
883 vim_free(new_vts_array);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200884 }
Bram Moolenaar307ac5c2018-06-28 22:23:00 +0200885 vim_free(new_ts_str);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200886 }
887#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 curbuf->b_p_ts = new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200889#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 coladvance(curwin->w_curswant);
891
892 u_clearline();
893}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894
895/*
896 * :move command - move lines line1-line2 to line dest
897 *
898 * return FAIL for failure, OK otherwise
899 */
900 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100901do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902{
903 char_u *str;
904 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100905 linenr_T extra; // Num lines added before line1
906 linenr_T num_lines; // Num lines moved
907 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200908#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100909 win_T *win;
910 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
913 if (dest >= line1 && dest < line2)
914 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100915 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 return FAIL;
917 }
918
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100919 // Do nothing if we are not actually moving any lines. This will prevent
920 // the 'modified' flag from being set without cause.
921 if (dest == line1 - 1 || dest == line2)
922 {
923 // Move the cursor as if lines were moved (see below) to be backwards
924 // compatible.
925 if (dest >= line1)
926 curwin->w_cursor.lnum = dest;
927 else
928 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
929
930 return OK;
931 }
932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 num_lines = line2 - line1 + 1;
934
935 /*
936 * First we copy the old text to its new location -- webb
937 * Also copy the flag that ":global" command uses.
938 */
939 if (u_save(dest, dest + 1) == FAIL)
940 return FAIL;
941 for (extra = 0, l = line1; l <= line2; l++)
942 {
943 str = vim_strsave(ml_get(l + extra));
944 if (str != NULL)
945 {
946 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
947 vim_free(str);
948 if (dest < line1)
949 extra++;
950 }
951 }
952
953 /*
954 * Now we must be careful adjusting our marks so that we don't overlap our
955 * mark_adjust() calls.
956 *
957 * We adjust the marks within the old text so that they refer to the
958 * last lines of the file (temporarily), because we know no other marks
959 * will be set there since these line numbers did not exist until we added
960 * our new lines.
961 *
962 * Then we adjust the marks on lines between the old and new text positions
963 * (either forwards or backwards).
964 *
965 * And Finally we adjust the marks we put at the end of the file back to
966 * their final destination at the new text position -- webb
967 */
968 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100969 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 if (dest >= line2)
971 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100972 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
973#ifdef FEAT_FOLDING
974 FOR_ALL_TAB_WINDOWS(tp, win) {
975 if (win->w_buffer == curbuf)
976 foldMoveRange(&win->w_folds, line1, line2, dest);
977 }
978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 curbuf->b_op_start.lnum = dest - num_lines + 1;
980 curbuf->b_op_end.lnum = dest;
981 }
982 else
983 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100984 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
985#ifdef FEAT_FOLDING
986 FOR_ALL_TAB_WINDOWS(tp, win) {
987 if (win->w_buffer == curbuf)
988 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
989 }
990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 curbuf->b_op_start.lnum = dest + 1;
992 curbuf->b_op_end.lnum = dest + num_lines;
993 }
994 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100995 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 -(last_line - dest - extra), 0L);
997
998 /*
999 * Now we delete the original text -- webb
1000 */
1001 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
1002 return FAIL;
1003
1004 for (l = line1; l <= line2; l++)
1005 ml_delete(line1 + extra, TRUE);
1006
1007 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001008 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001009 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010
1011 /*
1012 * Leave the cursor on the last of the moved lines.
1013 */
1014 if (dest >= line1)
1015 curwin->w_cursor.lnum = dest;
1016 else
1017 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
1018
1019 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +01001020 {
1021 dest += num_lines + 1;
1022 last_line = curbuf->b_ml.ml_line_count;
1023 if (dest > last_line + 1)
1024 dest = last_line + 1;
1025 changed_lines(line1, 0, dest, 0L);
1026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 else
1028 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
1029
1030 return OK;
1031}
1032
1033/*
1034 * ":copy"
1035 */
1036 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001037ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038{
1039 linenr_T count;
1040 char_u *p;
1041
1042 count = line2 - line1 + 1;
1043 curbuf->b_op_start.lnum = n + 1;
1044 curbuf->b_op_end.lnum = n + count;
1045 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
1046
1047 /*
1048 * there are three situations:
1049 * 1. destination is above line1
1050 * 2. destination is between line1 and line2
1051 * 3. destination is below line2
1052 *
1053 * n = destination (when starting)
1054 * curwin->w_cursor.lnum = destination (while copying)
1055 * line1 = start of source (while copying)
1056 * line2 = end of source (while copying)
1057 */
1058 if (u_save(n, n + 1) == FAIL)
1059 return;
1060
1061 curwin->w_cursor.lnum = n;
1062 while (line1 <= line2)
1063 {
1064 /* need to use vim_strsave() because the line will be unlocked within
1065 * ml_append() */
1066 p = vim_strsave(ml_get(line1));
1067 if (p != NULL)
1068 {
1069 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
1070 vim_free(p);
1071 }
1072 /* situation 2: skip already copied lines */
1073 if (line1 == n)
1074 line1 = curwin->w_cursor.lnum;
1075 ++line1;
1076 if (curwin->w_cursor.lnum < line1)
1077 ++line1;
1078 if (curwin->w_cursor.lnum < line2)
1079 ++line2;
1080 ++curwin->w_cursor.lnum;
1081 }
1082
1083 appended_lines_mark(n, count);
1084
1085 msgmore((long)count);
1086}
1087
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001088static char_u *prevcmd = NULL; /* the previous command */
1089
1090#if defined(EXITFREE) || defined(PROTO)
1091 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001092free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001093{
1094 vim_free(prevcmd);
1095}
1096#endif
1097
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098/*
1099 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1100 * Bangs in the argument are replaced with the previously entered command.
1101 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 */
1103 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001104do_bang(
1105 int addr_count,
1106 exarg_T *eap,
1107 int forceit,
1108 int do_in,
1109 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110{
1111 char_u *arg = eap->arg; /* command */
1112 linenr_T line1 = eap->line1; /* start of range */
1113 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 char_u *newcmd = NULL; /* the new command */
1115 int free_newcmd = FALSE; /* need to free() newcmd */
1116 int ins_prevcmd;
1117 char_u *t;
1118 char_u *p;
1119 char_u *trailarg;
1120 int len;
1121 int scroll_save = msg_scroll;
1122
1123 /*
1124 * Disallow shell commands for "rvim".
1125 * Disallow shell commands from .exrc and .vimrc in current directory for
1126 * security reasons.
1127 */
1128 if (check_restricted() || check_secure())
1129 return;
1130
1131 if (addr_count == 0) /* :! */
1132 {
1133 msg_scroll = FALSE; /* don't scroll here */
1134 autowrite_all();
1135 msg_scroll = scroll_save;
1136 }
1137
1138 /*
1139 * Try to find an embedded bang, like in :!<cmd> ! [args]
1140 * (:!! is indicated by the 'forceit' variable)
1141 */
1142 ins_prevcmd = forceit;
1143 trailarg = arg;
1144 do
1145 {
1146 len = (int)STRLEN(trailarg) + 1;
1147 if (newcmd != NULL)
1148 len += (int)STRLEN(newcmd);
1149 if (ins_prevcmd)
1150 {
1151 if (prevcmd == NULL)
1152 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001153 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 vim_free(newcmd);
1155 return;
1156 }
1157 len += (int)STRLEN(prevcmd);
1158 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001159 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 {
1161 vim_free(newcmd);
1162 return;
1163 }
1164 *t = NUL;
1165 if (newcmd != NULL)
1166 STRCAT(t, newcmd);
1167 if (ins_prevcmd)
1168 STRCAT(t, prevcmd);
1169 p = t + STRLEN(t);
1170 STRCAT(t, trailarg);
1171 vim_free(newcmd);
1172 newcmd = t;
1173
1174 /*
1175 * Scan the rest of the argument for '!', which is replaced by the
1176 * previous command. "\!" is replaced by "!" (this is vi compatible).
1177 */
1178 trailarg = NULL;
1179 while (*p)
1180 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001181 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 {
1183 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001184 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 else
1186 {
1187 trailarg = p;
1188 *trailarg++ = NUL;
1189 ins_prevcmd = TRUE;
1190 break;
1191 }
1192 }
1193 ++p;
1194 }
1195 } while (trailarg != NULL);
1196
1197 vim_free(prevcmd);
1198 prevcmd = newcmd;
1199
1200 if (bangredo) /* put cmd in redo buffer for ! command */
1201 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001202 /* If % or # appears in the command, it must have been escaped.
1203 * Reescape them, so that redoing them does not substitute them by the
1204 * buffername. */
1205 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1206
1207 if (cmd != NULL)
1208 {
1209 AppendToRedobuffLit(cmd, -1);
1210 vim_free(cmd);
1211 }
1212 else
1213 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 AppendToRedobuff((char_u *)"\n");
1215 bangredo = FALSE;
1216 }
1217 /*
1218 * Add quotes around the command, for shells that need them.
1219 */
1220 if (*p_shq != NUL)
1221 {
1222 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1223 if (newcmd == NULL)
1224 return;
1225 STRCPY(newcmd, p_shq);
1226 STRCAT(newcmd, prevcmd);
1227 STRCAT(newcmd, p_shq);
1228 free_newcmd = TRUE;
1229 }
1230 if (addr_count == 0) /* :! */
1231 {
1232 /* echo the command */
1233 msg_start();
1234 msg_putchar(':');
1235 msg_putchar('!');
1236 msg_outtrans(newcmd);
1237 msg_clr_eos();
1238 windgoto(msg_row, msg_col);
1239
1240 do_shell(newcmd, 0);
1241 }
1242 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001243 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 /* Careful: This may recursively call do_bang() again! (because of
1245 * autocommands) */
1246 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001247 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001248 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 if (free_newcmd)
1250 vim_free(newcmd);
1251}
1252
1253/*
1254 * do_filter: filter lines through a command given by the user
1255 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001256 * We mostly use temp files and the call_shell() routine here. This would
1257 * normally be done using pipes on a UNIX machine, but this is more portable
1258 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 * to deal with redirection somehow, and should handle things like looking
1260 * at the PATH env. variable, and adding reasonable extensions to the
1261 * command name given by the user. All reasonable versions of call_shell()
1262 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001263 * Alternatively, if on Unix and redirecting input or output, but not both,
1264 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 * We use input redirection if do_in is TRUE.
1266 * We use output redirection if do_out is TRUE.
1267 */
1268 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001269do_filter(
1270 linenr_T line1,
1271 linenr_T line2,
1272 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1273 char_u *cmd,
1274 int do_in,
1275 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276{
1277 char_u *itmp = NULL;
1278 char_u *otmp = NULL;
1279 linenr_T linecount;
1280 linenr_T read_linecount;
1281 pos_T cursor_save;
1282 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001284 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
1286 if (*cmd == NUL) /* no filter command */
1287 return;
1288
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 cursor_save = curwin->w_cursor;
1290 linecount = line2 - line1 + 1;
1291 curwin->w_cursor.lnum = line1;
1292 curwin->w_cursor.col = 0;
1293 changed_line_abv_curs();
1294 invalidate_botline();
1295
1296 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001297 * When using temp files:
1298 * 1. * Form temp file names
1299 * 2. * Write the lines to a temp file
1300 * 3. Run the filter command on the temp file
1301 * 4. * Read the output of the command into the buffer
1302 * 5. * Delete the original lines to be filtered
1303 * 6. * Remove the temp files
1304 *
1305 * When writing the input with a pipe or when catching the output with a
1306 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 */
1308
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001309 if (do_out)
1310 shell_flags |= SHELL_DOOUT;
1311
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001312#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001315 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1316 shell_flags |= SHELL_READ;
1317 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001319 else if (do_in && !do_out && !p_stmp)
1320 {
1321 /* Use a pipe to write stdin of the command, do not use a temp file. */
1322 shell_flags |= SHELL_WRITE;
1323 curbuf->b_op_start.lnum = line1;
1324 curbuf->b_op_end.lnum = line2;
1325 }
1326 else if (do_in && do_out && !p_stmp)
1327 {
1328 /* Use a pipe to write stdin and fetch stdout of the command, do not
1329 * use a temp file. */
1330 shell_flags |= SHELL_READ|SHELL_WRITE;
1331 curbuf->b_op_start.lnum = line1;
1332 curbuf->b_op_end.lnum = line2;
1333 curwin->w_cursor.lnum = line2;
1334 }
1335 else
1336#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001337 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1338 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001339 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001340 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001341 goto filterend;
1342 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343
1344/*
1345 * The writing and reading of temp files will not be shown.
1346 * Vi also doesn't do this and the messages are not very informative.
1347 */
1348 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001349 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 FALSE, FALSE, FALSE, TRUE) == FAIL)
1351 {
1352 msg_putchar('\n'); /* keep message from buf_write() */
1353 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001354#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 if (!aborting())
1356#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001357 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 goto filterend;
1359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 if (curbuf != old_curbuf)
1361 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 if (!do_out)
1364 msg_putchar('\n');
1365
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001366 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1368 if (cmd_buf == NULL)
1369 goto filterend;
1370
1371 windgoto((int)Rows - 1, 0);
1372 cursor_on();
1373
1374 /*
1375 * When not redirecting the output the command can write anything to the
1376 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1377 * stderr output of external command. Clear the screen later.
1378 * If do_in is FALSE, this could be something like ":r !cat", which may
1379 * also mess up the screen, clear it later.
1380 */
1381 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1382 redraw_later_clear();
1383
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001384 if (do_out)
1385 {
1386 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001387 {
1388 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001389 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001390 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001391 redraw_curbuf_later(VALID);
1392 }
1393 read_linecount = curbuf->b_ml.ml_line_count;
1394
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 /*
1396 * When call_shell() fails wait_return() is called to give the user a
1397 * chance to read the error messages. Otherwise errors are ignored, so you
1398 * can see the error messages from the command that appear on stdout; use
1399 * 'u' to fix the text
1400 * Switch to cooked mode when not redirecting stdin, avoids that something
1401 * like ":r !cat" hangs.
1402 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1403 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001404 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 {
1406 redraw_later_clear();
1407 wait_return(FALSE);
1408 }
1409 vim_free(cmd_buf);
1410
1411 did_check_timestamps = FALSE;
1412 need_check_timestamps = TRUE;
1413
1414 /* When interrupting the shell command, it may still have produced some
1415 * useful output. Reset got_int here, so that readfile() won't cancel
1416 * reading. */
1417 ui_breakcheck();
1418 got_int = FALSE;
1419
1420 if (do_out)
1421 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001422 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001424 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001425 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001427#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001428 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001430 {
1431 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001432 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001433 }
1434 goto error;
1435 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001436 if (curbuf != old_curbuf)
1437 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001438 }
1439
1440 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1441
1442 if (shell_flags & SHELL_READ)
1443 {
1444 curbuf->b_op_start.lnum = line2 + 1;
1445 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1446 appended_lines_mark(line2, read_linecount);
1447 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 if (do_in)
1450 {
1451 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1452 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 if (read_linecount >= linecount)
1454 /* move all marks from old lines to new lines */
1455 mark_adjust(line1, line2, linecount, 0L);
1456 else
1457 {
1458 /* move marks from old lines to new lines, delete marks
1459 * that are in deleted lines */
1460 mark_adjust(line1, line1 + read_linecount - 1,
1461 linecount, 0L);
1462 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1463 }
1464 }
1465
1466 /*
1467 * Put cursor on first filtered line for ":range!cmd".
1468 * Adjust '[ and '] (set by buf_write()).
1469 */
1470 curwin->w_cursor.lnum = line1;
1471 del_lines(linecount, TRUE);
1472 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1473 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1474 write_lnum_adjust(-linecount); /* adjust last line
1475 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001476#ifdef FEAT_FOLDING
1477 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1478#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 }
1480 else
1481 {
1482 /*
1483 * Put cursor on last new line for ":r !cmd".
1484 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001486 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001488
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1490 --no_wait_return;
1491
1492 if (linecount > p_report)
1493 {
1494 if (do_in)
1495 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001496 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001497 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001500 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 }
1502 else
1503 msgmore((long)linecount);
1504 }
1505 }
1506 else
1507 {
1508error:
1509 /* put cursor back in same position for ":w !cmd" */
1510 curwin->w_cursor = cursor_save;
1511 --no_wait_return;
1512 wait_return(FALSE);
1513 }
1514
1515filterend:
1516
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 if (curbuf != old_curbuf)
1518 {
1519 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001520 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 if (itmp != NULL)
1523 mch_remove(itmp);
1524 if (otmp != NULL)
1525 mch_remove(otmp);
1526 vim_free(itmp);
1527 vim_free(otmp);
1528}
1529
1530/*
1531 * Call a shell to execute a command.
1532 * When "cmd" is NULL start an interactive shell.
1533 */
1534 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001535do_shell(
1536 char_u *cmd,
1537 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538{
1539 buf_T *buf;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001540#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 int save_nwr;
1542#endif
1543#ifdef MSWIN
1544 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001545 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546#endif
1547
1548 /*
1549 * Disallow shell commands for "rvim".
1550 * Disallow shell commands from .exrc and .vimrc in current directory for
1551 * security reasons.
1552 */
1553 if (check_restricted() || check_secure())
1554 {
1555 msg_end();
1556 return;
1557 }
1558
1559#ifdef MSWIN
1560 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001561 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 */
1563 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001564 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1565
1566# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1567 // Don't stop termcap mode when using a terminal window for the shell.
1568 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1569 keep_termcap = TRUE;
1570# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571#endif
1572
1573 /*
1574 * For autocommands we want to get the output on the current screen, to
1575 * avoid having to type return below.
1576 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001577 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 {
1580#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001581 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582#endif
1583 stoptermcap();
1584 }
1585#ifdef MSWIN
1586 if (!winstart)
1587#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001588 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589
Bram Moolenaar049ca592019-03-17 16:59:44 +01001590 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001591 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001592 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001593 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 {
1595#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001596 if (!keep_termcap)
1597 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001599 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001601 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 stoptermcap();
1603#endif
1604 break;
1605 }
1606
Bram Moolenaar049ca592019-03-17 16:59:44 +01001607 // This windgoto is required for when the '\n' resulted in a "delete line
1608 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 if (!swapping_screen())
1610 windgoto(msg_row, msg_col);
1611 cursor_on();
1612 (void)call_shell(cmd, SHELL_COOKED | flags);
1613 did_check_timestamps = FALSE;
1614 need_check_timestamps = TRUE;
1615
1616 /*
1617 * put the message cursor at the end of the screen, avoids wait_return()
1618 * to overwrite the text that the external command showed
1619 */
1620 if (!swapping_screen())
1621 {
1622 msg_row = Rows - 1;
1623 msg_col = 0;
1624 }
1625
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 if (autocmd_busy)
1627 {
1628 if (msg_silent == 0)
1629 redraw_later_clear();
1630 }
1631 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 {
1633 /*
1634 * For ":sh" there is no need to call wait_return(), just redraw.
1635 * Also for the Win32 GUI (the output is in a console window).
1636 * Otherwise there is probably text on the screen that the user wants
1637 * to read before redrawing, so call wait_return().
1638 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001639#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1640# ifdef VIMDLL
1641 if (!gui.in_use)
1642# endif
1643 {
1644 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001645# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001646 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001648 )
1649 {
1650 if (msg_silent == 0)
1651 redraw_later_clear();
1652 need_wait_return = FALSE;
1653 }
1654 else
1655 {
1656 /*
1657 * If we switch screens when starttermcap() is called, we
1658 * really want to wait for "hit return to continue".
1659 */
1660 save_nwr = no_wait_return;
1661 if (swapping_screen())
1662 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001664 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001666 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001668 no_wait_return = save_nwr;
1669 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001671#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001674 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001676 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677
1678 /*
1679 * In an Amiga window redrawing is caused by asking the window size.
1680 * If we got an interrupt this will not work. The chance that the
1681 * window size is wrong is very small, but we need to redraw the
1682 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1683 * but it saves an extra redraw.
1684 */
1685#ifdef AMIGA
1686 if (skip_redraw) /* ':' hit in wait_return() */
1687 {
1688 if (msg_silent == 0)
1689 redraw_later_clear();
1690 }
1691 else if (term_console)
1692 {
1693 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1694 if (got_int && msg_silent == 0)
1695 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1696 else
1697 must_redraw = 0; /* no extra redraw needed */
1698 }
1699#endif
1700 }
1701
1702 /* display any error messages now */
1703 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001704
Bram Moolenaarade00832006-03-10 21:46:58 +00001705 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706}
1707
Bram Moolenaar06640892018-10-09 21:49:33 +02001708#if !defined(UNIX)
1709 static char_u *
1710find_pipe(char_u *cmd)
1711{
1712 char_u *p;
1713 int inquote = FALSE;
1714
1715 for (p = cmd; *p != NUL; ++p)
1716 {
1717 if (!inquote && *p == '|')
1718 return p;
1719 if (*p == '"')
1720 inquote = !inquote;
1721 else if (rem_backslash(p))
1722 ++p;
1723 }
1724 return NULL;
1725}
1726#endif
1727
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728/*
1729 * Create a shell command from a command string, input redirection file and
1730 * output redirection file.
1731 * Returns an allocated string with the shell command, or NULL for failure.
1732 */
1733 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001734make_filter_cmd(
1735 char_u *cmd, /* command */
1736 char_u *itmp, /* NULL or name of input file */
1737 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738{
1739 char_u *buf;
1740 long_u len;
1741
Bram Moolenaar53076832015-12-31 19:53:21 +01001742#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001743 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001744 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001745
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001746 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001747 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1748 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001749 if (is_fish_shell)
1750 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1751 else
1752#endif
1753 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 if (itmp != NULL)
1755 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1756 if (otmp != NULL)
1757 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1758 buf = lalloc(len, TRUE);
1759 if (buf == NULL)
1760 return NULL;
1761
Bram Moolenaar53076832015-12-31 19:53:21 +01001762#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001764 * Put braces around the command (for concatenated commands) when
1765 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001767 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001768 {
1769 if (is_fish_shell)
1770 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1771 else
1772 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1773 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001774 else
1775 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 if (itmp != NULL)
1777 {
1778 STRCAT(buf, " < ");
1779 STRCAT(buf, itmp);
1780 }
1781#else
1782 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001783 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 * the use of commands in a pipe.
1785 */
1786 STRCPY(buf, cmd);
1787 if (itmp != NULL)
1788 {
1789 char_u *p;
1790
1791 /*
1792 * If there is a pipe, we have to put the '<' in front of it.
1793 * Don't do this when 'shellquote' is not empty, otherwise the
1794 * redirection would be inside the quotes.
1795 */
1796 if (*p_shq == NUL)
1797 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001798 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 if (p != NULL)
1800 *p = NUL;
1801 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1803 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 if (*p_shq == NUL)
1805 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001806 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 if (p != NULL)
1808 {
1809 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1810 STRCAT(buf, p);
1811 }
1812 }
1813 }
1814#endif
1815 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001816 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 return buf;
1819}
1820
1821/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001822 * Append output redirection for file "fname" to the end of string buffer
1823 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 * Works with the 'shellredir' and 'shellpipe' options.
1825 * The caller should make sure that there is enough room:
1826 * STRLEN(opt) + STRLEN(fname) + 3
1827 */
1828 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001829append_redir(
1830 char_u *buf,
1831 int buflen,
1832 char_u *opt,
1833 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834{
1835 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001836 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001838 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001839 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001841 {
1842 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001844 if (p[1] == '%') /* skip %% */
1845 ++p;
1846 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 if (p != NULL)
1848 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001849 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1850 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1851 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 }
1853 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001854 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 " %s %s",
1857#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859#endif
1860 (char *)opt, (char *)fname);
1861}
1862
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001863#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001865static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001866static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001867static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868static int viminfo_errcnt;
1869
1870 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001871no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872{
1873 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001874 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875}
1876
1877/*
1878 * Report an error for reading a viminfo file.
1879 * Count the number of errors. When there are more than 10, return TRUE.
1880 */
1881 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001882viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001884 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1885 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001886 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001887 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1888 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001889 emsg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 if (++viminfo_errcnt >= 10)
1891 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001892 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 return TRUE;
1894 }
1895 return FALSE;
1896}
1897
1898/*
1899 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001900 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 */
1902 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001903read_viminfo(
1904 char_u *file, /* file name or NULL to use default name */
1905 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906{
1907 FILE *fp;
1908 char_u *fname;
1909
1910 if (no_viminfo())
1911 return FAIL;
1912
Bram Moolenaard812df62008-11-09 12:46:09 +00001913 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 if (fname == NULL)
1915 return FAIL;
1916 fp = mch_fopen((char *)fname, READBIN);
1917
1918 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001919 {
1920 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001921 smsg(_("Reading viminfo file \"%s\"%s%s%s"),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001922 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001923 (flags & VIF_WANT_INFO) ? _(" info") : "",
1924 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1925 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001926 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001927 verbose_leave();
1928 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929
1930 vim_free(fname);
1931 if (fp == NULL)
1932 return FAIL;
1933
1934 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001935 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936
1937 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 return OK;
1939}
1940
1941/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001942 * Write the viminfo file. The old one is read in first so that effectively a
1943 * merge of current info and old info is done. This allows multiple vims to
1944 * run simultaneously, without losing any marks etc.
1945 * If "forceit" is TRUE, then the old file is not read in, and only internal
1946 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 */
1948 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001949write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950{
1951 char_u *fname;
1952 FILE *fp_in = NULL; /* input viminfo file, if any */
1953 FILE *fp_out = NULL; /* output viminfo file */
1954 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001955 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956#if defined(UNIX) || defined(VMS)
1957 mode_t umask_save;
1958#endif
1959#ifdef UNIX
1960 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001961 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001963#ifdef MSWIN
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001964 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001965#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966
1967 if (no_viminfo())
1968 return;
1969
1970 fname = viminfo_filename(file); /* may set to default if NULL */
1971 if (fname == NULL)
1972 return;
1973
1974 fp_in = mch_fopen((char *)fname, READBIN);
1975 if (fp_in == NULL)
1976 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001977 int fd;
1978
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 /* if it does exist, but we can't read it, don't try writing */
1980 if (mch_stat((char *)fname, &st_new) == 0)
1981 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001982
1983 /* Create the new .viminfo non-accessible for others, because it may
1984 * contain text from non-accessible documents. It is up to the user to
1985 * widen access (e.g. to a group). This may also fail if there is a
1986 * race condition, then just give up. */
1987 fd = mch_open((char *)fname,
1988 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1989 if (fd < 0)
1990 goto end;
1991 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 }
1993 else
1994 {
1995 /*
1996 * There is an existing viminfo file. Create a temporary file to
1997 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001998 * existing viminfo file, which will be renamed once all writing is
1999 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 */
2001#ifdef UNIX
2002 /*
2003 * For Unix we check the owner of the file. It's not very nice to
2004 * overwrite a user's viminfo file after a "su root", with a
2005 * viminfo file that the user can't read.
2006 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00002007 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00002008 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00002010 if (mch_stat((char *)fname, &st_old) == 0
2011 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00002012 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 ? (st_old.st_mode & 0200)
2014 : (st_old.st_gid == getgid()
2015 ? (st_old.st_mode & 0020)
2016 : (st_old.st_mode & 0002))))
2017 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00002018 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002021 semsg(_("E137: Viminfo file is not writable: %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002023 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 goto end;
2025 }
2026#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002027#ifdef MSWIN
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002028 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01002029 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002030#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
2032 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002033 * Make tempname, find one that does not exist yet.
2034 * Beware of a race condition: If someone logs out and all Vim
2035 * instances exit at the same time a temp file might be created between
2036 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 * May try twice: Once normal and once with shortname set, just in
2038 * case somebody puts his viminfo file in an 8.3 filesystem.
2039 */
2040 for (;;)
2041 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002042 int next_char = 'z';
2043 char_u *wp;
2044
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 tempname = buf_modname(
2046#ifdef UNIX
2047 shortname,
2048#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050#endif
2051 fname,
2052#ifdef VMS
2053 (char_u *)"-tmp",
2054#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056#endif
2057 FALSE);
2058 if (tempname == NULL) /* out of memory */
2059 break;
2060
2061 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002062 * Try a series of names. Change one character, just before
2063 * the extension. This should also work for an 8.3
2064 * file name, when after adding the extension it still is
2065 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002067 wp = tempname + STRLEN(tempname) - 5;
2068 if (wp < gettail(tempname)) /* empty file name? */
2069 wp = gettail(tempname);
2070 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002072 /*
2073 * Check if tempfile already exists. Never overwrite an
2074 * existing file!
2075 */
2076 if (mch_stat((char *)tempname, &st_new) == 0)
2077 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002080 * Check if tempfile is same as original file. May happen
2081 * when modname() gave the same file back. E.g. silly
2082 * link, or file name-length reached. Try again with
2083 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002085 if (!shortname && st_new.st_dev == st_old.st_dev
2086 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01002088 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002089 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 break;
2091 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002092#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002094 else
2095 {
2096 /* Try creating the file exclusively. This may fail if
2097 * another Vim tries to do it at the same time. */
2098#ifdef VMS
2099 /* fdopen() fails for some reason */
2100 umask_save = umask(077);
2101 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2102 (void)umask(umask_save);
2103#else
2104 int fd;
2105
2106 /* Use mch_open() to be able to use O_NOFOLLOW and set file
2107 * protection:
2108 * Unix: same as original file, but strip s-bit. Reset
2109 * umask to avoid it getting in the way.
2110 * Others: r&w for user only. */
2111# ifdef UNIX
2112 umask_save = umask(0);
2113 fd = mch_open((char *)tempname,
2114 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
2115 (int)((st_old.st_mode & 0777) | 0600));
2116 (void)umask(umask_save);
2117# else
2118 fd = mch_open((char *)tempname,
2119 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
2120# endif
2121 if (fd < 0)
2122 {
2123 fp_out = NULL;
2124# ifdef EEXIST
2125 /* Avoid trying lots of names while the problem is lack
Bram Moolenaar94747162019-02-10 21:55:26 +01002126 * of permission, only retry if the file already
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002127 * exists. */
2128 if (errno != EEXIST)
2129 break;
2130# endif
2131 }
2132 else
2133 fp_out = fdopen(fd, WRITEBIN);
2134#endif /* VMS */
2135 if (fp_out != NULL)
2136 break;
2137 }
2138
2139 /* Assume file exists, try again with another name. */
2140 if (next_char == 'a' - 1)
2141 {
2142 /* They all exist? Must be something wrong! Don't write
2143 * the viminfo file then. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002144 semsg(_("E929: Too many viminfo temp files, like %s!"),
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002145 tempname);
2146 break;
2147 }
2148 *wp = next_char;
2149 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002151
2152 if (tempname != NULL)
2153 break;
2154 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 }
2156
Bram Moolenaara5792f52005-11-23 21:25:05 +00002157#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002158 if (tempname != NULL && fp_out != NULL)
2159 {
2160 stat_T tmp_st;
2161
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002163 * Make sure the original owner can read/write the tempfile and
2164 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002166 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002167 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002168 if (st_old.st_uid != tmp_st.st_uid)
2169 /* Changing the owner might fail, in which case the
2170 * file will now owned by the current user, oh well. */
Bram Moolenaar42335f52018-09-13 15:33:43 +02002171 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002172 if (st_old.st_gid != tmp_st.st_gid
2173 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2174 /* can't set the group to what it should be, remove
2175 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002176 (void)mch_setperm(tempname, 0600);
2177 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002178 else
2179 /* can't stat the file, set conservative permissions */
2180 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002182#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002183 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184
2185 /*
2186 * Check if the new viminfo file can be written to.
2187 */
2188 if (fp_out == NULL)
2189 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002190 semsg(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002191 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 if (fp_in != NULL)
2193 fclose(fp_in);
2194 goto end;
2195 }
2196
2197 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002198 {
2199 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002200 smsg(_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002201 verbose_leave();
2202 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203
2204 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002205 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206
Bram Moolenaar927030a2016-03-15 18:23:55 +01002207 if (fclose(fp_out) == EOF)
2208 ++viminfo_errcnt;
2209
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 if (fp_in != NULL)
2211 {
2212 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002213
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002214 /* In case of an error keep the original viminfo file. Otherwise
2215 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002216 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002217 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002218 if (vim_rename(tempname, fname) == -1)
2219 {
2220 ++viminfo_errcnt;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002221 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
Bram Moolenaar927030a2016-03-15 18:23:55 +01002222 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002223# ifdef MSWIN
Bram Moolenaar927030a2016-03-15 18:23:55 +01002224 /* If the viminfo file was hidden then also hide the new file. */
2225 else if (hidden)
2226 mch_hide(fname);
2227# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002228 }
2229 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 mch_remove(tempname);
2231 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002232
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233end:
2234 vim_free(fname);
2235 vim_free(tempname);
2236}
2237
2238/*
2239 * Get the viminfo file name to use.
2240 * If "file" is given and not empty, use it (has already been expanded by
2241 * cmdline functions).
2242 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2243 * expand environment variables.
2244 * Returns an allocated string. NULL when out of memory.
2245 */
2246 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002247viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248{
2249 if (file == NULL || *file == NUL)
2250 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002251 if (*p_viminfofile != NUL)
2252 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2254 {
2255#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256# ifdef VMS
2257 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2258# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002259# ifdef MSWIN
2260 /* Use $VIM only if $HOME is the default "C:/". */
2261 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2262 && mch_getenv((char_u *)"HOME") == NULL)
2263# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002265# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266# endif
2267 {
2268 /* don't use $VIM when not available. */
2269 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2270 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2271 file = (char_u *)VIMINFO_FILE2;
2272 else
2273 file = (char_u *)VIMINFO_FILE;
2274 }
2275 else
2276#endif
2277 file = (char_u *)VIMINFO_FILE;
2278 }
2279 expand_env(file, NameBuff, MAXPATHL);
2280 file = NameBuff;
2281 }
2282 return vim_strsave(file);
2283}
2284
2285/*
2286 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2287 */
2288 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002289do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 int eof = FALSE;
2292 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002293 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002294 int do_copy_marks = FALSE;
2295 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296
2297 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2298 return;
2299 vir.vir_fd = fp_in;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002301 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002302 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303
2304 if (fp_in != NULL)
2305 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002306 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002307 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002308 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002309 {
2310 /* Registers and marks are read and kept separate from what
2311 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002312 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002313 prepare_viminfo_marks();
2314 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002315
Bram Moolenaard812df62008-11-09 12:46:09 +00002316 eof = read_viminfo_up_to_marks(&vir,
2317 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002318 merge = TRUE;
2319 }
2320 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 /* Skip info, find start of marks */
2322 while (!(eof = viminfo_readline(&vir))
2323 && vir.vir_line[0] != '>')
2324 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002325
2326 do_copy_marks = (flags &
2327 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002329
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 if (fp_out != NULL)
2331 {
2332 /* Write the info: */
2333 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2334 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002335 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002336 write_viminfo_version(fp_out);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002337 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 write_viminfo_search_pattern(fp_out);
2340 write_viminfo_sub_string(fp_out);
2341#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002342 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343#endif
2344 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002345 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346#ifdef FEAT_EVAL
2347 write_viminfo_varlist(fp_out);
2348#endif
2349 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002350 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002352 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002353
2354 if (do_copy_marks)
2355 ga_init2(&buflist, sizeof(buf_T *), 50);
2356 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002358
2359 if (do_copy_marks)
2360 {
2361 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2362 if (fp_out != NULL)
2363 ga_clear(&buflist);
2364 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 vim_free(vir.vir_line);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 if (vir.vir_conv.vc_type != CONV_NONE)
2368 convert_setup(&vir.vir_conv, NULL, NULL);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002369 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370}
2371
2372/*
2373 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2374 * first part of the viminfo file which contains everything but the marks that
2375 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2376 */
2377 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002378read_viminfo_up_to_marks(
2379 vir_T *virp,
2380 int forceit,
2381 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382{
2383 int eof;
2384 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002385 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386
2387#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002388 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002390
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 eof = viminfo_readline(virp);
2392 while (!eof && virp->vir_line[0] != '>')
2393 {
2394 switch (virp->vir_line[0])
2395 {
2396 /* Characters reserved for future expansion, ignored now */
2397 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 case '^': /* to be defined */
2399 case '<': /* long line - ignored */
2400 /* A comment or empty line. */
2401 case NUL:
2402 case '\r':
2403 case '\n':
2404 case '#':
2405 eof = viminfo_readline(virp);
2406 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002407 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002408 eof = read_viminfo_barline(virp, got_encoding,
2409 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002410 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002412 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 eof = viminfo_encoding(virp);
2414 break;
2415 case '!': /* global variable */
2416#ifdef FEAT_EVAL
2417 eof = read_viminfo_varlist(virp, writing);
2418#else
2419 eof = viminfo_readline(virp);
2420#endif
2421 break;
2422 case '%': /* entry for buffer list */
2423 eof = read_viminfo_bufferlist(virp, writing);
2424 break;
2425 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002426 /* When registers are in bar lines skip the old style register
2427 * lines. */
2428 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2429 eof = read_viminfo_register(virp, forceit);
2430 else
2431 do {
2432 eof = viminfo_readline(virp);
2433 } while (!eof && (virp->vir_line[0] == TAB
2434 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 break;
2436 case '/': /* Search string */
2437 case '&': /* Substitute search string */
2438 case '~': /* Last search string, followed by '/' or '&' */
2439 eof = read_viminfo_search_pattern(virp, forceit);
2440 break;
2441 case '$':
2442 eof = read_viminfo_sub_string(virp, forceit);
2443 break;
2444 case ':':
2445 case '?':
2446 case '=':
2447 case '@':
2448#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002449 /* When history is in bar lines skip the old style history
2450 * lines. */
2451 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2452 eof = read_viminfo_history(virp, writing);
2453 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002455 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 break;
2457 case '-':
2458 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002459 /* When file marks are in bar lines skip the old style lines. */
2460 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2461 eof = read_viminfo_filemark(virp, forceit);
2462 else
2463 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 break;
2465 default:
2466 if (viminfo_error("E575: ", _("Illegal starting char"),
2467 virp->vir_line))
2468 eof = TRUE;
2469 else
2470 eof = viminfo_readline(virp);
2471 break;
2472 }
2473 }
2474
2475#ifdef FEAT_CMDHIST
2476 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002477 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002478 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479#endif
2480
2481 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002482 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 fmarks_check_names(buf);
2484
2485 return eof;
2486}
2487
2488/*
2489 * Compare the 'encoding' value in the viminfo file with the current value of
2490 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2491 * conversion of text with iconv() in viminfo_readstring().
2492 */
2493 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002494viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 char_u *p;
2497 int i;
2498
2499 if (get_viminfo_parameter('c') != 0)
2500 {
2501 p = vim_strchr(virp->vir_line, '=');
2502 if (p != NULL)
2503 {
2504 /* remove trailing newline */
2505 ++p;
2506 for (i = 0; vim_isprintc(p[i]); ++i)
2507 ;
2508 p[i] = NUL;
2509
2510 convert_setup(&virp->vir_conv, p, p_enc);
2511 }
2512 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 return viminfo_readline(virp);
2514}
2515
2516/*
2517 * Read a line from the viminfo file.
2518 * Returns TRUE for end-of-file;
2519 */
2520 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002521viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522{
2523 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2524}
2525
2526/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002527 * Check string read from viminfo file.
2528 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 * - replace CTRL-V CTRL-V with CTRL-V
2530 * - replace CTRL-V 'n' with '\n'
2531 *
2532 * Check for a long line as written by viminfo_writestring().
2533 *
2534 * Return the string in allocated memory (NULL when out of memory).
2535 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002537viminfo_readstring(
2538 vir_T *virp,
2539 int off, /* offset for virp->vir_line */
2540 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541{
2542 char_u *retval;
2543 char_u *s, *d;
2544 long len;
2545
2546 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2547 {
2548 len = atol((char *)virp->vir_line + off + 1);
2549 retval = lalloc(len, TRUE);
2550 if (retval == NULL)
2551 {
2552 /* Line too long? File messed up? Skip next line. */
2553 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2554 return NULL;
2555 }
2556 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2557 s = retval + 1; /* Skip the leading '<' */
2558 }
2559 else
2560 {
2561 retval = vim_strsave(virp->vir_line + off);
2562 if (retval == NULL)
2563 return NULL;
2564 s = retval;
2565 }
2566
2567 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2568 d = retval;
2569 while (*s != NUL && *s != '\n')
2570 {
2571 if (s[0] == Ctrl_V && s[1] != NUL)
2572 {
2573 if (s[1] == 'n')
2574 *d++ = '\n';
2575 else
2576 *d++ = Ctrl_V;
2577 s += 2;
2578 }
2579 else
2580 *d++ = *s++;
2581 }
2582 *d = NUL;
2583
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2585 {
2586 d = string_convert(&virp->vir_conv, retval, NULL);
2587 if (d != NULL)
2588 {
2589 vim_free(retval);
2590 retval = d;
2591 }
2592 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 return retval;
2595}
2596
2597/*
2598 * write string to viminfo file
2599 * - replace CTRL-V with CTRL-V CTRL-V
2600 * - replace '\n' with CTRL-V 'n'
2601 * - add a '\n' at the end
2602 *
2603 * For a long line:
2604 * - write " CTRL-V <length> \n " in first line
2605 * - write " < <string> \n " in second line
2606 */
2607 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002608viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609{
2610 int c;
2611 char_u *s;
2612 int len = 0;
2613
2614 for (s = p; *s != NUL; ++s)
2615 {
2616 if (*s == Ctrl_V || *s == '\n')
2617 ++len;
2618 ++len;
2619 }
2620
2621 /* If the string will be too long, write its length and put it in the next
2622 * line. Take into account that some room is needed for what comes before
2623 * the string (e.g., variable name). Add something to the length for the
2624 * '<', NL and trailing NUL. */
2625 if (len > LSIZE / 2)
2626 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2627
2628 while ((c = *p++) != NUL)
2629 {
2630 if (c == Ctrl_V || c == '\n')
2631 {
2632 putc(Ctrl_V, fd);
2633 if (c == '\n')
2634 c = 'n';
2635 }
2636 putc(c, fd);
2637 }
2638 putc('\n', fd);
2639}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002640
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002641/*
2642 * Write a string in quotes that barline_parse() can read back.
2643 * Breaks the line in less than LSIZE pieces when needed.
2644 * Returns remaining characters in the line.
2645 */
2646 int
2647barline_writestring(FILE *fd, char_u *s, int remaining_start)
2648{
2649 char_u *p;
2650 int remaining = remaining_start;
2651 int len = 2;
2652
2653 /* Count the number of characters produced, including quotes. */
2654 for (p = s; *p != NUL; ++p)
2655 {
2656 if (*p == NL)
2657 len += 2;
2658 else if (*p == '"' || *p == '\\')
2659 len += 2;
2660 else
2661 ++len;
2662 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002663 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002664 {
2665 fprintf(fd, ">%d\n|<", len);
2666 remaining = LSIZE - 20;
2667 }
2668
2669 putc('"', fd);
2670 for (p = s; *p != NUL; ++p)
2671 {
2672 if (*p == NL)
2673 {
2674 putc('\\', fd);
2675 putc('n', fd);
2676 --remaining;
2677 }
2678 else if (*p == '"' || *p == '\\')
2679 {
2680 putc('\\', fd);
2681 putc(*p, fd);
2682 --remaining;
2683 }
2684 else
2685 putc(*p, fd);
2686 --remaining;
2687
2688 if (remaining < 3)
2689 {
2690 putc('\n', fd);
2691 putc('|', fd);
2692 putc('<', fd);
2693 /* Leave enough space for another continuation. */
2694 remaining = LSIZE - 20;
2695 }
2696 }
2697 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002698 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002699}
2700
2701/*
2702 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002703 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002704 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002705 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002706 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002707barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002708{
2709 char_u *p = text;
2710 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002711 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002712 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002713 int i;
2714 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002715 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002716 char_u *sconv;
2717 int converted;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002718
2719 while (*p == ',')
2720 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002721 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002722 if (ga_grow(values, 1) == FAIL)
2723 break;
2724 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002725
2726 if (*p == '>')
2727 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002728 /* Need to read a continuation line. Put strings in allocated
2729 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002730 if (!allocated)
2731 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002732 for (i = 0; i < values->ga_len; ++i)
2733 {
2734 bval_T *vp = (bval_T *)(values->ga_data) + i;
2735
2736 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002738 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2739 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002740 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002741 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002742 allocated = TRUE;
2743 }
2744
2745 if (vim_isdigit(p[1]))
2746 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002747 size_t len;
2748 size_t todo;
2749 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002750
2751 /* String value was split into lines that are each shorter
2752 * than LSIZE:
2753 * |{bartype},>{length of "{text}{text2}"}
2754 * |<"{text1}
2755 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002756 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002757 */
2758 ++p;
2759 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002760 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002761 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002762 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002763 p = buf;
2764 for (todo = len; todo > 0; todo -= n)
2765 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002766 eof = viminfo_readline(virp);
2767 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002768 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002769 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002770 /* File was truncated or garbled. Read another line if
2771 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002772 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002773 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002774 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002775 /* Get length of text, excluding |< and NL chars. */
2776 n = STRLEN(virp->vir_line);
2777 while (n > 0 && (virp->vir_line[n - 1] == NL
2778 || virp->vir_line[n - 1] == CAR))
2779 --n;
2780 n -= 2;
2781 if (n > todo)
2782 {
2783 /* more values follow after the string */
2784 nextp = virp->vir_line + 2 + todo;
2785 n = todo;
2786 }
2787 mch_memmove(p, virp->vir_line + 2, n);
2788 p += n;
2789 }
2790 *p = NUL;
2791 p = buf;
2792 }
2793 else
2794 {
2795 /* Line ending in ">" continues in the next line:
2796 * |{bartype},{lots of values},>
2797 * |<{value},{value}
2798 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002799 eof = viminfo_readline(virp);
2800 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002801 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002802 /* File was truncated or garbled. Read another line if
2803 * this one starts with '|'. */
2804 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002805 p = virp->vir_line + 2;
2806 }
2807 }
2808
2809 if (isdigit(*p))
2810 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002811 value->bv_type = BVAL_NR;
2812 value->bv_nr = getdigits(&p);
2813 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002814 }
2815 else if (*p == '"')
2816 {
2817 int len = 0;
2818 char_u *s = p;
2819
2820 /* Unescape special characters in-place. */
2821 ++p;
2822 while (*p != '"')
2823 {
2824 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002825 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002826 if (*p == '\\')
2827 {
2828 ++p;
2829 if (*p == 'n')
2830 s[len++] = '\n';
2831 else
2832 s[len++] = *p;
2833 ++p;
2834 }
2835 else
2836 s[len++] = *p++;
2837 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002838 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002839 s[len] = NUL;
2840
Bram Moolenaar01227092016-06-11 14:47:40 +02002841 converted = FALSE;
2842 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2843 {
2844 sconv = string_convert(&virp->vir_conv, s, NULL);
2845 if (sconv != NULL)
2846 {
2847 if (s == buf)
2848 vim_free(s);
2849 s = sconv;
2850 buf = s;
2851 converted = TRUE;
2852 }
2853 }
Bram Moolenaar13505972019-01-24 15:04:48 +01002854
Bram Moolenaar01227092016-06-11 14:47:40 +02002855 /* Need to copy in allocated memory if the string wasn't allocated
2856 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002857 if (s != buf && allocated)
2858 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002859 value->bv_string = s;
2860 value->bv_type = BVAL_STRING;
2861 value->bv_len = len;
Bram Moolenaar13505972019-01-24 15:04:48 +01002862 value->bv_allocated = allocated || converted;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002863 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002864 if (nextp != NULL)
2865 {
2866 /* values following a long string */
2867 p = nextp;
2868 nextp = NULL;
2869 }
2870 }
2871 else if (*p == ',')
2872 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002873 value->bv_type = BVAL_EMPTY;
2874 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002875 }
2876 else
2877 break;
2878 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002879 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002880}
2881
2882 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002883read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002884{
2885 char_u *p = virp->vir_line + 1;
2886 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002887 garray_T values;
2888 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002889 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002890 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002891
2892 /* The format is: |{bartype},{value},...
2893 * For a very long string:
2894 * |{bartype},>{length of "{text}{text2}"}
2895 * |<{text1}
2896 * |<{text2},{value}
2897 * For a long line not using a string
2898 * |{bartype},{lots of values},>
2899 * |<{value},{value}
2900 */
2901 if (*p == '<')
2902 {
2903 /* Continuation line of an unrecognized item. */
2904 if (writing)
2905 ga_add_string(&virp->vir_barlines, virp->vir_line);
2906 }
2907 else
2908 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002909 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002910 bartype = getdigits(&p);
2911 switch (bartype)
2912 {
2913 case BARTYPE_VERSION:
2914 /* Only use the version when it comes before the encoding.
2915 * If it comes later it was copied by a Vim version that
2916 * doesn't understand the version. */
2917 if (!got_encoding)
2918 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002919 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002920 vp = (bval_T *)values.ga_data;
2921 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2922 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002923 }
2924 break;
2925
2926 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002927 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002928 handle_viminfo_history(&values, writing);
2929 break;
2930
2931 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002932 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002933 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002934 break;
2935
Bram Moolenaar2d358992016-06-12 21:20:54 +02002936 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002937 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002938 handle_viminfo_mark(&values, force);
2939 break;
2940
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002941 default:
2942 /* copy unrecognized line (for future use) */
2943 if (writing)
2944 ga_add_string(&virp->vir_barlines, virp->vir_line);
2945 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002946 for (i = 0; i < values.ga_len; ++i)
2947 {
2948 vp = (bval_T *)values.ga_data + i;
2949 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2950 vim_free(vp->bv_string);
2951 }
2952 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002953 }
2954
Bram Moolenaarecefe712016-06-20 12:50:17 +02002955 if (read_next)
2956 return viminfo_readline(virp);
2957 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002958}
2959
2960 static void
2961write_viminfo_version(FILE *fp_out)
2962{
2963 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2964 BARTYPE_VERSION, VIMINFO_VERSION);
2965}
2966
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002967 static void
2968write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2969{
2970 int i;
2971 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002972 int seen_useful = FALSE;
2973 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002974
2975 if (gap->ga_len > 0)
2976 {
2977 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2978
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002979 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002980 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002981 {
2982 line = ((char **)(gap->ga_data))[i];
2983 if (seen_useful || line[1] != '<')
2984 {
2985 fputs(line, fp_out);
2986 seen_useful = TRUE;
2987 }
2988 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002989 }
2990}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991#endif /* FEAT_VIMINFO */
2992
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002993/*
2994 * Return the current time in seconds. Calls time(), unless test_settime()
2995 * was used.
2996 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002997 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002998vim_time(void)
2999{
3000# ifdef FEAT_EVAL
3001 return time_for_testing == 0 ? time(NULL) : time_for_testing;
3002# else
3003 return time(NULL);
3004# endif
3005}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02003006
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007/*
3008 * Implementation of ":fixdel", also used by get_stty().
3009 * <BS> resulting <Del>
3010 * ^? ^H
3011 * not ^? ^?
3012 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003014do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015{
3016 char_u *p;
3017
3018 p = find_termcode((char_u *)"kb");
3019 add_termcode((char_u *)"kD", p != NULL
3020 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
3021}
3022
3023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003024print_line_no_prefix(
3025 linenr_T lnum,
3026 int use_number,
3027 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028{
Bram Moolenaar32526b32019-01-19 17:43:09 +01003029 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030
3031 if (curwin->w_p_nu || use_number)
3032 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01003033 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003034 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01003035 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003037 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038}
3039
3040/*
3041 * Print a text line. Also in silent mode ("ex -s").
3042 */
3043 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003044print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045{
3046 int save_silent = silent_mode;
3047
Bram Moolenaard29459b2016-08-26 22:29:11 +02003048 /* apply :filter /pat/ */
3049 if (message_filtered(ml_get(lnum)))
3050 return;
3051
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003053 silent_mode = FALSE;
3054 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
3055 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 if (save_silent)
3057 {
3058 msg_putchar('\n');
3059 cursor_on(); /* msg_start() switches it off */
3060 out_flush();
3061 silent_mode = save_silent;
3062 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00003063 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064}
3065
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003066 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003067rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003068{
3069 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02003070 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003071
Bram Moolenaar7e283842013-05-30 11:43:15 +02003072 buf = curbuf;
3073 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003074 /* buffer changed, don't change name now */
3075 if (buf != curbuf)
3076 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003077#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003078 if (aborting()) /* autocmds may abort script processing */
3079 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003080#endif
3081 /*
3082 * The name of the current buffer will be changed.
3083 * A new (unlisted) buffer entry needs to be made to hold the old file
3084 * name, which will become the alternate file name.
3085 * But don't set the alternate file name if the buffer didn't have a
3086 * name.
3087 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02003088 fname = curbuf->b_ffname;
3089 sfname = curbuf->b_sfname;
3090 xfname = curbuf->b_fname;
3091 curbuf->b_ffname = NULL;
3092 curbuf->b_sfname = NULL;
3093 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003094 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02003095 curbuf->b_ffname = fname;
3096 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003097 return FAIL;
3098 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02003099 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003100 if (xfname != NULL && *xfname != NUL)
3101 {
3102 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
3103 if (buf != NULL && !cmdmod.keepalt)
3104 curwin->w_alt_fnum = buf->b_fnum;
3105 }
3106 vim_free(fname);
3107 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02003108 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003109
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003110 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003111 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003112 return OK;
3113}
3114
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115/*
3116 * ":file[!] [fname]".
3117 */
3118 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003119ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003121 /* ":0file" removes the file name. Check for illegal uses ":3file",
3122 * "0file name", etc. */
3123 if (eap->addr_count > 0
3124 && (*eap->arg != NUL
3125 || eap->line2 > 0
3126 || eap->addr_count > 1))
3127 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003128 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003129 return;
3130 }
3131
3132 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003134 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02003136 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02003138
3139 // print file name if no argument or 'F' is not in 'shortmess'
3140 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01003141 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142}
3143
3144/*
3145 * ":update".
3146 */
3147 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003148ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149{
3150 if (curbufIsChanged())
3151 (void)do_write(eap);
3152}
3153
3154/*
3155 * ":write" and ":saveas".
3156 */
3157 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003158ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159{
3160 if (eap->usefilter) /* input lines to shell command */
3161 do_bang(1, eap, FALSE, TRUE, FALSE);
3162 else
3163 (void)do_write(eap);
3164}
3165
3166/*
3167 * write current buffer to file 'eap->arg'
3168 * if 'eap->append' is TRUE, append to the file
3169 *
3170 * if *eap->arg == NUL write to current file
3171 *
3172 * return FAIL for failure, OK otherwise
3173 */
3174 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003175do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176{
3177 int other;
3178 char_u *fname = NULL; /* init to shut up gcc */
3179 char_u *ffname;
3180 int retval = FAIL;
3181 char_u *free_fname = NULL;
3182#ifdef FEAT_BROWSE
3183 char_u *browse_file = NULL;
3184#endif
3185 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003186 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
3188 if (not_writing()) /* check 'write' option */
3189 return FAIL;
3190
3191 ffname = eap->arg;
3192#ifdef FEAT_BROWSE
3193 if (cmdmod.browse)
3194 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003195 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 NULL, NULL, NULL, curbuf);
3197 if (browse_file == NULL)
3198 goto theend;
3199 ffname = browse_file;
3200 }
3201#endif
3202 if (*ffname == NUL)
3203 {
3204 if (eap->cmdidx == CMD_saveas)
3205 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003206 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 goto theend;
3208 }
3209 other = FALSE;
3210 }
3211 else
3212 {
3213 fname = ffname;
3214 free_fname = fix_fname(ffname);
3215 /*
3216 * When out-of-memory, keep unexpanded file name, because we MUST be
3217 * able to write the file in this situation.
3218 */
3219 if (free_fname != NULL)
3220 ffname = free_fname;
3221 other = otherfile(ffname);
3222 }
3223
3224 /*
3225 * If we have a new file, put its name in the list of alternate file names.
3226 */
3227 if (other)
3228 {
3229 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3230 || eap->cmdidx == CMD_saveas)
3231 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3232 else
3233 alt_buf = buflist_findname(ffname);
3234 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3235 {
3236 /* Overwriting a file that is loaded in another buffer is not a
3237 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003238 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 goto theend;
3240 }
3241 }
3242
3243 /*
3244 * Writing to the current file is not allowed in readonly mode
3245 * and a file name is required.
3246 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3247 */
3248 if (!other && (
3249#ifdef FEAT_QUICKFIX
3250 bt_dontwrite_msg(curbuf) ||
3251#endif
3252 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3253 goto theend;
3254
3255 if (!other)
3256 {
3257 ffname = curbuf->b_ffname;
3258 fname = curbuf->b_fname;
3259 /*
3260 * Not writing the whole file is only allowed with '!'.
3261 */
3262 if ( (eap->line1 != 1
3263 || eap->line2 != curbuf->b_ml.ml_line_count)
3264 && !eap->forceit
3265 && !eap->append
3266 && !p_wa)
3267 {
3268#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3269 if (p_confirm || cmdmod.confirm)
3270 {
3271 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3272 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3273 goto theend;
3274 eap->forceit = TRUE;
3275 }
3276 else
3277#endif
3278 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003279 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 goto theend;
3281 }
3282 }
3283 }
3284
3285 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3286 {
3287 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3288 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 buf_T *was_curbuf = curbuf;
3290
3291 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003292 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003293#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003295#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003297#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 {
3299 /* buffer changed, don't change name now */
3300 retval = FAIL;
3301 goto theend;
3302 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 /* Exchange the file names for the current and the alternate
3304 * buffer. This makes it look like we are now editing the buffer
3305 * under the new name. Must be done before buf_write(), because
3306 * if there is no file name and 'cpo' contains 'F', it will set
3307 * the file name. */
3308 fname = alt_buf->b_fname;
3309 alt_buf->b_fname = curbuf->b_fname;
3310 curbuf->b_fname = fname;
3311 fname = alt_buf->b_ffname;
3312 alt_buf->b_ffname = curbuf->b_ffname;
3313 curbuf->b_ffname = fname;
3314 fname = alt_buf->b_sfname;
3315 alt_buf->b_sfname = curbuf->b_sfname;
3316 curbuf->b_sfname = fname;
3317 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003318
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003320 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 if (!alt_buf->b_p_bl)
3322 {
3323 alt_buf->b_p_bl = TRUE;
3324 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3325 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003326#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003328#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003330#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 {
3332 /* buffer changed, don't write the file */
3333 retval = FAIL;
3334 goto theend;
3335 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003336
3337 /* If 'filetype' was empty try detecting it now. */
3338 if (*curbuf->b_p_ft == NUL)
3339 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003340 if (au_has_group((char_u *)"filetypedetect"))
3341 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003342 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003343 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003344 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003345
3346 /* Autocommands may have changed buffer names, esp. when
3347 * 'autochdir' is set. */
3348 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 }
3350
Bram Moolenaar5c719942016-07-09 23:40:45 +02003351 name_was_missing = curbuf->b_ffname == NULL;
3352
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3354 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003355
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003356 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003357 if (eap->cmdidx == CMD_saveas)
3358 {
3359 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003360 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003361 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003362 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003363 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003364 }
3365
3366 /* Change directories when the 'acd' option is set and the file name
3367 * got changed or set. */
3368 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02003369 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 }
3371
3372theend:
3373#ifdef FEAT_BROWSE
3374 vim_free(browse_file);
3375#endif
3376 vim_free(free_fname);
3377 return retval;
3378}
3379
3380/*
3381 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3382 * BF_NEW or BF_READERR, check for overwriting current file.
3383 * May set eap->forceit if a dialog says it's OK to overwrite.
3384 * Return OK if it's OK, FAIL if it is not.
3385 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003386 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003387check_overwrite(
3388 exarg_T *eap,
3389 buf_T *buf,
3390 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003392 char_u *ffname, /* full path version of fname */
3393 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394{
3395 /*
3396 * write to other file or b_flags set or not writing the whole file:
3397 * overwriting only allowed with '!'
3398 */
3399 if ( (other
3400 || (buf->b_flags & BF_NOTEDITED)
3401 || ((buf->b_flags & BF_NEW)
3402 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3403 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003405#ifdef FEAT_QUICKFIX
3406 && !bt_nofile(buf)
3407#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 && vim_fexists(ffname))
3409 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003410 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003412#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003413 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003414 if (mch_isdir(ffname))
3415 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003416 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003417 return FAIL;
3418 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419#endif
3420#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003421 if (p_confirm || cmdmod.confirm)
3422 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003423 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003425 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3426 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3427 return FAIL;
3428 eap->forceit = TRUE;
3429 }
3430 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003432 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003433 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003434 return FAIL;
3435 }
3436 }
3437
3438 /* For ":w! filename" check that no swap file exists for "filename". */
3439 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003441 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003442 char_u *p;
3443 int r;
3444 char_u *swapname;
3445
3446 /* We only try the first entry in 'directory', without checking if
3447 * it's writable. If the "." directory is not writable the write
3448 * will probably fail anyway.
3449 * Use 'shortname' of the current buffer, since there is no buffer
3450 * for the written file. */
3451 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003452 {
3453 dir = alloc(5);
3454 if (dir == NULL)
3455 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003456 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003457 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003458 else
3459 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003460 dir = alloc(MAXPATHL);
3461 if (dir == NULL)
3462 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003463 p = p_dir;
3464 copy_option_part(&p, dir, MAXPATHL, ",");
3465 }
3466 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003467 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003468 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003469 if (r)
3470 {
3471#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3472 if (p_confirm || cmdmod.confirm)
3473 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003474 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003475
3476 dialog_msg(buff,
3477 _("Swap file \"%s\" exists, overwrite anyway?"),
3478 swapname);
3479 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3480 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003481 {
3482 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003483 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003484 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003485 eap->forceit = TRUE;
3486 }
3487 else
3488#endif
3489 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003490 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003491 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003492 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003493 return FAIL;
3494 }
3495 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003496 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 }
3498 }
3499 return OK;
3500}
3501
3502/*
3503 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3504 */
3505 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003506ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507{
3508 int i;
3509
3510 if (eap->cmd[1] == 'n')
3511 i = curwin->w_arg_idx + (int)eap->line2;
3512 else
3513 i = curwin->w_arg_idx - (int)eap->line2;
3514 eap->line1 = 1;
3515 eap->line2 = curbuf->b_ml.ml_line_count;
3516 if (do_write(eap) != FAIL)
3517 do_argfile(eap, i);
3518}
3519
3520/*
3521 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3522 */
3523 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003524do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525{
3526 buf_T *buf;
3527 int error = 0;
3528 int save_forceit = eap->forceit;
3529
3530 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3531 exiting = TRUE;
3532
Bram Moolenaar29323592016-07-24 22:04:11 +02003533 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003535#ifdef FEAT_TERMINAL
3536 if (exiting && term_job_running(buf->b_term))
3537 {
3538 no_write_message_nobang(buf);
3539 ++error;
3540 }
3541 else
3542#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003543 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 {
3545 /*
3546 * Check if there is a reason the buffer cannot be written:
3547 * 1. if the 'write' option is set
3548 * 2. if there is no file name (even after browsing)
3549 * 3. if the 'readonly' is set (even after a dialog)
3550 * 4. if overwriting is allowed (even after a dialog)
3551 */
3552 if (not_writing())
3553 {
3554 ++error;
3555 break;
3556 }
3557#ifdef FEAT_BROWSE
3558 /* ":browse wall": ask for file name if there isn't one */
3559 if (buf->b_ffname == NULL && cmdmod.browse)
3560 browse_save_fname(buf);
3561#endif
3562 if (buf->b_ffname == NULL)
3563 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003564 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 ++error;
3566 }
3567 else if (check_readonly(&eap->forceit, buf)
3568 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3569 FALSE) == FAIL)
3570 {
3571 ++error;
3572 }
3573 else
3574 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003575 bufref_T bufref;
3576
3577 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 if (buf_write_all(buf, eap->forceit) == FAIL)
3579 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003581 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 }
3584 eap->forceit = save_forceit; /* check_overwrite() may set it */
3585 }
3586 }
3587 if (exiting)
3588 {
3589 if (!error)
3590 getout(0); /* exit Vim */
3591 not_exiting();
3592 }
3593}
3594
3595/*
3596 * Check the 'write' option.
3597 * Return TRUE and give a message when it's not st.
3598 */
3599 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003600not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601{
3602 if (p_write)
3603 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003604 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 return TRUE;
3606}
3607
3608/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003609 * Check if a buffer is read-only (either 'readonly' option is set or file is
3610 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3611 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 */
3613 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003614check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003616 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003617
3618 /* Handle a file being readonly when the 'readonly' option is set or when
3619 * the file exists and permissions are read-only.
3620 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3621 * important for device checks but not here. */
3622 if (!*forceit && (buf->b_p_ro
3623 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3624 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 {
3626#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3627 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3628 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003629 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630
Bram Moolenaar5386a122007-06-28 20:02:32 +00003631 if (buf->b_p_ro)
3632 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3633 buf->b_fname);
3634 else
3635 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 +00003636 buf->b_fname);
3637
3638 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3639 {
3640 /* Set forceit, to force the writing of a readonly file */
3641 *forceit = TRUE;
3642 return FALSE;
3643 }
3644 else
3645 return TRUE;
3646 }
3647 else
3648#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003649 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003650 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003651 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003652 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00003653 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 return TRUE;
3655 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003656
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 return FALSE;
3658}
3659
3660/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003661 * Try to abandon the current file and edit a new or existing file.
3662 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003663 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003665 * Return:
3666 * GETFILE_ERROR for "normal" error,
3667 * GETFILE_NOT_WRITTEN for "not written" error,
3668 * GETFILE_SAME_FILE for success
3669 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 */
3671 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003672getfile(
3673 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003674 char_u *ffname_arg,
3675 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003676 int setpm,
3677 linenr_T lnum,
3678 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003680 char_u *ffname = ffname_arg;
3681 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 int other;
3683 int retval;
3684 char_u *free_me = NULL;
3685
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003686 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003687 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003688 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003689 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690
3691 if (fnum == 0)
3692 {
3693 /* make ffname full path, set sfname */
3694 fname_expand(curbuf, &ffname, &sfname);
3695 other = otherfile(ffname);
3696 free_me = ffname; /* has been allocated, free() later */
3697 }
3698 else
3699 other = (fnum != curbuf->b_fnum);
3700
3701 if (other)
3702 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003703 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3705 {
3706#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3707 if (p_confirm && p_write)
3708 dialog_changed(curbuf, FALSE);
3709 if (curbufIsChanged())
3710#endif
3711 {
3712 if (other)
3713 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003714 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003715 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 goto theend;
3717 }
3718 }
3719 if (other)
3720 --no_wait_return;
3721 if (setpm)
3722 setpcmark();
3723 if (!other)
3724 {
3725 if (lnum != 0)
3726 curwin->w_cursor.lnum = lnum;
3727 check_cursor_lnum();
3728 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003729 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 }
3731 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003732 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003733 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003734 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003736 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737
3738theend:
3739 vim_free(free_me);
3740 return retval;
3741}
3742
3743/*
3744 * start editing a new file
3745 *
3746 * fnum: file number; if zero use ffname/sfname
3747 * ffname: the file name
3748 * - full path if sfname used,
3749 * - any file name if sfname is NULL
3750 * - empty string to re-edit with the same file name (but may be
3751 * in a different directory)
3752 * - NULL to start an empty buffer
3753 * sfname: the short file name (or NULL)
3754 * eap: contains the command to be executed after loading the file and
3755 * forced 'ff' and 'fenc'
3756 * newlnum: if > 0: put cursor on this line number (if possible)
3757 * if ECMD_LASTL: use last position in loaded file
3758 * if ECMD_LAST: use last position in all files
3759 * if ECMD_ONE: use first line
3760 * flags:
3761 * ECMD_HIDE: if TRUE don't free the current buffer
3762 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3763 * ECMD_OLDBUF: use existing buffer if it exists
3764 * ECMD_FORCEIT: ! used for Ex command
3765 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003766 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003767 * window, NULL when splitting the window first. When not NULL info
3768 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 *
3770 * return FAIL for failure, OK otherwise
3771 */
3772 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003773do_ecmd(
3774 int fnum,
3775 char_u *ffname,
3776 char_u *sfname,
3777 exarg_T *eap, /* can be NULL! */
3778 linenr_T newlnum,
3779 int flags,
3780 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781{
3782 int other_file; /* TRUE if editing another file */
3783 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 int auto_buf = FALSE; /* TRUE if autocommands brought us
3785 into the buffer unexpectedly */
3786 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003787#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003788 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789#endif
3790 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003791 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003792 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 char_u *free_fname = NULL;
3794#ifdef FEAT_BROWSE
3795 char_u *browse_file = NULL;
3796#endif
3797 int retval = FAIL;
3798 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003799 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 linenr_T topline = 0;
3801 int newcol = -1;
3802 int solcol = -1;
3803 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003805#ifdef FEAT_SPELL
3806 int did_get_winopts = FALSE;
3807#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003808 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003809 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003810 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811
3812 if (eap != NULL)
3813 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003814 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815
3816 if (fnum != 0)
3817 {
3818 if (fnum == curbuf->b_fnum) /* file is already being edited */
3819 return OK; /* nothing to do */
3820 other_file = TRUE;
3821 }
3822 else
3823 {
3824#ifdef FEAT_BROWSE
3825 if (cmdmod.browse)
3826 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003827 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003828# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003829 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003830# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003831 au_has_group((char_u *)"FileExplorer"))
3832 {
3833 /* No browsing supported but we do have the file explorer:
3834 * Edit the directory. */
3835 if (ffname == NULL || !mch_isdir(ffname))
3836 ffname = (char_u *)".";
3837 }
3838 else
3839 {
3840 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003842 if (browse_file == NULL)
3843 goto theend;
3844 ffname = browse_file;
3845 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 }
3847#endif
3848 /* if no short name given, use ffname for short name */
3849 if (sfname == NULL)
3850 sfname = ffname;
3851#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01003852 if (sfname != NULL)
3853 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854#endif
3855
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3857 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858
3859 if (ffname == NULL)
3860 other_file = TRUE;
3861 /* there is no file name */
3862 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3863 other_file = FALSE;
3864 else
3865 {
3866 if (*ffname == NUL) /* re-edit with same file name */
3867 {
3868 ffname = curbuf->b_ffname;
3869 sfname = curbuf->b_fname;
3870 }
3871 free_fname = fix_fname(ffname); /* may expand to full path name */
3872 if (free_fname != NULL)
3873 ffname = free_fname;
3874 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 }
3876 }
3877
3878 /*
3879 * if the file was changed we may not be allowed to abandon it
3880 * - if we are going to re-edit the same file
3881 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3882 */
3883 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3884 || (curbuf->b_nwindows == 1
3885 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003886 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3887 | (other_file ? 0 : CCGD_MULTWIN)
3888 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3889 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 {
3891 if (fnum == 0 && other_file && ffname != NULL)
3892 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3893 goto theend;
3894 }
3895
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 /*
3897 * End Visual mode before switching to another buffer, so the text can be
3898 * copied into the GUI selection buffer.
3899 */
3900 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003902#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003903 if ((command != NULL || newlnum > (linenr_T)0)
3904 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3905 {
3906 int len;
3907 char_u *p;
3908
3909 /* Set v:swapcommand for the SwapExists autocommands. */
3910 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003911 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003912 else
3913 len = 30;
3914 p = alloc((unsigned)len);
3915 if (p != NULL)
3916 {
3917 if (command != NULL)
3918 vim_snprintf((char *)p, len, ":%s\r", command);
3919 else
3920 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3921 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3922 did_set_swapcommand = TRUE;
3923 vim_free(p);
3924 }
3925 }
3926#endif
3927
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 /*
3929 * If we are starting to edit another file, open a (new) buffer.
3930 * Otherwise we re-use the current buffer.
3931 */
3932 if (other_file)
3933 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003936 if (!cmdmod.keepalt)
3937 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003938 if (oldwin != NULL)
3939 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 }
3941
3942 if (fnum)
3943 buf = buflist_findnr(fnum);
3944 else
3945 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 if (flags & ECMD_ADDBUF)
3947 {
3948 linenr_T tlnum = 1L;
3949
3950 if (command != NULL)
3951 {
3952 tlnum = atol((char *)command);
3953 if (tlnum <= 0)
3954 tlnum = 1L;
3955 }
3956 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3957 goto theend;
3958 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 buf = buflist_new(ffname, sfname, 0L,
3960 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003961
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003962 /* autocommands may change curwin and curbuf */
3963 if (oldwin != NULL)
3964 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003965 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 }
3967 if (buf == NULL)
3968 goto theend;
3969 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3970 {
3971 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 }
3973 else /* existing memfile */
3974 {
3975 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003976 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003978 /* Check if autocommands made the buffer invalid or changed the
3979 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003980 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 goto theend;
3982#ifdef FEAT_EVAL
3983 if (aborting()) /* autocmds may abort script processing */
3984 goto theend;
3985#endif
3986 }
3987
3988 /* May jump to last used line number for a loaded buffer or when asked
3989 * for explicitly */
3990 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3991 {
3992 pos = buflist_findfpos(buf);
3993 newlnum = pos->lnum;
3994 solcol = pos->col;
3995 }
3996
3997 /*
3998 * Make the (new) buffer the one used by the current window.
3999 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
4000 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01004001 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 */
4003 if (buf != curbuf)
4004 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 /*
4006 * Be careful: The autocommands may delete any buffer and change
4007 * the current buffer.
4008 * - If the buffer we are going to edit is deleted, give up.
4009 * - If the current buffer is deleted, prefer to load the new
4010 * buffer when loading a buffer is required. This avoids
4011 * loading another buffer which then must be closed again.
4012 * - If we ended up in the new buffer already, need to skip a few
4013 * things, set auto_buf.
4014 */
4015 if (buf->b_fname != NULL)
4016 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004017 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004019 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004021 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 delbuf_msg(new_name); /* frees new_name */
4023 goto theend;
4024 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004025#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 if (aborting()) /* autocmds may abort script processing */
4027 {
4028 vim_free(new_name);
4029 goto theend;
4030 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004031#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 if (buf == curbuf) /* already in new buffer */
4033 auto_buf = TRUE;
4034 else
4035 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02004036 win_T *the_curwin = curwin;
4037
4038 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004039 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02004040 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004041 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02004042
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004043 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 buf_copy_options(buf, BCO_ENTER);
4045
Bram Moolenaar5a497892016-09-03 16:29:04 +02004046 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02004047 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004048 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00004049 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01004050 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051
Bram Moolenaar5a497892016-09-03 16:29:04 +02004052 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004053 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01004054
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004055#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02004056 /* autocmds may abort script processing */
4057 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 {
4059 vim_free(new_name);
4060 goto theend;
4061 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004062#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004064 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004066 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 delbuf_msg(new_name); /* frees new_name */
4068 goto theend;
4069 }
4070 if (buf == curbuf) /* already in new buffer */
4071 auto_buf = TRUE;
4072 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02004074#ifdef FEAT_SYN_HL
4075 /*
4076 * <VN> We could instead free the synblock
4077 * and re-attach to buffer, perhaps.
4078 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02004079 if (curwin->w_buffer == NULL
4080 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02004081 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02004082#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 curwin->w_buffer = buf;
4084 curbuf = buf;
4085 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02004086
4087 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
4088 if (!oldbuf && eap != NULL)
4089 {
4090 set_file_options(TRUE, eap);
4091 set_forced_fenc(eap);
4092 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 }
4094
4095 /* May get the window options from the last time this buffer
4096 * was in this window (or another window). If not used
4097 * before, reset the local window options to the global
4098 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004099 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004100#ifdef FEAT_SPELL
4101 did_get_winopts = TRUE;
4102#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 }
4104 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004105 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004106 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108
4109 curwin->w_pcmark.lnum = 1;
4110 curwin->w_pcmark.col = 0;
4111 }
4112 else /* !other_file */
4113 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02004114 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004116
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 oldbuf = (flags & ECMD_OLDBUF);
4118 }
4119
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004120 /* Don't redraw until the cursor is in the right line, otherwise
4121 * autocommands may cause ml_get errors. */
4122 ++RedrawingDisabled;
4123 did_inc_redrawing_disabled = TRUE;
4124
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004125 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4127 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004128 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 }
4130 else
4131 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 /* Don't make a buffer listed if it's a help buffer. Useful when
4133 * using CTRL-O to go back to a help file. */
4134 if (!curbuf->b_help)
4135 set_buflisted(TRUE);
4136 }
4137
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 /* If autocommands change buffers under our fingers, forget about
4139 * editing the file. */
4140 if (buf != curbuf)
4141 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004142#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 if (aborting()) /* autocmds may abort script processing */
4144 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004145#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146
4147 /* Since we are starting to edit a file, consider the filetype to be
4148 * unset. Helps for when an autocommand changes files and expects syntax
4149 * highlighting to work in the other file. */
4150 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152/*
4153 * other_file oldbuf
4154 * FALSE FALSE re-edit same file, buffer is re-used
4155 * FALSE TRUE re-edit same file, nothing changes
4156 * TRUE FALSE start editing new file, new buffer
4157 * TRUE TRUE start editing in existing buffer (nothing to do)
4158 */
4159 if (!other_file && !oldbuf) /* re-use the buffer */
4160 {
4161 set_last_cursor(curwin); /* may set b_last_cursor */
4162 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4163 {
4164 newlnum = curwin->w_cursor.lnum;
4165 solcol = curwin->w_cursor.col;
4166 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 buf = curbuf;
4168 if (buf->b_fname != NULL)
4169 new_name = vim_strsave(buf->b_fname);
4170 else
4171 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004172 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004173
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004174 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4175 {
4176 /* Save all the text, so that the reload can be undone.
4177 * Sync first so that this is a separate undo-able action. */
4178 u_sync(FALSE);
4179 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4180 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004181 {
4182 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004183 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004184 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004185 u_unchanged(curbuf);
4186 buf_freeall(curbuf, BFA_KEEP_UNDO);
4187
4188 /* tell readfile() not to clear or reload undo info */
4189 readfile_flags = READ_KEEP_UNDO;
4190 }
4191 else
4192 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004193
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 /* If autocommands deleted the buffer we were going to re-edit, give
4195 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004196 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 {
4198 delbuf_msg(new_name); /* frees new_name */
4199 goto theend;
4200 }
4201 vim_free(new_name);
4202
4203 /* If autocommands change buffers under our fingers, forget about
4204 * re-editing the file. Should do the buf_clear_file(), but perhaps
4205 * the autocommands changed the buffer... */
4206 if (buf != curbuf)
4207 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004208#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 if (aborting()) /* autocmds may abort script processing */
4210 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211#endif
4212 buf_clear_file(curbuf);
4213 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4214 curbuf->b_op_end.lnum = 0;
4215 }
4216
4217/*
4218 * If we get here we are sure to start editing
4219 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 /* Assume success now */
4221 retval = OK;
4222
4223 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 * Check if we are editing the w_arg_idx file in the argument list.
4225 */
4226 check_arg_idx(curwin);
4227
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 {
4230 /*
4231 * Set cursor and init window before reading the file and executing
4232 * autocommands. This allows for the autocommands to position the
4233 * cursor.
4234 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004235 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236
4237#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004238 /* It's possible that all lines in the buffer changed. Need to update
4239 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004240 {
4241 win_T *win;
4242 tabpage_T *tp;
4243
4244 FOR_ALL_TAB_WINDOWS(tp, win)
4245 if (win->w_buffer == curbuf)
4246 foldUpdateAll(win);
4247 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248#endif
4249
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004250 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02004251 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004252
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 /*
4254 * Careful: open_buffer() and apply_autocmds() may change the current
4255 * buffer and window.
4256 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004257 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 topline = curwin->w_topline;
4259 if (!oldbuf) /* need to read the file */
4260 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 swap_exists_action = SEA_DIALOG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4263
4264 /*
4265 * Open the buffer and read the file.
4266 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004267#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004268 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 retval = FAIL;
4270#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004271 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272#endif
4273
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 if (swap_exists_action == SEA_QUIT)
4275 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004276 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 else
4279 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004280 /* Read the modelines, but only to set window-local options. Any
4281 * buffer-local options have already been set and may have been
4282 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004283 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004284
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4286 &retval);
4287 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4288 &retval);
4289 }
4290 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291
Bram Moolenaareab316b2015-03-24 11:46:30 +01004292 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004293 * keep it. Also when it moves within a line. But not when it moves
4294 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004295 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004297 char_u *text = ml_get_curline();
4298
4299 if (curwin->w_cursor.lnum != orig_pos.lnum
4300 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
4301 {
4302 newlnum = curwin->w_cursor.lnum;
4303 newcol = curwin->w_cursor.col;
4304 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 }
4306 if (curwin->w_topline == topline)
4307 topline = 0;
4308
4309 /* Even when cursor didn't move we need to recompute topline. */
4310 changed_line_abv_curs();
4311
4312#ifdef FEAT_TITLE
4313 maketitle();
4314#endif
4315 }
4316
4317#ifdef FEAT_DIFF
4318 /* Tell the diff stuff that this buffer is new and/or needs updating.
4319 * Also needed when re-editing the same buffer, because unloading will
4320 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004321 if (curwin->w_p_diff)
4322 {
4323 diff_buf_add(curbuf);
4324 diff_invalidate(curbuf);
4325 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326#endif
4327
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004328#ifdef FEAT_SPELL
4329 /* If the window options were changed may need to set the spell language.
4330 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004331 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4332 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004333#endif
4334
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 if (command == NULL)
4336 {
4337 if (newcol >= 0) /* position set by autocommands */
4338 {
4339 curwin->w_cursor.lnum = newlnum;
4340 curwin->w_cursor.col = newcol;
4341 check_cursor();
4342 }
4343 else if (newlnum > 0) /* line number from caller or old position */
4344 {
4345 curwin->w_cursor.lnum = newlnum;
4346 check_cursor_lnum();
4347 if (solcol >= 0 && !p_sol)
4348 {
4349 /* 'sol' is off: Use last known column. */
4350 curwin->w_cursor.col = solcol;
4351 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 curwin->w_set_curswant = TRUE;
4354 }
4355 else
4356 beginline(BL_SOL | BL_FIX);
4357 }
4358 else /* no line number, go to last line in Ex mode */
4359 {
4360 if (exmode_active)
4361 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4362 beginline(BL_WHITE | BL_FIX);
4363 }
4364 }
4365
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 /* Check if cursors in other windows on the same buffer are still valid */
4367 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368
4369 /*
4370 * Did not read the file, need to show some info about the file.
4371 * Do this after setting the cursor.
4372 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004373 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 {
4375 int msg_scroll_save = msg_scroll;
4376
4377 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4378 * message. */
4379 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4380 msg_scroll = FALSE;
4381 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4382 check_for_delay(FALSE);
4383 msg_start();
4384 msg_scroll = msg_scroll_save;
4385 msg_scrolled_ign = TRUE;
4386
Bram Moolenaar426dd022016-03-15 15:09:29 +01004387 if (!shortmess(SHM_FILEINFO))
4388 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389
4390 msg_scrolled_ign = FALSE;
4391 }
4392
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004393#ifdef FEAT_VIMINFO
4394 curbuf->b_last_used = vim_time();
4395#endif
4396
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 if (command != NULL)
4398 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4399
4400#ifdef FEAT_KEYMAP
4401 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004402 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403#endif
4404
4405 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004406 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 if (!skip_redraw)
4408 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01004409 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01004411 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01004414 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4416 }
4417
4418 if (p_im)
4419 need_start_insertmode = TRUE;
4420
Bram Moolenaar15833232018-02-03 18:33:17 +01004421#ifdef FEAT_AUTOCHDIR
4422 /* Change directories when the 'acd' option is set and we aren't already in
4423 * that directory (should already be done above). Expect getcwd() to be
4424 * faster than calling shorten_fnames() unnecessarily. */
4425 if (p_acd && curbuf->b_ffname != NULL)
4426 {
4427 char_u curdir[MAXPATHL];
4428 char_u filedir[MAXPATHL];
4429
4430 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4431 *gettail_sep(filedir) = NUL;
4432 if (mch_dirname(curdir, MAXPATHL) != FAIL
4433 && vim_fnamecmp(curdir, filedir) != 0)
4434 do_autochdir();
4435 }
4436#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01004438#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004439 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004442 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004443 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444# endif
4445 }
4446#endif
4447
4448theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004449 if (did_inc_redrawing_disabled)
4450 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004451#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004452 if (did_set_swapcommand)
4453 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4454#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455#ifdef FEAT_BROWSE
4456 vim_free(browse_file);
4457#endif
4458 vim_free(free_fname);
4459 return retval;
4460}
4461
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004463delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004465 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 name == NULL ? (char_u *)"" : name);
4467 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004468 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004469 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004472static int append_indent = 0; /* autoindent for first line */
4473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474/*
4475 * ":insert" and ":append", also used by ":change"
4476 */
4477 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004478ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479{
4480 char_u *theline;
4481 int did_undo = FALSE;
4482 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004483 int indent = 0;
4484 char_u *p;
4485 int vcol;
4486 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004488 /* the ! flag toggles autoindent */
4489 if (eap->forceit)
4490 curbuf->b_p_ai = !curbuf->b_p_ai;
4491
4492 /* First autoindent comes from the line we start on */
4493 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4494 append_indent = get_indent_lnum(lnum);
4495
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 if (eap->cmdidx != CMD_append)
4497 --lnum;
4498
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004499 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004500 if (empty && lnum == 1)
4501 lnum = 0;
4502
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 State = INSERT; /* behave like in Insert mode */
4504 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4505 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004506
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004507 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 {
4509 msg_scroll = TRUE;
4510 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004511 if (curbuf->b_p_ai)
4512 {
4513 if (append_indent >= 0)
4514 {
4515 indent = append_indent;
4516 append_indent = -1;
4517 }
4518 else if (lnum > 0)
4519 indent = get_indent_lnum(lnum);
4520 }
4521 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004523 {
4524 /* No getline() function, use the lines that follow. This ends
4525 * when there is no more. */
4526 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4527 break;
4528 p = vim_strchr(eap->nextcmd, NL);
4529 if (p == NULL)
4530 p = eap->nextcmd + STRLEN(eap->nextcmd);
4531 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4532 if (*p != NUL)
4533 ++p;
4534 eap->nextcmd = p;
4535 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004537 {
4538 int save_State = State;
4539
4540 /* Set State to avoid the cursor shape to be set to INSERT mode
4541 * when getline() returns. */
4542 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 theline = eap->getline(
4544#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004545 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004547 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004548 State = save_State;
4549 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004551 if (theline == NULL)
4552 break;
4553
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004554 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4555 if (ex_keep_indent)
4556 append_indent = indent;
4557
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004558 /* Look for the "." after automatic indent. */
4559 vcol = 0;
4560 for (p = theline; indent > vcol; ++p)
4561 {
4562 if (*p == ' ')
4563 ++vcol;
4564 else if (*p == TAB)
4565 vcol += 8 - vcol % 8;
4566 else
4567 break;
4568 }
4569 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004570 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4571 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 {
4573 vim_free(theline);
4574 break;
4575 }
4576
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004577 /* don't use autoindent if nothing was typed. */
4578 if (p[0] == NUL)
4579 theline[0] = NUL;
4580
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 did_undo = TRUE;
4582 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004583 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584
4585 vim_free(theline);
4586 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004587
4588 if (empty)
4589 {
4590 ml_delete(2L, FALSE);
4591 empty = FALSE;
4592 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 }
4594 State = NORMAL;
4595
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004596 if (eap->forceit)
4597 curbuf->b_p_ai = !curbuf->b_p_ai;
4598
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004600 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 * "end" is set to lnum when something has been appended, otherwise
4602 * it is the same than "start" -- Acevedo */
4603 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4604 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4605 if (eap->cmdidx != CMD_append)
4606 --curbuf->b_op_start.lnum;
4607 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4608 ? lnum : curbuf->b_op_start.lnum;
4609 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4610 curwin->w_cursor.lnum = lnum;
4611 check_cursor_lnum();
4612 beginline(BL_SOL | BL_FIX);
4613
4614 need_wait_return = FALSE; /* don't use wait_return() now */
4615 ex_no_reprint = TRUE;
4616}
4617
4618/*
4619 * ":change"
4620 */
4621 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004622ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623{
4624 linenr_T lnum;
4625
4626 if (eap->line2 >= eap->line1
4627 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4628 return;
4629
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004630 /* the ! flag toggles autoindent */
4631 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4632 append_indent = get_indent_lnum(eap->line1);
4633
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4635 {
4636 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4637 break;
4638 ml_delete(eap->line1, FALSE);
4639 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004640
4641 /* make sure the cursor is not beyond the end of the file now */
4642 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4644
4645 /* ":append" on the line above the deleted lines. */
4646 eap->line2 = eap->line1;
4647 ex_append(eap);
4648}
4649
4650 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004651ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652{
4653 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004654 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004655 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 int minus = 0;
4657 linenr_T start, end, curs, i;
4658 int j;
4659 linenr_T lnum = eap->line2;
4660
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004661 /* Vi compatible: ":z!" uses display height, without a count uses
4662 * 'scroll' */
4663 if (eap->forceit)
4664 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004665 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004666 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004667 else
4668 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 if (bigness < 1)
4670 bigness = 1;
4671
4672 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004673 kind = x;
4674 if (*kind == '-' || *kind == '+' || *kind == '='
4675 || *kind == '^' || *kind == '.')
4676 ++x;
4677 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 ++x;
4679
4680 if (*x != 0)
4681 {
4682 if (!VIM_ISDIGIT(*x))
4683 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004684 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 return;
4686 }
4687 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004688 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004689 bigness = atol((char *)x);
4690
4691 /* bigness could be < 0 if atol(x) overflows. */
4692 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4693 bigness = 2 * curbuf->b_ml.ml_line_count;
4694
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004695 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004696 if (*kind == '=')
4697 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004698 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 }
4700
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004701 /* the number of '-' and '+' multiplies the distance */
4702 if (*kind == '-' || *kind == '+')
4703 for (x = kind + 1; *x == *kind; ++x)
4704 ;
4705
4706 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 {
4708 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004709 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4710 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004711 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 break;
4713
4714 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004715 start = lnum - (bigness + 1) / 2 + 1;
4716 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 curs = lnum;
4718 minus = 1;
4719 break;
4720
4721 case '^':
4722 start = lnum - bigness * 2;
4723 end = lnum - bigness;
4724 curs = lnum - bigness;
4725 break;
4726
4727 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004728 start = lnum - (bigness + 1) / 2 + 1;
4729 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 curs = end;
4731 break;
4732
4733 default: /* '+' */
4734 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004735 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004736 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004737 else if (eap->addr_count == 0)
4738 ++start;
4739 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 curs = end;
4741 break;
4742 }
4743
4744 if (start < 1)
4745 start = 1;
4746
4747 if (end > curbuf->b_ml.ml_line_count)
4748 end = curbuf->b_ml.ml_line_count;
4749
4750 if (curs > curbuf->b_ml.ml_line_count)
4751 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004752 else if (curs < 1)
4753 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754
4755 for (i = start; i <= end; i++)
4756 {
4757 if (minus && i == lnum)
4758 {
4759 msg_putchar('\n');
4760
4761 for (j = 1; j < Columns; j++)
4762 msg_putchar('-');
4763 }
4764
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004765 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766
4767 if (minus && i == lnum)
4768 {
4769 msg_putchar('\n');
4770
4771 for (j = 1; j < Columns; j++)
4772 msg_putchar('-');
4773 }
4774 }
4775
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004776 if (curwin->w_cursor.lnum != curs)
4777 {
4778 curwin->w_cursor.lnum = curs;
4779 curwin->w_cursor.col = 0;
4780 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 ex_no_reprint = TRUE;
4782}
4783
4784/*
4785 * Check if the restricted flag is set.
4786 * If so, give an error message and return TRUE.
4787 * Otherwise, return FALSE.
4788 */
4789 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004790check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791{
4792 if (restricted)
4793 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01004794 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 return TRUE;
4796 }
4797 return FALSE;
4798}
4799
4800/*
4801 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4802 * If so, give an error message and return TRUE.
4803 * Otherwise, return FALSE.
4804 */
4805 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004806check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807{
4808 if (secure)
4809 {
4810 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004811 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 return TRUE;
4813 }
4814#ifdef HAVE_SANDBOX
4815 /*
4816 * In the sandbox more things are not allowed, including the things
4817 * disallowed in secure mode.
4818 */
4819 if (sandbox != 0)
4820 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004821 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 return TRUE;
4823 }
4824#endif
4825 return FALSE;
4826}
4827
4828static char_u *old_sub = NULL; /* previous substitute pattern */
4829static int global_need_beginline; /* call beginline() after ":g" */
4830
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004831/*
4832 * Flags that are kept between calls to :substitute.
4833 */
4834typedef struct {
4835 int do_all; /* do multiple substitutions per line */
4836 int do_ask; /* ask for confirmation */
4837 int do_count; /* count only */
4838 int do_error; /* if false, ignore errors */
4839 int do_print; /* print last line with subs. */
4840 int do_list; /* list last line with subs. */
4841 int do_number; /* list last line with line nr*/
4842 int do_ic; /* ignore case flag */
4843} subflags_T;
4844
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845/* do_sub()
4846 *
4847 * Perform a substitution from line eap->line1 to line eap->line2 using the
4848 * command pointed to by eap->arg which should be of the form:
4849 *
4850 * /pattern/substitution/{flags}
4851 *
4852 * The usual escapes are supported as described in the regexp docs.
4853 */
4854 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004855do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856{
4857 linenr_T lnum;
4858 long i = 0;
4859 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004860 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4861 FALSE, FALSE, 0};
4862#ifdef FEAT_EVAL
4863 subflags_T subflags_save;
4864#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004865 int save_do_all; /* remember user specified 'g' flag */
4866 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4868 int delimiter;
4869 int sublen;
4870 int got_quit = FALSE;
4871 int got_match = FALSE;
4872 int temp;
4873 int which_pat;
4874 char_u *cmd;
4875 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004876 linenr_T first_line = 0; /* first changed line */
4877 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 * change */
4879 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4880 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004881 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004882 char_u *sub_firstline; /* allocated copy of first sub line */
4883 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004884 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004885 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004886#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004887 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004888#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889
4890 cmd = eap->arg;
4891 if (!global_busy)
4892 {
4893 sub_nsubs = 0;
4894 sub_nlines = 0;
4895 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004896 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 if (eap->cmdidx == CMD_tilde)
4899 which_pat = RE_LAST; /* use last used regexp */
4900 else
4901 which_pat = RE_SUBST; /* use last substitute regexp */
4902
4903 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004904 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4906 {
4907 /* don't accept alphanumeric for separator */
4908 if (isalpha(*cmd))
4909 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004910 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 return;
4912 }
4913 /*
4914 * undocumented vi feature:
4915 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4916 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4917 */
4918 if (*cmd == '\\')
4919 {
4920 ++cmd;
4921 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4922 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004923 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 return;
4925 }
4926 if (*cmd != '&')
4927 which_pat = RE_SEARCH; /* use last '/' pattern */
4928 pat = (char_u *)""; /* empty search pattern */
4929 delimiter = *cmd++; /* remember delimiter character */
4930 }
4931 else /* find the end of the regexp */
4932 {
4933 which_pat = RE_LAST; /* use last used regexp */
4934 delimiter = *cmd++; /* remember delimiter character */
4935 pat = cmd; /* remember start of search pat */
4936 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4937 if (cmd[0] == delimiter) /* end delimiter found */
4938 *cmd++ = NUL; /* replace it with a NUL */
4939 }
4940
4941 /*
4942 * Small incompatibility: vi sees '\n' as end of the command, but in
4943 * Vim we want to use '\n' to find/substitute a NUL.
4944 */
4945 sub = cmd; /* remember the start of the substitution */
4946
4947 while (cmd[0])
4948 {
4949 if (cmd[0] == delimiter) /* end delimiter found */
4950 {
4951 *cmd++ = NUL; /* replace it with a NUL */
4952 break;
4953 }
4954 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4955 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004956 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 }
4958
4959 if (!eap->skip)
4960 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004961 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4962 if (STRCMP(sub, "%") == 0
4963 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4964 {
4965 if (old_sub == NULL) /* there is no previous command */
4966 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004967 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004968 return;
4969 }
4970 sub = old_sub;
4971 }
4972 else
4973 {
4974 vim_free(old_sub);
4975 old_sub = vim_strsave(sub);
4976 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 }
4978 }
4979 else if (!eap->skip) /* use previous pattern and substitution */
4980 {
4981 if (old_sub == NULL) /* there is no previous command */
4982 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004983 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 return;
4985 }
4986 pat = NULL; /* search_regcomp() will use previous pattern */
4987 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004988
4989 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4990 * last column after using "$". */
4991 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 }
4993
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004994 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4995 * more efficient.
4996 * TODO: find a generic solution to make line-joining operations more
4997 * efficient, avoid allocating a string that grows in size.
4998 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004999 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005000 && *sub == NUL
5001 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
5002 || *cmd == 'p' || *cmd == '#'))))
5003 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005004 linenr_T joined_lines_count;
5005
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005006 curwin->w_cursor.lnum = eap->line1;
5007 if (*cmd == 'l')
5008 eap->flags = EXFLAG_LIST;
5009 else if (*cmd == '#')
5010 eap->flags = EXFLAG_NR;
5011 else if (*cmd == 'p')
5012 eap->flags = EXFLAG_PRINT;
5013
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005014 /* The number of lines joined is the number of lines in the range plus
5015 * one. One less when the last line is included. */
5016 joined_lines_count = eap->line2 - eap->line1 + 1;
5017 if (eap->line2 < curbuf->b_ml.ml_line_count)
5018 ++joined_lines_count;
5019 if (joined_lines_count > 1)
5020 {
5021 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
5022 sub_nsubs = joined_lines_count - 1;
5023 sub_nlines = 1;
5024 (void)do_sub_msg(FALSE);
5025 ex_may_print(eap);
5026 }
5027
5028 if (!cmdmod.keeppatterns)
5029 save_re_pat(RE_SUBST, pat, p_magic);
5030#ifdef FEAT_CMDHIST
5031 /* put pattern in history */
5032 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
5033#endif
5034
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005035 return;
5036 }
5037
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 /*
5039 * Find trailing options. When '&' is used, keep old options.
5040 */
5041 if (*cmd == '&')
5042 ++cmd;
5043 else
5044 {
5045 if (!p_ed)
5046 {
5047 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005048 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005050 subflags.do_all = FALSE;
5051 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005053 subflags.do_error = TRUE;
5054 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01005055 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005056 subflags.do_count = FALSE;
5057 subflags.do_number = FALSE;
5058 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 }
5060 while (*cmd)
5061 {
5062 /*
5063 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
5064 * 'r' is never inverted.
5065 */
5066 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005067 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005069 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005070 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005071 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005073 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 else if (*cmd == 'r') /* use last used regexp */
5075 which_pat = RE_LAST;
5076 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005077 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005078 else if (*cmd == '#')
5079 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005080 subflags.do_print = TRUE;
5081 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005082 }
5083 else if (*cmd == 'l')
5084 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005085 subflags.do_print = TRUE;
5086 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005087 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005089 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005091 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 else
5093 break;
5094 ++cmd;
5095 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005096 if (subflags.do_count)
5097 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005099 save_do_all = subflags.do_all;
5100 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005101
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 /*
5103 * check for a trailing count
5104 */
5105 cmd = skipwhite(cmd);
5106 if (VIM_ISDIGIT(*cmd))
5107 {
5108 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005109 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005111 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 return;
5113 }
5114 eap->line1 = eap->line2;
5115 eap->line2 += i - 1;
5116 if (eap->line2 > curbuf->b_ml.ml_line_count)
5117 eap->line2 = curbuf->b_ml.ml_line_count;
5118 }
5119
5120 /*
5121 * check for trailing command or garbage
5122 */
5123 cmd = skipwhite(cmd);
5124 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5125 {
5126 eap->nextcmd = check_nextcmd(cmd);
5127 if (eap->nextcmd == NULL)
5128 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005129 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130 return;
5131 }
5132 }
5133
5134 if (eap->skip) /* not executing commands, only parsing */
5135 return;
5136
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005137 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005138 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005139 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005140 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005141 return;
5142 }
5143
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5145 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005146 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005147 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 return;
5149 }
5150
5151 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005152 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005154 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 regmatch.rmm_ic = FALSE;
5156
5157 sub_firstline = NULL;
5158
5159 /*
5160 * ~ in the substitute pattern is replaced with the old pattern.
5161 * We do it here once to avoid it to be replaced over and over again.
5162 * But don't do it when it starts with "\=", then it's an expression.
5163 */
5164 if (!(sub[0] == '\\' && sub[1] == '='))
5165 sub = regtilde(sub, p_magic);
5166
5167 /*
5168 * Check for a match on each line.
5169 */
5170 line2 = eap->line2;
5171 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005172#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 || aborting()
5174#endif
5175 ); ++lnum)
5176 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005177 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005178 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 if (nmatch)
5180 {
5181 colnr_T copycol;
5182 colnr_T matchcol;
5183 colnr_T prev_matchcol = MAXCOL;
5184 char_u *new_end, *new_start = NULL;
5185 unsigned new_start_len = 0;
5186 char_u *p1;
5187 int did_sub = FALSE;
5188 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005189 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 long nmatch_tl = 0; /* nr of lines matched below lnum */
5191 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005192 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005193 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 /*
5196 * The new text is build up step by step, to avoid too much
5197 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005198 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 * copycol Column in the old text where we started
5200 * looking for a match; from here old text still
5201 * needs to be copied to the new text.
5202 * matchcol Column number of the old text where to look
5203 * for the next match. It's just after the
5204 * previous match or one further.
5205 * prev_matchcol Column just after the previous match (if any).
5206 * Mostly equal to matchcol, except for the first
5207 * match and after skipping an empty match.
5208 * regmatch.*pos Where the pattern matched in the old text.
5209 * new_start The new text, all that has been produced so
5210 * far.
5211 * new_end The new text, where to append new text.
5212 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005213 * lnum The line number where we found the start of
5214 * the match. Can be below the line we searched
5215 * when there is a \n before a \zs in the
5216 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 * sub_firstlnum The line number in the buffer where to look
5218 * for a match. Can be different from "lnum"
5219 * when the pattern or substitute string contains
5220 * line breaks.
5221 *
5222 * Special situations:
5223 * - When the substitute string contains a line break, the part up
5224 * to the line break is inserted in the text, but the copy of
5225 * the original line is kept. "sub_firstlnum" is adjusted for
5226 * the inserted lines.
5227 * - When the matched pattern contains a line break, the old line
5228 * is taken from the line at the end of the pattern. The lines
5229 * in the match are deleted later, "sub_firstlnum" is adjusted
5230 * accordingly.
5231 *
5232 * The new text is built up in new_start[]. It has some extra
5233 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005234 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 *
5236 * Make a copy of the old line, so it won't be taken away when
5237 * updating the screen or handling a multi-line match. The "old_"
5238 * pointers point into this copy.
5239 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005240 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 copycol = 0;
5242 matchcol = 0;
5243
5244 /* At first match, remember current cursor position. */
5245 if (!got_match)
5246 {
5247 setpcmark();
5248 got_match = TRUE;
5249 }
5250
5251 /*
5252 * Loop until nothing more to replace in this line.
5253 * 1. Handle match with empty string.
5254 * 2. If do_ask is set, ask for confirmation.
5255 * 3. substitute the string.
5256 * 4. if do_all is set, find next match
5257 * 5. break if there isn't another match in this line
5258 */
5259 for (;;)
5260 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005261 /* Advance "lnum" to the line where the match starts. The
5262 * match does not start in the first line when there is a line
5263 * break before \zs. */
5264 if (regmatch.startpos[0].lnum > 0)
5265 {
5266 lnum += regmatch.startpos[0].lnum;
5267 sub_firstlnum += regmatch.startpos[0].lnum;
5268 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005269 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005270 }
5271
5272 if (sub_firstline == NULL)
5273 {
5274 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5275 if (sub_firstline == NULL)
5276 {
5277 vim_free(new_start);
5278 goto outofmem;
5279 }
5280 }
5281
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 /* Save the line number of the last change for the final
5283 * cursor position (just like Vi). */
5284 curwin->w_cursor.lnum = lnum;
5285 do_again = FALSE;
5286
5287 /*
5288 * 1. Match empty string does not count, except for first
5289 * match. This reproduces the strange vi behaviour.
5290 * This also catches endless loops.
5291 */
5292 if (matchcol == prev_matchcol
5293 && regmatch.endpos[0].lnum == 0
5294 && matchcol == regmatch.endpos[0].col)
5295 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005296 if (sub_firstline[matchcol] == NUL)
5297 /* We already were at the end of the line. Don't look
5298 * for a match in this line again. */
5299 skip_match = TRUE;
5300 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005301 {
5302 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02005303 if (has_mbyte)
5304 matchcol += mb_ptr2len(sub_firstline + matchcol);
5305 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005306 ++matchcol;
5307 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 goto skip;
5309 }
5310
5311 /* Normally we continue searching for a match just after the
5312 * previous match. */
5313 matchcol = regmatch.endpos[0].col;
5314 prev_matchcol = matchcol;
5315
5316 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005317 * 2. If do_count is set only increase the counter.
5318 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005320 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005321 {
5322 /* For a multi-line match, put matchcol at the NUL at
5323 * the end of the line and set nmatch to one, so that
5324 * we continue looking for a match on the next line.
5325 * Avoids that ":s/\nB\@=//gc" get stuck. */
5326 if (nmatch > 1)
5327 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005328 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005329 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005330 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005331 }
5332 sub_nsubs++;
5333 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005334#ifdef FEAT_EVAL
5335 /* Skip the substitution, unless an expression is used,
5336 * then it is evaluated in the sandbox. */
5337 if (!(sub[0] == '\\' && sub[1] == '='))
5338#endif
5339 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005340 }
5341
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005342 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005344 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005345
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 /* change State to CONFIRM, so that the mouse works
5347 * properly */
5348 save_State = State;
5349 State = CONFIRM;
5350#ifdef FEAT_MOUSE
5351 setmouse(); /* disable mouse in xterm */
5352#endif
5353 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005354 if (curwin->w_p_crb)
5355 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
5357 /* When 'cpoptions' contains "u" don't sync undo when
5358 * asking for confirmation. */
5359 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5360 ++no_u_sync;
5361
5362 /*
5363 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5364 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005365 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005367 if (exmode_active)
5368 {
5369 char_u *resp;
5370 colnr_T sc, ec;
5371
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005372 print_line_no_prefix(lnum,
5373 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005374
5375 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5376 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005377 if (curwin->w_cursor.col < 0)
5378 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005379 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005380 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005381 {
5382 int numw = number_width(curwin) + 1;
5383 sc += numw;
5384 ec += numw;
5385 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005386 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005387 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005388 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005389 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005390 msg_putchar('^');
5391
5392 resp = getexmodeline('?', NULL, 0);
5393 if (resp != NULL)
5394 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005395 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005396 vim_free(resp);
5397 }
5398 }
5399 else
5400 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005401 char_u *orig_line = NULL;
5402 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005404 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005406 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005408 /* Invert the matched string.
5409 * Remove the inversion afterwards. */
5410 temp = RedrawingDisabled;
5411 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005413 if (new_start != NULL)
5414 {
5415 /* There already was a substitution, we would
5416 * like to show this to the user. We cannot
5417 * really update the line, it would change
5418 * what matches. Temporarily replace the line
5419 * and change it back afterwards. */
5420 orig_line = vim_strsave(ml_get(lnum));
5421 if (orig_line != NULL)
5422 {
5423 char_u *new_line = concat_str(new_start,
5424 sub_firstline + copycol);
5425
5426 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005427 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005428 else
5429 {
5430 /* Position the cursor relative to the
5431 * end of the line, the previous
5432 * substitute may have inserted or
5433 * deleted characters before the
5434 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005435 len_change = (int)STRLEN(new_line)
5436 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005437 curwin->w_cursor.col += len_change;
5438 ml_replace(lnum, new_line, FALSE);
5439 }
5440 }
5441 }
5442
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005443 search_match_lines = regmatch.endpos[0].lnum
5444 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005445 search_match_endcol = regmatch.endpos[0].col
5446 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005447 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005449 update_topline();
5450 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005451 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005452 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005453 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454
5455#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005456 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005458 if (msg_row == Rows - 1)
5459 msg_didout = FALSE; /* avoid a scroll-up */
5460 msg_starthere();
5461 i = msg_scroll;
5462 msg_scroll = 0; /* truncate msg when
5463 needed */
5464 msg_no_more = TRUE;
5465 /* write message same highlighting as for
5466 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005467 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005468 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005469 msg_no_more = FALSE;
5470 msg_scroll = i;
5471 showruler(TRUE);
5472 windgoto(msg_row, msg_col);
5473 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474
5475#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005476 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005478 ++no_mapping; /* don't map this key */
5479 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005480 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005481 --allow_keys;
5482 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005484 /* clear the question */
5485 msg_didout = FALSE; /* don't scroll up */
5486 msg_col = 0;
5487 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005488
5489 /* restore the line */
5490 if (orig_line != NULL)
5491 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005492 }
5493
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005495 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005497 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498#endif
5499 )
5500 {
5501 got_quit = TRUE;
5502 break;
5503 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005504 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005506 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005508 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 {
5510 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005511 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 line2 = lnum;
5513 break;
5514 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005515 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005517 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 break;
5519 }
5520#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005521 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005523 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 scrolldown_clamp();
5525#endif
5526 }
5527 State = save_State;
5528#ifdef FEAT_MOUSE
5529 setmouse();
5530#endif
5531 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5532 --no_u_sync;
5533
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005534 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 {
5536 /* For a multi-line match, put matchcol at the NUL at
5537 * the end of the line and set nmatch to one, so that
5538 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005539 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5540 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 if (nmatch > 1)
5542 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005543 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005544 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 }
5546 goto skip;
5547 }
5548 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005549 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 }
5551
5552 /* Move the cursor to the start of the match, so that we can
5553 * use "\=col("."). */
5554 curwin->w_cursor.col = regmatch.startpos[0].col;
5555
5556 /*
5557 * 3. substitute the string.
5558 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005559#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005560 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005561 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005562 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005563 save_ma = curbuf->b_p_ma;
5564 curbuf->b_p_ma = FALSE;
5565 sandbox++;
5566 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005567 /* Save flags for recursion. They can change for e.g.
5568 * :s/^/\=execute("s#^##gn") */
5569 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005570#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005572 sublen = vim_regsub_multi(&regmatch,
5573 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005575#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01005576 // If getting the substitute string caused an error, don't do
5577 // the replacement.
5578 if (aborting())
5579 goto skip;
5580
5581 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005582 subflags = subflags_save;
5583 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005584 {
5585 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005586 if (sandbox > 0)
5587 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005588 goto skip;
5589 }
5590#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591
Bram Moolenaar4463f292005-09-25 22:20:24 +00005592 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005593 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005594 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5595 {
5596 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5597 skip_match = TRUE;
5598 }
5599
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 /* Need room for:
5601 * - result so far in new_start (not for first sub in line)
5602 * - original text up to match
5603 * - length of substituted part
5604 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005605 * Adjust text properties here, since we have all information
5606 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 */
5608 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005609 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005611#ifdef FEAT_TEXT_PROP
5612 if (curbuf->b_has_textprop)
5613 adjust_prop_columns(lnum, regmatch.startpos[0].col,
5614 sublen - 1 - (regmatch.endpos[0].col
5615 - regmatch.startpos[0].col));
5616#endif
5617 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 else
5619 {
5620 p1 = ml_get(sub_firstlnum + nmatch - 1);
5621 nmatch_tl += nmatch - 1;
5622 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005623 copy_len = regmatch.startpos[0].col - copycol;
5624 needed_len = copy_len + ((unsigned)STRLEN(p1)
5625 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 if (new_start == NULL)
5627 {
5628 /*
5629 * Get some space for a temporary buffer to do the
5630 * substitution into (and some extra space to avoid
5631 * too many calls to alloc()/free()).
5632 */
5633 new_start_len = needed_len + 50;
5634 if ((new_start = alloc_check(new_start_len)) == NULL)
5635 goto outofmem;
5636 *new_start = NUL;
5637 new_end = new_start;
5638 }
5639 else
5640 {
5641 /*
5642 * Check if the temporary buffer is long enough to do the
5643 * substitution into. If not, make it larger (with a bit
5644 * extra to avoid too many calls to alloc()/free()).
5645 */
5646 len = (unsigned)STRLEN(new_start);
5647 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005648 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 {
5650 new_start_len = needed_len + 50;
5651 if ((p1 = alloc_check(new_start_len)) == NULL)
5652 {
5653 vim_free(new_start);
5654 goto outofmem;
5655 }
5656 mch_memmove(p1, new_start, (size_t)(len + 1));
5657 vim_free(new_start);
5658 new_start = p1;
5659 }
5660 new_end = new_start + len;
5661 }
5662
5663 /*
5664 * copy the text up to the part that matched
5665 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005666 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5667 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005669 (void)vim_regsub_multi(&regmatch,
5670 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 sub, new_end, TRUE, p_magic, TRUE);
5672 sub_nsubs++;
5673 did_sub = TRUE;
5674
5675 /* Move the cursor to the start of the line, to avoid that it
5676 * is beyond the end of the line after the substitution. */
5677 curwin->w_cursor.col = 0;
5678
5679 /* For a multi-line match, make a copy of the last matched
5680 * line and continue in that one. */
5681 if (nmatch > 1)
5682 {
5683 sub_firstlnum += nmatch - 1;
5684 vim_free(sub_firstline);
5685 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5686 /* When going beyond the last line, stop substituting. */
5687 if (sub_firstlnum <= line2)
5688 do_again = TRUE;
5689 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005690 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 }
5692
5693 /* Remember next character to be copied. */
5694 copycol = regmatch.endpos[0].col;
5695
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005696 if (skip_match)
5697 {
5698 /* Already hit end of the buffer, sub_firstlnum is one
5699 * less than what it ought to be. */
5700 vim_free(sub_firstline);
5701 sub_firstline = vim_strsave((char_u *)"");
5702 copycol = 0;
5703 }
5704
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 /*
5706 * Now the trick is to replace CTRL-M chars with a real line
5707 * break. This would make it impossible to insert a CTRL-M in
5708 * the text. The line break can be avoided by preceding the
5709 * CTRL-M with a backslash. To be able to insert a backslash,
5710 * they must be doubled in the string and are halved here.
5711 * That is Vi compatible.
5712 */
5713 for (p1 = new_end; *p1; ++p1)
5714 {
5715 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005716 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 else if (*p1 == CAR)
5718 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005719 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005721 colnr_T plen = (colnr_T)(p1 - new_start + 1);
5722
5723 *p1 = NUL; // truncate up to the CR
5724 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005726 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 appended_lines(lnum - 1, 1L);
5728 else
5729 {
5730 if (first_line == 0)
5731 first_line = lnum;
5732 last_line = lnum + 1;
5733 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005734#ifdef FEAT_TEXT_PROP
5735 adjust_props_for_split(lnum, plen, 1);
5736#endif
5737 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 ++sub_firstlnum;
5739 ++lnum;
5740 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005741 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005743 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005744 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 p1 = new_start - 1;
5746 }
5747 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005749 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 }
5751
5752 /*
5753 * 4. If do_all is set, find next match.
5754 * Prevent endless loop with patterns that match empty
5755 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5756 * But ":s/\n/#/" is OK.
5757 */
5758skip:
5759 /* We already know that we did the last subst when we are at
5760 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005761 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5762 * "line2" when there is a \zs in the pattern after a line
5763 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005764 lastone = (skip_match
5765 || got_int
5766 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005767 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005768 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005769 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5770 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 nmatch = -1;
5772
5773 /*
5774 * Replace the line in the buffer when needed. This is
5775 * skipped when there are more matches.
5776 * The check for nmatch_tl is needed for when multi-line
5777 * matching must replace the lines before trying to do another
5778 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005779 * When the match starts below where we start searching also
5780 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 */
5782 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 || nmatch_tl > 0
5784 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005785 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005786 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005787 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 {
5789 if (new_start != NULL)
5790 {
5791 /*
5792 * Copy the rest of the line, that didn't match.
5793 * "matchcol" has to be adjusted, we use the end of
5794 * the line as reference, because the substitute may
5795 * have changed the number of characters. Same for
5796 * "prev_matchcol".
5797 */
5798 STRCAT(new_start, sub_firstline + copycol);
5799 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5800 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5801 - prev_matchcol;
5802
5803 if (u_savesub(lnum) != OK)
5804 break;
5805 ml_replace(lnum, new_start, TRUE);
5806
5807 if (nmatch_tl > 0)
5808 {
5809 /*
5810 * Matched lines have now been substituted and are
5811 * useless, delete them. The part after the match
5812 * has been appended to new_start, we don't need
5813 * it in the buffer.
5814 */
5815 ++lnum;
5816 if (u_savedel(lnum, nmatch_tl) != OK)
5817 break;
5818 for (i = 0; i < nmatch_tl; ++i)
5819 ml_delete(lnum, (int)FALSE);
5820 mark_adjust(lnum, lnum + nmatch_tl - 1,
5821 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005822 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 deleted_lines(lnum, nmatch_tl);
5824 --lnum;
5825 line2 -= nmatch_tl; /* nr of lines decreases */
5826 nmatch_tl = 0;
5827 }
5828
5829 /* When asking, undo is saved each time, must also set
5830 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005831 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 changed_bytes(lnum, 0);
5833 else
5834 {
5835 if (first_line == 0)
5836 first_line = lnum;
5837 last_line = lnum + 1;
5838 }
5839
5840 sub_firstlnum = lnum;
5841 vim_free(sub_firstline); /* free the temp buffer */
5842 sub_firstline = new_start;
5843 new_start = NULL;
5844 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5845 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5846 - prev_matchcol;
5847 copycol = 0;
5848 }
5849 if (nmatch == -1 && !lastone)
5850 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005851 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852
5853 /*
5854 * 5. break if there isn't another match in this line
5855 */
5856 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005857 {
5858 /* If the match found didn't start where we were
5859 * searching, do the next search in the line where we
5860 * found the match. */
5861 if (nmatch == -1)
5862 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005864 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 }
5866
5867 line_breakcheck();
5868 }
5869
5870 if (did_sub)
5871 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005872 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005873 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 }
5875
5876 line_breakcheck();
5877 }
5878
5879 if (first_line != 0)
5880 {
5881 /* Need to subtract the number of added lines from "last_line" to get
5882 * the line number before the change (same as adding the number of
5883 * deleted lines). */
5884 i = curbuf->b_ml.ml_line_count - old_line_count;
5885 changed_lines(first_line, 0, last_line - i, i);
5886 }
5887
5888outofmem:
5889 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005890
5891 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005892 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005893 curwin->w_cursor = old_cursor;
5894
Bram Moolenaar46475522010-03-23 17:36:29 +01005895 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 {
5897 /* Set the '[ and '] marks. */
5898 curbuf->b_op_start.lnum = eap->line1;
5899 curbuf->b_op_end.lnum = line2;
5900 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5901
5902 if (!global_busy)
5903 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005904 /* when interactive leave cursor on the match */
5905 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005906 {
5907 if (endcolumn)
5908 coladvance((colnr_T)MAXCOL);
5909 else
5910 beginline(BL_WHITE | BL_FIX);
5911 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005912 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005913 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 }
5915 else
5916 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005917 if (subflags.do_print)
5918 print_line(curwin->w_cursor.lnum,
5919 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 }
5921 else if (!global_busy)
5922 {
5923 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005924 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005926 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005927 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005928 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 }
5930
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005931#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005932 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005933 /* Cursor position may require updating */
5934 changed_window_setting();
5935#endif
5936
Bram Moolenaar473de612013-06-08 18:19:48 +02005937 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005938
5939 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005940 subflags.do_all = save_do_all;
5941 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942}
5943
5944/*
5945 * Give message for number of substitutions.
5946 * Can also be used after a ":global" command.
5947 * Return TRUE if a message was given.
5948 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005949 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005950do_sub_msg(
5951 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952{
5953 /*
5954 * Only report substitutions when:
5955 * - more than 'report' substitutions
5956 * - command was typed by user, or number of changed lines > 'report'
5957 * - giving messages is not disabled by 'lazyredraw'
5958 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005959 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5960 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 && messaging())
5962 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005963 char *msg_single;
5964 char *msg_plural;
5965
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 if (got_int)
5967 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005968 else
5969 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005970
5971 msg_single = count_only
5972 ? NGETTEXT("%ld match on %ld line",
5973 "%ld matches on %ld line", sub_nsubs)
5974 : NGETTEXT("%ld substitution on %ld line",
5975 "%ld substitutions on %ld line", sub_nsubs);
5976 msg_plural = count_only
5977 ? NGETTEXT("%ld match on %ld lines",
5978 "%ld matches on %ld lines", sub_nsubs)
5979 : NGETTEXT("%ld substitution on %ld lines",
5980 "%ld substitutions on %ld lines", sub_nsubs);
5981
Bram Moolenaar32526b32019-01-19 17:43:09 +01005982 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005983 NGETTEXT(msg_single, msg_plural, sub_nlines),
5984 sub_nsubs, (long)sub_nlines);
5985
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005988 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 return TRUE;
5990 }
5991 if (got_int)
5992 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005993 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 return TRUE;
5995 }
5996 return FALSE;
5997}
5998
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005999 static void
6000global_exe_one(char_u *cmd, linenr_T lnum)
6001{
6002 curwin->w_cursor.lnum = lnum;
6003 curwin->w_cursor.col = 0;
6004 if (*cmd == NUL || *cmd == '\n')
6005 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6006 else
6007 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6008}
6009
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010/*
6011 * Execute a global command of the form:
6012 *
6013 * g/pattern/X : execute X on all lines where pattern matches
6014 * v/pattern/X : execute X on all lines where pattern does not match
6015 *
6016 * where 'X' is an EX command
6017 *
6018 * The command character (as well as the trailing slash) is optional, and
6019 * is assumed to be 'p' if missing.
6020 *
6021 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006022 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 * for each line that has a mark. This is required because after deleting
6024 * lines we do not know where to search for the next match.
6025 */
6026 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006027ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028{
6029 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006030 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 int type; /* first char of cmd: 'v' or 'g' */
6032 char_u *cmd; /* command argument */
6033
6034 char_u delim; /* delimiter, normally '/' */
6035 char_u *pat;
6036 regmmatch_T regmatch;
6037 int match;
6038 int which_pat;
6039
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006040 /* When nesting the command works on one line. This allows for
6041 * ":g/found/v/notfound/command". */
6042 if (global_busy && (eap->line1 != 1
6043 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006045 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006046 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 return;
6048 }
6049
6050 if (eap->forceit) /* ":global!" is like ":vglobal" */
6051 type = 'v';
6052 else
6053 type = *eap->cmd;
6054 cmd = eap->arg;
6055 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056
6057 /*
6058 * undocumented vi feature:
6059 * "\/" and "\?": use previous search pattern.
6060 * "\&": use previous substitute pattern.
6061 */
6062 if (*cmd == '\\')
6063 {
6064 ++cmd;
6065 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
6066 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006067 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 return;
6069 }
6070 if (*cmd == '&')
6071 which_pat = RE_SUBST; /* use previous substitute pattern */
6072 else
6073 which_pat = RE_SEARCH; /* use previous search pattern */
6074 ++cmd;
6075 pat = (char_u *)"";
6076 }
6077 else if (*cmd == NUL)
6078 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006079 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 return;
6081 }
6082 else
6083 {
6084 delim = *cmd; /* get the delimiter */
6085 if (delim)
6086 ++cmd; /* skip delimiter if there is one */
6087 pat = cmd; /* remember start of pattern */
6088 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
6089 if (cmd[0] == delim) /* end delimiter found */
6090 *cmd++ = NUL; /* replace it with a NUL */
6091 }
6092
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6094 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006095 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 return;
6097 }
6098
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006099 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006101 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006102 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006103 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006105 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 }
6107 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006108 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006109 /*
6110 * pass 1: set marks for each (not) matching line
6111 */
6112 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6113 {
6114 /* a match on this line? */
6115 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006116 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006117 if ((type == 'g' && match) || (type == 'v' && !match))
6118 {
6119 ml_setmarked(lnum);
6120 ndone++;
6121 }
6122 line_breakcheck();
6123 }
6124
6125 /*
6126 * pass 2: execute the command for each line that has been marked
6127 */
6128 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006129 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006130 else if (ndone == 0)
6131 {
6132 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006133 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006134 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006135 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006136 }
6137 else
6138 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006139#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006140 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006141#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006142 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006143#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006144 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006145#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006146 }
6147
6148 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006149 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150
Bram Moolenaar473de612013-06-08 18:19:48 +02006151 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152}
6153
6154/*
6155 * Execute "cmd" on lines marked with ml_setmarked().
6156 */
6157 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006158global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006160 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6161 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6162 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163
6164 /*
6165 * Set current position only once for a global command.
6166 * If global_busy is set, setpcmark() will not do anything.
6167 * If there is an error, global_busy will be incremented.
6168 */
6169 setpcmark();
6170
6171 /* When the command writes a message, don't overwrite the command. */
6172 msg_didout = TRUE;
6173
Bram Moolenaard25bc232010-03-23 17:49:24 +01006174 sub_nsubs = 0;
6175 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 global_need_beginline = FALSE;
6177 global_busy = 1;
6178 old_lcount = curbuf->b_ml.ml_line_count;
6179 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6180 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006181 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 ui_breakcheck();
6183 }
6184
6185 global_busy = 0;
6186 if (global_need_beginline)
6187 beginline(BL_WHITE | BL_FIX);
6188 else
6189 check_cursor(); /* cursor may be beyond the end of the line */
6190
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006191 /* the cursor may not have moved in the text but a change in a previous
6192 * line may move it on the screen */
6193 changed_line_abv_curs();
6194
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 /* If it looks like no message was written, allow overwriting the
6196 * command with the report for number of changes. */
6197 if (msg_col == 0 && msg_scrolled == 0)
6198 msg_didout = FALSE;
6199
Bram Moolenaar45667512007-05-10 19:24:43 +00006200 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006201 * number of extra or deleted lines.
6202 * Don't report extra or deleted lines in the edge case where the buffer
6203 * we are in after execution is different from the buffer we started in. */
6204 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6206}
6207
6208#ifdef FEAT_VIMINFO
6209 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006210read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006212 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 vim_free(old_sub);
6214 if (force || old_sub == NULL)
6215 old_sub = viminfo_readstring(virp, 1, TRUE);
6216 return viminfo_readline(virp);
6217}
6218
6219 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006220write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221{
6222 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6223 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006224 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 viminfo_writestring(fp, old_sub);
6226 }
6227}
6228#endif /* FEAT_VIMINFO */
6229
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006230#if defined(EXITFREE) || defined(PROTO)
6231 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006232free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006233{
6234 vim_free(old_sub);
6235}
6236#endif
6237
Bram Moolenaar4033c552017-09-16 20:54:51 +02006238#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239/*
6240 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006241 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006243 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006244prepare_tagpreview(
6245 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246{
6247 win_T *wp;
6248
6249# ifdef FEAT_GUI
6250 need_mouse_correct = TRUE;
6251# endif
6252
6253 /*
6254 * If there is already a preview window open, use that one.
6255 */
6256 if (!curwin->w_p_pvw)
6257 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006258 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 if (wp->w_p_pvw)
6260 break;
6261 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006262 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 else
6264 {
6265 /*
6266 * There is no preview window open yet. Create one.
6267 */
6268 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6269 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006270 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 curwin->w_p_pvw = TRUE;
6272 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006273 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6274 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275# ifdef FEAT_DIFF
6276 curwin->w_p_diff = FALSE; /* no 'diff' */
6277# endif
6278# ifdef FEAT_FOLDING
6279 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6280# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006281 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 }
6283 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006284 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285}
6286
6287#endif
6288
6289
6290/*
6291 * ":help": open a read-only window on a help file
6292 */
6293 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006294ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295{
6296 char_u *arg;
6297 char_u *tag;
6298 FILE *helpfd; /* file descriptor of help file */
6299 int n;
6300 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 int num_matches;
6303 char_u **matches;
6304 char_u *p;
6305 int empty_fnum = 0;
6306 int alt_fnum = 0;
6307 buf_T *buf;
6308#ifdef FEAT_MULTI_LANG
6309 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006310 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006312#ifdef FEAT_FOLDING
6313 int old_KeyTyped = KeyTyped;
6314#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315
6316 if (eap != NULL)
6317 {
6318 /*
6319 * A ":help" command ends at the first LF, or at a '|' that is
6320 * followed by some text. Set nextcmd to the following command.
6321 */
6322 for (arg = eap->arg; *arg; ++arg)
6323 {
6324 if (*arg == '\n' || *arg == '\r'
6325 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6326 {
6327 *arg++ = NUL;
6328 eap->nextcmd = arg;
6329 break;
6330 }
6331 }
6332 arg = eap->arg;
6333
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006334 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006336 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 return;
6338 }
6339
6340 if (eap->skip) /* not executing commands */
6341 return;
6342 }
6343 else
6344 arg = (char_u *)"";
6345
6346 /* remove trailing blanks */
6347 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006348 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 *p-- = NUL;
6350
6351#ifdef FEAT_MULTI_LANG
6352 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006353 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354#endif
6355
6356 /* When no argument given go to the index. */
6357 if (*arg == NUL)
6358 arg = (char_u *)"help.txt";
6359
6360 /*
6361 * Check if there is a match for the argument.
6362 */
6363 n = find_help_tags(arg, &num_matches, &matches,
6364 eap != NULL && eap->forceit);
6365
6366 i = 0;
6367#ifdef FEAT_MULTI_LANG
6368 if (n != FAIL && lang != NULL)
6369 /* Find first item with the requested language. */
6370 for (i = 0; i < num_matches; ++i)
6371 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006372 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 if (len > 3 && matches[i][len - 3] == '@'
6374 && STRICMP(matches[i] + len - 2, lang) == 0)
6375 break;
6376 }
6377#endif
6378 if (i >= num_matches || n == FAIL)
6379 {
6380#ifdef FEAT_MULTI_LANG
6381 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006382 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 else
6384#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006385 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 if (n != FAIL)
6387 FreeWild(num_matches, matches);
6388 return;
6389 }
6390
6391 /* The first match (in the requested language) is the best match. */
6392 tag = vim_strsave(matches[i]);
6393 FreeWild(num_matches, matches);
6394
6395#ifdef FEAT_GUI
6396 need_mouse_correct = TRUE;
6397#endif
6398
6399 /*
6400 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006401 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006403 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006405 if (cmdmod.tab != 0)
6406 wp = NULL;
6407 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006408 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006409 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006410 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6412 win_enter(wp, TRUE);
6413 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 {
6415 /*
6416 * There is no help window yet.
6417 * Try to open the file specified by the "helpfile" option.
6418 */
6419 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6420 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006421 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 goto erret;
6423 }
6424 fclose(helpfd);
6425
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006427 * specified, the current window is vertically split and
6428 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006431 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006434 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 if (curwin->w_height < p_hh)
6437 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438
6439 /*
6440 * Open help file (do_ecmd() will set b_help flag, readfile() will
6441 * set b_p_ro flag).
6442 * Set the alternate file to the previously edited file.
6443 */
6444 alt_fnum = curbuf->b_fnum;
6445 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006446 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006447 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006448 if (!cmdmod.keepalt)
6449 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 empty_fnum = curbuf->b_fnum;
6451 }
6452 }
6453
6454 if (!p_im)
6455 restart_edit = 0; /* don't want insert mode in help file */
6456
Bram Moolenaar8f535582011-09-30 17:30:31 +02006457#ifdef FEAT_FOLDING
6458 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6459 * It is needed for do_tag top open folds under the cursor. */
6460 KeyTyped = old_KeyTyped;
6461#endif
6462
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 if (tag != NULL)
6464 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6465
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006466 /* Delete the empty buffer if we're not using it. Careful: autocommands
6467 * may have jumped to another window, check that the buffer is not in a
6468 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6470 {
6471 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006472 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 wipe_buffer(buf, TRUE);
6474 }
6475
6476 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006477 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 curwin->w_alt_fnum = alt_fnum;
6479
6480erret:
6481 vim_free(tag);
6482}
6483
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006484/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006485 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006486 */
6487 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006488ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006489{
6490 win_T *win;
6491
6492 FOR_ALL_WINDOWS(win)
6493 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006494 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006495 {
6496 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006497 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006498 }
6499 }
6500}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006502#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6503/*
6504 * In an argument search for a language specifiers in the form "@xx".
6505 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6506 * Returns NULL if not found.
6507 */
6508 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006509check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006510{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006511 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006512
6513 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6514 && ASCII_ISALPHA(arg[len - 1]))
6515 {
6516 arg[len - 3] = NUL; /* remove the '@' */
6517 return arg + len - 2;
6518 }
6519 return NULL;
6520}
6521#endif
6522
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523/*
6524 * Return a heuristic indicating how well the given string matches. The
6525 * smaller the number, the better the match. This is the order of priorities,
6526 * from best match to worst match:
6527 * - Match with least alpha-numeric characters is better.
6528 * - Match with least total characters is better.
6529 * - Match towards the start is better.
6530 * - Match starting with "+" is worse (feature instead of command)
6531 * Assumption is made that the matched_string passed has already been found to
6532 * match some string for which help is requested. webb.
6533 */
6534 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006535help_heuristic(
6536 char_u *matched_string,
6537 int offset, /* offset for match */
6538 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539{
6540 int num_letters;
6541 char_u *p;
6542
6543 num_letters = 0;
6544 for (p = matched_string; *p; p++)
6545 if (ASCII_ISALNUM(*p))
6546 num_letters++;
6547
6548 /*
6549 * Multiply the number of letters by 100 to give it a much bigger
6550 * weighting than the number of characters.
6551 * If there only is a match while ignoring case, add 5000.
6552 * If the match starts in the middle of a word, add 10000 to put it
6553 * somewhere in the last half.
6554 * If the match is more than 2 chars from the start, multiply by 200 to
6555 * put it after matches at the start.
6556 */
6557 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6558 && ASCII_ISALNUM(matched_string[offset - 1]))
6559 offset += 10000;
6560 else if (offset > 2)
6561 offset *= 200;
6562 if (wrong_case)
6563 offset += 5000;
6564 /* Features are less interesting than the subjects themselves, but "+"
6565 * alone is not a feature. */
6566 if (matched_string[0] == '+' && matched_string[1] != NUL)
6567 offset += 100;
6568 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6569}
6570
6571/*
6572 * Compare functions for qsort() below, that checks the help heuristics number
6573 * that has been put after the tagname by find_tags().
6574 */
6575 static int
6576#ifdef __BORLANDC__
6577_RTLENTRYF
6578#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006579help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580{
6581 char *p1;
6582 char *p2;
6583
6584 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6585 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6586 return strcmp(p1, p2);
6587}
6588
6589/*
6590 * Find all help tags matching "arg", sort them and return in matches[], with
6591 * the number of matches in num_matches.
6592 * The matches will be sorted with a "best" match algorithm.
6593 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6594 */
6595 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006596find_help_tags(
6597 char_u *arg,
6598 int *num_matches,
6599 char_u ***matches,
6600 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601{
6602 char_u *s, *d;
6603 int i;
6604 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006605 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006606 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006607 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6608 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006609 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006610 "[count]", "[quotex]",
6611 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006612 "[pattern]", "\\|", "\\%$",
6613 "s/\\~", "s/\\U", "s/\\L",
6614 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006616 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006617 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006618 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6619 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006620 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006621 "\\[count]", "\\[quotex]",
6622 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006623 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006624 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006625 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006626 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
6627 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 int flags;
6629
6630 d = IObuff; /* assume IObuff is long enough! */
6631
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006632 if (STRNICMP(arg, "expr-", 5) == 0)
6633 {
6634 // When the string starting with "expr-" and containing '?' and matches
6635 // the table, it is taken literally. Otherwise '?' is recognized as a
6636 // wildcard.
6637 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
6638 if (STRCMP(arg + 5, expr_table[i]) == 0)
6639 {
6640 STRCPY(d, arg);
6641 break;
6642 }
6643 }
6644 else
6645 {
6646 // Recognize a few exceptions to the rule. Some strings that contain
6647 // '*' with "star". Otherwise '*' is recognized as a wildcard.
6648 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
6649 if (STRCMP(arg, mtable[i]) == 0)
6650 {
6651 STRCPY(d, rtable[i]);
6652 break;
6653 }
6654 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655
6656 if (i < 0) /* no match in table */
6657 {
6658 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6659 * Also replace "\%^" and "\%(", they match every tag too.
6660 * Also "\zs", "\z1", etc.
6661 * Also "\@<", "\@=", "\@<=", etc.
6662 * And also "\_$" and "\_^". */
6663 if (arg[0] == '\\'
6664 && ((arg[1] != NUL && arg[2] == NUL)
6665 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6666 && arg[2] != NUL)))
6667 {
6668 STRCPY(d, "/\\\\");
6669 STRCPY(d + 3, arg + 1);
6670 /* Check for "/\\_$", should be "/\\_\$" */
6671 if (d[3] == '_' && d[4] == '$')
6672 STRCPY(d + 4, "\\$");
6673 }
6674 else
6675 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006676 /* Replace:
6677 * "[:...:]" with "\[:...:]"
6678 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006679 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006680 */
6681 if ((arg[0] == '[' && (arg[1] == ':'
6682 || (arg[1] == '+' && arg[2] == '+')))
6683 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 *d++ = '\\';
6685
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006686 /*
6687 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6688 */
6689 if (*arg == '(' && arg[1] == '\'')
6690 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 for (s = arg; *s; ++s)
6692 {
6693 /*
6694 * Replace "|" with "bar" and '"' with "quote" to match the name of
6695 * the tags for these commands.
6696 * Replace "*" with ".*" and "?" with "." to match command line
6697 * completion.
6698 * Insert a backslash before '~', '$' and '.' to avoid their
6699 * special meaning.
6700 */
6701 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6702 break;
6703 switch (*s)
6704 {
6705 case '|': STRCPY(d, "bar");
6706 d += 3;
6707 continue;
6708 case '"': STRCPY(d, "quote");
6709 d += 5;
6710 continue;
6711 case '*': *d++ = '.';
6712 break;
6713 case '?': *d++ = '.';
6714 continue;
6715 case '$':
6716 case '.':
6717 case '~': *d++ = '\\';
6718 break;
6719 }
6720
6721 /*
6722 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6723 * ":help i_^_CTRL-D" work.
6724 * Insert '-' before and after "CTRL-X" when applicable.
6725 */
6726 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6727 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6728 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006729 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6730 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 STRCPY(d, "CTRL-");
6732 d += 5;
6733 if (*s < ' ')
6734 {
6735#ifdef EBCDIC
6736 *d++ = CtrlChar(*s);
6737#else
6738 *d++ = *s + '@';
6739#endif
6740 if (d[-1] == '\\')
6741 *d++ = '\\'; /* double a backslash */
6742 }
6743 else
6744 *d++ = *++s;
6745 if (s[1] != NUL && s[1] != '_')
6746 *d++ = '_'; /* append a '_' */
6747 continue;
6748 }
6749 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6750 *d++ = '\\';
6751
6752 /*
6753 * Insert a backslash before a backslash after a slash, for search
6754 * pattern tags: "/\|" --> "/\\|".
6755 */
6756 else if (s[0] == '\\' && s[1] != '\\'
6757 && *arg == '/' && s == arg + 1)
6758 *d++ = '\\';
6759
6760 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6761 * "CTRL-\_CTRL-N" */
6762 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6763 {
6764 STRCPY(d, "CTRL-\\\\");
6765 d += 7;
6766 s += 6;
6767 }
6768
6769 *d++ = *s;
6770
6771 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006772 * If tag contains "({" or "([", tag terminates at the "(".
6773 * This is for help on functions, e.g.: abs({expr}).
6774 */
6775 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6776 break;
6777
6778 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 * If tag starts with ', toss everything after a second '. Fixes
6780 * CTRL-] on 'option'. (would include the trailing '.').
6781 */
6782 if (*s == '\'' && s > arg && *arg == '\'')
6783 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006784 /* Also '{' and '}'. */
6785 if (*s == '}' && s > arg && *arg == '{')
6786 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 }
6788 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006789
6790 if (*IObuff == '`')
6791 {
6792 if (d > IObuff + 2 && d[-1] == '`')
6793 {
6794 /* remove the backticks from `command` */
6795 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6796 d[-2] = NUL;
6797 }
6798 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6799 {
6800 /* remove the backticks and comma from `command`, */
6801 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6802 d[-3] = NUL;
6803 }
6804 else if (d > IObuff + 4 && d[-3] == '`'
6805 && d[-2] == '\\' && d[-1] == '.')
6806 {
6807 /* remove the backticks and dot from `command`\. */
6808 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6809 d[-4] = NUL;
6810 }
6811 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 }
6813 }
6814
6815 *matches = (char_u **)"";
6816 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02006817 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 if (keep_lang)
6819 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006820 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006822 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 /* Sort the matches found on the heuristic number that is after the
6824 * tag name. */
6825 qsort((void *)*matches, (size_t)*num_matches,
6826 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006827 /* Delete more than TAG_MANY to reduce the size of the listing. */
6828 while (*num_matches > TAG_MANY)
6829 vim_free((*matches)[--*num_matches]);
6830 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 return OK;
6832}
6833
6834/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006835 * Called when starting to edit a buffer for a help file.
6836 */
6837 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006838prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006839{
6840 char_u *p;
6841
6842 curbuf->b_help = TRUE;
6843#ifdef FEAT_QUICKFIX
6844 set_string_option_direct((char_u *)"buftype", -1,
6845 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6846#endif
6847
6848 /*
6849 * Always set these options after jumping to a help tag, because the
6850 * user may have an autocommand that gets in the way.
6851 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6852 * latin1 word characters (for translated help files).
6853 * Only set it when needed, buf_init_chartab() is some work.
6854 */
6855 p =
6856#ifdef EBCDIC
6857 (char_u *)"65-255,^*,^|,^\"";
6858#else
6859 (char_u *)"!-~,^*,^|,^\",192-255";
6860#endif
6861 if (STRCMP(curbuf->b_p_isk, p) != 0)
6862 {
6863 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6864 check_buf_options(curbuf);
6865 (void)buf_init_chartab(curbuf, FALSE);
6866 }
6867
Bram Moolenaar0b105412014-11-30 13:34:23 +01006868#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006869 /* Don't use the global foldmethod.*/
6870 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6871 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006872#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006873
6874 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6875 curwin->w_p_list = FALSE; /* no list mode */
6876
6877 curbuf->b_p_ma = FALSE; /* not modifiable */
6878 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6879 curwin->w_p_nu = 0; /* no line numbers */
6880 curwin->w_p_rnu = 0; /* no relative line numbers */
6881 RESET_BINDING(curwin); /* no scroll or cursor binding */
6882#ifdef FEAT_ARABIC
6883 curwin->w_p_arab = FALSE; /* no arabic mode */
6884#endif
6885#ifdef FEAT_RIGHTLEFT
6886 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6887#endif
6888#ifdef FEAT_FOLDING
6889 curwin->w_p_fen = FALSE; /* No folding in the help window */
6890#endif
6891#ifdef FEAT_DIFF
6892 curwin->w_p_diff = FALSE; /* No 'diff' */
6893#endif
6894#ifdef FEAT_SPELL
6895 curwin->w_p_spell = FALSE; /* No spell checking */
6896#endif
6897
6898 set_buflisted(FALSE);
6899}
6900
6901/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 * After reading a help file: May cleanup a help buffer when syntax
6903 * highlighting is not used.
6904 */
6905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006906fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907{
6908 linenr_T lnum;
6909 char_u *line;
6910 int in_example = FALSE;
6911 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006912 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 char_u *p;
6914 char_u *rt;
6915 int mustfree;
6916
Bram Moolenaar90492982017-06-22 14:16:31 +02006917 /* Set filetype to "help" if still needed. */
6918 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006919 {
6920 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006921 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006922 --curbuf_lock;
6923 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924
6925#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006926 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927#endif
6928 {
6929 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6930 {
6931 line = ml_get_buf(curbuf, lnum, FALSE);
6932 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006933 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 {
6935 /* End of example: non-white or '<' in first column. */
6936 if (line[0] == '<')
6937 {
6938 /* blank-out a '<' in the first column */
6939 line = ml_get_buf(curbuf, lnum, TRUE);
6940 line[0] = ' ';
6941 }
6942 in_example = FALSE;
6943 }
6944 if (!in_example && len > 0)
6945 {
6946 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6947 {
6948 /* blank-out a '>' in the last column (start of example) */
6949 line = ml_get_buf(curbuf, lnum, TRUE);
6950 line[len - 1] = ' ';
6951 in_example = TRUE;
6952 }
6953 else if (line[len - 1] == '~')
6954 {
6955 /* blank-out a '~' at the end of line (header marker) */
6956 line = ml_get_buf(curbuf, lnum, TRUE);
6957 line[len - 1] = ' ';
6958 }
6959 }
6960 }
6961 }
6962
6963 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006964 * In the "help.txt" and "help.abx" file, add the locally added help
6965 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006967 fname = gettail(curbuf->b_fname);
6968 if (fnamecmp(fname, "help.txt") == 0
6969#ifdef FEAT_MULTI_LANG
6970 || (fnamencmp(fname, "help.", 5) == 0
6971 && ASCII_ISALPHA(fname[5])
6972 && ASCII_ISALPHA(fname[6])
6973 && TOLOWER_ASC(fname[7]) == 'x'
6974 && fname[8] == NUL)
6975#endif
6976 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 {
6978 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6979 {
6980 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006981 if (strstr((char *)line, "*local-additions*") == NULL)
6982 continue;
6983
6984 /* Go through all directories in 'runtimepath', skipping
6985 * $VIMRUNTIME. */
6986 p = p_rtp;
6987 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006989 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6990 mustfree = FALSE;
6991 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006992 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006994 int fcount;
6995 char_u **fnames;
6996 FILE *fd;
6997 char_u *s;
6998 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006999 vimconv_T vc;
7000 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007002 /* Find all "doc/ *.txt" files in this directory. */
7003 add_pathsep(NameBuff);
7004#ifdef FEAT_MULTI_LANG
7005 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007007 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007009 if (gen_expand_wildcards(1, &NameBuff, &fcount,
7010 &fnames, EW_FILE|EW_SILENT) == OK
7011 && fcount > 0)
7012 {
7013#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007014 int i1, i2;
7015 char_u *f1, *f2;
7016 char_u *t1, *t2;
7017 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007018
7019 /* If foo.abx is found use it instead of foo.txt in
7020 * the same directory. */
7021 for (i1 = 0; i1 < fcount; ++i1)
7022 {
7023 for (i2 = 0; i2 < fcount; ++i2)
7024 {
7025 if (i1 == i2)
7026 continue;
7027 if (fnames[i1] == NULL || fnames[i2] == NULL)
7028 continue;
7029 f1 = fnames[i1];
7030 f2 = fnames[i2];
7031 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007032 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007033 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007034 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02007035 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007036 continue;
7037 if (fnamecmp(e1, ".txt") != 0
7038 && fnamecmp(e1, fname + 4) != 0)
7039 {
7040 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007041 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007042 continue;
7043 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007044 if (e1 - f1 != e2 - f2
7045 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007046 continue;
7047 if (fnamecmp(e1, ".txt") == 0
7048 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007049 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007050 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007053#endif
7054 for (fi = 0; fi < fcount; ++fi)
7055 {
7056 if (fnames[fi] == NULL)
7057 continue;
7058 fd = mch_fopen((char *)fnames[fi], "r");
7059 if (fd != NULL)
7060 {
7061 vim_fgets(IObuff, IOSIZE, fd);
7062 if (IObuff[0] == '*'
7063 && (s = vim_strchr(IObuff + 1, '*'))
7064 != NULL)
7065 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007066 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01007067
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007068 /* Change tag definition to a
7069 * reference and remove <CR>/<NL>. */
7070 IObuff[0] = '|';
7071 *s = '|';
7072 while (*s != NUL)
7073 {
7074 if (*s == '\r' || *s == '\n')
7075 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007076 /* The text is utf-8 when a byte
7077 * above 127 is found and no
7078 * illegal byte sequence is found.
7079 */
7080 if (*s >= 0x80 && this_utf != FALSE)
7081 {
7082 int l;
7083
7084 this_utf = TRUE;
7085 l = utf_ptr2len(s);
7086 if (l == 1)
7087 this_utf = FALSE;
7088 s += l - 1;
7089 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007090 ++s;
7091 }
Bram Moolenaar13505972019-01-24 15:04:48 +01007092
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007093 /* The help file is latin1 or utf-8;
7094 * conversion to the current
7095 * 'encoding' may be required. */
7096 vc.vc_type = CONV_NONE;
7097 convert_setup(&vc, (char_u *)(
7098 this_utf == TRUE ? "utf-8"
7099 : "latin1"), p_enc);
7100 if (vc.vc_type == CONV_NONE)
7101 /* No conversion needed. */
7102 cp = IObuff;
7103 else
7104 {
7105 /* Do the conversion. If it fails
7106 * use the unconverted text. */
7107 cp = string_convert(&vc, IObuff,
7108 NULL);
7109 if (cp == NULL)
7110 cp = IObuff;
7111 }
7112 convert_setup(&vc, NULL, NULL);
7113
7114 ml_append(lnum, cp, (colnr_T)0, FALSE);
7115 if (cp != IObuff)
7116 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007117 ++lnum;
7118 }
7119 fclose(fd);
7120 }
7121 }
7122 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007125 if (mustfree)
7126 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007128 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 }
7130 }
7131}
7132
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007133/*
7134 * ":exusage"
7135 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007136 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007137ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007138{
7139 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7140}
7141
7142/*
7143 * ":viusage"
7144 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007145 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007146ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007147{
7148 do_cmdline_cmd((char_u *)"help normal-index");
7149}
7150
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007152 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007155helptags_one(
7156 char_u *dir, /* doc directory */
7157 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7158 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7159 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160{
7161 FILE *fd_tags;
7162 FILE *fd;
7163 garray_T ga;
7164 int filecount;
7165 char_u **files;
7166 char_u *p1, *p2;
7167 int fi;
7168 char_u *s;
7169 int i;
7170 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007171 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 int utf8 = MAYBE;
7173 int this_utf8;
7174 int firstline;
7175 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176
7177 /*
7178 * Find all *.txt files.
7179 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007180 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007182 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 STRCAT(NameBuff, ext);
7184 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7185 EW_FILE|EW_SILENT) == FAIL
7186 || filecount == 0)
7187 {
7188 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007189 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 return;
7191 }
7192
7193 /*
7194 * Open the tags file for writing.
7195 * Do this before scanning through all the files.
7196 */
7197 STRCPY(NameBuff, dir);
7198 add_pathsep(NameBuff);
7199 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007200 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 if (fd_tags == NULL)
7202 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007203 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 FreeWild(filecount, files);
7205 return;
7206 }
7207
7208 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007209 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7210 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 */
7212 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007213 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7214 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 {
7216 if (ga_grow(&ga, 1) == FAIL)
7217 got_int = TRUE;
7218 else
7219 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007220 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 if (s == NULL)
7222 got_int = TRUE;
7223 else
7224 {
7225 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7226 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7227 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 }
7229 }
7230 }
7231
7232 /*
7233 * Go over all the files and extract the tags.
7234 */
7235 for (fi = 0; fi < filecount && !got_int; ++fi)
7236 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007237 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 if (fd == NULL)
7239 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007240 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 continue;
7242 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007243 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7247 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 if (firstline)
7249 {
7250 /* Detect utf-8 file by a non-ASCII char in the first line. */
7251 this_utf8 = MAYBE;
7252 for (s = IObuff; *s != NUL; ++s)
7253 if (*s >= 0x80)
7254 {
7255 int l;
7256
7257 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007258 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 if (l == 1)
7260 {
7261 /* Illegal UTF-8 byte sequence. */
7262 this_utf8 = FALSE;
7263 break;
7264 }
7265 s += l - 1;
7266 }
7267 if (this_utf8 == MAYBE) /* only ASCII characters found */
7268 this_utf8 = FALSE;
7269 if (utf8 == MAYBE) /* first file */
7270 utf8 = this_utf8;
7271 else if (utf8 != this_utf8)
7272 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007273 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 mix = !got_int;
7275 got_int = TRUE;
7276 }
7277 firstline = FALSE;
7278 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7280 while (p1 != NULL)
7281 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007282 /* Use vim_strbyte() instead of vim_strchr() so that when
7283 * 'encoding' is dbcs it still works, don't find '*' in the
7284 * second byte. */
7285 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7287 {
7288 for (s = p1 + 1; s < p2; ++s)
7289 if (*s == ' ' || *s == '\t' || *s == '|')
7290 break;
7291
7292 /*
7293 * Only accept a *tag* when it consists of valid
7294 * characters, there is white space before it and is
7295 * followed by a white character or end-of-line.
7296 */
7297 if (s == p2
7298 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7299 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7300 || s[1] == '\0'))
7301 {
7302 *p2 = '\0';
7303 ++p1;
7304 if (ga_grow(&ga, 1) == FAIL)
7305 {
7306 got_int = TRUE;
7307 break;
7308 }
7309 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7310 if (s == NULL)
7311 {
7312 got_int = TRUE;
7313 break;
7314 }
7315 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7316 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 sprintf((char *)s, "%s\t%s", p1, fname);
7318
7319 /* find next '*' */
7320 p2 = vim_strchr(p2 + 1, '*');
7321 }
7322 }
7323 p1 = p2;
7324 }
7325 line_breakcheck();
7326 }
7327
7328 fclose(fd);
7329 }
7330
7331 FreeWild(filecount, files);
7332
7333 if (!got_int)
7334 {
7335 /*
7336 * Sort the tags.
7337 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007338 if (ga.ga_data != NULL)
7339 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340
7341 /*
7342 * Check for duplicates.
7343 */
7344 for (i = 1; i < ga.ga_len; ++i)
7345 {
7346 p1 = ((char_u **)ga.ga_data)[i - 1];
7347 p2 = ((char_u **)ga.ga_data)[i];
7348 while (*p1 == *p2)
7349 {
7350 if (*p2 == '\t')
7351 {
7352 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007353 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7355 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007356 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 *p2 = '\t';
7358 break;
7359 }
7360 ++p1;
7361 ++p2;
7362 }
7363 }
7364
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 if (utf8 == TRUE)
7366 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367
7368 /*
7369 * Write the tags into the file.
7370 */
7371 for (i = 0; i < ga.ga_len; ++i)
7372 {
7373 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007374 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007376 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 else
7378 {
7379 fprintf(fd_tags, "%s\t/*", s);
7380 for (p1 = s; *p1 != '\t'; ++p1)
7381 {
7382 /* insert backslash before '\\' and '/' */
7383 if (*p1 == '\\' || *p1 == '/')
7384 putc('\\', fd_tags);
7385 putc(*p1, fd_tags);
7386 }
7387 fprintf(fd_tags, "*\n");
7388 }
7389 }
7390 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 if (mix)
7392 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393
7394 for (i = 0; i < ga.ga_len; ++i)
7395 vim_free(((char_u **)ga.ga_data)[i]);
7396 ga_clear(&ga);
7397 fclose(fd_tags); /* there is no check for an error... */
7398}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007400/*
7401 * Generate tags in one help directory, taking care of translations.
7402 */
7403 static void
7404do_helptags(char_u *dirname, int add_help_tags)
7405{
7406#ifdef FEAT_MULTI_LANG
7407 int len;
7408 int i, j;
7409 garray_T ga;
7410 char_u lang[2];
7411 char_u ext[5];
7412 char_u fname[8];
7413 int filecount;
7414 char_u **files;
7415
7416 /* Get a list of all files in the help directory and in subdirectories. */
7417 STRCPY(NameBuff, dirname);
7418 add_pathsep(NameBuff);
7419 STRCAT(NameBuff, "**");
7420 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7421 EW_FILE|EW_SILENT) == FAIL
7422 || filecount == 0)
7423 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007424 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007425 return;
7426 }
7427
7428 /* Go over all files in the directory to find out what languages are
7429 * present. */
7430 ga_init2(&ga, 1, 10);
7431 for (i = 0; i < filecount; ++i)
7432 {
7433 len = (int)STRLEN(files[i]);
7434 if (len > 4)
7435 {
7436 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7437 {
7438 /* ".txt" -> language "en" */
7439 lang[0] = 'e';
7440 lang[1] = 'n';
7441 }
7442 else if (files[i][len - 4] == '.'
7443 && ASCII_ISALPHA(files[i][len - 3])
7444 && ASCII_ISALPHA(files[i][len - 2])
7445 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7446 {
7447 /* ".abx" -> language "ab" */
7448 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7449 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7450 }
7451 else
7452 continue;
7453
7454 /* Did we find this language already? */
7455 for (j = 0; j < ga.ga_len; j += 2)
7456 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7457 break;
7458 if (j == ga.ga_len)
7459 {
7460 /* New language, add it. */
7461 if (ga_grow(&ga, 2) == FAIL)
7462 break;
7463 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7464 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7465 }
7466 }
7467 }
7468
7469 /*
7470 * Loop over the found languages to generate a tags file for each one.
7471 */
7472 for (j = 0; j < ga.ga_len; j += 2)
7473 {
7474 STRCPY(fname, "tags-xx");
7475 fname[5] = ((char_u *)ga.ga_data)[j];
7476 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7477 if (fname[5] == 'e' && fname[6] == 'n')
7478 {
7479 /* English is an exception: use ".txt" and "tags". */
7480 fname[4] = NUL;
7481 STRCPY(ext, ".txt");
7482 }
7483 else
7484 {
7485 /* Language "ab" uses ".abx" and "tags-ab". */
7486 STRCPY(ext, ".xxx");
7487 ext[1] = fname[5];
7488 ext[2] = fname[6];
7489 }
7490 helptags_one(dirname, ext, fname, add_help_tags);
7491 }
7492
7493 ga_clear(&ga);
7494 FreeWild(filecount, files);
7495
7496#else
7497 /* No language support, just use "*.txt" and "tags". */
7498 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7499#endif
7500}
7501
7502 static void
7503helptags_cb(char_u *fname, void *cookie)
7504{
7505 do_helptags(fname, *(int *)cookie);
7506}
7507
7508/*
7509 * ":helptags"
7510 */
7511 void
7512ex_helptags(exarg_T *eap)
7513{
7514 expand_T xpc;
7515 char_u *dirname;
7516 int add_help_tags = FALSE;
7517
7518 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007519 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007520 {
7521 add_help_tags = TRUE;
7522 eap->arg = skipwhite(eap->arg + 3);
7523 }
7524
7525 if (STRCMP(eap->arg, "ALL") == 0)
7526 {
7527 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7528 helptags_cb, &add_help_tags);
7529 }
7530 else
7531 {
7532 ExpandInit(&xpc);
7533 xpc.xp_context = EXPAND_DIRECTORIES;
7534 dirname = ExpandOne(&xpc, eap->arg, NULL,
7535 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7536 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007537 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007538 else
7539 do_helptags(dirname, add_help_tags);
7540 vim_free(dirname);
7541 }
7542}
7543
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007544/*
7545 * Make the user happy.
7546 */
7547 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007548ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007549{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007550 static char *code[] = {
7551 "\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$",
7552 "\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"
7553 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007554 char *p;
7555 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007556 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007557
7558 msg_start();
7559 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007560 for (i = 0; i < 2; ++i)
7561 for (p = code[i]; *p != NUL; ++p)
7562 if (*p == 'x')
7563 msg_putchar('\n');
7564 else
7565 for (n = *p++; n > 0; --n)
7566 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01007567 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007568 else
7569 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007570 msg_clr_eos();
7571}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573/*
7574 * ":drop"
7575 * Opens the first argument in a window. When there are two or more arguments
7576 * the argument list is redefined.
7577 */
7578 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007579ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580{
7581 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 win_T *wp;
7583 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007584 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585
7586 /*
7587 * Check if the first argument is already being edited in a window. If
7588 * so, jump to that window.
7589 * We would actually need to check all arguments, but that's complicated
7590 * and mostly only one file is dropped.
7591 * This also ignores wildcards, since it is very unlikely the user is
7592 * editing a file name with a wildcard character.
7593 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007594 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007596 /*
7597 * Expanding wildcards may result in an empty argument list. E.g. when
7598 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7599 * already did an error message for this.
7600 */
7601 if (ARGCOUNT == 0)
7602 return;
7603
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007604 if (cmdmod.tab)
7605 {
7606 /* ":tab drop file ...": open a tab for each argument that isn't
7607 * edited in a window yet. It's like ":tab all" but without closing
7608 * windows or tabs. */
7609 ex_all(eap);
7610 }
7611 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007612 {
7613 /* ":drop file ...": Edit the first argument. Jump to an existing
7614 * window if possible, edit in current window if the current buffer
7615 * can be abandoned, otherwise open a new window. */
7616 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7617
7618 FOR_ALL_TAB_WINDOWS(tp, wp)
7619 {
7620 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007622 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 return;
7625 }
7626 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007628 /*
7629 * Check whether the current buffer is changed. If so, we will need
7630 * to split the current window or data could be lost.
7631 * Skip the check if the 'hidden' option is set, as in this case the
7632 * buffer won't be lost.
7633 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02007634 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007635 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007636 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01007637 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007638 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007641 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7642 if (split)
7643 {
7644 eap->cmdidx = CMD_sfirst;
7645 eap->cmd[0] = 's';
7646 }
7647 else
7648 eap->cmdidx = CMD_first;
7649 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007652
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007653/*
7654 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
7655 * Put the start of the pattern in "*s", unless "s" is NULL.
7656 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
7657 * If "s" is not NULL terminate the pattern with a NUL.
7658 * Return a pointer to the char just past the pattern plus flags.
7659 */
7660 char_u *
7661skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
7662{
7663 int c;
7664
7665 if (vim_isIDc(*p))
7666 {
7667 /* ":vimgrep pattern fname" */
7668 if (s != NULL)
7669 *s = p;
7670 p = skiptowhite(p);
7671 if (s != NULL && *p != NUL)
7672 *p++ = NUL;
7673 }
7674 else
7675 {
7676 /* ":vimgrep /pattern/[g][j] fname" */
7677 if (s != NULL)
7678 *s = p + 1;
7679 c = *p;
7680 p = skip_regexp(p + 1, c, TRUE, NULL);
7681 if (*p != c)
7682 return NULL;
7683
7684 /* Truncate the pattern. */
7685 if (s != NULL)
7686 *p = NUL;
7687 ++p;
7688
7689 /* Find the flags */
7690 while (*p == 'g' || *p == 'j')
7691 {
7692 if (flags != NULL)
7693 {
7694 if (*p == 'g')
7695 *flags |= VGR_GLOBAL;
7696 else
7697 *flags |= VGR_NOJUMP;
7698 }
7699 ++p;
7700 }
7701 }
7702 return p;
7703}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007704
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007705#if defined(FEAT_EVAL) || defined(PROTO)
7706/*
7707 * List v:oldfiles in a nice way.
7708 */
7709 void
7710ex_oldfiles(exarg_T *eap UNUSED)
7711{
7712 list_T *l = get_vim_var_list(VV_OLDFILES);
7713 listitem_T *li;
7714 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007715 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007716
7717 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007718 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007719 else
7720 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007721 msg_start();
7722 msg_scroll = TRUE;
7723 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
7724 {
7725 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007726 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02007727 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007728 {
7729 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01007730 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007731 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02007732 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007733 msg_putchar('\n');
7734 out_flush(); /* output one line at a time */
7735 ui_breakcheck();
7736 }
7737 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007738
7739 /* Assume "got_int" was set to truncate the listing. */
7740 got_int = FALSE;
7741
7742# ifdef FEAT_BROWSE_CMD
7743 if (cmdmod.browse)
7744 {
7745 quit_more = FALSE;
7746 nr = prompt_for_number(FALSE);
7747 msg_starthere();
7748 if (nr > 0)
7749 {
7750 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
7751 (long)nr);
7752
7753 if (p != NULL)
7754 {
7755 p = expand_env_save(p);
7756 eap->arg = p;
7757 eap->cmdidx = CMD_edit;
7758 cmdmod.browse = FALSE;
7759 do_exedit(eap, NULL);
7760 vim_free(p);
7761 }
7762 }
7763 }
7764# endif
7765 }
7766}
7767#endif