blob: 0ab5df6c0fca57e78572573f26b8a7549727fc64 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010031static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000032static int
33#ifdef __BORLANDC__
34 _RTLENTRYF
35#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010036 help_compare(const void *s1, const void *s2);
37static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39/*
40 * ":ascii" and "ga".
41 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010043do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000044{
45 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000046 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 char buf1[20];
48 char buf2[20];
49 char_u buf3[7];
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050#ifdef FEAT_DIGRAPHS
51 char_u *dig;
52#endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 c = gchar_cursor();
61 if (c == NUL)
62 {
Bram Moolenaar32526b32019-01-19 17:43:09 +010063 msg("NUL");
Bram Moolenaar071d4272004-06-13 20:20:40 +000064 return;
65 }
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067 IObuff[0] = NUL;
68 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
Bram Moolenaar071d4272004-06-13 20:20:40 +000069 {
70 if (c == NL) /* NUL is stored as NL */
71 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000072 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
73 cval = NL; /* NL is stored as CR */
74 else
75 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 if (vim_isprintc_strict(c) && (c < ' '
77#ifndef EBCDIC
78 || c > '~'
79#endif
80 ))
81 {
82 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000083 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 }
85 else
86 buf1[0] = NUL;
87#ifndef EBCDIC
88 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000089 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
90 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 else
92#endif
93 buf2[0] = NUL;
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010094#ifdef FEAT_DIGRAPHS
95 dig = get_digraph_for_char(cval);
96 if (dig != NULL)
97 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Oct %03o, Digr %s"),
99 transchar(c), buf1, buf2, cval, cval, cval, dig);
100 else
101#endif
102 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar555b2802005-05-19 21:08:39 +0000103 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +0000104 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000105 if (enc_utf8)
106 c = cc[ci++];
107 else
108 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 }
110
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 /* Repeat for combining characters. */
112 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
113 {
114 len = (int)STRLEN(IObuff);
115 /* This assumes every multi-byte char is printable... */
116 if (len > 0)
117 IObuff[len++] = ' ';
118 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000119 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000122# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 )
124 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000125 len += (*mb_char2bytes)(c, IObuff + len);
Bram Moolenaar5f73ef82018-02-27 21:09:30 +0100126#ifdef FEAT_DIGRAPHS
127 dig = get_digraph_for_char(c);
128 if (dig != NULL)
129 vim_snprintf((char *)IObuff + len, IOSIZE - len,
130 c < 0x10000 ? _("> %d, Hex %04x, Oct %o, Digr %s")
131 : _("> %d, Hex %08x, Oct %o, Digr %s"),
132 c, c, c, dig);
133 else
134#endif
135 vim_snprintf((char *)IObuff + len, IOSIZE - len,
136 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
137 : _("> %d, Hex %08x, Octal %o"),
138 c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000139 if (ci == MAX_MCO)
140 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000141 if (enc_utf8)
142 c = cc[ci++];
143 else
144 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
Bram Moolenaar32526b32019-01-19 17:43:09 +0100147 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148}
149
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150/*
151 * ":left", ":center" and ":right": align text.
152 */
153 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100154ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155{
156 pos_T save_curpos;
157 int len;
158 int indent = 0;
159 int new_indent;
160 int has_tab;
161 int width;
162
163#ifdef FEAT_RIGHTLEFT
164 if (curwin->w_p_rl)
165 {
166 /* switch left and right aligning */
167 if (eap->cmdidx == CMD_right)
168 eap->cmdidx = CMD_left;
169 else if (eap->cmdidx == CMD_left)
170 eap->cmdidx = CMD_right;
171 }
172#endif
173
174 width = atoi((char *)eap->arg);
175 save_curpos = curwin->w_cursor;
176 if (eap->cmdidx == CMD_left) /* width is used for new indent */
177 {
178 if (width >= 0)
179 indent = width;
180 }
181 else
182 {
183 /*
184 * if 'textwidth' set, use it
185 * else if 'wrapmargin' set, use it
186 * if invalid value, use 80
187 */
188 if (width <= 0)
189 width = curbuf->b_p_tw;
190 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200191 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192 if (width <= 0)
193 width = 80;
194 }
195
196 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
197 return;
198
199 for (curwin->w_cursor.lnum = eap->line1;
200 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
201 {
202 if (eap->cmdidx == CMD_left) /* left align */
203 new_indent = indent;
204 else
205 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000206 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 len = linelen(eap->cmdidx == CMD_right ? &has_tab
208 : NULL) - get_indent();
209
210 if (len <= 0) /* skip blank lines */
211 continue;
212
213 if (eap->cmdidx == CMD_center)
214 new_indent = (width - len) / 2;
215 else
216 {
217 new_indent = width - len; /* right align */
218
219 /*
220 * Make sure that embedded TABs don't make the text go too far
221 * to the right.
222 */
223 if (has_tab)
224 while (new_indent > 0)
225 {
226 (void)set_indent(new_indent, 0);
227 if (linelen(NULL) <= width)
228 {
229 /*
230 * Now try to move the line as much as possible to
231 * the right. Stop when it moves too far.
232 */
233 do
234 (void)set_indent(++new_indent, 0);
235 while (linelen(NULL) <= width);
236 --new_indent;
237 break;
238 }
239 --new_indent;
240 }
241 }
242 }
243 if (new_indent < 0)
244 new_indent = 0;
245 (void)set_indent(new_indent, 0); /* set indent */
246 }
247 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
248 curwin->w_cursor = save_curpos;
249 beginline(BL_WHITE | BL_FIX);
250}
251
252/*
253 * Get the length of the current line, excluding trailing white space.
254 */
255 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100256linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257{
258 char_u *line;
259 char_u *first;
260 char_u *last;
261 int save;
262 int len;
263
264 /* find the first non-blank character */
265 line = ml_get_curline();
266 first = skipwhite(line);
267
268 /* find the character after the last non-blank character */
269 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100270 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 ;
272 save = *last;
273 *last = NUL;
274 len = linetabsize(line); /* get line length */
275 if (has_tab != NULL) /* check for embedded TAB */
Bram Moolenaarb31a3ac2018-08-11 14:41:55 +0200276 *has_tab = (vim_strchr(first, TAB) != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 *last = save;
278
279 return len;
280}
281
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282/* Buffer for two lines used during sorting. They are allocated to
283 * contain the longest line being sorted. */
284static char_u *sortbuf1;
285static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000286
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100287static int sort_ic; /* ignore case */
288static int sort_nr; /* sort on number */
289static int sort_rx; /* sort on regex instead of skipping it */
290#ifdef FEAT_FLOAT
291static int sort_flt; /* sort on floating number */
292#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000293
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000295
296/* Struct to store info to be sorted. */
297typedef struct
298{
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100299 linenr_T lnum; // line number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100300 union {
301 struct
302 {
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100303 varnumber_T start_col_nr; // starting column number
304 varnumber_T end_col_nr; // ending column number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100305 } line;
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100306 struct
307 {
308 varnumber_T value; // value if sorting by integer
309 int is_number; // TRUE when line contains a number
310 } num;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100311#ifdef FEAT_FLOAT
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100312 float_T value_flt; // value if sorting by float
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100313#endif
314 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000315} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000316
317static int
318#ifdef __BORLANDC__
319_RTLENTRYF
320#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100321sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000322
323 static int
324#ifdef __BORLANDC__
325_RTLENTRYF
326#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100327sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000328{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 sorti_T l1 = *(sorti_T *)s1;
330 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000331 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000332
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000333 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000334 * if we return 0 every time, qsort will assume it's done sorting and
335 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000336 if (sort_abort)
337 return 0;
338 fast_breakcheck();
339 if (got_int)
340 sort_abort = TRUE;
341
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000342 if (sort_nr)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100343 {
344 if (l1.st_u.num.is_number != l2.st_u.num.is_number)
345 result = l1.st_u.num.is_number - l2.st_u.num.is_number;
346 else
347 result = l1.st_u.num.value == l2.st_u.num.value ? 0
348 : l1.st_u.num.value > l2.st_u.num.value ? 1 : -1;
349 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100350#ifdef FEAT_FLOAT
351 else if (sort_flt)
352 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
353 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
354#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000355 else
356 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000357 /* We need to copy one line into "sortbuf1", because there is no
358 * guarantee that the first pointer becomes invalid when obtaining the
359 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100360 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
361 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
362 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
363 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
364 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
365 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000366
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000367 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
368 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000369 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000370
371 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000372 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000373 return (int)(l1.lnum - l2.lnum);
374 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000375}
376
377/*
378 * ":sort".
379 */
380 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100381ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382{
383 regmatch_T regmatch;
384 int len;
385 linenr_T lnum;
386 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000387 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000388 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000389 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000390 char_u *p;
391 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000392 char_u *s2;
393 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000394 int unique = FALSE;
395 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 colnr_T start_col;
397 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100398 int sort_what = 0;
399 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200400 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401
Bram Moolenaar48c99162008-02-18 18:42:52 +0000402 /* Sorting one line is really quick! */
403 if (count <= 1)
404 return;
405
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000406 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
407 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000408 sortbuf1 = NULL;
409 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000410 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000411 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000412 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000413 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000414
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100415 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100416#ifdef FEAT_FLOAT
417 sort_flt = 0;
418#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000419
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000420 for (p = eap->arg; *p != NUL; ++p)
421 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100422 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000423 ;
424 else if (*p == 'i')
425 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000426 else if (*p == 'r')
427 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000428 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100429 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100430 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100431 ++format_found;
432 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100433#ifdef FEAT_FLOAT
434 else if (*p == 'f')
435 {
436 sort_flt = 1;
437 ++format_found;
438 }
439#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100440 else if (*p == 'b')
441 {
442 sort_what = STR2NR_BIN + STR2NR_FORCE;
443 ++format_found;
444 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000445 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100446 {
447 sort_what = STR2NR_OCT + STR2NR_FORCE;
448 ++format_found;
449 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100451 {
452 sort_what = STR2NR_HEX + STR2NR_FORCE;
453 ++format_found;
454 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000455 else if (*p == 'u')
456 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000457 else if (*p == '"') /* comment start */
458 break;
459 else if (check_nextcmd(p) != NULL)
460 {
461 eap->nextcmd = check_nextcmd(p);
462 break;
463 }
464 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000465 {
466 s = skip_regexp(p + 1, *p, TRUE, NULL);
467 if (*s != *p)
468 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100469 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000470 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000471 }
472 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000473 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100474 if (s == p + 1)
475 {
476 if (last_search_pat() == NULL)
477 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100478 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100479 goto sortend;
480 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000481 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100482 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000483 else
484 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000485 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000487 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000488 regmatch.rm_ic = p_ic;
489 }
490 else
491 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100492 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000493 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000494 }
495 }
496
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100497 /* Can only have one of 'n', 'b', 'o' and 'x'. */
498 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000499 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100500 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 }
503
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100504 /* From here on "sort_nr" is used as a flag for any integer number
505 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100506 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000509 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000510 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 * When sorting on strings "start_col_nr" is the offset in the line, for
512 * numbers sorting it's the number to sort on. This means the pattern
513 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000514 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000515 */
516 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
517 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000518 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000519 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520 if (maxlen < len)
521 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000523 start_col = 0;
524 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 {
527 if (sort_rx)
528 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000529 start_col = (colnr_T)(regmatch.startp[0] - s);
530 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000531 }
532 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000533 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000534 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000535 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000536 if (regmatch.regprog != NULL)
537 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000538
Bram Moolenaar937204a2016-01-30 23:37:38 +0100539 if (sort_nr
540#ifdef FEAT_FLOAT
541 || sort_flt
542#endif
543 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000544 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000545 /* Make sure vim_str2nr doesn't read any digits past the end
546 * of the match, by temporarily terminating the string there */
547 s2 = s + end_col;
548 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200549 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000550 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000551 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 if (sort_nr)
553 {
554 if (sort_what & STR2NR_HEX)
555 s = skiptohex(p);
556 else if (sort_what & STR2NR_BIN)
557 s = skiptobin(p);
558 else
559 s = skiptodigit(p);
560 if (s > p && s[-1] == '-')
561 --s; /* include preceding negative sign */
562 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100563 {
564 /* line without number should sort before any number */
565 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
566 nrs[lnum - eap->line1].st_u.num.value = 0;
567 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100568 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100569 {
570 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100571 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100572 &nrs[lnum - eap->line1].st_u.num.value, NULL, 0);
573 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100574 }
575#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000576 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100577 {
578 s = skipwhite(p);
579 if (*s == '+')
580 s = skipwhite(s + 1);
581
582 if (*s == NUL)
583 /* empty line should sort before any number */
584 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
585 else
586 nrs[lnum - eap->line1].st_u.value_flt =
587 strtod((char *)s, NULL);
588 }
589#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200590 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 }
592 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000594 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100595 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
596 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000597 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000598
599 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000600
601 if (regmatch.regprog != NULL)
602 fast_breakcheck();
603 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000604 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000605 }
606
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000607 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000608 sortbuf1 = alloc((unsigned)maxlen + 1);
609 if (sortbuf1 == NULL)
610 goto sortend;
611 sortbuf2 = alloc((unsigned)maxlen + 1);
612 if (sortbuf2 == NULL)
613 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000614
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000615 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000616 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000617
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000618 if (sort_abort)
619 goto sortend;
620
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000621 /* Insert the lines in the sorted order below the last one. */
622 lnum = eap->line2;
623 for (i = 0; i < count; ++i)
624 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200625 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
626
627 // If the original line number of the line being placed is not the same
628 // as "lnum" (accounting for offset), we know that the buffer changed.
629 if (get_lnum + ((linenr_T)count - 1) != lnum)
630 change_occurred = TRUE;
631
632 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000633 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000634 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000635 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200636 // Copy the line into a buffer, it may become invalid in
637 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100638 STRCPY(sortbuf1, s);
639 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000641 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000642 fast_breakcheck();
643 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000644 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 }
646
647 /* delete the original lines if appending worked */
648 if (i == count)
649 for (i = 0; i < count; ++i)
650 ml_delete(eap->line1, FALSE);
651 else
652 count = 0;
653
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000654 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000655 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000656 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200657 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000658 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200659 msgmore(-deleted);
660 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000661 else if (deleted < 0)
662 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200663
664 if (change_occurred || deleted != 0)
665 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000666
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000667 curwin->w_cursor.lnum = eap->line1;
668 beginline(BL_WHITE | BL_FIX);
669
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000670sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000671 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000672 vim_free(sortbuf1);
673 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200674 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000675 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100676 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000677}
678
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679/*
680 * ":retab".
681 */
682 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100683ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684{
685 linenr_T lnum;
686 int got_tab = FALSE;
687 long num_spaces = 0;
688 long num_tabs;
689 long len;
690 long col;
691 long vcol;
692 long start_col = 0; /* For start of white-space string */
693 long start_vcol = 0; /* For start of white-space string */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 long old_len;
695 char_u *ptr;
696 char_u *new_line = (char_u *)1; /* init to non-NULL */
697 int did_undo; /* called u_save for current line */
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200698#ifdef FEAT_VARTABS
Bram Moolenaar0119a592018-06-24 23:53:28 +0200699 int *new_vts_array = NULL;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200700 char_u *new_ts_str; /* string value of tab argument */
701#else
702 int temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 int new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200704#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 int save_list;
706 linenr_T first_line = 0; /* first changed line */
707 linenr_T last_line = 0; /* last changed line */
708
709 save_list = curwin->w_p_list;
710 curwin->w_p_list = 0; /* don't want list mode here */
711
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200712#ifdef FEAT_VARTABS
713 new_ts_str = eap->arg;
Bram Moolenaar0119a592018-06-24 23:53:28 +0200714 if (!tabstop_set(eap->arg, &new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200715 return;
716 while (vim_isdigit(*(eap->arg)) || *(eap->arg) == ',')
717 ++(eap->arg);
718
Bram Moolenaar0119a592018-06-24 23:53:28 +0200719 // This ensures that either new_vts_array and new_ts_str are freshly
720 // allocated, or new_vts_array points to an existing array and new_ts_str
721 // is null.
722 if (new_vts_array == NULL)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200723 {
Bram Moolenaar0119a592018-06-24 23:53:28 +0200724 new_vts_array = curbuf->b_p_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200725 new_ts_str = NULL;
726 }
727 else
728 new_ts_str = vim_strnsave(new_ts_str, eap->arg - new_ts_str);
729#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 new_ts = getdigits(&(eap->arg));
731 if (new_ts < 0)
732 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100733 emsg(_(e_positive));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 return;
735 }
736 if (new_ts == 0)
737 new_ts = curbuf->b_p_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200738#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
740 {
741 ptr = ml_get(lnum);
742 col = 0;
743 vcol = 0;
744 did_undo = FALSE;
745 for (;;)
746 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100747 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 {
749 if (!got_tab && num_spaces == 0)
750 {
751 /* First consecutive white-space */
752 start_vcol = vcol;
753 start_col = col;
754 }
755 if (ptr[col] == ' ')
756 num_spaces++;
757 else
758 got_tab = TRUE;
759 }
760 else
761 {
762 if (got_tab || (eap->forceit && num_spaces > 1))
763 {
764 /* Retabulate this string of white-space */
765
766 /* len is virtual length of white string */
767 len = num_spaces = vcol - start_vcol;
768 num_tabs = 0;
769 if (!curbuf->b_p_et)
770 {
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200771#ifdef FEAT_VARTABS
772 int t, s;
773
774 tabstop_fromto(start_vcol, vcol,
Bram Moolenaar0119a592018-06-24 23:53:28 +0200775 curbuf->b_p_ts, new_vts_array, &t, &s);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200776 num_tabs = t;
777 num_spaces = s;
778#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 temp = new_ts - (start_vcol % new_ts);
780 if (num_spaces >= temp)
781 {
782 num_spaces -= temp;
783 num_tabs++;
784 }
785 num_tabs += num_spaces / new_ts;
786 num_spaces -= (num_spaces / new_ts) * new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200787#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 }
789 if (curbuf->b_p_et || got_tab ||
790 (num_spaces + num_tabs < len))
791 {
792 if (did_undo == FALSE)
793 {
794 did_undo = TRUE;
795 if (u_save((linenr_T)(lnum - 1),
796 (linenr_T)(lnum + 1)) == FAIL)
797 {
798 new_line = NULL; /* flag out-of-memory */
799 break;
800 }
801 }
802
803 /* len is actual number of white characters used */
804 len = num_spaces + num_tabs;
805 old_len = (long)STRLEN(ptr);
806 new_line = lalloc(old_len - col + start_col + len + 1,
807 TRUE);
808 if (new_line == NULL)
809 break;
810 if (start_col > 0)
811 mch_memmove(new_line, ptr, (size_t)start_col);
812 mch_memmove(new_line + start_col + len,
813 ptr + col, (size_t)(old_len - col + 1));
814 ptr = new_line + start_col;
815 for (col = 0; col < len; col++)
816 ptr[col] = (col < num_tabs) ? '\t' : ' ';
817 ml_replace(lnum, new_line, FALSE);
818 if (first_line == 0)
819 first_line = lnum;
820 last_line = lnum;
821 ptr = new_line;
822 col = start_col + len;
823 }
824 }
825 got_tab = FALSE;
826 num_spaces = 0;
827 }
828 if (ptr[col] == NUL)
829 break;
830 vcol += chartabsize(ptr + col, (colnr_T)vcol);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000832 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 ++col;
835 }
836 if (new_line == NULL) /* out of memory */
837 break;
838 line_breakcheck();
839 }
840 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100841 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200843#ifdef FEAT_VARTABS
844 // If a single value was given then it can be considered equal to
845 // either the value of 'tabstop' or the value of 'vartabstop'.
846 if (tabstop_count(curbuf->b_p_vts_array) == 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200847 && tabstop_count(new_vts_array) == 1
848 && curbuf->b_p_ts == tabstop_first(new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200849 ; /* not changed */
850 else if (tabstop_count(curbuf->b_p_vts_array) > 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200851 && tabstop_eq(curbuf->b_p_vts_array, new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200852 ; /* not changed */
853 else
854 redraw_curbuf_later(NOT_VALID);
855#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (curbuf->b_p_ts != new_ts)
857 redraw_curbuf_later(NOT_VALID);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200858#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 if (first_line != 0)
860 changed_lines(first_line, 0, last_line + 1, 0L);
861
862 curwin->w_p_list = save_list; /* restore 'list' */
863
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200864#ifdef FEAT_VARTABS
865 if (new_ts_str != NULL) /* set the new tabstop */
866 {
867 // If 'vartabstop' is in use or if the value given to retab has more
868 // than one tabstop then update 'vartabstop'.
869 int *old_vts_ary = curbuf->b_p_vts_array;
870
Bram Moolenaar0119a592018-06-24 23:53:28 +0200871 if (tabstop_count(old_vts_ary) > 0 || tabstop_count(new_vts_array) > 1)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200872 {
873 set_string_option_direct((char_u *)"vts", -1, new_ts_str,
874 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0119a592018-06-24 23:53:28 +0200875 curbuf->b_p_vts_array = new_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200876 vim_free(old_vts_ary);
877 }
878 else
879 {
880 // 'vartabstop' wasn't in use and a single value was given to
881 // retab then update 'tabstop'.
Bram Moolenaar0119a592018-06-24 23:53:28 +0200882 curbuf->b_p_ts = tabstop_first(new_vts_array);
883 vim_free(new_vts_array);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200884 }
Bram Moolenaar307ac5c2018-06-28 22:23:00 +0200885 vim_free(new_ts_str);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200886 }
887#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 curbuf->b_p_ts = new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200889#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 coladvance(curwin->w_curswant);
891
892 u_clearline();
893}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894
895/*
896 * :move command - move lines line1-line2 to line dest
897 *
898 * return FAIL for failure, OK otherwise
899 */
900 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100901do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902{
903 char_u *str;
904 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100905 linenr_T extra; // Num lines added before line1
906 linenr_T num_lines; // Num lines moved
907 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200908#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100909 win_T *win;
910 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
913 if (dest >= line1 && dest < line2)
914 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100915 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 return FAIL;
917 }
918
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100919 // Do nothing if we are not actually moving any lines. This will prevent
920 // the 'modified' flag from being set without cause.
921 if (dest == line1 - 1 || dest == line2)
922 {
923 // Move the cursor as if lines were moved (see below) to be backwards
924 // compatible.
925 if (dest >= line1)
926 curwin->w_cursor.lnum = dest;
927 else
928 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
929
930 return OK;
931 }
932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 num_lines = line2 - line1 + 1;
934
935 /*
936 * First we copy the old text to its new location -- webb
937 * Also copy the flag that ":global" command uses.
938 */
939 if (u_save(dest, dest + 1) == FAIL)
940 return FAIL;
941 for (extra = 0, l = line1; l <= line2; l++)
942 {
943 str = vim_strsave(ml_get(l + extra));
944 if (str != NULL)
945 {
946 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
947 vim_free(str);
948 if (dest < line1)
949 extra++;
950 }
951 }
952
953 /*
954 * Now we must be careful adjusting our marks so that we don't overlap our
955 * mark_adjust() calls.
956 *
957 * We adjust the marks within the old text so that they refer to the
958 * last lines of the file (temporarily), because we know no other marks
959 * will be set there since these line numbers did not exist until we added
960 * our new lines.
961 *
962 * Then we adjust the marks on lines between the old and new text positions
963 * (either forwards or backwards).
964 *
965 * And Finally we adjust the marks we put at the end of the file back to
966 * their final destination at the new text position -- webb
967 */
968 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100969 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 if (dest >= line2)
971 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100972 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
973#ifdef FEAT_FOLDING
974 FOR_ALL_TAB_WINDOWS(tp, win) {
975 if (win->w_buffer == curbuf)
976 foldMoveRange(&win->w_folds, line1, line2, dest);
977 }
978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 curbuf->b_op_start.lnum = dest - num_lines + 1;
980 curbuf->b_op_end.lnum = dest;
981 }
982 else
983 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100984 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
985#ifdef FEAT_FOLDING
986 FOR_ALL_TAB_WINDOWS(tp, win) {
987 if (win->w_buffer == curbuf)
988 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
989 }
990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 curbuf->b_op_start.lnum = dest + 1;
992 curbuf->b_op_end.lnum = dest + num_lines;
993 }
994 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100995 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 -(last_line - dest - extra), 0L);
997
998 /*
999 * Now we delete the original text -- webb
1000 */
1001 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
1002 return FAIL;
1003
1004 for (l = line1; l <= line2; l++)
1005 ml_delete(line1 + extra, TRUE);
1006
1007 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001008 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02001009 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010
1011 /*
1012 * Leave the cursor on the last of the moved lines.
1013 */
1014 if (dest >= line1)
1015 curwin->w_cursor.lnum = dest;
1016 else
1017 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
1018
1019 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +01001020 {
1021 dest += num_lines + 1;
1022 last_line = curbuf->b_ml.ml_line_count;
1023 if (dest > last_line + 1)
1024 dest = last_line + 1;
1025 changed_lines(line1, 0, dest, 0L);
1026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 else
1028 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
1029
1030 return OK;
1031}
1032
1033/*
1034 * ":copy"
1035 */
1036 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001037ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038{
1039 linenr_T count;
1040 char_u *p;
1041
1042 count = line2 - line1 + 1;
1043 curbuf->b_op_start.lnum = n + 1;
1044 curbuf->b_op_end.lnum = n + count;
1045 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
1046
1047 /*
1048 * there are three situations:
1049 * 1. destination is above line1
1050 * 2. destination is between line1 and line2
1051 * 3. destination is below line2
1052 *
1053 * n = destination (when starting)
1054 * curwin->w_cursor.lnum = destination (while copying)
1055 * line1 = start of source (while copying)
1056 * line2 = end of source (while copying)
1057 */
1058 if (u_save(n, n + 1) == FAIL)
1059 return;
1060
1061 curwin->w_cursor.lnum = n;
1062 while (line1 <= line2)
1063 {
1064 /* need to use vim_strsave() because the line will be unlocked within
1065 * ml_append() */
1066 p = vim_strsave(ml_get(line1));
1067 if (p != NULL)
1068 {
1069 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
1070 vim_free(p);
1071 }
1072 /* situation 2: skip already copied lines */
1073 if (line1 == n)
1074 line1 = curwin->w_cursor.lnum;
1075 ++line1;
1076 if (curwin->w_cursor.lnum < line1)
1077 ++line1;
1078 if (curwin->w_cursor.lnum < line2)
1079 ++line2;
1080 ++curwin->w_cursor.lnum;
1081 }
1082
1083 appended_lines_mark(n, count);
1084
1085 msgmore((long)count);
1086}
1087
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001088static char_u *prevcmd = NULL; /* the previous command */
1089
1090#if defined(EXITFREE) || defined(PROTO)
1091 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001092free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001093{
1094 vim_free(prevcmd);
1095}
1096#endif
1097
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098/*
1099 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1100 * Bangs in the argument are replaced with the previously entered command.
1101 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 */
1103 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001104do_bang(
1105 int addr_count,
1106 exarg_T *eap,
1107 int forceit,
1108 int do_in,
1109 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110{
1111 char_u *arg = eap->arg; /* command */
1112 linenr_T line1 = eap->line1; /* start of range */
1113 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 char_u *newcmd = NULL; /* the new command */
1115 int free_newcmd = FALSE; /* need to free() newcmd */
1116 int ins_prevcmd;
1117 char_u *t;
1118 char_u *p;
1119 char_u *trailarg;
1120 int len;
1121 int scroll_save = msg_scroll;
1122
1123 /*
1124 * Disallow shell commands for "rvim".
1125 * Disallow shell commands from .exrc and .vimrc in current directory for
1126 * security reasons.
1127 */
1128 if (check_restricted() || check_secure())
1129 return;
1130
1131 if (addr_count == 0) /* :! */
1132 {
1133 msg_scroll = FALSE; /* don't scroll here */
1134 autowrite_all();
1135 msg_scroll = scroll_save;
1136 }
1137
1138 /*
1139 * Try to find an embedded bang, like in :!<cmd> ! [args]
1140 * (:!! is indicated by the 'forceit' variable)
1141 */
1142 ins_prevcmd = forceit;
1143 trailarg = arg;
1144 do
1145 {
1146 len = (int)STRLEN(trailarg) + 1;
1147 if (newcmd != NULL)
1148 len += (int)STRLEN(newcmd);
1149 if (ins_prevcmd)
1150 {
1151 if (prevcmd == NULL)
1152 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001153 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 vim_free(newcmd);
1155 return;
1156 }
1157 len += (int)STRLEN(prevcmd);
1158 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001159 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 {
1161 vim_free(newcmd);
1162 return;
1163 }
1164 *t = NUL;
1165 if (newcmd != NULL)
1166 STRCAT(t, newcmd);
1167 if (ins_prevcmd)
1168 STRCAT(t, prevcmd);
1169 p = t + STRLEN(t);
1170 STRCAT(t, trailarg);
1171 vim_free(newcmd);
1172 newcmd = t;
1173
1174 /*
1175 * Scan the rest of the argument for '!', which is replaced by the
1176 * previous command. "\!" is replaced by "!" (this is vi compatible).
1177 */
1178 trailarg = NULL;
1179 while (*p)
1180 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001181 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 {
1183 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001184 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 else
1186 {
1187 trailarg = p;
1188 *trailarg++ = NUL;
1189 ins_prevcmd = TRUE;
1190 break;
1191 }
1192 }
1193 ++p;
1194 }
1195 } while (trailarg != NULL);
1196
1197 vim_free(prevcmd);
1198 prevcmd = newcmd;
1199
1200 if (bangredo) /* put cmd in redo buffer for ! command */
1201 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001202 /* If % or # appears in the command, it must have been escaped.
1203 * Reescape them, so that redoing them does not substitute them by the
1204 * buffername. */
1205 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1206
1207 if (cmd != NULL)
1208 {
1209 AppendToRedobuffLit(cmd, -1);
1210 vim_free(cmd);
1211 }
1212 else
1213 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 AppendToRedobuff((char_u *)"\n");
1215 bangredo = FALSE;
1216 }
1217 /*
1218 * Add quotes around the command, for shells that need them.
1219 */
1220 if (*p_shq != NUL)
1221 {
1222 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1223 if (newcmd == NULL)
1224 return;
1225 STRCPY(newcmd, p_shq);
1226 STRCAT(newcmd, prevcmd);
1227 STRCAT(newcmd, p_shq);
1228 free_newcmd = TRUE;
1229 }
1230 if (addr_count == 0) /* :! */
1231 {
1232 /* echo the command */
1233 msg_start();
1234 msg_putchar(':');
1235 msg_putchar('!');
1236 msg_outtrans(newcmd);
1237 msg_clr_eos();
1238 windgoto(msg_row, msg_col);
1239
1240 do_shell(newcmd, 0);
1241 }
1242 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001243 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 /* Careful: This may recursively call do_bang() again! (because of
1245 * autocommands) */
1246 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001247 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001248 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 if (free_newcmd)
1250 vim_free(newcmd);
1251}
1252
1253/*
1254 * do_filter: filter lines through a command given by the user
1255 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001256 * We mostly use temp files and the call_shell() routine here. This would
1257 * normally be done using pipes on a UNIX machine, but this is more portable
1258 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 * to deal with redirection somehow, and should handle things like looking
1260 * at the PATH env. variable, and adding reasonable extensions to the
1261 * command name given by the user. All reasonable versions of call_shell()
1262 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001263 * Alternatively, if on Unix and redirecting input or output, but not both,
1264 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 * We use input redirection if do_in is TRUE.
1266 * We use output redirection if do_out is TRUE.
1267 */
1268 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001269do_filter(
1270 linenr_T line1,
1271 linenr_T line2,
1272 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1273 char_u *cmd,
1274 int do_in,
1275 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276{
1277 char_u *itmp = NULL;
1278 char_u *otmp = NULL;
1279 linenr_T linecount;
1280 linenr_T read_linecount;
1281 pos_T cursor_save;
1282 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001284 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
1286 if (*cmd == NUL) /* no filter command */
1287 return;
1288
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 cursor_save = curwin->w_cursor;
1290 linecount = line2 - line1 + 1;
1291 curwin->w_cursor.lnum = line1;
1292 curwin->w_cursor.col = 0;
1293 changed_line_abv_curs();
1294 invalidate_botline();
1295
1296 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001297 * When using temp files:
1298 * 1. * Form temp file names
1299 * 2. * Write the lines to a temp file
1300 * 3. Run the filter command on the temp file
1301 * 4. * Read the output of the command into the buffer
1302 * 5. * Delete the original lines to be filtered
1303 * 6. * Remove the temp files
1304 *
1305 * When writing the input with a pipe or when catching the output with a
1306 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 */
1308
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001309 if (do_out)
1310 shell_flags |= SHELL_DOOUT;
1311
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001312#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001315 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1316 shell_flags |= SHELL_READ;
1317 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001319 else if (do_in && !do_out && !p_stmp)
1320 {
1321 /* Use a pipe to write stdin of the command, do not use a temp file. */
1322 shell_flags |= SHELL_WRITE;
1323 curbuf->b_op_start.lnum = line1;
1324 curbuf->b_op_end.lnum = line2;
1325 }
1326 else if (do_in && do_out && !p_stmp)
1327 {
1328 /* Use a pipe to write stdin and fetch stdout of the command, do not
1329 * use a temp file. */
1330 shell_flags |= SHELL_READ|SHELL_WRITE;
1331 curbuf->b_op_start.lnum = line1;
1332 curbuf->b_op_end.lnum = line2;
1333 curwin->w_cursor.lnum = line2;
1334 }
1335 else
1336#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001337 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1338 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001339 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001340 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001341 goto filterend;
1342 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343
1344/*
1345 * The writing and reading of temp files will not be shown.
1346 * Vi also doesn't do this and the messages are not very informative.
1347 */
1348 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001349 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 FALSE, FALSE, FALSE, TRUE) == FAIL)
1351 {
1352 msg_putchar('\n'); /* keep message from buf_write() */
1353 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001354#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 if (!aborting())
1356#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001357 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 goto filterend;
1359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 if (curbuf != old_curbuf)
1361 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 if (!do_out)
1364 msg_putchar('\n');
1365
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001366 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1368 if (cmd_buf == NULL)
1369 goto filterend;
1370
1371 windgoto((int)Rows - 1, 0);
1372 cursor_on();
1373
1374 /*
1375 * When not redirecting the output the command can write anything to the
1376 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1377 * stderr output of external command. Clear the screen later.
1378 * If do_in is FALSE, this could be something like ":r !cat", which may
1379 * also mess up the screen, clear it later.
1380 */
1381 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1382 redraw_later_clear();
1383
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001384 if (do_out)
1385 {
1386 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001387 {
1388 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001389 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001390 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001391 redraw_curbuf_later(VALID);
1392 }
1393 read_linecount = curbuf->b_ml.ml_line_count;
1394
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 /*
1396 * When call_shell() fails wait_return() is called to give the user a
1397 * chance to read the error messages. Otherwise errors are ignored, so you
1398 * can see the error messages from the command that appear on stdout; use
1399 * 'u' to fix the text
1400 * Switch to cooked mode when not redirecting stdin, avoids that something
1401 * like ":r !cat" hangs.
1402 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1403 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001404 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 {
1406 redraw_later_clear();
1407 wait_return(FALSE);
1408 }
1409 vim_free(cmd_buf);
1410
1411 did_check_timestamps = FALSE;
1412 need_check_timestamps = TRUE;
1413
1414 /* When interrupting the shell command, it may still have produced some
1415 * useful output. Reset got_int here, so that readfile() won't cancel
1416 * reading. */
1417 ui_breakcheck();
1418 got_int = FALSE;
1419
1420 if (do_out)
1421 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001422 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001424 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001425 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001427#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001428 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001430 {
1431 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001432 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001433 }
1434 goto error;
1435 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001436 if (curbuf != old_curbuf)
1437 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001438 }
1439
1440 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1441
1442 if (shell_flags & SHELL_READ)
1443 {
1444 curbuf->b_op_start.lnum = line2 + 1;
1445 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1446 appended_lines_mark(line2, read_linecount);
1447 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 if (do_in)
1450 {
1451 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1452 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 if (read_linecount >= linecount)
1454 /* move all marks from old lines to new lines */
1455 mark_adjust(line1, line2, linecount, 0L);
1456 else
1457 {
1458 /* move marks from old lines to new lines, delete marks
1459 * that are in deleted lines */
1460 mark_adjust(line1, line1 + read_linecount - 1,
1461 linecount, 0L);
1462 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1463 }
1464 }
1465
1466 /*
1467 * Put cursor on first filtered line for ":range!cmd".
1468 * Adjust '[ and '] (set by buf_write()).
1469 */
1470 curwin->w_cursor.lnum = line1;
1471 del_lines(linecount, TRUE);
1472 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1473 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1474 write_lnum_adjust(-linecount); /* adjust last line
1475 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001476#ifdef FEAT_FOLDING
1477 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1478#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 }
1480 else
1481 {
1482 /*
1483 * Put cursor on last new line for ":r !cmd".
1484 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001486 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001488
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1490 --no_wait_return;
1491
1492 if (linecount > p_report)
1493 {
1494 if (do_in)
1495 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001496 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001497 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001500 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 }
1502 else
1503 msgmore((long)linecount);
1504 }
1505 }
1506 else
1507 {
1508error:
1509 /* put cursor back in same position for ":w !cmd" */
1510 curwin->w_cursor = cursor_save;
1511 --no_wait_return;
1512 wait_return(FALSE);
1513 }
1514
1515filterend:
1516
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 if (curbuf != old_curbuf)
1518 {
1519 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001520 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 if (itmp != NULL)
1523 mch_remove(itmp);
1524 if (otmp != NULL)
1525 mch_remove(otmp);
1526 vim_free(itmp);
1527 vim_free(otmp);
1528}
1529
1530/*
1531 * Call a shell to execute a command.
1532 * When "cmd" is NULL start an interactive shell.
1533 */
1534 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001535do_shell(
1536 char_u *cmd,
1537 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538{
1539 buf_T *buf;
1540#ifndef FEAT_GUI_MSWIN
1541 int save_nwr;
1542#endif
1543#ifdef MSWIN
1544 int winstart = FALSE;
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 */
1639#ifndef FEAT_GUI_MSWIN
1640 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001641# ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001642 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643# endif
1644 )
1645 {
1646 if (msg_silent == 0)
1647 redraw_later_clear();
1648 need_wait_return = FALSE;
1649 }
1650 else
1651 {
1652 /*
1653 * If we switch screens when starttermcap() is called, we really
1654 * want to wait for "hit return to continue".
1655 */
1656 save_nwr = no_wait_return;
1657 if (swapping_screen())
1658 no_wait_return = FALSE;
1659# ifdef AMIGA
1660 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1661# else
1662 wait_return(msg_silent == 0);
1663# endif
1664 no_wait_return = save_nwr;
1665 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001666#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
1668#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001669 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001671 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673 /*
1674 * In an Amiga window redrawing is caused by asking the window size.
1675 * If we got an interrupt this will not work. The chance that the
1676 * window size is wrong is very small, but we need to redraw the
1677 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1678 * but it saves an extra redraw.
1679 */
1680#ifdef AMIGA
1681 if (skip_redraw) /* ':' hit in wait_return() */
1682 {
1683 if (msg_silent == 0)
1684 redraw_later_clear();
1685 }
1686 else if (term_console)
1687 {
1688 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1689 if (got_int && msg_silent == 0)
1690 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1691 else
1692 must_redraw = 0; /* no extra redraw needed */
1693 }
1694#endif
1695 }
1696
1697 /* display any error messages now */
1698 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001699
Bram Moolenaarade00832006-03-10 21:46:58 +00001700 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701}
1702
Bram Moolenaar06640892018-10-09 21:49:33 +02001703#if !defined(UNIX)
1704 static char_u *
1705find_pipe(char_u *cmd)
1706{
1707 char_u *p;
1708 int inquote = FALSE;
1709
1710 for (p = cmd; *p != NUL; ++p)
1711 {
1712 if (!inquote && *p == '|')
1713 return p;
1714 if (*p == '"')
1715 inquote = !inquote;
1716 else if (rem_backslash(p))
1717 ++p;
1718 }
1719 return NULL;
1720}
1721#endif
1722
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723/*
1724 * Create a shell command from a command string, input redirection file and
1725 * output redirection file.
1726 * Returns an allocated string with the shell command, or NULL for failure.
1727 */
1728 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001729make_filter_cmd(
1730 char_u *cmd, /* command */
1731 char_u *itmp, /* NULL or name of input file */
1732 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733{
1734 char_u *buf;
1735 long_u len;
1736
Bram Moolenaar53076832015-12-31 19:53:21 +01001737#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001738 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001739 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001740
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001741 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001742 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1743 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001744 if (is_fish_shell)
1745 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1746 else
1747#endif
1748 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 if (itmp != NULL)
1750 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1751 if (otmp != NULL)
1752 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1753 buf = lalloc(len, TRUE);
1754 if (buf == NULL)
1755 return NULL;
1756
Bram Moolenaar53076832015-12-31 19:53:21 +01001757#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001759 * Put braces around the command (for concatenated commands) when
1760 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001762 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001763 {
1764 if (is_fish_shell)
1765 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1766 else
1767 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1768 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001769 else
1770 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 if (itmp != NULL)
1772 {
1773 STRCAT(buf, " < ");
1774 STRCAT(buf, itmp);
1775 }
1776#else
1777 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001778 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 * the use of commands in a pipe.
1780 */
1781 STRCPY(buf, cmd);
1782 if (itmp != NULL)
1783 {
1784 char_u *p;
1785
1786 /*
1787 * If there is a pipe, we have to put the '<' in front of it.
1788 * Don't do this when 'shellquote' is not empty, otherwise the
1789 * redirection would be inside the quotes.
1790 */
1791 if (*p_shq == NUL)
1792 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001793 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 if (p != NULL)
1795 *p = NUL;
1796 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1798 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 if (*p_shq == NUL)
1800 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001801 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 if (p != NULL)
1803 {
1804 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1805 STRCAT(buf, p);
1806 }
1807 }
1808 }
1809#endif
1810 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001811 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812
1813 return buf;
1814}
1815
1816/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001817 * Append output redirection for file "fname" to the end of string buffer
1818 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 * Works with the 'shellredir' and 'shellpipe' options.
1820 * The caller should make sure that there is enough room:
1821 * STRLEN(opt) + STRLEN(fname) + 3
1822 */
1823 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001824append_redir(
1825 char_u *buf,
1826 int buflen,
1827 char_u *opt,
1828 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829{
1830 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001831 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001833 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001834 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001836 {
1837 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001839 if (p[1] == '%') /* skip %% */
1840 ++p;
1841 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 if (p != NULL)
1843 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001844 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1845 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1846 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 }
1848 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001849 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 " %s %s",
1852#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854#endif
1855 (char *)opt, (char *)fname);
1856}
1857
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001858#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001860static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001861static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001862static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863static int viminfo_errcnt;
1864
1865 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001866no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867{
1868 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001869 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870}
1871
1872/*
1873 * Report an error for reading a viminfo file.
1874 * Count the number of errors. When there are more than 10, return TRUE.
1875 */
1876 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001877viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001879 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1880 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001881 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001882 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1883 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001884 emsg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 if (++viminfo_errcnt >= 10)
1886 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001887 emsg(_("E136: viminfo: Too many errors, skipping rest of file"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 return TRUE;
1889 }
1890 return FALSE;
1891}
1892
1893/*
1894 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001895 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 */
1897 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001898read_viminfo(
1899 char_u *file, /* file name or NULL to use default name */
1900 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901{
1902 FILE *fp;
1903 char_u *fname;
1904
1905 if (no_viminfo())
1906 return FAIL;
1907
Bram Moolenaard812df62008-11-09 12:46:09 +00001908 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 if (fname == NULL)
1910 return FAIL;
1911 fp = mch_fopen((char *)fname, READBIN);
1912
1913 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001914 {
1915 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001916 smsg(_("Reading viminfo file \"%s\"%s%s%s"),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001917 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001918 (flags & VIF_WANT_INFO) ? _(" info") : "",
1919 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1920 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001921 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001922 verbose_leave();
1923 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
1925 vim_free(fname);
1926 if (fp == NULL)
1927 return FAIL;
1928
1929 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001930 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931
1932 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 return OK;
1934}
1935
1936/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001937 * Write the viminfo file. The old one is read in first so that effectively a
1938 * merge of current info and old info is done. This allows multiple vims to
1939 * run simultaneously, without losing any marks etc.
1940 * If "forceit" is TRUE, then the old file is not read in, and only internal
1941 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 */
1943 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001944write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945{
1946 char_u *fname;
1947 FILE *fp_in = NULL; /* input viminfo file, if any */
1948 FILE *fp_out = NULL; /* output viminfo file */
1949 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001950 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951#if defined(UNIX) || defined(VMS)
1952 mode_t umask_save;
1953#endif
1954#ifdef UNIX
1955 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001956 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01001958#ifdef MSWIN
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001959 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001960#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961
1962 if (no_viminfo())
1963 return;
1964
1965 fname = viminfo_filename(file); /* may set to default if NULL */
1966 if (fname == NULL)
1967 return;
1968
1969 fp_in = mch_fopen((char *)fname, READBIN);
1970 if (fp_in == NULL)
1971 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001972 int fd;
1973
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 /* if it does exist, but we can't read it, don't try writing */
1975 if (mch_stat((char *)fname, &st_new) == 0)
1976 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001977
1978 /* Create the new .viminfo non-accessible for others, because it may
1979 * contain text from non-accessible documents. It is up to the user to
1980 * widen access (e.g. to a group). This may also fail if there is a
1981 * race condition, then just give up. */
1982 fd = mch_open((char *)fname,
1983 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1984 if (fd < 0)
1985 goto end;
1986 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 }
1988 else
1989 {
1990 /*
1991 * There is an existing viminfo file. Create a temporary file to
1992 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001993 * existing viminfo file, which will be renamed once all writing is
1994 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 */
1996#ifdef UNIX
1997 /*
1998 * For Unix we check the owner of the file. It's not very nice to
1999 * overwrite a user's viminfo file after a "su root", with a
2000 * viminfo file that the user can't read.
2001 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00002002 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00002003 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00002005 if (mch_stat((char *)fname, &st_old) == 0
2006 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00002007 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 ? (st_old.st_mode & 0200)
2009 : (st_old.st_gid == getgid()
2010 ? (st_old.st_mode & 0020)
2011 : (st_old.st_mode & 0002))))
2012 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00002013 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014
2015 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002016 semsg(_("E137: Viminfo file is not writable: %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002018 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 goto end;
2020 }
2021#endif
Bram Moolenaar4f974752019-02-17 17:44:42 +01002022#ifdef MSWIN
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002023 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01002024 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002025#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026
2027 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002028 * Make tempname, find one that does not exist yet.
2029 * Beware of a race condition: If someone logs out and all Vim
2030 * instances exit at the same time a temp file might be created between
2031 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 * May try twice: Once normal and once with shortname set, just in
2033 * case somebody puts his viminfo file in an 8.3 filesystem.
2034 */
2035 for (;;)
2036 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002037 int next_char = 'z';
2038 char_u *wp;
2039
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 tempname = buf_modname(
2041#ifdef UNIX
2042 shortname,
2043#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045#endif
2046 fname,
2047#ifdef VMS
2048 (char_u *)"-tmp",
2049#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051#endif
2052 FALSE);
2053 if (tempname == NULL) /* out of memory */
2054 break;
2055
2056 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002057 * Try a series of names. Change one character, just before
2058 * the extension. This should also work for an 8.3
2059 * file name, when after adding the extension it still is
2060 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002062 wp = tempname + STRLEN(tempname) - 5;
2063 if (wp < gettail(tempname)) /* empty file name? */
2064 wp = gettail(tempname);
2065 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002067 /*
2068 * Check if tempfile already exists. Never overwrite an
2069 * existing file!
2070 */
2071 if (mch_stat((char *)tempname, &st_new) == 0)
2072 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002075 * Check if tempfile is same as original file. May happen
2076 * when modname() gave the same file back. E.g. silly
2077 * link, or file name-length reached. Try again with
2078 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002080 if (!shortname && st_new.st_dev == st_old.st_dev
2081 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01002083 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002084 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 break;
2086 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002087#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002089 else
2090 {
2091 /* Try creating the file exclusively. This may fail if
2092 * another Vim tries to do it at the same time. */
2093#ifdef VMS
2094 /* fdopen() fails for some reason */
2095 umask_save = umask(077);
2096 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2097 (void)umask(umask_save);
2098#else
2099 int fd;
2100
2101 /* Use mch_open() to be able to use O_NOFOLLOW and set file
2102 * protection:
2103 * Unix: same as original file, but strip s-bit. Reset
2104 * umask to avoid it getting in the way.
2105 * Others: r&w for user only. */
2106# ifdef UNIX
2107 umask_save = umask(0);
2108 fd = mch_open((char *)tempname,
2109 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
2110 (int)((st_old.st_mode & 0777) | 0600));
2111 (void)umask(umask_save);
2112# else
2113 fd = mch_open((char *)tempname,
2114 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
2115# endif
2116 if (fd < 0)
2117 {
2118 fp_out = NULL;
2119# ifdef EEXIST
2120 /* Avoid trying lots of names while the problem is lack
Bram Moolenaar94747162019-02-10 21:55:26 +01002121 * of permission, only retry if the file already
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002122 * exists. */
2123 if (errno != EEXIST)
2124 break;
2125# endif
2126 }
2127 else
2128 fp_out = fdopen(fd, WRITEBIN);
2129#endif /* VMS */
2130 if (fp_out != NULL)
2131 break;
2132 }
2133
2134 /* Assume file exists, try again with another name. */
2135 if (next_char == 'a' - 1)
2136 {
2137 /* They all exist? Must be something wrong! Don't write
2138 * the viminfo file then. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002139 semsg(_("E929: Too many viminfo temp files, like %s!"),
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002140 tempname);
2141 break;
2142 }
2143 *wp = next_char;
2144 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002146
2147 if (tempname != NULL)
2148 break;
2149 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 }
2151
Bram Moolenaara5792f52005-11-23 21:25:05 +00002152#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002153 if (tempname != NULL && fp_out != NULL)
2154 {
2155 stat_T tmp_st;
2156
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002158 * Make sure the original owner can read/write the tempfile and
2159 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002161 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002162 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002163 if (st_old.st_uid != tmp_st.st_uid)
2164 /* Changing the owner might fail, in which case the
2165 * file will now owned by the current user, oh well. */
Bram Moolenaar42335f52018-09-13 15:33:43 +02002166 vim_ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002167 if (st_old.st_gid != tmp_st.st_gid
2168 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2169 /* can't set the group to what it should be, remove
2170 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002171 (void)mch_setperm(tempname, 0600);
2172 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002173 else
2174 /* can't stat the file, set conservative permissions */
2175 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002177#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002178 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179
2180 /*
2181 * Check if the new viminfo file can be written to.
2182 */
2183 if (fp_out == NULL)
2184 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002185 semsg(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002186 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 if (fp_in != NULL)
2188 fclose(fp_in);
2189 goto end;
2190 }
2191
2192 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002193 {
2194 verbose_enter();
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002195 smsg(_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002196 verbose_leave();
2197 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198
2199 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002200 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201
Bram Moolenaar927030a2016-03-15 18:23:55 +01002202 if (fclose(fp_out) == EOF)
2203 ++viminfo_errcnt;
2204
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205 if (fp_in != NULL)
2206 {
2207 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002208
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002209 /* In case of an error keep the original viminfo file. Otherwise
2210 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002211 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002212 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002213 if (vim_rename(tempname, fname) == -1)
2214 {
2215 ++viminfo_errcnt;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002216 semsg(_("E886: Can't rename viminfo file to %s!"), fname);
Bram Moolenaar927030a2016-03-15 18:23:55 +01002217 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01002218# ifdef MSWIN
Bram Moolenaar927030a2016-03-15 18:23:55 +01002219 /* If the viminfo file was hidden then also hide the new file. */
2220 else if (hidden)
2221 mch_hide(fname);
2222# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002223 }
2224 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 mch_remove(tempname);
2226 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002227
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228end:
2229 vim_free(fname);
2230 vim_free(tempname);
2231}
2232
2233/*
2234 * Get the viminfo file name to use.
2235 * If "file" is given and not empty, use it (has already been expanded by
2236 * cmdline functions).
2237 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2238 * expand environment variables.
2239 * Returns an allocated string. NULL when out of memory.
2240 */
2241 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002242viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243{
2244 if (file == NULL || *file == NUL)
2245 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002246 if (*p_viminfofile != NUL)
2247 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2249 {
2250#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251# ifdef VMS
2252 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2253# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002254# ifdef MSWIN
2255 /* Use $VIM only if $HOME is the default "C:/". */
2256 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2257 && mch_getenv((char_u *)"HOME") == NULL)
2258# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002260# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261# endif
2262 {
2263 /* don't use $VIM when not available. */
2264 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2265 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2266 file = (char_u *)VIMINFO_FILE2;
2267 else
2268 file = (char_u *)VIMINFO_FILE;
2269 }
2270 else
2271#endif
2272 file = (char_u *)VIMINFO_FILE;
2273 }
2274 expand_env(file, NameBuff, MAXPATHL);
2275 file = NameBuff;
2276 }
2277 return vim_strsave(file);
2278}
2279
2280/*
2281 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2282 */
2283 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002284do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 int eof = FALSE;
2287 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002288 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002289 int do_copy_marks = FALSE;
2290 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291
2292 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2293 return;
2294 vir.vir_fd = fp_in;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 vir.vir_conv.vc_type = CONV_NONE;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002296 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002297 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298
2299 if (fp_in != NULL)
2300 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002301 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002302 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002303 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002304 {
2305 /* Registers and marks are read and kept separate from what
2306 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002307 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002308 prepare_viminfo_marks();
2309 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002310
Bram Moolenaard812df62008-11-09 12:46:09 +00002311 eof = read_viminfo_up_to_marks(&vir,
2312 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002313 merge = TRUE;
2314 }
2315 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 /* Skip info, find start of marks */
2317 while (!(eof = viminfo_readline(&vir))
2318 && vir.vir_line[0] != '>')
2319 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002320
2321 do_copy_marks = (flags &
2322 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002324
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 if (fp_out != NULL)
2326 {
2327 /* Write the info: */
2328 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2329 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002330 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002331 write_viminfo_version(fp_out);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002332 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 write_viminfo_search_pattern(fp_out);
2335 write_viminfo_sub_string(fp_out);
2336#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002337 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338#endif
2339 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002340 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341#ifdef FEAT_EVAL
2342 write_viminfo_varlist(fp_out);
2343#endif
2344 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002345 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002347 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002348
2349 if (do_copy_marks)
2350 ga_init2(&buflist, sizeof(buf_T *), 50);
2351 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002353
2354 if (do_copy_marks)
2355 {
2356 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2357 if (fp_out != NULL)
2358 ga_clear(&buflist);
2359 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360
2361 vim_free(vir.vir_line);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 if (vir.vir_conv.vc_type != CONV_NONE)
2363 convert_setup(&vir.vir_conv, NULL, NULL);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002364 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365}
2366
2367/*
2368 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2369 * first part of the viminfo file which contains everything but the marks that
2370 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2371 */
2372 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002373read_viminfo_up_to_marks(
2374 vir_T *virp,
2375 int forceit,
2376 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377{
2378 int eof;
2379 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002380 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381
2382#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002383 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002385
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 eof = viminfo_readline(virp);
2387 while (!eof && virp->vir_line[0] != '>')
2388 {
2389 switch (virp->vir_line[0])
2390 {
2391 /* Characters reserved for future expansion, ignored now */
2392 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 case '^': /* to be defined */
2394 case '<': /* long line - ignored */
2395 /* A comment or empty line. */
2396 case NUL:
2397 case '\r':
2398 case '\n':
2399 case '#':
2400 eof = viminfo_readline(virp);
2401 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002402 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002403 eof = read_viminfo_barline(virp, got_encoding,
2404 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002405 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002407 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 eof = viminfo_encoding(virp);
2409 break;
2410 case '!': /* global variable */
2411#ifdef FEAT_EVAL
2412 eof = read_viminfo_varlist(virp, writing);
2413#else
2414 eof = viminfo_readline(virp);
2415#endif
2416 break;
2417 case '%': /* entry for buffer list */
2418 eof = read_viminfo_bufferlist(virp, writing);
2419 break;
2420 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002421 /* When registers are in bar lines skip the old style register
2422 * lines. */
2423 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2424 eof = read_viminfo_register(virp, forceit);
2425 else
2426 do {
2427 eof = viminfo_readline(virp);
2428 } while (!eof && (virp->vir_line[0] == TAB
2429 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 break;
2431 case '/': /* Search string */
2432 case '&': /* Substitute search string */
2433 case '~': /* Last search string, followed by '/' or '&' */
2434 eof = read_viminfo_search_pattern(virp, forceit);
2435 break;
2436 case '$':
2437 eof = read_viminfo_sub_string(virp, forceit);
2438 break;
2439 case ':':
2440 case '?':
2441 case '=':
2442 case '@':
2443#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002444 /* When history is in bar lines skip the old style history
2445 * lines. */
2446 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2447 eof = read_viminfo_history(virp, writing);
2448 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002450 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 break;
2452 case '-':
2453 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002454 /* When file marks are in bar lines skip the old style lines. */
2455 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2456 eof = read_viminfo_filemark(virp, forceit);
2457 else
2458 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 break;
2460 default:
2461 if (viminfo_error("E575: ", _("Illegal starting char"),
2462 virp->vir_line))
2463 eof = TRUE;
2464 else
2465 eof = viminfo_readline(virp);
2466 break;
2467 }
2468 }
2469
2470#ifdef FEAT_CMDHIST
2471 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002472 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002473 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474#endif
2475
2476 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002477 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 fmarks_check_names(buf);
2479
2480 return eof;
2481}
2482
2483/*
2484 * Compare the 'encoding' value in the viminfo file with the current value of
2485 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2486 * conversion of text with iconv() in viminfo_readstring().
2487 */
2488 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002489viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 char_u *p;
2492 int i;
2493
2494 if (get_viminfo_parameter('c') != 0)
2495 {
2496 p = vim_strchr(virp->vir_line, '=');
2497 if (p != NULL)
2498 {
2499 /* remove trailing newline */
2500 ++p;
2501 for (i = 0; vim_isprintc(p[i]); ++i)
2502 ;
2503 p[i] = NUL;
2504
2505 convert_setup(&virp->vir_conv, p, p_enc);
2506 }
2507 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 return viminfo_readline(virp);
2509}
2510
2511/*
2512 * Read a line from the viminfo file.
2513 * Returns TRUE for end-of-file;
2514 */
2515 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002516viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517{
2518 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2519}
2520
2521/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002522 * Check string read from viminfo file.
2523 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 * - replace CTRL-V CTRL-V with CTRL-V
2525 * - replace CTRL-V 'n' with '\n'
2526 *
2527 * Check for a long line as written by viminfo_writestring().
2528 *
2529 * Return the string in allocated memory (NULL when out of memory).
2530 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002532viminfo_readstring(
2533 vir_T *virp,
2534 int off, /* offset for virp->vir_line */
2535 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536{
2537 char_u *retval;
2538 char_u *s, *d;
2539 long len;
2540
2541 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2542 {
2543 len = atol((char *)virp->vir_line + off + 1);
2544 retval = lalloc(len, TRUE);
2545 if (retval == NULL)
2546 {
2547 /* Line too long? File messed up? Skip next line. */
2548 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2549 return NULL;
2550 }
2551 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2552 s = retval + 1; /* Skip the leading '<' */
2553 }
2554 else
2555 {
2556 retval = vim_strsave(virp->vir_line + off);
2557 if (retval == NULL)
2558 return NULL;
2559 s = retval;
2560 }
2561
2562 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2563 d = retval;
2564 while (*s != NUL && *s != '\n')
2565 {
2566 if (s[0] == Ctrl_V && s[1] != NUL)
2567 {
2568 if (s[1] == 'n')
2569 *d++ = '\n';
2570 else
2571 *d++ = Ctrl_V;
2572 s += 2;
2573 }
2574 else
2575 *d++ = *s++;
2576 }
2577 *d = NUL;
2578
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2580 {
2581 d = string_convert(&virp->vir_conv, retval, NULL);
2582 if (d != NULL)
2583 {
2584 vim_free(retval);
2585 retval = d;
2586 }
2587 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588
2589 return retval;
2590}
2591
2592/*
2593 * write string to viminfo file
2594 * - replace CTRL-V with CTRL-V CTRL-V
2595 * - replace '\n' with CTRL-V 'n'
2596 * - add a '\n' at the end
2597 *
2598 * For a long line:
2599 * - write " CTRL-V <length> \n " in first line
2600 * - write " < <string> \n " in second line
2601 */
2602 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002603viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604{
2605 int c;
2606 char_u *s;
2607 int len = 0;
2608
2609 for (s = p; *s != NUL; ++s)
2610 {
2611 if (*s == Ctrl_V || *s == '\n')
2612 ++len;
2613 ++len;
2614 }
2615
2616 /* If the string will be too long, write its length and put it in the next
2617 * line. Take into account that some room is needed for what comes before
2618 * the string (e.g., variable name). Add something to the length for the
2619 * '<', NL and trailing NUL. */
2620 if (len > LSIZE / 2)
2621 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2622
2623 while ((c = *p++) != NUL)
2624 {
2625 if (c == Ctrl_V || c == '\n')
2626 {
2627 putc(Ctrl_V, fd);
2628 if (c == '\n')
2629 c = 'n';
2630 }
2631 putc(c, fd);
2632 }
2633 putc('\n', fd);
2634}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002635
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002636/*
2637 * Write a string in quotes that barline_parse() can read back.
2638 * Breaks the line in less than LSIZE pieces when needed.
2639 * Returns remaining characters in the line.
2640 */
2641 int
2642barline_writestring(FILE *fd, char_u *s, int remaining_start)
2643{
2644 char_u *p;
2645 int remaining = remaining_start;
2646 int len = 2;
2647
2648 /* Count the number of characters produced, including quotes. */
2649 for (p = s; *p != NUL; ++p)
2650 {
2651 if (*p == NL)
2652 len += 2;
2653 else if (*p == '"' || *p == '\\')
2654 len += 2;
2655 else
2656 ++len;
2657 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002658 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002659 {
2660 fprintf(fd, ">%d\n|<", len);
2661 remaining = LSIZE - 20;
2662 }
2663
2664 putc('"', fd);
2665 for (p = s; *p != NUL; ++p)
2666 {
2667 if (*p == NL)
2668 {
2669 putc('\\', fd);
2670 putc('n', fd);
2671 --remaining;
2672 }
2673 else if (*p == '"' || *p == '\\')
2674 {
2675 putc('\\', fd);
2676 putc(*p, fd);
2677 --remaining;
2678 }
2679 else
2680 putc(*p, fd);
2681 --remaining;
2682
2683 if (remaining < 3)
2684 {
2685 putc('\n', fd);
2686 putc('|', fd);
2687 putc('<', fd);
2688 /* Leave enough space for another continuation. */
2689 remaining = LSIZE - 20;
2690 }
2691 }
2692 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002693 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002694}
2695
2696/*
2697 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002698 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002699 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002700 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002701 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002702barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002703{
2704 char_u *p = text;
2705 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002706 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002707 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002708 int i;
2709 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002710 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002711 char_u *sconv;
2712 int converted;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002713
2714 while (*p == ',')
2715 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002716 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002717 if (ga_grow(values, 1) == FAIL)
2718 break;
2719 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002720
2721 if (*p == '>')
2722 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002723 /* Need to read a continuation line. Put strings in allocated
2724 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002725 if (!allocated)
2726 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002727 for (i = 0; i < values->ga_len; ++i)
2728 {
2729 bval_T *vp = (bval_T *)(values->ga_data) + i;
2730
2731 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002732 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002733 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2734 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002735 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002736 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737 allocated = TRUE;
2738 }
2739
2740 if (vim_isdigit(p[1]))
2741 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002742 size_t len;
2743 size_t todo;
2744 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002745
2746 /* String value was split into lines that are each shorter
2747 * than LSIZE:
2748 * |{bartype},>{length of "{text}{text2}"}
2749 * |<"{text1}
2750 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002751 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002752 */
2753 ++p;
2754 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002755 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002756 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002757 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002758 p = buf;
2759 for (todo = len; todo > 0; todo -= n)
2760 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002761 eof = viminfo_readline(virp);
2762 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002763 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002764 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002765 /* File was truncated or garbled. Read another line if
2766 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002767 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002768 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002769 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002770 /* Get length of text, excluding |< and NL chars. */
2771 n = STRLEN(virp->vir_line);
2772 while (n > 0 && (virp->vir_line[n - 1] == NL
2773 || virp->vir_line[n - 1] == CAR))
2774 --n;
2775 n -= 2;
2776 if (n > todo)
2777 {
2778 /* more values follow after the string */
2779 nextp = virp->vir_line + 2 + todo;
2780 n = todo;
2781 }
2782 mch_memmove(p, virp->vir_line + 2, n);
2783 p += n;
2784 }
2785 *p = NUL;
2786 p = buf;
2787 }
2788 else
2789 {
2790 /* Line ending in ">" continues in the next line:
2791 * |{bartype},{lots of values},>
2792 * |<{value},{value}
2793 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002794 eof = viminfo_readline(virp);
2795 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002796 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002797 /* File was truncated or garbled. Read another line if
2798 * this one starts with '|'. */
2799 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002800 p = virp->vir_line + 2;
2801 }
2802 }
2803
2804 if (isdigit(*p))
2805 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002806 value->bv_type = BVAL_NR;
2807 value->bv_nr = getdigits(&p);
2808 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002809 }
2810 else if (*p == '"')
2811 {
2812 int len = 0;
2813 char_u *s = p;
2814
2815 /* Unescape special characters in-place. */
2816 ++p;
2817 while (*p != '"')
2818 {
2819 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002820 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002821 if (*p == '\\')
2822 {
2823 ++p;
2824 if (*p == 'n')
2825 s[len++] = '\n';
2826 else
2827 s[len++] = *p;
2828 ++p;
2829 }
2830 else
2831 s[len++] = *p++;
2832 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002833 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002834 s[len] = NUL;
2835
Bram Moolenaar01227092016-06-11 14:47:40 +02002836 converted = FALSE;
2837 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2838 {
2839 sconv = string_convert(&virp->vir_conv, s, NULL);
2840 if (sconv != NULL)
2841 {
2842 if (s == buf)
2843 vim_free(s);
2844 s = sconv;
2845 buf = s;
2846 converted = TRUE;
2847 }
2848 }
Bram Moolenaar13505972019-01-24 15:04:48 +01002849
Bram Moolenaar01227092016-06-11 14:47:40 +02002850 /* Need to copy in allocated memory if the string wasn't allocated
2851 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002852 if (s != buf && allocated)
2853 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002854 value->bv_string = s;
2855 value->bv_type = BVAL_STRING;
2856 value->bv_len = len;
Bram Moolenaar13505972019-01-24 15:04:48 +01002857 value->bv_allocated = allocated || converted;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002858 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002859 if (nextp != NULL)
2860 {
2861 /* values following a long string */
2862 p = nextp;
2863 nextp = NULL;
2864 }
2865 }
2866 else if (*p == ',')
2867 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002868 value->bv_type = BVAL_EMPTY;
2869 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002870 }
2871 else
2872 break;
2873 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002874 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002875}
2876
2877 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002878read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002879{
2880 char_u *p = virp->vir_line + 1;
2881 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002882 garray_T values;
2883 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002884 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002885 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002886
2887 /* The format is: |{bartype},{value},...
2888 * For a very long string:
2889 * |{bartype},>{length of "{text}{text2}"}
2890 * |<{text1}
2891 * |<{text2},{value}
2892 * For a long line not using a string
2893 * |{bartype},{lots of values},>
2894 * |<{value},{value}
2895 */
2896 if (*p == '<')
2897 {
2898 /* Continuation line of an unrecognized item. */
2899 if (writing)
2900 ga_add_string(&virp->vir_barlines, virp->vir_line);
2901 }
2902 else
2903 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002904 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002905 bartype = getdigits(&p);
2906 switch (bartype)
2907 {
2908 case BARTYPE_VERSION:
2909 /* Only use the version when it comes before the encoding.
2910 * If it comes later it was copied by a Vim version that
2911 * doesn't understand the version. */
2912 if (!got_encoding)
2913 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002914 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002915 vp = (bval_T *)values.ga_data;
2916 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2917 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002918 }
2919 break;
2920
2921 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002922 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002923 handle_viminfo_history(&values, writing);
2924 break;
2925
2926 case BARTYPE_REGISTER:
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_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002929 break;
2930
Bram Moolenaar2d358992016-06-12 21:20:54 +02002931 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002932 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002933 handle_viminfo_mark(&values, force);
2934 break;
2935
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002936 default:
2937 /* copy unrecognized line (for future use) */
2938 if (writing)
2939 ga_add_string(&virp->vir_barlines, virp->vir_line);
2940 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002941 for (i = 0; i < values.ga_len; ++i)
2942 {
2943 vp = (bval_T *)values.ga_data + i;
2944 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2945 vim_free(vp->bv_string);
2946 }
2947 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002948 }
2949
Bram Moolenaarecefe712016-06-20 12:50:17 +02002950 if (read_next)
2951 return viminfo_readline(virp);
2952 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002953}
2954
2955 static void
2956write_viminfo_version(FILE *fp_out)
2957{
2958 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2959 BARTYPE_VERSION, VIMINFO_VERSION);
2960}
2961
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002962 static void
2963write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2964{
2965 int i;
2966 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002967 int seen_useful = FALSE;
2968 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002969
2970 if (gap->ga_len > 0)
2971 {
2972 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2973
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002974 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002975 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002976 {
2977 line = ((char **)(gap->ga_data))[i];
2978 if (seen_useful || line[1] != '<')
2979 {
2980 fputs(line, fp_out);
2981 seen_useful = TRUE;
2982 }
2983 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002984 }
2985}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986#endif /* FEAT_VIMINFO */
2987
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002988/*
2989 * Return the current time in seconds. Calls time(), unless test_settime()
2990 * was used.
2991 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002992 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002993vim_time(void)
2994{
2995# ifdef FEAT_EVAL
2996 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2997# else
2998 return time(NULL);
2999# endif
3000}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02003001
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002/*
3003 * Implementation of ":fixdel", also used by get_stty().
3004 * <BS> resulting <Del>
3005 * ^? ^H
3006 * not ^? ^?
3007 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003009do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010{
3011 char_u *p;
3012
3013 p = find_termcode((char_u *)"kb");
3014 add_termcode((char_u *)"kD", p != NULL
3015 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
3016}
3017
3018 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003019print_line_no_prefix(
3020 linenr_T lnum,
3021 int use_number,
3022 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023{
Bram Moolenaar32526b32019-01-19 17:43:09 +01003024 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025
3026 if (curwin->w_p_nu || use_number)
3027 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01003028 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003029 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01003030 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003032 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033}
3034
3035/*
3036 * Print a text line. Also in silent mode ("ex -s").
3037 */
3038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003039print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040{
3041 int save_silent = silent_mode;
3042
Bram Moolenaard29459b2016-08-26 22:29:11 +02003043 /* apply :filter /pat/ */
3044 if (message_filtered(ml_get(lnum)))
3045 return;
3046
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003048 silent_mode = FALSE;
3049 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
3050 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 if (save_silent)
3052 {
3053 msg_putchar('\n');
3054 cursor_on(); /* msg_start() switches it off */
3055 out_flush();
3056 silent_mode = save_silent;
3057 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00003058 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059}
3060
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003061 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003062rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003063{
3064 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02003065 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003066
Bram Moolenaar7e283842013-05-30 11:43:15 +02003067 buf = curbuf;
3068 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003069 /* buffer changed, don't change name now */
3070 if (buf != curbuf)
3071 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003072#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003073 if (aborting()) /* autocmds may abort script processing */
3074 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003075#endif
3076 /*
3077 * The name of the current buffer will be changed.
3078 * A new (unlisted) buffer entry needs to be made to hold the old file
3079 * name, which will become the alternate file name.
3080 * But don't set the alternate file name if the buffer didn't have a
3081 * name.
3082 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02003083 fname = curbuf->b_ffname;
3084 sfname = curbuf->b_sfname;
3085 xfname = curbuf->b_fname;
3086 curbuf->b_ffname = NULL;
3087 curbuf->b_sfname = NULL;
3088 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003089 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02003090 curbuf->b_ffname = fname;
3091 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003092 return FAIL;
3093 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02003094 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003095 if (xfname != NULL && *xfname != NUL)
3096 {
3097 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
3098 if (buf != NULL && !cmdmod.keepalt)
3099 curwin->w_alt_fnum = buf->b_fnum;
3100 }
3101 vim_free(fname);
3102 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02003103 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003104
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003105 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003106 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003107 return OK;
3108}
3109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110/*
3111 * ":file[!] [fname]".
3112 */
3113 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003114ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003116 /* ":0file" removes the file name. Check for illegal uses ":3file",
3117 * "0file name", etc. */
3118 if (eap->addr_count > 0
3119 && (*eap->arg != NUL
3120 || eap->line2 > 0
3121 || eap->addr_count > 1))
3122 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003123 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003124 return;
3125 }
3126
3127 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003129 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02003131 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02003133
3134 // print file name if no argument or 'F' is not in 'shortmess'
3135 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01003136 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137}
3138
3139/*
3140 * ":update".
3141 */
3142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003143ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144{
3145 if (curbufIsChanged())
3146 (void)do_write(eap);
3147}
3148
3149/*
3150 * ":write" and ":saveas".
3151 */
3152 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003153ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154{
3155 if (eap->usefilter) /* input lines to shell command */
3156 do_bang(1, eap, FALSE, TRUE, FALSE);
3157 else
3158 (void)do_write(eap);
3159}
3160
3161/*
3162 * write current buffer to file 'eap->arg'
3163 * if 'eap->append' is TRUE, append to the file
3164 *
3165 * if *eap->arg == NUL write to current file
3166 *
3167 * return FAIL for failure, OK otherwise
3168 */
3169 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003170do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171{
3172 int other;
3173 char_u *fname = NULL; /* init to shut up gcc */
3174 char_u *ffname;
3175 int retval = FAIL;
3176 char_u *free_fname = NULL;
3177#ifdef FEAT_BROWSE
3178 char_u *browse_file = NULL;
3179#endif
3180 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003181 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
3183 if (not_writing()) /* check 'write' option */
3184 return FAIL;
3185
3186 ffname = eap->arg;
3187#ifdef FEAT_BROWSE
3188 if (cmdmod.browse)
3189 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003190 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 NULL, NULL, NULL, curbuf);
3192 if (browse_file == NULL)
3193 goto theend;
3194 ffname = browse_file;
3195 }
3196#endif
3197 if (*ffname == NUL)
3198 {
3199 if (eap->cmdidx == CMD_saveas)
3200 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003201 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 goto theend;
3203 }
3204 other = FALSE;
3205 }
3206 else
3207 {
3208 fname = ffname;
3209 free_fname = fix_fname(ffname);
3210 /*
3211 * When out-of-memory, keep unexpanded file name, because we MUST be
3212 * able to write the file in this situation.
3213 */
3214 if (free_fname != NULL)
3215 ffname = free_fname;
3216 other = otherfile(ffname);
3217 }
3218
3219 /*
3220 * If we have a new file, put its name in the list of alternate file names.
3221 */
3222 if (other)
3223 {
3224 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3225 || eap->cmdidx == CMD_saveas)
3226 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3227 else
3228 alt_buf = buflist_findname(ffname);
3229 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3230 {
3231 /* Overwriting a file that is loaded in another buffer is not a
3232 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003233 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 goto theend;
3235 }
3236 }
3237
3238 /*
3239 * Writing to the current file is not allowed in readonly mode
3240 * and a file name is required.
3241 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3242 */
3243 if (!other && (
3244#ifdef FEAT_QUICKFIX
3245 bt_dontwrite_msg(curbuf) ||
3246#endif
3247 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3248 goto theend;
3249
3250 if (!other)
3251 {
3252 ffname = curbuf->b_ffname;
3253 fname = curbuf->b_fname;
3254 /*
3255 * Not writing the whole file is only allowed with '!'.
3256 */
3257 if ( (eap->line1 != 1
3258 || eap->line2 != curbuf->b_ml.ml_line_count)
3259 && !eap->forceit
3260 && !eap->append
3261 && !p_wa)
3262 {
3263#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3264 if (p_confirm || cmdmod.confirm)
3265 {
3266 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3267 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3268 goto theend;
3269 eap->forceit = TRUE;
3270 }
3271 else
3272#endif
3273 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003274 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 goto theend;
3276 }
3277 }
3278 }
3279
3280 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3281 {
3282 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3283 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 buf_T *was_curbuf = curbuf;
3285
3286 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003287 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003288#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003290#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003292#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 {
3294 /* buffer changed, don't change name now */
3295 retval = FAIL;
3296 goto theend;
3297 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 /* Exchange the file names for the current and the alternate
3299 * buffer. This makes it look like we are now editing the buffer
3300 * under the new name. Must be done before buf_write(), because
3301 * if there is no file name and 'cpo' contains 'F', it will set
3302 * the file name. */
3303 fname = alt_buf->b_fname;
3304 alt_buf->b_fname = curbuf->b_fname;
3305 curbuf->b_fname = fname;
3306 fname = alt_buf->b_ffname;
3307 alt_buf->b_ffname = curbuf->b_ffname;
3308 curbuf->b_ffname = fname;
3309 fname = alt_buf->b_sfname;
3310 alt_buf->b_sfname = curbuf->b_sfname;
3311 curbuf->b_sfname = fname;
3312 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003315 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 if (!alt_buf->b_p_bl)
3317 {
3318 alt_buf->b_p_bl = TRUE;
3319 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3320 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003321#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003323#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003325#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 {
3327 /* buffer changed, don't write the file */
3328 retval = FAIL;
3329 goto theend;
3330 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003331
3332 /* If 'filetype' was empty try detecting it now. */
3333 if (*curbuf->b_p_ft == NUL)
3334 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003335 if (au_has_group((char_u *)"filetypedetect"))
3336 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003337 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003338 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003339 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003340
3341 /* Autocommands may have changed buffer names, esp. when
3342 * 'autochdir' is set. */
3343 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 }
3345
Bram Moolenaar5c719942016-07-09 23:40:45 +02003346 name_was_missing = curbuf->b_ffname == NULL;
3347
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3349 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003350
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003351 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003352 if (eap->cmdidx == CMD_saveas)
3353 {
3354 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003355 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003356 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003357 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003358 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003359 }
3360
3361 /* Change directories when the 'acd' option is set and the file name
3362 * got changed or set. */
3363 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02003364 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 }
3366
3367theend:
3368#ifdef FEAT_BROWSE
3369 vim_free(browse_file);
3370#endif
3371 vim_free(free_fname);
3372 return retval;
3373}
3374
3375/*
3376 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3377 * BF_NEW or BF_READERR, check for overwriting current file.
3378 * May set eap->forceit if a dialog says it's OK to overwrite.
3379 * Return OK if it's OK, FAIL if it is not.
3380 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003381 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003382check_overwrite(
3383 exarg_T *eap,
3384 buf_T *buf,
3385 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003387 char_u *ffname, /* full path version of fname */
3388 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389{
3390 /*
3391 * write to other file or b_flags set or not writing the whole file:
3392 * overwriting only allowed with '!'
3393 */
3394 if ( (other
3395 || (buf->b_flags & BF_NOTEDITED)
3396 || ((buf->b_flags & BF_NEW)
3397 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3398 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003400#ifdef FEAT_QUICKFIX
3401 && !bt_nofile(buf)
3402#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 && vim_fexists(ffname))
3404 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003405 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003407#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003408 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003409 if (mch_isdir(ffname))
3410 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003411 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003412 return FAIL;
3413 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414#endif
3415#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003416 if (p_confirm || cmdmod.confirm)
3417 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003418 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003420 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3421 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3422 return FAIL;
3423 eap->forceit = TRUE;
3424 }
3425 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003428 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003429 return FAIL;
3430 }
3431 }
3432
3433 /* For ":w! filename" check that no swap file exists for "filename". */
3434 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003436 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003437 char_u *p;
3438 int r;
3439 char_u *swapname;
3440
3441 /* We only try the first entry in 'directory', without checking if
3442 * it's writable. If the "." directory is not writable the write
3443 * will probably fail anyway.
3444 * Use 'shortname' of the current buffer, since there is no buffer
3445 * for the written file. */
3446 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003447 {
3448 dir = alloc(5);
3449 if (dir == NULL)
3450 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003451 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003452 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003453 else
3454 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003455 dir = alloc(MAXPATHL);
3456 if (dir == NULL)
3457 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003458 p = p_dir;
3459 copy_option_part(&p, dir, MAXPATHL, ",");
3460 }
3461 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003462 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003463 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003464 if (r)
3465 {
3466#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3467 if (p_confirm || cmdmod.confirm)
3468 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003469 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003470
3471 dialog_msg(buff,
3472 _("Swap file \"%s\" exists, overwrite anyway?"),
3473 swapname);
3474 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3475 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003476 {
3477 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003478 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003479 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003480 eap->forceit = TRUE;
3481 }
3482 else
3483#endif
3484 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003485 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003486 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003487 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003488 return FAIL;
3489 }
3490 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003491 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 }
3493 }
3494 return OK;
3495}
3496
3497/*
3498 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3499 */
3500 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003501ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502{
3503 int i;
3504
3505 if (eap->cmd[1] == 'n')
3506 i = curwin->w_arg_idx + (int)eap->line2;
3507 else
3508 i = curwin->w_arg_idx - (int)eap->line2;
3509 eap->line1 = 1;
3510 eap->line2 = curbuf->b_ml.ml_line_count;
3511 if (do_write(eap) != FAIL)
3512 do_argfile(eap, i);
3513}
3514
3515/*
3516 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3517 */
3518 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003519do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520{
3521 buf_T *buf;
3522 int error = 0;
3523 int save_forceit = eap->forceit;
3524
3525 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3526 exiting = TRUE;
3527
Bram Moolenaar29323592016-07-24 22:04:11 +02003528 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003530#ifdef FEAT_TERMINAL
3531 if (exiting && term_job_running(buf->b_term))
3532 {
3533 no_write_message_nobang(buf);
3534 ++error;
3535 }
3536 else
3537#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003538 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 {
3540 /*
3541 * Check if there is a reason the buffer cannot be written:
3542 * 1. if the 'write' option is set
3543 * 2. if there is no file name (even after browsing)
3544 * 3. if the 'readonly' is set (even after a dialog)
3545 * 4. if overwriting is allowed (even after a dialog)
3546 */
3547 if (not_writing())
3548 {
3549 ++error;
3550 break;
3551 }
3552#ifdef FEAT_BROWSE
3553 /* ":browse wall": ask for file name if there isn't one */
3554 if (buf->b_ffname == NULL && cmdmod.browse)
3555 browse_save_fname(buf);
3556#endif
3557 if (buf->b_ffname == NULL)
3558 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003559 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 ++error;
3561 }
3562 else if (check_readonly(&eap->forceit, buf)
3563 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3564 FALSE) == FAIL)
3565 {
3566 ++error;
3567 }
3568 else
3569 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003570 bufref_T bufref;
3571
3572 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 if (buf_write_all(buf, eap->forceit) == FAIL)
3574 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003576 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 }
3579 eap->forceit = save_forceit; /* check_overwrite() may set it */
3580 }
3581 }
3582 if (exiting)
3583 {
3584 if (!error)
3585 getout(0); /* exit Vim */
3586 not_exiting();
3587 }
3588}
3589
3590/*
3591 * Check the 'write' option.
3592 * Return TRUE and give a message when it's not st.
3593 */
3594 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003595not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596{
3597 if (p_write)
3598 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003599 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 return TRUE;
3601}
3602
3603/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003604 * Check if a buffer is read-only (either 'readonly' option is set or file is
3605 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3606 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 */
3608 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003609check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003611 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003612
3613 /* Handle a file being readonly when the 'readonly' option is set or when
3614 * the file exists and permissions are read-only.
3615 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3616 * important for device checks but not here. */
3617 if (!*forceit && (buf->b_p_ro
3618 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3619 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 {
3621#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3622 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3623 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003624 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625
Bram Moolenaar5386a122007-06-28 20:02:32 +00003626 if (buf->b_p_ro)
3627 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3628 buf->b_fname);
3629 else
3630 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 +00003631 buf->b_fname);
3632
3633 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3634 {
3635 /* Set forceit, to force the writing of a readonly file */
3636 *forceit = TRUE;
3637 return FALSE;
3638 }
3639 else
3640 return TRUE;
3641 }
3642 else
3643#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003644 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003645 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003646 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003647 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00003648 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 return TRUE;
3650 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003651
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 return FALSE;
3653}
3654
3655/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003656 * Try to abandon the current file and edit a new or existing file.
3657 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003658 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003660 * Return:
3661 * GETFILE_ERROR for "normal" error,
3662 * GETFILE_NOT_WRITTEN for "not written" error,
3663 * GETFILE_SAME_FILE for success
3664 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 */
3666 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003667getfile(
3668 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003669 char_u *ffname_arg,
3670 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003671 int setpm,
3672 linenr_T lnum,
3673 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02003675 char_u *ffname = ffname_arg;
3676 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 int other;
3678 int retval;
3679 char_u *free_me = NULL;
3680
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003681 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003682 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003683 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003684 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685
3686 if (fnum == 0)
3687 {
3688 /* make ffname full path, set sfname */
3689 fname_expand(curbuf, &ffname, &sfname);
3690 other = otherfile(ffname);
3691 free_me = ffname; /* has been allocated, free() later */
3692 }
3693 else
3694 other = (fnum != curbuf->b_fnum);
3695
3696 if (other)
3697 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003698 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3700 {
3701#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3702 if (p_confirm && p_write)
3703 dialog_changed(curbuf, FALSE);
3704 if (curbufIsChanged())
3705#endif
3706 {
3707 if (other)
3708 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003709 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003710 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 goto theend;
3712 }
3713 }
3714 if (other)
3715 --no_wait_return;
3716 if (setpm)
3717 setpcmark();
3718 if (!other)
3719 {
3720 if (lnum != 0)
3721 curwin->w_cursor.lnum = lnum;
3722 check_cursor_lnum();
3723 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003724 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 }
3726 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003727 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003728 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003729 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003731 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732
3733theend:
3734 vim_free(free_me);
3735 return retval;
3736}
3737
3738/*
3739 * start editing a new file
3740 *
3741 * fnum: file number; if zero use ffname/sfname
3742 * ffname: the file name
3743 * - full path if sfname used,
3744 * - any file name if sfname is NULL
3745 * - empty string to re-edit with the same file name (but may be
3746 * in a different directory)
3747 * - NULL to start an empty buffer
3748 * sfname: the short file name (or NULL)
3749 * eap: contains the command to be executed after loading the file and
3750 * forced 'ff' and 'fenc'
3751 * newlnum: if > 0: put cursor on this line number (if possible)
3752 * if ECMD_LASTL: use last position in loaded file
3753 * if ECMD_LAST: use last position in all files
3754 * if ECMD_ONE: use first line
3755 * flags:
3756 * ECMD_HIDE: if TRUE don't free the current buffer
3757 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3758 * ECMD_OLDBUF: use existing buffer if it exists
3759 * ECMD_FORCEIT: ! used for Ex command
3760 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003761 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003762 * window, NULL when splitting the window first. When not NULL info
3763 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 *
3765 * return FAIL for failure, OK otherwise
3766 */
3767 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003768do_ecmd(
3769 int fnum,
3770 char_u *ffname,
3771 char_u *sfname,
3772 exarg_T *eap, /* can be NULL! */
3773 linenr_T newlnum,
3774 int flags,
3775 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776{
3777 int other_file; /* TRUE if editing another file */
3778 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 int auto_buf = FALSE; /* TRUE if autocommands brought us
3780 into the buffer unexpectedly */
3781 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003782#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003783 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784#endif
3785 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003786 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003787 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 char_u *free_fname = NULL;
3789#ifdef FEAT_BROWSE
3790 char_u *browse_file = NULL;
3791#endif
3792 int retval = FAIL;
3793 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003794 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 linenr_T topline = 0;
3796 int newcol = -1;
3797 int solcol = -1;
3798 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003800#ifdef FEAT_SPELL
3801 int did_get_winopts = FALSE;
3802#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003803 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003804 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003805 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806
3807 if (eap != NULL)
3808 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003809 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810
3811 if (fnum != 0)
3812 {
3813 if (fnum == curbuf->b_fnum) /* file is already being edited */
3814 return OK; /* nothing to do */
3815 other_file = TRUE;
3816 }
3817 else
3818 {
3819#ifdef FEAT_BROWSE
3820 if (cmdmod.browse)
3821 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003822 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003823# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003824 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003825# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003826 au_has_group((char_u *)"FileExplorer"))
3827 {
3828 /* No browsing supported but we do have the file explorer:
3829 * Edit the directory. */
3830 if (ffname == NULL || !mch_isdir(ffname))
3831 ffname = (char_u *)".";
3832 }
3833 else
3834 {
3835 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003837 if (browse_file == NULL)
3838 goto theend;
3839 ffname = browse_file;
3840 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 }
3842#endif
3843 /* if no short name given, use ffname for short name */
3844 if (sfname == NULL)
3845 sfname = ffname;
3846#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01003847 if (sfname != NULL)
3848 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849#endif
3850
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3852 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853
3854 if (ffname == NULL)
3855 other_file = TRUE;
3856 /* there is no file name */
3857 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3858 other_file = FALSE;
3859 else
3860 {
3861 if (*ffname == NUL) /* re-edit with same file name */
3862 {
3863 ffname = curbuf->b_ffname;
3864 sfname = curbuf->b_fname;
3865 }
3866 free_fname = fix_fname(ffname); /* may expand to full path name */
3867 if (free_fname != NULL)
3868 ffname = free_fname;
3869 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 }
3871 }
3872
3873 /*
3874 * if the file was changed we may not be allowed to abandon it
3875 * - if we are going to re-edit the same file
3876 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3877 */
3878 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3879 || (curbuf->b_nwindows == 1
3880 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003881 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3882 | (other_file ? 0 : CCGD_MULTWIN)
3883 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3884 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 {
3886 if (fnum == 0 && other_file && ffname != NULL)
3887 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3888 goto theend;
3889 }
3890
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 /*
3892 * End Visual mode before switching to another buffer, so the text can be
3893 * copied into the GUI selection buffer.
3894 */
3895 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003897#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003898 if ((command != NULL || newlnum > (linenr_T)0)
3899 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3900 {
3901 int len;
3902 char_u *p;
3903
3904 /* Set v:swapcommand for the SwapExists autocommands. */
3905 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003906 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003907 else
3908 len = 30;
3909 p = alloc((unsigned)len);
3910 if (p != NULL)
3911 {
3912 if (command != NULL)
3913 vim_snprintf((char *)p, len, ":%s\r", command);
3914 else
3915 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3916 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3917 did_set_swapcommand = TRUE;
3918 vim_free(p);
3919 }
3920 }
3921#endif
3922
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 /*
3924 * If we are starting to edit another file, open a (new) buffer.
3925 * Otherwise we re-use the current buffer.
3926 */
3927 if (other_file)
3928 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003931 if (!cmdmod.keepalt)
3932 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003933 if (oldwin != NULL)
3934 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 }
3936
3937 if (fnum)
3938 buf = buflist_findnr(fnum);
3939 else
3940 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 if (flags & ECMD_ADDBUF)
3942 {
3943 linenr_T tlnum = 1L;
3944
3945 if (command != NULL)
3946 {
3947 tlnum = atol((char *)command);
3948 if (tlnum <= 0)
3949 tlnum = 1L;
3950 }
3951 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3952 goto theend;
3953 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 buf = buflist_new(ffname, sfname, 0L,
3955 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003956
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003957 /* autocommands may change curwin and curbuf */
3958 if (oldwin != NULL)
3959 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003960 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 }
3962 if (buf == NULL)
3963 goto theend;
3964 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3965 {
3966 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 }
3968 else /* existing memfile */
3969 {
3970 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003971 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003973 /* Check if autocommands made the buffer invalid or changed the
3974 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003975 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 goto theend;
3977#ifdef FEAT_EVAL
3978 if (aborting()) /* autocmds may abort script processing */
3979 goto theend;
3980#endif
3981 }
3982
3983 /* May jump to last used line number for a loaded buffer or when asked
3984 * for explicitly */
3985 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3986 {
3987 pos = buflist_findfpos(buf);
3988 newlnum = pos->lnum;
3989 solcol = pos->col;
3990 }
3991
3992 /*
3993 * Make the (new) buffer the one used by the current window.
3994 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3995 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003996 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 */
3998 if (buf != curbuf)
3999 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 /*
4001 * Be careful: The autocommands may delete any buffer and change
4002 * the current buffer.
4003 * - If the buffer we are going to edit is deleted, give up.
4004 * - If the current buffer is deleted, prefer to load the new
4005 * buffer when loading a buffer is required. This avoids
4006 * loading another buffer which then must be closed again.
4007 * - If we ended up in the new buffer already, need to skip a few
4008 * things, set auto_buf.
4009 */
4010 if (buf->b_fname != NULL)
4011 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004012 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004014 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004016 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 delbuf_msg(new_name); /* frees new_name */
4018 goto theend;
4019 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004020#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 if (aborting()) /* autocmds may abort script processing */
4022 {
4023 vim_free(new_name);
4024 goto theend;
4025 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004026#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 if (buf == curbuf) /* already in new buffer */
4028 auto_buf = TRUE;
4029 else
4030 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02004031 win_T *the_curwin = curwin;
4032
4033 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004034 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02004035 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004036 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02004037
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004038 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 buf_copy_options(buf, BCO_ENTER);
4040
Bram Moolenaar5a497892016-09-03 16:29:04 +02004041 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02004042 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004043 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00004044 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01004045 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046
Bram Moolenaar5a497892016-09-03 16:29:04 +02004047 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02004048 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01004049
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004050#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02004051 /* autocmds may abort script processing */
4052 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 {
4054 vim_free(new_name);
4055 goto theend;
4056 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004057#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004059 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004061 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 delbuf_msg(new_name); /* frees new_name */
4063 goto theend;
4064 }
4065 if (buf == curbuf) /* already in new buffer */
4066 auto_buf = TRUE;
4067 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02004069#ifdef FEAT_SYN_HL
4070 /*
4071 * <VN> We could instead free the synblock
4072 * and re-attach to buffer, perhaps.
4073 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02004074 if (curwin->w_buffer == NULL
4075 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02004076 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02004077#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 curwin->w_buffer = buf;
4079 curbuf = buf;
4080 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02004081
4082 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
4083 if (!oldbuf && eap != NULL)
4084 {
4085 set_file_options(TRUE, eap);
4086 set_forced_fenc(eap);
4087 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 }
4089
4090 /* May get the window options from the last time this buffer
4091 * was in this window (or another window). If not used
4092 * before, reset the local window options to the global
4093 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004094 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004095#ifdef FEAT_SPELL
4096 did_get_winopts = TRUE;
4097#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 }
4099 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004100 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004101 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103
4104 curwin->w_pcmark.lnum = 1;
4105 curwin->w_pcmark.col = 0;
4106 }
4107 else /* !other_file */
4108 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02004109 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004111
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 oldbuf = (flags & ECMD_OLDBUF);
4113 }
4114
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004115 /* Don't redraw until the cursor is in the right line, otherwise
4116 * autocommands may cause ml_get errors. */
4117 ++RedrawingDisabled;
4118 did_inc_redrawing_disabled = TRUE;
4119
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004120 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4122 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004123 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 }
4125 else
4126 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 /* Don't make a buffer listed if it's a help buffer. Useful when
4128 * using CTRL-O to go back to a help file. */
4129 if (!curbuf->b_help)
4130 set_buflisted(TRUE);
4131 }
4132
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 /* If autocommands change buffers under our fingers, forget about
4134 * editing the file. */
4135 if (buf != curbuf)
4136 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004137#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 if (aborting()) /* autocmds may abort script processing */
4139 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004140#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141
4142 /* Since we are starting to edit a file, consider the filetype to be
4143 * unset. Helps for when an autocommand changes files and expects syntax
4144 * highlighting to work in the other file. */
4145 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146
4147/*
4148 * other_file oldbuf
4149 * FALSE FALSE re-edit same file, buffer is re-used
4150 * FALSE TRUE re-edit same file, nothing changes
4151 * TRUE FALSE start editing new file, new buffer
4152 * TRUE TRUE start editing in existing buffer (nothing to do)
4153 */
4154 if (!other_file && !oldbuf) /* re-use the buffer */
4155 {
4156 set_last_cursor(curwin); /* may set b_last_cursor */
4157 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4158 {
4159 newlnum = curwin->w_cursor.lnum;
4160 solcol = curwin->w_cursor.col;
4161 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 buf = curbuf;
4163 if (buf->b_fname != NULL)
4164 new_name = vim_strsave(buf->b_fname);
4165 else
4166 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004167 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004168
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004169 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4170 {
4171 /* Save all the text, so that the reload can be undone.
4172 * Sync first so that this is a separate undo-able action. */
4173 u_sync(FALSE);
4174 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4175 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004176 {
4177 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004178 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004179 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004180 u_unchanged(curbuf);
4181 buf_freeall(curbuf, BFA_KEEP_UNDO);
4182
4183 /* tell readfile() not to clear or reload undo info */
4184 readfile_flags = READ_KEEP_UNDO;
4185 }
4186 else
4187 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004188
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 /* If autocommands deleted the buffer we were going to re-edit, give
4190 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004191 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 {
4193 delbuf_msg(new_name); /* frees new_name */
4194 goto theend;
4195 }
4196 vim_free(new_name);
4197
4198 /* If autocommands change buffers under our fingers, forget about
4199 * re-editing the file. Should do the buf_clear_file(), but perhaps
4200 * the autocommands changed the buffer... */
4201 if (buf != curbuf)
4202 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004203#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 if (aborting()) /* autocmds may abort script processing */
4205 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206#endif
4207 buf_clear_file(curbuf);
4208 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4209 curbuf->b_op_end.lnum = 0;
4210 }
4211
4212/*
4213 * If we get here we are sure to start editing
4214 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 /* Assume success now */
4216 retval = OK;
4217
4218 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 * Check if we are editing the w_arg_idx file in the argument list.
4220 */
4221 check_arg_idx(curwin);
4222
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 {
4225 /*
4226 * Set cursor and init window before reading the file and executing
4227 * autocommands. This allows for the autocommands to position the
4228 * cursor.
4229 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004230 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231
4232#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004233 /* It's possible that all lines in the buffer changed. Need to update
4234 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004235 {
4236 win_T *win;
4237 tabpage_T *tp;
4238
4239 FOR_ALL_TAB_WINDOWS(tp, win)
4240 if (win->w_buffer == curbuf)
4241 foldUpdateAll(win);
4242 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243#endif
4244
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004245 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02004246 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004247
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 /*
4249 * Careful: open_buffer() and apply_autocmds() may change the current
4250 * buffer and window.
4251 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004252 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 topline = curwin->w_topline;
4254 if (!oldbuf) /* need to read the file */
4255 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004256#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 swap_exists_action = SEA_DIALOG;
4258#endif
4259 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4260
4261 /*
4262 * Open the buffer and read the file.
4263 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004264#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004265 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 retval = FAIL;
4267#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004268 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269#endif
4270
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004271#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 if (swap_exists_action == SEA_QUIT)
4273 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004274 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275#endif
4276 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 else
4278 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004279 /* Read the modelines, but only to set window-local options. Any
4280 * buffer-local options have already been set and may have been
4281 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004282 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004283
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4285 &retval);
4286 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4287 &retval);
4288 }
4289 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290
Bram Moolenaareab316b2015-03-24 11:46:30 +01004291 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004292 * keep it. Also when it moves within a line. But not when it moves
4293 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004294 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02004296 char_u *text = ml_get_curline();
4297
4298 if (curwin->w_cursor.lnum != orig_pos.lnum
4299 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
4300 {
4301 newlnum = curwin->w_cursor.lnum;
4302 newcol = curwin->w_cursor.col;
4303 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 }
4305 if (curwin->w_topline == topline)
4306 topline = 0;
4307
4308 /* Even when cursor didn't move we need to recompute topline. */
4309 changed_line_abv_curs();
4310
4311#ifdef FEAT_TITLE
4312 maketitle();
4313#endif
4314 }
4315
4316#ifdef FEAT_DIFF
4317 /* Tell the diff stuff that this buffer is new and/or needs updating.
4318 * Also needed when re-editing the same buffer, because unloading will
4319 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004320 if (curwin->w_p_diff)
4321 {
4322 diff_buf_add(curbuf);
4323 diff_invalidate(curbuf);
4324 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325#endif
4326
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004327#ifdef FEAT_SPELL
4328 /* If the window options were changed may need to set the spell language.
4329 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004330 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4331 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004332#endif
4333
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 if (command == NULL)
4335 {
4336 if (newcol >= 0) /* position set by autocommands */
4337 {
4338 curwin->w_cursor.lnum = newlnum;
4339 curwin->w_cursor.col = newcol;
4340 check_cursor();
4341 }
4342 else if (newlnum > 0) /* line number from caller or old position */
4343 {
4344 curwin->w_cursor.lnum = newlnum;
4345 check_cursor_lnum();
4346 if (solcol >= 0 && !p_sol)
4347 {
4348 /* 'sol' is off: Use last known column. */
4349 curwin->w_cursor.col = solcol;
4350 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 curwin->w_set_curswant = TRUE;
4353 }
4354 else
4355 beginline(BL_SOL | BL_FIX);
4356 }
4357 else /* no line number, go to last line in Ex mode */
4358 {
4359 if (exmode_active)
4360 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4361 beginline(BL_WHITE | BL_FIX);
4362 }
4363 }
4364
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 /* Check if cursors in other windows on the same buffer are still valid */
4366 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367
4368 /*
4369 * Did not read the file, need to show some info about the file.
4370 * Do this after setting the cursor.
4371 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004372 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 {
4374 int msg_scroll_save = msg_scroll;
4375
4376 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4377 * message. */
4378 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4379 msg_scroll = FALSE;
4380 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4381 check_for_delay(FALSE);
4382 msg_start();
4383 msg_scroll = msg_scroll_save;
4384 msg_scrolled_ign = TRUE;
4385
Bram Moolenaar426dd022016-03-15 15:09:29 +01004386 if (!shortmess(SHM_FILEINFO))
4387 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388
4389 msg_scrolled_ign = FALSE;
4390 }
4391
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004392#ifdef FEAT_VIMINFO
4393 curbuf->b_last_used = vim_time();
4394#endif
4395
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 if (command != NULL)
4397 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4398
4399#ifdef FEAT_KEYMAP
4400 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004401 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402#endif
4403
4404 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004405 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 if (!skip_redraw)
4407 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01004408 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01004410 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01004413 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4415 }
4416
4417 if (p_im)
4418 need_start_insertmode = TRUE;
4419
Bram Moolenaar15833232018-02-03 18:33:17 +01004420#ifdef FEAT_AUTOCHDIR
4421 /* Change directories when the 'acd' option is set and we aren't already in
4422 * that directory (should already be done above). Expect getcwd() to be
4423 * faster than calling shorten_fnames() unnecessarily. */
4424 if (p_acd && curbuf->b_ffname != NULL)
4425 {
4426 char_u curdir[MAXPATHL];
4427 char_u filedir[MAXPATHL];
4428
4429 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4430 *gettail_sep(filedir) = NUL;
4431 if (mch_dirname(curdir, MAXPATHL) != FAIL
4432 && vim_fnamecmp(curdir, filedir) != 0)
4433 do_autochdir();
4434 }
4435#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01004437#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004438 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004441 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004442 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443# endif
4444 }
4445#endif
4446
4447theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004448 if (did_inc_redrawing_disabled)
4449 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004450#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004451 if (did_set_swapcommand)
4452 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4453#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454#ifdef FEAT_BROWSE
4455 vim_free(browse_file);
4456#endif
4457 vim_free(free_fname);
4458 return retval;
4459}
4460
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004462delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004464 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 name == NULL ? (char_u *)"" : name);
4466 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004467 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004468 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004471static int append_indent = 0; /* autoindent for first line */
4472
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473/*
4474 * ":insert" and ":append", also used by ":change"
4475 */
4476 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004477ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478{
4479 char_u *theline;
4480 int did_undo = FALSE;
4481 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004482 int indent = 0;
4483 char_u *p;
4484 int vcol;
4485 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004487 /* the ! flag toggles autoindent */
4488 if (eap->forceit)
4489 curbuf->b_p_ai = !curbuf->b_p_ai;
4490
4491 /* First autoindent comes from the line we start on */
4492 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4493 append_indent = get_indent_lnum(lnum);
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 if (eap->cmdidx != CMD_append)
4496 --lnum;
4497
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004498 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004499 if (empty && lnum == 1)
4500 lnum = 0;
4501
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 State = INSERT; /* behave like in Insert mode */
4503 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4504 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004505
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004506 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 {
4508 msg_scroll = TRUE;
4509 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004510 if (curbuf->b_p_ai)
4511 {
4512 if (append_indent >= 0)
4513 {
4514 indent = append_indent;
4515 append_indent = -1;
4516 }
4517 else if (lnum > 0)
4518 indent = get_indent_lnum(lnum);
4519 }
4520 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004522 {
4523 /* No getline() function, use the lines that follow. This ends
4524 * when there is no more. */
4525 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4526 break;
4527 p = vim_strchr(eap->nextcmd, NL);
4528 if (p == NULL)
4529 p = eap->nextcmd + STRLEN(eap->nextcmd);
4530 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4531 if (*p != NUL)
4532 ++p;
4533 eap->nextcmd = p;
4534 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004536 {
4537 int save_State = State;
4538
4539 /* Set State to avoid the cursor shape to be set to INSERT mode
4540 * when getline() returns. */
4541 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 theline = eap->getline(
4543#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004544 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004546 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004547 State = save_State;
4548 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004550 if (theline == NULL)
4551 break;
4552
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004553 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4554 if (ex_keep_indent)
4555 append_indent = indent;
4556
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004557 /* Look for the "." after automatic indent. */
4558 vcol = 0;
4559 for (p = theline; indent > vcol; ++p)
4560 {
4561 if (*p == ' ')
4562 ++vcol;
4563 else if (*p == TAB)
4564 vcol += 8 - vcol % 8;
4565 else
4566 break;
4567 }
4568 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004569 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4570 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 {
4572 vim_free(theline);
4573 break;
4574 }
4575
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004576 /* don't use autoindent if nothing was typed. */
4577 if (p[0] == NUL)
4578 theline[0] = NUL;
4579
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 did_undo = TRUE;
4581 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004582 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583
4584 vim_free(theline);
4585 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004586
4587 if (empty)
4588 {
4589 ml_delete(2L, FALSE);
4590 empty = FALSE;
4591 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 }
4593 State = NORMAL;
4594
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004595 if (eap->forceit)
4596 curbuf->b_p_ai = !curbuf->b_p_ai;
4597
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004599 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 * "end" is set to lnum when something has been appended, otherwise
4601 * it is the same than "start" -- Acevedo */
4602 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4603 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4604 if (eap->cmdidx != CMD_append)
4605 --curbuf->b_op_start.lnum;
4606 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4607 ? lnum : curbuf->b_op_start.lnum;
4608 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4609 curwin->w_cursor.lnum = lnum;
4610 check_cursor_lnum();
4611 beginline(BL_SOL | BL_FIX);
4612
4613 need_wait_return = FALSE; /* don't use wait_return() now */
4614 ex_no_reprint = TRUE;
4615}
4616
4617/*
4618 * ":change"
4619 */
4620 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004621ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622{
4623 linenr_T lnum;
4624
4625 if (eap->line2 >= eap->line1
4626 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4627 return;
4628
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004629 /* the ! flag toggles autoindent */
4630 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4631 append_indent = get_indent_lnum(eap->line1);
4632
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4634 {
4635 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4636 break;
4637 ml_delete(eap->line1, FALSE);
4638 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004639
4640 /* make sure the cursor is not beyond the end of the file now */
4641 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4643
4644 /* ":append" on the line above the deleted lines. */
4645 eap->line2 = eap->line1;
4646 ex_append(eap);
4647}
4648
4649 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004650ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651{
4652 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004653 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004654 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 int minus = 0;
4656 linenr_T start, end, curs, i;
4657 int j;
4658 linenr_T lnum = eap->line2;
4659
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004660 /* Vi compatible: ":z!" uses display height, without a count uses
4661 * 'scroll' */
4662 if (eap->forceit)
4663 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004664 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004665 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004666 else
4667 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 if (bigness < 1)
4669 bigness = 1;
4670
4671 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004672 kind = x;
4673 if (*kind == '-' || *kind == '+' || *kind == '='
4674 || *kind == '^' || *kind == '.')
4675 ++x;
4676 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 ++x;
4678
4679 if (*x != 0)
4680 {
4681 if (!VIM_ISDIGIT(*x))
4682 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004683 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 return;
4685 }
4686 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004687 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004688 bigness = atol((char *)x);
4689
4690 /* bigness could be < 0 if atol(x) overflows. */
4691 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4692 bigness = 2 * curbuf->b_ml.ml_line_count;
4693
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004694 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004695 if (*kind == '=')
4696 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004697 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 }
4699
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004700 /* the number of '-' and '+' multiplies the distance */
4701 if (*kind == '-' || *kind == '+')
4702 for (x = kind + 1; *x == *kind; ++x)
4703 ;
4704
4705 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 {
4707 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004708 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4709 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004710 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 break;
4712
4713 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004714 start = lnum - (bigness + 1) / 2 + 1;
4715 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 curs = lnum;
4717 minus = 1;
4718 break;
4719
4720 case '^':
4721 start = lnum - bigness * 2;
4722 end = lnum - bigness;
4723 curs = lnum - bigness;
4724 break;
4725
4726 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004727 start = lnum - (bigness + 1) / 2 + 1;
4728 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 curs = end;
4730 break;
4731
4732 default: /* '+' */
4733 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004734 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004735 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004736 else if (eap->addr_count == 0)
4737 ++start;
4738 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 curs = end;
4740 break;
4741 }
4742
4743 if (start < 1)
4744 start = 1;
4745
4746 if (end > curbuf->b_ml.ml_line_count)
4747 end = curbuf->b_ml.ml_line_count;
4748
4749 if (curs > curbuf->b_ml.ml_line_count)
4750 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004751 else if (curs < 1)
4752 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
4754 for (i = start; i <= end; i++)
4755 {
4756 if (minus && i == lnum)
4757 {
4758 msg_putchar('\n');
4759
4760 for (j = 1; j < Columns; j++)
4761 msg_putchar('-');
4762 }
4763
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004764 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765
4766 if (minus && i == lnum)
4767 {
4768 msg_putchar('\n');
4769
4770 for (j = 1; j < Columns; j++)
4771 msg_putchar('-');
4772 }
4773 }
4774
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004775 if (curwin->w_cursor.lnum != curs)
4776 {
4777 curwin->w_cursor.lnum = curs;
4778 curwin->w_cursor.col = 0;
4779 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 ex_no_reprint = TRUE;
4781}
4782
4783/*
4784 * Check if the restricted flag is set.
4785 * If so, give an error message and return TRUE.
4786 * Otherwise, return FALSE.
4787 */
4788 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004789check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790{
4791 if (restricted)
4792 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01004793 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 return TRUE;
4795 }
4796 return FALSE;
4797}
4798
4799/*
4800 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4801 * If so, give an error message and return TRUE.
4802 * Otherwise, return FALSE.
4803 */
4804 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004805check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806{
4807 if (secure)
4808 {
4809 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004810 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 return TRUE;
4812 }
4813#ifdef HAVE_SANDBOX
4814 /*
4815 * In the sandbox more things are not allowed, including the things
4816 * disallowed in secure mode.
4817 */
4818 if (sandbox != 0)
4819 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004820 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 return TRUE;
4822 }
4823#endif
4824 return FALSE;
4825}
4826
4827static char_u *old_sub = NULL; /* previous substitute pattern */
4828static int global_need_beginline; /* call beginline() after ":g" */
4829
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004830/*
4831 * Flags that are kept between calls to :substitute.
4832 */
4833typedef struct {
4834 int do_all; /* do multiple substitutions per line */
4835 int do_ask; /* ask for confirmation */
4836 int do_count; /* count only */
4837 int do_error; /* if false, ignore errors */
4838 int do_print; /* print last line with subs. */
4839 int do_list; /* list last line with subs. */
4840 int do_number; /* list last line with line nr*/
4841 int do_ic; /* ignore case flag */
4842} subflags_T;
4843
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844/* do_sub()
4845 *
4846 * Perform a substitution from line eap->line1 to line eap->line2 using the
4847 * command pointed to by eap->arg which should be of the form:
4848 *
4849 * /pattern/substitution/{flags}
4850 *
4851 * The usual escapes are supported as described in the regexp docs.
4852 */
4853 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004854do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855{
4856 linenr_T lnum;
4857 long i = 0;
4858 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004859 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4860 FALSE, FALSE, 0};
4861#ifdef FEAT_EVAL
4862 subflags_T subflags_save;
4863#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004864 int save_do_all; /* remember user specified 'g' flag */
4865 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4867 int delimiter;
4868 int sublen;
4869 int got_quit = FALSE;
4870 int got_match = FALSE;
4871 int temp;
4872 int which_pat;
4873 char_u *cmd;
4874 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004875 linenr_T first_line = 0; /* first changed line */
4876 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 * change */
4878 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4879 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004880 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004881 char_u *sub_firstline; /* allocated copy of first sub line */
4882 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004883 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004884 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004885#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004886 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004887#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888
4889 cmd = eap->arg;
4890 if (!global_busy)
4891 {
4892 sub_nsubs = 0;
4893 sub_nlines = 0;
4894 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004895 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 if (eap->cmdidx == CMD_tilde)
4898 which_pat = RE_LAST; /* use last used regexp */
4899 else
4900 which_pat = RE_SUBST; /* use last substitute regexp */
4901
4902 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004903 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4905 {
4906 /* don't accept alphanumeric for separator */
4907 if (isalpha(*cmd))
4908 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004909 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 return;
4911 }
4912 /*
4913 * undocumented vi feature:
4914 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4915 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4916 */
4917 if (*cmd == '\\')
4918 {
4919 ++cmd;
4920 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4921 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004922 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 return;
4924 }
4925 if (*cmd != '&')
4926 which_pat = RE_SEARCH; /* use last '/' pattern */
4927 pat = (char_u *)""; /* empty search pattern */
4928 delimiter = *cmd++; /* remember delimiter character */
4929 }
4930 else /* find the end of the regexp */
4931 {
4932 which_pat = RE_LAST; /* use last used regexp */
4933 delimiter = *cmd++; /* remember delimiter character */
4934 pat = cmd; /* remember start of search pat */
4935 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4936 if (cmd[0] == delimiter) /* end delimiter found */
4937 *cmd++ = NUL; /* replace it with a NUL */
4938 }
4939
4940 /*
4941 * Small incompatibility: vi sees '\n' as end of the command, but in
4942 * Vim we want to use '\n' to find/substitute a NUL.
4943 */
4944 sub = cmd; /* remember the start of the substitution */
4945
4946 while (cmd[0])
4947 {
4948 if (cmd[0] == delimiter) /* end delimiter found */
4949 {
4950 *cmd++ = NUL; /* replace it with a NUL */
4951 break;
4952 }
4953 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4954 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004955 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 }
4957
4958 if (!eap->skip)
4959 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004960 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4961 if (STRCMP(sub, "%") == 0
4962 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4963 {
4964 if (old_sub == NULL) /* there is no previous command */
4965 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004966 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004967 return;
4968 }
4969 sub = old_sub;
4970 }
4971 else
4972 {
4973 vim_free(old_sub);
4974 old_sub = vim_strsave(sub);
4975 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 }
4977 }
4978 else if (!eap->skip) /* use previous pattern and substitution */
4979 {
4980 if (old_sub == NULL) /* there is no previous command */
4981 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004982 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 return;
4984 }
4985 pat = NULL; /* search_regcomp() will use previous pattern */
4986 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004987
4988 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4989 * last column after using "$". */
4990 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 }
4992
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004993 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4994 * more efficient.
4995 * TODO: find a generic solution to make line-joining operations more
4996 * efficient, avoid allocating a string that grows in size.
4997 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004998 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004999 && *sub == NUL
5000 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
5001 || *cmd == 'p' || *cmd == '#'))))
5002 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005003 linenr_T joined_lines_count;
5004
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005005 curwin->w_cursor.lnum = eap->line1;
5006 if (*cmd == 'l')
5007 eap->flags = EXFLAG_LIST;
5008 else if (*cmd == '#')
5009 eap->flags = EXFLAG_NR;
5010 else if (*cmd == 'p')
5011 eap->flags = EXFLAG_PRINT;
5012
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01005013 /* The number of lines joined is the number of lines in the range plus
5014 * one. One less when the last line is included. */
5015 joined_lines_count = eap->line2 - eap->line1 + 1;
5016 if (eap->line2 < curbuf->b_ml.ml_line_count)
5017 ++joined_lines_count;
5018 if (joined_lines_count > 1)
5019 {
5020 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
5021 sub_nsubs = joined_lines_count - 1;
5022 sub_nlines = 1;
5023 (void)do_sub_msg(FALSE);
5024 ex_may_print(eap);
5025 }
5026
5027 if (!cmdmod.keeppatterns)
5028 save_re_pat(RE_SUBST, pat, p_magic);
5029#ifdef FEAT_CMDHIST
5030 /* put pattern in history */
5031 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
5032#endif
5033
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02005034 return;
5035 }
5036
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 /*
5038 * Find trailing options. When '&' is used, keep old options.
5039 */
5040 if (*cmd == '&')
5041 ++cmd;
5042 else
5043 {
5044 if (!p_ed)
5045 {
5046 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005047 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005049 subflags.do_all = FALSE;
5050 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005052 subflags.do_error = TRUE;
5053 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01005054 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005055 subflags.do_count = FALSE;
5056 subflags.do_number = FALSE;
5057 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 }
5059 while (*cmd)
5060 {
5061 /*
5062 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
5063 * 'r' is never inverted.
5064 */
5065 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005066 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005068 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005069 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005070 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005072 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 else if (*cmd == 'r') /* use last used regexp */
5074 which_pat = RE_LAST;
5075 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005076 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005077 else if (*cmd == '#')
5078 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005079 subflags.do_print = TRUE;
5080 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005081 }
5082 else if (*cmd == 'l')
5083 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005084 subflags.do_print = TRUE;
5085 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005086 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005088 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005090 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 else
5092 break;
5093 ++cmd;
5094 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005095 if (subflags.do_count)
5096 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005098 save_do_all = subflags.do_all;
5099 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 /*
5102 * check for a trailing count
5103 */
5104 cmd = skipwhite(cmd);
5105 if (VIM_ISDIGIT(*cmd))
5106 {
5107 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005108 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005110 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 return;
5112 }
5113 eap->line1 = eap->line2;
5114 eap->line2 += i - 1;
5115 if (eap->line2 > curbuf->b_ml.ml_line_count)
5116 eap->line2 = curbuf->b_ml.ml_line_count;
5117 }
5118
5119 /*
5120 * check for trailing command or garbage
5121 */
5122 cmd = skipwhite(cmd);
5123 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5124 {
5125 eap->nextcmd = check_nextcmd(cmd);
5126 if (eap->nextcmd == NULL)
5127 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005128 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 return;
5130 }
5131 }
5132
5133 if (eap->skip) /* not executing commands, only parsing */
5134 return;
5135
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005136 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005137 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005138 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005139 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005140 return;
5141 }
5142
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5144 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005145 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005146 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 return;
5148 }
5149
5150 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005151 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005153 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 regmatch.rmm_ic = FALSE;
5155
5156 sub_firstline = NULL;
5157
5158 /*
5159 * ~ in the substitute pattern is replaced with the old pattern.
5160 * We do it here once to avoid it to be replaced over and over again.
5161 * But don't do it when it starts with "\=", then it's an expression.
5162 */
5163 if (!(sub[0] == '\\' && sub[1] == '='))
5164 sub = regtilde(sub, p_magic);
5165
5166 /*
5167 * Check for a match on each line.
5168 */
5169 line2 = eap->line2;
5170 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005171#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 || aborting()
5173#endif
5174 ); ++lnum)
5175 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005176 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005177 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 if (nmatch)
5179 {
5180 colnr_T copycol;
5181 colnr_T matchcol;
5182 colnr_T prev_matchcol = MAXCOL;
5183 char_u *new_end, *new_start = NULL;
5184 unsigned new_start_len = 0;
5185 char_u *p1;
5186 int did_sub = FALSE;
5187 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005188 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 long nmatch_tl = 0; /* nr of lines matched below lnum */
5190 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005191 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005192 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193
5194 /*
5195 * The new text is build up step by step, to avoid too much
5196 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005197 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 * copycol Column in the old text where we started
5199 * looking for a match; from here old text still
5200 * needs to be copied to the new text.
5201 * matchcol Column number of the old text where to look
5202 * for the next match. It's just after the
5203 * previous match or one further.
5204 * prev_matchcol Column just after the previous match (if any).
5205 * Mostly equal to matchcol, except for the first
5206 * match and after skipping an empty match.
5207 * regmatch.*pos Where the pattern matched in the old text.
5208 * new_start The new text, all that has been produced so
5209 * far.
5210 * new_end The new text, where to append new text.
5211 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005212 * lnum The line number where we found the start of
5213 * the match. Can be below the line we searched
5214 * when there is a \n before a \zs in the
5215 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 * sub_firstlnum The line number in the buffer where to look
5217 * for a match. Can be different from "lnum"
5218 * when the pattern or substitute string contains
5219 * line breaks.
5220 *
5221 * Special situations:
5222 * - When the substitute string contains a line break, the part up
5223 * to the line break is inserted in the text, but the copy of
5224 * the original line is kept. "sub_firstlnum" is adjusted for
5225 * the inserted lines.
5226 * - When the matched pattern contains a line break, the old line
5227 * is taken from the line at the end of the pattern. The lines
5228 * in the match are deleted later, "sub_firstlnum" is adjusted
5229 * accordingly.
5230 *
5231 * The new text is built up in new_start[]. It has some extra
5232 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005233 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 *
5235 * Make a copy of the old line, so it won't be taken away when
5236 * updating the screen or handling a multi-line match. The "old_"
5237 * pointers point into this copy.
5238 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005239 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 copycol = 0;
5241 matchcol = 0;
5242
5243 /* At first match, remember current cursor position. */
5244 if (!got_match)
5245 {
5246 setpcmark();
5247 got_match = TRUE;
5248 }
5249
5250 /*
5251 * Loop until nothing more to replace in this line.
5252 * 1. Handle match with empty string.
5253 * 2. If do_ask is set, ask for confirmation.
5254 * 3. substitute the string.
5255 * 4. if do_all is set, find next match
5256 * 5. break if there isn't another match in this line
5257 */
5258 for (;;)
5259 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005260 /* Advance "lnum" to the line where the match starts. The
5261 * match does not start in the first line when there is a line
5262 * break before \zs. */
5263 if (regmatch.startpos[0].lnum > 0)
5264 {
5265 lnum += regmatch.startpos[0].lnum;
5266 sub_firstlnum += regmatch.startpos[0].lnum;
5267 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005268 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005269 }
5270
5271 if (sub_firstline == NULL)
5272 {
5273 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5274 if (sub_firstline == NULL)
5275 {
5276 vim_free(new_start);
5277 goto outofmem;
5278 }
5279 }
5280
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 /* Save the line number of the last change for the final
5282 * cursor position (just like Vi). */
5283 curwin->w_cursor.lnum = lnum;
5284 do_again = FALSE;
5285
5286 /*
5287 * 1. Match empty string does not count, except for first
5288 * match. This reproduces the strange vi behaviour.
5289 * This also catches endless loops.
5290 */
5291 if (matchcol == prev_matchcol
5292 && regmatch.endpos[0].lnum == 0
5293 && matchcol == regmatch.endpos[0].col)
5294 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005295 if (sub_firstline[matchcol] == NUL)
5296 /* We already were at the end of the line. Don't look
5297 * for a match in this line again. */
5298 skip_match = TRUE;
5299 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005300 {
5301 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02005302 if (has_mbyte)
5303 matchcol += mb_ptr2len(sub_firstline + matchcol);
5304 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005305 ++matchcol;
5306 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 goto skip;
5308 }
5309
5310 /* Normally we continue searching for a match just after the
5311 * previous match. */
5312 matchcol = regmatch.endpos[0].col;
5313 prev_matchcol = matchcol;
5314
5315 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005316 * 2. If do_count is set only increase the counter.
5317 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005319 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005320 {
5321 /* For a multi-line match, put matchcol at the NUL at
5322 * the end of the line and set nmatch to one, so that
5323 * we continue looking for a match on the next line.
5324 * Avoids that ":s/\nB\@=//gc" get stuck. */
5325 if (nmatch > 1)
5326 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005327 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005328 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005329 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005330 }
5331 sub_nsubs++;
5332 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005333#ifdef FEAT_EVAL
5334 /* Skip the substitution, unless an expression is used,
5335 * then it is evaluated in the sandbox. */
5336 if (!(sub[0] == '\\' && sub[1] == '='))
5337#endif
5338 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005339 }
5340
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005341 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005343 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005344
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 /* change State to CONFIRM, so that the mouse works
5346 * properly */
5347 save_State = State;
5348 State = CONFIRM;
5349#ifdef FEAT_MOUSE
5350 setmouse(); /* disable mouse in xterm */
5351#endif
5352 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005353 if (curwin->w_p_crb)
5354 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
5356 /* When 'cpoptions' contains "u" don't sync undo when
5357 * asking for confirmation. */
5358 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5359 ++no_u_sync;
5360
5361 /*
5362 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5363 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005364 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005366 if (exmode_active)
5367 {
5368 char_u *resp;
5369 colnr_T sc, ec;
5370
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005371 print_line_no_prefix(lnum,
5372 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005373
5374 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5375 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005376 if (curwin->w_cursor.col < 0)
5377 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005378 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005379 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005380 {
5381 int numw = number_width(curwin) + 1;
5382 sc += numw;
5383 ec += numw;
5384 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005385 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005386 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005387 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005388 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005389 msg_putchar('^');
5390
5391 resp = getexmodeline('?', NULL, 0);
5392 if (resp != NULL)
5393 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005394 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005395 vim_free(resp);
5396 }
5397 }
5398 else
5399 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005400 char_u *orig_line = NULL;
5401 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005403 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005405 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005407 /* Invert the matched string.
5408 * Remove the inversion afterwards. */
5409 temp = RedrawingDisabled;
5410 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005412 if (new_start != NULL)
5413 {
5414 /* There already was a substitution, we would
5415 * like to show this to the user. We cannot
5416 * really update the line, it would change
5417 * what matches. Temporarily replace the line
5418 * and change it back afterwards. */
5419 orig_line = vim_strsave(ml_get(lnum));
5420 if (orig_line != NULL)
5421 {
5422 char_u *new_line = concat_str(new_start,
5423 sub_firstline + copycol);
5424
5425 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005426 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005427 else
5428 {
5429 /* Position the cursor relative to the
5430 * end of the line, the previous
5431 * substitute may have inserted or
5432 * deleted characters before the
5433 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005434 len_change = (int)STRLEN(new_line)
5435 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005436 curwin->w_cursor.col += len_change;
5437 ml_replace(lnum, new_line, FALSE);
5438 }
5439 }
5440 }
5441
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005442 search_match_lines = regmatch.endpos[0].lnum
5443 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005444 search_match_endcol = regmatch.endpos[0].col
5445 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005446 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005448 update_topline();
5449 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005450 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005451 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005452 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
5454#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005455 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005457 if (msg_row == Rows - 1)
5458 msg_didout = FALSE; /* avoid a scroll-up */
5459 msg_starthere();
5460 i = msg_scroll;
5461 msg_scroll = 0; /* truncate msg when
5462 needed */
5463 msg_no_more = TRUE;
5464 /* write message same highlighting as for
5465 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005466 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005467 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005468 msg_no_more = FALSE;
5469 msg_scroll = i;
5470 showruler(TRUE);
5471 windgoto(msg_row, msg_col);
5472 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473
5474#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005475 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005477 ++no_mapping; /* don't map this key */
5478 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005479 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005480 --allow_keys;
5481 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005483 /* clear the question */
5484 msg_didout = FALSE; /* don't scroll up */
5485 msg_col = 0;
5486 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005487
5488 /* restore the line */
5489 if (orig_line != NULL)
5490 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005491 }
5492
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005494 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005496 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497#endif
5498 )
5499 {
5500 got_quit = TRUE;
5501 break;
5502 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005503 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005505 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005507 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 {
5509 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005510 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 line2 = lnum;
5512 break;
5513 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005514 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005516 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 break;
5518 }
5519#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005520 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005522 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 scrolldown_clamp();
5524#endif
5525 }
5526 State = save_State;
5527#ifdef FEAT_MOUSE
5528 setmouse();
5529#endif
5530 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5531 --no_u_sync;
5532
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005533 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 {
5535 /* For a multi-line match, put matchcol at the NUL at
5536 * the end of the line and set nmatch to one, so that
5537 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005538 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5539 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 if (nmatch > 1)
5541 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005542 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005543 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 }
5545 goto skip;
5546 }
5547 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005548 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 }
5550
5551 /* Move the cursor to the start of the match, so that we can
5552 * use "\=col("."). */
5553 curwin->w_cursor.col = regmatch.startpos[0].col;
5554
5555 /*
5556 * 3. substitute the string.
5557 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005558#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005559 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005560 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005561 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005562 save_ma = curbuf->b_p_ma;
5563 curbuf->b_p_ma = FALSE;
5564 sandbox++;
5565 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005566 /* Save flags for recursion. They can change for e.g.
5567 * :s/^/\=execute("s#^##gn") */
5568 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005569#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005571 sublen = vim_regsub_multi(&regmatch,
5572 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005574#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01005575 // If getting the substitute string caused an error, don't do
5576 // the replacement.
5577 if (aborting())
5578 goto skip;
5579
5580 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005581 subflags = subflags_save;
5582 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005583 {
5584 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005585 if (sandbox > 0)
5586 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005587 goto skip;
5588 }
5589#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590
Bram Moolenaar4463f292005-09-25 22:20:24 +00005591 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005592 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005593 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5594 {
5595 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5596 skip_match = TRUE;
5597 }
5598
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 /* Need room for:
5600 * - result so far in new_start (not for first sub in line)
5601 * - original text up to match
5602 * - length of substituted part
5603 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005604 * Adjust text properties here, since we have all information
5605 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 */
5607 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005608 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005610#ifdef FEAT_TEXT_PROP
5611 if (curbuf->b_has_textprop)
5612 adjust_prop_columns(lnum, regmatch.startpos[0].col,
5613 sublen - 1 - (regmatch.endpos[0].col
5614 - regmatch.startpos[0].col));
5615#endif
5616 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 else
5618 {
5619 p1 = ml_get(sub_firstlnum + nmatch - 1);
5620 nmatch_tl += nmatch - 1;
5621 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005622 copy_len = regmatch.startpos[0].col - copycol;
5623 needed_len = copy_len + ((unsigned)STRLEN(p1)
5624 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 if (new_start == NULL)
5626 {
5627 /*
5628 * Get some space for a temporary buffer to do the
5629 * substitution into (and some extra space to avoid
5630 * too many calls to alloc()/free()).
5631 */
5632 new_start_len = needed_len + 50;
5633 if ((new_start = alloc_check(new_start_len)) == NULL)
5634 goto outofmem;
5635 *new_start = NUL;
5636 new_end = new_start;
5637 }
5638 else
5639 {
5640 /*
5641 * Check if the temporary buffer is long enough to do the
5642 * substitution into. If not, make it larger (with a bit
5643 * extra to avoid too many calls to alloc()/free()).
5644 */
5645 len = (unsigned)STRLEN(new_start);
5646 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005647 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 {
5649 new_start_len = needed_len + 50;
5650 if ((p1 = alloc_check(new_start_len)) == NULL)
5651 {
5652 vim_free(new_start);
5653 goto outofmem;
5654 }
5655 mch_memmove(p1, new_start, (size_t)(len + 1));
5656 vim_free(new_start);
5657 new_start = p1;
5658 }
5659 new_end = new_start + len;
5660 }
5661
5662 /*
5663 * copy the text up to the part that matched
5664 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005665 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5666 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005668 (void)vim_regsub_multi(&regmatch,
5669 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 sub, new_end, TRUE, p_magic, TRUE);
5671 sub_nsubs++;
5672 did_sub = TRUE;
5673
5674 /* Move the cursor to the start of the line, to avoid that it
5675 * is beyond the end of the line after the substitution. */
5676 curwin->w_cursor.col = 0;
5677
5678 /* For a multi-line match, make a copy of the last matched
5679 * line and continue in that one. */
5680 if (nmatch > 1)
5681 {
5682 sub_firstlnum += nmatch - 1;
5683 vim_free(sub_firstline);
5684 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5685 /* When going beyond the last line, stop substituting. */
5686 if (sub_firstlnum <= line2)
5687 do_again = TRUE;
5688 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005689 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 }
5691
5692 /* Remember next character to be copied. */
5693 copycol = regmatch.endpos[0].col;
5694
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005695 if (skip_match)
5696 {
5697 /* Already hit end of the buffer, sub_firstlnum is one
5698 * less than what it ought to be. */
5699 vim_free(sub_firstline);
5700 sub_firstline = vim_strsave((char_u *)"");
5701 copycol = 0;
5702 }
5703
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 /*
5705 * Now the trick is to replace CTRL-M chars with a real line
5706 * break. This would make it impossible to insert a CTRL-M in
5707 * the text. The line break can be avoided by preceding the
5708 * CTRL-M with a backslash. To be able to insert a backslash,
5709 * they must be doubled in the string and are halved here.
5710 * That is Vi compatible.
5711 */
5712 for (p1 = new_end; *p1; ++p1)
5713 {
5714 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005715 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 else if (*p1 == CAR)
5717 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005718 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005720 colnr_T plen = (colnr_T)(p1 - new_start + 1);
5721
5722 *p1 = NUL; // truncate up to the CR
5723 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005725 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 appended_lines(lnum - 1, 1L);
5727 else
5728 {
5729 if (first_line == 0)
5730 first_line = lnum;
5731 last_line = lnum + 1;
5732 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005733#ifdef FEAT_TEXT_PROP
5734 adjust_props_for_split(lnum, plen, 1);
5735#endif
5736 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 ++sub_firstlnum;
5738 ++lnum;
5739 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005740 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01005742 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005743 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 p1 = new_start - 1;
5745 }
5746 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005748 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 }
5750
5751 /*
5752 * 4. If do_all is set, find next match.
5753 * Prevent endless loop with patterns that match empty
5754 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5755 * But ":s/\n/#/" is OK.
5756 */
5757skip:
5758 /* We already know that we did the last subst when we are at
5759 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005760 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5761 * "line2" when there is a \zs in the pattern after a line
5762 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005763 lastone = (skip_match
5764 || got_int
5765 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005766 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005767 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005768 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5769 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 nmatch = -1;
5771
5772 /*
5773 * Replace the line in the buffer when needed. This is
5774 * skipped when there are more matches.
5775 * The check for nmatch_tl is needed for when multi-line
5776 * matching must replace the lines before trying to do another
5777 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005778 * When the match starts below where we start searching also
5779 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 */
5781 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 || nmatch_tl > 0
5783 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005784 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005785 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005786 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 {
5788 if (new_start != NULL)
5789 {
5790 /*
5791 * Copy the rest of the line, that didn't match.
5792 * "matchcol" has to be adjusted, we use the end of
5793 * the line as reference, because the substitute may
5794 * have changed the number of characters. Same for
5795 * "prev_matchcol".
5796 */
5797 STRCAT(new_start, sub_firstline + copycol);
5798 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5799 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5800 - prev_matchcol;
5801
5802 if (u_savesub(lnum) != OK)
5803 break;
5804 ml_replace(lnum, new_start, TRUE);
5805
5806 if (nmatch_tl > 0)
5807 {
5808 /*
5809 * Matched lines have now been substituted and are
5810 * useless, delete them. The part after the match
5811 * has been appended to new_start, we don't need
5812 * it in the buffer.
5813 */
5814 ++lnum;
5815 if (u_savedel(lnum, nmatch_tl) != OK)
5816 break;
5817 for (i = 0; i < nmatch_tl; ++i)
5818 ml_delete(lnum, (int)FALSE);
5819 mark_adjust(lnum, lnum + nmatch_tl - 1,
5820 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005821 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 deleted_lines(lnum, nmatch_tl);
5823 --lnum;
5824 line2 -= nmatch_tl; /* nr of lines decreases */
5825 nmatch_tl = 0;
5826 }
5827
5828 /* When asking, undo is saved each time, must also set
5829 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005830 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 changed_bytes(lnum, 0);
5832 else
5833 {
5834 if (first_line == 0)
5835 first_line = lnum;
5836 last_line = lnum + 1;
5837 }
5838
5839 sub_firstlnum = lnum;
5840 vim_free(sub_firstline); /* free the temp buffer */
5841 sub_firstline = new_start;
5842 new_start = NULL;
5843 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5844 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5845 - prev_matchcol;
5846 copycol = 0;
5847 }
5848 if (nmatch == -1 && !lastone)
5849 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005850 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851
5852 /*
5853 * 5. break if there isn't another match in this line
5854 */
5855 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005856 {
5857 /* If the match found didn't start where we were
5858 * searching, do the next search in the line where we
5859 * found the match. */
5860 if (nmatch == -1)
5861 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005863 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 }
5865
5866 line_breakcheck();
5867 }
5868
5869 if (did_sub)
5870 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005871 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005872 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 }
5874
5875 line_breakcheck();
5876 }
5877
5878 if (first_line != 0)
5879 {
5880 /* Need to subtract the number of added lines from "last_line" to get
5881 * the line number before the change (same as adding the number of
5882 * deleted lines). */
5883 i = curbuf->b_ml.ml_line_count - old_line_count;
5884 changed_lines(first_line, 0, last_line - i, i);
5885 }
5886
5887outofmem:
5888 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005889
5890 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005891 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005892 curwin->w_cursor = old_cursor;
5893
Bram Moolenaar46475522010-03-23 17:36:29 +01005894 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 {
5896 /* Set the '[ and '] marks. */
5897 curbuf->b_op_start.lnum = eap->line1;
5898 curbuf->b_op_end.lnum = line2;
5899 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5900
5901 if (!global_busy)
5902 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005903 /* when interactive leave cursor on the match */
5904 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005905 {
5906 if (endcolumn)
5907 coladvance((colnr_T)MAXCOL);
5908 else
5909 beginline(BL_WHITE | BL_FIX);
5910 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005911 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005912 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 }
5914 else
5915 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005916 if (subflags.do_print)
5917 print_line(curwin->w_cursor.lnum,
5918 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 }
5920 else if (!global_busy)
5921 {
5922 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005923 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005925 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005926 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005927 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 }
5929
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005930#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005931 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005932 /* Cursor position may require updating */
5933 changed_window_setting();
5934#endif
5935
Bram Moolenaar473de612013-06-08 18:19:48 +02005936 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005937
5938 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005939 subflags.do_all = save_do_all;
5940 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941}
5942
5943/*
5944 * Give message for number of substitutions.
5945 * Can also be used after a ":global" command.
5946 * Return TRUE if a message was given.
5947 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005948 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005949do_sub_msg(
5950 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005951{
5952 /*
5953 * Only report substitutions when:
5954 * - more than 'report' substitutions
5955 * - command was typed by user, or number of changed lines > 'report'
5956 * - giving messages is not disabled by 'lazyredraw'
5957 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005958 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5959 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 && messaging())
5961 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005962 char *msg_single;
5963 char *msg_plural;
5964
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 if (got_int)
5966 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005967 else
5968 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005969
5970 msg_single = count_only
5971 ? NGETTEXT("%ld match on %ld line",
5972 "%ld matches on %ld line", sub_nsubs)
5973 : NGETTEXT("%ld substitution on %ld line",
5974 "%ld substitutions on %ld line", sub_nsubs);
5975 msg_plural = count_only
5976 ? NGETTEXT("%ld match on %ld lines",
5977 "%ld matches on %ld lines", sub_nsubs)
5978 : NGETTEXT("%ld substitution on %ld lines",
5979 "%ld substitutions on %ld lines", sub_nsubs);
5980
Bram Moolenaar32526b32019-01-19 17:43:09 +01005981 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02005982 NGETTEXT(msg_single, msg_plural, sub_nlines),
5983 sub_nsubs, (long)sub_nlines);
5984
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01005987 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 return TRUE;
5989 }
5990 if (got_int)
5991 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005992 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 return TRUE;
5994 }
5995 return FALSE;
5996}
5997
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005998 static void
5999global_exe_one(char_u *cmd, linenr_T lnum)
6000{
6001 curwin->w_cursor.lnum = lnum;
6002 curwin->w_cursor.col = 0;
6003 if (*cmd == NUL || *cmd == '\n')
6004 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6005 else
6006 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6007}
6008
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009/*
6010 * Execute a global command of the form:
6011 *
6012 * g/pattern/X : execute X on all lines where pattern matches
6013 * v/pattern/X : execute X on all lines where pattern does not match
6014 *
6015 * where 'X' is an EX command
6016 *
6017 * The command character (as well as the trailing slash) is optional, and
6018 * is assumed to be 'p' if missing.
6019 *
6020 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006021 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 * for each line that has a mark. This is required because after deleting
6023 * lines we do not know where to search for the next match.
6024 */
6025 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006026ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027{
6028 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006029 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 int type; /* first char of cmd: 'v' or 'g' */
6031 char_u *cmd; /* command argument */
6032
6033 char_u delim; /* delimiter, normally '/' */
6034 char_u *pat;
6035 regmmatch_T regmatch;
6036 int match;
6037 int which_pat;
6038
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006039 /* When nesting the command works on one line. This allows for
6040 * ":g/found/v/notfound/command". */
6041 if (global_busy && (eap->line1 != 1
6042 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006044 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006045 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 return;
6047 }
6048
6049 if (eap->forceit) /* ":global!" is like ":vglobal" */
6050 type = 'v';
6051 else
6052 type = *eap->cmd;
6053 cmd = eap->arg;
6054 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055
6056 /*
6057 * undocumented vi feature:
6058 * "\/" and "\?": use previous search pattern.
6059 * "\&": use previous substitute pattern.
6060 */
6061 if (*cmd == '\\')
6062 {
6063 ++cmd;
6064 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
6065 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006066 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 return;
6068 }
6069 if (*cmd == '&')
6070 which_pat = RE_SUBST; /* use previous substitute pattern */
6071 else
6072 which_pat = RE_SEARCH; /* use previous search pattern */
6073 ++cmd;
6074 pat = (char_u *)"";
6075 }
6076 else if (*cmd == NUL)
6077 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006078 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 return;
6080 }
6081 else
6082 {
6083 delim = *cmd; /* get the delimiter */
6084 if (delim)
6085 ++cmd; /* skip delimiter if there is one */
6086 pat = cmd; /* remember start of pattern */
6087 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
6088 if (cmd[0] == delim) /* end delimiter found */
6089 *cmd++ = NUL; /* replace it with a NUL */
6090 }
6091
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6093 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006094 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 return;
6096 }
6097
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006098 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006100 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006101 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006102 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006104 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 }
6106 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006107 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006108 /*
6109 * pass 1: set marks for each (not) matching line
6110 */
6111 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6112 {
6113 /* a match on this line? */
6114 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006115 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006116 if ((type == 'g' && match) || (type == 'v' && !match))
6117 {
6118 ml_setmarked(lnum);
6119 ndone++;
6120 }
6121 line_breakcheck();
6122 }
6123
6124 /*
6125 * pass 2: execute the command for each line that has been marked
6126 */
6127 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006128 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006129 else if (ndone == 0)
6130 {
6131 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006132 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006133 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006134 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006135 }
6136 else
6137 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006138#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006139 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006140#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006141 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006142#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006143 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006144#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006145 }
6146
6147 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006148 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149
Bram Moolenaar473de612013-06-08 18:19:48 +02006150 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151}
6152
6153/*
6154 * Execute "cmd" on lines marked with ml_setmarked().
6155 */
6156 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006157global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006159 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6160 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6161 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162
6163 /*
6164 * Set current position only once for a global command.
6165 * If global_busy is set, setpcmark() will not do anything.
6166 * If there is an error, global_busy will be incremented.
6167 */
6168 setpcmark();
6169
6170 /* When the command writes a message, don't overwrite the command. */
6171 msg_didout = TRUE;
6172
Bram Moolenaard25bc232010-03-23 17:49:24 +01006173 sub_nsubs = 0;
6174 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 global_need_beginline = FALSE;
6176 global_busy = 1;
6177 old_lcount = curbuf->b_ml.ml_line_count;
6178 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6179 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006180 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 ui_breakcheck();
6182 }
6183
6184 global_busy = 0;
6185 if (global_need_beginline)
6186 beginline(BL_WHITE | BL_FIX);
6187 else
6188 check_cursor(); /* cursor may be beyond the end of the line */
6189
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006190 /* the cursor may not have moved in the text but a change in a previous
6191 * line may move it on the screen */
6192 changed_line_abv_curs();
6193
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 /* If it looks like no message was written, allow overwriting the
6195 * command with the report for number of changes. */
6196 if (msg_col == 0 && msg_scrolled == 0)
6197 msg_didout = FALSE;
6198
Bram Moolenaar45667512007-05-10 19:24:43 +00006199 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006200 * number of extra or deleted lines.
6201 * Don't report extra or deleted lines in the edge case where the buffer
6202 * we are in after execution is different from the buffer we started in. */
6203 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6205}
6206
6207#ifdef FEAT_VIMINFO
6208 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006209read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006211 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 vim_free(old_sub);
6213 if (force || old_sub == NULL)
6214 old_sub = viminfo_readstring(virp, 1, TRUE);
6215 return viminfo_readline(virp);
6216}
6217
6218 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006219write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220{
6221 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6222 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006223 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 viminfo_writestring(fp, old_sub);
6225 }
6226}
6227#endif /* FEAT_VIMINFO */
6228
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006229#if defined(EXITFREE) || defined(PROTO)
6230 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006231free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006232{
6233 vim_free(old_sub);
6234}
6235#endif
6236
Bram Moolenaar4033c552017-09-16 20:54:51 +02006237#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238/*
6239 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006240 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006242 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006243prepare_tagpreview(
6244 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245{
6246 win_T *wp;
6247
6248# ifdef FEAT_GUI
6249 need_mouse_correct = TRUE;
6250# endif
6251
6252 /*
6253 * If there is already a preview window open, use that one.
6254 */
6255 if (!curwin->w_p_pvw)
6256 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006257 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 if (wp->w_p_pvw)
6259 break;
6260 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006261 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 else
6263 {
6264 /*
6265 * There is no preview window open yet. Create one.
6266 */
6267 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6268 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006269 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 curwin->w_p_pvw = TRUE;
6271 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006272 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6273 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274# ifdef FEAT_DIFF
6275 curwin->w_p_diff = FALSE; /* no 'diff' */
6276# endif
6277# ifdef FEAT_FOLDING
6278 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6279# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006280 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 }
6282 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006283 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284}
6285
6286#endif
6287
6288
6289/*
6290 * ":help": open a read-only window on a help file
6291 */
6292 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006293ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294{
6295 char_u *arg;
6296 char_u *tag;
6297 FILE *helpfd; /* file descriptor of help file */
6298 int n;
6299 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 int num_matches;
6302 char_u **matches;
6303 char_u *p;
6304 int empty_fnum = 0;
6305 int alt_fnum = 0;
6306 buf_T *buf;
6307#ifdef FEAT_MULTI_LANG
6308 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006309 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006311#ifdef FEAT_FOLDING
6312 int old_KeyTyped = KeyTyped;
6313#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314
6315 if (eap != NULL)
6316 {
6317 /*
6318 * A ":help" command ends at the first LF, or at a '|' that is
6319 * followed by some text. Set nextcmd to the following command.
6320 */
6321 for (arg = eap->arg; *arg; ++arg)
6322 {
6323 if (*arg == '\n' || *arg == '\r'
6324 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6325 {
6326 *arg++ = NUL;
6327 eap->nextcmd = arg;
6328 break;
6329 }
6330 }
6331 arg = eap->arg;
6332
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006333 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006335 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 return;
6337 }
6338
6339 if (eap->skip) /* not executing commands */
6340 return;
6341 }
6342 else
6343 arg = (char_u *)"";
6344
6345 /* remove trailing blanks */
6346 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006347 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 *p-- = NUL;
6349
6350#ifdef FEAT_MULTI_LANG
6351 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006352 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353#endif
6354
6355 /* When no argument given go to the index. */
6356 if (*arg == NUL)
6357 arg = (char_u *)"help.txt";
6358
6359 /*
6360 * Check if there is a match for the argument.
6361 */
6362 n = find_help_tags(arg, &num_matches, &matches,
6363 eap != NULL && eap->forceit);
6364
6365 i = 0;
6366#ifdef FEAT_MULTI_LANG
6367 if (n != FAIL && lang != NULL)
6368 /* Find first item with the requested language. */
6369 for (i = 0; i < num_matches; ++i)
6370 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006371 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 if (len > 3 && matches[i][len - 3] == '@'
6373 && STRICMP(matches[i] + len - 2, lang) == 0)
6374 break;
6375 }
6376#endif
6377 if (i >= num_matches || n == FAIL)
6378 {
6379#ifdef FEAT_MULTI_LANG
6380 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006381 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 else
6383#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006384 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 if (n != FAIL)
6386 FreeWild(num_matches, matches);
6387 return;
6388 }
6389
6390 /* The first match (in the requested language) is the best match. */
6391 tag = vim_strsave(matches[i]);
6392 FreeWild(num_matches, matches);
6393
6394#ifdef FEAT_GUI
6395 need_mouse_correct = TRUE;
6396#endif
6397
6398 /*
6399 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006400 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006402 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006404 if (cmdmod.tab != 0)
6405 wp = NULL;
6406 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006407 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006408 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006409 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6411 win_enter(wp, TRUE);
6412 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 {
6414 /*
6415 * There is no help window yet.
6416 * Try to open the file specified by the "helpfile" option.
6417 */
6418 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6419 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006420 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 goto erret;
6422 }
6423 fclose(helpfd);
6424
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006426 * specified, the current window is vertically split and
6427 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006430 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006433 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 if (curwin->w_height < p_hh)
6436 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437
6438 /*
6439 * Open help file (do_ecmd() will set b_help flag, readfile() will
6440 * set b_p_ro flag).
6441 * Set the alternate file to the previously edited file.
6442 */
6443 alt_fnum = curbuf->b_fnum;
6444 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006445 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006446 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006447 if (!cmdmod.keepalt)
6448 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 empty_fnum = curbuf->b_fnum;
6450 }
6451 }
6452
6453 if (!p_im)
6454 restart_edit = 0; /* don't want insert mode in help file */
6455
Bram Moolenaar8f535582011-09-30 17:30:31 +02006456#ifdef FEAT_FOLDING
6457 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6458 * It is needed for do_tag top open folds under the cursor. */
6459 KeyTyped = old_KeyTyped;
6460#endif
6461
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 if (tag != NULL)
6463 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6464
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006465 /* Delete the empty buffer if we're not using it. Careful: autocommands
6466 * may have jumped to another window, check that the buffer is not in a
6467 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6469 {
6470 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006471 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 wipe_buffer(buf, TRUE);
6473 }
6474
6475 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006476 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 curwin->w_alt_fnum = alt_fnum;
6478
6479erret:
6480 vim_free(tag);
6481}
6482
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006483/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006484 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006485 */
6486 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006487ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006488{
6489 win_T *win;
6490
6491 FOR_ALL_WINDOWS(win)
6492 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006493 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006494 {
6495 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006496 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006497 }
6498 }
6499}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006501#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6502/*
6503 * In an argument search for a language specifiers in the form "@xx".
6504 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6505 * Returns NULL if not found.
6506 */
6507 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006508check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006509{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006510 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006511
6512 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6513 && ASCII_ISALPHA(arg[len - 1]))
6514 {
6515 arg[len - 3] = NUL; /* remove the '@' */
6516 return arg + len - 2;
6517 }
6518 return NULL;
6519}
6520#endif
6521
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522/*
6523 * Return a heuristic indicating how well the given string matches. The
6524 * smaller the number, the better the match. This is the order of priorities,
6525 * from best match to worst match:
6526 * - Match with least alpha-numeric characters is better.
6527 * - Match with least total characters is better.
6528 * - Match towards the start is better.
6529 * - Match starting with "+" is worse (feature instead of command)
6530 * Assumption is made that the matched_string passed has already been found to
6531 * match some string for which help is requested. webb.
6532 */
6533 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006534help_heuristic(
6535 char_u *matched_string,
6536 int offset, /* offset for match */
6537 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538{
6539 int num_letters;
6540 char_u *p;
6541
6542 num_letters = 0;
6543 for (p = matched_string; *p; p++)
6544 if (ASCII_ISALNUM(*p))
6545 num_letters++;
6546
6547 /*
6548 * Multiply the number of letters by 100 to give it a much bigger
6549 * weighting than the number of characters.
6550 * If there only is a match while ignoring case, add 5000.
6551 * If the match starts in the middle of a word, add 10000 to put it
6552 * somewhere in the last half.
6553 * If the match is more than 2 chars from the start, multiply by 200 to
6554 * put it after matches at the start.
6555 */
6556 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6557 && ASCII_ISALNUM(matched_string[offset - 1]))
6558 offset += 10000;
6559 else if (offset > 2)
6560 offset *= 200;
6561 if (wrong_case)
6562 offset += 5000;
6563 /* Features are less interesting than the subjects themselves, but "+"
6564 * alone is not a feature. */
6565 if (matched_string[0] == '+' && matched_string[1] != NUL)
6566 offset += 100;
6567 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6568}
6569
6570/*
6571 * Compare functions for qsort() below, that checks the help heuristics number
6572 * that has been put after the tagname by find_tags().
6573 */
6574 static int
6575#ifdef __BORLANDC__
6576_RTLENTRYF
6577#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006578help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579{
6580 char *p1;
6581 char *p2;
6582
6583 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6584 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6585 return strcmp(p1, p2);
6586}
6587
6588/*
6589 * Find all help tags matching "arg", sort them and return in matches[], with
6590 * the number of matches in num_matches.
6591 * The matches will be sorted with a "best" match algorithm.
6592 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6593 */
6594 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006595find_help_tags(
6596 char_u *arg,
6597 int *num_matches,
6598 char_u ***matches,
6599 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600{
6601 char_u *s, *d;
6602 int i;
6603 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006604 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006605 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006606 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6607 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006608 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006609 "[count]", "[quotex]",
6610 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006611 "[pattern]", "\\|", "\\%$",
6612 "s/\\~", "s/\\U", "s/\\L",
6613 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006615 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006616 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006617 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
6618 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006619 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006620 "\\[count]", "\\[quotex]",
6621 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006622 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006623 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006624 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006625 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
6626 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 int flags;
6628
6629 d = IObuff; /* assume IObuff is long enough! */
6630
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02006631 if (STRNICMP(arg, "expr-", 5) == 0)
6632 {
6633 // When the string starting with "expr-" and containing '?' and matches
6634 // the table, it is taken literally. Otherwise '?' is recognized as a
6635 // wildcard.
6636 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
6637 if (STRCMP(arg + 5, expr_table[i]) == 0)
6638 {
6639 STRCPY(d, arg);
6640 break;
6641 }
6642 }
6643 else
6644 {
6645 // Recognize a few exceptions to the rule. Some strings that contain
6646 // '*' with "star". Otherwise '*' is recognized as a wildcard.
6647 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
6648 if (STRCMP(arg, mtable[i]) == 0)
6649 {
6650 STRCPY(d, rtable[i]);
6651 break;
6652 }
6653 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654
6655 if (i < 0) /* no match in table */
6656 {
6657 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6658 * Also replace "\%^" and "\%(", they match every tag too.
6659 * Also "\zs", "\z1", etc.
6660 * Also "\@<", "\@=", "\@<=", etc.
6661 * And also "\_$" and "\_^". */
6662 if (arg[0] == '\\'
6663 && ((arg[1] != NUL && arg[2] == NUL)
6664 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6665 && arg[2] != NUL)))
6666 {
6667 STRCPY(d, "/\\\\");
6668 STRCPY(d + 3, arg + 1);
6669 /* Check for "/\\_$", should be "/\\_\$" */
6670 if (d[3] == '_' && d[4] == '$')
6671 STRCPY(d + 4, "\\$");
6672 }
6673 else
6674 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006675 /* Replace:
6676 * "[:...:]" with "\[:...:]"
6677 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006678 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006679 */
6680 if ((arg[0] == '[' && (arg[1] == ':'
6681 || (arg[1] == '+' && arg[2] == '+')))
6682 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 *d++ = '\\';
6684
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006685 /*
6686 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6687 */
6688 if (*arg == '(' && arg[1] == '\'')
6689 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 for (s = arg; *s; ++s)
6691 {
6692 /*
6693 * Replace "|" with "bar" and '"' with "quote" to match the name of
6694 * the tags for these commands.
6695 * Replace "*" with ".*" and "?" with "." to match command line
6696 * completion.
6697 * Insert a backslash before '~', '$' and '.' to avoid their
6698 * special meaning.
6699 */
6700 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6701 break;
6702 switch (*s)
6703 {
6704 case '|': STRCPY(d, "bar");
6705 d += 3;
6706 continue;
6707 case '"': STRCPY(d, "quote");
6708 d += 5;
6709 continue;
6710 case '*': *d++ = '.';
6711 break;
6712 case '?': *d++ = '.';
6713 continue;
6714 case '$':
6715 case '.':
6716 case '~': *d++ = '\\';
6717 break;
6718 }
6719
6720 /*
6721 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6722 * ":help i_^_CTRL-D" work.
6723 * Insert '-' before and after "CTRL-X" when applicable.
6724 */
6725 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6726 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6727 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006728 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6729 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 STRCPY(d, "CTRL-");
6731 d += 5;
6732 if (*s < ' ')
6733 {
6734#ifdef EBCDIC
6735 *d++ = CtrlChar(*s);
6736#else
6737 *d++ = *s + '@';
6738#endif
6739 if (d[-1] == '\\')
6740 *d++ = '\\'; /* double a backslash */
6741 }
6742 else
6743 *d++ = *++s;
6744 if (s[1] != NUL && s[1] != '_')
6745 *d++ = '_'; /* append a '_' */
6746 continue;
6747 }
6748 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6749 *d++ = '\\';
6750
6751 /*
6752 * Insert a backslash before a backslash after a slash, for search
6753 * pattern tags: "/\|" --> "/\\|".
6754 */
6755 else if (s[0] == '\\' && s[1] != '\\'
6756 && *arg == '/' && s == arg + 1)
6757 *d++ = '\\';
6758
6759 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6760 * "CTRL-\_CTRL-N" */
6761 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6762 {
6763 STRCPY(d, "CTRL-\\\\");
6764 d += 7;
6765 s += 6;
6766 }
6767
6768 *d++ = *s;
6769
6770 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006771 * If tag contains "({" or "([", tag terminates at the "(".
6772 * This is for help on functions, e.g.: abs({expr}).
6773 */
6774 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6775 break;
6776
6777 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 * If tag starts with ', toss everything after a second '. Fixes
6779 * CTRL-] on 'option'. (would include the trailing '.').
6780 */
6781 if (*s == '\'' && s > arg && *arg == '\'')
6782 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006783 /* Also '{' and '}'. */
6784 if (*s == '}' && s > arg && *arg == '{')
6785 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 }
6787 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006788
6789 if (*IObuff == '`')
6790 {
6791 if (d > IObuff + 2 && d[-1] == '`')
6792 {
6793 /* remove the backticks from `command` */
6794 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6795 d[-2] = NUL;
6796 }
6797 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6798 {
6799 /* remove the backticks and comma from `command`, */
6800 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6801 d[-3] = NUL;
6802 }
6803 else if (d > IObuff + 4 && d[-3] == '`'
6804 && d[-2] == '\\' && d[-1] == '.')
6805 {
6806 /* remove the backticks and dot from `command`\. */
6807 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6808 d[-4] = NUL;
6809 }
6810 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 }
6812 }
6813
6814 *matches = (char_u **)"";
6815 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02006816 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 if (keep_lang)
6818 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006819 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006821 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 /* Sort the matches found on the heuristic number that is after the
6823 * tag name. */
6824 qsort((void *)*matches, (size_t)*num_matches,
6825 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006826 /* Delete more than TAG_MANY to reduce the size of the listing. */
6827 while (*num_matches > TAG_MANY)
6828 vim_free((*matches)[--*num_matches]);
6829 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 return OK;
6831}
6832
6833/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006834 * Called when starting to edit a buffer for a help file.
6835 */
6836 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006837prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006838{
6839 char_u *p;
6840
6841 curbuf->b_help = TRUE;
6842#ifdef FEAT_QUICKFIX
6843 set_string_option_direct((char_u *)"buftype", -1,
6844 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6845#endif
6846
6847 /*
6848 * Always set these options after jumping to a help tag, because the
6849 * user may have an autocommand that gets in the way.
6850 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6851 * latin1 word characters (for translated help files).
6852 * Only set it when needed, buf_init_chartab() is some work.
6853 */
6854 p =
6855#ifdef EBCDIC
6856 (char_u *)"65-255,^*,^|,^\"";
6857#else
6858 (char_u *)"!-~,^*,^|,^\",192-255";
6859#endif
6860 if (STRCMP(curbuf->b_p_isk, p) != 0)
6861 {
6862 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6863 check_buf_options(curbuf);
6864 (void)buf_init_chartab(curbuf, FALSE);
6865 }
6866
Bram Moolenaar0b105412014-11-30 13:34:23 +01006867#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006868 /* Don't use the global foldmethod.*/
6869 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6870 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006871#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006872
6873 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6874 curwin->w_p_list = FALSE; /* no list mode */
6875
6876 curbuf->b_p_ma = FALSE; /* not modifiable */
6877 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6878 curwin->w_p_nu = 0; /* no line numbers */
6879 curwin->w_p_rnu = 0; /* no relative line numbers */
6880 RESET_BINDING(curwin); /* no scroll or cursor binding */
6881#ifdef FEAT_ARABIC
6882 curwin->w_p_arab = FALSE; /* no arabic mode */
6883#endif
6884#ifdef FEAT_RIGHTLEFT
6885 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6886#endif
6887#ifdef FEAT_FOLDING
6888 curwin->w_p_fen = FALSE; /* No folding in the help window */
6889#endif
6890#ifdef FEAT_DIFF
6891 curwin->w_p_diff = FALSE; /* No 'diff' */
6892#endif
6893#ifdef FEAT_SPELL
6894 curwin->w_p_spell = FALSE; /* No spell checking */
6895#endif
6896
6897 set_buflisted(FALSE);
6898}
6899
6900/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 * After reading a help file: May cleanup a help buffer when syntax
6902 * highlighting is not used.
6903 */
6904 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006905fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906{
6907 linenr_T lnum;
6908 char_u *line;
6909 int in_example = FALSE;
6910 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006911 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 char_u *p;
6913 char_u *rt;
6914 int mustfree;
6915
Bram Moolenaar90492982017-06-22 14:16:31 +02006916 /* Set filetype to "help" if still needed. */
6917 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006918 {
6919 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006920 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006921 --curbuf_lock;
6922 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923
6924#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006925 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926#endif
6927 {
6928 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6929 {
6930 line = ml_get_buf(curbuf, lnum, FALSE);
6931 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006932 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 {
6934 /* End of example: non-white or '<' in first column. */
6935 if (line[0] == '<')
6936 {
6937 /* blank-out a '<' in the first column */
6938 line = ml_get_buf(curbuf, lnum, TRUE);
6939 line[0] = ' ';
6940 }
6941 in_example = FALSE;
6942 }
6943 if (!in_example && len > 0)
6944 {
6945 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6946 {
6947 /* blank-out a '>' in the last column (start of example) */
6948 line = ml_get_buf(curbuf, lnum, TRUE);
6949 line[len - 1] = ' ';
6950 in_example = TRUE;
6951 }
6952 else if (line[len - 1] == '~')
6953 {
6954 /* blank-out a '~' at the end of line (header marker) */
6955 line = ml_get_buf(curbuf, lnum, TRUE);
6956 line[len - 1] = ' ';
6957 }
6958 }
6959 }
6960 }
6961
6962 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006963 * In the "help.txt" and "help.abx" file, add the locally added help
6964 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006966 fname = gettail(curbuf->b_fname);
6967 if (fnamecmp(fname, "help.txt") == 0
6968#ifdef FEAT_MULTI_LANG
6969 || (fnamencmp(fname, "help.", 5) == 0
6970 && ASCII_ISALPHA(fname[5])
6971 && ASCII_ISALPHA(fname[6])
6972 && TOLOWER_ASC(fname[7]) == 'x'
6973 && fname[8] == NUL)
6974#endif
6975 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 {
6977 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6978 {
6979 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006980 if (strstr((char *)line, "*local-additions*") == NULL)
6981 continue;
6982
6983 /* Go through all directories in 'runtimepath', skipping
6984 * $VIMRUNTIME. */
6985 p = p_rtp;
6986 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006988 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6989 mustfree = FALSE;
6990 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006991 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006993 int fcount;
6994 char_u **fnames;
6995 FILE *fd;
6996 char_u *s;
6997 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006998 vimconv_T vc;
6999 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007001 /* Find all "doc/ *.txt" files in this directory. */
7002 add_pathsep(NameBuff);
7003#ifdef FEAT_MULTI_LANG
7004 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007006 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007008 if (gen_expand_wildcards(1, &NameBuff, &fcount,
7009 &fnames, EW_FILE|EW_SILENT) == OK
7010 && fcount > 0)
7011 {
7012#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007013 int i1, i2;
7014 char_u *f1, *f2;
7015 char_u *t1, *t2;
7016 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007017
7018 /* If foo.abx is found use it instead of foo.txt in
7019 * the same directory. */
7020 for (i1 = 0; i1 < fcount; ++i1)
7021 {
7022 for (i2 = 0; i2 < fcount; ++i2)
7023 {
7024 if (i1 == i2)
7025 continue;
7026 if (fnames[i1] == NULL || fnames[i2] == NULL)
7027 continue;
7028 f1 = fnames[i1];
7029 f2 = fnames[i2];
7030 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007031 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007032 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007033 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02007034 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007035 continue;
7036 if (fnamecmp(e1, ".txt") != 0
7037 && fnamecmp(e1, fname + 4) != 0)
7038 {
7039 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007040 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007041 continue;
7042 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01007043 if (e1 - f1 != e2 - f2
7044 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007045 continue;
7046 if (fnamecmp(e1, ".txt") == 0
7047 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007048 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01007049 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007052#endif
7053 for (fi = 0; fi < fcount; ++fi)
7054 {
7055 if (fnames[fi] == NULL)
7056 continue;
7057 fd = mch_fopen((char *)fnames[fi], "r");
7058 if (fd != NULL)
7059 {
7060 vim_fgets(IObuff, IOSIZE, fd);
7061 if (IObuff[0] == '*'
7062 && (s = vim_strchr(IObuff + 1, '*'))
7063 != NULL)
7064 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007065 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01007066
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007067 /* Change tag definition to a
7068 * reference and remove <CR>/<NL>. */
7069 IObuff[0] = '|';
7070 *s = '|';
7071 while (*s != NUL)
7072 {
7073 if (*s == '\r' || *s == '\n')
7074 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007075 /* The text is utf-8 when a byte
7076 * above 127 is found and no
7077 * illegal byte sequence is found.
7078 */
7079 if (*s >= 0x80 && this_utf != FALSE)
7080 {
7081 int l;
7082
7083 this_utf = TRUE;
7084 l = utf_ptr2len(s);
7085 if (l == 1)
7086 this_utf = FALSE;
7087 s += l - 1;
7088 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007089 ++s;
7090 }
Bram Moolenaar13505972019-01-24 15:04:48 +01007091
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007092 /* The help file is latin1 or utf-8;
7093 * conversion to the current
7094 * 'encoding' may be required. */
7095 vc.vc_type = CONV_NONE;
7096 convert_setup(&vc, (char_u *)(
7097 this_utf == TRUE ? "utf-8"
7098 : "latin1"), p_enc);
7099 if (vc.vc_type == CONV_NONE)
7100 /* No conversion needed. */
7101 cp = IObuff;
7102 else
7103 {
7104 /* Do the conversion. If it fails
7105 * use the unconverted text. */
7106 cp = string_convert(&vc, IObuff,
7107 NULL);
7108 if (cp == NULL)
7109 cp = IObuff;
7110 }
7111 convert_setup(&vc, NULL, NULL);
7112
7113 ml_append(lnum, cp, (colnr_T)0, FALSE);
7114 if (cp != IObuff)
7115 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007116 ++lnum;
7117 }
7118 fclose(fd);
7119 }
7120 }
7121 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007124 if (mustfree)
7125 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007127 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 }
7129 }
7130}
7131
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007132/*
7133 * ":exusage"
7134 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007135 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007136ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007137{
7138 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7139}
7140
7141/*
7142 * ":viusage"
7143 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007144 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007145ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007146{
7147 do_cmdline_cmd((char_u *)"help normal-index");
7148}
7149
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007151 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007154helptags_one(
7155 char_u *dir, /* doc directory */
7156 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7157 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7158 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159{
7160 FILE *fd_tags;
7161 FILE *fd;
7162 garray_T ga;
7163 int filecount;
7164 char_u **files;
7165 char_u *p1, *p2;
7166 int fi;
7167 char_u *s;
7168 int i;
7169 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007170 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 int utf8 = MAYBE;
7172 int this_utf8;
7173 int firstline;
7174 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175
7176 /*
7177 * Find all *.txt files.
7178 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007179 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007181 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 STRCAT(NameBuff, ext);
7183 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7184 EW_FILE|EW_SILENT) == FAIL
7185 || filecount == 0)
7186 {
7187 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007188 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 return;
7190 }
7191
7192 /*
7193 * Open the tags file for writing.
7194 * Do this before scanning through all the files.
7195 */
7196 STRCPY(NameBuff, dir);
7197 add_pathsep(NameBuff);
7198 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007199 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 if (fd_tags == NULL)
7201 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007202 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 FreeWild(filecount, files);
7204 return;
7205 }
7206
7207 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007208 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7209 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 */
7211 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007212 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7213 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 {
7215 if (ga_grow(&ga, 1) == FAIL)
7216 got_int = TRUE;
7217 else
7218 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007219 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 if (s == NULL)
7221 got_int = TRUE;
7222 else
7223 {
7224 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7225 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7226 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 }
7228 }
7229 }
7230
7231 /*
7232 * Go over all the files and extract the tags.
7233 */
7234 for (fi = 0; fi < filecount && !got_int; ++fi)
7235 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007236 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 if (fd == NULL)
7238 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007239 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 continue;
7241 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007242 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7246 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 if (firstline)
7248 {
7249 /* Detect utf-8 file by a non-ASCII char in the first line. */
7250 this_utf8 = MAYBE;
7251 for (s = IObuff; *s != NUL; ++s)
7252 if (*s >= 0x80)
7253 {
7254 int l;
7255
7256 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007257 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 if (l == 1)
7259 {
7260 /* Illegal UTF-8 byte sequence. */
7261 this_utf8 = FALSE;
7262 break;
7263 }
7264 s += l - 1;
7265 }
7266 if (this_utf8 == MAYBE) /* only ASCII characters found */
7267 this_utf8 = FALSE;
7268 if (utf8 == MAYBE) /* first file */
7269 utf8 = this_utf8;
7270 else if (utf8 != this_utf8)
7271 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007272 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 mix = !got_int;
7274 got_int = TRUE;
7275 }
7276 firstline = FALSE;
7277 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7279 while (p1 != NULL)
7280 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007281 /* Use vim_strbyte() instead of vim_strchr() so that when
7282 * 'encoding' is dbcs it still works, don't find '*' in the
7283 * second byte. */
7284 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7286 {
7287 for (s = p1 + 1; s < p2; ++s)
7288 if (*s == ' ' || *s == '\t' || *s == '|')
7289 break;
7290
7291 /*
7292 * Only accept a *tag* when it consists of valid
7293 * characters, there is white space before it and is
7294 * followed by a white character or end-of-line.
7295 */
7296 if (s == p2
7297 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7298 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7299 || s[1] == '\0'))
7300 {
7301 *p2 = '\0';
7302 ++p1;
7303 if (ga_grow(&ga, 1) == FAIL)
7304 {
7305 got_int = TRUE;
7306 break;
7307 }
7308 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7309 if (s == NULL)
7310 {
7311 got_int = TRUE;
7312 break;
7313 }
7314 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7315 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 sprintf((char *)s, "%s\t%s", p1, fname);
7317
7318 /* find next '*' */
7319 p2 = vim_strchr(p2 + 1, '*');
7320 }
7321 }
7322 p1 = p2;
7323 }
7324 line_breakcheck();
7325 }
7326
7327 fclose(fd);
7328 }
7329
7330 FreeWild(filecount, files);
7331
7332 if (!got_int)
7333 {
7334 /*
7335 * Sort the tags.
7336 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007337 if (ga.ga_data != NULL)
7338 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339
7340 /*
7341 * Check for duplicates.
7342 */
7343 for (i = 1; i < ga.ga_len; ++i)
7344 {
7345 p1 = ((char_u **)ga.ga_data)[i - 1];
7346 p2 = ((char_u **)ga.ga_data)[i];
7347 while (*p1 == *p2)
7348 {
7349 if (*p2 == '\t')
7350 {
7351 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007352 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7354 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007355 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 *p2 = '\t';
7357 break;
7358 }
7359 ++p1;
7360 ++p2;
7361 }
7362 }
7363
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 if (utf8 == TRUE)
7365 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366
7367 /*
7368 * Write the tags into the file.
7369 */
7370 for (i = 0; i < ga.ga_len; ++i)
7371 {
7372 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007373 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007375 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 else
7377 {
7378 fprintf(fd_tags, "%s\t/*", s);
7379 for (p1 = s; *p1 != '\t'; ++p1)
7380 {
7381 /* insert backslash before '\\' and '/' */
7382 if (*p1 == '\\' || *p1 == '/')
7383 putc('\\', fd_tags);
7384 putc(*p1, fd_tags);
7385 }
7386 fprintf(fd_tags, "*\n");
7387 }
7388 }
7389 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 if (mix)
7391 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392
7393 for (i = 0; i < ga.ga_len; ++i)
7394 vim_free(((char_u **)ga.ga_data)[i]);
7395 ga_clear(&ga);
7396 fclose(fd_tags); /* there is no check for an error... */
7397}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007399/*
7400 * Generate tags in one help directory, taking care of translations.
7401 */
7402 static void
7403do_helptags(char_u *dirname, int add_help_tags)
7404{
7405#ifdef FEAT_MULTI_LANG
7406 int len;
7407 int i, j;
7408 garray_T ga;
7409 char_u lang[2];
7410 char_u ext[5];
7411 char_u fname[8];
7412 int filecount;
7413 char_u **files;
7414
7415 /* Get a list of all files in the help directory and in subdirectories. */
7416 STRCPY(NameBuff, dirname);
7417 add_pathsep(NameBuff);
7418 STRCAT(NameBuff, "**");
7419 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7420 EW_FILE|EW_SILENT) == FAIL
7421 || filecount == 0)
7422 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007423 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007424 return;
7425 }
7426
7427 /* Go over all files in the directory to find out what languages are
7428 * present. */
7429 ga_init2(&ga, 1, 10);
7430 for (i = 0; i < filecount; ++i)
7431 {
7432 len = (int)STRLEN(files[i]);
7433 if (len > 4)
7434 {
7435 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7436 {
7437 /* ".txt" -> language "en" */
7438 lang[0] = 'e';
7439 lang[1] = 'n';
7440 }
7441 else if (files[i][len - 4] == '.'
7442 && ASCII_ISALPHA(files[i][len - 3])
7443 && ASCII_ISALPHA(files[i][len - 2])
7444 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7445 {
7446 /* ".abx" -> language "ab" */
7447 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7448 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7449 }
7450 else
7451 continue;
7452
7453 /* Did we find this language already? */
7454 for (j = 0; j < ga.ga_len; j += 2)
7455 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7456 break;
7457 if (j == ga.ga_len)
7458 {
7459 /* New language, add it. */
7460 if (ga_grow(&ga, 2) == FAIL)
7461 break;
7462 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7463 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7464 }
7465 }
7466 }
7467
7468 /*
7469 * Loop over the found languages to generate a tags file for each one.
7470 */
7471 for (j = 0; j < ga.ga_len; j += 2)
7472 {
7473 STRCPY(fname, "tags-xx");
7474 fname[5] = ((char_u *)ga.ga_data)[j];
7475 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7476 if (fname[5] == 'e' && fname[6] == 'n')
7477 {
7478 /* English is an exception: use ".txt" and "tags". */
7479 fname[4] = NUL;
7480 STRCPY(ext, ".txt");
7481 }
7482 else
7483 {
7484 /* Language "ab" uses ".abx" and "tags-ab". */
7485 STRCPY(ext, ".xxx");
7486 ext[1] = fname[5];
7487 ext[2] = fname[6];
7488 }
7489 helptags_one(dirname, ext, fname, add_help_tags);
7490 }
7491
7492 ga_clear(&ga);
7493 FreeWild(filecount, files);
7494
7495#else
7496 /* No language support, just use "*.txt" and "tags". */
7497 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7498#endif
7499}
7500
7501 static void
7502helptags_cb(char_u *fname, void *cookie)
7503{
7504 do_helptags(fname, *(int *)cookie);
7505}
7506
7507/*
7508 * ":helptags"
7509 */
7510 void
7511ex_helptags(exarg_T *eap)
7512{
7513 expand_T xpc;
7514 char_u *dirname;
7515 int add_help_tags = FALSE;
7516
7517 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007518 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007519 {
7520 add_help_tags = TRUE;
7521 eap->arg = skipwhite(eap->arg + 3);
7522 }
7523
7524 if (STRCMP(eap->arg, "ALL") == 0)
7525 {
7526 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7527 helptags_cb, &add_help_tags);
7528 }
7529 else
7530 {
7531 ExpandInit(&xpc);
7532 xpc.xp_context = EXPAND_DIRECTORIES;
7533 dirname = ExpandOne(&xpc, eap->arg, NULL,
7534 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7535 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007536 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007537 else
7538 do_helptags(dirname, add_help_tags);
7539 vim_free(dirname);
7540 }
7541}
7542
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007543/*
7544 * Make the user happy.
7545 */
7546 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007547ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007548{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007549 static char *code[] = {
7550 "\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$",
7551 "\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"
7552 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007553 char *p;
7554 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007555 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007556
7557 msg_start();
7558 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007559 for (i = 0; i < 2; ++i)
7560 for (p = code[i]; *p != NUL; ++p)
7561 if (*p == 'x')
7562 msg_putchar('\n');
7563 else
7564 for (n = *p++; n > 0; --n)
7565 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01007566 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02007567 else
7568 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007569 msg_clr_eos();
7570}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572/*
7573 * ":drop"
7574 * Opens the first argument in a window. When there are two or more arguments
7575 * the argument list is redefined.
7576 */
7577 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007578ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579{
7580 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 win_T *wp;
7582 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007583 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584
7585 /*
7586 * Check if the first argument is already being edited in a window. If
7587 * so, jump to that window.
7588 * We would actually need to check all arguments, but that's complicated
7589 * and mostly only one file is dropped.
7590 * This also ignores wildcards, since it is very unlikely the user is
7591 * editing a file name with a wildcard character.
7592 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007593 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007595 /*
7596 * Expanding wildcards may result in an empty argument list. E.g. when
7597 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7598 * already did an error message for this.
7599 */
7600 if (ARGCOUNT == 0)
7601 return;
7602
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007603 if (cmdmod.tab)
7604 {
7605 /* ":tab drop file ...": open a tab for each argument that isn't
7606 * edited in a window yet. It's like ":tab all" but without closing
7607 * windows or tabs. */
7608 ex_all(eap);
7609 }
7610 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007611 {
7612 /* ":drop file ...": Edit the first argument. Jump to an existing
7613 * window if possible, edit in current window if the current buffer
7614 * can be abandoned, otherwise open a new window. */
7615 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7616
7617 FOR_ALL_TAB_WINDOWS(tp, wp)
7618 {
7619 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007621 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 return;
7624 }
7625 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007627 /*
7628 * Check whether the current buffer is changed. If so, we will need
7629 * to split the current window or data could be lost.
7630 * Skip the check if the 'hidden' option is set, as in this case the
7631 * buffer won't be lost.
7632 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02007633 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007634 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007635 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01007636 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007637 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007638 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007640 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7641 if (split)
7642 {
7643 eap->cmdidx = CMD_sfirst;
7644 eap->cmd[0] = 's';
7645 }
7646 else
7647 eap->cmdidx = CMD_first;
7648 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007651
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007652/*
7653 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
7654 * Put the start of the pattern in "*s", unless "s" is NULL.
7655 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
7656 * If "s" is not NULL terminate the pattern with a NUL.
7657 * Return a pointer to the char just past the pattern plus flags.
7658 */
7659 char_u *
7660skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
7661{
7662 int c;
7663
7664 if (vim_isIDc(*p))
7665 {
7666 /* ":vimgrep pattern fname" */
7667 if (s != NULL)
7668 *s = p;
7669 p = skiptowhite(p);
7670 if (s != NULL && *p != NUL)
7671 *p++ = NUL;
7672 }
7673 else
7674 {
7675 /* ":vimgrep /pattern/[g][j] fname" */
7676 if (s != NULL)
7677 *s = p + 1;
7678 c = *p;
7679 p = skip_regexp(p + 1, c, TRUE, NULL);
7680 if (*p != c)
7681 return NULL;
7682
7683 /* Truncate the pattern. */
7684 if (s != NULL)
7685 *p = NUL;
7686 ++p;
7687
7688 /* Find the flags */
7689 while (*p == 'g' || *p == 'j')
7690 {
7691 if (flags != NULL)
7692 {
7693 if (*p == 'g')
7694 *flags |= VGR_GLOBAL;
7695 else
7696 *flags |= VGR_NOJUMP;
7697 }
7698 ++p;
7699 }
7700 }
7701 return p;
7702}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02007703
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007704#if defined(FEAT_EVAL) || defined(PROTO)
7705/*
7706 * List v:oldfiles in a nice way.
7707 */
7708 void
7709ex_oldfiles(exarg_T *eap UNUSED)
7710{
7711 list_T *l = get_vim_var_list(VV_OLDFILES);
7712 listitem_T *li;
7713 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007714 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007715
7716 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01007717 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007718 else
7719 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007720 msg_start();
7721 msg_scroll = TRUE;
7722 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
7723 {
7724 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007725 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02007726 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007727 {
7728 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01007729 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007730 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02007731 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007732 msg_putchar('\n');
7733 out_flush(); /* output one line at a time */
7734 ui_breakcheck();
7735 }
7736 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02007737
7738 /* Assume "got_int" was set to truncate the listing. */
7739 got_int = FALSE;
7740
7741# ifdef FEAT_BROWSE_CMD
7742 if (cmdmod.browse)
7743 {
7744 quit_more = FALSE;
7745 nr = prompt_for_number(FALSE);
7746 msg_starthere();
7747 if (nr > 0)
7748 {
7749 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
7750 (long)nr);
7751
7752 if (p != NULL)
7753 {
7754 p = expand_env_save(p);
7755 eap->arg = p;
7756 eap->cmdidx = CMD_edit;
7757 cmdmod.browse = FALSE;
7758 do_exedit(eap, NULL);
7759 vim_free(p);
7760 }
7761 }
7762 }
7763# endif
7764 }
7765}
7766#endif